Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListBillEstimateCommitments

Lists the commitments associated with a bill estimate.

Request Syntax


{
   "billEstimateId": "string",
   "maxResults": number,
   "nextToken": "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.

billEstimateId

The unique identifier of the bill estimate to list commitments for.

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

maxResults

The maximum number of results to return per page.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 25.

Required: No

nextToken

A token to retrieve the next page of results.

Type: String

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

Pattern: [\S\s]*

Required: No

Response Syntax


{
   "items": [ 
      { 
         "id": "string",
         "monthlyPayment": { 
            "amount": number,
            "currency": "string"
         },
         "offeringId": "string",
         "paymentOption": "string",
         "purchaseAgreementType": "string",
         "region": "string",
         "termLength": "string",
         "upfrontPayment": { 
            "amount": number,
            "currency": "string"
         },
         "usageAccountId": "string"
      }
   ],
   "nextToken": "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.

items

The list of commitments associated with the bill estimate.

Type: Array of BillEstimateCommitmentSummary objects

nextToken

A token to retrieve the next page of results, if any.

Type: String

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

Pattern: [\S\s]*

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.

retryAfterSeconds: 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.

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

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 AWS 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 AWS service.

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

HTTP Status Code: 400