Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSavingsPlansPurchaseRecommendationGeneration

Retrieves a list of your historical recommendation generations within the past 30 days.

Request Syntax


{
   "GenerationStatus": "string",
   "NextPageToken": "string",
   "PageSize": number,
   "RecommendationIds": [ "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.

GenerationStatus

The status of the recommendation generation.

Type: String

Valid Values: SUCCEEDED | PROCESSING | FAILED

Required: No

NextPageToken

The token to retrieve the next set of results.

Type: String

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

Pattern: [\S\s]*

Required: No

PageSize

The number of recommendations that you want returned in a single response object.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

RecommendationIds

The IDs for each specific recommendation.

Type: Array of strings

Length Constraints: Fixed length of 36.

Pattern: ^[\S\s]{8}-[\S\s]{4}-[\S\s]{4}-[\S\s]{4}-[\S\s]{12}$

Required: No

Response Syntax


{
   "GenerationSummaryList": [ 
      { 
         "EstimatedCompletionTime": "string",
         "GenerationCompletionTime": "string",
         "GenerationStartedTime": "string",
         "GenerationStatus": "string",
         "RecommendationId": "string"
      }
   ],
   "NextPageToken": "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.

GenerationSummaryList

The list of historical recommendation generations.

Type: Array of GenerationSummary objects

NextPageToken

The token to retrieve the next set of results.

Type: String

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

Pattern: [\S\s]*

Errors

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

DataUnavailableException

The requested data is unavailable.

HTTP Status Code: 400

InvalidNextTokenException

The pagination token is invalid. Try again without a pagination token.

HTTP Status Code: 400

LimitExceededException

You made too many calls in a short period of time. Try again later.

HTTP Status Code: 400