Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeSavingsPlansOfferings

Describes the offerings for the specified Savings Plans.

Request Syntax


POST /DescribeSavingsPlansOfferings HTTP/1.1
Content-type: application/json

{
   "currencies": [ "string" ],
   "descriptions": [ "string" ],
   "durations": [ number ],
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "offeringIds": [ "string" ],
   "operations": [ "string" ],
   "paymentOptions": [ "string" ],
   "planTypes": [ "string" ],
   "productType": "string",
   "serviceCodes": [ "string" ],
   "usageTypes": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

currencies

The currencies.

Type: Array of strings

Valid Values: CNY | USD

Required: No

descriptions

The descriptions.

Type: Array of strings

Pattern: ^[a-zA-Z0-9_\- ]+$

Required: No

durations

The duration, in seconds.

Type: Array of longs

Valid Range: Minimum value of 0.

Required: No

filters

The filters.

Type: Array of SavingsPlanOfferingFilterElement objects

Required: No

maxResults

The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

Type: Integer

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

Required: No

nextToken

The token for the next page of results.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^[A-Za-z0-9/=\+]+$

Required: No

offeringIds

The IDs of the offerings.

Type: Array of strings

Pattern: [a-f0-9]+(-[a-f0-9]+)*

Required: No

operations

The specific AWS operation for the line item in the billing report.

Type: Array of strings

Length Constraints: Maximum length of 255.

Pattern: ^[a-zA-Z0-9_ \/.:-]*$

Required: No

paymentOptions

The payment options.

Type: Array of strings

Valid Values: All Upfront | Partial Upfront | No Upfront

Required: No

planTypes

The plan types.

Type: Array of strings

Valid Values: Compute | EC2Instance | SageMaker

Required: No

productType

The product type.

Type: String

Valid Values: EC2 | Fargate | Lambda | SageMaker

Required: No

serviceCodes

The services.

Type: Array of strings

Length Constraints: Maximum length of 255.

Pattern: ^[a-zA-Z]+$

Required: No

usageTypes

The usage details of the line item in the billing report.

Type: Array of strings

Length Constraints: Maximum length of 255.

Pattern: ^[a-zA-Z0-9_ \/.:-]+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "searchResults": [ 
      { 
         "currency": "string",
         "description": "string",
         "durationSeconds": number,
         "offeringId": "string",
         "operation": "string",
         "paymentOption": "string",
         "planType": "string",
         "productTypes": [ "string" ],
         "properties": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "serviceCode": "string",
         "usageType": "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.

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^[A-Za-z0-9/=\+]+$

searchResults

Information about the Savings Plans offerings.

Type: Array of SavingsPlanOffering objects

Errors

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

InternalServerException

An unexpected error occurred.

HTTP Status Code: 500

ValidationException

One of the input parameters is not valid.

HTTP Status Code: 400