Package {paws.cost.management}

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The Amazon Resource Name (ARN) of the billing view to associate source views with.

[required] A list of ARNs of the source billing views to associate.

[required] The name of the billing view.

The description of the billing view.

[required] A list of billing views used as the data source for the custom billing view.

See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.

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.

A list of key value map specifying tags associated to the billing view being created.

[required] The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

If set to true, forces deletion of the billing view even if it has derived resources (e.g. other billing views or budgets). Use with caution as this may break dependent resources.

[required] The Amazon Resource Name (ARN) of the billing view to disassociate source views from.

[required] A list of ARNs of the source billing views to disassociate.

[required] The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

[required] The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.

The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

The type of billing view.

Filters the list of billing views by name. You can specify search criteria to match billing view names based on the search option provided.

The list of owners of the billing view.

Filters the results to include only billing views that use the specified account as a source.

The maximum number of billing views to retrieve. Default is 100.

The pagination token that is used on subsequent calls to list billing views.

[required] The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

The number of entries a paginated response contains.

The pagination token that is used on subsequent calls to list billing views.

[required] The Amazon Resource Name (ARN) of the resource.

[required] The Amazon Resource Name (ARN) of the resource.

[required] A list of tag key value pairs that are associated with the resource.

[required] The Amazon Resource Name (ARN) of the resource.

[required] A list of tag key value pairs that are associated with the resource.

[required] The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

The name of the billing view.

The description of the billing view.

See Expression. Billing view only supports LINKED_ACCOUNT, Tags, and CostCategories.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.

[required] The associating array of account IDs.

[required] The PricingPlanArn that the PricingRuleArns are associated with.

[required] The PricingRuleArns that are associated with the Pricing Plan.

[required] A percentage custom line item ARN to associate the resources to.

[required] A list containing the ARNs of the resources to be associated.

A time range for which the margin summary is effective. The time range can be up to 12 months.

[required] A percentage custom line item ARN to disassociate the resources from.

[required] A list containing the ARNs of resources to be disassociated.

A time range for which the margin summary is effective. The time range can be up to 12 months.

A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

[required] The billing group name. The names must be unique.

[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.

[required] The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

The account ID that serves as the main account in a billing group.

The description of the billing group.

A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta.

A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

[required] The name of the custom line item.

[required] The description of the custom line item. This is shown on the Bills page in association with the charge value.

[required] The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

A time range for which the custom line item is effective.

A map that contains tag keys and tag values that are attached to a custom line item.

[required] A CustomLineItemChargeDetails that describes the charge details for a custom line item.

The Amazon Web Services account in which this custom line item will be applied to.

Specifies how the custom line item charges are computed.

Details controlling how the custom line item charges are presented in the bill. Contains specifications for which service the charges will be shown under.

A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

[required] The name of the pricing plan. The names must be unique to each pricing plan.

The description of the pricing plan.

A list of Amazon Resource Names (ARNs) that define the pricing plan parameters.

A map that contains tag keys and tag values that are attached to a pricing plan.

A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

[required] The pricing rule name. The names must be unique to each pricing rule.

The pricing rule description.

[required] The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.

[required] The type of pricing rule.

A percentage modifier that's applied on the public pricing rates. Your entry will be rounded to the nearest 2 decimal places.

If the Scope attribute is set to SERVICE or SKU, the attribute indicates which service the PricingRule is applicable for.

A map that contains tag keys and tag values that are attached to a pricing rule.

The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.

The set of tiering configurations for the pricing rule.

Usage type is the unit that each service uses to measure the usage of a specific type of resource.

If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an⁠ M2 High Memory Double Extra Large⁠ instance in the US West (Oregon) Region.

Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item.

If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

[required] The Amazon Resource Name (ARN) of the billing group that you're deleting.

[required] The ARN of the custom line item to be deleted.

A time range for which the margin summary is effective. The time range can be up to 12 months.

[required] The Amazon Resource Name (ARN) of the pricing plan that you're deleting.

[required] The Amazon Resource Name (ARN) of the pricing rule that you are deleting.

[required] The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from.

[required] The array of account IDs to disassociate.

[required] The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from.

[required] A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated.

[required] The Amazon Resource Number (ARN) that uniquely identifies the billing group.

A time range for which the margin summary is effective. You can specify up to 12 months.

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 Services service name or the billing period.

The maximum number of margin summary reports to retrieve.

The pagination token used on subsequent calls to get reports.

The preferred billing period to get account associations.

The filter on the account ID of the linked account, or any of the following:

MONITORED: linked accounts that are associated to billing groups.

UNMONITORED: linked accounts that aren't associated to billing groups.

⁠Billing Group Arn⁠: linked accounts that are associated to the provided billing group Arn.

The pagination token that's used on subsequent calls to retrieve accounts.

The preferred billing period for your report.

The maximum number of reports to retrieve.

The pagination token that's used on subsequent calls to get reports.

A ListBillingGroupCostReportsFilter to specify billing groups to retrieve reports from.

The preferred billing period to get billing groups.

The maximum number of billing groups to retrieve.

The pagination token that's used on subsequent calls to get billing groups.

A ListBillingGroupsFilter that specifies the billing group and pricing plan to retrieve billing group information.

[required] The Amazon Resource Name (ARN) for the custom line item.

The maximum number of custom line item versions to retrieve.

The pagination token that's used on subsequent calls to retrieve custom line item versions.

A ListCustomLineItemVersionsFilter that specifies the billing period range in which the custom line item versions are applied.

The preferred billing period to get custom line items (FFLIs).

The maximum number of billing groups to retrieve.

The pagination token that's used on subsequent calls to get custom line items (FFLIs).

A ListCustomLineItemsFilter that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information.

The preferred billing period to get pricing plan.

A ListPricingPlansFilter that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information.

The maximum number of pricing plans to retrieve.

The pagination token that's used on subsequent call to get pricing plans.

The pricing plan billing period for which associations will be listed.

[required] The pricing rule Amazon Resource Name (ARN) for which associations will be listed.

The optional maximum number of pricing rule associations to retrieve.

The optional pagination token returned by a previous call.

The preferred billing period to get the pricing plan.

A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information.

The maximum number of pricing rules to retrieve.

The pagination token that's used on subsequent call to get pricing rules.

The billing period for which the pricing rule associations are to be listed.

[required] The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed.

The optional maximum number of pricing rule associations to retrieve.

The optional pagination token returned by a previous call.

The billing period for which the resource associations will be listed.

[required] The ARN of the custom line item for which the resource associations will be listed.

(Optional) The maximum number of resource associations to be retrieved.

(Optional) The pagination token that's returned by a previous request.

(Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify the types of resources that should be retrieved.

[required] The Amazon Resource Name (ARN) that identifies the resource to list the tags.

[required] The Amazon Resource Name (ARN) of the resource to which to add tags.

[required] The tags to add to the resource as a list of key-value pairs.

[required] The Amazon Resource Name (ARN) of the resource to which to delete tags.

[required] The tags to delete from the resource as a list of key-value pairs.

[required] The Amazon Resource Name (ARN) of the billing group being updated.

The name of the billing group. The names must be unique to each billing group.

The status of the billing group. Only one of the valid values can be used.

The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

A description of the billing group.

Specifies if the billing group has automatic account association (AutoAssociate) enabled.

[required] The ARN of the custom line item to be updated.

The new name for the custom line item.

The new line item description of the custom line item.

A ListCustomLineItemChargeDetails containing the new charge details for the custom line item.

A time range for which the margin summary is effective. The time range can be up to 12 months.

[required] The Amazon Resource Name (ARN) of the pricing plan that you're updating.

The name of the pricing plan. The name must be unique to each pricing plan.

The description of the pricing plan.

[required] The Amazon Resource Name (ARN) of the pricing rule to update.

The new name of the pricing rule. The name must be unique to each pricing rule.

The new description for the pricing rule.

The new pricing rule type.

The new modifier to show pricing plan rates as a percentage. Your entry will be rounded to the nearest 2 decimal places.

The set of tiering configurations for the pricing rule.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The accountId that is associated with the budget.

[required] The budget object that you want to create.

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 create_budget call, Amazon Web Services creates the notifications and subscribers for you.

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.

[required] The account ID of the user. It's a 12-digit number.

[required] A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

[required] The type of a notification. It must be ACTUAL or FORECASTED.

[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.

[required] The trigger threshold of the action.

[required] Specifies all of the type-specific parameters.

[required] The role passed for action execution and reversion. Roles and actions must be in the same account.

[required] This specifies if the action needs manual or automatic approval.

[required] A list of subscribers.

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.

[required] The accountId that is associated with the budget that you want to create a notification for.

[required] The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.

[required] The notification that you want to create.

[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.

[required] The accountId that is associated with the budget that you want to create a subscriber for.

[required] The name of the budget that you want to subscribe to. Budget names must be unique within an account.

[required] The notification that you want to create a subscriber for.

[required] The subscriber that you want to associate with a budget notification.

[required] The accountId that is associated with the budget that you want to delete.

[required] The name of the budget that you want to delete.

[required] The account ID of the user. It's a 12-digit number.

[required] A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

[required] A system-generated universally unique identifier (UUID) for the action.

[required] The accountId that is associated with the budget whose notification you want to delete.

[required] The name of the budget whose notification you want to delete.

[required] The notification that you want to delete.

[required] The accountId that is associated with the budget whose subscriber you want to delete.

[required] The name of the budget whose subscriber you want to delete.

[required] The notification whose subscriber you want to delete.

[required] The subscriber that you want to delete.

[required] The accountId that is associated with the budget that you want a description of.

[required] The name of the budget that you want a description of.

Specifies whether the response includes the filter expression associated with the budget. By showing the filter expression, you can see detailed filtering logic applied to the budget, such as Amazon Web Services services or tags that are being tracked.

[required] The account ID of the user. It's a 12-digit number.

[required] A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

[required] A system-generated universally unique identifier (UUID) for the action.

[required] The account ID of the user. It's a 12-digit number.

[required] A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

[required] A system-generated universally unique identifier (UUID) for the action.

The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

An integer that represents how many entries a paginated response contains. The maximum is 100.

A generic string.

[required] The account ID of the user. It's a 12-digit number.

An integer that represents how many entries a paginated response contains. The maximum is 100.

A generic string.

[required] The account ID of the user. It's a 12-digit number.

[required] A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

An integer that represents how many entries a paginated response contains. The maximum is 100.

A generic string.

[required] The account ID of the user. It's a 12-digit number.

An integer that represents how many budgets a paginated response contains. The default is 50.

A generic string.

[required] The account ID of the user. It's a 12-digit number.

[required] A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

Retrieves how often the budget went into an ALARM state for the specified time period.

An integer that represents how many entries a paginated response contains. The maximum is 100.

A generic string.

[required] The accountId that is associated with the budgets that you want to describe.

An integer that represents how many budgets a paginated response contains. The default is 100.

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Specifies whether the response includes the filter expression associated with the budgets. By showing the filter expression, you can see detailed filtering logic applied to the budgets, such as Amazon Web Services services or tags that are being tracked.

[required] The accountId that is associated with the budget whose notifications you want descriptions of.

[required] The name of the budget whose notifications you want descriptions of.

An optional integer that represents how many entries a paginated response contains.

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

[required] The accountId that is associated with the budget whose subscribers you want descriptions of.

[required] The name of the budget whose subscribers you want descriptions of.

[required] The notification whose subscribers you want to list.

An optional integer that represents how many entries a paginated response contains.

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

[required] The account ID of the user. It's a 12-digit number.

[required] A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

[required] A system-generated universally unique identifier (UUID) for the action.

[required] The type of execution.

[required] The unique identifier for the resource.

[required] The unique identifier for the resource.

[required] The tags associated with the resource.

[required] The unique identifier for the resource.

[required] The key that's associated with the tag.

[required] The accountId that is associated with the budget that you want to update.

[required] The budget that you want to update your budget to.

[required] The account ID of the user. It's a 12-digit number.

[required] A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

[required] A system-generated universally unique identifier (UUID) for the action.

The type of a notification. It must be ACTUAL or FORECASTED.

The trigger threshold of the action.

Specifies all of the type-specific parameters.

The role passed for action execution and reversion. Roles and actions must be in the same account.

This specifies if the action needs manual or automatic approval.

A list of subscribers.

[required] The accountId that is associated with the budget whose notification you want to update.

[required] The name of the budget whose notification you want to update.

[required] The previous notification that is associated with a budget.

[required] The updated notification to be associated with a budget.

[required] The accountId that is associated with the budget whose subscriber you want to update.

[required] The name of the budget whose subscriber you want to update.

[required] The notification whose subscriber you want to update.

[required] The previous subscriber that is associated with a budget notification.

[required] The updated subscriber that is associated with a budget notification.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The name of the report that you want to delete. The name must be unique, is case sensitive, and can't include spaces.

The maximum number of results that Amazon Web Services returns for the operation.

A generic string.

[required] The report name of the report definition that tags are to be returned for.

[required] The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

[required] The definition of Amazon Web Services Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

[required] Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information.

The tags to be assigned to the report definition resource.

[required] The report name of the report definition that tags are to be associated with.

[required] The tags to be assigned to the report definition resource.

[required] The report name of the report definition that tags are to be disassociated from.

[required] The tags to be disassociated from the report definition resource.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The cost anomaly detection monitor object that you want to create.

An optional list of tags to associate with the specified AnomalyMonitor . You can use resource tags to control access to your monitor using IAM policies.

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:

• Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

• The maximum length of a key is 128 characters

• The maximum length of a value is 256 characters

• Keys and values can only contain alphanumeric characters, spaces, and any of the following: ⁠_.:/=+@-⁠

• Keys and values are case sensitive

• Keys and values are trimmed for any leading or trailing whitespaces

• Don’t use ⁠aws:⁠ as a prefix for your keys. This prefix is reserved for Amazon Web Services use

[required] The cost anomaly subscription object that you want to create.

An optional list of tags to associate with the specified AnomalySubscription . You can use resource tags to control access to your subscription using IAM policies.

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:

• Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

• The maximum length of a key is 128 characters

• The maximum length of a value is 256 characters

• Keys and values can only contain alphanumeric characters, spaces, and any of the following: ⁠_.:/=+@-⁠

• Keys and values are case sensitive

• Keys and values are trimmed for any leading or trailing whitespaces

• Don’t use ⁠aws:⁠ as a prefix for your keys. This prefix is reserved for Amazon Web Services use

[required] The unique name of the cost category.

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.

[required] The rule schema version in this particular cost category.

[required] The cost category rules used to categorize costs. For more information, see CostCategoryRule.

The default value for the cost category.

The split charge rules used to allocate your charges between your cost category values.

An optional list of tags to associate with the specified CostCategory . You can use resource tags to control access to your ⁠cost category⁠ using IAM policies.

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:

• Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

• The maximum length of a key is 128 characters

• The maximum length of a value is 256 characters

• Keys and values can only contain alphanumeric characters, spaces, and any of the following: ⁠_.:/=+@-⁠

• Keys and values are case sensitive

• Keys and values are trimmed for any leading or trailing whitespaces

• Don’t use ⁠aws:⁠ as a prefix for your keys. This prefix is reserved for Amazon Web Services use

[required] The unique identifier of the cost anomaly monitor that you want to delete.

[required] The unique identifier of the cost anomaly subscription that you want to delete.

[required] The unique identifier for your cost category.

[required] The unique identifier for your cost category.

The date when the cost category was effective.

Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN).

[required] Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an AnomalyEndDate in the specified time range.

Filters anomaly results by the feedback field on the anomaly object.

Filters anomaly results by the total impact field on the anomaly object. For example, you can filter anomalies ⁠GREATER_THAN 200.00⁠ to retrieve anomalies, with an estimated dollar impact greater than 200.

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.

The number of entries a paginated response contains.

A list of cost anomaly monitor ARNs.

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.

The number of entries that a paginated response contains.

A list of cost anomaly subscription ARNs.

Cost anomaly monitor ARNs.

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.

The number of entries a paginated response contains.

[required] How granular you want the data to be. You can enable data at hourly or daily granularity.

The service metadata for the service or services you want to query. If not specified, all elements are returned.

[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.

[required] The analysis ID that's associated with the commitment purchase analysis.

[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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

[required] Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.

[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 AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours and GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for get_cost_and_usage requests.

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 DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.

When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

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.

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.

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.

[required] The reference time period for comparison. This time period serves as the baseline against which other cost and usage data will be compared. The interval must start and end on the first day of a month, with a duration of exactly one month.

[required] The comparison time period for analysis. This time period's cost and usage data will be compared against the baseline time period. The interval must start and end on the first day of a month, with a duration of exactly one month.

[required] The cost and usage metric to compare. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for ⁠REGION==us-east-1 OR REGION==us-west-1⁠. For get_rightsizing_recommendation, the Region is a full name (for example, ⁠REGION==US East (N. Virginia)⁠.

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }⁠

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }⁠

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ⁠((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)⁠.

  • The corresponding Expression for this example is as follows: ⁠{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } ⁠

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: ⁠{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }⁠

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the get_rightsizing_recommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the get_reservation_purchase_recommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

You can group results using the attributes DIMENSION, TAG, and COST_CATEGORY.

The maximum number of results that are returned for the request.

The token to retrieve the next set of paginated results.

[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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

[required] Sets the Amazon Web Services cost granularity to MONTHLY, DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, MONTHLY, DAILY, or HOURLY.

[required] Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

The get_cost_and_usage_with_resources operation requires that you either group by or filter by a ResourceId. It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.

Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.

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 AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hour or GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for get_cost_and_usage_with_resources requests.

You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.

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.

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.

The value that you want to search the filter values for.

If you don't specify a CostCategoryName, SearchString is used to filter cost category names that match the SearchString pattern. If you specify a CostCategoryName, SearchString is used to filter cost category values that match the SearchString pattern.

[required] The time period of the request.

The unique name of the cost category.

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for ⁠REGION==us-east-1 OR REGION==us-west-1⁠. For get_rightsizing_recommendation, the Region is a full name (for example, ⁠REGION==US East (N. Virginia)⁠.

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }⁠

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }⁠

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ⁠((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)⁠.

  • The corresponding Expression for this example is as follows: ⁠{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } ⁠

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: ⁠{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }⁠

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the get_rightsizing_recommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the get_reservation_purchase_recommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

The value that you sort the data by.

The key represents the cost and usage metrics. The following values are supported:

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

The supported key values for the SortOrder value are ASCENDING and DESCENDING.

When you use the SortBy value, the NextPageToken and SearchString key values aren't supported.

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.

This field is only used when the SortBy value is provided in the request.

The maximum number of objects that are returned for this request. If MaxResults isn't specified with the SortBy value, the request returns 1000 results as the default value for this parameter.

For get_cost_categories, MaxResults has an upper quota of 1000.

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.

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.

[required] The reference time period for comparison. This time period serves as the baseline against which other cost and usage data will be compared. The interval must start and end on the first day of a month, with a duration of exactly one month.

[required] The comparison time period for analysis. This time period's cost and usage data will be compared against the baseline time period. The interval must start and end on the first day of a month, with a duration of exactly one month.

[required] The cost and usage metric to compare. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for ⁠REGION==us-east-1 OR REGION==us-west-1⁠. For get_rightsizing_recommendation, the Region is a full name (for example, ⁠REGION==US East (N. Virginia)⁠.

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }⁠

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }⁠

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ⁠((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)⁠.

  • The corresponding Expression for this example is as follows: ⁠{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } ⁠

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: ⁠{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }⁠

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the get_rightsizing_recommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the get_reservation_purchase_recommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

You can group results using the attributes DIMENSION, TAG, and COST_CATEGORY. Note that SERVICE and USAGE_TYPE dimensions are automatically included in the cost comparison drivers analysis.

The maximum number of results that are returned for the request.

The token to retrieve the next set of paginated results.

[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.

[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 get_cost_forecast call are the following:

• AMORTIZED_COST

• BLENDED_COST

• NET_AMORTIZED_COST

• NET_UNBLENDED_COST

• UNBLENDED_COST

[required] How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 18 months of MONTHLY forecasts.

The get_cost_forecast operation supports only DAILY and MONTHLY granularities.

The filters that you want to use to filter your forecast. The get_cost_forecast API supports filtering by the following dimensions:

• AZ

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATION

• PURCHASE_TYPE

• REGION

• SERVICE

• USAGE_TYPE

• USAGE_TYPE_GROUP

• RECORD_TYPE

• OPERATING_SYSTEM

• TENANCY

• SCOPE

• PLATFORM

• SUBSCRIPTION_ID

• LEGAL_ENTITY_NAME

• DEPLOYMENT_OPTION

• DATABASE_ENGINE

• INSTANCE_TYPE_FAMILY

• BILLING_ENTITY

• RESERVATION_ID

• SAVINGS_PLAN_ARN

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.

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.

The value that you want to search the filter values for.

[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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

[required] The name of the dimension. Each Dimension is available for a different Context. For more information, see Context. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

The context for the call to get_dimension_values. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the get_reservation_utilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the get_cost_and_usage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

• AZ - The Availability Zone. An example is ⁠us-east-1a⁠.

• BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:

  \- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services services.

  \- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services services in India.

  \- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.

• CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

• DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

• DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

• INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

• INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are ⁠Compute Optimized⁠ (for example, C4, C5, C6g, and C7g), ⁠Memory Optimization⁠ (for example, R4, R5n, R5b, and R6g).

• INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.

• LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

• LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

• OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

• OPERATION - The action performed. Examples include RunInstance and CreateBucket.

• PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

• PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.

• RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.

• SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

• SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).

• SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

• TENANCY - The tenancy of a resource. Examples are shared or dedicated.

• USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the get_dimension_values operation includes a unit attribute. Examples include GB and Hrs.

• USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

• REGION - The Amazon Web Services Region.

• RECORD_TYPE - The different types of charges such as Reserved Instance (RI) fees, usage costs, tax refunds, and credits.

• RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

• AZ - The Availability Zone. An example is ⁠us-east-1a⁠.

• CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

• DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

• INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

• LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

• PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

• REGION - The Amazon Web Services Region.

• SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

• TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

• TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

• SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

• PAYMENT_OPTION - The payment option for the given Savings Plans (for example, All Upfront)

• REGION - The Amazon Web Services Region.

• INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

• LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.

• SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for ⁠REGION==us-east-1 OR REGION==us-west-1⁠. For get_rightsizing_recommendation, the Region is a full name (for example, ⁠REGION==US East (N. Virginia)⁠.

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }⁠

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }⁠

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ⁠((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)⁠.

  • The corresponding Expression for this example is as follows: ⁠{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } ⁠

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: ⁠{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }⁠

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the get_rightsizing_recommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the get_reservation_purchase_recommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

The supported values for the SortOrder key are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString aren't supported.

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.

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 get_dimension_values, MaxResults has an upper limit of 1000.

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.

[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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

You can group the data by the following attributes:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• INVOICING_ENTITY

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• TENANCY

The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.

The get_reservation_coverage operation supports only DAILY and MONTHLY granularities.

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DATABASE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• TAG

• TENANCY

get_reservation_coverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

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.

The value by which you want to sort the data.

The following values are supported for Key:

• OnDemandCost

• CoverageHoursPercentage

• OnDemandHours

• ReservedHours

• TotalRunningHours

• CoverageNormalizedUnitsPercentage

• OnDemandNormalizedUnits

• ReservedNormalizedUnits

• TotalRunningNormalizedUnits

• Time

Supported values for SortOrder are ASCENDING or DESCENDING.

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.

The account ID that's associated with the recommendation.

[required] The specific service that you want recommendations for.

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for ⁠REGION==us-east-1 OR REGION==us-west-1⁠. For get_rightsizing_recommendation, the Region is a full name (for example, ⁠REGION==US East (N. Virginia)⁠.

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }⁠

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }⁠

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ⁠((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)⁠.

  • The corresponding Expression for this example is as follows: ⁠{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } ⁠

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: ⁠{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }⁠

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the get_rightsizing_recommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the get_reservation_purchase_recommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

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 PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

The reservation term that you want recommendations for.

The reservation purchase option that you want recommendations for.

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

The number of recommendations that you want returned in a single response object.

The pagination token that indicates the next set of results that you want to retrieve.

[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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Groups only by SUBSCRIPTION_ID. Metadata is included.

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, get_reservation_utilization defaults to DAILY.

The get_reservation_utilization operation supports only DAILY and MONTHLY granularities.

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

  If not specified, the SERVICE filter defaults to Amazon Elastic Compute Cloud - Compute. Supported values for SERVICE are Amazon Elastic Compute Cloud - Compute, Amazon Relational Database Service, Amazon ElastiCache, Amazon Redshift, and Amazon Elasticsearch Service. The value for the SERVICE filter should not exceed "1".

• SCOPE

• TENANCY

get_reservation_utilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• UtilizationPercentageInUnits

• PurchasedHours

• PurchasedUnits

• TotalActualHours

• TotalActualUnits

• UnusedHours

• UnusedUnits

• OnDemandCostOfRIHoursUsed

• NetRISavings

• TotalPotentialRISavings

• AmortizedUpfrontFee

• AmortizedRecurringFee

• TotalAmortizedFee

• RICostForUnusedHours

• RealizedSavings

• UnrealizedSavings

The supported values for SortOrder are ASCENDING and DESCENDING.

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.

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.

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for ⁠REGION==us-east-1 OR REGION==us-west-1⁠. For get_rightsizing_recommendation, the Region is a full name (for example, ⁠REGION==US East (N. Virginia)⁠.

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }⁠

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }⁠

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ⁠((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)⁠.

  • The corresponding Expression for this example is as follows: ⁠{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } ⁠

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: ⁠{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }⁠

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the get_rightsizing_recommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the get_reservation_purchase_recommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

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.

[required] The specific service that you want recommendations for. The only valid value for get_rightsizing_recommendation is "AmazonEC2".

The number of recommendations that you want returned in a single response object.

The pagination token that indicates the next set of results that you want to retrieve.

[required] The ID that is associated with the Savings Plan recommendation.

[required] The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

The get_savings_plans_coverage operation supports only DAILY and MONTHLY granularities.

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

• LINKED_ACCOUNT

• REGION

• SERVICE

• INSTANCE_FAMILY

get_savings_plans_coverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

Cost category is also supported.

The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans.

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.

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

The value that you want to sort the data by.

The following values are supported for Key:

• SpendCoveredBySavingsPlan

• OnDemandCost

• CoveragePercentage

• TotalCost

• InstanceFamily

• Region

• Service

The supported values for SortOrder are ASCENDING and DESCENDING.

[required] The Savings Plans recommendation type that's requested.

[required] The savings plan recommendation term that's used to generate these recommendations.

[required] The payment option that's used to generate these recommendations.

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 PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

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.

The number of recommendations that you want returned in a single response object.

[required] The lookback period that's used to generate the recommendation.

You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are not supported.

[required] The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

The granularity of the Amazon Web Services utillization data for your Savings Plans.

The get_savings_plans_utilization operation supports only DAILY and MONTHLY granularities.

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• SAVINGS_PLANS_TYPE

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

get_savings_plans_utilization uses the same Expression object as the other operations, but only AND is supported among each dimension.

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

The supported values for SortOrder are ASCENDING and DESCENDING.

[required] The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

• LINKED_ACCOUNT

• SAVINGS_PLAN_ARN

• REGION

• PAYMENT_OPTION

• INSTANCE_TYPE_FAMILY

get_savings_plans_utilization_details uses the same Expression object as the other operations, but only AND is supported among each dimension.

The data type.

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.

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

The value that you want to sort the data by.

The following values are supported for Key:

• UtilizationPercentage

• TotalCommitment

• UsedCommitment

• UnusedCommitment

• NetSavings

• AmortizedRecurringCommitment

• AmortizedUpfrontCommitment

The supported values for SortOrder are ASCENDING and DESCENDING.

The value that you want to search for.

[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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

The key of the tag that you want to return values for.

Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:

• Simple dimension values.

  • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

    • Specify the CostCategories field to define a filter that acts on Cost Categories.

    • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

    • Specify the Dimensions field to define a filter that acts on the DimensionValues .

  • For each filter type, you can set the dimension name and values for the filters that you plan to use.

    • For example, you can filter for ⁠REGION==us-east-1 OR REGION==us-west-1⁠. For get_rightsizing_recommendation, the Region is a full name (for example, ⁠REGION==US East (N. Virginia)⁠.

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }⁠

    • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

  • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

    • For example, you can filter for linked account names that start with "a".

    • The corresponding Expression for this example is as follows: ⁠{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }⁠

• Compound Expression types with logical operations.

  • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

  • For example, you can filter by ⁠((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)⁠.

  • The corresponding Expression for this example is as follows: ⁠{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } ⁠

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: ⁠{ "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }⁠

  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"

For the get_rightsizing_recommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the get_reservation_purchase_recommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.

The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

The supported values for SortOrder are ASCENDING and DESCENDING.

When you use SortBy, NextPageToken and SearchString aren't supported.

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.

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 get_tags, MaxResults has an upper quota of 1000.

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.

[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 start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

[required] Which metric Cost Explorer uses to create your forecast.

Valid values for a get_usage_forecast call are the following:

• USAGE_QUANTITY

• NORMALIZED_USAGE_AMOUNT

[required] How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 18 months of MONTHLY forecasts.

The get_usage_forecast operation supports only DAILY and MONTHLY granularities.

The filters that you want to use to filter your forecast. The get_usage_forecast API supports filtering by the following dimensions:

• AZ

• INSTANCE_TYPE

• LINKED_ACCOUNT

• LINKED_ACCOUNT_NAME

• OPERATION

• PURCHASE_TYPE

• REGION

• SERVICE

• USAGE_TYPE

• USAGE_TYPE_GROUP

• RECORD_TYPE

• OPERATING_SYSTEM

• TENANCY

• SCOPE

• PLATFORM

• SUBSCRIPTION_ID

• LEGAL_ENTITY_NAME

• DEPLOYMENT_OPTION

• DATABASE_ENGINE

• INSTANCE_TYPE_FAMILY

• BILLING_ENTITY

• RESERVATION_ID

• SAVINGS_PLAN_ARN

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.

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.

The status of the analysis.

The token to retrieve the next set of results.

The number of analyses that you want returned in a single response object.

The analysis IDs associated with the commitment purchase analyses.

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.

The maximum number of objects that are returned for this request.

The status of cost allocation tag keys that are returned for this request.

The list of cost allocation tag keys that are returned for this request.

The type of CostAllocationTag object that are returned for this request. The AWSGenerated type tags are tags that Amazon Web Services defines and applies to support Amazon Web Services resources for cost allocation purposes. The UserDefined type tags are tags that you define, create, and apply to resources.

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.

The maximum number of objects that are returned for this request. By default, the request returns 100 results.

The date when the cost category was effective.

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.

The number of entries a paginated response contains.

Filter cost category definitions that are supported by given resource types based on the latest version. If the filter is present, the result only includes Cost Categories that supports input resource type. If the filter isn't provided, no filtering is applied. The valid values are billing:rispgroupsharing and billing:billingview.

The unique identifier for your cost category.

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.

The number of entries a paginated response contains.

The status of the recommendation generation.

The IDs for each specific recommendation.

The number of recommendations that you want returned in a single response object.

The token to retrieve the next set of results.

[required] The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.

[required] A cost anomaly ID.

[required] Describes whether the cost anomaly was a planned activity or you considered it an anomaly.

[required] The configuration for the commitment purchase analysis.

[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.

[required] The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.

[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:

• Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

• The maximum length of a key is 128 characters

• The maximum length of a value is 256 characters

• Keys and values can only contain alphanumeric characters, spaces, and any of the following: ⁠_.:/=+@-⁠

• Keys and values are case sensitive

• Keys and values are trimmed for any leading or trailing whitespaces

• Don’t use ⁠aws:⁠ as a prefix for your keys. This prefix is reserved for Amazon Web Services use

[required] The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.

[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.

[required] Cost anomaly monitor Amazon Resource Names (ARNs).

The new name for the cost anomaly monitor.

[required] A cost anomaly subscription Amazon Resource Name (ARN).

(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.

The update to the frequency value that subscribers receive notifications.

A list of cost anomaly monitor ARNs.

The update to the subscriber list.

The new name of the subscription.

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 ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.

You can specify either Threshold or ThresholdExpression, but not both.

The following are examples of valid ThresholdExpressions:

• Absolute threshold: ⁠{ "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }⁠

• Percentage threshold: ⁠{ "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }⁠

• AND two thresholds together: ⁠{ "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }⁠

• OR two thresholds together: ⁠{ "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }⁠

[required] The list of CostAllocationTagStatusEntry objects that are used to update cost allocation tags status for this request.

[required] The unique identifier for your cost category.

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.

[required] The rule schema version in this particular cost category.

[required] The Expression object used to categorize costs. For more information, see CostCategoryRule .

The default value for the cost category.

The split charge rules used to allocate your charges between your cost category values.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] List of entity IDs and the catalogs the entities are present in.

[required] Required. The catalog related to the request. Fixed value: AWSMarketplace.

[required] Required. The unique identifier of the start_change_set request that you want to cancel.

[required] The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.

[required] Required. The catalog related to the request. Fixed value: AWSMarketplace

[required] Required. The unique identifier for the start_change_set request that you want to describe the details for.

[required] Required. The catalog related to the request. Fixed value: AWSMarketplace

[required] Required. The unique ID of the entity to describe.

[required] The Amazon Resource Name (ARN) of the entity resource that is associated with the resource policy.

[required] The catalog related to the request. Fixed value: AWSMarketplace

An array of filter objects.

An object that contains two attributes, SortBy and SortOrder.

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.

The token value retrieved from a previous call to access the next page of results.

[required] The catalog related to the request. Fixed value: AWSMarketplace

[required] The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, OfferSet, Seller, ResaleAuthorization, Solution.

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

An object that contains two attributes, SortBy and SortOrder.

The value of the next token, if it exists. Null if there are no more results.

Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API put_resource_policy operation can't be discovered through the SHARED parameter.

A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

[required] Required. The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

[required] The Amazon Resource Name (ARN) of the entity resource you want to associate with a resource policy.

[required] The policy document to set; formatted in JSON.

[required] The catalog related to the request. Fixed value: AWSMarketplace

[required] Array of change object.

Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list of change sets.

A unique token to identify the request to ensure idempotency.

A list of objects specifying each key name and value for the ChangeSetTags property.

The intent related to the request. The default is APPLY. To test your request before applying changes to your entities, use VALIDATE. This feature is currently available for adding versions to single-AMI products. For more information, see Add a new version.

[required] Required. The Amazon Resource Name (ARN) associated with the resource you want to tag.

[required] Required. A list of objects specifying each key name and value. Number of objects allowed: 1-50.

[required] Required. The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

[required] Required. A list of key names of tags to be removed. Number of strings allowed: 0-256.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The desired data set type.

• customer_subscriber_hourly_monthly_subscriptions

  From 2017-09-15 to present: Available daily by 24:00 UTC.

• customer_subscriber_annual_subscriptions

  From 2017-09-15 to present: Available daily by 24:00 UTC.

• daily_business_usage_by_instance_type

  From 2017-09-15 to present: Available daily by 24:00 UTC.

• daily_business_fees

  From 2017-09-15 to present: Available daily by 24:00 UTC.

• daily_business_free_trial_conversions

  From 2017-09-15 to present: Available daily by 24:00 UTC.

• daily_business_new_instances

  From 2017-09-15 to present: Available daily by 24:00 UTC.

• daily_business_new_product_subscribers

  From 2017-09-15 to present: Available daily by 24:00 UTC.

• daily_business_canceled_product_subscribers

  From 2017-09-15 to present: Available daily by 24:00 UTC.

• monthly_revenue_billing_and_revenue_data

  From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.

• monthly_revenue_annual_subscriptions

  From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.

• monthly_revenue_field_demonstration_usage

  From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

• monthly_revenue_flexible_payment_schedule

  From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

• disbursed_amount_by_product

  From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

• disbursed_amount_by_instance_hours

  From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

• disbursed_amount_by_customer_geo

  From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

• disbursed_amount_by_age_of_uncollected_funds

  From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

• disbursed_amount_by_age_of_disbursed_funds

  From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

• disbursed_amount_by_age_of_past_due_funds

  From 2018-04-07 to present: Available every 30 days by 24:00 UTC.

• disbursed_amount_by_uncollected_funds_breakdown

  From 2019-10-04 to present: Available every 30 days by 24:00 UTC.

• sales_compensation_billed_revenue

  From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.

• us_sales_and_use_tax_records

  From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

• disbursed_amount_by_product_with_uncollected_funds

  This data set is deprecated. Download related reports from AMMP instead!

• customer_profile_by_industry

  This data set is deprecated. Download related reports from AMMP instead!

• customer_profile_by_revenue

  This data set is deprecated. Download related reports from AMMP instead!

• customer_profile_by_geography

  This data set is deprecated. Download related reports from AMMP instead!

[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).

[required] The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

[required] The name (friendly name, not ARN) of the destination S3 bucket.

(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.

[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.

(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.

[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.

• customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.

• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data