CostExplorer / Client / create_anomaly_monitor

create_anomaly_monitor

CostExplorer.Client.create_anomaly_monitor(**kwargs)

Creates a new cost anomaly detection monitor with the requested type and monitor specification.

See also: AWS API Documentation

Request Syntax

response = client.create_anomaly_monitor(
    AnomalyMonitor={
        'MonitorArn': 'string',
        'MonitorName': 'string',
        'CreationDate': 'string',
        'LastUpdatedDate': 'string',
        'LastEvaluatedDate': 'string',
        'MonitorType': 'DIMENSIONAL'|'CUSTOM',
        'MonitorDimension': 'SERVICE',
        'MonitorSpecification': {
            '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',
                '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',
                ]
            }
        },
        'DimensionalValueCount': 123
    },
    ResourceTags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • AnomalyMonitor (dict) –

    [REQUIRED]

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

    • MonitorArn (string) –

      The Amazon Resource Name (ARN) value.

    • MonitorName (string) – [REQUIRED]

      The name of the monitor.

    • CreationDate (string) –

      The date when the monitor was created.

    • LastUpdatedDate (string) –

      The date when the monitor was last updated.

    • LastEvaluatedDate (string) –

      The date when the monitor last evaluated for anomalies.

    • MonitorType (string) – [REQUIRED]

      The possible type values.

    • MonitorDimension (string) –

      The dimensions to evaluate.

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

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

          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.

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

    • DimensionalValueCount (integer) –

      The value for evaluated dimensions.

  • ResourceTags (list) –

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

    Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

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

    • The maximum length of a key is 128 characters

    • The maximum length of a value is 256 characters

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

    • Keys and values are case sensitive

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

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

    • (dict) –

      The tag structure that contains a tag key and value.

      Note

      Tagging is supported only for the following Cost Explorer resource types: AnomalyMonitor, AnomalySubscription, CostCategory.

      • Key (string) – [REQUIRED]

        The key that’s associated with the tag.

      • Value (string) – [REQUIRED]

        The value that’s associated with the tag.

Return type:

dict

Returns:

Response Syntax

{
    'MonitorArn': 'string'
}

Response Structure

  • (dict) –

    • MonitorArn (string) –

      The unique identifier of your newly created cost anomaly detection monitor.

Exceptions

  • CostExplorer.Client.exceptions.LimitExceededException