CostExplorer ¶

Table of Contents

CostExplorer
- Client
- Paginators

Client ¶

class CostExplorer.Client¶

A low-level client representing AWS Cost Explorer Service:

import boto3

client = boto3.client('ce')

These are the available methods:

can_paginate()
generate_presigned_url()
get_cost_and_usage()
get_cost_forecast()
get_dimension_values()
get_paginator()
get_reservation_coverage()
get_reservation_purchase_recommendation()
get_reservation_utilization()
get_tags()
get_waiter()

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.

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_cost_and_usage(**kwargs)¶

Retrieves cost and usage metrics 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. Master accounts in an organization in AWS Organizations have access to all member accounts.

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'|'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'|'CACHE_ENGINE'|'INSTANCE_TYPE_FAMILY'|'BILLING_ENTITY'|'RESERVATION_ID',
            'Values': [
                'string',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ]
        }
    },
    Metrics=[
        'string',
    ],
    GroupBy=[
        {
            'Type': 'DIMENSION'|'TAG',
            'Key': 'string'
        },
    ],
    NextPageToken='string'
)

Parameters

TimePeriod (dict) --
Sets the start and end dates for retrieving AWS 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 that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
- End (string) -- [REQUIRED]
  The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01 .
Granularity (string) -- Sets the AWS cost granularity to MONTHLY or DAILY . If Granularity isn't set, the response object doesn't include the Granularity , either MONTHLY or DAILY .
Filter (dict) --
Filters AWS 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 INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large . The Expression for that looks like this: { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } } 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. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"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" ] } }
- 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 INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large . The Expression for that looks like this: { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } } 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. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"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" ] } }
- 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.
    
    Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute , Amazon Elasticsearch Service , Amazon ElastiCache , Amazon Redshift , and Amazon Relational Database Service .
    - (string) --
- Tags (dict) --
  The specific Tag to use for Expression .
  - Key (string) --
    The key for a tag.
  - Values (list) --
    The specific value of a tag.
    - (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 into account the units. For example, if you aggregate usageQuantity across all of EC2, the results aren't meaningful because 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 GetCostAndUsage requests.
- (string) --
GroupBy (list) --
You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ , INSTANCE_TYPE , LEGAL_ENTITY_NAME , LINKED_ACCOUNT , OPERATION , PLATFORM , PURCHASE_TYPE , SERVICE , TAGS , TENANCY , and USAGE_TYPE .
- (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. AWS 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',
            '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
        },
    ]
}

Response Structure

(dict) --
- NextPageToken (string) --
  
  The token for the next set of retrievable results. AWS 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 is associated with a time period.
    - TimePeriod (dict) --
      
      The time period covered by a result.
      - Start (string) --
        
        The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
      - End (string) --
        
        The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS 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 are included in this time period.
      - (dict) --
        
        One level of grouped data within 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) --
      
      Whether this result is estimated.

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'|'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'|'CACHE_ENGINE'|'INSTANCE_TYPE_FAMILY'|'BILLING_ENTITY'|'RESERVATION_ID',
            'Values': [
                'string',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ]
        }
    },
    PredictionIntervalLevel=123
)

Parameters

TimePeriod (dict) --
[REQUIRED]

The period of time that you want the forecast to cover.
- Start (string) -- [REQUIRED]
  The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
- End (string) -- [REQUIRED]
  The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS 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:
- AmortizedCost
- BlendedCost
- NetAmortizedCost
- NetUnblendedCost
- UnblendedCost
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.
Filter (dict) --
The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.
- 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 INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large . The Expression for that looks like this: { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } } 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. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"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" ] } }
- 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 INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large . The Expression for that looks like this: { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } } 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. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"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" ] } }
- 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.
    
    Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute , Amazon Elasticsearch Service , Amazon ElastiCache , Amazon Redshift , and Amazon Relational Database Service .
    - (string) --
- Tags (dict) --
  The specific Tag to use for Expression .
  - Key (string) --
    The key for a tag.
  - Values (list) --
    The specific value of a tag.
    - (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 created for your query.
    - TimePeriod (dict) --
      
      The period of time that the forecast covers.
      - Start (string) --
        
        The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
      - End (string) --
        
        The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS 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.

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'|'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'|'CACHE_ENGINE'|'INSTANCE_TYPE_FAMILY'|'BILLING_ENTITY'|'RESERVATION_ID',
    Context='COST_AND_USAGE'|'RESERVATIONS',
    NextPageToken='string'
)

Parameters

SearchString (string) -- The value that you want to search the filter values 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 that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
- End (string) -- [REQUIRED]
  The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS 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 different a 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 EC2 instance. An example is m4.xlarge .
- LEGAL_ENTITY_NAME - The name of the organization that sells you AWS 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 AWS 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 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 AWS 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 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.
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 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 AWS ID of the member account.
- PLATFORM - The EC2 operating system. Examples are Windows or Linux.
- REGION - The AWS 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.
NextPageToken (string) -- The token to retrieve the next set of results. AWS 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 EC2 instance. An example is m4.xlarge .
  - LEGAL_ENTITY_NAME - The name of the organization that sells you AWS 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 AWS 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 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 AWS 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 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.
  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 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 AWS ID of the member account.
  - PLATFORM - The EC2 operating system. Examples are Windows or Linux.
  - REGION - The AWS 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.
  - (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 AWS returned at one time.
- TotalSize (integer) --
  
  The total number of search results.
- NextPageToken (string) --
  
  The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

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 allows 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 master account can see the coverage of the associated member accounts. 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',
            'Key': 'string'
        },
    ],
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    Filter={
        'Or': [
            {'... recursive ...'},
        ],
        'And': [
            {'... recursive ...'},
        ],
        'Not': {'... recursive ...'},
        'Dimensions': {
            'Key': 'AZ'|'INSTANCE_TYPE'|'LINKED_ACCOUNT'|'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'|'CACHE_ENGINE'|'INSTANCE_TYPE_FAMILY'|'BILLING_ENTITY'|'RESERVATION_ID',
            'Values': [
                'string',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ]
        }
    },
    NextPageToken='string'
)

Parameters

TimePeriod (dict) --
[REQUIRED]

The start and end dates of the period for which you want to retrieve data about reservation coverage. 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 that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
- End (string) -- [REQUIRED]
  The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS 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
- TAG
- 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 AWS 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 .
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.
- 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 INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large . The Expression for that looks like this: { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } } 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. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"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" ] } }
- 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 INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large . The Expression for that looks like this: { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } } 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. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"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" ] } }
- 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.
    
    Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute , Amazon Elasticsearch Service , Amazon ElastiCache , Amazon Redshift , and Amazon Relational Database Service .
    - (string) --
- Tags (dict) --
  The specific Tag to use for Expression .
  - Key (string) --
    The key for a tag.
  - Values (list) --
    The specific value of a tag.
    - (string) --
NextPageToken (string) -- The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

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'
                        }
                    }
                },
            ],
            'Total': {
                'CoverageHours': {
                    'OnDemandHours': 'string',
                    'ReservedHours': 'string',
                    'TotalRunningHours': 'string',
                    'CoverageHoursPercentage': 'string'
                }
            }
        },
    ],
    'Total': {
        'CoverageHours': {
            'OnDemandHours': 'string',
            'ReservedHours': 'string',
            'TotalRunningHours': 'string',
            'CoverageHoursPercentage': '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 over which this coverage was used.
      - Start (string) --
        
        The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
      - End (string) --
        
        The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01 .
    - Groups (list) --
      
      The groups of instances that are covered by a reservation.
      - (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 a reservation covered, in hours.
        
        OnDemandHours (string) --
        
        The number of instance running hours that are covered by On-Demand Instances.
        
        ReservedHours (string) --
        
        The number of instance running hours that are covered by reservations.
        
        TotalRunningHours (string) --
        
        The total instance usage, in hours.
        
        CoverageHoursPercentage (string) --
        
        The percentage of instance hours that are covered by a reservation.
    - Total (dict) --
      
      The total reservation coverage, in hours.
      - CoverageHours (dict) --
        
        The amount of instance usage that a reservation covered, in hours.
        
        OnDemandHours (string) --
        
        The number of instance running hours that are covered by On-Demand Instances.
        
        ReservedHours (string) --
        
        The number of instance running hours that are covered by reservations.
        
        TotalRunningHours (string) --
        
        The total instance usage, in hours.
        
        CoverageHoursPercentage (string) --
        
        The percentage of instance hours that are covered by a reservation.
- Total (dict) --
  
  The total amount of instance usage that is covered by a reservation.
  - CoverageHours (dict) --
    
    The amount of instance usage that a reservation covered, in hours.
    - OnDemandHours (string) --
      
      The number of instance running hours that are covered by On-Demand Instances.
    - ReservedHours (string) --
      
      The number of instance running hours that are covered by reservations.
    - TotalRunningHours (string) --
      
      The total instance usage, in hours.
    - CoverageHoursPercentage (string) --
      
      The percentage of instance hours that are covered by a reservation.
- NextPageToken (string) --
  
  The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

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.

AWS 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 AWS 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, AWS automatically aggregates your 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. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS 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',
    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.
AccountScope (string) --
The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.

Valid values are PAYER and LINKED .
LookbackPeriodInDays (string) -- The number of previous days that you want AWS 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 EC2 instances.
- EC2Specification (dict) --
  The EC2 hardware specifications that you want AWS to provide recommendations for.
  - OfferingClass (string) --
    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 time stamp for when AWS made this recommendation.
- Recommendations (list) --
  
  Recommendations for reservations to purchase.
  - (dict) --
    
    A specific reservation that AWS recommends for purchase.
    - AccountScope (string) --
      
      The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.
    - LookbackPeriodInDays (string) --
      
      How many days of previous usage that AWS 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 EC2 hardware specifications that you want AWS to provide recommendations for.
        
        OfferingClass (string) --
        
        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) --
        
        InstanceDetails (dict) --
        
        Details about the instances that AWS recommends that you purchase.
        
        EC2InstanceDetails (dict) --
        
        The EC2 instances that AWS recommends that you purchase.
        
        Family (string) --
        
        The instance family of the recommended reservation.
        
        InstanceType (string) --
        
        The type of instance that AWS recommends.
        
        Region (string) --
        
        The AWS 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) --
        
        Whether the recommended reservation is dedicated or shared.
        
        CurrentGeneration (boolean) --
        
        Whether the recommendation is for a current generation instance.
        
        SizeFlexEligible (boolean) --
        
        Whether the recommended reservation is size flexible.
        
        RDSInstanceDetails (dict) --
        
        The RDS instances that AWS recommends that you purchase.
        
        Family (string) --
        
        The instance family of the recommended reservation.
        
        InstanceType (string) --
        
        The type of instance that AWS recommends.
        
        Region (string) --
        
        The AWS 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) --
        
        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) --
        
        Whether the recommendation is for a current generation instance.
        
        SizeFlexEligible (boolean) --
        
        Whether the recommended reservation is size flexible.
        
        RedshiftInstanceDetails (dict) --
        
        The Amazon Redshift instances that AWS recommends that you purchase.
        
        Family (string) --
        
        The instance family of the recommended reservation.
        
        NodeType (string) --
        
        The type of node that AWS recommends.
        
        Region (string) --
        
        The AWS Region of the recommended reservation.
        
        CurrentGeneration (boolean) --
        
        Whether the recommendation is for a current generation instance.
        
        SizeFlexEligible (boolean) --
        
        Whether the recommended reservation is size flexible.
        
        ElastiCacheInstanceDetails (dict) --
        
        The ElastiCache instances that AWS recommends that you purchase.
        
        Family (string) --
        
        The instance family of the recommended reservation.
        
        NodeType (string) --
        
        The type of node that AWS recommends.
        
        Region (string) --
        
        The AWS Region of the recommended reservation.
        
        ProductDescription (string) --
        
        The description of the recommended reservation.
        
        CurrentGeneration (boolean) --
        
        Whether the recommendation is for a current generation instance.
        
        SizeFlexEligible (boolean) --
        
        Whether the recommended reservation is size flexible.
        
        ESInstanceDetails (dict) --
        
        The Amazon ES instances that AWS recommends that you purchase.
        
        InstanceClass (string) --
        
        The class of instance that AWS recommends.
        
        InstanceSize (string) --
        
        The size of instance that AWS recommends.
        
        Region (string) --
        
        The AWS Region of the recommended reservation.
        
        CurrentGeneration (boolean) --
        
        Whether the recommendation is for a current generation instance.
        
        SizeFlexEligible (boolean) --
        
        Whether the recommended reservation is size flexible.
        
        RecommendedNumberOfInstancesToPurchase (string) --
        
        The number of instances that AWS recommends that you purchase.
        
        RecommendedNormalizedUnitsToPurchase (string) --
        
        The number of normalized units that AWS recommends that you purchase.
        
        MinimumNumberOfInstancesUsedPerHour (string) --
        
        The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
        
        MinimumNormalizedUnitsUsedPerHour (string) --
        
        The minimum number of hours that you used in an hour during the historical period. AWS 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. AWS 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. AWS 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. AWS 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. AWS uses this to calculate your recommended reservation purchases.
        
        AverageUtilization (string) --
        
        The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.
        
        EstimatedBreakEvenInMonths (string) --
        
        How long AWS estimates that it takes for this instance to start saving you money, in months.
        
        CurrencyCode (string) --
        
        The currency code that AWS used to calculate the costs for this instance.
        
        EstimatedMonthlySavingsAmount (string) --
        
        How much AWS estimates that this specific recommendation could save you in a month.
        
        EstimatedMonthlySavingsPercentage (string) --
        
        How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.
        
        EstimatedMonthlyOnDemandCost (string) --
        
        How much AWS estimates that you spend on On-Demand Instances in a month.
        
        EstimatedReservationCostForLookbackPeriod (string) --
        
        How much AWS estimates that you would have spent for all usage during the specified historical period if you had 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 AWS estimates that this recommendation could save you in a month.
      - TotalEstimatedMonthlySavingsPercentage (string) --
        
        The total amount that AWS 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.

get_reservation_utilization(**kwargs)¶

Retrieves the reservation utilization for your account. Master accounts 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',
            'Key': 'string'
        },
    ],
    Granularity='DAILY'|'MONTHLY'|'HOURLY',
    Filter={
        'Or': [
            {'... recursive ...'},
        ],
        'And': [
            {'... recursive ...'},
        ],
        'Not': {'... recursive ...'},
        'Dimensions': {
            'Key': 'AZ'|'INSTANCE_TYPE'|'LINKED_ACCOUNT'|'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'|'CACHE_ENGINE'|'INSTANCE_TYPE_FAMILY'|'BILLING_ENTITY'|'RESERVATION_ID',
            'Values': [
                'string',
            ]
        },
        'Tags': {
            'Key': 'string',
            'Values': [
                'string',
            ]
        }
    },
    NextPageToken='string'
)

Parameters

TimePeriod (dict) --
[REQUIRED]

Sets the start and end dates for retrieving Reserved Instance (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 that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
- End (string) -- [REQUIRED]
  The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS 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 .
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
- 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 INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large . The Expression for that looks like this: { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } } 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. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"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" ] } }
- 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 INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large . The Expression for that looks like this: { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } } 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. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"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" ] } }
- 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.
    
    Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute , Amazon Elasticsearch Service , Amazon ElastiCache , Amazon Redshift , and Amazon Relational Database Service .
    - (string) --
- Tags (dict) --
  The specific Tag to use for Expression .
  - Key (string) --
    The key for a tag.
  - Values (list) --
    The specific value of a tag.
    - (string) --
NextPageToken (string) -- The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Return type

dict

Returns

Response Syntax

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

Response Structure

(dict) --
- UtilizationsByTime (list) --
  
  The amount of time that you utilized your RIs.
  - (dict) --
    
    The amount of utilization, in hours.
    - TimePeriod (dict) --
      
      The period of time over which this utilization was used.
      - Start (string) --
        
        The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
      - End (string) --
        
        The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01 .
    - Groups (list) --
      
      The groups that are included in this utilization result.
      - (dict) --
        
        A group of Reserved Instances (RIs) that share a set of attributes.
        
        Key (string) --
        
        The key for a specific RI attribute.
        
        Value (string) --
        
        The value of a specific RI attribute.
        
        Attributes (dict) --
        
        The attributes for this group of RIs.
        
        (string) --
        
        (string) --
        
        Utilization (dict) --
        
        How much you used this group of RIs.
        
        UtilizationPercentage (string) --
        
        The percentage of RI time that you used.
        
        PurchasedHours (string) --
        
        How many RI hours that you purchased.
        
        TotalActualHours (string) --
        
        The total number of RI hours that you used.
        
        UnusedHours (string) --
        
        The number of RI hours that you didn't use.
        
        OnDemandCostOfRIHoursUsed (string) --
        
        How much your RIs would cost if charged On-Demand rates.
        
        NetRISavings (string) --
        
        How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .
        
        TotalPotentialRISavings (string) --
        
        How much you could save if you use your entire reservation.
        
        AmortizedUpfrontFee (string) --
        
        The upfront cost of your RI, amortized over the RI period.
        
        AmortizedRecurringFee (string) --
        
        The monthly cost of your RI, amortized over the RI period.
        
        TotalAmortizedFee (string) --
        
        The total cost of your RI, amortized over the RI period.
    - Total (dict) --
      
      The total number of RI hours that were used.
      - UtilizationPercentage (string) --
        
        The percentage of RI time that you used.
      - PurchasedHours (string) --
        
        How many RI hours that you purchased.
      - TotalActualHours (string) --
        
        The total number of RI hours that you used.
      - UnusedHours (string) --
        
        The number of RI hours that you didn't use.
      - OnDemandCostOfRIHoursUsed (string) --
        
        How much your RIs would cost if charged On-Demand rates.
      - NetRISavings (string) --
        
        How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .
      - TotalPotentialRISavings (string) --
        
        How much you could save if you use your entire reservation.
      - AmortizedUpfrontFee (string) --
        
        The upfront cost of your RI, amortized over the RI period.
      - AmortizedRecurringFee (string) --
        
        The monthly cost of your RI, amortized over the RI period.
      - TotalAmortizedFee (string) --
        
        The total cost of your RI, amortized over the RI period.
- Total (dict) --
  
  The total amount of time that you utilized your RIs.
  - UtilizationPercentage (string) --
    
    The percentage of RI time that you used.
  - PurchasedHours (string) --
    
    How many RI hours that you purchased.
  - TotalActualHours (string) --
    
    The total number of RI hours that you used.
  - UnusedHours (string) --
    
    The number of RI hours that you didn't use.
  - OnDemandCostOfRIHoursUsed (string) --
    
    How much your RIs would cost if charged On-Demand rates.
  - NetRISavings (string) --
    
    How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .
  - TotalPotentialRISavings (string) --
    
    How much you could save if you use your entire reservation.
  - AmortizedUpfrontFee (string) --
    
    The upfront cost of your RI, amortized over the RI period.
  - AmortizedRecurringFee (string) --
    
    The monthly cost of your RI, amortized over the RI period.
  - TotalAmortizedFee (string) --
    
    The total cost of your RI, amortized over the RI period.
- NextPageToken (string) --
  
  The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

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',
    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 that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
- End (string) -- [REQUIRED]
  The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS 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.
NextPageToken (string) -- The token to retrieve the next set of results. AWS 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. AWS 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 AWS returns at a time.
- TotalSize (integer) --
  
  The total number of query results.

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

Paginators ¶

The available paginators are:

Navigation

Table Of Contents

CostExplorer¶

Client¶

Paginators¶

Navigation

CostExplorer ¶

Client ¶

Paginators ¶