idle_recommendations

Creates, updates, deletes, gets or lists an idle_recommendations resource.

Overview

Name	idle_recommendations
Type	Resource
Id	aws.compute_optimizer.idle_recommendations

Fields

The following fields are returned by SELECT queries:

get_idle_recommendations

Name	Datatype	Description
errors	array	An array of objects that describe errors of the request.
idle_recommendations	array	An array of objects that describe the idle resource recommendations.
next_token	string	The token to advance to the next page of idle resource recommendations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_idle_recommendations	select	region		Returns idle resource recommendations. Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see Resource requirements in the Compute Optimizer User Guide
export_idle_recommendations	exec	region, s3DestinationConfig		Export optimization recommendations for your idle resources. Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (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 idle resource 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_idle_recommendations

Returns idle resource recommendations. Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see Resource requirements in the Compute Optimizer User Guide

SELECT
errors,
idle_recommendations,
next_token
FROM aws.compute_optimizer.idle_recommendations
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

export_idle_recommendations

Export optimization recommendations for your idle resources. Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (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 idle resource export job in progress per Amazon Web Services Region.

EXEC aws.compute_optimizer.idle_recommendations.export_idle_recommendations 
@region='{{ region }}' --required 
@@json=
'{
"accountIds": "{{ accountIds }}", 
"filters": "{{ filters }}", 
"fieldsToExport": "{{ fieldsToExport }}", 
"s3DestinationConfig": "{{ s3DestinationConfig }}", 
"fileFormat": "{{ fileFormat }}", 
"includeMemberAccounts": {{ includeMemberAccounts }}
}'
;