GetBillEstimate - AWS Billing and Cost Management

GetBillEstimate

Retrieves details of a specific bill estimate.

Request Syntax

{ "identifier": "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.

identifier

The unique identifier of the bill estimate to retrieve.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

Response Syntax

{ "billInterval": { "end": number, "start": number }, "costSummary": { "serviceCostDifferences": { "string" : { "estimatedCost": { "amount": number, "currency": "string" }, "historicalCost": { "amount": number, "currency": "string" } } }, "totalCostDifference": { "estimatedCost": { "amount": number, "currency": "string" }, "historicalCost": { "amount": number, "currency": "string" } } }, "createdAt": number, "expiresAt": number, "failureMessage": "string", "id": "string", "name": "string", "status": "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.

billInterval

The time period covered by the bill estimate.

Type: BillInterval object

costSummary

A summary of the estimated costs.

Type: BillEstimateCostSummary object

createdAt

The timestamp when the bill estimate was created.

Type: Timestamp

expiresAt

The timestamp when the bill estimate will expire.

Type: Timestamp

failureMessage

An error message if the bill estimate retrieval failed.

Type: String

id

The unique identifier of the retrieved bill estimate.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name

The name of the retrieved bill estimate.

Type: String

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

Pattern: [a-zA-Z0-9-]+

status

The current status of the bill estimate.

Type: String

Valid Values: IN_PROGRESS | COMPLETE | FAILED

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

DataUnavailableException

The requested data is currently unavailable.

HTTP Status Code: 400

InternalServerException

An internal error has occurred. Retry your request, but if the problem persists, contact AWS support.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input provided fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

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