CostExplorer / Client / get_anomaly_subscriptions

get_anomaly_subscriptions

CostExplorer.Client.get_anomaly_subscriptions(**kwargs)

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

Request Syntax

response = client.get_anomaly_subscriptions(
    SubscriptionArnList=[
        'string',
    ],
    MonitorArn='string',
    NextPageToken='string',
    MaxResults=123
)

Parameters:

• SubscriptionArnList (list) –

  A list of cost anomaly subscription ARNs.

  • (string) –

• MonitorArn (string) – Cost anomaly monitor ARNs.

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

• MaxResults (integer) – The number of entries a paginated response contains.

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'|'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',
                    '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',
                    ]
                }
            }
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

• (dict) –

  • AnomalySubscriptions (list) –

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

    • (dict) –

      The association between a monitor, threshold, and list of subscribers used to deliver notifications about anomalies detected by a monitor that exceeds a threshold. The content consists of the detailed metadata and the current status of the AnomalySubscription object.

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

        The dollar value that triggers a notification if the threshold is exceeded.

        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.

      • Frequency (string) –

        The frequency that anomaly reports are sent over email.

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

        One of Threshold or ThresholdExpression is required for this resource.

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

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

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

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

Exceptions

• CostExplorer.Client.exceptions.LimitExceededException

• CostExplorer.Client.exceptions.UnknownSubscriptionException

• CostExplorer.Client.exceptions.InvalidNextTokenException