Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListBillScenarios

Lists all bill scenarios for the account.

Request Syntax


{
   "createdAtFilter": { 
      "afterTimestamp": number,
      "beforeTimestamp": number
   },
   "expiresAtFilter": { 
      "afterTimestamp": number,
      "beforeTimestamp": number
   },
   "filters": [ 
      { 
         "matchOption": "string",
         "name": "string",
         "values": [ "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.

createdAtFilter

Filter bill scenarios based on the creation date.

Type: FilterTimestamp object

Required: No

expiresAtFilter

Filter bill scenarios based on the expiration date.

Type: FilterTimestamp object

Required: No

filters

Filters to apply to the list of bill scenarios.

Type: Array of ListBillScenariosFilter objects

Required: No

maxResults

The maximum number of results to return per page.

Type: Integer

Valid Range: 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": [ 
      { 
         "billInterval": { 
            "end": number,
            "start": number
         },
         "createdAt": number,
         "expiresAt": number,
         "failureMessage": "string",
         "id": "string",
         "name": "string",
         "status": "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 bill scenarios for the account.

Type: Array of BillScenarioSummary 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.

HTTP Status Code: 500

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