Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1436232180.1 KB

Create a Bill estimate from a Bill scenario. In the Bill scenario you can model usage addition, usage changes, and usage removal. You can also model commitment addition and commitment removal. After all changes in a Bill scenario is made satisfactorily, you can call this API with a Bill scenario ID to generate the Bill estimate. Bill estimate calculates the pre-tax cost for your consolidated billing family, incorporating all modeled usage and commitments alongside existing usage and commitments from your most recent completed anniversary bill, with any applicable discounts applied.

post/#X-Amz-Target=AWSBCMPricingCalculator.CreateBillEstimate

Headers

X-Amz-Target'AWSBCMPricingCalculator.CreateBillEstimate' required

Request body

billScenarioIdstring required

The ID of the Bill Scenario for which you want to create a Bill estimate.

namestring required

The name of the Bill estimate that will be created. Names must be unique for an account.

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

tagsobject
<p> An optional list of tags to associate with the specified BillEstimate. You can use resource tags to control access to your BillEstimate using IAM policies. Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags: </p> <ul> <li> <p>Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services. </p> </li> <li> <p>The maximum length of a key is 128 characters.</p> </li> <li> <p>The maximum length of a value is 256 characters.</p> </li> <li> <p>Keys and values can only contain alphanumeric characters, spaces, and any of the following: <code>_.:/=+@-</code>.</p> </li> <li> <p>Keys and values are case sensitive.</p> </li> <li> <p>Keys and values are trimmed for any leading or trailing whitespaces.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for your keys. This prefix is reserved for Amazon Web Services.</p> </li> </ul>

Response

Success

idstring required

The unique identifier of your newly created Bill estimate.

namestring

The name of your newly created Bill estimate.

status'IN_PROGRESS' | 'COMPLETE' | 'FAILED'

The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

failureMessagestring

This attribute provides the reason if a Bill estimate result generation fails.

createdAtstring date-time

The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

expiresAtstring date-time

The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

groupSharingPreference'OPEN' | 'PRIORITIZED' | 'RESTRICTED'

The setting for the reserved instance and savings plan group sharing used in this estimate.

costCategoryGroupSharingPreferenceArnstring

The arn of the cost category used in the reserved and prioritized group sharing.

costCategoryGroupSharingPreferenceEffectiveDatestring date-time

Timestamp of the effective date of the cost category used in the group sharing settings.