license_recommendations

Creates, updates, deletes, gets or lists a license_recommendations resource.

Overview

Name	license_recommendations
Type	Resource
Id	aws.compute_optimizer.license_recommendations

Fields

The following fields are returned by SELECT queries:

get_license_recommendations

Name	Datatype	Description
errors	array	An array of objects that describe errors of the request.
license_recommendations	array	An array of objects that describe license recommendations.
next_token	string	The token to use to advance to the next page of license recommendations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_license_recommendations	select	region		Returns license recommendations for Amazon EC2 instances that run on a specific license. Compute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
export_license_recommendations	exec	region, s3DestinationConfig		Export optimization recommendations for your licenses. 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 license 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_license_recommendations

Returns license recommendations for Amazon EC2 instances that run on a specific license. Compute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

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

Lifecycle Methods

export_license_recommendations

Export optimization recommendations for your licenses. 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 license export job in progress per Amazon Web Services Region.

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