CostExplorer

Client

class CostExplorer.Client

A low-level client representing AWS Cost Explorer Service

You can use the Cost Explorer API to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data. This might include the number of daily write operations for Amazon DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:

  • https://ce.us-east-1.amazonaws.com

For information about the costs that are associated with the Cost Explorer API, see Amazon Web Services Cost Management Pricing .

client = session.create_client('ce')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
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'|'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',
                'Values': [
                    'string',
                ],
                'MatchOptions': [
                    'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                ]
            },
            'Tags': {
                'Key': 'string',
                'Values': [
                    'string',
                ],
                'MatchOptions': [
                    'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                ]
            },
            'CostCategories': {
                'Key': 'string',
                'Values': [
                    'string',
                ],
                'MatchOptions': [
                    'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                ]
            }
        },
        'DimensionalValueCount': 123
    }
)
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 by cost or by usage. There are two patterns:

    • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
    • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

    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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

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

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

create_anomaly_subscription(**kwargs)

Adds a subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set a dollar threshold and a time frequency for receiving notifications.

See also: AWS API Documentation

Request Syntax

response = client.create_anomaly_subscription(
    AnomalySubscription={
        'SubscriptionArn': 'string',
        'AccountId': 'string',
        'MonitorArnList': [
            'string',
        ],
        'Subscribers': [
            {
                'Address': 'string',
                'Type': 'EMAIL'|'SNS',
                'Status': 'CONFIRMED'|'DECLINED'
            },
        ],
        'Threshold': 123.0,
        'Frequency': 'DAILY'|'IMMEDIATE'|'WEEKLY',
        'SubscriptionName': 'string'
    }
)
Parameters
AnomalySubscription (dict) --

[REQUIRED]

The cost anomaly subscription object that you want to create.

  • SubscriptionArn (string) --

    The AnomalySubscription Amazon Resource Name (ARN).

  • AccountId (string) --

    Your unique account identifier.

  • MonitorArnList (list) -- [REQUIRED]

    A list of cost anomaly monitors.

    • (string) --
  • Subscribers (list) -- [REQUIRED]

    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) -- [REQUIRED]

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

  • Frequency (string) -- [REQUIRED]

    The frequency that anomaly reports are sent over email.

  • SubscriptionName (string) -- [REQUIRED]

    The name for the subscription.

Return type
dict
Returns
Response Syntax
{
    'SubscriptionArn': 'string'
}

Response Structure

  • (dict) --
    • SubscriptionArn (string) --

      The unique identifier of your newly created cost anomaly subscription.

Exceptions

create_cost_category_definition(**kwargs)

Creates a new Cost Category with the requested name and rules.

See also: AWS API Documentation

Request Syntax

response = client.create_cost_category_definition(
    Name='string',
    RuleVersion='CostCategoryExpression.v1',
    Rules=[
        {
            'Value': 'string',
            'Rule': {
                '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',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                },
                'Tags': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                },
                'CostCategories': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                }
            },
            'InheritedValue': {
                'DimensionName': 'LINKED_ACCOUNT_NAME'|'TAG',
                'DimensionKey': 'string'
            },
            'Type': 'REGULAR'|'INHERITED_VALUE'
        },
    ],
    DefaultValue='string',
    SplitChargeRules=[
        {
            'Source': 'string',
            'Targets': [
                'string',
            ],
            'Method': 'FIXED'|'PROPORTIONAL'|'EVEN',
            'Parameters': [
                {
                    'Type': 'ALLOCATION_PERCENTAGES',
                    'Values': [
                        'string',
                    ]
                },
            ]
        },
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    The unique name of the Cost Category.

  • RuleVersion (string) --

    [REQUIRED]

    The rule schema version in this particular Cost Category.

  • Rules (list) --

    [REQUIRED]

    The Cost Category rules used to categorize costs. For more information, see CostCategoryRule .

    • (dict) --

      Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.

      • Value (string) --

        The default value for the cost category.

      • Rule (dict) --

        An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT , SERVICE_CODE , RECORD_TYPE , and LINKED_ACCOUNT_NAME .

        Root level OR isn't supported. We recommend that you create a separate rule instead.

        RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide .
        • Or (list) --

          Return results that match either Dimension object.

          • (dict) --

            Use Expression to filter by cost or by usage. There are two patterns:

            • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
            • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

            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 by cost or by usage. There are two patterns:

            • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
            • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

            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.

          • 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. 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) --
      • InheritedValue (dict) --

        The value the line item is categorized as if the line item contains the matched dimension.

        • DimensionName (string) --

          The name of the dimension that's used to group costs.

          If you specify LINKED_ACCOUNT_NAME , the cost category value is based on account name. If you specify TAG , the cost category value will be based on the value of the specified tag key.

        • DimensionKey (string) --

          The key to extract cost category values.

      • Type (string) --

        You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE . The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension . For example, if you want to dynamically group costs based on the value of a specific tag key, first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

  • DefaultValue (string) -- The default value for the cost category.
  • SplitChargeRules (list) --

    The split charge rules used to allocate your charges between your Cost Category values.

    • (dict) --

      Use the split charge rule to split the cost of one Cost Category value across several other target values.

      • Source (string) -- [REQUIRED]

        The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.

      • Targets (list) -- [REQUIRED]

        The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.

        • (string) --
      • Method (string) -- [REQUIRED]

        The method that's used to define how to split your source costs across your targets.

        Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

        Fixed - Allocates charges across your targets based on your defined allocation percentage.

        >``Even`` - Allocates costs evenly across all targets.

      • Parameters (list) --

        The parameters for a split charge method. This is only required for the FIXED method.

        • (dict) --

          The parameters for a split charge method.

          • Type (string) -- [REQUIRED]

            The parameter type.

          • Values (list) -- [REQUIRED]

            The parameter values.

            • (string) --
Return type

dict

Returns

Response Syntax

{
    'CostCategoryArn': 'string',
    'EffectiveStart': 'string'
}

Response Structure

  • (dict) --

    • CostCategoryArn (string) --

      The unique identifier for your newly created Cost Category.

    • EffectiveStart (string) --

      The Cost Category's effective start date.

Exceptions

delete_anomaly_monitor(**kwargs)

Deletes a cost anomaly monitor.

See also: AWS API Documentation

Request Syntax

response = client.delete_anomaly_monitor(
    MonitorArn='string'
)
Parameters
MonitorArn (string) --

[REQUIRED]

The unique identifier of the cost anomaly monitor that you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_anomaly_subscription(**kwargs)

Deletes a cost anomaly subscription.

See also: AWS API Documentation

Request Syntax

response = client.delete_anomaly_subscription(
    SubscriptionArn='string'
)
Parameters
SubscriptionArn (string) --

[REQUIRED]

The unique identifier of the cost anomaly subscription that you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_cost_category_definition(**kwargs)

Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.

See also: AWS API Documentation

Request Syntax

response = client.delete_cost_category_definition(
    CostCategoryArn='string'
)
Parameters
CostCategoryArn (string) --

[REQUIRED]

The unique identifier for your Cost Category.

Return type
dict
Returns
Response Syntax
{
    'CostCategoryArn': 'string',
    'EffectiveEnd': 'string'
}

Response Structure

  • (dict) --
    • CostCategoryArn (string) --

      The unique identifier for your Cost Category.

    • EffectiveEnd (string) --

      The effective end date of the Cost Category as a result of deleting it. No costs after this date will be categorized by the deleted Cost Category.

Exceptions

describe_cost_category_definition(**kwargs)

Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.

You have the option to use EffectiveOn to return a Cost Category that is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.

See also: AWS API Documentation

Request Syntax

response = client.describe_cost_category_definition(
    CostCategoryArn='string',
    EffectiveOn='string'
)
Parameters
  • CostCategoryArn (string) --

    [REQUIRED]

    The unique identifier for your Cost Category.

  • EffectiveOn (string) -- The date when the Cost Category was effective.
Return type

dict

Returns

Response Syntax

{
    'CostCategory': {
        'CostCategoryArn': 'string',
        'EffectiveStart': 'string',
        'EffectiveEnd': 'string',
        'Name': 'string',
        'RuleVersion': 'CostCategoryExpression.v1',
        'Rules': [
            {
                'Value': 'string',
                'Rule': {
                    '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',
                        'Values': [
                            'string',
                        ],
                        'MatchOptions': [
                            'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                        ]
                    },
                    'Tags': {
                        'Key': 'string',
                        'Values': [
                            'string',
                        ],
                        'MatchOptions': [
                            'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                        ]
                    },
                    'CostCategories': {
                        'Key': 'string',
                        'Values': [
                            'string',
                        ],
                        'MatchOptions': [
                            'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                        ]
                    }
                },
                'InheritedValue': {
                    'DimensionName': 'LINKED_ACCOUNT_NAME'|'TAG',
                    'DimensionKey': 'string'
                },
                'Type': 'REGULAR'|'INHERITED_VALUE'
            },
        ],
        'SplitChargeRules': [
            {
                'Source': 'string',
                'Targets': [
                    'string',
                ],
                'Method': 'FIXED'|'PROPORTIONAL'|'EVEN',
                'Parameters': [
                    {
                        'Type': 'ALLOCATION_PERCENTAGES',
                        'Values': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        'ProcessingStatus': [
            {
                'Component': 'COST_EXPLORER',
                'Status': 'PROCESSING'|'APPLIED'
            },
        ],
        'DefaultValue': 'string'
    }
}

Response Structure

  • (dict) --

    • CostCategory (dict) --

      The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.

      • CostCategoryArn (string) --

        The unique identifier for your Cost Category.

      • EffectiveStart (string) --

        The effective state data of your Cost Category.

      • EffectiveEnd (string) --

        The effective end data of your Cost Category.

      • Name (string) --

        The unique name of the Cost Category.

      • RuleVersion (string) --

        The rule schema version in this particular Cost Category.

      • Rules (list) --

        The rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.

        • (dict) --

          Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.

          • Value (string) --

            The default value for the cost category.

          • Rule (dict) --

            An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT , SERVICE_CODE , RECORD_TYPE , and LINKED_ACCOUNT_NAME .

            Root level OR isn't supported. We recommend that you create a separate rule instead.

            RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide .

            • Or (list) --

              Return results that match either Dimension object.

              • (dict) --

                Use Expression to filter by cost or by usage. There are two patterns:

                • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
                • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

                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 by cost or by usage. There are two patterns:

                • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
                • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

                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.

              • 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. 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) --
          • InheritedValue (dict) --

            The value the line item is categorized as if the line item contains the matched dimension.

            • DimensionName (string) --

              The name of the dimension that's used to group costs.

              If you specify LINKED_ACCOUNT_NAME , the cost category value is based on account name. If you specify TAG , the cost category value will be based on the value of the specified tag key.

            • DimensionKey (string) --

              The key to extract cost category values.

          • Type (string) --

            You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE . The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension . For example, if you want to dynamically group costs based on the value of a specific tag key, first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

      • SplitChargeRules (list) --

        The split charge rules that are used to allocate your charges between your Cost Category values.

        • (dict) --

          Use the split charge rule to split the cost of one Cost Category value across several other target values.

          • Source (string) --

            The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.

          • Targets (list) --

            The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.

            • (string) --
          • Method (string) --

            The method that's used to define how to split your source costs across your targets.

            Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

            Fixed - Allocates charges across your targets based on your defined allocation percentage.

            >``Even`` - Allocates costs evenly across all targets.

          • Parameters (list) --

            The parameters for a split charge method. This is only required for the FIXED method.

            • (dict) --

              The parameters for a split charge method.

              • Type (string) --

                The parameter type.

              • Values (list) --

                The parameter values.

                • (string) --
      • ProcessingStatus (list) --

        The list of processing statuses for Cost Management products for a specific cost category.

        • (dict) --

          The list of processing statuses for Cost Management products for a specific cost category.

          • Component (string) --

            The Cost Management product name of the applied status.

          • Status (string) --

            The process status for a specific cost category.

      • DefaultValue (string) --

        The default value for the cost category.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_anomalies(**kwargs)

Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object.

See also: AWS API Documentation

Request Syntax

response = client.get_anomalies(
    MonitorArn='string',
    DateInterval={
        'StartDate': 'string',
        'EndDate': 'string'
    },
    Feedback='YES'|'NO'|'PLANNED_ACTIVITY',
    TotalImpact={
        'NumericOperator': 'EQUAL'|'GREATER_THAN_OR_EQUAL'|'LESS_THAN_OR_EQUAL'|'GREATER_THAN'|'LESS_THAN'|'BETWEEN',
        'StartValue': 123.0,
        'EndValue': 123.0
    },
    NextPageToken='string',
    MaxResults=123
)
Parameters
  • MonitorArn (string) -- Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN).
  • DateInterval (dict) --

    [REQUIRED]

    Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an AnomalyEndDate in the specified time range.

    • StartDate (string) -- [REQUIRED]

      The first date an anomaly was observed.

    • EndDate (string) --

      The last date an anomaly was observed.

  • Feedback (string) -- Filters anomaly results by the feedback field on the anomaly object.
  • TotalImpact (dict) --

    Filters anomaly results by the total impact field on the anomaly object. For example, you can filter anomalies GREATER_THAN 200.00 to retrieve anomalies, with an estimated dollar impact greater than 200.

    • NumericOperator (string) -- [REQUIRED]

      The comparing value that's used in the filter.

    • StartValue (float) -- [REQUIRED]

      The lower bound dollar value that's used in the filter.

    • EndValue (float) --

      The upper bound dollar value that's used in the filter.

  • 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

{
    'Anomalies': [
        {
            'AnomalyId': 'string',
            'AnomalyStartDate': 'string',
            'AnomalyEndDate': 'string',
            'DimensionValue': 'string',
            'RootCauses': [
                {
                    'Service': 'string',
                    'Region': 'string',
                    'LinkedAccount': 'string',
                    'UsageType': 'string'
                },
            ],
            'AnomalyScore': {
                'MaxScore': 123.0,
                'CurrentScore': 123.0
            },
            'Impact': {
                'MaxImpact': 123.0,
                'TotalImpact': 123.0
            },
            'MonitorArn': 'string',
            'Feedback': 'YES'|'NO'|'PLANNED_ACTIVITY'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

  • (dict) --

    • Anomalies (list) --

      A list of cost anomalies.

      • (dict) --

        An unusual cost pattern. This consists of the detailed metadata and the current status of the anomaly object.

        • AnomalyId (string) --

          The unique identifier for the anomaly.

        • AnomalyStartDate (string) --

          The first day the anomaly is detected.

        • AnomalyEndDate (string) --

          The last day the anomaly is detected.

        • DimensionValue (string) --

          The dimension for the anomaly (for example, an Amazon Web Services service in a service monitor).

        • RootCauses (list) --

          The list of identified root causes for the anomaly.

          • (dict) --

            The combination of Amazon Web Services service, linked account, Region, and usage type where a cost anomaly is observed.

            • Service (string) --

              The Amazon Web Services service name that's associated with the cost anomaly.

            • Region (string) --

              The Amazon Web Services Region that's associated with the cost anomaly.

            • LinkedAccount (string) --

              The member account value that's associated with the cost anomaly.

            • UsageType (string) --

              The UsageType value that's associated with the cost anomaly.

        • AnomalyScore (dict) --

          The latest and maximum score for the anomaly.

          • MaxScore (float) --

            The maximum score that's observed during the AnomalyDateInterval .

          • CurrentScore (float) --

            The last observed score.

        • Impact (dict) --

          The dollar impact for the anomaly.

          • MaxImpact (float) --

            The maximum dollar value that's observed for an anomaly.

          • TotalImpact (float) --

            The cumulative dollar value that's observed for an anomaly.

        • MonitorArn (string) --

          The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.

        • Feedback (string) --

          The feedback value.

    • 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

get_anomaly_monitors(**kwargs)

Retrieves the cost anomaly monitor definitions 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_monitors(
    MonitorArnList=[
        'string',
    ],
    NextPageToken='string',
    MaxResults=123
)
Parameters
  • MonitorArnList (list) --

    A list of cost anomaly monitor ARNs.

    • (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.
  • MaxResults (integer) -- The number of entries that a paginated response contains.
Return type

dict

Returns

Response Syntax

{
    'AnomalyMonitors': [
        {
            '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'|'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',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                },
                'Tags': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                },
                'CostCategories': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                }
            },
            'DimensionalValueCount': 123
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

  • (dict) --

    • AnomalyMonitors (list) --

      A list of cost anomaly monitors that includes the detailed metadata for each monitor.

      • (dict) --

        This object continuously inspects your account's cost data for anomalies. It's based on MonitorType and MonitorSpecification . The content consists of detailed metadata and the current status of the monitor object.

        • MonitorArn (string) --

          The Amazon Resource Name (ARN) value.

        • MonitorName (string) --

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

          The possible type values.

        • MonitorDimension (string) --

          The dimensions to evaluate.

        • MonitorSpecification (dict) --

          Use Expression to filter by cost or by usage. There are two patterns:

          • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
          • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

          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 by cost or by usage. There are two patterns:

              • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
              • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

              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 by cost or by usage. There are two patterns:

              • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
              • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

              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.

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

    • 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

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'
        },
    ],
    '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) --

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

        • Frequency (string) --

          The frequency that anomaly reports are sent over email.

        • SubscriptionName (string) --

          The name for the subscription.

    • 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

get_cost_and_usage(**kwargs)

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts or UsageQuantity . You can also filter and group your data by various dimensions, such as SERVICE or AZ , in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.

For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_cost_and_usage(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    Metrics=[
        'string',
    ],
    GroupBy=[
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': 'string'
        },
    ],
    NextPageToken='string'
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    Sets the start date and end date for retrieving Amazon Web Services costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

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

  • Granularity (string) --

    [REQUIRED]

    Sets the Amazon Web Services cost granularity to MONTHLY or DAILY , or HOURLY . If Granularity isn't set, the response object doesn't include the Granularity , either MONTHLY or DAILY , or HOURLY .

  • Filter (dict) --

    Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression .

    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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 (list) --

    [REQUIRED]

    Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill? .

    Valid values are AmortizedCost , BlendedCost , NetAmortizedCost , NetUnblendedCost , NormalizedUsageAmount , UnblendedCost , and UsageQuantity .

    Note

    If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours and GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups .

    Metrics is required for GetCostAndUsage requests.

    • (string) --
  • GroupBy (list) --

    You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

    Valid values for the DIMENSION type are AZ , INSTANCE_TYPE , LEGAL_ENTITY_NAME , LINKED_ACCOUNT , OPERATION , PLATFORM , PURCHASE_TYPE , SERVICE , TENANCY , RECORD_TYPE , and USAGE_TYPE .

    When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

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

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

dict

Returns

Response Syntax

{
    'NextPageToken': 'string',
    'GroupDefinitions': [
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': 'string'
        },
    ],
    'ResultsByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'Total': {
                'string': {
                    'Amount': 'string',
                    'Unit': 'string'
                }
            },
            'Groups': [
                {
                    'Keys': [
                        'string',
                    ],
                    'Metrics': {
                        'string': {
                            'Amount': 'string',
                            'Unit': 'string'
                        }
                    }
                },
            ],
            'Estimated': True|False
        },
    ],
    'DimensionValueAttributes': [
        {
            'Value': 'string',
            'Attributes': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextPageToken (string) --

      The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

    • GroupDefinitions (list) --

      The groups that are specified by the Filter or GroupBy parameters in the request.

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

    • ResultsByTime (list) --

      The time period that's covered by the results in the response.

      • (dict) --

        The result that's associated with a time period.

        • TimePeriod (dict) --

          The time period that the result covers.

          • Start (string) --

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

            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 .

        • Total (dict) --

          The total amount of cost or usage accrued during the time period.

          • (string) --

            • (dict) --

              The aggregated value for a metric.

              • Amount (string) --

                The actual number that represents the metric.

              • Unit (string) --

                The unit that the metric is given in.

        • Groups (list) --

          The groups that this time period includes.

          • (dict) --

            One level of grouped data in the results.

            • Keys (list) --

              The keys that are included in this group.

              • (string) --
            • Metrics (dict) --

              The metrics that are included in this group.

              • (string) --

                • (dict) --

                  The aggregated value for a metric.

                  • Amount (string) --

                    The actual number that represents the metric.

                  • Unit (string) --

                    The unit that the metric is given in.

        • Estimated (boolean) --

          Determines whether the result is estimated.

    • DimensionValueAttributes (list) --

      The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.

      • (dict) --

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

        • Value (string) --

          The value of a dimension with a specific attribute.

        • Attributes (dict) --

          The attribute that applies to a specific Dimension .

          • (string) --
            • (string) --

Exceptions

get_cost_and_usage_with_resources(**kwargs)

Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity , that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ , in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

Note

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_cost_and_usage_with_resources(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    Metrics=[
        'string',
    ],
    GroupBy=[
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': 'string'
        },
    ],
    NextPageToken='string'
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days (the start date cannot be earlier than 14 days ago). The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

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

  • Granularity (string) --

    [REQUIRED]

    Sets the Amazon Web Services cost granularity to MONTHLY , DAILY , or HOURLY . If Granularity isn't set, the response object doesn't include the Granularity , MONTHLY , DAILY , or HOURLY .

  • Filter (dict) --

    [REQUIRED]

    Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression .

    The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId . It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.

    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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 (list) --

    Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill? .

    Valid values are AmortizedCost , BlendedCost , NetAmortizedCost , NetUnblendedCost , NormalizedUsageAmount , UnblendedCost , and UsageQuantity .

    Note

    If you return the UsageQuantity metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups .

    Metrics is required for GetCostAndUsageWithResources requests.

    • (string) --
  • GroupBy (list) --

    You can group Amazon Web Services costs using up to two different groups: DIMENSION , TAG , COST_CATEGORY .

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

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

dict

Returns

Response Syntax

{
    'NextPageToken': 'string',
    'GroupDefinitions': [
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': 'string'
        },
    ],
    'ResultsByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'Total': {
                'string': {
                    'Amount': 'string',
                    'Unit': 'string'
                }
            },
            'Groups': [
                {
                    'Keys': [
                        'string',
                    ],
                    'Metrics': {
                        'string': {
                            'Amount': 'string',
                            'Unit': 'string'
                        }
                    }
                },
            ],
            'Estimated': True|False
        },
    ],
    'DimensionValueAttributes': [
        {
            'Value': 'string',
            'Attributes': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextPageToken (string) --

      The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

    • GroupDefinitions (list) --

      The groups that are specified by the Filter or GroupBy parameters in the request.

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

    • ResultsByTime (list) --

      The time period that is covered by the results in the response.

      • (dict) --

        The result that's associated with a time period.

        • TimePeriod (dict) --

          The time period that the result covers.

          • Start (string) --

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

            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 .

        • Total (dict) --

          The total amount of cost or usage accrued during the time period.

          • (string) --

            • (dict) --

              The aggregated value for a metric.

              • Amount (string) --

                The actual number that represents the metric.

              • Unit (string) --

                The unit that the metric is given in.

        • Groups (list) --

          The groups that this time period includes.

          • (dict) --

            One level of grouped data in the results.

            • Keys (list) --

              The keys that are included in this group.

              • (string) --
            • Metrics (dict) --

              The metrics that are included in this group.

              • (string) --

                • (dict) --

                  The aggregated value for a metric.

                  • Amount (string) --

                    The actual number that represents the metric.

                  • Unit (string) --

                    The unit that the metric is given in.

        • Estimated (boolean) --

          Determines whether the result is estimated.

    • DimensionValueAttributes (list) --

      The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.

      • (dict) --

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

        • Value (string) --

          The value of a dimension with a specific attribute.

        • Attributes (dict) --

          The attribute that applies to a specific Dimension .

          • (string) --
            • (string) --

Exceptions

get_cost_categories(**kwargs)

Retrieves an array of Cost Category names and values incurred cost.

Note

If some Cost Category names and values are not associated with any cost, they will not be returned by this API.

See also: AWS API Documentation

Request Syntax

response = client.get_cost_categories(
    SearchString='string',
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    CostCategoryName='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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    SortBy=[
        {
            'Key': 'string',
            'SortOrder': 'ASCENDING'|'DESCENDING'
        },
    ],
    MaxResults=123,
    NextPageToken='string'
)
Parameters
  • SearchString (string) --

    The value that you want to search the filter values for.

    If you do not specify a CostCategoryName , SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName , SearchString will be used to filter Cost Category values that match the SearchString pattern.

  • TimePeriod (dict) --

    [REQUIRED]

    The time period of the request.

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

  • CostCategoryName (string) -- The unique name of the Cost Category.
  • Filter (dict) --

    Use Expression to filter by cost or by usage. There are two patterns:

    • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
    • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

    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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • SortBy (list) --

    The value by which you want to sort the data.

    The key represents cost and usage metrics. The following values are supported:

    • BlendedCost
    • UnblendedCost
    • AmortizedCost
    • NetAmortizedCost
    • NetUnblendedCost
    • UsageQuantity
    • NormalizedUsageAmount

    Supported values for SortOrder are ASCENDING or DESCENDING .

    When using SortBy , NextPageToken and SearchString are not supported.

    • (dict) --

      The details of how to sort the data.

      • Key (string) -- [REQUIRED]

        The key that's used to sort the data.

      • SortOrder (string) --

        The order that's used to sort the data.

  • MaxResults (integer) --

    This field is only used when SortBy is provided in the request.

    The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy , the request will return 1000 results as the default value for this parameter.

    For GetCostCategories , MaxResults has an upper limit of 1000.

  • NextPageToken (string) -- If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.
Return type

dict

Returns

Response Syntax

{
    'NextPageToken': 'string',
    'CostCategoryNames': [
        'string',
    ],
    'CostCategoryValues': [
        'string',
    ],
    'ReturnSize': 123,
    'TotalSize': 123
}

Response Structure

  • (dict) --

    • NextPageToken (string) --

      If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • CostCategoryNames (list) --

      The names of the Cost Categories.

      • (string) --

        The unique name of the Cost Category.

    • CostCategoryValues (list) --

      The Cost Category values.

      CostCategoryValues are not returned if CostCategoryName is not specified in the request.

      • (string) --

        The default value for the cost category.

    • ReturnSize (integer) --

      The number of objects returned.

    • TotalSize (integer) --

      The total number of objects.

Exceptions

get_cost_forecast(**kwargs)

Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.

See also: AWS API Documentation

Request Syntax

response = client.get_cost_forecast(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    Metric='BLENDED_COST'|'UNBLENDED_COST'|'AMORTIZED_COST'|'NET_UNBLENDED_COST'|'NET_AMORTIZED_COST'|'USAGE_QUANTITY'|'NORMALIZED_USAGE_AMOUNT',
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    PredictionIntervalLevel=123
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

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

  • Metric (string) --

    [REQUIRED]

    Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill? .

    Valid values for a GetCostForecast call are the following:

    • AMORTIZED_COST
    • BLENDED_COST
    • NET_AMORTIZED_COST
    • NET_UNBLENDED_COST
    • UNBLENDED_COST
  • Granularity (string) --

    [REQUIRED]

    How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

    The GetCostForecast operation supports only DAILY and MONTHLY granularities.

  • Filter (dict) --

    The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

    • AZ
    • INSTANCE_TYPE
    • LINKED_ACCOUNT
    • LINKED_ACCOUNT_NAME
    • OPERATION
    • PURCHASE_TYPE
    • REGION
    • SERVICE
    • USAGE_TYPE
    • USAGE_TYPE_GROUP
    • RECORD_TYPE
    • OPERATING_SYSTEM
    • TENANCY
    • SCOPE
    • PLATFORM
    • SUBSCRIPTION_ID
    • LEGAL_ENTITY_NAME
    • DEPLOYMENT_OPTION
    • DATABASE_ENGINE
    • INSTANCE_TYPE_FAMILY
    • BILLING_ENTITY
    • RESERVATION_ID
    • SAVINGS_PLAN_ARN
    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • PredictionIntervalLevel (integer) -- Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
Return type

dict

Returns

Response Syntax

{
    'Total': {
        'Amount': 'string',
        'Unit': 'string'
    },
    'ForecastResultsByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'MeanValue': 'string',
            'PredictionIntervalLowerBound': 'string',
            'PredictionIntervalUpperBound': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Total (dict) --

      How much you are forecasted to spend over the forecast period, in USD .

      • Amount (string) --

        The actual number that represents the metric.

      • Unit (string) --

        The unit that the metric is given in.

    • ForecastResultsByTime (list) --

      The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

      • (dict) --

        The forecast that's created for your query.

        • TimePeriod (dict) --

          The period of time that the forecast covers.

          • Start (string) --

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

            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 .

        • MeanValue (string) --

          The mean value of the forecast.

        • PredictionIntervalLowerBound (string) --

          The lower limit for the prediction interval.

        • PredictionIntervalUpperBound (string) --

          The upper limit for the prediction interval.

Exceptions

get_dimension_values(**kwargs)

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

See also: AWS API Documentation

Request Syntax

response = client.get_dimension_values(
    SearchString='string',
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    Dimension='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',
    Context='COST_AND_USAGE'|'RESERVATIONS'|'SAVINGS_PLANS',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    SortBy=[
        {
            'Key': 'string',
            'SortOrder': 'ASCENDING'|'DESCENDING'
        },
    ],
    MaxResults=123,
    NextPageToken='string'
)
Parameters
  • SearchString (string) -- The value that you want to search the filter values for.
  • TimePeriod (dict) --

    [REQUIRED]

    The start date and end date for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

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

  • Dimension (string) --

    [REQUIRED]

    The name of the dimension. Each Dimension is available for a different Context . For more information, see Context .

  • Context (string) --

    The context for the call to GetDimensionValues . This can be RESERVATIONS or COST_AND_USAGE . The default value is COST_AND_USAGE . If the context is set to RESERVATIONS , the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE , the resulting dimension values can be used in the GetCostAndUsage operation.

    If you set the context to COST_AND_USAGE , you can use the following dimensions for searching:

    • AZ - The Availability Zone. An example is us-east-1a .
    • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
    • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge .
    • LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
    • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
    • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
    • OPERATION - The action performed. Examples include RunInstance and CreateBucket .
    • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
    • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
    • SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
    • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
    • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
    • REGION - The Amazon Web Services Region.
    • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
    • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    If you set the context to RESERVATIONS , you can use the following dimensions for searching:

    • AZ - The Availability Zone. An example is us-east-1a .
    • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
    • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ .
    • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge .
    • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
    • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
    • REGION - The Amazon Web Services Region.
    • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
    • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
    • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    If you set the context to SAVINGS_PLANS , you can use the following dimensions for searching:

    • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
    • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
    • REGION - The Amazon Web Services Region.
    • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5 )
    • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
    • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
  • Filter (dict) --

    Use Expression to filter by cost or by usage. There are two patterns:

    • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
    • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

    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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • SortBy (list) --

    The value by which you want to sort the data.

    The key represents cost and usage metrics. The following values are supported:

    • BlendedCost
    • UnblendedCost
    • AmortizedCost
    • NetAmortizedCost
    • NetUnblendedCost
    • UsageQuantity
    • NormalizedUsageAmount

    Supported values for SortOrder are ASCENDING or DESCENDING .

    When you specify a SortBy paramater, the context must be COST_AND_USAGE . Further, when using SortBy , NextPageToken and SearchString are not supported.

    • (dict) --

      The details of how to sort the data.

      • Key (string) -- [REQUIRED]

        The key that's used to sort the data.

      • SortOrder (string) --

        The order that's used to sort the data.

  • MaxResults (integer) --

    This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

    For GetDimensionValues , MaxResults has an upper limit of 1000.

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

dict

Returns

Response Syntax

{
    'DimensionValues': [
        {
            'Value': 'string',
            'Attributes': {
                'string': 'string'
            }
        },
    ],
    'ReturnSize': 123,
    'TotalSize': 123,
    'NextPageToken': 'string'
}

Response Structure

  • (dict) --

    • DimensionValues (list) --

      The filters that you used to filter your request. Some dimensions are available only for a specific context.

      If you set the context to COST_AND_USAGE , you can use the following dimensions for searching:

      • AZ - The Availability Zone. An example is us-east-1a .
      • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
      • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge .
      • LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
      • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
      • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
      • OPERATION - The action performed. Examples include RunInstance and CreateBucket .
      • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
      • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
      • SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
      • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
      • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
      • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
      • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

      If you set the context to RESERVATIONS , you can use the following dimensions for searching:

      • AZ - The Availability Zone. An example is us-east-1a .
      • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
      • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ .
      • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge .
      • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
      • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
      • REGION - The Amazon Web Services Region.
      • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
      • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
      • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

      If you set the context to SAVINGS_PLANS , you can use the following dimensions for searching:

      • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
      • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
      • REGION - The Amazon Web Services Region.
      • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5 )
      • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
      • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
      • (dict) --

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

        • Value (string) --

          The value of a dimension with a specific attribute.

        • Attributes (dict) --

          The attribute that applies to a specific Dimension .

          • (string) --
            • (string) --
    • ReturnSize (integer) --

      The number of results that Amazon Web Services returned at one time.

    • TotalSize (integer) --

      The total number of search results.

    • NextPageToken (string) --

      The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_reservation_coverage(**kwargs)

Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:

  • AZ
  • CACHE_ENGINE
  • DATABASE_ENGINE
  • DEPLOYMENT_OPTION
  • INSTANCE_TYPE
  • LINKED_ACCOUNT
  • OPERATING_SYSTEM
  • PLATFORM
  • REGION
  • SERVICE
  • TAG
  • TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation.

See also: AWS API Documentation

Request Syntax

response = client.get_reservation_coverage(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    GroupBy=[
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': 'string'
        },
    ],
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    Metrics=[
        'string',
    ],
    NextPageToken='string',
    SortBy={
        'Key': 'string',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    MaxResults=123
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

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

  • GroupBy (list) --

    You can group the data by the following attributes:

    • AZ
    • CACHE_ENGINE
    • DATABASE_ENGINE
    • DEPLOYMENT_OPTION
    • INSTANCE_TYPE
    • LINKED_ACCOUNT
    • OPERATING_SYSTEM
    • PLATFORM
    • REGION
    • TENANCY
    • (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.

  • Granularity (string) --

    The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY .

    If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity , either MONTHLY or DAILY .

    The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

  • Filter (dict) --

    Filters utilization data by dimensions. You can filter by the following dimensions:

    • AZ
    • CACHE_ENGINE
    • DATABASE_ENGINE
    • DEPLOYMENT_OPTION
    • INSTANCE_TYPE
    • LINKED_ACCOUNT
    • OPERATING_SYSTEM
    • PLATFORM
    • REGION
    • SERVICE
    • TAG
    • TENANCY
    GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

    If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

    Cost category is also supported.

    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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 (list) --

    The measurement that you want your reservation coverage reported in.

    Valid values are Hour , Unit , and Cost . You can use multiple values in a request.

    • (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.
  • SortBy (dict) --

    The value by which you want to sort the data.

    The following values are supported for Key :

    • OnDemandCost
    • CoverageHoursPercentage
    • OnDemandHours
    • ReservedHours
    • TotalRunningHours
    • CoverageNormalizedUnitsPercentage
    • OnDemandNormalizedUnits
    • ReservedNormalizedUnits
    • TotalRunningNormalizedUnits
    • Time

    Supported values for SortOrder are ASCENDING or DESCENDING .

    • Key (string) -- [REQUIRED]

      The key that's used to sort the data.

    • SortOrder (string) --

      The order that's used to sort the data.

  • MaxResults (integer) -- The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
Return type

dict

Returns

Response Syntax

{
    'CoveragesByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'Groups': [
                {
                    'Attributes': {
                        'string': 'string'
                    },
                    'Coverage': {
                        'CoverageHours': {
                            'OnDemandHours': 'string',
                            'ReservedHours': 'string',
                            'TotalRunningHours': 'string',
                            'CoverageHoursPercentage': 'string'
                        },
                        'CoverageNormalizedUnits': {
                            'OnDemandNormalizedUnits': 'string',
                            'ReservedNormalizedUnits': 'string',
                            'TotalRunningNormalizedUnits': 'string',
                            'CoverageNormalizedUnitsPercentage': 'string'
                        },
                        'CoverageCost': {
                            'OnDemandCost': 'string'
                        }
                    }
                },
            ],
            'Total': {
                'CoverageHours': {
                    'OnDemandHours': 'string',
                    'ReservedHours': 'string',
                    'TotalRunningHours': 'string',
                    'CoverageHoursPercentage': 'string'
                },
                'CoverageNormalizedUnits': {
                    'OnDemandNormalizedUnits': 'string',
                    'ReservedNormalizedUnits': 'string',
                    'TotalRunningNormalizedUnits': 'string',
                    'CoverageNormalizedUnitsPercentage': 'string'
                },
                'CoverageCost': {
                    'OnDemandCost': 'string'
                }
            }
        },
    ],
    'Total': {
        'CoverageHours': {
            'OnDemandHours': 'string',
            'ReservedHours': 'string',
            'TotalRunningHours': 'string',
            'CoverageHoursPercentage': 'string'
        },
        'CoverageNormalizedUnits': {
            'OnDemandNormalizedUnits': 'string',
            'ReservedNormalizedUnits': 'string',
            'TotalRunningNormalizedUnits': 'string',
            'CoverageNormalizedUnitsPercentage': 'string'
        },
        'CoverageCost': {
            'OnDemandCost': 'string'
        }
    },
    'NextPageToken': 'string'
}

Response Structure

  • (dict) --

    • CoveragesByTime (list) --

      The amount of time that your reservations covered.

      • (dict) --

        Reservation coverage for a specified period, in hours.

        • TimePeriod (dict) --

          The period that this coverage was used over.

          • Start (string) --

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

            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 .

        • Groups (list) --

          The groups of instances that the reservation covered.

          • (dict) --

            A group of reservations that share a set of attributes.

            • Attributes (dict) --

              The attributes for this group of reservations.

              • (string) --
                • (string) --
            • Coverage (dict) --

              How much instance usage this group of reservations covered.

              • CoverageHours (dict) --

                The amount of instance usage that the reservation covered, in hours.

                • OnDemandHours (string) --

                  The number of instance running hours that On-Demand Instances covered.

                • ReservedHours (string) --

                  The number of instance running hours that reservations covered.

                • TotalRunningHours (string) --

                  The total instance usage, in hours.

                • CoverageHoursPercentage (string) --

                  The percentage of instance hours that a reservation covered.

              • CoverageNormalizedUnits (dict) --

                The amount of instance usage that the reservation covered, in normalized units.

                • OnDemandNormalizedUnits (string) --

                  The number of normalized units that are covered by On-Demand Instances instead of a reservation.

                • ReservedNormalizedUnits (string) --

                  The number of normalized units that a reservation covers.

                • TotalRunningNormalizedUnits (string) --

                  The total number of normalized units that you used.

                • CoverageNormalizedUnitsPercentage (string) --

                  The percentage of your used instance normalized units that a reservation covers.

              • CoverageCost (dict) --

                The amount of cost that the reservation covered.

                • OnDemandCost (string) --

                  How much an On-Demand Instance costs.

        • Total (dict) --

          The total reservation coverage, in hours.

          • CoverageHours (dict) --

            The amount of instance usage that the reservation covered, in hours.

            • OnDemandHours (string) --

              The number of instance running hours that On-Demand Instances covered.

            • ReservedHours (string) --

              The number of instance running hours that reservations covered.

            • TotalRunningHours (string) --

              The total instance usage, in hours.

            • CoverageHoursPercentage (string) --

              The percentage of instance hours that a reservation covered.

          • CoverageNormalizedUnits (dict) --

            The amount of instance usage that the reservation covered, in normalized units.

            • OnDemandNormalizedUnits (string) --

              The number of normalized units that are covered by On-Demand Instances instead of a reservation.

            • ReservedNormalizedUnits (string) --

              The number of normalized units that a reservation covers.

            • TotalRunningNormalizedUnits (string) --

              The total number of normalized units that you used.

            • CoverageNormalizedUnitsPercentage (string) --

              The percentage of your used instance normalized units that a reservation covers.

          • CoverageCost (dict) --

            The amount of cost that the reservation covered.

            • OnDemandCost (string) --

              How much an On-Demand Instance costs.

    • Total (dict) --

      The total amount of instance usage that a reservation covered.

      • CoverageHours (dict) --

        The amount of instance usage that the reservation covered, in hours.

        • OnDemandHours (string) --

          The number of instance running hours that On-Demand Instances covered.

        • ReservedHours (string) --

          The number of instance running hours that reservations covered.

        • TotalRunningHours (string) --

          The total instance usage, in hours.

        • CoverageHoursPercentage (string) --

          The percentage of instance hours that a reservation covered.

      • CoverageNormalizedUnits (dict) --

        The amount of instance usage that the reservation covered, in normalized units.

        • OnDemandNormalizedUnits (string) --

          The number of normalized units that are covered by On-Demand Instances instead of a reservation.

        • ReservedNormalizedUnits (string) --

          The number of normalized units that a reservation covers.

        • TotalRunningNormalizedUnits (string) --

          The total number of normalized units that you used.

        • CoverageNormalizedUnitsPercentage (string) --

          The percentage of your used instance normalized units that a reservation covers.

      • CoverageCost (dict) --

        The amount of cost that the reservation covered.

        • OnDemandCost (string) --

          How much an On-Demand Instance costs.

    • NextPageToken (string) --

      The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Exceptions

get_reservation_purchase_recommendation(**kwargs)

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. Amazon Web Services also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large because that is the smallest size instance in the c4 instance family.

See also: AWS API Documentation

Request Syntax

response = client.get_reservation_purchase_recommendation(
    AccountId='string',
    Service='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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    AccountScope='PAYER'|'LINKED',
    LookbackPeriodInDays='SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
    TermInYears='ONE_YEAR'|'THREE_YEARS',
    PaymentOption='NO_UPFRONT'|'PARTIAL_UPFRONT'|'ALL_UPFRONT'|'LIGHT_UTILIZATION'|'MEDIUM_UTILIZATION'|'HEAVY_UTILIZATION',
    ServiceSpecification={
        'EC2Specification': {
            'OfferingClass': 'STANDARD'|'CONVERTIBLE'
        }
    },
    PageSize=123,
    NextPageToken='string'
)
Parameters
  • AccountId (string) -- The account ID that is associated with the recommendation.
  • Service (string) --

    [REQUIRED]

    The specific service that you want recommendations for.

  • Filter (dict) --

    Use Expression to filter by cost or by usage. There are two patterns:

    • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
    • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

    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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • AccountScope (string) -- The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER . If the value is LINKED , recommendations are calculated for individual member accounts only.
  • LookbackPeriodInDays (string) -- The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.
  • TermInYears (string) -- The reservation term that you want recommendations for.
  • PaymentOption (string) -- The reservation purchase option that you want recommendations for.
  • ServiceSpecification (dict) --

    The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

    • EC2Specification (dict) --

      The Amazon EC2 hardware specifications that you want Amazon Web Services to provide recommendations for.

      • OfferingClass (string) --

        Indicates whether you want a recommendation for standard or convertible reservations.

  • PageSize (integer) -- The number of recommendations that you want returned in a single response object.
  • NextPageToken (string) -- The pagination token that indicates the next set of results that you want to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Metadata': {
        'RecommendationId': 'string',
        'GenerationTimestamp': 'string'
    },
    'Recommendations': [
        {
            'AccountScope': 'PAYER'|'LINKED',
            'LookbackPeriodInDays': 'SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
            'TermInYears': 'ONE_YEAR'|'THREE_YEARS',
            'PaymentOption': 'NO_UPFRONT'|'PARTIAL_UPFRONT'|'ALL_UPFRONT'|'LIGHT_UTILIZATION'|'MEDIUM_UTILIZATION'|'HEAVY_UTILIZATION',
            'ServiceSpecification': {
                'EC2Specification': {
                    'OfferingClass': 'STANDARD'|'CONVERTIBLE'
                }
            },
            'RecommendationDetails': [
                {
                    'AccountId': 'string',
                    'InstanceDetails': {
                        'EC2InstanceDetails': {
                            'Family': 'string',
                            'InstanceType': 'string',
                            'Region': 'string',
                            'AvailabilityZone': 'string',
                            'Platform': 'string',
                            'Tenancy': 'string',
                            'CurrentGeneration': True|False,
                            'SizeFlexEligible': True|False
                        },
                        'RDSInstanceDetails': {
                            'Family': 'string',
                            'InstanceType': 'string',
                            'Region': 'string',
                            'DatabaseEngine': 'string',
                            'DatabaseEdition': 'string',
                            'DeploymentOption': 'string',
                            'LicenseModel': 'string',
                            'CurrentGeneration': True|False,
                            'SizeFlexEligible': True|False
                        },
                        'RedshiftInstanceDetails': {
                            'Family': 'string',
                            'NodeType': 'string',
                            'Region': 'string',
                            'CurrentGeneration': True|False,
                            'SizeFlexEligible': True|False
                        },
                        'ElastiCacheInstanceDetails': {
                            'Family': 'string',
                            'NodeType': 'string',
                            'Region': 'string',
                            'ProductDescription': 'string',
                            'CurrentGeneration': True|False,
                            'SizeFlexEligible': True|False
                        },
                        'ESInstanceDetails': {
                            'InstanceClass': 'string',
                            'InstanceSize': 'string',
                            'Region': 'string',
                            'CurrentGeneration': True|False,
                            'SizeFlexEligible': True|False
                        }
                    },
                    'RecommendedNumberOfInstancesToPurchase': 'string',
                    'RecommendedNormalizedUnitsToPurchase': 'string',
                    'MinimumNumberOfInstancesUsedPerHour': 'string',
                    'MinimumNormalizedUnitsUsedPerHour': 'string',
                    'MaximumNumberOfInstancesUsedPerHour': 'string',
                    'MaximumNormalizedUnitsUsedPerHour': 'string',
                    'AverageNumberOfInstancesUsedPerHour': 'string',
                    'AverageNormalizedUnitsUsedPerHour': 'string',
                    'AverageUtilization': 'string',
                    'EstimatedBreakEvenInMonths': 'string',
                    'CurrencyCode': 'string',
                    'EstimatedMonthlySavingsAmount': 'string',
                    'EstimatedMonthlySavingsPercentage': 'string',
                    'EstimatedMonthlyOnDemandCost': 'string',
                    'EstimatedReservationCostForLookbackPeriod': 'string',
                    'UpfrontCost': 'string',
                    'RecurringStandardMonthlyCost': 'string'
                },
            ],
            'RecommendationSummary': {
                'TotalEstimatedMonthlySavingsAmount': 'string',
                'TotalEstimatedMonthlySavingsPercentage': 'string',
                'CurrencyCode': 'string'
            }
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

  • (dict) --

    • Metadata (dict) --

      Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.

      • RecommendationId (string) --

        The ID for this specific recommendation.

      • GenerationTimestamp (string) --

        The timestamp for when Amazon Web Services made this recommendation.

    • Recommendations (list) --

      Recommendations for reservations to purchase.

      • (dict) --

        A specific reservation that Amazon Web Services recommends for purchase.

        • AccountScope (string) --

          The account scope that Amazon Web Services recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in Amazon Web Services Organizations.

        • LookbackPeriodInDays (string) --

          How many days of previous usage that Amazon Web Services considers when making this recommendation.

        • TermInYears (string) --

          The term of the reservation that you want recommendations for, in years.

        • PaymentOption (string) --

          The payment option for the reservation (for example, AllUpfront or NoUpfront ).

        • ServiceSpecification (dict) --

          Hardware specifications for the service that you want recommendations for.

          • EC2Specification (dict) --

            The Amazon EC2 hardware specifications that you want Amazon Web Services to provide recommendations for.

            • OfferingClass (string) --

              Indicates whether you want a recommendation for standard or convertible reservations.

        • RecommendationDetails (list) --

          Details about the recommended purchases.

          • (dict) --

            Details about your recommended reservation purchase.

            • AccountId (string) --

              The account that this RI recommendation is for.

            • InstanceDetails (dict) --

              Details about the instances that Amazon Web Services recommends that you purchase.

              • EC2InstanceDetails (dict) --

                The Amazon EC2 instances that Amazon Web Services recommends that you purchase.

                • Family (string) --

                  The instance family of the recommended reservation.

                • InstanceType (string) --

                  The type of instance that Amazon Web Services recommends.

                • Region (string) --

                  The Amazon Web Services Region of the recommended reservation.

                • AvailabilityZone (string) --

                  The Availability Zone of the recommended reservation.

                • Platform (string) --

                  The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.

                • Tenancy (string) --

                  Determines whether the recommended reservation is dedicated or shared.

                • CurrentGeneration (boolean) --

                  Determines whether the recommendation is for a current-generation instance.

                • SizeFlexEligible (boolean) --

                  Determines whether the recommended reservation is size flexible.

              • RDSInstanceDetails (dict) --

                The Amazon RDS instances that Amazon Web Services recommends that you purchase.

                • Family (string) --

                  The instance family of the recommended reservation.

                • InstanceType (string) --

                  The type of instance that Amazon Web Services recommends.

                • Region (string) --

                  The Amazon Web Services Region of the recommended reservation.

                • DatabaseEngine (string) --

                  The database engine that the recommended reservation supports.

                • DatabaseEdition (string) --

                  The database edition that the recommended reservation supports.

                • DeploymentOption (string) --

                  Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.

                • LicenseModel (string) --

                  The license model that the recommended reservation supports.

                • CurrentGeneration (boolean) --

                  Determines whether the recommendation is for a current-generation instance.

                • SizeFlexEligible (boolean) --

                  Determines whether the recommended reservation is size flexible.

              • RedshiftInstanceDetails (dict) --

                The Amazon Redshift instances that Amazon Web Services recommends that you purchase.

                • Family (string) --

                  The instance family of the recommended reservation.

                • NodeType (string) --

                  The type of node that Amazon Web Services recommends.

                • Region (string) --

                  The Amazon Web Services Region of the recommended reservation.

                • CurrentGeneration (boolean) --

                  Determines whether the recommendation is for a current-generation instance.

                • SizeFlexEligible (boolean) --

                  Determines whether the recommended reservation is size flexible.

              • ElastiCacheInstanceDetails (dict) --

                The ElastiCache instances that Amazon Web Services recommends that you purchase.

                • Family (string) --

                  The instance family of the recommended reservation.

                • NodeType (string) --

                  The type of node that Amazon Web Services recommends.

                • Region (string) --

                  The Amazon Web Services Region of the recommended reservation.

                • ProductDescription (string) --

                  The description of the recommended reservation.

                • CurrentGeneration (boolean) --

                  Determines whether the recommendation is for a current generation instance.

                • SizeFlexEligible (boolean) --

                  Determines whether the recommended reservation is size flexible.

              • ESInstanceDetails (dict) --

                The Amazon ES instances that Amazon Web Services recommends that you purchase.

                • InstanceClass (string) --

                  The class of instance that Amazon Web Services recommends.

                • InstanceSize (string) --

                  The size of instance that Amazon Web Services recommends.

                • Region (string) --

                  The Amazon Web Services Region of the recommended reservation.

                • CurrentGeneration (boolean) --

                  Determines whether the recommendation is for a current-generation instance.

                • SizeFlexEligible (boolean) --

                  Determines whether the recommended reservation is size flexible.

            • RecommendedNumberOfInstancesToPurchase (string) --

              The number of instances that Amazon Web Services recommends that you purchase.

            • RecommendedNormalizedUnitsToPurchase (string) --

              The number of normalized units that Amazon Web Services recommends that you purchase.

            • MinimumNumberOfInstancesUsedPerHour (string) --

              The minimum number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

            • MinimumNormalizedUnitsUsedPerHour (string) --

              The minimum number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

            • MaximumNumberOfInstancesUsedPerHour (string) --

              The maximum number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

            • MaximumNormalizedUnitsUsedPerHour (string) --

              The maximum number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

            • AverageNumberOfInstancesUsedPerHour (string) --

              The average number of instances that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

            • AverageNormalizedUnitsUsedPerHour (string) --

              The average number of normalized units that you used in an hour during the historical period. Amazon Web Services uses this to calculate your recommended reservation purchases.

            • AverageUtilization (string) --

              The average utilization of your instances. Amazon Web Services uses this to calculate your recommended reservation purchases.

            • EstimatedBreakEvenInMonths (string) --

              How long Amazon Web Services estimates that it takes for this instance to start saving you money, in months.

            • CurrencyCode (string) --

              The currency code that Amazon Web Services used to calculate the costs for this instance.

            • EstimatedMonthlySavingsAmount (string) --

              How much Amazon Web Services estimates that this specific recommendation could save you in a month.

            • EstimatedMonthlySavingsPercentage (string) --

              How much Amazon Web Services estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.

            • EstimatedMonthlyOnDemandCost (string) --

              How much Amazon Web Services estimates that you spend on On-Demand Instances in a month.

            • EstimatedReservationCostForLookbackPeriod (string) --

              How much Amazon Web Services estimates that you would have spent for all usage during the specified historical period if you had a reservation.

            • UpfrontCost (string) --

              How much purchasing this instance costs you upfront.

            • RecurringStandardMonthlyCost (string) --

              How much purchasing this instance costs you on a monthly basis.

        • RecommendationSummary (dict) --

          A summary about the recommended purchase.

          • TotalEstimatedMonthlySavingsAmount (string) --

            The total amount that Amazon Web Services estimates that this recommendation could save you in a month.

          • TotalEstimatedMonthlySavingsPercentage (string) --

            The total amount that Amazon Web Services estimates that this recommendation could save you in a month, as a percentage of your costs.

          • CurrencyCode (string) --

            The currency code used for this recommendation.

    • NextPageToken (string) --

      The pagination token for the next set of retrievable results.

Exceptions

get_reservation_utilization(**kwargs)

Retrieves the reservation utilization for your account. Management account in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID .

See also: AWS API Documentation

Request Syntax

response = client.get_reservation_utilization(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    GroupBy=[
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': 'string'
        },
    ],
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    SortBy={
        'Key': 'string',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    NextPageToken='string',
    MaxResults=123
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

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

  • GroupBy (list) --

    Groups only by SUBSCRIPTION_ID . Metadata is included.

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

  • Granularity (string) --

    If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity , either MONTHLY or DAILY . If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY .

    The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

  • Filter (dict) --

    Filters utilization data by dimensions. You can filter by the following dimensions:

    • AZ
    • CACHE_ENGINE
    • DEPLOYMENT_OPTION
    • INSTANCE_TYPE
    • LINKED_ACCOUNT
    • OPERATING_SYSTEM
    • PLATFORM
    • REGION
    • SERVICE
    • SCOPE
    • TENANCY
    GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • SortBy (dict) --

    The value by which you want to sort the data.

    The following values are supported for Key :

    • UtilizationPercentage
    • UtilizationPercentageInUnits
    • PurchasedHours
    • PurchasedUnits
    • TotalActualHours
    • TotalActualUnits
    • UnusedHours
    • UnusedUnits
    • OnDemandCostOfRIHoursUsed
    • NetRISavings
    • TotalPotentialRISavings
    • AmortizedUpfrontFee
    • AmortizedRecurringFee
    • TotalAmortizedFee
    • RICostForUnusedHours
    • RealizedSavings
    • UnrealizedSavings

    Supported values for SortOrder are ASCENDING or DESCENDING .

    • Key (string) -- [REQUIRED]

      The key that's used to sort the data.

    • SortOrder (string) --

      The order that's used to sort the data.

  • 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 maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
Return type

dict

Returns

Response Syntax

{
    'UtilizationsByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'Groups': [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'Attributes': {
                        'string': 'string'
                    },
                    'Utilization': {
                        'UtilizationPercentage': 'string',
                        'UtilizationPercentageInUnits': 'string',
                        'PurchasedHours': 'string',
                        'PurchasedUnits': 'string',
                        'TotalActualHours': 'string',
                        'TotalActualUnits': 'string',
                        'UnusedHours': 'string',
                        'UnusedUnits': 'string',
                        'OnDemandCostOfRIHoursUsed': 'string',
                        'NetRISavings': 'string',
                        'TotalPotentialRISavings': 'string',
                        'AmortizedUpfrontFee': 'string',
                        'AmortizedRecurringFee': 'string',
                        'TotalAmortizedFee': 'string',
                        'RICostForUnusedHours': 'string',
                        'RealizedSavings': 'string',
                        'UnrealizedSavings': 'string'
                    }
                },
            ],
            'Total': {
                'UtilizationPercentage': 'string',
                'UtilizationPercentageInUnits': 'string',
                'PurchasedHours': 'string',
                'PurchasedUnits': 'string',
                'TotalActualHours': 'string',
                'TotalActualUnits': 'string',
                'UnusedHours': 'string',
                'UnusedUnits': 'string',
                'OnDemandCostOfRIHoursUsed': 'string',
                'NetRISavings': 'string',
                'TotalPotentialRISavings': 'string',
                'AmortizedUpfrontFee': 'string',
                'AmortizedRecurringFee': 'string',
                'TotalAmortizedFee': 'string',
                'RICostForUnusedHours': 'string',
                'RealizedSavings': 'string',
                'UnrealizedSavings': 'string'
            }
        },
    ],
    'Total': {
        'UtilizationPercentage': 'string',
        'UtilizationPercentageInUnits': 'string',
        'PurchasedHours': 'string',
        'PurchasedUnits': 'string',
        'TotalActualHours': 'string',
        'TotalActualUnits': 'string',
        'UnusedHours': 'string',
        'UnusedUnits': 'string',
        'OnDemandCostOfRIHoursUsed': 'string',
        'NetRISavings': 'string',
        'TotalPotentialRISavings': 'string',
        'AmortizedUpfrontFee': 'string',
        'AmortizedRecurringFee': 'string',
        'TotalAmortizedFee': 'string',
        'RICostForUnusedHours': 'string',
        'RealizedSavings': 'string',
        'UnrealizedSavings': 'string'
    },
    'NextPageToken': 'string'
}

Response Structure

  • (dict) --

    • UtilizationsByTime (list) --

      The amount of time that you used your RIs.

      • (dict) --

        The amount of utilization, in hours.

        • TimePeriod (dict) --

          The period of time that this utilization was used for.

          • Start (string) --

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

            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 .

        • Groups (list) --

          The groups that this utilization result uses.

          • (dict) --

            A group of reservations that share a set of attributes.

            • Key (string) --

              The key for a specific reservation attribute.

            • Value (string) --

              The value of a specific reservation attribute.

            • Attributes (dict) --

              The attributes for this group of reservations.

              • (string) --
                • (string) --
            • Utilization (dict) --

              How much you used this group of reservations.

              • UtilizationPercentage (string) --

                The percentage of reservation time that you used.

              • UtilizationPercentageInUnits (string) --

                The percentage of Amazon EC2 reservation time that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

              • PurchasedHours (string) --

                How many reservation hours that you purchased.

              • PurchasedUnits (string) --

                The number of Amazon EC2 reservation hours that you purchased. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

              • TotalActualHours (string) --

                The total number of reservation hours that you used.

              • TotalActualUnits (string) --

                The total number of Amazon EC2 reservation hours that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

              • UnusedHours (string) --

                The number of reservation hours that you didn't use.

              • UnusedUnits (string) --

                The number of Amazon EC2 reservation hours that you didn't use. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

              • OnDemandCostOfRIHoursUsed (string) --

                How much your reservation costs if charged On-Demand rates.

              • NetRISavings (string) --

                How much you saved due to purchasing and utilizing reservation. Amazon Web Services calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

              • TotalPotentialRISavings (string) --

                How much you might save if you use your entire reservation.

              • AmortizedUpfrontFee (string) --

                The upfront cost of your reservation. It's amortized over the reservation period.

              • AmortizedRecurringFee (string) --

                The monthly cost of your reservation. It's amortized over the reservation period.

              • TotalAmortizedFee (string) --

                The total cost of your reservation. It's amortized over the reservation period.

              • RICostForUnusedHours (string) --

                The cost of unused hours for your reservation.

              • RealizedSavings (string) --

                The realized savings because of purchasing and using a reservation.

              • UnrealizedSavings (string) --

                The unrealized savings because of purchasing and using a reservation.

        • Total (dict) --

          The total number of reservation hours that were used.

          • UtilizationPercentage (string) --

            The percentage of reservation time that you used.

          • UtilizationPercentageInUnits (string) --

            The percentage of Amazon EC2 reservation time that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

          • PurchasedHours (string) --

            How many reservation hours that you purchased.

          • PurchasedUnits (string) --

            The number of Amazon EC2 reservation hours that you purchased. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

          • TotalActualHours (string) --

            The total number of reservation hours that you used.

          • TotalActualUnits (string) --

            The total number of Amazon EC2 reservation hours that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

          • UnusedHours (string) --

            The number of reservation hours that you didn't use.

          • UnusedUnits (string) --

            The number of Amazon EC2 reservation hours that you didn't use. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

          • OnDemandCostOfRIHoursUsed (string) --

            How much your reservation costs if charged On-Demand rates.

          • NetRISavings (string) --

            How much you saved due to purchasing and utilizing reservation. Amazon Web Services calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

          • TotalPotentialRISavings (string) --

            How much you might save if you use your entire reservation.

          • AmortizedUpfrontFee (string) --

            The upfront cost of your reservation. It's amortized over the reservation period.

          • AmortizedRecurringFee (string) --

            The monthly cost of your reservation. It's amortized over the reservation period.

          • TotalAmortizedFee (string) --

            The total cost of your reservation. It's amortized over the reservation period.

          • RICostForUnusedHours (string) --

            The cost of unused hours for your reservation.

          • RealizedSavings (string) --

            The realized savings because of purchasing and using a reservation.

          • UnrealizedSavings (string) --

            The unrealized savings because of purchasing and using a reservation.

    • Total (dict) --

      The total amount of time that you used your RIs.

      • UtilizationPercentage (string) --

        The percentage of reservation time that you used.

      • UtilizationPercentageInUnits (string) --

        The percentage of Amazon EC2 reservation time that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

      • PurchasedHours (string) --

        How many reservation hours that you purchased.

      • PurchasedUnits (string) --

        The number of Amazon EC2 reservation hours that you purchased. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

      • TotalActualHours (string) --

        The total number of reservation hours that you used.

      • TotalActualUnits (string) --

        The total number of Amazon EC2 reservation hours that you used. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

      • UnusedHours (string) --

        The number of reservation hours that you didn't use.

      • UnusedUnits (string) --

        The number of Amazon EC2 reservation hours that you didn't use. It's converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

      • OnDemandCostOfRIHoursUsed (string) --

        How much your reservation costs if charged On-Demand rates.

      • NetRISavings (string) --

        How much you saved due to purchasing and utilizing reservation. Amazon Web Services calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

      • TotalPotentialRISavings (string) --

        How much you might save if you use your entire reservation.

      • AmortizedUpfrontFee (string) --

        The upfront cost of your reservation. It's amortized over the reservation period.

      • AmortizedRecurringFee (string) --

        The monthly cost of your reservation. It's amortized over the reservation period.

      • TotalAmortizedFee (string) --

        The total cost of your reservation. It's amortized over the reservation period.

      • RICostForUnusedHours (string) --

        The cost of unused hours for your reservation.

      • RealizedSavings (string) --

        The realized savings because of purchasing and using a reservation.

      • UnrealizedSavings (string) --

        The unrealized savings because of purchasing and using a reservation.

    • NextPageToken (string) --

      The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Exceptions

get_rightsizing_recommendation(**kwargs)

Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_rightsizing_recommendation(
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    Configuration={
        'RecommendationTarget': 'SAME_INSTANCE_FAMILY'|'CROSS_INSTANCE_FAMILY',
        'BenefitsConsidered': True|False
    },
    Service='string',
    PageSize=123,
    NextPageToken='string'
)
Parameters
  • Filter (dict) --

    Use Expression to filter by cost or by usage. There are two patterns:

    • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
    • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

    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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • Configuration (dict) --

    Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

    • RecommendationTarget (string) -- [REQUIRED]

      The option to see recommendations within the same instance family or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY .

    • BenefitsConsidered (boolean) -- [REQUIRED]

      The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE .

  • Service (string) --

    [REQUIRED]

    The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is "AmazonEC2 ".

  • PageSize (integer) -- The number of recommendations that you want returned in a single response object.
  • NextPageToken (string) -- The pagination token that indicates the next set of results that you want to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Metadata': {
        'RecommendationId': 'string',
        'GenerationTimestamp': 'string',
        'LookbackPeriodInDays': 'SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
        'AdditionalMetadata': 'string'
    },
    'Summary': {
        'TotalRecommendationCount': 'string',
        'EstimatedTotalMonthlySavingsAmount': 'string',
        'SavingsCurrencyCode': 'string',
        'SavingsPercentage': 'string'
    },
    'RightsizingRecommendations': [
        {
            'AccountId': 'string',
            'CurrentInstance': {
                'ResourceId': 'string',
                'InstanceName': 'string',
                'Tags': [
                    {
                        'Key': 'string',
                        'Values': [
                            'string',
                        ],
                        'MatchOptions': [
                            'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                        ]
                    },
                ],
                'ResourceDetails': {
                    'EC2ResourceDetails': {
                        'HourlyOnDemandRate': 'string',
                        'InstanceType': 'string',
                        'Platform': 'string',
                        'Region': 'string',
                        'Sku': 'string',
                        'Memory': 'string',
                        'NetworkPerformance': 'string',
                        'Storage': 'string',
                        'Vcpu': 'string'
                    }
                },
                'ResourceUtilization': {
                    'EC2ResourceUtilization': {
                        'MaxCpuUtilizationPercentage': 'string',
                        'MaxMemoryUtilizationPercentage': 'string',
                        'MaxStorageUtilizationPercentage': 'string',
                        'EBSResourceUtilization': {
                            'EbsReadOpsPerSecond': 'string',
                            'EbsWriteOpsPerSecond': 'string',
                            'EbsReadBytesPerSecond': 'string',
                            'EbsWriteBytesPerSecond': 'string'
                        },
                        'DiskResourceUtilization': {
                            'DiskReadOpsPerSecond': 'string',
                            'DiskWriteOpsPerSecond': 'string',
                            'DiskReadBytesPerSecond': 'string',
                            'DiskWriteBytesPerSecond': 'string'
                        },
                        'NetworkResourceUtilization': {
                            'NetworkInBytesPerSecond': 'string',
                            'NetworkOutBytesPerSecond': 'string',
                            'NetworkPacketsInPerSecond': 'string',
                            'NetworkPacketsOutPerSecond': 'string'
                        }
                    }
                },
                'ReservationCoveredHoursInLookbackPeriod': 'string',
                'SavingsPlansCoveredHoursInLookbackPeriod': 'string',
                'OnDemandHoursInLookbackPeriod': 'string',
                'TotalRunningHoursInLookbackPeriod': 'string',
                'MonthlyCost': 'string',
                'CurrencyCode': 'string'
            },
            'RightsizingType': 'TERMINATE'|'MODIFY',
            'ModifyRecommendationDetail': {
                'TargetInstances': [
                    {
                        'EstimatedMonthlyCost': 'string',
                        'EstimatedMonthlySavings': 'string',
                        'CurrencyCode': 'string',
                        'DefaultTargetInstance': True|False,
                        'ResourceDetails': {
                            'EC2ResourceDetails': {
                                'HourlyOnDemandRate': 'string',
                                'InstanceType': 'string',
                                'Platform': 'string',
                                'Region': 'string',
                                'Sku': 'string',
                                'Memory': 'string',
                                'NetworkPerformance': 'string',
                                'Storage': 'string',
                                'Vcpu': 'string'
                            }
                        },
                        'ExpectedResourceUtilization': {
                            'EC2ResourceUtilization': {
                                'MaxCpuUtilizationPercentage': 'string',
                                'MaxMemoryUtilizationPercentage': 'string',
                                'MaxStorageUtilizationPercentage': 'string',
                                'EBSResourceUtilization': {
                                    'EbsReadOpsPerSecond': 'string',
                                    'EbsWriteOpsPerSecond': 'string',
                                    'EbsReadBytesPerSecond': 'string',
                                    'EbsWriteBytesPerSecond': 'string'
                                },
                                'DiskResourceUtilization': {
                                    'DiskReadOpsPerSecond': 'string',
                                    'DiskWriteOpsPerSecond': 'string',
                                    'DiskReadBytesPerSecond': 'string',
                                    'DiskWriteBytesPerSecond': 'string'
                                },
                                'NetworkResourceUtilization': {
                                    'NetworkInBytesPerSecond': 'string',
                                    'NetworkOutBytesPerSecond': 'string',
                                    'NetworkPacketsInPerSecond': 'string',
                                    'NetworkPacketsOutPerSecond': 'string'
                                }
                            }
                        },
                        'PlatformDifferences': [
                            'HYPERVISOR'|'NETWORK_INTERFACE'|'STORAGE_INTERFACE'|'INSTANCE_STORE_AVAILABILITY'|'VIRTUALIZATION_TYPE',
                        ]
                    },
                ]
            },
            'TerminateRecommendationDetail': {
                'EstimatedMonthlySavings': 'string',
                'CurrencyCode': 'string'
            },
            'FindingReasonCodes': [
                'CPU_OVER_PROVISIONED'|'CPU_UNDER_PROVISIONED'|'MEMORY_OVER_PROVISIONED'|'MEMORY_UNDER_PROVISIONED'|'EBS_THROUGHPUT_OVER_PROVISIONED'|'EBS_THROUGHPUT_UNDER_PROVISIONED'|'EBS_IOPS_OVER_PROVISIONED'|'EBS_IOPS_UNDER_PROVISIONED'|'NETWORK_BANDWIDTH_OVER_PROVISIONED'|'NETWORK_BANDWIDTH_UNDER_PROVISIONED'|'NETWORK_PPS_OVER_PROVISIONED'|'NETWORK_PPS_UNDER_PROVISIONED'|'DISK_IOPS_OVER_PROVISIONED'|'DISK_IOPS_UNDER_PROVISIONED'|'DISK_THROUGHPUT_OVER_PROVISIONED'|'DISK_THROUGHPUT_UNDER_PROVISIONED',
            ]
        },
    ],
    'NextPageToken': 'string',
    'Configuration': {
        'RecommendationTarget': 'SAME_INSTANCE_FAMILY'|'CROSS_INSTANCE_FAMILY',
        'BenefitsConsidered': True|False
    }
}

Response Structure

  • (dict) --

    • Metadata (dict) --

      Information regarding this specific recommendation set.

      • RecommendationId (string) --

        The ID for this specific recommendation.

      • GenerationTimestamp (string) --

        The timestamp for when Amazon Web Services made this recommendation.

      • LookbackPeriodInDays (string) --

        The number of days of previous usage that Amazon Web Services considers when making this recommendation.

      • AdditionalMetadata (string) --

        Additional metadata that might be applicable to the recommendation.

    • Summary (dict) --

      Summary of this recommendation set.

      • TotalRecommendationCount (string) --

        The total number of instance recommendations.

      • EstimatedTotalMonthlySavingsAmount (string) --

        The estimated total savings resulting from modifications, on a monthly basis.

      • SavingsCurrencyCode (string) --

        The currency code that Amazon Web Services used to calculate the savings.

      • SavingsPercentage (string) --

        The savings percentage based on the recommended modifications. It's relative to the total On-Demand costs that are associated with these instances.

    • RightsizingRecommendations (list) --

      Recommendations to rightsize resources.

      • (dict) --

        Recommendations to rightsize resources.

        • AccountId (string) --

          The account that this recommendation is for.

        • CurrentInstance (dict) --

          Context regarding the current instance.

          • ResourceId (string) --

            Resource ID of the current instance.

          • InstanceName (string) --

            The name that you given an instance. This field shows as blank if you haven't given the instance a name.

          • Tags (list) --

            Cost allocation resource tags that are applied to the instance.

            • (dict) --

              The values that are available for a tag.

              If Values and Key aren't specified, the ABSENT MatchOption is applied to all tags. That is, it's filtered on resources with no tags.

              If Values is provided and Key isn't specified, the ABSENT MatchOption is applied to the tag Key only. That is, it's filtered on resources without the given tag key.

              • 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) --
          • ResourceDetails (dict) --

            Details about the resource and utilization.

            • EC2ResourceDetails (dict) --

              Details on the Amazon EC2 resource.

              • HourlyOnDemandRate (string) --

                The hourly public On-Demand rate for the instance type.

              • InstanceType (string) --

                The type of Amazon Web Services instance.

              • Platform (string) --

                The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.

              • Region (string) --

                The Amazon Web Services Region of the instance.

              • Sku (string) --

                The SKU of the product.

              • Memory (string) --

                The memory capacity of the Amazon Web Services instance.

              • NetworkPerformance (string) --

                The network performance capacity of the Amazon Web Services instance.

              • Storage (string) --

                The disk storage of the Amazon Web Services instance. This doesn't include EBS storage.

              • Vcpu (string) --

                The number of VCPU cores in the Amazon Web Services instance type.

          • ResourceUtilization (dict) --

            Utilization information of the current instance during the lookback period.

            • EC2ResourceUtilization (dict) --

              The utilization of current Amazon EC2 instance.

              • MaxCpuUtilizationPercentage (string) --

                The maximum observed or expected CPU utilization of the instance.

              • MaxMemoryUtilizationPercentage (string) --

                The maximum observed or expected memory utilization of the instance.

              • MaxStorageUtilizationPercentage (string) --

                The maximum observed or expected storage utilization of the instance. This doesn't include EBS storage.

              • EBSResourceUtilization (dict) --

                The EBS field that contains a list of EBS metrics that are associated with the current instance.

                • EbsReadOpsPerSecond (string) --

                  The maximum number of read operations per second.

                • EbsWriteOpsPerSecond (string) --

                  The maximum number of write operations per second.

                • EbsReadBytesPerSecond (string) --

                  The maximum size of read operations per second

                • EbsWriteBytesPerSecond (string) --

                  The maximum size of write operations per second.

              • DiskResourceUtilization (dict) --

                The field that contains a list of disk (local storage) metrics that are associated with the current instance.

                • DiskReadOpsPerSecond (string) --

                  The maximum number of read operations per second.

                • DiskWriteOpsPerSecond (string) --

                  The maximum number of write operations per second.

                • DiskReadBytesPerSecond (string) --

                  The maximum read throughput operations per second.

                • DiskWriteBytesPerSecond (string) --

                  The maximum write throughput operations per second.

              • NetworkResourceUtilization (dict) --

                The network field that contains a list of network metrics that are associated with the current instance.

                • NetworkInBytesPerSecond (string) --

                  The network inbound throughput utilization measured in Bytes per second.

                • NetworkOutBytesPerSecond (string) --

                  The network outbound throughput utilization measured in Bytes per second.

                • NetworkPacketsInPerSecond (string) --

                  The network ingress packets that are measured in packets per second.

                • NetworkPacketsOutPerSecond (string) --

                  The network outgress packets that are measured in packets per second.

          • ReservationCoveredHoursInLookbackPeriod (string) --

            The number of hours during the lookback period that's covered by reservations.

          • SavingsPlansCoveredHoursInLookbackPeriod (string) --

            The number of hours during the lookback period that's covered by Savings Plans.

          • OnDemandHoursInLookbackPeriod (string) --

            The number of hours during the lookback period that's billed at On-Demand rates.

          • TotalRunningHoursInLookbackPeriod (string) --

            The total number of hours that the instance ran during the lookback period.

          • MonthlyCost (string) --

            The current On-Demand cost of operating this instance on a monthly basis.

          • CurrencyCode (string) --

            The currency code that Amazon Web Services used to calculate the costs for this instance.

        • RightsizingType (string) --

          A recommendation to either terminate or modify the resource.

        • ModifyRecommendationDetail (dict) --

          The details for the modification recommendations.

          • TargetInstances (list) --

            Determines whether this instance type is the Amazon Web Services default recommendation.

            • (dict) --

              Details on recommended instance.

              • EstimatedMonthlyCost (string) --

                The expected cost to operate this instance type on a monthly basis.

              • EstimatedMonthlySavings (string) --

                The estimated savings that result from modification, on a monthly basis.

              • CurrencyCode (string) --

                The currency code that Amazon Web Services used to calculate the costs for this instance.

              • DefaultTargetInstance (boolean) --

                Determines whether this recommendation is the defaulted Amazon Web Services recommendation.

              • ResourceDetails (dict) --

                Details on the target instance type.

                • EC2ResourceDetails (dict) --

                  Details on the Amazon EC2 resource.

                  • HourlyOnDemandRate (string) --

                    The hourly public On-Demand rate for the instance type.

                  • InstanceType (string) --

                    The type of Amazon Web Services instance.

                  • Platform (string) --

                    The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.

                  • Region (string) --

                    The Amazon Web Services Region of the instance.

                  • Sku (string) --

                    The SKU of the product.

                  • Memory (string) --

                    The memory capacity of the Amazon Web Services instance.

                  • NetworkPerformance (string) --

                    The network performance capacity of the Amazon Web Services instance.

                  • Storage (string) --

                    The disk storage of the Amazon Web Services instance. This doesn't include EBS storage.

                  • Vcpu (string) --

                    The number of VCPU cores in the Amazon Web Services instance type.

              • ExpectedResourceUtilization (dict) --

                The expected utilization metrics for target instance type.

                • EC2ResourceUtilization (dict) --

                  The utilization of current Amazon EC2 instance.

                  • MaxCpuUtilizationPercentage (string) --

                    The maximum observed or expected CPU utilization of the instance.

                  • MaxMemoryUtilizationPercentage (string) --

                    The maximum observed or expected memory utilization of the instance.

                  • MaxStorageUtilizationPercentage (string) --

                    The maximum observed or expected storage utilization of the instance. This doesn't include EBS storage.

                  • EBSResourceUtilization (dict) --

                    The EBS field that contains a list of EBS metrics that are associated with the current instance.

                    • EbsReadOpsPerSecond (string) --

                      The maximum number of read operations per second.

                    • EbsWriteOpsPerSecond (string) --

                      The maximum number of write operations per second.

                    • EbsReadBytesPerSecond (string) --

                      The maximum size of read operations per second

                    • EbsWriteBytesPerSecond (string) --

                      The maximum size of write operations per second.

                  • DiskResourceUtilization (dict) --

                    The field that contains a list of disk (local storage) metrics that are associated with the current instance.

                    • DiskReadOpsPerSecond (string) --

                      The maximum number of read operations per second.

                    • DiskWriteOpsPerSecond (string) --

                      The maximum number of write operations per second.

                    • DiskReadBytesPerSecond (string) --

                      The maximum read throughput operations per second.

                    • DiskWriteBytesPerSecond (string) --

                      The maximum write throughput operations per second.

                  • NetworkResourceUtilization (dict) --

                    The network field that contains a list of network metrics that are associated with the current instance.

                    • NetworkInBytesPerSecond (string) --

                      The network inbound throughput utilization measured in Bytes per second.

                    • NetworkOutBytesPerSecond (string) --

                      The network outbound throughput utilization measured in Bytes per second.

                    • NetworkPacketsInPerSecond (string) --

                      The network ingress packets that are measured in packets per second.

                    • NetworkPacketsOutPerSecond (string) --

                      The network outgress packets that are measured in packets per second.

              • PlatformDifferences (list) --

                Explains the actions you might need to take in order to successfully migrate your workloads from the current instance type to the recommended instance type.

                • (string) --
        • TerminateRecommendationDetail (dict) --

          The details for termination recommendations.

          • EstimatedMonthlySavings (string) --

            The estimated savings that result from modification, on a monthly basis.

          • CurrencyCode (string) --

            The currency code that Amazon Web Services used to calculate the costs for this instance.

        • FindingReasonCodes (list) --

          The list of possible reasons why the recommendation is generated such as under or over utilization of specific metrics (for example, CPU, Memory, Network).

          • (string) --
    • NextPageToken (string) --

      The token to retrieve the next set of results.

    • Configuration (dict) --

      Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

      • RecommendationTarget (string) --

        The option to see recommendations within the same instance family or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY .

      • BenefitsConsidered (boolean) --

        The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE .

Exceptions

get_savings_plans_coverage(**kwargs)

Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:

  • LINKED_ACCOUNT
  • REGION
  • SERVICE
  • INSTANCE_FAMILY

To determine valid values for a dimension, use the GetDimensionValues operation.

See also: AWS API Documentation

Request Syntax

response = client.get_savings_plans_coverage(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    GroupBy=[
        {
            'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
            'Key': 'string'
        },
    ],
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    Metrics=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    SortBy={
        'Key': 'string',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    }
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

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

  • GroupBy (list) --

    You can group the data using the attributes INSTANCE_FAMILY , REGION , or SERVICE .

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

  • Granularity (string) --

    The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

    The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities.

  • Filter (dict) --

    Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

    • LINKED_ACCOUNT
    • REGION
    • SERVICE
    • INSTANCE_FAMILY
    GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

    Cost category is also supported.

    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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 (list) --

    The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans .

    • (string) --
  • NextToken (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 items to be returned in a response. The default is 20 , with a minimum value of 1 .
  • SortBy (dict) --

    The value by which you want to sort the data.

    The following values are supported for Key :

    • SpendCoveredBySavingsPlan
    • OnDemandCost
    • CoveragePercentage
    • TotalCost
    • InstanceFamily
    • Region
    • Service

    Supported values for SortOrder are ASCENDING or DESCENDING .

    • Key (string) -- [REQUIRED]

      The key that's used to sort the data.

    • SortOrder (string) --

      The order that's used to sort the data.

Return type

dict

Returns

Response Syntax

{
    'SavingsPlansCoverages': [
        {
            'Attributes': {
                'string': 'string'
            },
            'Coverage': {
                'SpendCoveredBySavingsPlans': 'string',
                'OnDemandCost': 'string',
                'TotalCost': 'string',
                'CoveragePercentage': 'string'
            },
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SavingsPlansCoverages (list) --

      The amount of spend that your Savings Plans covered.

      • (dict) --

        The amount of Savings Plans eligible usage that is covered by Savings Plans. All calculations consider the On-Demand equivalent of your Savings Plans usage.

        • Attributes (dict) --

          The attribute that applies to a specific Dimension .

          • (string) --
            • (string) --
        • Coverage (dict) --

          The amount of Savings Plans eligible usage that the Savings Plans covered.

          • SpendCoveredBySavingsPlans (string) --

            The amount of your Amazon Web Services usage that is covered by a Savings Plans.

          • OnDemandCost (string) --

            The cost of your Amazon Web Services usage at the public On-Demand rate.

          • TotalCost (string) --

            The total cost of your Amazon Web Services usage, regardless of your purchase option.

          • CoveragePercentage (string) --

            The percentage of your existing Savings Plans covered usage, divided by all of your eligible Savings Plans usage in an account (or set of accounts).

        • TimePeriod (dict) --

          The time period of the request.

          • Start (string) --

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

            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 .

    • NextToken (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

get_savings_plans_purchase_recommendation(**kwargs)

Retrieves your request parameters, Savings Plan Recommendations Summary and Details.

See also: AWS API Documentation

Request Syntax

response = client.get_savings_plans_purchase_recommendation(
    SavingsPlansType='COMPUTE_SP'|'EC2_INSTANCE_SP'|'SAGEMAKER_SP',
    TermInYears='ONE_YEAR'|'THREE_YEARS',
    PaymentOption='NO_UPFRONT'|'PARTIAL_UPFRONT'|'ALL_UPFRONT'|'LIGHT_UTILIZATION'|'MEDIUM_UTILIZATION'|'HEAVY_UTILIZATION',
    AccountScope='PAYER'|'LINKED',
    NextPageToken='string',
    PageSize=123,
    LookbackPeriodInDays='SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    }
)
Parameters
  • SavingsPlansType (string) --

    [REQUIRED]

    The Savings Plans recommendation type requested.

  • TermInYears (string) --

    [REQUIRED]

    The savings plan recommendation term used to generate these recommendations.

  • PaymentOption (string) --

    [REQUIRED]

    The payment option used to generate these recommendations.

  • AccountScope (string) -- The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER . If the value is LINKED , recommendations are calculated for individual member accounts only.
  • 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.
  • PageSize (integer) -- The number of recommendations that you want returned in a single response object.
  • LookbackPeriodInDays (string) --

    [REQUIRED]

    The lookback period used to generate the recommendation.

  • Filter (dict) --

    You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) for which you want to see Savings Plans purchase recommendations.

    For GetSavingsPlansPurchaseRecommendation, the Filter does not include CostCategories or Tags . It only includes Dimensions . With Dimensions , Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs for which you want to see Savings Plans Purchase Recommendations. AND and OR operators are not supported.

    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
Return type

dict

Returns

Response Syntax

{
    'Metadata': {
        'RecommendationId': 'string',
        'GenerationTimestamp': 'string',
        'AdditionalMetadata': 'string'
    },
    'SavingsPlansPurchaseRecommendation': {
        'AccountScope': 'PAYER'|'LINKED',
        'SavingsPlansType': 'COMPUTE_SP'|'EC2_INSTANCE_SP'|'SAGEMAKER_SP',
        'TermInYears': 'ONE_YEAR'|'THREE_YEARS',
        'PaymentOption': 'NO_UPFRONT'|'PARTIAL_UPFRONT'|'ALL_UPFRONT'|'LIGHT_UTILIZATION'|'MEDIUM_UTILIZATION'|'HEAVY_UTILIZATION',
        'LookbackPeriodInDays': 'SEVEN_DAYS'|'THIRTY_DAYS'|'SIXTY_DAYS',
        'SavingsPlansPurchaseRecommendationDetails': [
            {
                'SavingsPlansDetails': {
                    'Region': 'string',
                    'InstanceFamily': 'string',
                    'OfferingId': 'string'
                },
                'AccountId': 'string',
                'UpfrontCost': 'string',
                'EstimatedROI': 'string',
                'CurrencyCode': 'string',
                'EstimatedSPCost': 'string',
                'EstimatedOnDemandCost': 'string',
                'EstimatedOnDemandCostWithCurrentCommitment': 'string',
                'EstimatedSavingsAmount': 'string',
                'EstimatedSavingsPercentage': 'string',
                'HourlyCommitmentToPurchase': 'string',
                'EstimatedAverageUtilization': 'string',
                'EstimatedMonthlySavingsAmount': 'string',
                'CurrentMinimumHourlyOnDemandSpend': 'string',
                'CurrentMaximumHourlyOnDemandSpend': 'string',
                'CurrentAverageHourlyOnDemandSpend': 'string'
            },
        ],
        'SavingsPlansPurchaseRecommendationSummary': {
            'EstimatedROI': 'string',
            'CurrencyCode': 'string',
            'EstimatedTotalCost': 'string',
            'CurrentOnDemandSpend': 'string',
            'EstimatedSavingsAmount': 'string',
            'TotalRecommendationCount': 'string',
            'DailyCommitmentToPurchase': 'string',
            'HourlyCommitmentToPurchase': 'string',
            'EstimatedSavingsPercentage': 'string',
            'EstimatedMonthlySavingsAmount': 'string',
            'EstimatedOnDemandCostWithCurrentCommitment': 'string'
        }
    },
    'NextPageToken': 'string'
}

Response Structure

  • (dict) --

    • Metadata (dict) --

      Information regarding this specific recommendation set.

      • RecommendationId (string) --

        The unique identifier for the recommendation set.

      • GenerationTimestamp (string) --

        The timestamp showing when the recommendations were generated.

      • AdditionalMetadata (string) --

        Additional metadata that might be applicable to the recommendation.

    • SavingsPlansPurchaseRecommendation (dict) --

      Contains your request parameters, Savings Plan Recommendations Summary, and Details.

      • AccountScope (string) --

        The account scope that you want your recommendations for. Amazon Web Services calculates recommendations that include the management account and member accounts if the value is set to PAYER . If the value is LINKED , recommendations are calculated for individual member accounts only.

      • SavingsPlansType (string) --

        The requested Savings Plans recommendation type.

      • TermInYears (string) --

        The Savings Plans recommendation term in years. It's used to generate the recommendation.

      • PaymentOption (string) --

        The payment option used to generate the recommendation.

      • LookbackPeriodInDays (string) --

        The lookback period in days, used to generate the recommendation.

      • SavingsPlansPurchaseRecommendationDetails (list) --

        Details for the Savings Plans we recommend that you purchase to cover existing Savings Plans eligible workloads.

        • (dict) --

          Details for your recommended Savings Plans.

          • SavingsPlansDetails (dict) --

            Details for your recommended Savings Plans.

            • Region (string) --

              A collection of Amazon Web Services resources in a geographic area. Each Amazon Web Services Region is isolated and independent of the other Regions.

            • InstanceFamily (string) --

              A group of instance types that Savings Plans applies to.

            • OfferingId (string) --

              The unique ID that's used to distinguish Savings Plans from one another.

          • AccountId (string) --

            The AccountID the recommendation is generated for.

          • UpfrontCost (string) --

            The upfront cost of the recommended Savings Plans, based on the selected payment option.

          • EstimatedROI (string) --

            The estimated return on investment that's based on the recommended Savings Plans that you purchased. This is calculated as estimatedSavingsAmount / estimatedSPCost *100.

          • CurrencyCode (string) --

            The currency code that Amazon Web Services used to generate the recommendations and present potential savings.

          • EstimatedSPCost (string) --

            The cost of the recommended Savings Plans over the length of the lookback period.

          • EstimatedOnDemandCost (string) --

            The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the lookback period.

          • EstimatedOnDemandCostWithCurrentCommitment (string) --

            The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.

          • EstimatedSavingsAmount (string) --

            The estimated savings amount that's based on the recommended Savings Plans over the length of the lookback period.

          • EstimatedSavingsPercentage (string) --

            The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

          • HourlyCommitmentToPurchase (string) --

            The recommended hourly commitment level for the Savings Plans type and the configuration that's based on the usage during the lookback period.

          • EstimatedAverageUtilization (string) --

            The estimated utilization of the recommended Savings Plans.

          • EstimatedMonthlySavingsAmount (string) --

            The estimated monthly savings amount based on the recommended Savings Plans.

          • CurrentMinimumHourlyOnDemandSpend (string) --

            The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

          • CurrentMaximumHourlyOnDemandSpend (string) --

            The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

          • CurrentAverageHourlyOnDemandSpend (string) --

            The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

      • SavingsPlansPurchaseRecommendationSummary (dict) --

        Summary metrics for your Savings Plans Recommendations.

        • EstimatedROI (string) --

          The estimated return on investment that's based on the recommended Savings Plans and estimated savings.

        • CurrencyCode (string) --

          The currency code that Amazon Web Services used to generate the recommendations and present potential savings.

        • EstimatedTotalCost (string) --

          The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand usage.

        • CurrentOnDemandSpend (string) --

          The current total on demand spend of the applicable usage types over the lookback period.

        • EstimatedSavingsAmount (string) --

          The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.

        • TotalRecommendationCount (string) --

          The aggregate number of Savings Plans recommendations that exist for your account.

        • DailyCommitmentToPurchase (string) --

          The recommended Savings Plans cost on a daily (24 hourly) basis.

        • HourlyCommitmentToPurchase (string) --

          The recommended hourly commitment that's based on the recommendation parameters.

        • EstimatedSavingsPercentage (string) --

          The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated as estimatedSavingsAmount / CurrentOnDemandSpend *100.

        • EstimatedMonthlySavingsAmount (string) --

          The estimated monthly savings amount that's based on the recommended Savings Plans purchase.

        • EstimatedOnDemandCostWithCurrentCommitment (string) --

          The estimated On-Demand costs you would expect with no additional commitment. It's based on your usage of the selected time period and the Savings Plans you own.

    • NextPageToken (string) --

      The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Exceptions

get_savings_plans_utilization(**kwargs)

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

Note

You cannot group by any dimension values for GetSavingsPlansUtilization .

See also: AWS API Documentation

Request Syntax

response = client.get_savings_plans_utilization(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    SortBy={
        'Key': 'string',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    }
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

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

  • Granularity (string) --

    The granularity of the Amazon Web Services utillization data for your Savings Plans.

    The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

  • Filter (dict) --

    Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

    • LINKED_ACCOUNT
    • SAVINGS_PLAN_ARN
    • SAVINGS_PLANS_TYPE
    • REGION
    • PAYMENT_OPTION
    • INSTANCE_TYPE_FAMILY
    GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • SortBy (dict) --

    The value by which you want to sort the data.

    The following values are supported for Key :

    • UtilizationPercentage
    • TotalCommitment
    • UsedCommitment
    • UnusedCommitment
    • NetSavings

    Supported values for SortOrder are ASCENDING or DESCENDING .

    • Key (string) -- [REQUIRED]

      The key that's used to sort the data.

    • SortOrder (string) --

      The order that's used to sort the data.

Return type

dict

Returns

Response Syntax

{
    'SavingsPlansUtilizationsByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'Utilization': {
                'TotalCommitment': 'string',
                'UsedCommitment': 'string',
                'UnusedCommitment': 'string',
                'UtilizationPercentage': 'string'
            },
            'Savings': {
                'NetSavings': 'string',
                'OnDemandCostEquivalent': 'string'
            },
            'AmortizedCommitment': {
                'AmortizedRecurringCommitment': 'string',
                'AmortizedUpfrontCommitment': 'string',
                'TotalAmortizedCommitment': 'string'
            }
        },
    ],
    'Total': {
        'Utilization': {
            'TotalCommitment': 'string',
            'UsedCommitment': 'string',
            'UnusedCommitment': 'string',
            'UtilizationPercentage': 'string'
        },
        'Savings': {
            'NetSavings': 'string',
            'OnDemandCostEquivalent': 'string'
        },
        'AmortizedCommitment': {
            'AmortizedRecurringCommitment': 'string',
            'AmortizedUpfrontCommitment': 'string',
            'TotalAmortizedCommitment': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • SavingsPlansUtilizationsByTime (list) --

      The amount of cost/commitment you used your Savings Plans. This allows you to specify date ranges.

      • (dict) --

        The amount of Savings Plans utilization, in hours.

        • TimePeriod (dict) --

          The time period of the request.

          • Start (string) --

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

            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 .

        • Utilization (dict) --

          A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

          • TotalCommitment (string) --

            The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

          • UsedCommitment (string) --

            The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.

          • UnusedCommitment (string) --

            The amount of your Savings Plans commitment that wasn't consumed from Savings Plans eligible usage in a specific period.

          • UtilizationPercentage (string) --

            The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.

        • Savings (dict) --

          The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

          • NetSavings (string) --

            The savings amount that you're accumulating for the usage that's covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

          • OnDemandCostEquivalent (string) --

            How much the amount that the usage would have cost if it was accrued at the On-Demand rate.

        • AmortizedCommitment (dict) --

          The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

          • AmortizedRecurringCommitment (string) --

            The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront .

          • AmortizedUpfrontCommitment (string) --

            The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.

          • TotalAmortizedCommitment (string) --

            The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.

    • Total (dict) --

      The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.

      • Utilization (dict) --

        A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

        • TotalCommitment (string) --

          The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

        • UsedCommitment (string) --

          The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.

        • UnusedCommitment (string) --

          The amount of your Savings Plans commitment that wasn't consumed from Savings Plans eligible usage in a specific period.

        • UtilizationPercentage (string) --

          The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.

      • Savings (dict) --

        The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

        • NetSavings (string) --

          The savings amount that you're accumulating for the usage that's covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

        • OnDemandCostEquivalent (string) --

          How much the amount that the usage would have cost if it was accrued at the On-Demand rate.

      • AmortizedCommitment (dict) --

        The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

        • AmortizedRecurringCommitment (string) --

          The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront .

        • AmortizedUpfrontCommitment (string) --

          The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.

        • TotalAmortizedCommitment (string) --

          The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.

Exceptions

get_savings_plans_utilization_details(**kwargs)

Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization , but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

Note

GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn .

See also: AWS API Documentation

Request Syntax

response = client.get_savings_plans_utilization_details(
    TimePeriod={
        'Start': 'string',
        'End': '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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    DataType=[
        'ATTRIBUTES'|'UTILIZATION'|'AMORTIZED_COMMITMENT'|'SAVINGS',
    ],
    NextToken='string',
    MaxResults=123,
    SortBy={
        'Key': 'string',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    }
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

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

  • Filter (dict) --

    Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

    • LINKED_ACCOUNT
    • SAVINGS_PLAN_ARN
    • REGION
    • PAYMENT_OPTION
    • INSTANCE_TYPE_FAMILY
    GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.
    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • DataType (list) --

    The data type.

    • (string) --
  • NextToken (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 items to be returned in a response. The default is 20 , with a minimum value of 1 .
  • SortBy (dict) --

    The value by which you want to sort the data.

    The following values are supported for Key :

    • UtilizationPercentage
    • TotalCommitment
    • UsedCommitment
    • UnusedCommitment
    • NetSavings
    • AmortizedRecurringCommitment
    • AmortizedUpfrontCommitment

    Supported values for SortOrder are ASCENDING or DESCENDING .

    • Key (string) -- [REQUIRED]

      The key that's used to sort the data.

    • SortOrder (string) --

      The order that's used to sort the data.

Return type

dict

Returns

Response Syntax

{
    'SavingsPlansUtilizationDetails': [
        {
            'SavingsPlanArn': 'string',
            'Attributes': {
                'string': 'string'
            },
            'Utilization': {
                'TotalCommitment': 'string',
                'UsedCommitment': 'string',
                'UnusedCommitment': 'string',
                'UtilizationPercentage': 'string'
            },
            'Savings': {
                'NetSavings': 'string',
                'OnDemandCostEquivalent': 'string'
            },
            'AmortizedCommitment': {
                'AmortizedRecurringCommitment': 'string',
                'AmortizedUpfrontCommitment': 'string',
                'TotalAmortizedCommitment': 'string'
            }
        },
    ],
    'Total': {
        'Utilization': {
            'TotalCommitment': 'string',
            'UsedCommitment': 'string',
            'UnusedCommitment': 'string',
            'UtilizationPercentage': 'string'
        },
        'Savings': {
            'NetSavings': 'string',
            'OnDemandCostEquivalent': 'string'
        },
        'AmortizedCommitment': {
            'AmortizedRecurringCommitment': 'string',
            'AmortizedUpfrontCommitment': 'string',
            'TotalAmortizedCommitment': 'string'
        }
    },
    'TimePeriod': {
        'Start': 'string',
        'End': 'string'
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SavingsPlansUtilizationDetails (list) --

      Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

      • (dict) --

        A single daily or monthly Savings Plans utilization rate, and details for your account. A management account in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.

        • SavingsPlanArn (string) --

          The unique Amazon Resource Name (ARN) for a particular Savings Plan.

        • Attributes (dict) --

          The attribute that applies to a specific Dimension .

          • (string) --
            • (string) --
        • Utilization (dict) --

          A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

          • TotalCommitment (string) --

            The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

          • UsedCommitment (string) --

            The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.

          • UnusedCommitment (string) --

            The amount of your Savings Plans commitment that wasn't consumed from Savings Plans eligible usage in a specific period.

          • UtilizationPercentage (string) --

            The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.

        • Savings (dict) --

          The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

          • NetSavings (string) --

            The savings amount that you're accumulating for the usage that's covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

          • OnDemandCostEquivalent (string) --

            How much the amount that the usage would have cost if it was accrued at the On-Demand rate.

        • AmortizedCommitment (dict) --

          The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans fees.

          • AmortizedRecurringCommitment (string) --

            The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront .

          • AmortizedUpfrontCommitment (string) --

            The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.

          • TotalAmortizedCommitment (string) --

            The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.

    • Total (dict) --

      The total Savings Plans utilization, regardless of time period.

      • Utilization (dict) --

        A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

        • TotalCommitment (string) --

          The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

        • UsedCommitment (string) --

          The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.

        • UnusedCommitment (string) --

          The amount of your Savings Plans commitment that wasn't consumed from Savings Plans eligible usage in a specific period.

        • UtilizationPercentage (string) --

          The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.

      • Savings (dict) --

        The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

        • NetSavings (string) --

          The savings amount that you're accumulating for the usage that's covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

        • OnDemandCostEquivalent (string) --

          How much the amount that the usage would have cost if it was accrued at the On-Demand rate.

      • AmortizedCommitment (dict) --

        The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

        • AmortizedRecurringCommitment (string) --

          The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront .

        • AmortizedUpfrontCommitment (string) --

          The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.

        • TotalAmortizedCommitment (string) --

          The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.

    • TimePeriod (dict) --

      The time period of the request.

      • Start (string) --

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

        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 .

    • NextToken (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

get_tags(**kwargs)

Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

See also: AWS API Documentation

Request Syntax

response = client.get_tags(
    SearchString='string',
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    TagKey='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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    SortBy=[
        {
            'Key': 'string',
            'SortOrder': 'ASCENDING'|'DESCENDING'
        },
    ],
    MaxResults=123,
    NextPageToken='string'
)
Parameters
  • SearchString (string) -- The value that you want to search for.
  • TimePeriod (dict) --

    [REQUIRED]

    The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

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

  • TagKey (string) -- The key of the tag that you want to return values for.
  • Filter (dict) --

    Use Expression to filter by cost or by usage. There are two patterns:

    • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
    • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

    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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • SortBy (list) --

    The value by which you want to sort the data.

    The key represents cost and usage metrics. The following values are supported:

    • BlendedCost
    • UnblendedCost
    • AmortizedCost
    • NetAmortizedCost
    • NetUnblendedCost
    • UsageQuantity
    • NormalizedUsageAmount

    Supported values for SortOrder are ASCENDING or DESCENDING .

    When using SortBy , NextPageToken and SearchString are not supported.

    • (dict) --

      The details of how to sort the data.

      • Key (string) -- [REQUIRED]

        The key that's used to sort the data.

      • SortOrder (string) --

        The order that's used to sort the data.

  • MaxResults (integer) --

    This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

    For GetTags , MaxResults has an upper limit of 1000.

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

dict

Returns

Response Syntax

{
    'NextPageToken': 'string',
    'Tags': [
        'string',
    ],
    'ReturnSize': 123,
    'TotalSize': 123
}

Response Structure

  • (dict) --

    • NextPageToken (string) --

      The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

    • Tags (list) --

      The tags that match your request.

      • (string) --
    • ReturnSize (integer) --

      The number of query results that Amazon Web Services returns at a time.

    • TotalSize (integer) --

      The total number of query results.

Exceptions

get_usage_forecast(**kwargs)

Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.

See also: AWS API Documentation

Request Syntax

response = client.get_usage_forecast(
    TimePeriod={
        'Start': 'string',
        'End': 'string'
    },
    Metric='BLENDED_COST'|'UNBLENDED_COST'|'AMORTIZED_COST'|'NET_UNBLENDED_COST'|'NET_AMORTIZED_COST'|'USAGE_QUANTITY'|'NORMALIZED_USAGE_AMOUNT',
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    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',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        },
        'CostCategories': {
            'Key': 'string',
            'Values': [
                'string',
            ],
            'MatchOptions': [
                'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
            ]
        }
    },
    PredictionIntervalLevel=123
)
Parameters
  • TimePeriod (dict) --

    [REQUIRED]

    The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 . The start date must be equal to or later than the current date to avoid a validation error.

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

  • Metric (string) --

    [REQUIRED]

    Which metric Cost Explorer uses to create your forecast.

    Valid values for a GetUsageForecast call are the following:

    • USAGE_QUANTITY
    • NORMALIZED_USAGE_AMOUNT
  • Granularity (string) --

    [REQUIRED]

    How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

    The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

  • Filter (dict) --

    The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:

    • AZ
    • INSTANCE_TYPE
    • LINKED_ACCOUNT
    • LINKED_ACCOUNT_NAME
    • OPERATION
    • PURCHASE_TYPE
    • REGION
    • SERVICE
    • USAGE_TYPE
    • USAGE_TYPE_GROUP
    • RECORD_TYPE
    • OPERATING_SYSTEM
    • TENANCY
    • SCOPE
    • PLATFORM
    • SUBSCRIPTION_ID
    • LEGAL_ENTITY_NAME
    • DEPLOYMENT_OPTION
    • DATABASE_ENGINE
    • INSTANCE_TYPE_FAMILY
    • BILLING_ENTITY
    • RESERVATION_ID
    • SAVINGS_PLAN_ARN
    • Or (list) --

      Return results that match either Dimension object.

      • (dict) --

        Use Expression to filter by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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 by cost or by usage. There are two patterns:

        • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
        • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

        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.

      • 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. 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) --
  • PredictionIntervalLevel (integer) -- Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
Return type

dict

Returns

Response Syntax

{
    'Total': {
        'Amount': 'string',
        'Unit': 'string'
    },
    'ForecastResultsByTime': [
        {
            'TimePeriod': {
                'Start': 'string',
                'End': 'string'
            },
            'MeanValue': 'string',
            'PredictionIntervalLowerBound': 'string',
            'PredictionIntervalUpperBound': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Total (dict) --

      How much you're forecasted to use over the forecast period.

      • Amount (string) --

        The actual number that represents the metric.

      • Unit (string) --

        The unit that the metric is given in.

    • ForecastResultsByTime (list) --

      The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

      • (dict) --

        The forecast that's created for your query.

        • TimePeriod (dict) --

          The period of time that the forecast covers.

          • Start (string) --

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

            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 .

        • MeanValue (string) --

          The mean value of the forecast.

        • PredictionIntervalLowerBound (string) --

          The lower limit for the prediction interval.

        • PredictionIntervalUpperBound (string) --

          The upper limit for the prediction interval.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_cost_category_definitions(**kwargs)

Returns the name, ARN, NumberOfRules and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100.

See also: AWS API Documentation

Request Syntax

response = client.list_cost_category_definitions(
    EffectiveOn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • EffectiveOn (string) -- The date when the Cost Category was effective.
  • NextToken (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

{
    'CostCategoryReferences': [
        {
            'CostCategoryArn': 'string',
            'Name': 'string',
            'EffectiveStart': 'string',
            'EffectiveEnd': 'string',
            'NumberOfRules': 123,
            'ProcessingStatus': [
                {
                    'Component': 'COST_EXPLORER',
                    'Status': 'PROCESSING'|'APPLIED'
                },
            ],
            'Values': [
                'string',
            ],
            'DefaultValue': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CostCategoryReferences (list) --

      A reference to a Cost Category containing enough information to identify the Cost Category.

      • (dict) --

        A reference to a Cost Category containing only enough information to identify the Cost Category.

        You can use this information to retrieve the full Cost Category information using DescribeCostCategory .

        • CostCategoryArn (string) --

          The unique identifier for your Cost Category.

        • Name (string) --

          The unique name of the Cost Category.

        • EffectiveStart (string) --

          The Cost Category's effective start date.

        • EffectiveEnd (string) --

          The Cost Category's effective end date.

        • NumberOfRules (integer) --

          The number of rules that are associated with a specific Cost Category.

        • ProcessingStatus (list) --

          The list of processing statuses for Cost Management products for a specific cost category.

          • (dict) --

            The list of processing statuses for Cost Management products for a specific cost category.

            • Component (string) --

              The Cost Management product name of the applied status.

            • Status (string) --

              The process status for a specific cost category.

        • Values (list) --

          A list of unique cost category values in a specific cost category.

          • (string) --

            The default value for the cost category.

        • DefaultValue (string) --

          The default value for the cost category.

    • NextToken (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

provide_anomaly_feedback(**kwargs)

Modifies the feedback property of a given cost anomaly.

See also: AWS API Documentation

Request Syntax

response = client.provide_anomaly_feedback(
    AnomalyId='string',
    Feedback='YES'|'NO'|'PLANNED_ACTIVITY'
)
Parameters
  • AnomalyId (string) --

    [REQUIRED]

    A cost anomaly ID.

  • Feedback (string) --

    [REQUIRED]

    Describes whether the cost anomaly was a planned activity or you considered it an anomaly.

Return type

dict

Returns

Response Syntax

{
    'AnomalyId': 'string'
}

Response Structure

  • (dict) --

    • AnomalyId (string) --

      The ID of the modified cost anomaly.

Exceptions

update_anomaly_monitor(**kwargs)

Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn'tt change anomalies detected in the past.

See also: AWS API Documentation

Request Syntax

response = client.update_anomaly_monitor(
    MonitorArn='string',
    MonitorName='string'
)
Parameters
  • MonitorArn (string) --

    [REQUIRED]

    Cost anomaly monitor Amazon Resource Names (ARNs).

  • MonitorName (string) -- The new name for the cost anomaly monitor.
Return type

dict

Returns

Response Syntax

{
    'MonitorArn': 'string'
}

Response Structure

  • (dict) --

    • MonitorArn (string) --

      A cost anomaly monitor ARN.

Exceptions

update_anomaly_subscription(**kwargs)

Updates an existing cost anomaly monitor subscription.

See also: AWS API Documentation

Request Syntax

response = client.update_anomaly_subscription(
    SubscriptionArn='string',
    Threshold=123.0,
    Frequency='DAILY'|'IMMEDIATE'|'WEEKLY',
    MonitorArnList=[
        'string',
    ],
    Subscribers=[
        {
            'Address': 'string',
            'Type': 'EMAIL'|'SNS',
            'Status': 'CONFIRMED'|'DECLINED'
        },
    ],
    SubscriptionName='string'
)
Parameters
  • SubscriptionArn (string) --

    [REQUIRED]

    A cost anomaly subscription Amazon Resource Name (ARN).

  • Threshold (float) -- The update to the threshold value for receiving notifications.
  • Frequency (string) -- The update to the frequency value that subscribers receive notifications.
  • MonitorArnList (list) --

    A list of cost anomaly monitor ARNs.

    • (string) --
  • Subscribers (list) --

    The update to the subscriber list.

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

  • SubscriptionName (string) -- The new name of the subscription.
Return type

dict

Returns

Response Syntax

{
    'SubscriptionArn': 'string'
}

Response Structure

  • (dict) --

    • SubscriptionArn (string) --

      A cost anomaly subscription ARN.

Exceptions

update_cost_category_definition(**kwargs)

Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.

See also: AWS API Documentation

Request Syntax

response = client.update_cost_category_definition(
    CostCategoryArn='string',
    RuleVersion='CostCategoryExpression.v1',
    Rules=[
        {
            'Value': 'string',
            'Rule': {
                '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',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                },
                'Tags': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                },
                'CostCategories': {
                    'Key': 'string',
                    'Values': [
                        'string',
                    ],
                    'MatchOptions': [
                        'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE',
                    ]
                }
            },
            'InheritedValue': {
                'DimensionName': 'LINKED_ACCOUNT_NAME'|'TAG',
                'DimensionKey': 'string'
            },
            'Type': 'REGULAR'|'INHERITED_VALUE'
        },
    ],
    DefaultValue='string',
    SplitChargeRules=[
        {
            'Source': 'string',
            'Targets': [
                'string',
            ],
            'Method': 'FIXED'|'PROPORTIONAL'|'EVEN',
            'Parameters': [
                {
                    'Type': 'ALLOCATION_PERCENTAGES',
                    'Values': [
                        'string',
                    ]
                },
            ]
        },
    ]
)
Parameters
  • CostCategoryArn (string) --

    [REQUIRED]

    The unique identifier for your Cost Category.

  • RuleVersion (string) --

    [REQUIRED]

    The rule schema version in this particular Cost Category.

  • Rules (list) --

    [REQUIRED]

    The Expression object used to categorize costs. For more information, see CostCategoryRule .

    • (dict) --

      Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.

      • Value (string) --

        The default value for the cost category.

      • Rule (dict) --

        An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT , SERVICE_CODE , RECORD_TYPE , and LINKED_ACCOUNT_NAME .

        Root level OR isn't supported. We recommend that you create a separate rule instead.

        RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide .
        • Or (list) --

          Return results that match either Dimension object.

          • (dict) --

            Use Expression to filter by cost or by usage. There are two patterns:

            • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
            • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

            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 by cost or by usage. There are two patterns:

            • Simple dimension values - 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 Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
            • Compound dimension values 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 on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that 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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

            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.

          • 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. 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) --
      • InheritedValue (dict) --

        The value the line item is categorized as if the line item contains the matched dimension.

        • DimensionName (string) --

          The name of the dimension that's used to group costs.

          If you specify LINKED_ACCOUNT_NAME , the cost category value is based on account name. If you specify TAG , the cost category value will be based on the value of the specified tag key.

        • DimensionKey (string) --

          The key to extract cost category values.

      • Type (string) --

        You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE . The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension . For example, if you want to dynamically group costs based on the value of a specific tag key, first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

  • DefaultValue (string) -- The default value for the cost category.
  • SplitChargeRules (list) --

    The split charge rules used to allocate your charges between your Cost Category values.

    • (dict) --

      Use the split charge rule to split the cost of one Cost Category value across several other target values.

      • Source (string) -- [REQUIRED]

        The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.

      • Targets (list) -- [REQUIRED]

        The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.

        • (string) --
      • Method (string) -- [REQUIRED]

        The method that's used to define how to split your source costs across your targets.

        Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

        Fixed - Allocates charges across your targets based on your defined allocation percentage.

        >``Even`` - Allocates costs evenly across all targets.

      • Parameters (list) --

        The parameters for a split charge method. This is only required for the FIXED method.

        • (dict) --

          The parameters for a split charge method.

          • Type (string) -- [REQUIRED]

            The parameter type.

          • Values (list) -- [REQUIRED]

            The parameter values.

            • (string) --
Return type

dict

Returns

Response Syntax

{
    'CostCategoryArn': 'string',
    'EffectiveStart': 'string'
}

Response Structure

  • (dict) --

    • CostCategoryArn (string) --

      The unique identifier for your Cost Category.

    • EffectiveStart (string) --

      The Cost Category's effective start date.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class CostExplorer.Client.exceptions.BillExpirationException

The requested report expired. Update the date interval and try again.

Example

try:
  ...
except client.exceptions.BillExpirationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested report expired. Update the date interval and try again.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.DataUnavailableException

The requested data is unavailable.

Example

try:
  ...
except client.exceptions.DataUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested data is unavailable.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.InvalidNextTokenException

The pagination token is invalid. Try again without a pagination token.

Example

try:
  ...
except client.exceptions.InvalidNextTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The pagination token is invalid. Try again without a pagination token.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.LimitExceededException

You made too many calls in a short period of time. Try again later.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You made too many calls in a short period of time. Try again later.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.RequestChangedException

Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

Example

try:
  ...
except client.exceptions.RequestChangedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.ResourceNotFoundException

The specified ARN in the request doesn't exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified ARN in the request doesn't exist.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.ServiceQuotaExceededException

You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.UnknownMonitorException

The cost anomaly monitor does not exist for the account.

Example

try:
  ...
except client.exceptions.UnknownMonitorException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The cost anomaly monitor does not exist for the account.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.UnknownSubscriptionException

The cost anomaly subscription does not exist for the account.

Example

try:
  ...
except client.exceptions.UnknownSubscriptionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The cost anomaly subscription does not exist for the account.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CostExplorer.Client.exceptions.UnresolvableUsageUnitException

Cost Explorer was unable to identify the usage unit. Provide UsageType/UsageTypeGroup filter selections that contain matching units, for example: hours .

Example

try:
  ...
except client.exceptions.UnresolvableUsageUnitException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Cost Explorer was unable to identify the usage unit. Provide UsageType/UsageTypeGroup filter selections that contain matching units, for example: hours .

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: