Skip to content

aws.ssm.describe_automation_executions

Example SQL Queries

SELECT * FROM
aws.ssm.describe_automation_executions;

Description

Provides details about all active and terminated Automation executions.

Table Definition

Column NameColumn Data Type
filters Input Column

Filters used to limit the scope of executions that are requested.

STRUCT(
"key" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].key

One or more keys to limit the results.

filters[].values[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
alarm_configuration

The details for the CloudWatch alarm applied to your automation.

STRUCT(
"ignore_poll_alarm_failure" BOOLEAN,
"alarms" STRUCT(
"name" VARCHAR
)[]
)
Show child fields
alarm_configuration.alarms[]
Show child fields
alarm_configuration.alarms[].name

The name of your CloudWatch alarm.

alarm_configuration.ignore_poll_alarm_failure

When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

association_id

The ID of a State Manager association used in the Automation operation.

VARCHAR
automation_execution_id

The execution ID.

VARCHAR
automation_execution_status

The status of the execution.

VARCHAR
automation_subtype

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

VARCHAR
automation_type

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

VARCHAR
change_request_name

The name of the Change Manager change request.

VARCHAR
current_action

The action of the step that is currently running.

VARCHAR
current_step_name

The name of the step that is currently running.

VARCHAR
document_name

The name of the Automation runbook used during execution.

VARCHAR
document_version

The document version used during the execution.

VARCHAR
executed_by

The IAM role ARN of the user who ran the automation.

VARCHAR
execution_end_time

The time the execution finished. This isn't populated if the execution is still in progress.

TIMESTAMP_S
execution_start_time

The time the execution started.

TIMESTAMP_S
failure_message

The list of execution outputs as defined in the Automation runbook.

VARCHAR
log_file

An S3 bucket where execution information is stored.

VARCHAR
max_concurrency

The MaxConcurrency value specified by the user when starting the automation.

VARCHAR
max_errors

The MaxErrors value specified by the user when starting the automation.

VARCHAR
mode

The Automation execution mode.

VARCHAR
ops_item_id

The ID of an OpsItem that is created to represent a Change Manager change request.

VARCHAR
outputs

The list of execution outputs as defined in the Automation runbook.

MAP(VARCHAR, VARCHAR[])
parent_automation_execution_id

The execution ID of the parent automation.

VARCHAR
resolved_targets

A list of targets that resolved during the execution.

STRUCT(
"parameter_values" VARCHAR[],
"truncated" BOOLEAN
)
Show child fields
resolved_targets.parameter_values[]
resolved_targets.truncated

A boolean value indicating whether the resolved target list is truncated.

runbooks

Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

STRUCT(
"document_name" VARCHAR,
"document_version" VARCHAR,
"parameters" MAP(VARCHAR, VARCHAR[]),
"target_parameter_name" VARCHAR,
"targets" STRUCT(
"key" VARCHAR,
"values" VARCHAR[]
)[],
"target_maps" MAP(VARCHAR, VARCHAR[])[],
"max_concurrency" VARCHAR,
"max_errors" VARCHAR,
"target_locations" STRUCT(
"accounts" VARCHAR[],
"regions" VARCHAR[],
"target_location_max_concurrency" VARCHAR,
"target_location_max_errors" VARCHAR,
"execution_role_name" VARCHAR,
"target_location_alarm_configuration" STRUCT(
"ignore_poll_alarm_failure" BOOLEAN,
"alarms" STRUCT(
"name" VARCHAR
)[]
)
)[]
)[]
Show child fields
runbooks[]
Show child fields
runbooks[].document_name

The name of the Automation runbook used in a runbook workflow.

runbooks[].document_version

The version of the Automation runbook used in a runbook workflow.

runbooks[].max_concurrency

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

runbooks[].max_errors

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

runbooks[].parameters

The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

runbooks[].target_locations[]
Show child fields
runbooks[].target_locations[].accounts[]
runbooks[].target_locations[].execution_role_name

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

runbooks[].target_locations[].regions[]
runbooks[].target_locations[].target_location_alarm_configuration

The details for the CloudWatch alarm you want to apply to an automation or command.

Show child fields
runbooks[].target_locations[].target_location_alarm_configuration.alarms[]
Show child fields
runbooks[].target_locations[].target_location_alarm_configuration.alarms[].name

The name of your CloudWatch alarm.

runbooks[].target_locations[].target_location_alarm_configuration.ignore_poll_alarm_failure

When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.

runbooks[].target_locations[].target_location_max_concurrency

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

runbooks[].target_locations[].target_location_max_errors

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

runbooks[].target_maps[]
runbooks[].target_parameter_name

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

runbooks[].targets[]
Show child fields
runbooks[].targets[].key

User-defined criteria for sending commands that target managed nodes that meet the criteria.

runbooks[].targets[].values[]
scheduled_time

The date and time the Automation operation is scheduled to start.

TIMESTAMP_S
target

The list of execution outputs as defined in the Automation runbook.

VARCHAR
target_maps

The specified key-value mapping of document parameters to target resources.

MAP(VARCHAR, VARCHAR[])[]
Show child fields
target_maps[]
target_parameter_name

The list of execution outputs as defined in the Automation runbook.

VARCHAR
targets

The targets defined by the user when starting the automation.

STRUCT(
"key" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
targets[]
Show child fields
targets[].key

User-defined criteria for sending commands that target managed nodes that meet the criteria.

targets[].values[]
triggered_alarms

The CloudWatch alarm that was invoked by the automation.

STRUCT(
"name" VARCHAR,
"state" VARCHAR
)[]
Show child fields
triggered_alarms[]
Show child fields
triggered_alarms[].name

The name of your CloudWatch alarm.

triggered_alarms[].state

The state of your CloudWatch alarm.