automation_events

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

Overview

Name	automation_events
Type	Resource
Id	aws.compute_optimizer_automation.automation_events

Fields

The following fields are returned by SELECT queries:

get_automation_event

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID associated with the automation event. (pattern: <code>[0-9]{12}</code>)
completed_timestamp	string (date-time)	The timestamp when the automation event completed.
created_timestamp	string (date-time)	The timestamp when the automation event was created.
estimated_monthly_savings	object	Contains information about estimated monthly cost savings.
event_description	string	A description of the automation event.
event_id	string	The ID of the automation event to retrieve. (pattern: <code>[0-9A-Za-z]{16}</code>)
event_status	string	The current status of the automation event. (Ready, InProgress, Complete, Failed, Cancelled, RollbackReady, RollbackInProgress, RollbackComplete, RollbackFailed)
event_status_reason	string	The reason for the current event status.
event_type	string	The type of automation event. (SnapshotAndDeleteUnattachedEbsVolume, UpgradeEbsVolumeType)
recommended_action_id	string	The ID of the recommended action associated with this automation event. (pattern: <code>[0-9A-Za-z]{16}</code>)
region	string	The Amazon Web Services Region where the automation event occurred.
resource_arn	string	The Amazon Resource Name (ARN) of the resource affected by the automation event. (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 affected by the automation event. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
resource_type	string	The type of resource affected by the automation event. (EbsVolume)
rule_id	string	The ID of the automation rule that triggered this event. (pattern: <code>[0-9A-Za-z]{16}</code>)

list_automation_events

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID associated with the automation event. (pattern: <code>[0-9]{12}</code>)
completed_timestamp	string (date-time)	The timestamp when the automation event completed.
created_timestamp	string (date-time)	The timestamp when the automation event was created.
estimated_monthly_savings	object	Contains information about estimated monthly cost savings.
event_description	string	A description of the automation event.
event_id	string	The unique identifier for the automation event. (pattern: <code>[0-9A-Za-z]{16}</code>)
event_status	string	The current status of the automation event. (Ready, InProgress, Complete, Failed, Cancelled, RollbackReady, RollbackInProgress, RollbackComplete, RollbackFailed)
event_status_reason	string	The reason for the current event status.
event_type	string	The type of automation event. (SnapshotAndDeleteUnattachedEbsVolume, UpgradeEbsVolumeType)
recommended_action_id	string	The ID of the recommended action associated with this automation event. (pattern: <code>[0-9A-Za-z]{16}</code>)
region	string	The Amazon Web Services Region where the automation event occurred.
resource_arn	string	The Amazon Resource Name (ARN) of the resource affected by the automation event. (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 affected by the automation event. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
resource_type	string	The type of resource affected by the automation event. (EbsVolume)
rule_id	string	The ID of the automation rule that triggered this event. (pattern: <code>[0-9A-Za-z]{16}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_automation_event	select	region		Retrieves details about a specific automation event.
list_automation_events	select	region		Lists automation events based on specified filters. You can retrieve events that were created within the past year.

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_automation_event

Retrieves details about a specific automation event.

SELECT
account_id,
completed_timestamp,
created_timestamp,
estimated_monthly_savings,
event_description,
event_id,
event_status,
event_status_reason,
event_type,
recommended_action_id,
region,
resource_arn,
resource_id,
resource_type,
rule_id
FROM aws.compute_optimizer_automation.automation_events
WHERE region = '{{ region }}' -- required
;

list_automation_events

Lists automation events based on specified filters. You can retrieve events that were created within the past year.

SELECT
account_id,
completed_timestamp,
created_timestamp,
estimated_monthly_savings,
event_description,
event_id,
event_status,
event_status_reason,
event_type,
recommended_action_id,
region,
resource_arn,
resource_id,
resource_type,
rule_id
FROM aws.compute_optimizer_automation.automation_events
WHERE region = '{{ region }}' -- required
;