DescribeSavingsPlanRates - AWS Savings Plans

DescribeSavingsPlanRates

Describes the specified Savings Plans rates.

Request Syntax

POST /DescribeSavingsPlanRates HTTP/1.1 Content-type: application/json { "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string", "savingsPlanId": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

The filters.

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

savingsPlanId

The ID of the Savings Plan.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "savingsPlanId": "string", "searchResults": [ { "currency": "string", "operation": "string", "productType": "string", "properties": [ { "name": "string", "value": "string" } ], "rate": "string", "serviceCode": "string", "unit": "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/=\+]+$

savingsPlanId

The ID of the Savings Plan.

Type: String

searchResults

Information about the Savings Plans rates.

Type: Array of SavingsPlanRate objects

Errors

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ValidationException

One of the input parameters is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: