# get-anomaly-subscriptions ## Description Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetAnomalySubscriptions) `get-anomaly-subscriptions` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument. When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `AnomalySubscriptions` ## Synopsis ``` get-anomaly-subscriptions [--subscription-arn-list ] [--monitor-arn ] [--starting-token ] [--page-size ] [--max-items ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] ``` ## Options `--subscription-arn-list` (list) > A list of cost anomaly subscription ARNs. > (string) > > Constraints: > > * min: `0` > > * max: `1024` > > * pattern: `[\S\s]*` Syntax: ``` "string" "string" ... ``` `--monitor-arn` (string) > Cost anomaly monitor ARNs. > Constraints: > * min: `0` > * max: `1024` > * pattern: `[\S\s]*` `--starting-token` (string) > A token to specify where to start paginating. This is the `NextToken` from a previously truncated response. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . `--page-size` (integer) > The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . `--max-items` (integer) > The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI. > For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. `--generate-cli-skeleton` (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced ## Output AnomalySubscriptions -> (list) > A list of cost anomaly subscriptions that includes the detailed metadata for each one. > (structure) > > An `AnomalySubscription` resource (also referred to as an alert subscription) sends notifications about specific anomalies that meet an alerting criteria defined by you. > > You can specify the frequency of the alerts and the subscribers to notify. > > Anomaly subscriptions can be associated with one or more \` `AnomalyMonitor` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor).html\`_\_ resources, and they only send notifications about anomalies detected by those associated monitors. You can also configure a threshold to further control which anomalies are included in the notifications. > > Anomalies that don’t exceed the chosen threshold and therefore don’t trigger notifications from an anomaly subscription will still be available on the console and from the \` `GetAnomalies` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetAnomalies](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetAnomalies).html\`_\_ API. > > SubscriptionArn -> (string) > > > The `AnomalySubscription` Amazon Resource Name (ARN). > > > Constraints: > > > * min: `0` > > > * max: `1024` > > > * pattern: `[\S\s]*` > > AccountId -> (string) > > > Your unique account identifier. > > > Constraints: > > > * min: `0` > > > * max: `1024` > > > * pattern: `[\S\s]*` > > MonitorArnList -> (list) [required] > > > A list of cost anomaly monitors. > > > (string) > > > > Constraints: > > > > * min: `20` > > > > * max: `2048` > > > > * pattern: `arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+` > > Subscribers -> (list) [required] > > > A list of subscribers to notify. > > > (structure) > > > > The recipient of `AnomalySubscription` notifications. > > > > Address -> (string) > > > > > The email address or SNS Amazon Resource Name (ARN). This depends on the `Type` . > > > > > Constraints: > > > > > * min: `6` > > > > > * max: `302` > > > > > * pattern: `(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+(\.fifo)?$)` > > > > Type -> (string) > > > > > The notification delivery channel. > > > > > Possible values: > > > > > * `EMAIL` > > > > > * `SNS` > > > > Status -> (string) > > > > > Indicates if the subscriber accepts the notifications. > > > > > Possible values: > > > > > * `CONFIRMED` > > > > > * `DECLINED` > > Threshold -> (double) > > > (deprecated) > > > An absolute dollar value that must be exceeded by the anomaly’s total impact (see [Impact](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) for more details) for an anomaly notification to be generated. > > > This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression. > > > One of Threshold or ThresholdExpression is required for this resource. You cannot specify both. > > > Constraints: > > > * min: `0.0` > > Frequency -> (string) [required] > > > The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see [Creating an Amazon SNS topic for anomaly notifications](https://docs.aws.amazon.com/cost-management/latest/userguide/ad-SNS.html) . > > > Possible values: > > > * `DAILY` > > > * `IMMEDIATE` > > > * `WEEKLY` > > SubscriptionName -> (string) [required] > > > The name for the subscription. > > > Constraints: > > > * min: `0` > > > * max: `1024` > > > * pattern: `[\S\s]*` > > ThresholdExpression -> (structure) > > > An [Expression](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) 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](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) 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. > > > One of Threshold or ThresholdExpression is required for this resource. You cannot specify 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" ] } } ] }` > > > Or -> (list) > > > > Return results that match either `Dimension` object. > > > > (structure) > > > > > 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 four types of simple dimension values: `CostCategories` , `Tags` , `Dimensions` , and `ProductAttributes` . > > > > > * 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` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues).html\`_\_ . > > > > > * Specify the `ProductAttributes` field to define a filter that acts on the product attributes of supported services, such as Amazon Bedrock. Only `GetCostAndUsage` , `GetCostAndUsageWithResources` , `GetDimensionValues` (in the `COST_AND_USAGE` context), `GetTags` , and `GetCostCategories` support `ProductAttributes` . For the supported services, keys and `SERVICE` filter rules, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > * 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 `GetRightsizingRecommendation` , 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"] }}} ] }` > > > > > #### NOTE > > > > > 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"` > > > > > #### NOTE > > > > > For the `GetRightsizingRecommendation` 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 `GetReservationPurchaseRecommendation` action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited to `LINKED_ACCOUNT` . > > > > > Or -> (list) > > > > > > Return results that match either `Dimension` object. > > > > > > ( … recursive … ) > > > > > And -> (list) > > > > > > Return results that match both `Dimension` objects. > > > > > > ( … recursive … ) > > > > > ( … recursive … )Dimensions -> (structure) > > > > > > The specific `Dimension` to use for `Expression` . > > > > > > Key -> (string) > > > > > > > The names of the metadata types that you can use to filter and group your results. For example, `AZ` returns a list of Availability Zones. > > > > > > > Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported. > > > > > > > > `LINKED_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in [CostCategoryRule](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html) . > > > > > > > > `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE` can only be used in [AnomalySubscriptions](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) . > > > > > > > Use `PRODUCT_ATTRIBUTE` only as the `Dimension` in `GetDimensionValues` . To filter or group by product attributes, use the `ProductAttributes` field of `Expression` or the `PRODUCT_ATTRIBUTE` group type. > > > > > > > Possible values: > > > > > > > * `AZ` > > > > > > > * `INSTANCE_TYPE` > > > > > > > * `LINKED_ACCOUNT` > > > > > > > * `PAYER_ACCOUNT` > > > > > > > * `LINKED_ACCOUNT_NAME` > > > > > > > * `OPERATION` > > > > > > > * `PURCHASE_TYPE` > > > > > > > * `REGION` > > > > > > > * `SERVICE` > > > > > > > * `SERVICE_CODE` > > > > > > > * `USAGE_TYPE` > > > > > > > * `USAGE_TYPE_GROUP` > > > > > > > * `RECORD_TYPE` > > > > > > > * `OPERATING_SYSTEM` > > > > > > > * `TENANCY` > > > > > > > * `SCOPE` > > > > > > > * `PLATFORM` > > > > > > > * `SUBSCRIPTION_ID` > > > > > > > * `LEGAL_ENTITY_NAME` > > > > > > > * `DEPLOYMENT_OPTION` > > > > > > > * `DATABASE_ENGINE` > > > > > > > * `CACHE_ENGINE` > > > > > > > * `INSTANCE_TYPE_FAMILY` > > > > > > > * `BILLING_ENTITY` > > > > > > > * `RESERVATION_ID` > > > > > > > * `RESOURCE_ID` > > > > > > > * `RIGHTSIZING_TYPE` > > > > > > > * `SAVINGS_PLANS_TYPE` > > > > > > > * `SAVINGS_PLAN_ARN` > > > > > > > * `PAYMENT_OPTION` > > > > > > > * `AGREEMENT_END_DATE_TIME_AFTER` > > > > > > > * `AGREEMENT_END_DATE_TIME_BEFORE` > > > > > > > * `INVOICING_ENTITY` > > > > > > > * `ANOMALY_TOTAL_IMPACT_ABSOLUTE` > > > > > > > * `ANOMALY_TOTAL_IMPACT_PERCENTAGE` > > > > > > > * `PRODUCT_ATTRIBUTE` > > > > > > Values -> (list) > > > > > > > The metadata values that you can use to filter and group your results. You can use `GetDimensionValues` to find specific values. > > > > > > > (string) > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `1024` > > > > > > > > * pattern: `[\S\s]*` > > > > > > MatchOptions -> (list) > > > > > > > The match options that you can use to filter your results. > > > > > > > > `MatchOptions` is only applicable for actions related to cost category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported. > > > > > > > The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE` . > > > > > > > (string) > > > > > > > > Possible values: > > > > > > > > * `EQUALS` > > > > > > > > * `ABSENT` > > > > > > > > * `STARTS_WITH` > > > > > > > > * `ENDS_WITH` > > > > > > > > * `CONTAINS` > > > > > > > > * `CASE_SENSITIVE` > > > > > > > > * `CASE_INSENSITIVE` > > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > > Tags -> (structure) > > > > > > The specific `Tag` to use for `Expression` . > > > > > > Key -> (string) > > > > > > > The key for the tag. > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `1024` > > > > > > > * pattern: `[\S\s]*` > > > > > > Values -> (list) > > > > > > > The specific value of the tag. > > > > > > > (string) > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `1024` > > > > > > > > * pattern: `[\S\s]*` > > > > > > MatchOptions -> (list) > > > > > > > The match options that you can use to filter your results. `MatchOptions` is only applicable for actions related to cost category. The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE` . > > > > > > > (string) > > > > > > > > Possible values: > > > > > > > > * `EQUALS` > > > > > > > > * `ABSENT` > > > > > > > > * `STARTS_WITH` > > > > > > > > * `ENDS_WITH` > > > > > > > > * `CONTAINS` > > > > > > > > * `CASE_SENSITIVE` > > > > > > > > * `CASE_INSENSITIVE` > > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > > CostCategories -> (structure) > > > > > > The filter that’s based on `CostCategory` values. > > > > > > Key -> (string) > > > > > > > The unique name of the cost category. > > > > > > > Constraints: > > > > > > > * min: `1` > > > > > > > * max: `50` > > > > > > > * pattern: `^(?! )[\p{L}\p{N}\p{Z}-_]*(? > > > > > Values -> (list) > > > > > > > The specific value of the cost category. > > > > > > > (string) > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `1024` > > > > > > > > * pattern: `[\S\s]*` > > > > > > MatchOptions -> (list) > > > > > > > The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for `MatchOptions` is `EQUALS` and `CASE_SENSITIVE` . > > > > > > > (string) > > > > > > > > Possible values: > > > > > > > > * `EQUALS` > > > > > > > > * `ABSENT` > > > > > > > > * `STARTS_WITH` > > > > > > > > * `ENDS_WITH` > > > > > > > > * `CONTAINS` > > > > > > > > * `CASE_SENSITIVE` > > > > > > > > * `CASE_INSENSITIVE` > > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > > ProductAttributes -> (structure) > > > > > > The filter that’s based on `ProductAttributeValues` . Use it to filter the costs of supported services, such as Amazon Bedrock, by product attributes. The following operations support this filter: `GetCostAndUsage` , `GetCostAndUsageWithResources` , `GetDimensionValues` (in the `COST_AND_USAGE` context), `GetTags` , and `GetCostCategories` . For the supported services and keys, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > > Key -> (string) [required] > > > > > > > The name of the product attribute, such as `model` . The keys that are available depend on the service. For the keys of each supported service, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > > > Keys are case-sensitive. A key that doesn’t exist doesn’t return an error: `EQUALS` matches no costs, and `ABSENT` matches all costs of supported services. > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `1024` > > > > > > > * pattern: `^([a-zA-Z][a-zA-Z0-9]*)?$` > > > > > > Values -> (list) > > > > > > > The specific values of the product attribute, such as `Claude Sonnet 5` for the `model` key. Values are matched exactly, including case. To list the values of a key, use `GetDimensionValues` with `Dimension` set to `PRODUCT_ATTRIBUTE` and `DimensionKey` set to the key. > > > > > > > To match costs that have no value for the key, set `MatchOptions` to `ABSENT` and omit `Values` . Otherwise, `Values` is required. > > > > > > > Constraints: > > > > > > > * min: `1` > > > > > > > * max: `6000` > > > > > > > (string) > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `1024` > > > > > > > > * pattern: `[\S\s]*` > > > > > > MatchOptions -> (list) > > > > > > > The match options that you can use to filter your results. Valid values: > > > > > > > * `EQUALS` - Matches the values that you specify. > > > > > > > * `ABSENT` - Matches costs that have no value for the key. Omit `Values` . > > > > > > > * `CASE_SENSITIVE` - Use only with `EQUALS` . Values are always matched case-sensitively. > > > > > > > Default values are `EQUALS` and `CASE_SENSITIVE` . > > > > > > > (string) > > > > > > > > Possible values: > > > > > > > > * `EQUALS` > > > > > > > > * `ABSENT` > > > > > > > > * `STARTS_WITH` > > > > > > > > * `ENDS_WITH` > > > > > > > > * `CONTAINS` > > > > > > > > * `CASE_SENSITIVE` > > > > > > > > * `CASE_INSENSITIVE` > > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > And -> (list) > > > > Return results that match both `Dimension` objects. > > > > (structure) > > > > > 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 four types of simple dimension values: `CostCategories` , `Tags` , `Dimensions` , and `ProductAttributes` . > > > > > * 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` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues).html\`_\_ . > > > > > * Specify the `ProductAttributes` field to define a filter that acts on the product attributes of supported services, such as Amazon Bedrock. Only `GetCostAndUsage` , `GetCostAndUsageWithResources` , `GetDimensionValues` (in the `COST_AND_USAGE` context), `GetTags` , and `GetCostCategories` support `ProductAttributes` . For the supported services, keys and `SERVICE` filter rules, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > * 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 `GetRightsizingRecommendation` , 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"] }}} ] }` > > > > > #### NOTE > > > > > 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"` > > > > > #### NOTE > > > > > For the `GetRightsizingRecommendation` 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 `GetReservationPurchaseRecommendation` action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited to `LINKED_ACCOUNT` . > > > > > Or -> (list) > > > > > > Return results that match either `Dimension` object. > > > > > > ( … recursive … ) > > > > > And -> (list) > > > > > > Return results that match both `Dimension` objects. > > > > > > ( … recursive … ) > > > > > ( … recursive … )Dimensions -> (structure) > > > > > > The specific `Dimension` to use for `Expression` . > > > > > > Key -> (string) > > > > > > > The names of the metadata types that you can use to filter and group your results. For example, `AZ` returns a list of Availability Zones. > > > > > > > Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported. > > > > > > > > `LINKED_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in [CostCategoryRule](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html) . > > > > > > > > `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE` can only be used in [AnomalySubscriptions](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) . > > > > > > > Use `PRODUCT_ATTRIBUTE` only as the `Dimension` in `GetDimensionValues` . To filter or group by product attributes, use the `ProductAttributes` field of `Expression` or the `PRODUCT_ATTRIBUTE` group type. > > > > > > > Possible values: > > > > > > > * `AZ` > > > > > > > * `INSTANCE_TYPE` > > > > > > > * `LINKED_ACCOUNT` > > > > > > > * `PAYER_ACCOUNT` > > > > > > > * `LINKED_ACCOUNT_NAME` > > > > > > > * `OPERATION` > > > > > > > * `PURCHASE_TYPE` > > > > > > > * `REGION` > > > > > > > * `SERVICE` > > > > > > > * `SERVICE_CODE` > > > > > > > * `USAGE_TYPE` > > > > > > > * `USAGE_TYPE_GROUP` > > > > > > > * `RECORD_TYPE` > > > > > > > * `OPERATING_SYSTEM` > > > > > > > * `TENANCY` > > > > > > > * `SCOPE` > > > > > > > * `PLATFORM` > > > > > > > * `SUBSCRIPTION_ID` > > > > > > > * `LEGAL_ENTITY_NAME` > > > > > > > * `DEPLOYMENT_OPTION` > > > > > > > * `DATABASE_ENGINE` > > > > > > > * `CACHE_ENGINE` > > > > > > > * `INSTANCE_TYPE_FAMILY` > > > > > > > * `BILLING_ENTITY` > > > > > > > * `RESERVATION_ID` > > > > > > > * `RESOURCE_ID` > > > > > > > * `RIGHTSIZING_TYPE` > > > > > > > * `SAVINGS_PLANS_TYPE` > > > > > > > * `SAVINGS_PLAN_ARN` > > > > > > > * `PAYMENT_OPTION` > > > > > > > * `AGREEMENT_END_DATE_TIME_AFTER` > > > > > > > * `AGREEMENT_END_DATE_TIME_BEFORE` > > > > > > > * `INVOICING_ENTITY` > > > > > > > * `ANOMALY_TOTAL_IMPACT_ABSOLUTE` > > > > > > > * `ANOMALY_TOTAL_IMPACT_PERCENTAGE` > > > > > > > * `PRODUCT_ATTRIBUTE` > > > > > > Values -> (list) > > > > > > > The metadata values that you can use to filter and group your results. You can use `GetDimensionValues` to find specific values. > > > > > > > (string) > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `1024` > > > > > > > > * pattern: `[\S\s]*` > > > > > > MatchOptions -> (list) > > > > > > > The match options that you can use to filter your results. > > > > > > > > `MatchOptions` is only applicable for actions related to cost category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported. > > > > > > > The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE` . > > > > > > > (string) > > > > > > > > Possible values: > > > > > > > > * `EQUALS` > > > > > > > > * `ABSENT` > > > > > > > > * `STARTS_WITH` > > > > > > > > * `ENDS_WITH` > > > > > > > > * `CONTAINS` > > > > > > > > * `CASE_SENSITIVE` > > > > > > > > * `CASE_INSENSITIVE` > > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > > Tags -> (structure) > > > > > > The specific `Tag` to use for `Expression` . > > > > > > Key -> (string) > > > > > > > The key for the tag. > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `1024` > > > > > > > * pattern: `[\S\s]*` > > > > > > Values -> (list) > > > > > > > The specific value of the tag. > > > > > > > (string) > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `1024` > > > > > > > > * pattern: `[\S\s]*` > > > > > > MatchOptions -> (list) > > > > > > > The match options that you can use to filter your results. `MatchOptions` is only applicable for actions related to cost category. The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE` . > > > > > > > (string) > > > > > > > > Possible values: > > > > > > > > * `EQUALS` > > > > > > > > * `ABSENT` > > > > > > > > * `STARTS_WITH` > > > > > > > > * `ENDS_WITH` > > > > > > > > * `CONTAINS` > > > > > > > > * `CASE_SENSITIVE` > > > > > > > > * `CASE_INSENSITIVE` > > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > > CostCategories -> (structure) > > > > > > The filter that’s based on `CostCategory` values. > > > > > > Key -> (string) > > > > > > > The unique name of the cost category. > > > > > > > Constraints: > > > > > > > * min: `1` > > > > > > > * max: `50` > > > > > > > * pattern: `^(?! )[\p{L}\p{N}\p{Z}-_]*(? > > > > > Values -> (list) > > > > > > > The specific value of the cost category. > > > > > > > (string) > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `1024` > > > > > > > > * pattern: `[\S\s]*` > > > > > > MatchOptions -> (list) > > > > > > > The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for `MatchOptions` is `EQUALS` and `CASE_SENSITIVE` . > > > > > > > (string) > > > > > > > > Possible values: > > > > > > > > * `EQUALS` > > > > > > > > * `ABSENT` > > > > > > > > * `STARTS_WITH` > > > > > > > > * `ENDS_WITH` > > > > > > > > * `CONTAINS` > > > > > > > > * `CASE_SENSITIVE` > > > > > > > > * `CASE_INSENSITIVE` > > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > > ProductAttributes -> (structure) > > > > > > The filter that’s based on `ProductAttributeValues` . Use it to filter the costs of supported services, such as Amazon Bedrock, by product attributes. The following operations support this filter: `GetCostAndUsage` , `GetCostAndUsageWithResources` , `GetDimensionValues` (in the `COST_AND_USAGE` context), `GetTags` , and `GetCostCategories` . For the supported services and keys, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > > Key -> (string) [required] > > > > > > > The name of the product attribute, such as `model` . The keys that are available depend on the service. For the keys of each supported service, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > > > Keys are case-sensitive. A key that doesn’t exist doesn’t return an error: `EQUALS` matches no costs, and `ABSENT` matches all costs of supported services. > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `1024` > > > > > > > * pattern: `^([a-zA-Z][a-zA-Z0-9]*)?$` > > > > > > Values -> (list) > > > > > > > The specific values of the product attribute, such as `Claude Sonnet 5` for the `model` key. Values are matched exactly, including case. To list the values of a key, use `GetDimensionValues` with `Dimension` set to `PRODUCT_ATTRIBUTE` and `DimensionKey` set to the key. > > > > > > > To match costs that have no value for the key, set `MatchOptions` to `ABSENT` and omit `Values` . Otherwise, `Values` is required. > > > > > > > Constraints: > > > > > > > * min: `1` > > > > > > > * max: `6000` > > > > > > > (string) > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `1024` > > > > > > > > * pattern: `[\S\s]*` > > > > > > MatchOptions -> (list) > > > > > > > The match options that you can use to filter your results. Valid values: > > > > > > > * `EQUALS` - Matches the values that you specify. > > > > > > > * `ABSENT` - Matches costs that have no value for the key. Omit `Values` . > > > > > > > * `CASE_SENSITIVE` - Use only with `EQUALS` . Values are always matched case-sensitively. > > > > > > > Default values are `EQUALS` and `CASE_SENSITIVE` . > > > > > > > (string) > > > > > > > > Possible values: > > > > > > > > * `EQUALS` > > > > > > > > * `ABSENT` > > > > > > > > * `STARTS_WITH` > > > > > > > > * `ENDS_WITH` > > > > > > > > * `CONTAINS` > > > > > > > > * `CASE_SENSITIVE` > > > > > > > > * `CASE_INSENSITIVE` > > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > Not -> (structure) > > > > Return results that don’t match a `Dimension` object. > > > > Or -> (list) > > > > > Return results that match either `Dimension` object. > > > > > ( … recursive … ) > > > > And -> (list) > > > > > Return results that match both `Dimension` objects. > > > > > ( … recursive … ) > > > > ( … recursive … )Dimensions -> (structure) > > > > > The specific `Dimension` to use for `Expression` . > > > > > Key -> (string) > > > > > > The names of the metadata types that you can use to filter and group your results. For example, `AZ` returns a list of Availability Zones. > > > > > > Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported. > > > > > > > `LINKED_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in [CostCategoryRule](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html) . > > > > > > > `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE` can only be used in [AnomalySubscriptions](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) . > > > > > > Use `PRODUCT_ATTRIBUTE` only as the `Dimension` in `GetDimensionValues` . To filter or group by product attributes, use the `ProductAttributes` field of `Expression` or the `PRODUCT_ATTRIBUTE` group type. > > > > > > Possible values: > > > > > > * `AZ` > > > > > > * `INSTANCE_TYPE` > > > > > > * `LINKED_ACCOUNT` > > > > > > * `PAYER_ACCOUNT` > > > > > > * `LINKED_ACCOUNT_NAME` > > > > > > * `OPERATION` > > > > > > * `PURCHASE_TYPE` > > > > > > * `REGION` > > > > > > * `SERVICE` > > > > > > * `SERVICE_CODE` > > > > > > * `USAGE_TYPE` > > > > > > * `USAGE_TYPE_GROUP` > > > > > > * `RECORD_TYPE` > > > > > > * `OPERATING_SYSTEM` > > > > > > * `TENANCY` > > > > > > * `SCOPE` > > > > > > * `PLATFORM` > > > > > > * `SUBSCRIPTION_ID` > > > > > > * `LEGAL_ENTITY_NAME` > > > > > > * `DEPLOYMENT_OPTION` > > > > > > * `DATABASE_ENGINE` > > > > > > * `CACHE_ENGINE` > > > > > > * `INSTANCE_TYPE_FAMILY` > > > > > > * `BILLING_ENTITY` > > > > > > * `RESERVATION_ID` > > > > > > * `RESOURCE_ID` > > > > > > * `RIGHTSIZING_TYPE` > > > > > > * `SAVINGS_PLANS_TYPE` > > > > > > * `SAVINGS_PLAN_ARN` > > > > > > * `PAYMENT_OPTION` > > > > > > * `AGREEMENT_END_DATE_TIME_AFTER` > > > > > > * `AGREEMENT_END_DATE_TIME_BEFORE` > > > > > > * `INVOICING_ENTITY` > > > > > > * `ANOMALY_TOTAL_IMPACT_ABSOLUTE` > > > > > > * `ANOMALY_TOTAL_IMPACT_PERCENTAGE` > > > > > > * `PRODUCT_ATTRIBUTE` > > > > > Values -> (list) > > > > > > The metadata values that you can use to filter and group your results. You can use `GetDimensionValues` to find specific values. > > > > > > (string) > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `1024` > > > > > > > * pattern: `[\S\s]*` > > > > > MatchOptions -> (list) > > > > > > The match options that you can use to filter your results. > > > > > > > `MatchOptions` is only applicable for actions related to cost category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported. > > > > > > The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE` . > > > > > > (string) > > > > > > > Possible values: > > > > > > > * `EQUALS` > > > > > > > * `ABSENT` > > > > > > > * `STARTS_WITH` > > > > > > > * `ENDS_WITH` > > > > > > > * `CONTAINS` > > > > > > > * `CASE_SENSITIVE` > > > > > > > * `CASE_INSENSITIVE` > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > Tags -> (structure) > > > > > The specific `Tag` to use for `Expression` . > > > > > Key -> (string) > > > > > > The key for the tag. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1024` > > > > > > * pattern: `[\S\s]*` > > > > > Values -> (list) > > > > > > The specific value of the tag. > > > > > > (string) > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `1024` > > > > > > > * pattern: `[\S\s]*` > > > > > MatchOptions -> (list) > > > > > > The match options that you can use to filter your results. `MatchOptions` is only applicable for actions related to cost category. The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE` . > > > > > > (string) > > > > > > > Possible values: > > > > > > > * `EQUALS` > > > > > > > * `ABSENT` > > > > > > > * `STARTS_WITH` > > > > > > > * `ENDS_WITH` > > > > > > > * `CONTAINS` > > > > > > > * `CASE_SENSITIVE` > > > > > > > * `CASE_INSENSITIVE` > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > CostCategories -> (structure) > > > > > The filter that’s based on `CostCategory` values. > > > > > Key -> (string) > > > > > > The unique name of the cost category. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `50` > > > > > > * pattern: `^(?! )[\p{L}\p{N}\p{Z}-_]*(? > > > > Values -> (list) > > > > > > The specific value of the cost category. > > > > > > (string) > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `1024` > > > > > > > * pattern: `[\S\s]*` > > > > > MatchOptions -> (list) > > > > > > The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for `MatchOptions` is `EQUALS` and `CASE_SENSITIVE` . > > > > > > (string) > > > > > > > Possible values: > > > > > > > * `EQUALS` > > > > > > > * `ABSENT` > > > > > > > * `STARTS_WITH` > > > > > > > * `ENDS_WITH` > > > > > > > * `CONTAINS` > > > > > > > * `CASE_SENSITIVE` > > > > > > > * `CASE_INSENSITIVE` > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > > ProductAttributes -> (structure) > > > > > The filter that’s based on `ProductAttributeValues` . Use it to filter the costs of supported services, such as Amazon Bedrock, by product attributes. The following operations support this filter: `GetCostAndUsage` , `GetCostAndUsageWithResources` , `GetDimensionValues` (in the `COST_AND_USAGE` context), `GetTags` , and `GetCostCategories` . For the supported services and keys, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > Key -> (string) [required] > > > > > > The name of the product attribute, such as `model` . The keys that are available depend on the service. For the keys of each supported service, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > > Keys are case-sensitive. A key that doesn’t exist doesn’t return an error: `EQUALS` matches no costs, and `ABSENT` matches all costs of supported services. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1024` > > > > > > * pattern: `^([a-zA-Z][a-zA-Z0-9]*)?$` > > > > > Values -> (list) > > > > > > The specific values of the product attribute, such as `Claude Sonnet 5` for the `model` key. Values are matched exactly, including case. To list the values of a key, use `GetDimensionValues` with `Dimension` set to `PRODUCT_ATTRIBUTE` and `DimensionKey` set to the key. > > > > > > To match costs that have no value for the key, set `MatchOptions` to `ABSENT` and omit `Values` . Otherwise, `Values` is required. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `6000` > > > > > > (string) > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `1024` > > > > > > > * pattern: `[\S\s]*` > > > > > MatchOptions -> (list) > > > > > > The match options that you can use to filter your results. Valid values: > > > > > > * `EQUALS` - Matches the values that you specify. > > > > > > * `ABSENT` - Matches costs that have no value for the key. Omit `Values` . > > > > > > * `CASE_SENSITIVE` - Use only with `EQUALS` . Values are always matched case-sensitively. > > > > > > Default values are `EQUALS` and `CASE_SENSITIVE` . > > > > > > (string) > > > > > > > Possible values: > > > > > > > * `EQUALS` > > > > > > > * `ABSENT` > > > > > > > * `STARTS_WITH` > > > > > > > * `ENDS_WITH` > > > > > > > * `CONTAINS` > > > > > > > * `CASE_SENSITIVE` > > > > > > > * `CASE_INSENSITIVE` > > > > > > > * `GREATER_THAN_OR_EQUAL` > > > Dimensions -> (structure) > > > > The specific `Dimension` to use for `Expression` . > > > > Key -> (string) > > > > > The names of the metadata types that you can use to filter and group your results. For example, `AZ` returns a list of Availability Zones. > > > > > Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported. > > > > > > `LINKED_ACCOUNT_NAME` and `SERVICE_CODE` can only be used in [CostCategoryRule](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html) . > > > > > > `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE` can only be used in [AnomalySubscriptions](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html) . > > > > > Use `PRODUCT_ATTRIBUTE` only as the `Dimension` in `GetDimensionValues` . To filter or group by product attributes, use the `ProductAttributes` field of `Expression` or the `PRODUCT_ATTRIBUTE` group type. > > > > > Possible values: > > > > > * `AZ` > > > > > * `INSTANCE_TYPE` > > > > > * `LINKED_ACCOUNT` > > > > > * `PAYER_ACCOUNT` > > > > > * `LINKED_ACCOUNT_NAME` > > > > > * `OPERATION` > > > > > * `PURCHASE_TYPE` > > > > > * `REGION` > > > > > * `SERVICE` > > > > > * `SERVICE_CODE` > > > > > * `USAGE_TYPE` > > > > > * `USAGE_TYPE_GROUP` > > > > > * `RECORD_TYPE` > > > > > * `OPERATING_SYSTEM` > > > > > * `TENANCY` > > > > > * `SCOPE` > > > > > * `PLATFORM` > > > > > * `SUBSCRIPTION_ID` > > > > > * `LEGAL_ENTITY_NAME` > > > > > * `DEPLOYMENT_OPTION` > > > > > * `DATABASE_ENGINE` > > > > > * `CACHE_ENGINE` > > > > > * `INSTANCE_TYPE_FAMILY` > > > > > * `BILLING_ENTITY` > > > > > * `RESERVATION_ID` > > > > > * `RESOURCE_ID` > > > > > * `RIGHTSIZING_TYPE` > > > > > * `SAVINGS_PLANS_TYPE` > > > > > * `SAVINGS_PLAN_ARN` > > > > > * `PAYMENT_OPTION` > > > > > * `AGREEMENT_END_DATE_TIME_AFTER` > > > > > * `AGREEMENT_END_DATE_TIME_BEFORE` > > > > > * `INVOICING_ENTITY` > > > > > * `ANOMALY_TOTAL_IMPACT_ABSOLUTE` > > > > > * `ANOMALY_TOTAL_IMPACT_PERCENTAGE` > > > > > * `PRODUCT_ATTRIBUTE` > > > > Values -> (list) > > > > > The metadata values that you can use to filter and group your results. You can use `GetDimensionValues` to find specific values. > > > > > (string) > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1024` > > > > > > * pattern: `[\S\s]*` > > > > MatchOptions -> (list) > > > > > The match options that you can use to filter your results. > > > > > > `MatchOptions` is only applicable for actions related to cost category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported. > > > > > The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE` . > > > > > (string) > > > > > > Possible values: > > > > > > * `EQUALS` > > > > > > * `ABSENT` > > > > > > * `STARTS_WITH` > > > > > > * `ENDS_WITH` > > > > > > * `CONTAINS` > > > > > > * `CASE_SENSITIVE` > > > > > > * `CASE_INSENSITIVE` > > > > > > * `GREATER_THAN_OR_EQUAL` > > > Tags -> (structure) > > > > The specific `Tag` to use for `Expression` . > > > > Key -> (string) > > > > > The key for the tag. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `1024` > > > > > * pattern: `[\S\s]*` > > > > Values -> (list) > > > > > The specific value of the tag. > > > > > (string) > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1024` > > > > > > * pattern: `[\S\s]*` > > > > MatchOptions -> (list) > > > > > The match options that you can use to filter your results. `MatchOptions` is only applicable for actions related to cost category. The default values for `MatchOptions` are `EQUALS` and `CASE_SENSITIVE` . > > > > > (string) > > > > > > Possible values: > > > > > > * `EQUALS` > > > > > > * `ABSENT` > > > > > > * `STARTS_WITH` > > > > > > * `ENDS_WITH` > > > > > > * `CONTAINS` > > > > > > * `CASE_SENSITIVE` > > > > > > * `CASE_INSENSITIVE` > > > > > > * `GREATER_THAN_OR_EQUAL` > > > CostCategories -> (structure) > > > > The filter that’s based on `CostCategory` values. > > > > Key -> (string) > > > > > The unique name of the cost category. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `50` > > > > > * pattern: `^(?! )[\p{L}\p{N}\p{Z}-_]*(? > > > Values -> (list) > > > > > The specific value of the cost category. > > > > > (string) > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1024` > > > > > > * pattern: `[\S\s]*` > > > > MatchOptions -> (list) > > > > > The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for `MatchOptions` is `EQUALS` and `CASE_SENSITIVE` . > > > > > (string) > > > > > > Possible values: > > > > > > * `EQUALS` > > > > > > * `ABSENT` > > > > > > * `STARTS_WITH` > > > > > > * `ENDS_WITH` > > > > > > * `CONTAINS` > > > > > > * `CASE_SENSITIVE` > > > > > > * `CASE_INSENSITIVE` > > > > > > * `GREATER_THAN_OR_EQUAL` > > > ProductAttributes -> (structure) > > > > The filter that’s based on `ProductAttributeValues` . Use it to filter the costs of supported services, such as Amazon Bedrock, by product attributes. The following operations support this filter: `GetCostAndUsage` , `GetCostAndUsageWithResources` , `GetDimensionValues` (in the `COST_AND_USAGE` context), `GetTags` , and `GetCostCategories` . For the supported services and keys, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > Key -> (string) [required] > > > > > The name of the product attribute, such as `model` . The keys that are available depend on the service. For the keys of each supported service, see \` `ProductAttributeValues` [https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ProductAttributeValues).html\`_\_ . > > > > > Keys are case-sensitive. A key that doesn’t exist doesn’t return an error: `EQUALS` matches no costs, and `ABSENT` matches all costs of supported services. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `1024` > > > > > * pattern: `^([a-zA-Z][a-zA-Z0-9]*)?$` > > > > Values -> (list) > > > > > The specific values of the product attribute, such as `Claude Sonnet 5` for the `model` key. Values are matched exactly, including case. To list the values of a key, use `GetDimensionValues` with `Dimension` set to `PRODUCT_ATTRIBUTE` and `DimensionKey` set to the key. > > > > > To match costs that have no value for the key, set `MatchOptions` to `ABSENT` and omit `Values` . Otherwise, `Values` is required. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `6000` > > > > > (string) > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1024` > > > > > > * pattern: `[\S\s]*` > > > > MatchOptions -> (list) > > > > > The match options that you can use to filter your results. Valid values: > > > > > * `EQUALS` - Matches the values that you specify. > > > > > * `ABSENT` - Matches costs that have no value for the key. Omit `Values` . > > > > > * `CASE_SENSITIVE` - Use only with `EQUALS` . Values are always matched case-sensitively. > > > > > Default values are `EQUALS` and `CASE_SENSITIVE` . > > > > > (string) > > > > > > Possible values: > > > > > > * `EQUALS` > > > > > > * `ABSENT` > > > > > > * `STARTS_WITH` > > > > > > * `ENDS_WITH` > > > > > > * `CONTAINS` > > > > > > * `CASE_SENSITIVE` > > > > > > * `CASE_INSENSITIVE` > > > > > > * `GREATER_THAN_OR_EQUAL` NextPageToken -> (string) > 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. > Constraints: > * min: `0` > * max: `8192` > * pattern: `[\S\s]*`