Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartCommitmentPurchaseAnalysis

Specifies the parameters of a planned commitment purchase and starts the generation of the analysis. This enables you to estimate the cost, coverage, and utilization impact of your planned commitment purchases.

Request Syntax


{
   "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" ]
      }
   }
}

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.

CommitmentPurchaseAnalysisConfiguration

The configuration for the commitment purchase analysis.

Type: CommitmentPurchaseAnalysisConfiguration object

Required: Yes

Response Syntax


{
   "AnalysisId": "string",
   "AnalysisStartedTime": "string",
   "EstimatedCompletionTime": "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.

AnalysisId

The analysis ID that's associated with the commitment purchase analysis.

Type: String

Length Constraints: Fixed length of 36.

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

AnalysisStartedTime

The start time of the analysis.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 25.

Pattern: ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$

EstimatedCompletionTime

The estimated time for when the analysis will complete.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 25.

Pattern: ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$

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

GenerationExistsException

A request to generate a recommendation or analysis is already in progress.

HTTP Status Code: 400

LimitExceededException

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

HTTP Status Code: 400

ServiceQuotaExceededException

You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

HTTP Status Code: 400