ebs_volume_recommendations
Creates, updates, deletes, gets or lists an ebs_volume_recommendations resource.
Overview
| Name | ebs_volume_recommendations |
| Type | Resource |
| Id | aws.compute_optimizer.ebs_volume_recommendations |
Fields
The following fields are returned by SELECT queries:
- get_ebs_volume_recommendations
| Name | Datatype | Description |
|---|---|---|
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 volume. |
next_token | string | The token to use to advance to the next page of volume recommendations. This value is null when there are no more pages of volume recommendations to return. |
volume_recommendations | array | An array of objects that describe volume recommendations. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_ebs_volume_recommendations | select | region | Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations. Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. | |
export_ebs_volume_recommendations | exec | region, s3DestinationConfig | Exports optimization recommendations for Amazon EBS volumes. 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 Amazon EBS volume 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_ebs_volume_recommendations
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations. Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
SELECT
errors,
next_token,
volume_recommendations
FROM aws.compute_optimizer.ebs_volume_recommendations
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- export_ebs_volume_recommendations
Exports optimization recommendations for Amazon EBS volumes. 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 Amazon EBS volume export job in progress per Amazon Web Services Region.
EXEC aws.compute_optimizer.ebs_volume_recommendations.export_ebs_volume_recommendations
@region='{{ region }}' --required
@@json=
'{
"accountIds": "{{ accountIds }}",
"filters": "{{ filters }}",
"fieldsToExport": "{{ fieldsToExport }}",
"s3DestinationConfig": "{{ s3DestinationConfig }}",
"fileFormat": "{{ fileFormat }}",
"includeMemberAccounts": {{ includeMemberAccounts }}
}'
;