GetCostAndUsageWithResources - AWS Cost Explorer Service

GetCostAndUsageWithResources

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

Note

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

Request Syntax

{ "Filter": { "And": [ "Expression" ], "CostCategories": { "Key": "string", "Values": [ "string" ] }, "Dimensions": { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] }, "Not": "Expression", "Or": [ "Expression" ], "Tags": { "Key": "string", "MatchOptions": [ "string" ], "Values": [ "string" ] } }, "Granularity": "string", "GroupBy": [ { "Key": "string", "Type": "string" } ], "Metrics": [ "string" ], "NextPageToken": "string", "TimePeriod": { "End": "string", "Start": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filter

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

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

Type: Expression object

Required: Yes

Granularity

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

Type: String

Valid Values: DAILY | MONTHLY | HOURLY

Required: No

GroupBy

You can group Amazon Web Services costs using up to two different groups: either dimensions, tag keys, or both.

Type: Array of GroupDefinition objects

Required: No

Metrics

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

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

Note

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

Metrics is required for GetCostAndUsageWithResources requests.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\S\s]*

Required: No

NextPageToken

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [\S\s]*

Required: No

TimePeriod

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

Type: DateInterval object

Required: Yes

Response Syntax

{ "GroupDefinitions": [ { "Key": "string", "Type": "string" } ], "NextPageToken": "string", "ResultsByTime": [ { "Estimated": boolean, "Groups": [ { "Keys": [ "string" ], "Metrics": { "string" : { "Amount": "string", "Unit": "string" } } } ], "TimePeriod": { "End": "string", "Start": "string" }, "Total": { "string" : { "Amount": "string", "Unit": "string" } } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GroupDefinitions

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

Type: Array of GroupDefinition objects

NextPageToken

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [\S\s]*

ResultsByTime

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

Type: Array of ResultByTime objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BillExpirationException

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

HTTP Status Code: 400

DataUnavailableException

The requested data is unavailable.

HTTP Status Code: 400

InvalidNextTokenException

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

HTTP Status Code: 400

LimitExceededException

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

HTTP Status Code: 400

RequestChangedException

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

HTTP Status Code: 400

Example

The following is a sample request and response of the GetCostAndUsageWithResources operation that enables you to retrieve your Amazon EC2 costs. For more complex examples, such as multi-level groupings, see Expression.

Sample Request

POST / HTTP/1.1 Host: ce.us-east-1.amazonaws.com x-amz-Date: <Date> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: AWSInsightsIndexService.GetCostAndUsageWithResources { "TimePeriod": { "Start":"2018-11-19", "End": "2018-11-20" }, "Granularity": "DAILY", "Filter": { "Dimensions": { "Key": "SERVICE", "Values": [ "Amazon Elastic Compute Cloud - Compute" ] } }, "GroupBy":[ { "Type":"DIMENSION", "Key":"RESOURCE_ID" } ], "Metrics":["BlendedCost", "UnblendedCost", "UsageQuantity"] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "GroupDefinitions": [ { "Key": "RESOURCE_ID", "Type": "DIMENSION" } ], "ResultsByTime": [ { "Estimated": true, "Groups": [ { "Keys": [ "i-00cb32c5f3163" ], "Metrics": { "BlendedCost": { "Amount": "0.0927335232", "Unit": "USD" }, "UnblendedCost": { "Amount": "0.1276", "Unit": "USD" }, "UsageQuantity": { "Amount": "24.0010557602", "Unit": "N/A" } } }, { "Keys": [ "i-04a0089019f41" ], "Metrics": { "BlendedCost": { "Amount": "0.1656", "Unit": "USD" }, "UnblendedCost": { "Amount": "0.1656", "Unit": "USD" }, "UsageQuantity": { "Amount": "24.0018044403", "Unit": "N/A" } } }, { "Keys": [ "i-03b49bda9fdef" ], "Metrics": { "BlendedCost": { "Amount": "0.0927335232", "Unit": "USD" }, "UnblendedCost": { "Amount": "0.0116", "Unit": "USD" }, "UsageQuantity": { "Amount": "24.0009345564", "Unit": "N/A" } } }, { "Keys": [ "i-0e56e09d11711" ], "Metrics": { "BlendedCost": { "Amount": "0.0927335232", "Unit": "USD" }, "UnblendedCost": { "Amount": "0.1392", "Unit": "USD" }, "UsageQuantity": { "Amount": "24.0011066563", "Unit": "N/A" } } } ], "TimePeriod": { "End": "2018-11-20T00:00:00Z", "Start": "2018-11-19T00:00:00Z" }, "Total": {} } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: