auto_scaling_group_recommendations
Creates, updates, deletes, gets or lists an auto_scaling_group_recommendations resource.
Overview
| Name | auto_scaling_group_recommendations |
| Type | Resource |
| Id | aws.compute_optimizer.auto_scaling_group_recommendations |
Fields
The following fields are returned by SELECT queries:
- get_auto_scaling_group_recommendations
| Name | Datatype | Description |
|---|---|---|
auto_scaling_group_recommendations | array | An array of objects that describe Auto Scaling group recommendations. |
errors | array | An array of objects that describe errors of the request. For example, an error is returned if you request recommendations for an unsupported Auto Scaling group. |
next_token | string | The token to use to advance to the next page of Auto Scaling group recommendations. This value is null when there are no more pages of Auto Scaling group recommendations to return. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_auto_scaling_group_recommendations | select | region | Returns Auto Scaling group recommendations. Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. | |
export_auto_scaling_group_recommendations | exec | region, s3DestinationConfig | Exports optimization recommendations for Auto Scaling groups. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Auto Scaling group export job in progress per Amazon Web Services Region. |
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_auto_scaling_group_recommendations
Returns Auto Scaling group recommendations. Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
SELECT
auto_scaling_group_recommendations,
errors,
next_token
FROM aws.compute_optimizer.auto_scaling_group_recommendations
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- export_auto_scaling_group_recommendations
Exports optimization recommendations for Auto Scaling groups. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.
EXEC aws.compute_optimizer.auto_scaling_group_recommendations.export_auto_scaling_group_recommendations
@region='{{ region }}' --required
@@json=
'{
"accountIds": "{{ accountIds }}",
"filters": "{{ filters }}",
"fieldsToExport": "{{ fieldsToExport }}",
"s3DestinationConfig": "{{ s3DestinationConfig }}",
"fileFormat": "{{ fileFormat }}",
"includeMemberAccounts": {{ includeMemberAccounts }},
"recommendationPreferences": "{{ recommendationPreferences }}"
}'
;