Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateBillScenario

Creates a new bill scenario to model potential changes to Amazon usage and costs.

Request Syntax


{
   "clientToken": "string",
   "name": "string",
   "tags": { 
      "string" : "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.

clientToken

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

Type: String

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

Pattern: [\u0021-\u007E]+

Required: No

name

A descriptive name for the bill scenario.

Type: String

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

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

Required: Yes

tags

The tags to apply to the bill scenario.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\w\s:+=@/-]+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [\w\s:+=@/-]*

Required: No

Response Syntax


{
   "billInterval": { 
      "end": number,
      "start": number
   },
   "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 scenario.

Type: BillInterval object

createdAt

The timestamp when the bill scenario was created.

Type: Timestamp

expiresAt

The timestamp when the bill scenario will expire.

Type: Timestamp

failureMessage

An error message if the bill scenario creation failed.

Type: String

id

The unique identifier for the created bill scenario.

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 created bill scenario.

Type: String

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

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

status

The current status of the bill scenario.

Type: String

Valid Values: READY | LOCKED | FAILED | STALE

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

ConflictException

The request could not be processed because of conflict in the current state of the resource.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

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 Amazon support.

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

HTTP Status Code: 500

ServiceQuotaExceededException

The request would cause you to exceed your service quota.

quotaCode: The quota code that was exceeded.
resourceId: The identifier of the resource that exceeded quota.
resourceType: The type of the resource that exceeded quota.
serviceCode: The service code that exceeded quota.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

quotaCode: The quota code that exceeded the throttling limit.
retryAfterSeconds: The service code that exceeded the throttling limit. Retry your request, but if the problem persists, contact Amazon support.
serviceCode: The service code that exceeded the throttling limit.

HTTP Status Code: 400

ValidationException

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

fieldList: The list of fields that are invalid.
reason: The reason for the validation exception.

HTTP Status Code: 400