DescribeSavingsPlans - AWS Savings Plans

DescribeSavingsPlans

Describes the specified Savings Plans.

Request Syntax

POST /DescribeSavingsPlans HTTP/1.1 Content-type: application/json { "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string", "savingsPlanArns": [ "string" ], "savingsPlanIds": [ "string" ], "states": [ "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 SavingsPlanFilter 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

savingsPlanArns

The Amazon Resource Names (ARN) of the Savings Plans.

Type: Array of strings

Array Members: Maximum number of 100 items.

Pattern: arn:aws:[a-z]+:([a-z]{2}-[a-z]+-\d{1}|):(\d{12}):savingsplan\/([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})$

Required: No

savingsPlanIds

The IDs of the Savings Plans.

Type: Array of strings

Required: No

states

The states.

Type: Array of strings

Valid Values: payment-pending | payment-failed | active | retired

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "savingsPlans": [ { "commitment": "string", "currency": "string", "description": "string", "ec2InstanceFamily": "string", "end": "string", "offeringId": "string", "paymentOption": "string", "productTypes": [ "string" ], "recurringPaymentAmount": "string", "region": "string", "savingsPlanArn": "string", "savingsPlanId": "string", "savingsPlanType": "string", "start": "string", "state": "string", "tags": { "string" : "string" }, "termDurationInSeconds": number, "upfrontPaymentAmount": "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/=\+]+$

savingsPlans

Information about the Savings Plans.

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

See Also

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