commitment_purchase_analysis
Creates, updates, deletes, gets or lists a commitment_purchase_analysis resource.
Overview
| Name | commitment_purchase_analysis |
| Type | Resource |
| Id | aws.ce.commitment_purchase_analysis |
Fields
The following fields are returned by SELECT queries:
- get_commitment_purchase_analysis
| Name | Datatype | Description |
|---|---|---|
analysis_completion_time | string | The completion time of the analysis. (pattern: <code>^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$</code>) |
analysis_details | object | Details about the analysis. |
analysis_id | string | The analysis ID that's associated with the commitment purchase analysis. (pattern: <code>^[\S\s]{8}-[\S\s]{4}-[\S\s]{4}-[\S\s]{4}-[\S\s]{12}$</code>) |
analysis_started_time | string | The start time of the analysis. (pattern: <code>^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$</code>) |
analysis_status | string | The status of the analysis. (SUCCEEDED, PROCESSING, FAILED) |
commitment_purchase_analysis_configuration | object | The configuration for the commitment purchase analysis. |
error_code | string | The error code used for the analysis. (NO_USAGE_FOUND, INTERNAL_FAILURE, INVALID_SAVINGS_PLANS_TO_ADD, INVALID_SAVINGS_PLANS_TO_EXCLUDE, INVALID_ACCOUNT_ID) |
estimated_completion_time | string | The estimated time for when the analysis will complete. (pattern: <code>^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_commitment_purchase_analysis | select | region | Retrieves a commitment purchase analysis result based on the AnalysisId. | |
start_commitment_purchase_analysis | exec | region, CommitmentPurchaseAnalysisConfiguration | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_commitment_purchase_analysis
Retrieves a commitment purchase analysis result based on the AnalysisId.
SELECT
analysis_completion_time,
analysis_details,
analysis_id,
analysis_started_time,
analysis_status,
commitment_purchase_analysis_configuration,
error_code,
estimated_completion_time
FROM aws.ce.commitment_purchase_analysis
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- start_commitment_purchase_analysis
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.
EXEC aws.ce.commitment_purchase_analysis.start_commitment_purchase_analysis
@region='{{ region }}' --required
@@json=
'{
"CommitmentPurchaseAnalysisConfiguration": "{{ CommitmentPurchaseAnalysisConfiguration }}"
}'
;