CostExplorer / Client / get_cost_comparison_drivers

get_cost_comparison_drivers

CostExplorer.Client.get_cost_comparison_drivers(**kwargs)

Retrieves key factors driving cost changes between two time periods within the last 13 months, such as usage changes, discount changes, and commitment-based savings. If you have enabled multi-year data at monthly granularity, you can go back up to 38 months.

See also: AWS API Documentation

Request Syntax

response = client.get_cost_comparison_drivers(
    BillingViewArn='string',
    BaselineTimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    ComparisonTimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    MetricForComparison='string',
    Filter={
        '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',
            ]
        }
    },
    GroupBy=[
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': 'string'
        },
    ],
    MaxResults=123,
    NextPageToken='string'
)
Parameters:

  • BillingViewArn (string) – The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.

  • BaselineTimePeriod (dict) –

    [REQUIRED]

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

    • Start (string) – [REQUIRED]

      The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

    • End (string) – [REQUIRED]

      The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

  • ComparisonTimePeriod (dict) –

    [REQUIRED]

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

    • Start (string) – [REQUIRED]

      The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

    • End (string) – [REQUIRED]

      The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

  • MetricForComparison (string) –

    [REQUIRED]

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

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

  • GroupBy (list) –

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

    • (dict) –

      Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.

      • Type (string) –

        The string that represents the type of group.

      • Key (string) –

        The string that represents a key for a specified group.

  • MaxResults (integer) – The maximum number of results that are returned for the request.

  • NextPageToken (string) – The token to retrieve the next set of paginated results.

Return type:

dict

Returns:

Response Syntax

{
    'CostComparisonDrivers': [
        {
            'CostSelector': {
                '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',
                    ]
                }
            },
            'Metrics': {
                'string': {
                    'BaselineTimePeriodAmount': 'string',
                    'ComparisonTimePeriodAmount': 'string',
                    'Difference': 'string',
                    'Unit': 'string'
                }
            },
            'CostDrivers': [
                {
                    'Type': 'string',
                    'Name': 'string',
                    'Metrics': {
                        'string': {
                            'BaselineTimePeriodAmount': 'string',
                            'ComparisonTimePeriodAmount': 'string',
                            'Difference': 'string',
                            'Unit': 'string'
                        }
                    }
                },
            ]
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

  • (dict) –

    • CostComparisonDrivers (list) –

      An array of comparison results showing factors that drive significant cost differences between BaselineTimePeriod and ComparisonTimePeriod.

      • (dict) –

        Represents a collection of cost drivers and their associated metrics for cost comparison analysis.

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

        • Metrics (dict) –

          A mapping of metric names to their comparison values.

          • (string) –

            • (dict) –

              Contains cost or usage metric values for comparing two time periods. Each value includes amounts for the baseline and comparison time periods, their difference, and the unit of measurement.

              • BaselineTimePeriodAmount (string) –

                The numeric value for the baseline time period measurement.

              • ComparisonTimePeriodAmount (string) –

                The numeric value for the comparison time period measurement.

              • Difference (string) –

                The calculated difference between ComparisonTimePeriodAmount and BaselineTimePeriodAmount.

              • Unit (string) –

                The unit of measurement applicable to all numeric values in this comparison.

        • CostDrivers (list) –

          An array of cost drivers, each representing a cost difference between the baseline and comparison time periods. Each entry also includes a metric delta (for example, usage change) that contributed to the cost variance, along with the identifier and type of change.

          • (dict) –

            Represents factors that contribute to cost variations between the baseline and comparison time periods, including the type of driver, an identifier of the driver, and associated metrics.

            • Type (string) –

              The category or classification of the cost driver.

              Values include: BUNDLED_DISCOUNT, CREDIT, OUT_OF_CYCLE_CHARGE, REFUND, RECURRING_RESERVATION_FEE, RESERVATION_USAGE, RI_VOLUME_DISCOUNT, SAVINGS_PLAN_USAGE, SAVINGS_PLAN_NEGATION, SAVINGS_PLAN_RECURRING_FEE, SUPPORT_FEE, TAX, UPFRONT_RESERVATION_FEE, USAGE_CHANGE, COMMITMENT

            • Name (string) –

              The specific identifier of the cost driver.

            • Metrics (dict) –

              A mapping of metric names to their comparison values, measuring the impact of this cost driver.

              • (string) –

                • (dict) –

                  Contains cost or usage metric values for comparing two time periods. Each value includes amounts for the baseline and comparison time periods, their difference, and the unit of measurement.

                  • BaselineTimePeriodAmount (string) –

                    The numeric value for the baseline time period measurement.

                  • ComparisonTimePeriodAmount (string) –

                    The numeric value for the comparison time period measurement.

                  • Difference (string) –

                    The calculated difference between ComparisonTimePeriodAmount and BaselineTimePeriodAmount.

                  • Unit (string) –

                    The unit of measurement applicable to all numeric values in this comparison.

    • NextPageToken (string) –

      The token to retrieve the next set of paginated results.

Exceptions