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'|'INVOICING_ENTITY'|'ANOMALY_TOTAL_IMPACT_ABSOLUTE'|'ANOMALY_TOTAL_IMPACT_PERCENTAGE',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
]
},
'Tags': {
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
]
},
'CostCategories': {
'Key': 'string',
'Values': [
'string',
],
'MatchOptions': [
'EQUALS'|'ABSENT'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CASE_SENSITIVE'|'CASE_INSENSITIVE'|'GREATER_THAN_OR_EQUAL',
]
}
},
Metrics=[
'string',
],
GroupBy=[
{
'Type': 'DIMENSION'|'TAG'|'COST_CATEGORY',
'Key': 'string'
},
],
NextPageToken='string'
)
[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 .
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.
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 .
[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 .
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.
Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE .
Valid values for MatchOptions for CostCategories and Tags are EQUALS , ABSENT , and CASE_SENSITIVE . Default values are EQUALS and CASE_SENSITIVE .
Return results that match either Dimension object.
Use Expression to filter in various Cost Explorer APIs.
Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.
There are two patterns:
CostCategories , Tags , and Dimensions .CostCategories field to define a filter that acts on Cost Categories.Tags field to define a filter that acts on Cost Allocation Tags.Dimensions field to define a filter that acts on the DimensionValues.REGION==us-east-1 OR REGION==us-west-1 . For GetRightsizingRecommendation , the Region is a full name (for example, REGION==US East (N. Virginia) .Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }OR when applying the filter.Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }Expression types with logical operations.Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) .Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }Note
Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
Note
For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE .
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT .
Return results that match both Dimension objects.
Use Expression to filter in various Cost Explorer APIs.
Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.
There are two patterns:
CostCategories , Tags , and Dimensions .CostCategories field to define a filter that acts on Cost Categories.Tags field to define a filter that acts on Cost Allocation Tags.Dimensions field to define a filter that acts on the DimensionValues.REGION==us-east-1 OR REGION==us-west-1 . For GetRightsizingRecommendation , the Region is a full name (for example, REGION==US East (N. Virginia) .Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }OR when applying the filter.Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }Expression types with logical operations.Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) .Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }Note
Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
Note
For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE .
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT .
Return results that don't match a Dimension object.
The specific Dimension to use for Expression .
The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.
Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.
LINK_ACCOUNT_NAMEandSERVICE_CODEcan only be used in CostCategoryRule.
ANOMALY_TOTAL_IMPACT_ABSOLUTEandANOMALY_TOTAL_IMPACT_PERCENTAGEcan only be used in AnomalySubscriptions.
The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
The match options that you can use to filter your results.
MatchOptionsis only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.
The default values for MatchOptions are EQUALS and CASE_SENSITIVE .
The specific Tag to use for Expression .
The key for the tag.
The specific value of the tag.
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 .
The filter that's based on CostCategory values.
The unique name of the Cost Category.
The specific value of the Cost Category.
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 .
[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 theUsageQuantitymetric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregateusageQuantityacross 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 meaningfulUsageQuantitymetrics, filter byUsageTypeorUsageTypeGroups.
Metrics is required for GetCostAndUsage requests.
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 , INVOICING_ENTITY , 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.
Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.
The string that represents the type of group.
The string that represents a key for a specified group.
dict
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.
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 .
Exceptions
CostExplorer.Client.exceptions.LimitExceededExceptionCostExplorer.Client.exceptions.BillExpirationExceptionCostExplorer.Client.exceptions.DataUnavailableExceptionCostExplorer.Client.exceptions.InvalidNextTokenExceptionCostExplorer.Client.exceptions.RequestChangedException