recommended_actions

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

Overview

Name	recommended_actions
Type	Resource
Id	aws.compute_optimizer_automation.recommended_actions

Fields

The following fields are returned by SELECT queries:

list_recommended_actions

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID that owns the resource. (pattern: <code>[0-9]{12}</code>)
current_resource_details	object	Detailed configuration information for a specific Amazon Web Services resource, with type-specific details.
current_resource_summary	string	A summary of the resource's current configuration.
estimated_monthly_savings	object	Contains information about estimated monthly cost savings.
look_back_period_in_days	integer	The number of days of historical data used to generate the recommendation.
recommended_action_id	string	The unique identifier of the recommended action. (pattern: <code>[0-9A-Za-z]{16}</code>)
recommended_action_type	string	Recommended action type enumeration (SnapshotAndDeleteUnattachedEbsVolume, UpgradeEbsVolumeType)
recommended_resource_details	object	Detailed configuration information for a specific Amazon Web Services resource, with type-specific details.
recommended_resource_summary	string	A summary of the resource's recommended configuration.
region	string	The Amazon Web Services Region where the resource is located.
resource_arn	string	The Amazon Resource Name (ARN) of the resource that the recommendation applies to. (pattern: <code>arn:aws[a-z0-9-]:[a-z0-9-]+:[a-z0-9-]:[0-9]{0,12}:[a-zA-Z0-9/_.-]+</code>)
resource_id	string	The ID of the resource that the recommendation applies to. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
resource_tags	array	The tags associated with the resource.
resource_type	string	The type of resource being evaluated. (EbsVolume)
restart_needed	boolean	Indicates whether implementing the recommended action requires a resource restart.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_recommended_actions	select	region		Lists the recommended actions based that match specified filters. Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts.
start_automation_event	exec	region, recommendedActionId		Initiates a one-time, on-demand automation for the specified recommended action. Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using AssociateAccounts.

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

list_recommended_actions

Lists the recommended actions based that match specified filters. Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts.

SELECT
account_id,
current_resource_details,
current_resource_summary,
estimated_monthly_savings,
look_back_period_in_days,
recommended_action_id,
recommended_action_type,
recommended_resource_details,
recommended_resource_summary,
region,
resource_arn,
resource_id,
resource_tags,
resource_type,
restart_needed
FROM aws.compute_optimizer_automation.recommended_actions
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

start_automation_event

Initiates a one-time, on-demand automation for the specified recommended action. Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using AssociateAccounts.

EXEC aws.compute_optimizer_automation.recommended_actions.start_automation_event 
@region='{{ region }}' --required 
@@json=
'{
"recommendedActionId": "{{ recommendedActionId }}", 
"clientToken": "{{ clientToken }}"
}'
;