Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCommitmentPurchaseAnalysis

Retrieves a commitment purchase analysis result based on the AnalysisId.

Request Syntax


{
   "AnalysisId": "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.

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}$

Required: Yes

Response Syntax


{
   "AnalysisCompletionTime": "string",
   "AnalysisDetails": { 
      "SavingsPlansPurchaseAnalysisDetails": { 
         "AdditionalMetadata": "string",
         "CurrencyCode": "string",
         "CurrentAverageCoverage": "string",
         "CurrentAverageHourlyOnDemandSpend": "string",
         "CurrentMaximumHourlyOnDemandSpend": "string",
         "CurrentMinimumHourlyOnDemandSpend": "string",
         "CurrentOnDemandSpend": "string",
         "EstimatedAverageCoverage": "string",
         "EstimatedAverageUtilization": "string",
         "EstimatedCommitmentCost": "string",
         "EstimatedMonthlySavingsAmount": "string",
         "EstimatedOnDemandCost": "string",
         "EstimatedOnDemandCostWithCurrentCommitment": "string",
         "EstimatedROI": "string",
         "EstimatedSavingsAmount": "string",
         "EstimatedSavingsPercentage": "string",
         "ExistingHourlyCommitment": "string",
         "HourlyCommitmentToPurchase": "string",
         "LatestUsageTimestamp": "string",
         "LookbackPeriodInHours": "string",
         "MetricsOverLookbackPeriod": [ 
            { 
               "CurrentCoverage": "string",
               "EstimatedCoverage": "string",
               "EstimatedNewCommitmentUtilization": "string",
               "EstimatedOnDemandCost": "string",
               "StartTime": "string"
            }
         ],
         "UpfrontCost": "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"
}