savings_plans_purchase_recommendations
Creates, updates, deletes, gets or lists a savings_plans_purchase_recommendations resource.
Overview
| Name | savings_plans_purchase_recommendations |
| Type | Resource |
| Id | aws.ce.savings_plans_purchase_recommendations |
Fields
The following fields are returned by SELECT queries:
- get_savings_plans_purchase_recommendation
| Name | Datatype | Description |
|---|---|---|
metadata | object | Information that regards this specific recommendation set. |
next_page_token | string | The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. (pattern: <code>[\S\s]*</code>) |
savings_plans_purchase_recommendation | object | Contains your request parameters, Savings Plan Recommendations Summary, and Details. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_savings_plans_purchase_recommendation | select | region | Retrieves the Savings Plans recommendations for your account. First use StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them. | |
start_savings_plans_purchase_recommendation_generation | exec | region | Requests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family. StartSavingsPlansPurchaseRecommendationGeneration has no request syntax because no input parameters are needed to support this operation. |
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_savings_plans_purchase_recommendation
Retrieves the Savings Plans recommendations for your account. First use StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them.
SELECT
metadata,
next_page_token,
savings_plans_purchase_recommendation
FROM aws.ce.savings_plans_purchase_recommendations
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- start_savings_plans_purchase_recommendation_generation
Requests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family. StartSavingsPlansPurchaseRecommendationGeneration has no request syntax because no input parameters are needed to support this operation.
EXEC aws.ce.savings_plans_purchase_recommendations.start_savings_plans_purchase_recommendation_generation
@region='{{ region }}' --required
;