CostExplorer / Paginator / GetAnomalySubscriptions

GetAnomalySubscriptions

class CostExplorer.Paginator.GetAnomalySubscriptions
paginator = client.get_paginator('get_anomaly_subscriptions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CostExplorer.Client.get_anomaly_subscriptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SubscriptionArnList=[
        'string',
    ],
    MonitorArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • SubscriptionArnList (list) –

    A list of cost anomaly subscription ARNs.

    • (string) –

  • MonitorArn (string) – Cost anomaly monitor ARNs.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AnomalySubscriptions': [
        {
            'SubscriptionArn': 'string',
            'AccountId': 'string',
            'MonitorArnList': [
                'string',
            ],
            'Subscribers': [
                {
                    'Address': 'string',
                    'Type': 'EMAIL'|'SNS',
                    'Status': 'CONFIRMED'|'DECLINED'
                },
            ],
            'Threshold': 123.0,
            'Frequency': 'DAILY'|'IMMEDIATE'|'WEEKLY',
            'SubscriptionName': 'string',
            'ThresholdExpression': {
                'Or': [
                    {'... recursive ...'},
                ],
                'And': [
                    {'... recursive ...'},
                ],
                'Not': {'... recursive ...'},
                'Dimensions': {
                    'Key': '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': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
                    ]
                },
                'Tags': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
                    ]
                },
                'CostCategories': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
                    ]
                },
                'ProductAttributes': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
                    ]
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AnomalySubscriptions (list) –

      A list of cost anomaly subscriptions that includes the detailed metadata for each one.

      • (dict) –

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

        • SubscriptionArn (string) –

          The AnomalySubscription Amazon Resource Name (ARN).

        • AccountId (string) –

          Your unique account identifier.

        • MonitorArnList (list) –

          A list of cost anomaly monitors.

          • (string) –

        • Subscribers (list) –

          A list of subscribers to notify.

          • (dict) –

            The recipient of AnomalySubscription notifications.

            • Address (string) –

              The email address or SNS Amazon Resource Name (ARN). This depends on the Type.

            • Type (string) –

              The notification delivery channel.

            • Status (string) –

              Indicates if the subscriber accepts the notifications.

        • Threshold (float) –

          (deprecated)

          An absolute dollar value that must be exceeded by the anomaly’s total impact (see Impact 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.

        • Frequency (string) –

          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.

        • SubscriptionName (string) –

          The name for the subscription.

        • ThresholdExpression (dict) –

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

          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.

            • (dict) –

              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.

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

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

          • And (list) –

            Return results that match both Dimension objects.

            • (dict) –

              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.

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

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

          • Not (dict) –

            Return results that don’t match a Dimension object.

          • Dimensions (dict) –

            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.

              ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

              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.

            • Values (list) –

              The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

              • (string) –

            • 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) –

          • Tags (dict) –

            The specific Tag to use for Expression.

            • Key (string) –

              The key for the tag.

            • Values (list) –

              The specific value of the tag.

              • (string) –

            • 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) –

          • CostCategories (dict) –

            The filter that’s based on CostCategory values.

            • Key (string) –

              The unique name of the cost category.

            • Values (list) –

              The specific value of the cost category.

              • (string) –

            • 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) –

          • ProductAttributes (dict) –

            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.

            • Key (string) –

              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.

              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.

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

              • (string) –

            • 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) –

    • NextToken (string) –

      A token to resume pagination.