Title: | 'Amazon Web Services' Cost Management Services |
Version: | 0.9.0 |
Description: | Interface to 'Amazon Web Services' cost management services, including cost and usage reports, budgets, pricing, and more https://aws.amazon.com/. |
License: | Apache License (≥ 2.0) |
URL: | https://github.com/paws-r/paws, https://paws-r.r-universe.dev/paws.cost.management |
BugReports: | https://github.com/paws-r/paws/issues |
Imports: | paws.common (≥ 0.8.0) |
Suggests: | testthat |
Encoding: | UTF-8 |
RoxygenNote: | 7.3.2 |
Collate: | 'billing_service.R' 'billing_interfaces.R' 'billing_operations.R' 'billingconductor_service.R' 'billingconductor_interfaces.R' 'billingconductor_operations.R' 'budgets_service.R' 'budgets_interfaces.R' 'budgets_operations.R' 'costandusagereportservice_service.R' 'costandusagereportservice_interfaces.R' 'costandusagereportservice_operations.R' 'costexplorer_service.R' 'costexplorer_interfaces.R' 'costexplorer_operations.R' 'marketplacecatalog_service.R' 'marketplacecatalog_interfaces.R' 'marketplacecatalog_operations.R' 'marketplacecommerceanalytics_service.R' 'marketplacecommerceanalytics_interfaces.R' 'marketplacecommerceanalytics_operations.R' 'marketplaceentitlementservice_service.R' 'marketplaceentitlementservice_interfaces.R' 'marketplaceentitlementservice_operations.R' 'marketplacemetering_service.R' 'marketplacemetering_interfaces.R' 'marketplacemetering_operations.R' 'paymentcryptographycontrolplane_service.R' 'paymentcryptographycontrolplane_interfaces.R' 'paymentcryptographycontrolplane_operations.R' 'paymentcryptographydataplane_service.R' 'paymentcryptographydataplane_interfaces.R' 'paymentcryptographydataplane_operations.R' 'pricing_service.R' 'pricing_interfaces.R' 'pricing_operations.R' 'reexports_paws.common.R' 'savingsplans_service.R' 'savingsplans_interfaces.R' 'savingsplans_operations.R' |
NeedsCompilation: | no |
Packaged: | 2025-03-14 09:20:23 UTC; dyfanjones |
Author: | David Kretch [aut], Adam Banker [aut], Dyfan Jones [cre], Amazon.com, Inc. [cph] |
Maintainer: | Dyfan Jones <dyfan.r.jones@gmail.com> |
Repository: | CRAN |
Date/Publication: | 2025-03-14 14:20:02 UTC |
AWS Billing
Description
You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data.
The Billing API provides the following endpoint:
https://billing.us-east-1.api.aws
Usage
billing(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- billing( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_billing_view | Creates a billing view with the specified billing view attributes |
delete_billing_view | Deletes the specified billing view |
get_billing_view | Returns the metadata associated to the specified billing view ARN |
get_resource_policy | Returns the resource-based policy document attached to the resource in JSON format |
list_billing_views | Lists the billing views available for a given time period |
list_source_views_for_billing_view | Lists the source views (managed Amazon Web Services billing views) associated with the billing view |
list_tags_for_resource | Lists tags associated with the billing view resource |
tag_resource | An API operation for adding one or more tags (key-value pairs) to a resource |
untag_resource | Removes one or more tags from a resource |
update_billing_view | An API to update the attributes of the billing view |
Examples
## Not run:
svc <- billing()
svc$create_billing_view(
Foo = 123
)
## End(Not run)
Creates a billing view with the specified billing view attributes
Description
Creates a billing view with the specified billing view attributes.
See https://www.paws-r-sdk.com/docs/billing_create_billing_view/ for full documentation.
Usage
billing_create_billing_view(
name,
description = NULL,
sourceViews,
dataFilterExpression = NULL,
clientToken = NULL,
resourceTags = NULL
)
Arguments
name |
[required] The name of the billing view. |
description |
The description of the billing view. |
sourceViews |
[required] A list of billing views used as the data source for the custom billing view. |
dataFilterExpression |
See
Expression.
Billing view only supports |
clientToken |
A unique, case-sensitive identifier you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. If the original request completes successfully, any subsequent retries complete successfully without performing any further actions with an idempotent request. |
resourceTags |
A list of key value map specifying tags associated to the billing view being created. |
Deletes the specified billing view
Description
Deletes the specified billing view.
See https://www.paws-r-sdk.com/docs/billing_delete_billing_view/ for full documentation.
Usage
billing_delete_billing_view(arn)
Arguments
arn |
[required] The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view. |
Returns the metadata associated to the specified billing view ARN
Description
Returns the metadata associated to the specified billing view ARN.
See https://www.paws-r-sdk.com/docs/billing_get_billing_view/ for full documentation.
Usage
billing_get_billing_view(arn)
Arguments
arn |
[required] The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view. |
Returns the resource-based policy document attached to the resource in JSON format
Description
Returns the resource-based policy document attached to the resource in JSON
format.
See https://www.paws-r-sdk.com/docs/billing_get_resource_policy/ for full documentation.
Usage
billing_get_resource_policy(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to. |
Lists the billing views available for a given time period
Description
Lists the billing views available for a given time period.
See https://www.paws-r-sdk.com/docs/billing_list_billing_views/ for full documentation.
Usage
billing_list_billing_views(
activeTimeRange = NULL,
arns = NULL,
billingViewTypes = NULL,
ownerAccountId = NULL,
maxResults = NULL,
nextToken = NULL
)
Arguments
activeTimeRange |
The time range for the billing views listed. |
arns |
The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view. |
billingViewTypes |
The type of billing view. |
ownerAccountId |
The list of owners of the billing view. |
maxResults |
The maximum number of billing views to retrieve. Default is 100. |
nextToken |
The pagination token that is used on subsequent calls to list billing views. |
Lists the source views (managed Amazon Web Services billing views) associated with the billing view
Description
Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
See https://www.paws-r-sdk.com/docs/billing_list_source_views_for_billing_view/ for full documentation.
Usage
billing_list_source_views_for_billing_view(
arn,
maxResults = NULL,
nextToken = NULL
)
Arguments
arn |
[required] The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view. |
maxResults |
The number of entries a paginated response contains. |
nextToken |
The pagination token that is used on subsequent calls to list billing views. |
Lists tags associated with the billing view resource
Description
Lists tags associated with the billing view resource.
See https://www.paws-r-sdk.com/docs/billing_list_tags_for_resource/ for full documentation.
Usage
billing_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
An API operation for adding one or more tags (key-value pairs) to a resource
Description
An API operation for adding one or more tags (key-value pairs) to a resource.
See https://www.paws-r-sdk.com/docs/billing_tag_resource/ for full documentation.
Usage
billing_tag_resource(resourceArn, resourceTags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
resourceTags |
[required] A list of tag key value pairs that are associated with the resource. |
Removes one or more tags from a resource
Description
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
See https://www.paws-r-sdk.com/docs/billing_untag_resource/ for full documentation.
Usage
billing_untag_resource(resourceArn, resourceTagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
resourceTagKeys |
[required] A list of tag key value pairs that are associated with the resource. |
An API to update the attributes of the billing view
Description
An API to update the attributes of the billing view.
See https://www.paws-r-sdk.com/docs/billing_update_billing_view/ for full documentation.
Usage
billing_update_billing_view(
arn,
name = NULL,
description = NULL,
dataFilterExpression = NULL
)
Arguments
arn |
[required] The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view. |
name |
The name of the billing view. |
description |
The description of the billing view. |
dataFilterExpression |
See
Expression.
Billing view only supports |
AWSBillingConductor
Description
Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a proforma version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group.
This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductor user interface, see the Amazon Web Services Billing Conductor User Guide.
Usage
billingconductor(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- billingconductor( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
associate_accounts | Connects an array of account IDs in a consolidated billing family to a predefined billing group |
associate_pricing_rules | Connects an array of PricingRuleArns to a defined PricingPlan |
batch_associate_resources_to_custom_line_item | Associates a batch of resources to a percentage custom line item |
batch_disassociate_resources_from_custom_line_item | Disassociates a batch of resources from a percentage custom line item |
create_billing_group | Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation |
create_custom_line_item | Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period |
create_pricing_plan | Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups |
create_pricing_rule | Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans |
delete_billing_group | Deletes a billing group |
delete_custom_line_item | Deletes the custom line item identified by the given ARN in the current, or previous billing period |
delete_pricing_plan | Deletes a pricing plan |
delete_pricing_rule | Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN) |
disassociate_accounts | Removes the specified list of account IDs from the given billing group |
disassociate_pricing_rules | Disassociates a list of pricing rules from a pricing plan |
get_billing_group_cost_report | Retrieves the margin summary report, which includes the Amazon Web Services cost and charged amount (pro forma cost) by Amazon Web Service for a specific billing group |
list_account_associations | This is a paginated call to list linked accounts that are linked to the payer account for the specified time period |
list_billing_group_cost_reports | A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group |
list_billing_groups | A paginated call to retrieve a list of billing groups for the given billing period |
list_custom_line_items | A paginated call to get a list of all custom line items (FFLIs) for the given billing period |
list_custom_line_item_versions | A paginated call to get a list of all custom line item versions |
list_pricing_plans | A paginated call to get pricing plans for the given billing period |
list_pricing_plans_associated_with_pricing_rule | A list of the pricing plans that are associated with a pricing rule |
list_pricing_rules | Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans |
list_pricing_rules_associated_to_pricing_plan | Lists the pricing rules that are associated with a pricing plan |
list_resources_associated_to_custom_line_item | List the resources that are associated to a custom line item |
list_tags_for_resource | A list the tags for a resource |
tag_resource | Associates the specified tags to a resource with the specified resourceArn |
untag_resource | Deletes specified tags from a resource |
update_billing_group | This updates an existing billing group |
update_custom_line_item | Update an existing custom line item in the current or previous billing period |
update_pricing_plan | This updates an existing pricing plan |
update_pricing_rule | Updates an existing pricing rule |
Examples
## Not run:
svc <- billingconductor()
svc$associate_accounts(
Foo = 123
)
## End(Not run)
Connects an array of account IDs in a consolidated billing family to a predefined billing group
Description
Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30.
See https://www.paws-r-sdk.com/docs/billingconductor_associate_accounts/ for full documentation.
Usage
billingconductor_associate_accounts(Arn, AccountIds)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs. |
AccountIds |
[required] The associating array of account IDs. |
Connects an array of PricingRuleArns to a defined PricingPlan
Description
Connects an array of PricingRuleArns
to a defined PricingPlan
. The maximum number PricingRuleArn
that can be associated in one call is 30.
See https://www.paws-r-sdk.com/docs/billingconductor_associate_pricing_rules/ for full documentation.
Usage
billingconductor_associate_pricing_rules(Arn, PricingRuleArns)
Arguments
Arn |
[required] The |
PricingRuleArns |
[required] The |
Associates a batch of resources to a percentage custom line item
Description
Associates a batch of resources to a percentage custom line item.
See https://www.paws-r-sdk.com/docs/billingconductor_batch_associate_resources_to_custom_line_item/ for full documentation.
Usage
billingconductor_batch_associate_resources_to_custom_line_item(
TargetArn,
ResourceArns,
BillingPeriodRange = NULL
)
Arguments
TargetArn |
[required] A percentage custom line item ARN to associate the resources to. |
ResourceArns |
[required] A list containing the ARNs of the resources to be associated. |
BillingPeriodRange |
Disassociates a batch of resources from a percentage custom line item
Description
Disassociates a batch of resources from a percentage custom line item.
See https://www.paws-r-sdk.com/docs/billingconductor_batch_disassociate_resources_from_custom_line_item/ for full documentation.
Usage
billingconductor_batch_disassociate_resources_from_custom_line_item(
TargetArn,
ResourceArns,
BillingPeriodRange = NULL
)
Arguments
TargetArn |
[required] A percentage custom line item ARN to disassociate the resources from. |
ResourceArns |
[required] A list containing the ARNs of resources to be disassociated. |
BillingPeriodRange |
Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation
Description
Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.
See https://www.paws-r-sdk.com/docs/billingconductor_create_billing_group/ for full documentation.
Usage
billingconductor_create_billing_group(
ClientToken = NULL,
Name,
AccountGrouping,
ComputationPreference,
PrimaryAccountId = NULL,
Description = NULL,
Tags = NULL
)
Arguments
ClientToken |
The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. |
Name |
[required] The billing group name. The names must be unique. |
AccountGrouping |
[required] The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated billing family. |
ComputationPreference |
[required] The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group. |
PrimaryAccountId |
The account ID that serves as the main account in a billing group. |
Description |
The description of the billing group. |
Tags |
A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta. |
Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period
Description
Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.
See https://www.paws-r-sdk.com/docs/billingconductor_create_custom_line_item/ for full documentation.
Usage
billingconductor_create_custom_line_item(
ClientToken = NULL,
Name,
Description,
BillingGroupArn,
BillingPeriodRange = NULL,
Tags = NULL,
ChargeDetails,
AccountId = NULL
)
Arguments
ClientToken |
The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. |
Name |
[required] The name of the custom line item. |
Description |
[required] The description of the custom line item. This is shown on the Bills page in association with the charge value. |
BillingGroupArn |
[required] The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. |
BillingPeriodRange |
A time range for which the custom line item is effective. |
Tags |
A map that contains tag keys and tag values that are attached to a custom line item. |
ChargeDetails |
[required] A |
AccountId |
The Amazon Web Services account in which this custom line item will be applied to. |
Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups
Description
Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.
See https://www.paws-r-sdk.com/docs/billingconductor_create_pricing_plan/ for full documentation.
Usage
billingconductor_create_pricing_plan(
ClientToken = NULL,
Name,
Description = NULL,
PricingRuleArns = NULL,
Tags = NULL
)
Arguments
ClientToken |
The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. |
Name |
[required] The name of the pricing plan. The names must be unique to each pricing plan. |
Description |
The description of the pricing plan. |
PricingRuleArns |
A list of Amazon Resource Names (ARNs) that define the pricing plan parameters. |
Tags |
A map that contains tag keys and tag values that are attached to a pricing plan. |
Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans
Description
Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.
See https://www.paws-r-sdk.com/docs/billingconductor_create_pricing_rule/ for full documentation.
Usage
billingconductor_create_pricing_rule(
ClientToken = NULL,
Name,
Description = NULL,
Scope,
Type,
ModifierPercentage = NULL,
Service = NULL,
Tags = NULL,
BillingEntity = NULL,
Tiering = NULL,
UsageType = NULL,
Operation = NULL
)
Arguments
ClientToken |
The token that's needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. |
Name |
[required] The pricing rule name. The names must be unique to each pricing rule. |
Description |
The pricing rule description. |
Scope |
[required] The scope of pricing rule that indicates if it's globally applicable, or it's service-specific. |
Type |
[required] The type of pricing rule. |
ModifierPercentage |
A percentage modifier that's applied on the public pricing rates. |
Service |
If the |
Tags |
A map that contains tag keys and tag values that are attached to a pricing rule. |
BillingEntity |
The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace. |
Tiering |
The set of tiering configurations for the pricing rule. |
UsageType |
Usage type is the unit that each service uses to measure the usage of a specific type of resource. If the </p> |
Operation |
Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item. If the |
Deletes a billing group
Description
Deletes a billing group.
See https://www.paws-r-sdk.com/docs/billingconductor_delete_billing_group/ for full documentation.
Usage
billingconductor_delete_billing_group(Arn)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the billing group that you're deleting. |
Deletes the custom line item identified by the given ARN in the current, or previous billing period
Description
Deletes the custom line item identified by the given ARN in the current, or previous billing period.
See https://www.paws-r-sdk.com/docs/billingconductor_delete_custom_line_item/ for full documentation.
Usage
billingconductor_delete_custom_line_item(Arn, BillingPeriodRange = NULL)
Arguments
Arn |
[required] The ARN of the custom line item to be deleted. |
BillingPeriodRange |
Deletes a pricing plan
Description
Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.
See https://www.paws-r-sdk.com/docs/billingconductor_delete_pricing_plan/ for full documentation.
Usage
billingconductor_delete_pricing_plan(Arn)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the pricing plan that you're deleting. |
Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN)
Description
Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).
See https://www.paws-r-sdk.com/docs/billingconductor_delete_pricing_rule/ for full documentation.
Usage
billingconductor_delete_pricing_rule(Arn)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the pricing rule that you are deleting. |
Removes the specified list of account IDs from the given billing group
Description
Removes the specified list of account IDs from the given billing group.
See https://www.paws-r-sdk.com/docs/billingconductor_disassociate_accounts/ for full documentation.
Usage
billingconductor_disassociate_accounts(Arn, AccountIds)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from. |
AccountIds |
[required] The array of account IDs to disassociate. |
Disassociates a list of pricing rules from a pricing plan
Description
Disassociates a list of pricing rules from a pricing plan.
See https://www.paws-r-sdk.com/docs/billingconductor_disassociate_pricing_rules/ for full documentation.
Usage
billingconductor_disassociate_pricing_rules(Arn, PricingRuleArns)
Arguments
Arn |
[required] The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from. |
PricingRuleArns |
[required] A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated. |
Retrieves the margin summary report, which includes the Amazon Web Services cost and charged amount (pro forma cost) by Amazon Web Service for a specific billing group
Description
Retrieves the margin summary report, which includes the Amazon Web Services cost and charged amount (pro forma cost) by Amazon Web Service for a specific billing group.
See https://www.paws-r-sdk.com/docs/billingconductor_get_billing_group_cost_report/ for full documentation.
Usage
billingconductor_get_billing_group_cost_report(
Arn,
BillingPeriodRange = NULL,
GroupBy = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Arn |
[required] The Amazon Resource Number (ARN) that uniquely identifies the billing group. |
BillingPeriodRange |
A time range for which the margin summary is effective. You can specify up to 12 months. |
GroupBy |
A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the Amazon Web Service name or the billing period. |
MaxResults |
The maximum number of margin summary reports to retrieve. |
NextToken |
The pagination token used on subsequent calls to get reports. |
This is a paginated call to list linked accounts that are linked to the payer account for the specified time period
Description
This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group that's associated with the linked account.
See https://www.paws-r-sdk.com/docs/billingconductor_list_account_associations/ for full documentation.
Usage
billingconductor_list_account_associations(
BillingPeriod = NULL,
Filters = NULL,
NextToken = NULL
)
Arguments
BillingPeriod |
The preferred billing period to get account associations. |
Filters |
The filter on the account ID of the linked account, or any of the following:
|
NextToken |
The pagination token that's used on subsequent calls to retrieve accounts. |
A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group
Description
A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.
See https://www.paws-r-sdk.com/docs/billingconductor_list_billing_group_cost_reports/ for full documentation.
Usage
billingconductor_list_billing_group_cost_reports(
BillingPeriod = NULL,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
BillingPeriod |
The preferred billing period for your report. |
MaxResults |
The maximum number of reports to retrieve. |
NextToken |
The pagination token that's used on subsequent calls to get reports. |
Filters |
A |
A paginated call to retrieve a list of billing groups for the given billing period
Description
A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.
See https://www.paws-r-sdk.com/docs/billingconductor_list_billing_groups/ for full documentation.
Usage
billingconductor_list_billing_groups(
BillingPeriod = NULL,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
BillingPeriod |
The preferred billing period to get billing groups. |
MaxResults |
The maximum number of billing groups to retrieve. |
NextToken |
The pagination token that's used on subsequent calls to get billing groups. |
Filters |
A |
A paginated call to get a list of all custom line item versions
Description
A paginated call to get a list of all custom line item versions.
See https://www.paws-r-sdk.com/docs/billingconductor_list_custom_line_item_versions/ for full documentation.
Usage
billingconductor_list_custom_line_item_versions(
Arn,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) for the custom line item. |
MaxResults |
The maximum number of custom line item versions to retrieve. |
NextToken |
The pagination token that's used on subsequent calls to retrieve custom line item versions. |
Filters |
A |
A paginated call to get a list of all custom line items (FFLIs) for the given billing period
Description
A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used.
See https://www.paws-r-sdk.com/docs/billingconductor_list_custom_line_items/ for full documentation.
Usage
billingconductor_list_custom_line_items(
BillingPeriod = NULL,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
BillingPeriod |
The preferred billing period to get custom line items (FFLIs). |
MaxResults |
The maximum number of billing groups to retrieve. |
NextToken |
The pagination token that's used on subsequent calls to get custom line items (FFLIs). |
Filters |
A |
A paginated call to get pricing plans for the given billing period
Description
A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.
See https://www.paws-r-sdk.com/docs/billingconductor_list_pricing_plans/ for full documentation.
Usage
billingconductor_list_pricing_plans(
BillingPeriod = NULL,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
BillingPeriod |
The preferred billing period to get pricing plan. |
Filters |
A |
MaxResults |
The maximum number of pricing plans to retrieve. |
NextToken |
The pagination token that's used on subsequent call to get pricing plans. |
A list of the pricing plans that are associated with a pricing rule
Description
A list of the pricing plans that are associated with a pricing rule.
See https://www.paws-r-sdk.com/docs/billingconductor_list_pricing_plans_associated_with_pricing_rule/ for full documentation.
Usage
billingconductor_list_pricing_plans_associated_with_pricing_rule(
BillingPeriod = NULL,
PricingRuleArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
BillingPeriod |
The pricing plan billing period for which associations will be listed. |
PricingRuleArn |
[required] The pricing rule Amazon Resource Name (ARN) for which associations will be listed. |
MaxResults |
The optional maximum number of pricing rule associations to retrieve. |
NextToken |
The optional pagination token returned by a previous call. |
Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans
Description
Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.
See https://www.paws-r-sdk.com/docs/billingconductor_list_pricing_rules/ for full documentation.
Usage
billingconductor_list_pricing_rules(
BillingPeriod = NULL,
Filters = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
BillingPeriod |
The preferred billing period to get the pricing plan. |
Filters |
A |
MaxResults |
The maximum number of pricing rules to retrieve. |
NextToken |
The pagination token that's used on subsequent call to get pricing rules. |
Lists the pricing rules that are associated with a pricing plan
Description
Lists the pricing rules that are associated with a pricing plan.
See https://www.paws-r-sdk.com/docs/billingconductor_list_pricing_rules_associated_to_pricing_plan/ for full documentation.
Usage
billingconductor_list_pricing_rules_associated_to_pricing_plan(
BillingPeriod = NULL,
PricingPlanArn,
MaxResults = NULL,
NextToken = NULL
)
Arguments
BillingPeriod |
The billing period for which the pricing rule associations are to be listed. |
PricingPlanArn |
[required] The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed. |
MaxResults |
The optional maximum number of pricing rule associations to retrieve. |
NextToken |
The optional pagination token returned by a previous call. |
List the resources that are associated to a custom line item
Description
List the resources that are associated to a custom line item.
See https://www.paws-r-sdk.com/docs/billingconductor_list_resources_associated_to_custom_line_item/ for full documentation.
Usage
billingconductor_list_resources_associated_to_custom_line_item(
BillingPeriod = NULL,
Arn,
MaxResults = NULL,
NextToken = NULL,
Filters = NULL
)
Arguments
BillingPeriod |
The billing period for which the resource associations will be listed. |
Arn |
[required] The ARN of the custom line item for which the resource associations will be listed. |
MaxResults |
(Optional) The maximum number of resource associations to be retrieved. |
NextToken |
(Optional) The pagination token that's returned by a previous request. |
Filters |
(Optional) A |
A list the tags for a resource
Description
A list the tags for a resource.
See https://www.paws-r-sdk.com/docs/billingconductor_list_tags_for_resource/ for full documentation.
Usage
billingconductor_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) that identifies the resource to list the tags. |
Associates the specified tags to a resource with the specified resourceArn
Description
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a resource are not specified in the request parameters, they are not changed.
See https://www.paws-r-sdk.com/docs/billingconductor_tag_resource/ for full documentation.
Usage
billingconductor_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource to which to add tags. |
Tags |
[required] The tags to add to the resource as a list of key-value pairs. |
Deletes specified tags from a resource
Description
Deletes specified tags from a resource.
See https://www.paws-r-sdk.com/docs/billingconductor_untag_resource/ for full documentation.
Usage
billingconductor_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource to which to delete tags. |
TagKeys |
[required] The tags to delete from the resource as a list of key-value pairs. |
This updates an existing billing group
Description
This updates an existing billing group.
See https://www.paws-r-sdk.com/docs/billingconductor_update_billing_group/ for full documentation.
Usage
billingconductor_update_billing_group(
Arn,
Name = NULL,
Status = NULL,
ComputationPreference = NULL,
Description = NULL,
AccountGrouping = NULL
)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the billing group being updated. |
Name |
The name of the billing group. The names must be unique to each billing group. |
Status |
The status of the billing group. Only one of the valid values can be used. |
ComputationPreference |
The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group. |
Description |
A description of the billing group. |
AccountGrouping |
Specifies if the billing group has automatic account association
( |
Update an existing custom line item in the current or previous billing period
Description
Update an existing custom line item in the current or previous billing period.
See https://www.paws-r-sdk.com/docs/billingconductor_update_custom_line_item/ for full documentation.
Usage
billingconductor_update_custom_line_item(
Arn,
Name = NULL,
Description = NULL,
ChargeDetails = NULL,
BillingPeriodRange = NULL
)
Arguments
Arn |
[required] The ARN of the custom line item to be updated. |
Name |
The new name for the custom line item. |
Description |
The new line item description of the custom line item. |
ChargeDetails |
A |
BillingPeriodRange |
This updates an existing pricing plan
Description
This updates an existing pricing plan.
See https://www.paws-r-sdk.com/docs/billingconductor_update_pricing_plan/ for full documentation.
Usage
billingconductor_update_pricing_plan(Arn, Name = NULL, Description = NULL)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the pricing plan that you're updating. |
Name |
The name of the pricing plan. The name must be unique to each pricing plan. |
Description |
The description of the pricing plan. |
Updates an existing pricing rule
Description
Updates an existing pricing rule.
See https://www.paws-r-sdk.com/docs/billingconductor_update_pricing_rule/ for full documentation.
Usage
billingconductor_update_pricing_rule(
Arn,
Name = NULL,
Description = NULL,
Type = NULL,
ModifierPercentage = NULL,
Tiering = NULL
)
Arguments
Arn |
[required] The Amazon Resource Name (ARN) of the pricing rule to update. |
Name |
The new name of the pricing rule. The name must be unique to each pricing rule. |
Description |
The new description for the pricing rule. |
Type |
The new pricing rule type. |
ModifierPercentage |
The new modifier to show pricing plan rates as a percentage. |
Tiering |
The set of tiering configurations for the pricing rule. |
AWS Budgets
Description
Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.
Budgets provide you with a way to see the following information:
How close your plan is to your budgeted amount or to the free tier limits
Your usage-to-date, including how much you've used of your Reserved Instances (RIs)
Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
How much of your budget has been used
Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:
-
Cost budgets - Plan how much you want to spend on a service.
-
Usage budgets - Plan how much you want to use one or more services.
-
RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.
-
RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.
Service Endpoint
The Amazon Web Services Budgets API provides the following endpoint:
https://budgets.amazonaws.com
For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
Usage
budgets(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- budgets( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_budget | Creates a budget and, if included, notifications and subscribers |
create_budget_action | Creates a budget action |
create_notification | Creates a notification |
create_subscriber | Creates a subscriber |
delete_budget | Deletes a budget |
delete_budget_action | Deletes a budget action |
delete_notification | Deletes a notification |
delete_subscriber | Deletes a subscriber |
describe_budget | Describes a budget |
describe_budget_action | Describes a budget action detail |
describe_budget_action_histories | Describes a budget action history detail |
describe_budget_actions_for_account | Describes all of the budget actions for an account |
describe_budget_actions_for_budget | Describes all of the budget actions for a budget |
describe_budget_notifications_for_account | Lists the budget names and notifications that are associated with an account |
describe_budget_performance_history | Describes the history for DAILY, MONTHLY, and QUARTERLY budgets |
describe_budgets | Lists the budgets that are associated with an account |
describe_notifications_for_budget | Lists the notifications that are associated with a budget |
describe_subscribers_for_notification | Lists the subscribers that are associated with a notification |
execute_budget_action | Executes a budget action |
list_tags_for_resource | Lists tags associated with a budget or budget action resource |
tag_resource | Creates tags for a budget or budget action resource |
untag_resource | Deletes tags associated with a budget or budget action resource |
update_budget | Updates a budget |
update_budget_action | Updates a budget action |
update_notification | Updates a notification |
update_subscriber | Updates a subscriber |
Examples
## Not run:
svc <- budgets()
svc$create_budget(
Foo = 123
)
## End(Not run)
Creates a budget and, if included, notifications and subscribers
Description
Creates a budget and, if included, notifications and subscribers.
See https://www.paws-r-sdk.com/docs/budgets_create_budget/ for full documentation.
Usage
budgets_create_budget(
AccountId,
Budget,
NotificationsWithSubscribers = NULL,
ResourceTags = NULL
)
Arguments
AccountId |
[required] The |
Budget |
[required] The budget object that you want to create. |
NotificationsWithSubscribers |
A notification that you want to associate with a budget. A budget can
have up to five notifications, and each notification can have one SNS
subscriber and up to 10 email subscribers. If you include notifications
and subscribers in your |
ResourceTags |
An optional list of tags to associate with the specified budget. Each tag consists of a key and a value, and each key must be unique for the resource. |
Creates a budget action
Description
Creates a budget action.
See https://www.paws-r-sdk.com/docs/budgets_create_budget_action/ for full documentation.
Usage
budgets_create_budget_action(
AccountId,
BudgetName,
NotificationType,
ActionType,
ActionThreshold,
Definition,
ExecutionRoleArn,
ApprovalModel,
Subscribers,
ResourceTags = NULL
)
Arguments
AccountId |
[required] |
BudgetName |
[required] |
NotificationType |
[required] |
ActionType |
[required] The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition. |
ActionThreshold |
[required] |
Definition |
[required] |
ExecutionRoleArn |
[required] The role passed for action execution and reversion. Roles and actions must be in the same account. |
ApprovalModel |
[required] This specifies if the action needs manual or automatic approval. |
Subscribers |
[required] |
ResourceTags |
An optional list of tags to associate with the specified budget action. Each tag consists of a key and a value, and each key must be unique for the resource. |
Creates a notification
Description
Creates a notification. You must create the budget before you create the associated notification.
See https://www.paws-r-sdk.com/docs/budgets_create_notification/ for full documentation.
Usage
budgets_create_notification(AccountId, BudgetName, Notification, Subscribers)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account. |
Notification |
[required] The notification that you want to create. |
Subscribers |
[required] A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers. |
Creates a subscriber
Description
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
See https://www.paws-r-sdk.com/docs/budgets_create_subscriber/ for full documentation.
Usage
budgets_create_subscriber(AccountId, BudgetName, Notification, Subscriber)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget that you want to subscribe to. Budget names must be unique within an account. |
Notification |
[required] The notification that you want to create a subscriber for. |
Subscriber |
[required] The subscriber that you want to associate with a budget notification. |
Deletes a budget
Description
Deletes a budget. You can delete your budget at any time.
See https://www.paws-r-sdk.com/docs/budgets_delete_budget/ for full documentation.
Usage
budgets_delete_budget(AccountId, BudgetName)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget that you want to delete. |
Deletes a budget action
Description
Deletes a budget action.
See https://www.paws-r-sdk.com/docs/budgets_delete_budget_action/ for full documentation.
Usage
budgets_delete_budget_action(AccountId, BudgetName, ActionId)
Arguments
AccountId |
[required] |
BudgetName |
[required] |
ActionId |
[required] A system-generated universally unique identifier (UUID) for the action. |
Deletes a notification
Description
Deletes a notification.
See https://www.paws-r-sdk.com/docs/budgets_delete_notification/ for full documentation.
Usage
budgets_delete_notification(AccountId, BudgetName, Notification)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget whose notification you want to delete. |
Notification |
[required] The notification that you want to delete. |
Deletes a subscriber
Description
Deletes a subscriber.
See https://www.paws-r-sdk.com/docs/budgets_delete_subscriber/ for full documentation.
Usage
budgets_delete_subscriber(AccountId, BudgetName, Notification, Subscriber)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget whose subscriber you want to delete. |
Notification |
[required] The notification whose subscriber you want to delete. |
Subscriber |
[required] The subscriber that you want to delete. |
Describes a budget
Description
Describes a budget.
See https://www.paws-r-sdk.com/docs/budgets_describe_budget/ for full documentation.
Usage
budgets_describe_budget(AccountId, BudgetName)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget that you want a description of. |
Describes a budget action detail
Description
Describes a budget action detail.
See https://www.paws-r-sdk.com/docs/budgets_describe_budget_action/ for full documentation.
Usage
budgets_describe_budget_action(AccountId, BudgetName, ActionId)
Arguments
AccountId |
[required] |
BudgetName |
[required] |
ActionId |
[required] A system-generated universally unique identifier (UUID) for the action. |
Describes a budget action history detail
Description
Describes a budget action history detail.
See https://www.paws-r-sdk.com/docs/budgets_describe_budget_action_histories/ for full documentation.
Usage
budgets_describe_budget_action_histories(
AccountId,
BudgetName,
ActionId,
TimePeriod = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AccountId |
[required] |
BudgetName |
[required] |
ActionId |
[required] A system-generated universally unique identifier (UUID) for the action. |
TimePeriod |
|
MaxResults |
|
NextToken |
Describes all of the budget actions for an account
Description
Describes all of the budget actions for an account.
See https://www.paws-r-sdk.com/docs/budgets_describe_budget_actions_for_account/ for full documentation.
Usage
budgets_describe_budget_actions_for_account(
AccountId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AccountId |
[required] |
MaxResults |
|
NextToken |
Describes all of the budget actions for a budget
Description
Describes all of the budget actions for a budget.
See https://www.paws-r-sdk.com/docs/budgets_describe_budget_actions_for_budget/ for full documentation.
Usage
budgets_describe_budget_actions_for_budget(
AccountId,
BudgetName,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AccountId |
[required] |
BudgetName |
[required] |
MaxResults |
|
NextToken |
Lists the budget names and notifications that are associated with an account
Description
Lists the budget names and notifications that are associated with an account.
See https://www.paws-r-sdk.com/docs/budgets_describe_budget_notifications_for_account/ for full documentation.
Usage
budgets_describe_budget_notifications_for_account(
AccountId,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AccountId |
[required] |
MaxResults |
An integer that represents how many budgets a paginated response contains. The default is 50. |
NextToken |
Describes the history for DAILY, MONTHLY, and QUARTERLY budgets
Description
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets. Budget history isn't available for ANNUAL
budgets.
See https://www.paws-r-sdk.com/docs/budgets_describe_budget_performance_history/ for full documentation.
Usage
budgets_describe_budget_performance_history(
AccountId,
BudgetName,
TimePeriod = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AccountId |
[required] |
BudgetName |
[required] |
TimePeriod |
Retrieves how often the budget went into an |
MaxResults |
|
NextToken |
Lists the budgets that are associated with an account
Description
Lists the budgets that are associated with an account.
See https://www.paws-r-sdk.com/docs/budgets_describe_budgets/ for full documentation.
Usage
budgets_describe_budgets(AccountId, MaxResults = NULL, NextToken = NULL)
Arguments
AccountId |
[required] The |
MaxResults |
An integer that represents how many budgets a paginated response contains. The default is 100. |
NextToken |
The pagination token that you include in your request to indicate the next set of results that you want to retrieve. |
Lists the notifications that are associated with a budget
Description
Lists the notifications that are associated with a budget.
See https://www.paws-r-sdk.com/docs/budgets_describe_notifications_for_budget/ for full documentation.
Usage
budgets_describe_notifications_for_budget(
AccountId,
BudgetName,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget whose notifications you want descriptions of. |
MaxResults |
An optional integer that represents how many entries a paginated response contains. |
NextToken |
The pagination token that you include in your request to indicate the next set of results that you want to retrieve. |
Lists the subscribers that are associated with a notification
Description
Lists the subscribers that are associated with a notification.
See https://www.paws-r-sdk.com/docs/budgets_describe_subscribers_for_notification/ for full documentation.
Usage
budgets_describe_subscribers_for_notification(
AccountId,
BudgetName,
Notification,
MaxResults = NULL,
NextToken = NULL
)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget whose subscribers you want descriptions of. |
Notification |
[required] The notification whose subscribers you want to list. |
MaxResults |
An optional integer that represents how many entries a paginated response contains. |
NextToken |
The pagination token that you include in your request to indicate the next set of results that you want to retrieve. |
Executes a budget action
Description
Executes a budget action.
See https://www.paws-r-sdk.com/docs/budgets_execute_budget_action/ for full documentation.
Usage
budgets_execute_budget_action(AccountId, BudgetName, ActionId, ExecutionType)
Arguments
AccountId |
[required] |
BudgetName |
[required] |
ActionId |
[required] A system-generated universally unique identifier (UUID) for the action. |
ExecutionType |
[required] The type of execution. |
Lists tags associated with a budget or budget action resource
Description
Lists tags associated with a budget or budget action resource.
See https://www.paws-r-sdk.com/docs/budgets_list_tags_for_resource/ for full documentation.
Usage
budgets_list_tags_for_resource(ResourceARN)
Arguments
ResourceARN |
[required] The unique identifier for the resource. |
Creates tags for a budget or budget action resource
Description
Creates tags for a budget or budget action resource.
See https://www.paws-r-sdk.com/docs/budgets_tag_resource/ for full documentation.
Usage
budgets_tag_resource(ResourceARN, ResourceTags)
Arguments
ResourceARN |
[required] The unique identifier for the resource. |
ResourceTags |
[required] The tags associated with the resource. |
Deletes tags associated with a budget or budget action resource
Description
Deletes tags associated with a budget or budget action resource.
See https://www.paws-r-sdk.com/docs/budgets_untag_resource/ for full documentation.
Usage
budgets_untag_resource(ResourceARN, ResourceTagKeys)
Arguments
ResourceARN |
[required] The unique identifier for the resource. |
ResourceTagKeys |
[required] The key that's associated with the tag. |
Updates a budget
Description
Updates a budget. You can change every part of a budget except for the budgetName
and the calculatedSpend
. When you modify a budget, the calculatedSpend
drops to zero until Amazon Web Services has new usage data to use for forecasting.
See https://www.paws-r-sdk.com/docs/budgets_update_budget/ for full documentation.
Usage
budgets_update_budget(AccountId, NewBudget)
Arguments
AccountId |
[required] The |
NewBudget |
[required] The budget that you want to update your budget to. |
Updates a budget action
Description
Updates a budget action.
See https://www.paws-r-sdk.com/docs/budgets_update_budget_action/ for full documentation.
Usage
budgets_update_budget_action(
AccountId,
BudgetName,
ActionId,
NotificationType = NULL,
ActionThreshold = NULL,
Definition = NULL,
ExecutionRoleArn = NULL,
ApprovalModel = NULL,
Subscribers = NULL
)
Arguments
AccountId |
[required] |
BudgetName |
[required] |
ActionId |
[required] A system-generated universally unique identifier (UUID) for the action. |
NotificationType |
|
ActionThreshold |
|
Definition |
|
ExecutionRoleArn |
The role passed for action execution and reversion. Roles and actions must be in the same account. |
ApprovalModel |
This specifies if the action needs manual or automatic approval. |
Subscribers |
Updates a notification
Description
Updates a notification.
See https://www.paws-r-sdk.com/docs/budgets_update_notification/ for full documentation.
Usage
budgets_update_notification(
AccountId,
BudgetName,
OldNotification,
NewNotification
)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget whose notification you want to update. |
OldNotification |
[required] The previous notification that is associated with a budget. |
NewNotification |
[required] The updated notification to be associated with a budget. |
Updates a subscriber
Description
Updates a subscriber.
See https://www.paws-r-sdk.com/docs/budgets_update_subscriber/ for full documentation.
Usage
budgets_update_subscriber(
AccountId,
BudgetName,
Notification,
OldSubscriber,
NewSubscriber
)
Arguments
AccountId |
[required] The |
BudgetName |
[required] The name of the budget whose subscriber you want to update. |
Notification |
[required] The notification whose subscriber you want to update. |
OldSubscriber |
[required] The previous subscriber that is associated with a budget notification. |
NewSubscriber |
[required] The updated subscriber that is associated with a budget notification. |
AWS Cost and Usage Report Service
Description
You can use the Amazon Web Services Cost and Usage Report API to programmatically create, query, and delete Amazon Web Services Cost and Usage Report definitions.
Amazon Web Services Cost and Usage Report track the monthly Amazon Web Services costs and usage associated with your Amazon Web Services account. The report contains line items for each unique combination of Amazon Web Services product, usage type, and operation that your Amazon Web Services account uses. You can configure the Amazon Web Services Cost and Usage Report to show only the data that you want, using the Amazon Web Services Cost and Usage Report API.
Service Endpoint
The Amazon Web Services Cost and Usage Report API provides the following endpoint:
cur.us-east-1.amazonaws.com
Usage
costandusagereportservice(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- costandusagereportservice( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
delete_report_definition | Deletes the specified report |
describe_report_definitions | Lists the Amazon Web Services Cost and Usage Report available to this account |
list_tags_for_resource | Lists the tags associated with the specified report definition |
modify_report_definition | Allows you to programmatically update your report preferences |
put_report_definition | Creates a new report using the description that you provide |
tag_resource | Associates a set of tags with a report definition |
untag_resource | Disassociates a set of tags from a report definition |
Examples
## Not run:
svc <- costandusagereportservice()
# The following example deletes the AWS Cost and Usage report named
# ExampleReport.
svc$delete_report_definition(
ReportName = "ExampleReport"
)
## End(Not run)
Deletes the specified report
Description
Deletes the specified report. Any tags associated with the report are also deleted.
See https://www.paws-r-sdk.com/docs/costandusagereportservice_delete_report_definition/ for full documentation.
Usage
costandusagereportservice_delete_report_definition(ReportName)
Arguments
ReportName |
[required] The name of the report that you want to delete. The name must be unique, is case sensitive, and can't include spaces. |
Lists the Amazon Web Services Cost and Usage Report available to this account
Description
Lists the Amazon Web Services Cost and Usage Report available to this account.
See https://www.paws-r-sdk.com/docs/costandusagereportservice_describe_report_definitions/ for full documentation.
Usage
costandusagereportservice_describe_report_definitions(
MaxResults = NULL,
NextToken = NULL
)
Arguments
MaxResults |
|
NextToken |
Lists the tags associated with the specified report definition
Description
Lists the tags associated with the specified report definition.
See https://www.paws-r-sdk.com/docs/costandusagereportservice_list_tags_for_resource/ for full documentation.
Usage
costandusagereportservice_list_tags_for_resource(ReportName)
Arguments
ReportName |
[required] The report name of the report definition that tags are to be returned for. |
Allows you to programmatically update your report preferences
Description
Allows you to programmatically update your report preferences.
See https://www.paws-r-sdk.com/docs/costandusagereportservice_modify_report_definition/ for full documentation.
Usage
costandusagereportservice_modify_report_definition(
ReportName,
ReportDefinition
)
Arguments
ReportName |
[required] |
ReportDefinition |
[required] |
Creates a new report using the description that you provide
Description
Creates a new report using the description that you provide.
See https://www.paws-r-sdk.com/docs/costandusagereportservice_put_report_definition/ for full documentation.
Usage
costandusagereportservice_put_report_definition(ReportDefinition, Tags = NULL)
Arguments
ReportDefinition |
[required] Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information. |
Tags |
The tags to be assigned to the report definition resource. |
Associates a set of tags with a report definition
Description
Associates a set of tags with a report definition.
See https://www.paws-r-sdk.com/docs/costandusagereportservice_tag_resource/ for full documentation.
Usage
costandusagereportservice_tag_resource(ReportName, Tags)
Arguments
ReportName |
[required] The report name of the report definition that tags are to be associated with. |
Tags |
[required] The tags to be assigned to the report definition resource. |
Disassociates a set of tags from a report definition
Description
Disassociates a set of tags from a report definition.
See https://www.paws-r-sdk.com/docs/costandusagereportservice_untag_resource/ for full documentation.
Usage
costandusagereportservice_untag_resource(ReportName, TagKeys)
Arguments
ReportName |
[required] The report name of the report definition that tags are to be disassociated from. |
TagKeys |
[required] The tags to be disassociated from the report definition resource. |
AWS Cost Explorer Service
Description
You can use the Cost Explorer API to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data. This might include the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
-
https://ce.us-east-1.amazonaws.com
For information about the costs that are associated with the Cost Explorer API, see Amazon Web Services Cost Management Pricing.
Usage
costexplorer(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- costexplorer( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_anomaly_monitor | Creates a new cost anomaly detection monitor with the requested type and monitor specification |
create_anomaly_subscription | Adds an alert subscription to a cost anomaly detection monitor |
create_cost_category_definition | Creates a new Cost Category with the requested name and rules |
delete_anomaly_monitor | Deletes a cost anomaly monitor |
delete_anomaly_subscription | Deletes a cost anomaly subscription |
delete_cost_category_definition | Deletes a Cost Category |
describe_cost_category_definition | Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account |
get_anomalies | Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object |
get_anomaly_monitors | Retrieves the cost anomaly monitor definitions for your account |
get_anomaly_subscriptions | Retrieves the cost anomaly subscription objects for your account |
get_approximate_usage_records | Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity |
get_commitment_purchase_analysis | Retrieves a commitment purchase analysis result based on the AnalysisId |
get_cost_and_usage | Retrieves cost and usage metrics for your account |
get_cost_and_usage_with_resources | Retrieves cost and usage metrics with resources for your account |
get_cost_categories | Retrieves an array of Cost Category names and values incurred cost |
get_cost_forecast | Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs |
get_dimension_values | Retrieves all available filter values for a specified filter over a period of time |
get_reservation_coverage | Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation |
get_reservation_purchase_recommendation | Gets recommendations for reservation purchases |
get_reservation_utilization | Retrieves the reservation utilization for your account |
get_rightsizing_recommendation | Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances |
get_savings_plan_purchase_recommendation_details | Retrieves the details for a Savings Plan recommendation |
get_savings_plans_coverage | Retrieves the Savings Plans covered for your account |
get_savings_plans_purchase_recommendation | Retrieves the Savings Plans recommendations for your account |
get_savings_plans_utilization | Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity |
get_savings_plans_utilization_details | Retrieves attribute data along with aggregate utilization and savings data for a given time period |
get_tags | Queries for available tag keys and tag values for a specified period |
get_usage_forecast | Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage |
list_commitment_purchase_analyses | Lists the commitment purchase analyses for your account |
list_cost_allocation_tag_backfill_history | Retrieves a list of your historical cost allocation tag backfill requests |
list_cost_allocation_tags | Get a list of cost allocation tags |
list_cost_category_definitions | Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account |
list_savings_plans_purchase_recommendation_generation | Retrieves a list of your historical recommendation generations within the past 30 days |
list_tags_for_resource | Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN) |
provide_anomaly_feedback | Modifies the feedback property of a given cost anomaly |
start_commitment_purchase_analysis | Specifies the parameters of a planned commitment purchase and starts the generation of the analysis |
start_cost_allocation_tag_backfill | Request a cost allocation tag backfill |
start_savings_plans_purchase_recommendation_generation | Requests a Savings Plans recommendation generation |
tag_resource | An API operation for adding one or more tags (key-value pairs) to a resource |
untag_resource | Removes one or more tags from a resource |
update_anomaly_monitor | Updates an existing cost anomaly monitor |
update_anomaly_subscription | Updates an existing cost anomaly subscription |
update_cost_allocation_tags_status | Updates status for cost allocation tags in bulk, with maximum batch size of 20 |
update_cost_category_definition | Updates an existing Cost Category |
Examples
## Not run:
svc <- costexplorer()
svc$create_anomaly_monitor(
Foo = 123
)
## End(Not run)
Creates a new cost anomaly detection monitor with the requested type and monitor specification
Description
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
See https://www.paws-r-sdk.com/docs/costexplorer_create_anomaly_monitor/ for full documentation.
Usage
costexplorer_create_anomaly_monitor(AnomalyMonitor, ResourceTags = NULL)
Arguments
AnomalyMonitor |
[required] The cost anomaly detection monitor object that you want to create. |
ResourceTags |
An optional list of tags to associate with the specified
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
|
Adds an alert subscription to a cost anomaly detection monitor
Description
Adds an alert subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set an absolute or percentage threshold and a time frequency for receiving notifications.
See https://www.paws-r-sdk.com/docs/costexplorer_create_anomaly_subscription/ for full documentation.
Usage
costexplorer_create_anomaly_subscription(
AnomalySubscription,
ResourceTags = NULL
)
Arguments
AnomalySubscription |
[required] The cost anomaly subscription object that you want to create. |
ResourceTags |
An optional list of tags to associate with the specified
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
|
Creates a new Cost Category with the requested name and rules
Description
Creates a new Cost Category with the requested name and rules.
See https://www.paws-r-sdk.com/docs/costexplorer_create_cost_category_definition/ for full documentation.
Usage
costexplorer_create_cost_category_definition(
Name,
EffectiveStart = NULL,
RuleVersion,
Rules,
DefaultValue = NULL,
SplitChargeRules = NULL,
ResourceTags = NULL
)
Arguments
Name |
[required] |
EffectiveStart |
The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future. |
RuleVersion |
[required] |
Rules |
[required] The Cost Category rules used to categorize costs. For more information, see CostCategoryRule. |
DefaultValue |
|
SplitChargeRules |
The split charge rules used to allocate your charges between your Cost Category values. |
ResourceTags |
An optional list of tags to associate with the specified
Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
|
Deletes a cost anomaly monitor
Description
Deletes a cost anomaly monitor.
See https://www.paws-r-sdk.com/docs/costexplorer_delete_anomaly_monitor/ for full documentation.
Usage
costexplorer_delete_anomaly_monitor(MonitorArn)
Arguments
MonitorArn |
[required] The unique identifier of the cost anomaly monitor that you want to delete. |
Deletes a cost anomaly subscription
Description
Deletes a cost anomaly subscription.
See https://www.paws-r-sdk.com/docs/costexplorer_delete_anomaly_subscription/ for full documentation.
Usage
costexplorer_delete_anomaly_subscription(SubscriptionArn)
Arguments
SubscriptionArn |
[required] The unique identifier of the cost anomaly subscription that you want to delete. |
Deletes a Cost Category
Description
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
See https://www.paws-r-sdk.com/docs/costexplorer_delete_cost_category_definition/ for full documentation.
Usage
costexplorer_delete_cost_category_definition(CostCategoryArn)
Arguments
CostCategoryArn |
[required] The unique identifier for your Cost Category. |
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account
Description
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account.
See https://www.paws-r-sdk.com/docs/costexplorer_describe_cost_category_definition/ for full documentation.
Usage
costexplorer_describe_cost_category_definition(
CostCategoryArn,
EffectiveOn = NULL
)
Arguments
CostCategoryArn |
[required] The unique identifier for your Cost Category. |
EffectiveOn |
The date when the Cost Category was effective. |
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object
Description
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval
object. Anomalies are available for up to 90 days.
See https://www.paws-r-sdk.com/docs/costexplorer_get_anomalies/ for full documentation.
Usage
costexplorer_get_anomalies(
MonitorArn = NULL,
DateInterval,
Feedback = NULL,
TotalImpact = NULL,
NextPageToken = NULL,
MaxResults = NULL
)
Arguments
MonitorArn |
Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN). |
DateInterval |
[required] Assigns the start and end dates for retrieving cost anomalies. The
returned anomaly object will have an |
Feedback |
Filters anomaly results by the feedback field on the anomaly object. |
TotalImpact |
Filters anomaly results by the total impact field on the anomaly object.
For example, you can filter anomalies |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The number of entries a paginated response contains. |
Retrieves the cost anomaly monitor definitions for your account
Description
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
See https://www.paws-r-sdk.com/docs/costexplorer_get_anomaly_monitors/ for full documentation.
Usage
costexplorer_get_anomaly_monitors(
MonitorArnList = NULL,
NextPageToken = NULL,
MaxResults = NULL
)
Arguments
MonitorArnList |
A list of cost anomaly monitor ARNs. |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The number of entries that a paginated response contains. |
Retrieves the cost anomaly subscription objects for your account
Description
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
See https://www.paws-r-sdk.com/docs/costexplorer_get_anomaly_subscriptions/ for full documentation.
Usage
costexplorer_get_anomaly_subscriptions(
SubscriptionArnList = NULL,
MonitorArn = NULL,
NextPageToken = NULL,
MaxResults = NULL
)
Arguments
SubscriptionArnList |
A list of cost anomaly subscription ARNs. |
MonitorArn |
Cost anomaly monitor ARNs. |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The number of entries a paginated response contains. |
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity
Description
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.
See https://www.paws-r-sdk.com/docs/costexplorer_get_approximate_usage_records/ for full documentation.
Usage
costexplorer_get_approximate_usage_records(
Granularity,
Services = NULL,
ApproximationDimension
)
Arguments
Granularity |
[required] How granular you want the data to be. You can enable data at hourly or daily granularity. |
Services |
The service metadata for the service or services you want to query. If not specified, all elements are returned. |
ApproximationDimension |
[required] The service to evaluate for the usage records. You can choose resource-level data at daily granularity, or hourly granularity with or without resource-level data. |
Retrieves a commitment purchase analysis result based on the AnalysisId
Description
Retrieves a commitment purchase analysis result based on the AnalysisId
.
See https://www.paws-r-sdk.com/docs/costexplorer_get_commitment_purchase_analysis/ for full documentation.
Usage
costexplorer_get_commitment_purchase_analysis(AnalysisId)
Arguments
AnalysisId |
[required] The analysis ID that's associated with the commitment purchase analysis. |
Retrieves cost and usage metrics for your account
Description
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts
or UsageQuantity
. You can also filter and group your data by various dimensions, such as SERVICE
or AZ
, in a specific time range. For a complete list of valid dimensions, see the get_dimension_values
operation. Management account in an organization in Organizations have access to all member accounts.
See https://www.paws-r-sdk.com/docs/costexplorer_get_cost_and_usage/ for full documentation.
Usage
costexplorer_get_cost_and_usage(
TimePeriod,
Granularity,
Filter = NULL,
Metrics,
GroupBy = NULL,
BillingViewArn = NULL,
NextPageToken = NULL
)
Arguments
TimePeriod |
[required] Sets the start date and end date for retrieving Amazon Web Services
costs. The start date is inclusive, but the end date is exclusive. For
example, if |
Granularity |
[required] Sets the Amazon Web Services cost granularity to |
Filter |
Filters Amazon Web Services costs by different dimensions. For example,
you can specify Valid values for Valid values for |
Metrics |
[required] Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values are If you return the
|
GroupBy |
You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types. Valid values for the When you group by the |
BillingViewArn |
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
Retrieves cost and usage metrics with resources for your account
Description
Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as BlendedCosts
or UsageQuantity
, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE
or AZ
, in a specific time range. For a complete list of valid dimensions, see the get_dimension_values
operation. Management account in an organization in Organizations have access to all member accounts.
See https://www.paws-r-sdk.com/docs/costexplorer_get_cost_and_usage_with_resources/ for full documentation.
Usage
costexplorer_get_cost_and_usage_with_resources(
TimePeriod,
Granularity,
Filter,
Metrics = NULL,
GroupBy = NULL,
BillingViewArn = NULL,
NextPageToken = NULL
)
Arguments
TimePeriod |
[required] Sets the start and end dates for retrieving Amazon Web Services costs.
The range must be within the last 14 days (the start date cannot be
earlier than 14 days ago). The start date is inclusive, but the end date
is exclusive. For example, if |
Granularity |
[required] Sets the Amazon Web Services cost granularity to |
Filter |
[required] Filters Amazon Web Services costs by different dimensions. For example,
you can specify The
Valid values for Valid values for |
Metrics |
Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values are If you return the
|
GroupBy |
You can group Amazon Web Services costs using up to two different
groups: |
BillingViewArn |
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
Retrieves an array of Cost Category names and values incurred cost
Description
Retrieves an array of Cost Category names and values incurred cost.
See https://www.paws-r-sdk.com/docs/costexplorer_get_cost_categories/ for full documentation.
Usage
costexplorer_get_cost_categories(
SearchString = NULL,
TimePeriod,
CostCategoryName = NULL,
Filter = NULL,
SortBy = NULL,
BillingViewArn = NULL,
MaxResults = NULL,
NextPageToken = NULL
)
Arguments
SearchString |
The value that you want to search the filter values for. If you don't specify a |
TimePeriod |
[required] |
CostCategoryName |
|
Filter |
|
SortBy |
The value that you sort the data by. The key represents the cost and usage metrics. The following values are supported:
The supported key values for the When you use the |
BillingViewArn |
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. |
MaxResults |
This field is only used when the The maximum number of objects that are returned for this request. If
For |
NextPageToken |
If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request. |
Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs
Description
Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
See https://www.paws-r-sdk.com/docs/costexplorer_get_cost_forecast/ for full documentation.
Usage
costexplorer_get_cost_forecast(
TimePeriod,
Metric,
Granularity,
Filter = NULL,
BillingViewArn = NULL,
PredictionIntervalLevel = NULL
)
Arguments
TimePeriod |
[required] The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error. |
Metric |
[required] Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values for a
|
Granularity |
[required] How granular you want the forecast to be. You can get 3 months of
The |
Filter |
The filters that you want to use to filter your forecast. The
|
BillingViewArn |
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. |
PredictionIntervalLevel |
Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals. |
Retrieves all available filter values for a specified filter over a period of time
Description
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
See https://www.paws-r-sdk.com/docs/costexplorer_get_dimension_values/ for full documentation.
Usage
costexplorer_get_dimension_values(
SearchString = NULL,
TimePeriod,
Dimension,
Context = NULL,
Filter = NULL,
SortBy = NULL,
BillingViewArn = NULL,
MaxResults = NULL,
NextPageToken = NULL
)
Arguments
SearchString |
The value that you want to search the filter values for. |
TimePeriod |
[required] The start date and end date for retrieving the dimension values. The
start date is inclusive, but the end date is exclusive. For example, if
|
Dimension |
[required] The name of the dimension. Each |
Context |
The context for the call to
If you set the context to
If you set the context to
If you set the context to
|
Filter |
|
SortBy |
The value that you want to sort the data by. The key represents cost and usage metrics. The following values are supported:
The supported values for the When you specify a |
BillingViewArn |
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. |
MaxResults |
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter. For |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation
Description
Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:
See https://www.paws-r-sdk.com/docs/costexplorer_get_reservation_coverage/ for full documentation.
Usage
costexplorer_get_reservation_coverage(
TimePeriod,
GroupBy = NULL,
Granularity = NULL,
Filter = NULL,
Metrics = NULL,
NextPageToken = NULL,
SortBy = NULL,
MaxResults = NULL
)
Arguments
TimePeriod |
[required] The start and end dates of the period that you want to retrieve data
about reservation coverage for. You can retrieve data for a maximum of
13 months: the last 12 months and the current month. The start date is
inclusive, but the end date is exclusive. For example, if |
GroupBy |
You can group the data by the following attributes:
|
Granularity |
The granularity of the Amazon Web Services cost data for the
reservation. Valid values are If The |
Filter |
Filters utilization data by dimensions. You can filter by the following dimensions:
If you don't provide a Cost category is also supported. |
Metrics |
The measurement that you want your reservation coverage reported in. Valid values are |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
SortBy |
The value by which you want to sort the data. The following values are supported for
Supported values for |
MaxResults |
The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects. |
Gets recommendations for reservation purchases
Description
Gets recommendations for reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
See https://www.paws-r-sdk.com/docs/costexplorer_get_reservation_purchase_recommendation/ for full documentation.
Usage
costexplorer_get_reservation_purchase_recommendation(
AccountId = NULL,
Service,
Filter = NULL,
AccountScope = NULL,
LookbackPeriodInDays = NULL,
TermInYears = NULL,
PaymentOption = NULL,
ServiceSpecification = NULL,
PageSize = NULL,
NextPageToken = NULL
)
Arguments
AccountId |
The account ID that's associated with the recommendation. |
Service |
[required] The specific service that you want recommendations for. |
Filter |
|
AccountScope |
The account scope that you want your recommendations for. Amazon Web
Services calculates recommendations including the management account and
member accounts if the value is set to |
LookbackPeriodInDays |
The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations. |
TermInYears |
The reservation term that you want recommendations for. |
PaymentOption |
The reservation purchase option that you want recommendations for. |
ServiceSpecification |
The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances. |
PageSize |
The number of recommendations that you want returned in a single response object. |
NextPageToken |
The pagination token that indicates the next set of results that you want to retrieve. |
Retrieves the reservation utilization for your account
Description
Retrieves the reservation utilization for your account. Management account in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use get_dimension_values
to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID
.
See https://www.paws-r-sdk.com/docs/costexplorer_get_reservation_utilization/ for full documentation.
Usage
costexplorer_get_reservation_utilization(
TimePeriod,
GroupBy = NULL,
Granularity = NULL,
Filter = NULL,
SortBy = NULL,
NextPageToken = NULL,
MaxResults = NULL
)
Arguments
TimePeriod |
[required] Sets the start and end dates for retrieving Reserved Instance (RI)
utilization. The start date is inclusive, but the end date is exclusive.
For example, if |
GroupBy |
Groups only by |
Granularity |
If The
|
Filter |
Filters utilization data by dimensions. You can filter by the following dimensions:
|
SortBy |
The value that you want to sort the data by. The following values are supported for
The supported values for |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects. |
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances
Description
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
See https://www.paws-r-sdk.com/docs/costexplorer_get_rightsizing_recommendation/ for full documentation.
Usage
costexplorer_get_rightsizing_recommendation(
Filter = NULL,
Configuration = NULL,
Service,
PageSize = NULL,
NextPageToken = NULL
)
Arguments
Filter |
|
Configuration |
You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither. |
Service |
[required] The specific service that you want recommendations for. The only valid
value for
|
PageSize |
The number of recommendations that you want returned in a single response object. |
NextPageToken |
The pagination token that indicates the next set of results that you want to retrieve. |
Retrieves the details for a Savings Plan recommendation
Description
Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.
See https://www.paws-r-sdk.com/docs/costexplorer_get_savings_plan_purchase_recommendation_details/ for full documentation.
Usage
costexplorer_get_savings_plan_purchase_recommendation_details(
RecommendationDetailId
)
Arguments
RecommendationDetailId |
[required] The ID that is associated with the Savings Plan recommendation. |
Retrieves the Savings Plans covered for your account
Description
Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:
See https://www.paws-r-sdk.com/docs/costexplorer_get_savings_plans_coverage/ for full documentation.
Usage
costexplorer_get_savings_plans_coverage(
TimePeriod,
GroupBy = NULL,
Granularity = NULL,
Filter = NULL,
Metrics = NULL,
NextToken = NULL,
MaxResults = NULL,
SortBy = NULL
)
Arguments
TimePeriod |
[required] The time period that you want the usage and costs for. The |
GroupBy |
You can group the data using the attributes |
Granularity |
The granularity of the Amazon Web Services cost data for your Savings
Plans. The
|
Filter |
Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:
Cost category is also supported. |
Metrics |
The measurement that you want your Savings Plans coverage reported in.
The only valid value is |
NextToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The number of items to be returned in a response. The default is |
SortBy |
The value that you want to sort the data by. The following values are supported for
The supported values for |
Retrieves the Savings Plans recommendations for your account
Description
Retrieves the Savings Plans recommendations for your account. First use start_savings_plans_purchase_recommendation_generation
to generate a new set of recommendations, and then use get_savings_plans_purchase_recommendation
to retrieve them.
See https://www.paws-r-sdk.com/docs/costexplorer_get_savings_plans_purchase_recommendation/ for full documentation.
Usage
costexplorer_get_savings_plans_purchase_recommendation(
SavingsPlansType,
TermInYears,
PaymentOption,
AccountScope = NULL,
NextPageToken = NULL,
PageSize = NULL,
LookbackPeriodInDays,
Filter = NULL
)
Arguments
SavingsPlansType |
[required] The Savings Plans recommendation type that's requested. |
TermInYears |
[required] The savings plan recommendation term that's used to generate these recommendations. |
PaymentOption |
[required] The payment option that's used to generate these recommendations. |
AccountScope |
The account scope that you want your recommendations for. Amazon Web
Services calculates recommendations including the management account and
member accounts if the value is set to |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
PageSize |
The number of recommendations that you want returned in a single response object. |
LookbackPeriodInDays |
[required] The lookback period that's used to generate the recommendation. |
Filter |
You can filter your recommendations by Account ID with the
For GetSavingsPlansPurchaseRecommendation, the |
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity
Description
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use get_dimension_values
in SAVINGS_PLANS
to determine the possible dimension values.
See https://www.paws-r-sdk.com/docs/costexplorer_get_savings_plans_utilization/ for full documentation.
Usage
costexplorer_get_savings_plans_utilization(
TimePeriod,
Granularity = NULL,
Filter = NULL,
SortBy = NULL
)
Arguments
TimePeriod |
[required] The time period that you want the usage and costs for. The |
Granularity |
The granularity of the Amazon Web Services utillization data for your Savings Plans. The
|
Filter |
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
|
SortBy |
The value that you want to sort the data by. The following values are supported for
The supported values for |
Retrieves attribute data along with aggregate utilization and savings data for a given time period
Description
Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization
, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails
by providing individual dates. You can use get_dimension_values
in SAVINGS_PLANS
to determine the possible dimension values.
See https://www.paws-r-sdk.com/docs/costexplorer_get_savings_plans_utilization_details/ for full documentation.
Usage
costexplorer_get_savings_plans_utilization_details(
TimePeriod,
Filter = NULL,
DataType = NULL,
NextToken = NULL,
MaxResults = NULL,
SortBy = NULL
)
Arguments
TimePeriod |
[required] The time period that you want the usage and costs for. The |
Filter |
Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:
|
DataType |
The data type. |
NextToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The number of items to be returned in a response. The default is |
SortBy |
The value that you want to sort the data by. The following values are supported for
The supported values for |
Queries for available tag keys and tag values for a specified period
Description
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
See https://www.paws-r-sdk.com/docs/costexplorer_get_tags/ for full documentation.
Usage
costexplorer_get_tags(
SearchString = NULL,
TimePeriod,
TagKey = NULL,
Filter = NULL,
SortBy = NULL,
BillingViewArn = NULL,
MaxResults = NULL,
NextPageToken = NULL
)
Arguments
SearchString |
The value that you want to search for. |
TimePeriod |
[required] The start and end dates for retrieving the dimension values. The start
date is inclusive, but the end date is exclusive. For example, if
|
TagKey |
The key of the tag that you want to return values for. |
Filter |
|
SortBy |
The value that you want to sort the data by. The key represents cost and usage metrics. The following values are supported:
The supported values for When you use |
BillingViewArn |
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. |
MaxResults |
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter. For |
NextPageToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage
Description
Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
See https://www.paws-r-sdk.com/docs/costexplorer_get_usage_forecast/ for full documentation.
Usage
costexplorer_get_usage_forecast(
TimePeriod,
Metric,
Granularity,
Filter = NULL,
BillingViewArn = NULL,
PredictionIntervalLevel = NULL
)
Arguments
TimePeriod |
[required] The start and end dates of the period that you want to retrieve usage
forecast for. The start date is included in the period, but the end date
isn't included in the period. For example, if |
Metric |
[required] Which metric Cost Explorer uses to create your forecast. Valid values for a
|
Granularity |
[required] How granular you want the forecast to be. You can get 3 months of
The |
Filter |
The filters that you want to use to filter your forecast. The
|
BillingViewArn |
The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. |
PredictionIntervalLevel |
Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals. |
Lists the commitment purchase analyses for your account
Description
Lists the commitment purchase analyses for your account.
See https://www.paws-r-sdk.com/docs/costexplorer_list_commitment_purchase_analyses/ for full documentation.
Usage
costexplorer_list_commitment_purchase_analyses(
AnalysisStatus = NULL,
NextPageToken = NULL,
PageSize = NULL,
AnalysisIds = NULL
)
Arguments
AnalysisStatus |
The status of the analysis. |
NextPageToken |
The token to retrieve the next set of results. |
PageSize |
The number of analyses that you want returned in a single response object. |
AnalysisIds |
The analysis IDs associated with the commitment purchase analyses. |
Retrieves a list of your historical cost allocation tag backfill requests
Description
Retrieves a list of your historical cost allocation tag backfill requests.
See https://www.paws-r-sdk.com/docs/costexplorer_list_cost_allocation_tag_backfill_history/ for full documentation.
Usage
costexplorer_list_cost_allocation_tag_backfill_history(
NextToken = NULL,
MaxResults = NULL
)
Arguments
NextToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The maximum number of objects that are returned for this request. |
Get a list of cost allocation tags
Description
Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.
See https://www.paws-r-sdk.com/docs/costexplorer_list_cost_allocation_tags/ for full documentation.
Usage
costexplorer_list_cost_allocation_tags(
Status = NULL,
TagKeys = NULL,
Type = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
Status |
The status of cost allocation tag keys that are returned for this request. |
TagKeys |
The list of cost allocation tag keys that are returned for this request. |
Type |
The type of |
NextToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The maximum number of objects that are returned for this request. By default, the request returns 100 results. |
Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account
Description
Returns the name, Amazon Resource Name (ARN), NumberOfRules
and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn
to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn
specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd
is omitted in the response. list_cost_category_definitions
supports pagination. The request can have a MaxResults
range up to 100.
See https://www.paws-r-sdk.com/docs/costexplorer_list_cost_category_definitions/ for full documentation.
Usage
costexplorer_list_cost_category_definitions(
EffectiveOn = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
EffectiveOn |
The date when the Cost Category was effective. |
NextToken |
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. |
MaxResults |
The number of entries a paginated response contains. |
Retrieves a list of your historical recommendation generations within the past 30 days
Description
Retrieves a list of your historical recommendation generations within the past 30 days.
See https://www.paws-r-sdk.com/docs/costexplorer_list_savings_plans_purchase_recommendation_generation/ for full documentation.
Usage
costexplorer_list_savings_plans_purchase_recommendation_generation(
GenerationStatus = NULL,
RecommendationIds = NULL,
PageSize = NULL,
NextPageToken = NULL
)
Arguments
GenerationStatus |
The status of the recommendation generation. |
RecommendationIds |
The IDs for each specific recommendation. |
PageSize |
The number of recommendations that you want returned in a single response object. |
NextPageToken |
The token to retrieve the next set of results. |
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN)
Description
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
See https://www.paws-r-sdk.com/docs/costexplorer_list_tags_for_resource/ for full documentation.
Usage
costexplorer_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag. |
Modifies the feedback property of a given cost anomaly
Description
Modifies the feedback property of a given cost anomaly.
See https://www.paws-r-sdk.com/docs/costexplorer_provide_anomaly_feedback/ for full documentation.
Usage
costexplorer_provide_anomaly_feedback(AnomalyId, Feedback)
Arguments
AnomalyId |
[required] A cost anomaly ID. |
Feedback |
[required] Describes whether the cost anomaly was a planned activity or you considered it an anomaly. |
Specifies the parameters of a planned commitment purchase and starts the generation of the analysis
Description
Specifies the parameters of a planned commitment purchase and starts the generation of the analysis. This enables you to estimate the cost, coverage, and utilization impact of your planned commitment purchases.
See https://www.paws-r-sdk.com/docs/costexplorer_start_commitment_purchase_analysis/ for full documentation.
Usage
costexplorer_start_commitment_purchase_analysis(
CommitmentPurchaseAnalysisConfiguration
)
Arguments
CommitmentPurchaseAnalysisConfiguration |
[required] The configuration for the commitment purchase analysis. |
Request a cost allocation tag backfill
Description
Request a cost allocation tag backfill. This will backfill the activation status (either active
or inactive
) for all tag keys from para:BackfillFrom
up to the when this request is made.
See https://www.paws-r-sdk.com/docs/costexplorer_start_cost_allocation_tag_backfill/ for full documentation.
Usage
costexplorer_start_cost_allocation_tag_backfill(BackfillFrom)
Arguments
BackfillFrom |
[required] The date you want the backfill to start from. The date can only be a first day of the month (a billing start date). Dates can't precede the previous twelve months, or in the future. |
Requests a Savings Plans recommendation generation
Description
Requests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family.
See https://www.paws-r-sdk.com/docs/costexplorer_start_savings_plans_purchase_recommendation_generation/ for full documentation.
Usage
costexplorer_start_savings_plans_purchase_recommendation_generation()
An API operation for adding one or more tags (key-value pairs) to a resource
Description
An API operation for adding one or more tags (key-value pairs) to a resource.
See https://www.paws-r-sdk.com/docs/costexplorer_tag_resource/ for full documentation.
Usage
costexplorer_tag_resource(ResourceArn, ResourceTags)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag. |
ResourceTags |
[required] A list of tag key-value pairs to be added to the resource. Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
|
Removes one or more tags from a resource
Description
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
See https://www.paws-r-sdk.com/docs/costexplorer_untag_resource/ for full documentation.
Usage
costexplorer_untag_resource(ResourceArn, ResourceTagKeys)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag. |
ResourceTagKeys |
[required] A list of tag keys associated with tags that need to be removed from the resource. If you specify a tag key that doesn't exist, it's ignored. Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use. |
Updates an existing cost anomaly monitor
Description
Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.
See https://www.paws-r-sdk.com/docs/costexplorer_update_anomaly_monitor/ for full documentation.
Usage
costexplorer_update_anomaly_monitor(MonitorArn, MonitorName = NULL)
Arguments
MonitorArn |
[required] Cost anomaly monitor Amazon Resource Names (ARNs). |
MonitorName |
The new name for the cost anomaly monitor. |
Updates an existing cost anomaly subscription
Description
Updates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged.
See https://www.paws-r-sdk.com/docs/costexplorer_update_anomaly_subscription/ for full documentation.
Usage
costexplorer_update_anomaly_subscription(
SubscriptionArn,
Threshold = NULL,
Frequency = NULL,
MonitorArnList = NULL,
Subscribers = NULL,
SubscriptionName = NULL,
ThresholdExpression = NULL
)
Arguments
SubscriptionArn |
[required] A cost anomaly subscription Amazon Resource Name (ARN). |
Threshold |
(deprecated) The update to the threshold value for receiving notifications. This field has been deprecated. To update a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression. You can specify either Threshold or ThresholdExpression, but not both. |
Frequency |
The update to the frequency value that subscribers receive notifications. |
MonitorArnList |
A list of cost anomaly monitor ARNs. |
Subscribers |
The update to the subscriber list. |
SubscriptionName |
The new name of the subscription. |
ThresholdExpression |
The update to the
Expression
object used to specify the anomalies that you want to generate alerts
for. This supports dimensions and nested expressions. The supported
dimensions are You can specify either Threshold or ThresholdExpression, but not both. The following are examples of valid ThresholdExpressions:
|
Updates status for cost allocation tags in bulk, with maximum batch size of 20
Description
Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag).
See https://www.paws-r-sdk.com/docs/costexplorer_update_cost_allocation_tags_status/ for full documentation.
Usage
costexplorer_update_cost_allocation_tags_status(CostAllocationTagsStatus)
Arguments
CostAllocationTagsStatus |
[required] The list of |
Updates an existing Cost Category
Description
Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
See https://www.paws-r-sdk.com/docs/costexplorer_update_cost_category_definition/ for full documentation.
Usage
costexplorer_update_cost_category_definition(
CostCategoryArn,
EffectiveStart = NULL,
RuleVersion,
Rules,
DefaultValue = NULL,
SplitChargeRules = NULL
)
Arguments
CostCategoryArn |
[required] The unique identifier for your Cost Category. |
EffectiveStart |
The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future. |
RuleVersion |
[required] |
Rules |
[required] The |
DefaultValue |
|
SplitChargeRules |
The split charge rules used to allocate your charges between your Cost Category values. |
AWS Marketplace Catalog Service
Description
Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace.
You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.
Usage
marketplacecatalog(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- marketplacecatalog( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
batch_describe_entities | Returns metadata and content for multiple entities |
cancel_change_set | Used to cancel an open change request |
delete_resource_policy | Deletes a resource-based policy on an entity that is identified by its resource ARN |
describe_change_set | Provides information about a given change set |
describe_entity | Returns the metadata and content of the entity |
get_resource_policy | Gets a resource-based policy of an entity that is identified by its resource ARN |
list_change_sets | Returns the list of change sets owned by the account being used to make the call |
list_entities | Provides the list of entities of a given type |
list_tags_for_resource | Lists all tags that have been added to a resource (either an entity or change set) |
put_resource_policy | Attaches a resource-based policy to an entity |
start_change_set | Allows you to request changes for your entities |
tag_resource | Tags a resource (either an entity or change set) |
untag_resource | Removes a tag or list of tags from a resource (either an entity or change set) |
Examples
## Not run:
svc <- marketplacecatalog()
svc$batch_describe_entities(
Foo = 123
)
## End(Not run)
Returns metadata and content for multiple entities
Description
Returns metadata and content for multiple entities. This is the Batch version of the describe_entity
API and uses the same IAM permission action as describe_entity
API.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_batch_describe_entities/ for full documentation.
Usage
marketplacecatalog_batch_describe_entities(EntityRequestList)
Arguments
EntityRequestList |
[required] List of entity IDs and the catalogs the entities are present in. |
Used to cancel an open change request
Description
Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING
, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_cancel_change_set/ for full documentation.
Usage
marketplacecatalog_cancel_change_set(Catalog, ChangeSetId)
Arguments
Catalog |
[required] Required. The catalog related to the request. Fixed value:
|
ChangeSetId |
[required] Required. The unique identifier of the
|
Deletes a resource-based policy on an entity that is identified by its resource ARN
Description
Deletes a resource-based policy on an entity that is identified by its resource ARN.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_delete_resource_policy/ for full documentation.
Usage
marketplacecatalog_delete_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy. |
Provides information about a given change set
Description
Provides information about a given change set.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_describe_change_set/ for full documentation.
Usage
marketplacecatalog_describe_change_set(Catalog, ChangeSetId)
Arguments
Catalog |
[required] Required. The catalog related to the request. Fixed value:
|
ChangeSetId |
[required] Required. The unique identifier for the
|
Returns the metadata and content of the entity
Description
Returns the metadata and content of the entity.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_describe_entity/ for full documentation.
Usage
marketplacecatalog_describe_entity(Catalog, EntityId)
Arguments
Catalog |
[required] Required. The catalog related to the request. Fixed value:
|
EntityId |
[required] Required. The unique ID of the entity to describe. |
Gets a resource-based policy of an entity that is identified by its resource ARN
Description
Gets a resource-based policy of an entity that is identified by its resource ARN.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_get_resource_policy/ for full documentation.
Usage
marketplacecatalog_get_resource_policy(ResourceArn)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy. |
Returns the list of change sets owned by the account being used to make the call
Description
Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of entityId
, ChangeSetName
, and status. If you provide more than one filter, the API operation applies a logical AND between the filters.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_list_change_sets/ for full documentation.
Usage
marketplacecatalog_list_change_sets(
Catalog,
FilterList = NULL,
Sort = NULL,
MaxResults = NULL,
NextToken = NULL
)
Arguments
Catalog |
[required] The catalog related to the request. Fixed value: |
FilterList |
An array of filter objects. |
Sort |
An object that contains two attributes, |
MaxResults |
The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results. By default, this value is 20. |
NextToken |
The token value retrieved from a previous call to access the next page of results. |
Provides the list of entities of a given type
Description
Provides the list of entities of a given type.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_list_entities/ for full documentation.
Usage
marketplacecatalog_list_entities(
Catalog,
EntityType,
FilterList = NULL,
Sort = NULL,
NextToken = NULL,
MaxResults = NULL,
OwnershipType = NULL,
EntityTypeFilters = NULL,
EntityTypeSort = NULL
)
Arguments
Catalog |
[required] The catalog related to the request. Fixed value: |
EntityType |
[required] The type of entities to retrieve. Valid values are: |
FilterList |
An array of filter objects. Each filter object contains two attributes,
|
Sort |
An object that contains two attributes, |
NextToken |
The value of the next token, if it exists. Null if there are no more results. |
MaxResults |
Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20. |
OwnershipType |
Filters the returned set of entities based on their owner. The default
is |
EntityTypeFilters |
A Union object containing filter shapes for all |
EntityTypeSort |
A Union object containing |
Lists all tags that have been added to a resource (either an entity or change set)
Description
Lists all tags that have been added to a resource (either an entity or change set).
See https://www.paws-r-sdk.com/docs/marketplacecatalog_list_tags_for_resource/ for full documentation.
Usage
marketplacecatalog_list_tags_for_resource(ResourceArn)
Arguments
ResourceArn |
[required] Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on. |
Attaches a resource-based policy to an entity
Description
Attaches a resource-based policy to an entity. Examples of an entity include: AmiProduct
and ContainerProduct
.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_put_resource_policy/ for full documentation.
Usage
marketplacecatalog_put_resource_policy(ResourceArn, Policy)
Arguments
ResourceArn |
[required] The Amazon Resource Name (ARN) of the entity resource you want to associate with a resource policy. |
Policy |
[required] The policy document to set; formatted in JSON. |
Allows you to request changes for your entities
Description
Allows you to request changes for your entities. Within a single ChangeSet
, you can't start the same change type against the same entity multiple times. Additionally, when a ChangeSet
is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive a ResourceInUseException
error.
See https://www.paws-r-sdk.com/docs/marketplacecatalog_start_change_set/ for full documentation.
Usage
marketplacecatalog_start_change_set(
Catalog,
ChangeSet,
ChangeSetName = NULL,
ClientRequestToken = NULL,
ChangeSetTags = NULL,
Intent = NULL
)
Arguments
Catalog |
[required] The catalog related to the request. Fixed value: |
ChangeSet |
[required] Array of |
ChangeSetName |
Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets. |
ClientRequestToken |
A unique token to identify the request to ensure idempotency. |
ChangeSetTags |
A list of objects specifying each key name and value for the
|
Intent |
The intent related to the request. The default is |
Tags a resource (either an entity or change set)
Description
Tags a resource (either an entity or change set).
See https://www.paws-r-sdk.com/docs/marketplacecatalog_tag_resource/ for full documentation.
Usage
marketplacecatalog_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] Required. The Amazon Resource Name (ARN) associated with the resource you want to tag. |
Tags |
[required] Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50. |
Removes a tag or list of tags from a resource (either an entity or change set)
Description
Removes a tag or list of tags from a resource (either an entity or change set).
See https://www.paws-r-sdk.com/docs/marketplacecatalog_untag_resource/ for full documentation.
Usage
marketplacecatalog_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from. |
TagKeys |
[required] Required. A list of key names of tags to be removed. Number of strings allowed: 0-256. |
AWS Marketplace Commerce Analytics
Description
Provides AWS Marketplace business intelligence data on-demand.
Usage
marketplacecommerceanalytics(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- marketplacecommerceanalytics( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
generate_data_set | Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available |
start_support_data_export | This target has been deprecated |
Examples
## Not run:
svc <- marketplacecommerceanalytics()
svc$generate_data_set(
Foo = 123
)
## End(Not run)
Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available
Description
Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
See https://www.paws-r-sdk.com/docs/marketplacecommerceanalytics_generate_data_set/ for full documentation.
Usage
marketplacecommerceanalytics_generate_data_set(
dataSetType,
dataSetPublicationDate,
roleNameArn,
destinationS3BucketName,
destinationS3Prefix = NULL,
snsTopicArn,
customerDefinedValues = NULL
)
Arguments
dataSetType |
[required] The desired data set type.
|
dataSetPublicationDate |
[required] The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For monthly data sets except those with prefix disbursed_amount, provide a date with month-level granularity for the desired month (the day value will be ignored). For data sets with prefix disbursed_amount, provide a date with day-level granularity for the desired day. For these data sets we will look backwards in time over the range of 31 days until the first data set is found (the latest one). |
roleNameArn |
[required] The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. |
destinationS3BucketName |
[required] The name (friendly name, not ARN) of the destination S3 bucket. |
destinationS3Prefix |
(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root. |
snsTopicArn |
[required] Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred. |
customerDefinedValues |
(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems. |
This target has been deprecated
Description
This target has been deprecated. Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
See https://www.paws-r-sdk.com/docs/marketplacecommerceanalytics_start_support_data_export/ for full documentation.
Usage
marketplacecommerceanalytics_start_support_data_export(
dataSetType,
fromDate,
roleNameArn,
destinationS3BucketName,
destinationS3Prefix = NULL,
snsTopicArn,
customerDefinedValues = NULL
)
Arguments
dataSetType |
[required] This target has been deprecated. Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.
|
fromDate |
[required] This target has been deprecated. The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type. |
roleNameArn |
[required] This target has been deprecated. The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. |
destinationS3BucketName |
[required] This target has been deprecated. The name (friendly name, not ARN) of the destination S3 bucket. |
destinationS3Prefix |
This target has been deprecated. (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root. |
snsTopicArn |
[required] This target has been deprecated. Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred. |
customerDefinedValues |
This target has been deprecated. (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. |
AWS Marketplace Entitlement Service
Description
This reference provides descriptions of the AWS Marketplace Entitlement Service API.
AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.
Getting Entitlement Records
-
GetEntitlements- Gets the entitlements for a Marketplace product.
Usage
marketplaceentitlementservice(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- marketplaceentitlementservice( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
get_entitlements | GetEntitlements retrieves entitlement values for a given product |
Examples
## Not run:
svc <- marketplaceentitlementservice()
svc$get_entitlements(
Foo = 123
)
## End(Not run)
GetEntitlements retrieves entitlement values for a given product
Description
GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.
See https://www.paws-r-sdk.com/docs/marketplaceentitlementservice_get_entitlements/ for full documentation.
Usage
marketplaceentitlementservice_get_entitlements(
ProductCode,
Filter = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ProductCode |
[required] Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created. |
Filter |
Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key. |
NextToken |
For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult. |
MaxResults |
The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements. |
AWSMarketplace Metering
Description
AWS Marketplace Metering Service
This reference provides descriptions of the low-level AWS Marketplace Metering Service API.
AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.
For information on the permissions you need to use this API, see AWS Marketplace metering and entitlement API permissions in the AWS Marketplace Seller Guide.
Submitting Metering Records
-
MeterUsage - Submits the metering record for an AWS Marketplace product.
meter_usage
is called from an EC2 instance or a container running on EKS or ECS. -
BatchMeterUsage - Submits the metering record for a set of customers.
batch_meter_usage
is called from a software-as-a-service (SaaS) application.
Accepting New Customers
-
ResolveCustomer - Called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a Registration Token through the browser. The Registration Token is resolved through this API to obtain a
CustomerIdentifier
along with theCustomerAWSAccountId
andProductCode
.
Entitlement and Metering for Paid Container Products
Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the
register_usage
operation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to callregister_usage
, but you can do so if you want to receive usage data in your seller reports. For more information on using theregister_usage
operation, see Container-Based Products.
batch_meter_usage
API calls
are captured by AWS CloudTrail. You can use Cloudtrail to verify that
the SaaS metering records that you sent are accurate by searching for
records with the eventName
of
batch_meter_usage
. You can
also use CloudTrail to audit records over time. For more information,
see the AWS CloudTrail User Guide.
Usage
marketplacemetering(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- marketplacemetering( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
batch_meter_usage | BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers |
meter_usage | API to emit metering records |
register_usage | Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering |
resolve_customer | ResolveCustomer is called by a SaaS application during the registration process |
Examples
## Not run:
svc <- marketplacemetering()
svc$batch_meter_usage(
Foo = 123
)
## End(Not run)
BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers
Description
batch_meter_usage
is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers.
See https://www.paws-r-sdk.com/docs/marketplacemetering_batch_meter_usage/ for full documentation.
Usage
marketplacemetering_batch_meter_usage(UsageRecords, ProductCode)
Arguments
UsageRecords |
[required] The set of |
ProductCode |
[required] Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product. |
API to emit metering records
Description
API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.
See https://www.paws-r-sdk.com/docs/marketplacemetering_meter_usage/ for full documentation.
Usage
marketplacemetering_meter_usage(
ProductCode,
Timestamp,
UsageDimension,
UsageQuantity = NULL,
DryRun = NULL,
UsageAllocations = NULL
)
Arguments
ProductCode |
[required] Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product. |
Timestamp |
[required] Timestamp, in UTC, for which the usage is being reported. Your
application can meter usage for up to one hour in the past. Make sure
the |
UsageDimension |
[required] It will be one of the fcp dimension name provided during the publishing of the product. |
UsageQuantity |
Consumption value for the hour. Defaults to |
DryRun |
Checks whether you have the permissions required for the action, but
does not make the request. If you have the permissions, the request
returns |
UsageAllocations |
The set of The sum of all |
Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering
Description
Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the register_usage
operation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call register_usage
, but you may choose to do so if you would like to receive usage data in your seller reports. The sections below explain the behavior of register_usage
. register_usage
performs two primary functions: metering and entitlement.
See https://www.paws-r-sdk.com/docs/marketplacemetering_register_usage/ for full documentation.
Usage
marketplacemetering_register_usage(ProductCode, PublicKeyVersion, Nonce = NULL)
Arguments
ProductCode |
[required] Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product. |
PublicKeyVersion |
[required] Public Key Version provided by AWS Marketplace |
Nonce |
(Optional) To scope down the registration to a specific running software instance and guard against replay attacks. |
ResolveCustomer is called by a SaaS application during the registration process
Description
resolve_customer
is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier
along with the CustomerAWSAccountId
and ProductCode
.
See https://www.paws-r-sdk.com/docs/marketplacemetering_resolve_customer/ for full documentation.
Usage
marketplacemetering_resolve_customer(RegistrationToken)
Arguments
RegistrationToken |
[required] When a buyer visits your website during the registration process, the
buyer submits a registration token through the browser. The registration
token is resolved to obtain a |
Payment Cryptography Control Plane
Description
Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide.
To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the Amazon Web Services Payment Cryptography Data Plane. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.
All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests.
Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
Usage
paymentcryptographycontrolplane(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- paymentcryptographycontrolplane( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_alias | Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key |
create_key | Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region |
delete_alias | Deletes the alias, but doesn't affect the underlying key |
delete_key | Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key |
export_key | Exports a key from Amazon Web Services Payment Cryptography |
get_alias | Gets the Amazon Web Services Payment Cryptography key associated with the alias |
get_key | Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created |
get_parameters_for_export | Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography |
get_parameters_for_import | Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography |
get_public_key_certificate | Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography |
import_key | Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography |
list_aliases | Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region |
list_keys | Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region |
list_tags_for_resource | Lists the tags for an Amazon Web Services resource |
restore_key | Cancels a scheduled key deletion during the waiting period |
start_key_usage | Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography |
stop_key_usage | Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography |
tag_resource | Adds or edits tags on an Amazon Web Services Payment Cryptography key |
untag_resource | Deletes a tag from an Amazon Web Services Payment Cryptography key |
update_alias | Associates an existing Amazon Web Services Payment Cryptography alias with a different key |
Examples
## Not run:
svc <- paymentcryptographycontrolplane()
svc$create_alias(
Foo = 123
)
## End(Not run)
Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key
Description
Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_create_alias/ for full documentation.
Usage
paymentcryptographycontrolplane_create_alias(AliasName, KeyArn = NULL)
Arguments
AliasName |
[required] A friendly name that you can use to refer to a key. An alias must begin
with Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. |
KeyArn |
The |
Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region
Description
Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_create_key/ for full documentation.
Usage
paymentcryptographycontrolplane_create_key(
KeyAttributes,
KeyCheckValueAlgorithm = NULL,
Exportable,
Enabled = NULL,
Tags = NULL
)
Arguments
KeyAttributes |
[required] The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created. |
KeyCheckValueAlgorithm |
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. |
Exportable |
[required] Specifies whether the key is exportable from the service. |
Enabled |
Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled. |
Tags |
Assigns one or more tags to the Amazon Web Services Payment Cryptography
key. Use this parameter to tag a key when it is created. To tag an
existing Amazon Web Services Payment Cryptography key, use the
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key. |
Deletes the alias, but doesn't affect the underlying key
Description
Deletes the alias, but doesn't affect the underlying key.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_delete_alias/ for full documentation.
Usage
paymentcryptographycontrolplane_delete_alias(AliasName)
Arguments
AliasName |
[required] A friendly name that you can use to refer Amazon Web Services Payment
Cryptography key. This value must begin with |
Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key
Description
Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_delete_key/ for full documentation.
Usage
paymentcryptographycontrolplane_delete_key(
KeyIdentifier,
DeleteKeyInDays = NULL
)
Arguments
KeyIdentifier |
[required] The |
DeleteKeyInDays |
The waiting period for key deletion. The default value is seven days. |
Exports a key from Amazon Web Services Payment Cryptography
Description
Exports a key from Amazon Web Services Payment Cryptography.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_export_key/ for full documentation.
Usage
paymentcryptographycontrolplane_export_key(
KeyMaterial,
ExportKeyIdentifier,
ExportAttributes = NULL
)
Arguments
KeyMaterial |
[required] The key block format type, for example, TR-34 or TR-31, to use during key material export. |
ExportKeyIdentifier |
[required] The |
ExportAttributes |
The attributes for IPEK generation during export. |
Gets the Amazon Web Services Payment Cryptography key associated with the alias
Description
Gets the Amazon Web Services Payment Cryptography key associated with the alias.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_get_alias/ for full documentation.
Usage
paymentcryptographycontrolplane_get_alias(AliasName)
Arguments
AliasName |
[required] The alias of the Amazon Web Services Payment Cryptography key. |
Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created
Description
Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_get_key/ for full documentation.
Usage
paymentcryptographycontrolplane_get_key(KeyIdentifier)
Arguments
KeyIdentifier |
[required] The |
Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography
Description
Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_get_parameters_for_export/ for full documentation.
Usage
paymentcryptographycontrolplane_get_parameters_for_export(
KeyMaterialType,
SigningKeyAlgorithm
)
Arguments
KeyMaterialType |
[required] The key block format type (for example, TR-34 or TR-31) to use during
key material export. Export token is only required for a TR-34 key
export, |
SigningKeyAlgorithm |
[required] The signing key algorithm to generate a signing key certificate. This
certificate signs the wrapped key under export within the TR-34 key
block. |
Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography
Description
Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_get_parameters_for_import/ for full documentation.
Usage
paymentcryptographycontrolplane_get_parameters_for_import(
KeyMaterialType,
WrappingKeyAlgorithm
)
Arguments
KeyMaterialType |
[required] The method to use for key material import. Import token is only required
for TR-34 WrappedKeyBlock ( Import token is not required for TR-31, root public key cerificate or trusted public key certificate. |
WrappingKeyAlgorithm |
[required] The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import. At this time, |
Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography
Description
Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_get_public_key_certificate/ for full documentation.
Usage
paymentcryptographycontrolplane_get_public_key_certificate(KeyIdentifier)
Arguments
KeyIdentifier |
[required] The |
Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography
Description
Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_import_key/ for full documentation.
Usage
paymentcryptographycontrolplane_import_key(
KeyMaterial,
KeyCheckValueAlgorithm = NULL,
Enabled = NULL,
Tags = NULL
)
Arguments
KeyMaterial |
[required] The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey. |
KeyCheckValueAlgorithm |
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result. |
Enabled |
Specifies whether import key is enabled. |
Tags |
Assigns one or more tags to the Amazon Web Services Payment Cryptography
key. Use this parameter to tag a key when it is imported. To tag an
existing Amazon Web Services Payment Cryptography key, use the
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one. Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key. |
Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region
Description
Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by keyARN
. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_list_aliases/ for full documentation.
Usage
paymentcryptographycontrolplane_list_aliases(
KeyArn = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
KeyArn |
The |
NextToken |
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of |
MaxResults |
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. |
Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region
Description
Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_list_keys/ for full documentation.
Usage
paymentcryptographycontrolplane_list_keys(
KeyState = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
KeyState |
The key state of the keys you want to list. |
NextToken |
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of |
MaxResults |
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. |
Lists the tags for an Amazon Web Services resource
Description
Lists the tags for an Amazon Web Services resource.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_list_tags_for_resource/ for full documentation.
Usage
paymentcryptographycontrolplane_list_tags_for_resource(
ResourceArn,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ResourceArn |
[required] The |
NextToken |
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of |
MaxResults |
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. |
Cancels a scheduled key deletion during the waiting period
Description
Cancels a scheduled key deletion during the waiting period. Use this operation to restore a Key
that is scheduled for deletion.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_restore_key/ for full documentation.
Usage
paymentcryptographycontrolplane_restore_key(KeyIdentifier)
Arguments
KeyIdentifier |
[required] The |
Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
Description
Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_start_key_usage/ for full documentation.
Usage
paymentcryptographycontrolplane_start_key_usage(KeyIdentifier)
Arguments
KeyIdentifier |
[required] The |
Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography
Description
Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_stop_key_usage/ for full documentation.
Usage
paymentcryptographycontrolplane_stop_key_usage(KeyIdentifier)
Arguments
KeyIdentifier |
[required] The |
Adds or edits tags on an Amazon Web Services Payment Cryptography key
Description
Adds or edits tags on an Amazon Web Services Payment Cryptography key.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_tag_resource/ for full documentation.
Usage
paymentcryptographycontrolplane_tag_resource(ResourceArn, Tags)
Arguments
ResourceArn |
[required] The |
Tags |
[required] One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one. Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. To use this parameter, you must have
Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. |
Deletes a tag from an Amazon Web Services Payment Cryptography key
Description
Deletes a tag from an Amazon Web Services Payment Cryptography key.
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_untag_resource/ for full documentation.
Usage
paymentcryptographycontrolplane_untag_resource(ResourceArn, TagKeys)
Arguments
ResourceArn |
[required] The |
TagKeys |
[required] One or more tag keys. Don't include the tag values. If the Amazon Web Services Payment Cryptography key doesn't have the
specified tag key, Amazon Web Services Payment Cryptography doesn't
throw an exception or return a response. To confirm that the operation
succeeded, use the
|
Associates an existing Amazon Web Services Payment Cryptography alias with a different key
Description
Associates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
See https://www.paws-r-sdk.com/docs/paymentcryptographycontrolplane_update_alias/ for full documentation.
Usage
paymentcryptographycontrolplane_update_alias(AliasName, KeyArn = NULL)
Arguments
AliasName |
[required] The alias whose associated key is changing. |
KeyArn |
The |
Payment Cryptography Data Plane
Description
You use the Amazon Web Services Payment Cryptography Data Plane to manage how encryption keys are used for payment-related transaction processing and associated cryptographic operations. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations in Amazon Web Services Payment Cryptography. For more information, see Data operations in the Amazon Web Services Payment Cryptography User Guide.
To manage your encryption keys, you use the Amazon Web Services Payment Cryptography Control Plane. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys.
Usage
paymentcryptographydataplane(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- paymentcryptographydataplane( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
decrypt_data | Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme |
encrypt_data | Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme |
generate_card_validation_data | Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC) |
generate_mac | Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography |
generate_mac_emv_pin_change | Generates an issuer script mac for EMV payment cards that use offline PINs as the cardholder verification method (CVM) |
generate_pin_data | Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance |
re_encrypt_data | Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys |
translate_pin_data | Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4 |
verify_auth_request_cryptogram | Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization |
verify_card_validation_data | Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC) |
verify_mac | Verifies a Message Authentication Code (MAC) |
verify_pin_data | Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624 |
Examples
## Not run:
svc <- paymentcryptographydataplane()
svc$decrypt_data(
Foo = 123
)
## End(Not run)
Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme
Description
Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_decrypt_data/ for full documentation.
Usage
paymentcryptographydataplane_decrypt_data(
KeyIdentifier,
CipherText,
DecryptionAttributes,
WrappedKey = NULL
)
Arguments
KeyIdentifier |
[required] The When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation. |
CipherText |
[required] The ciphertext to decrypt. |
DecryptionAttributes |
[required] The encryption key type and attributes for ciphertext decryption. |
WrappedKey |
The WrappedKeyBlock containing the encryption key for ciphertext decryption. |
Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme
Description
Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_encrypt_data/ for full documentation.
Usage
paymentcryptographydataplane_encrypt_data(
KeyIdentifier,
PlainText,
EncryptionAttributes,
WrappedKey = NULL
)
Arguments
KeyIdentifier |
[required] The When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation. |
PlainText |
[required] The plaintext to be encrypted. For encryption using asymmetric keys, plaintext data length is
constrained by encryption key strength that you define in |
EncryptionAttributes |
[required] The encryption key type and attributes for plaintext encryption. |
WrappedKey |
The WrappedKeyBlock containing the encryption key for plaintext encryption. |
Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC)
Description
Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC). For more information, see Generate card data in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_generate_card_validation_data/ for full documentation.
Usage
paymentcryptographydataplane_generate_card_validation_data(
KeyIdentifier,
PrimaryAccountNumber,
GenerationAttributes,
ValidationDataLength = NULL
)
Arguments
KeyIdentifier |
[required] The |
PrimaryAccountNumber |
[required] The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder. |
GenerationAttributes |
[required] The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography. |
ValidationDataLength |
The length of the CVV or CSC to be generated. The default value is 3. |
Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography
Description
Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_generate_mac/ for full documentation.
Usage
paymentcryptographydataplane_generate_mac(
KeyIdentifier,
MessageData,
GenerationAttributes,
MacLength = NULL
)
Arguments
KeyIdentifier |
[required] The |
MessageData |
[required] The data for which a MAC is under generation. This value must be hexBinary. |
GenerationAttributes |
[required] The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography. |
MacLength |
The length of a MAC under generation. |
Generates an issuer script mac for EMV payment cards that use offline PINs as the cardholder verification method (CVM)
Description
Generates an issuer script mac for EMV payment cards that use offline PINs as the cardholder verification method (CVM).
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_generate_mac_emv_pin_change/ for full documentation.
Usage
paymentcryptographydataplane_generate_mac_emv_pin_change(
NewPinPekIdentifier,
NewEncryptedPinBlock,
PinBlockFormat,
SecureMessagingIntegrityKeyIdentifier,
SecureMessagingConfidentialityKeyIdentifier,
MessageData,
DerivationMethodAttributes
)
Arguments
NewPinPekIdentifier |
[required] The |
NewEncryptedPinBlock |
[required] The incoming new encrypted PIN block data for offline pin change on an EMV card. |
PinBlockFormat |
[required] The PIN encoding format of the incoming new encrypted PIN block as specified in ISO 9564. |
SecureMessagingIntegrityKeyIdentifier |
[required] The |
SecureMessagingConfidentialityKeyIdentifier |
[required] The |
MessageData |
[required] The message data is the APDU command from the card reader or terminal. The target encrypted PIN block, after translation to ISO2 format, is appended to this message data to generate an issuer script response. |
DerivationMethodAttributes |
[required] The attributes and data values to derive payment card specific confidentiality and integrity keys. |
Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance
Description
Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance. For more information, see Generate PIN data in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_generate_pin_data/ for full documentation.
Usage
paymentcryptographydataplane_generate_pin_data(
GenerationKeyIdentifier,
EncryptionKeyIdentifier,
GenerationAttributes,
PinDataLength = NULL,
PrimaryAccountNumber,
PinBlockFormat,
EncryptionWrappedKey = NULL
)
Arguments
GenerationKeyIdentifier |
[required] The |
EncryptionKeyIdentifier |
[required] The |
GenerationAttributes |
[required] The attributes and values to use for PIN, PVV, or PIN Offset generation. |
PinDataLength |
The length of PIN under generation. |
PrimaryAccountNumber |
[required] The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder. |
PinBlockFormat |
[required] The PIN encoding format for pin data generation as specified in ISO
9564. Amazon Web Services Payment Cryptography supports The The |
EncryptionWrappedKey |
Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys
Description
Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_re_encrypt_data/ for full documentation.
Usage
paymentcryptographydataplane_re_encrypt_data(
IncomingKeyIdentifier,
OutgoingKeyIdentifier,
CipherText,
IncomingEncryptionAttributes,
OutgoingEncryptionAttributes,
IncomingWrappedKey = NULL,
OutgoingWrappedKey = NULL
)
Arguments
IncomingKeyIdentifier |
[required] The When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation. |
OutgoingKeyIdentifier |
[required] The |
CipherText |
[required] Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes. |
IncomingEncryptionAttributes |
[required] The attributes and values for incoming ciphertext. |
OutgoingEncryptionAttributes |
[required] The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography. |
IncomingWrappedKey |
The WrappedKeyBlock containing the encryption key of incoming ciphertext data. |
OutgoingWrappedKey |
The WrappedKeyBlock containing the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography. |
Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4
Description
Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_translate_pin_data/ for full documentation.
Usage
paymentcryptographydataplane_translate_pin_data(
IncomingKeyIdentifier,
OutgoingKeyIdentifier,
IncomingTranslationAttributes,
OutgoingTranslationAttributes,
EncryptedPinBlock,
IncomingDukptAttributes = NULL,
OutgoingDukptAttributes = NULL,
IncomingWrappedKey = NULL,
OutgoingWrappedKey = NULL
)
Arguments
IncomingKeyIdentifier |
[required] The For dynamic keys, it is the |
OutgoingKeyIdentifier |
[required] The For ECDH, it is the |
IncomingTranslationAttributes |
[required] The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography. |
OutgoingTranslationAttributes |
[required] The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography. |
EncryptedPinBlock |
[required] The encrypted PIN block data that Amazon Web Services Payment Cryptography translates. |
IncomingDukptAttributes |
The attributes and values to use for incoming DUKPT encryption key for PIN block translation. |
OutgoingDukptAttributes |
The attributes and values to use for outgoing DUKPT encryption key after PIN block translation. |
IncomingWrappedKey |
The WrappedKeyBlock containing the encryption key under which incoming PIN block data is encrypted. |
OutgoingWrappedKey |
The WrappedKeyBlock containing the encryption key for encrypting outgoing PIN block data. |
Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization
Description
Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization. For more information, see Verify auth request cryptogram in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_verify_auth_request_cryptogram/ for full documentation.
Usage
paymentcryptographydataplane_verify_auth_request_cryptogram(
KeyIdentifier,
TransactionData,
AuthRequestCryptogram,
MajorKeyDerivationMode,
SessionKeyDerivationAttributes,
AuthResponseAttributes = NULL
)
Arguments
KeyIdentifier |
[required] The |
TransactionData |
[required] The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography. |
AuthRequestCryptogram |
[required] The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data. |
MajorKeyDerivationMode |
[required] The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography. |
SessionKeyDerivationAttributes |
[required] The attributes and values to use for deriving a session key for ARQC verification within Amazon Web Services Payment Cryptography. The same attributes were used for ARQC generation outside of Amazon Web Services Payment Cryptography. |
AuthResponseAttributes |
The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification. |
Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC)
Description
Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC). For more information, see Verify card data in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_verify_card_validation_data/ for full documentation.
Usage
paymentcryptographydataplane_verify_card_validation_data(
KeyIdentifier,
PrimaryAccountNumber,
VerificationAttributes,
ValidationData
)
Arguments
KeyIdentifier |
[required] The |
PrimaryAccountNumber |
[required] The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder. |
VerificationAttributes |
[required] The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography. |
ValidationData |
[required] The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography. |
Verifies a Message Authentication Code (MAC)
Description
Verifies a Message Authentication Code (MAC).
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_verify_mac/ for full documentation.
Usage
paymentcryptographydataplane_verify_mac(
KeyIdentifier,
MessageData,
Mac,
VerificationAttributes,
MacLength = NULL
)
Arguments
KeyIdentifier |
[required] The |
MessageData |
[required] The data on for which MAC is under verification. This value must be hexBinary. |
Mac |
[required] The MAC being verified. |
VerificationAttributes |
[required] The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography. |
MacLength |
The length of the MAC. |
Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624
Description
Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment Cryptography User Guide.
See https://www.paws-r-sdk.com/docs/paymentcryptographydataplane_verify_pin_data/ for full documentation.
Usage
paymentcryptographydataplane_verify_pin_data(
VerificationKeyIdentifier,
EncryptionKeyIdentifier,
VerificationAttributes,
EncryptedPinBlock,
PrimaryAccountNumber,
PinBlockFormat,
PinDataLength = NULL,
DukptAttributes = NULL,
EncryptionWrappedKey = NULL
)
Arguments
VerificationKeyIdentifier |
[required] The |
EncryptionKeyIdentifier |
[required] The |
VerificationAttributes |
[required] The attributes and values for PIN data verification. |
EncryptedPinBlock |
[required] The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies. |
PrimaryAccountNumber |
[required] The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder. |
PinBlockFormat |
[required] The PIN encoding format for pin data generation as specified in ISO
9564. Amazon Web Services Payment Cryptography supports The The |
PinDataLength |
The length of PIN being verified. |
DukptAttributes |
The attributes and values for the DUKPT encrypted PIN block data. |
EncryptionWrappedKey |
AWS Price List Service
Description
The Amazon Web Services Price List API is a centralized and convenient
way to programmatically query Amazon Web Services for services,
products, and pricing information. The Amazon Web Services Price List
uses standardized product attributes such as Location
,
Storage Class
, and Operating System
, and provides prices at the SKU
level. You can use the Amazon Web Services Price List to do the
following:
Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services
Use GetServices
without a service code to retrieve the service codes
for all Amazon Web Services services, then GetServices
with a service
code to retrieve the attribute names for that service. After you have
the service code and attribute names, you can use
get_attribute_values
to see what
values are available for an attribute. With the service code and an
attribute name and value, you can use
get_products
to find specific products that
you're interested in, such as an AmazonEC2
instance, with a
Provisioned IOPS
volumeType
.
For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.
Usage
pricing(config = list(), credentials = list(), endpoint = NULL, region = NULL)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- pricing( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
describe_services | Returns the metadata for one service or a list of the metadata for all services |
get_attribute_values | Returns a list of attribute values |
get_price_list_file_url | This feature is in preview release and is subject to change |
get_products | Returns a list of all products that match the filter criteria |
list_price_lists | This feature is in preview release and is subject to change |
Examples
## Not run:
svc <- pricing()
# Retrieves the service for the given Service Code.
svc$describe_services(
FormatVersion = "aws_v1",
MaxResults = 1L,
ServiceCode = "AmazonEC2"
)
## End(Not run)
Returns the metadata for one service or a list of the metadata for all services
Description
Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2
, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType
, maxIopsVolume
, operation
, locationType
, and instanceCapacity10xlarge
.
See https://www.paws-r-sdk.com/docs/pricing_describe_services/ for full documentation.
Usage
pricing_describe_services(
ServiceCode = NULL,
FormatVersion = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServiceCode |
The code for the service whose information you want to retrieve, such as
|
FormatVersion |
The format version that you want the response to be in. Valid values are: |
NextToken |
The pagination token that indicates the next set of results that you want to retrieve. |
MaxResults |
The maximum number of results that you want returned in the response. |
Returns a list of attribute values
Description
Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Billing and Cost Management User Guide.
See https://www.paws-r-sdk.com/docs/pricing_get_attribute_values/ for full documentation.
Usage
pricing_get_attribute_values(
ServiceCode,
AttributeName,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServiceCode |
[required] The service code for the service whose attributes you want to retrieve.
For example, if you want the retrieve an EC2 attribute, use |
AttributeName |
[required] The name of the attribute that you want to retrieve the values for, such
as |
NextToken |
The pagination token that indicates the next set of results that you want to retrieve. |
MaxResults |
The maximum number of results to return in response. |
This feature is in preview release and is subject to change
Description
This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).
See https://www.paws-r-sdk.com/docs/pricing_get_price_list_file_url/ for full documentation.
Usage
pricing_get_price_list_file_url(PriceListArn, FileFormat)
Arguments
PriceListArn |
[required] The unique identifier that maps to where your Price List files are
located. |
FileFormat |
[required] The format that you want to retrieve your Price List files in. The
|
Returns a list of all products that match the filter criteria
Description
Returns a list of all products that match the filter criteria.
See https://www.paws-r-sdk.com/docs/pricing_get_products/ for full documentation.
Usage
pricing_get_products(
ServiceCode,
Filters = NULL,
FormatVersion = NULL,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServiceCode |
[required] The code for the service whose products you want to retrieve. |
Filters |
The list of filters that limit the returned products. only products that match all filters are returned. |
FormatVersion |
The format version that you want the response to be in. Valid values are: |
NextToken |
The pagination token that indicates the next set of results that you want to retrieve. |
MaxResults |
The maximum number of results to return in the response. |
This feature is in preview release and is subject to change
Description
This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).
See https://www.paws-r-sdk.com/docs/pricing_list_price_lists/ for full documentation.
Usage
pricing_list_price_lists(
ServiceCode,
EffectiveDate,
RegionCode = NULL,
CurrencyCode,
NextToken = NULL,
MaxResults = NULL
)
Arguments
ServiceCode |
[required] The service code or the Savings Plan service code for the attributes
that you want to retrieve. For example, to get the list of applicable
Amazon EC2 price lists, use To retrieve the Reserved Instance and Compute Savings Plan price lists,
use To retrieve Machine Learning Savings Plans price lists, use
|
EffectiveDate |
[required] The date that the Price List file prices are effective from. |
RegionCode |
This is used to filter the Price List by Amazon Web Services Region. For
example, to get the price list only for the |
CurrencyCode |
[required] The three alphabetical character ISO-4217 currency code that the Price List files are denominated in. |
NextToken |
The pagination token that indicates the next set of results that you want to retrieve. |
MaxResults |
The maximum number of results to return in the response. |
Objects exported from other packages
Description
These objects are imported from other packages. Follow the links below to see their documentation.
- paws.common
config
,credentials
,creds
,list_paginators
,paginate
,paginate_lapply
,paginate_sapply
,paws_stream_parser
AWS Savings Plans
Description
Savings Plans are a pricing model that offer significant savings on Amazon Web Services usage (for example, on Amazon EC2 instances). You commit to a consistent amount of usage per hour, in the specified currency, for a term of one or three years, and receive a lower price for that usage. For more information, see the Amazon Web Services Savings Plans User Guide.
Usage
savingsplans(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)
Arguments
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
Value
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Service syntax
svc <- savingsplans( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
Operations
create_savings_plan | Creates a Savings Plan |
delete_queued_savings_plan | Deletes the queued purchase for the specified Savings Plan |
describe_savings_plan_rates | Describes the rates for the specified Savings Plan |
describe_savings_plans | Describes the specified Savings Plans |
describe_savings_plans_offering_rates | Describes the offering rates for the specified Savings Plans |
describe_savings_plans_offerings | Describes the offerings for the specified Savings Plans |
list_tags_for_resource | Lists the tags for the specified resource |
return_savings_plan | Returns the specified Savings Plan |
tag_resource | Adds the specified tags to the specified resource |
untag_resource | Removes the specified tags from the specified resource |
Examples
## Not run:
svc <- savingsplans()
svc$create_savings_plan(
Foo = 123
)
## End(Not run)
Creates a Savings Plan
Description
Creates a Savings Plan.
See https://www.paws-r-sdk.com/docs/savingsplans_create_savings_plan/ for full documentation.
Usage
savingsplans_create_savings_plan(
savingsPlanOfferingId,
commitment,
upfrontPaymentAmount = NULL,
purchaseTime = NULL,
clientToken = NULL,
tags = NULL
)
Arguments
savingsPlanOfferingId |
[required] The ID of the offering. |
commitment |
[required] The hourly commitment, in the same currency of the
|
upfrontPaymentAmount |
The up-front payment amount. This is a whole number between 50 and 99
percent of the total value of the Savings Plan. This parameter is only
supported if the payment option is |
purchaseTime |
The purchase time of the Savings Plan in UTC format (YYYY-MM-DDTHH:MM:SSZ). |
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
tags |
One or more tags. |
Deletes the queued purchase for the specified Savings Plan
Description
Deletes the queued purchase for the specified Savings Plan.
See https://www.paws-r-sdk.com/docs/savingsplans_delete_queued_savings_plan/ for full documentation.
Usage
savingsplans_delete_queued_savings_plan(savingsPlanId)
Arguments
savingsPlanId |
[required] The ID of the Savings Plan. |
Describes the rates for the specified Savings Plan
Description
Describes the rates for the specified Savings Plan.
See https://www.paws-r-sdk.com/docs/savingsplans_describe_savings_plan_rates/ for full documentation.
Usage
savingsplans_describe_savings_plan_rates(
savingsPlanId,
filters = NULL,
nextToken = NULL,
maxResults = NULL
)
Arguments
savingsPlanId |
[required] The ID of the Savings Plan. |
filters |
The filters. |
nextToken |
The token for the next page of results. |
maxResults |
The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value. |
Describes the specified Savings Plans
Description
Describes the specified Savings Plans.
See https://www.paws-r-sdk.com/docs/savingsplans_describe_savings_plans/ for full documentation.
Usage
savingsplans_describe_savings_plans(
savingsPlanArns = NULL,
savingsPlanIds = NULL,
nextToken = NULL,
maxResults = NULL,
states = NULL,
filters = NULL
)
Arguments
savingsPlanArns |
The Amazon Resource Names (ARN) of the Savings Plans. |
savingsPlanIds |
The IDs of the Savings Plans. |
nextToken |
The token for the next page of results. |
maxResults |
The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value. |
states |
The current states of the Savings Plans. |
filters |
The filters. |
Describes the offering rates for the specified Savings Plans
Description
Describes the offering rates for the specified Savings Plans.
See https://www.paws-r-sdk.com/docs/savingsplans_describe_savings_plans_offering_rates/ for full documentation.
Usage
savingsplans_describe_savings_plans_offering_rates(
savingsPlanOfferingIds = NULL,
savingsPlanPaymentOptions = NULL,
savingsPlanTypes = NULL,
products = NULL,
serviceCodes = NULL,
usageTypes = NULL,
operations = NULL,
filters = NULL,
nextToken = NULL,
maxResults = NULL
)
Arguments
savingsPlanOfferingIds |
The IDs of the offerings. |
savingsPlanPaymentOptions |
The payment options. |
savingsPlanTypes |
The plan types. |
products |
The Amazon Web Services products. |
serviceCodes |
The services. |
usageTypes |
The usage details of the line item in the billing report. |
operations |
The specific Amazon Web Services operation for the line item in the billing report. |
filters |
The filters. |
nextToken |
The token for the next page of results. |
maxResults |
The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value. |
Describes the offerings for the specified Savings Plans
Description
Describes the offerings for the specified Savings Plans.
See https://www.paws-r-sdk.com/docs/savingsplans_describe_savings_plans_offerings/ for full documentation.
Usage
savingsplans_describe_savings_plans_offerings(
offeringIds = NULL,
paymentOptions = NULL,
productType = NULL,
planTypes = NULL,
durations = NULL,
currencies = NULL,
descriptions = NULL,
serviceCodes = NULL,
usageTypes = NULL,
operations = NULL,
filters = NULL,
nextToken = NULL,
maxResults = NULL
)
Arguments
offeringIds |
The IDs of the offerings. |
paymentOptions |
The payment options. |
productType |
The product type. |
planTypes |
The plan types. |
durations |
The duration, in seconds. |
currencies |
The currencies. |
descriptions |
The descriptions. |
serviceCodes |
The services. |
usageTypes |
The usage details of the line item in the billing report. |
operations |
The specific Amazon Web Services operation for the line item in the billing report. |
filters |
The filters. |
nextToken |
The token for the next page of results. |
maxResults |
The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value. |
Lists the tags for the specified resource
Description
Lists the tags for the specified resource.
See https://www.paws-r-sdk.com/docs/savingsplans_list_tags_for_resource/ for full documentation.
Usage
savingsplans_list_tags_for_resource(resourceArn)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
Returns the specified Savings Plan
Description
Returns the specified Savings Plan.
See https://www.paws-r-sdk.com/docs/savingsplans_return_savings_plan/ for full documentation.
Usage
savingsplans_return_savings_plan(savingsPlanId, clientToken = NULL)
Arguments
savingsPlanId |
[required] The ID of the Savings Plan. |
clientToken |
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
Adds the specified tags to the specified resource
Description
Adds the specified tags to the specified resource.
See https://www.paws-r-sdk.com/docs/savingsplans_tag_resource/ for full documentation.
Usage
savingsplans_tag_resource(resourceArn, tags)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tags |
[required] One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }. |
Removes the specified tags from the specified resource
Description
Removes the specified tags from the specified resource.
See https://www.paws-r-sdk.com/docs/savingsplans_untag_resource/ for full documentation.
Usage
savingsplans_untag_resource(resourceArn, tagKeys)
Arguments
resourceArn |
[required] The Amazon Resource Name (ARN) of the resource. |
tagKeys |
[required] The tag keys. |