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"
}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.
- AnalysisCompletionTime
-
The completion 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)$ - AnalysisDetails
-
Details about the analysis.
Type: AnalysisDetails object
- 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)$ - AnalysisStatus
-
The status of the analysis.
Type: String
Valid Values:
SUCCEEDED | PROCESSING | FAILED - CommitmentPurchaseAnalysisConfiguration
-
The configuration for the commitment purchase analysis.
Type: CommitmentPurchaseAnalysisConfiguration object
- ErrorCode
-
The error code used for the analysis.
Type: String
Valid Values:
NO_USAGE_FOUND | INTERNAL_FAILURE | INVALID_SAVINGS_PLANS_TO_ADD | INVALID_SAVINGS_PLANS_TO_EXCLUDE | INVALID_ACCOUNT_ID - 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.
- AnalysisNotFoundException
-
The requested analysis can't be found.
HTTP Status Code: 400
- DataUnavailableException
-
The requested data is unavailable.
HTTP Status Code: 400
- LimitExceededException
-
You made too many calls in a short period of time. Try again later.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
