Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListCommitmentPurchaseAnalyses

Lists the commitment purchase analyses for your account.

Request Syntax


{
   "AnalysisIds": [ "string" ],
   "AnalysisStatus": "string",
   "NextPageToken": "string",
   "PageSize": number
}

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.

AnalysisIds

The analysis IDs associated with the commitment purchase analyses.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 600 items.

Length Constraints: Fixed length of 36.

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

Required: No

AnalysisStatus

The status of the analysis.

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 analyses that you want returned in a single response object.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Response Syntax


{
   "AnalysisSummaryList": [ 
      { 
         "AnalysisCompletionTime": "string",
         "AnalysisId": "string",
         "AnalysisStartedTime": "string",
         "AnalysisStatus": "string",
         "CommitmentPurchaseAnalysisConfiguration": { 
            "SavingsPlansPurchaseAnalysisConfiguration": { 
               "AccountId": "string",
               "AccountScope": "string",
               "AnalysisType": "string",
               "LookBackTimePeriod": { 
                  "End": "string",
                  "Start": "string"
               },
               "SavingsPlansToAdd": [ 
                  { 
                     "InstanceFamily": "string",
                     "OfferingId": "string",
                     "PaymentOption": "string",
                     "Region": "string",
                     "SavingsPlansCommitment": number,
                     "SavingsPlansType": "string",
                     "TermInYears": "string"
                  }
               ],
               "SavingsPlansToExclude": [ "string" ]
            }
         },
         "ErrorCode": "string",
         "EstimatedCompletionTime": "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.

AnalysisSummaryList

The list of analyses.

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