Skip to content
AWS for Query.Farm

aws.ssm.get_automation_execution

Example SQL Queries

SELECT * FROM
aws.ssm.get_automation_execution
WHERE
"automation_execution_id" = 'VALUE';

Description

Get detailed information about a particular Automation execution.

Table Definition

Column NameColumn Data Type
automation_execution_id Required Input Column

The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.

VARCHAR
_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
automation_execution

Detailed information about the current state of an automation execution.

STRUCT(
    "automation_execution_id" VARCHAR,
    "document_name" VARCHAR,
    "document_version" VARCHAR,
    "execution_start_time" TIMESTAMP_S,
    "execution_end_time" TIMESTAMP_S,
    "automation_execution_status" VARCHAR,
    "step_executions" STRUCT(
        "step_name" VARCHAR,
        "action" VARCHAR,
        "timeout_seconds" BIGINT,
        "on_failure" VARCHAR,
        "max_attempts" BIGINT,
        "execution_start_time" TIMESTAMP_S,
        "execution_end_time" TIMESTAMP_S,
        "step_status" VARCHAR,
        "response_code" VARCHAR,
        "inputs" MAP(VARCHAR, VARCHAR),
        "outputs" MAP(VARCHAR, VARCHAR[]),
        "response" VARCHAR,
        "failure_message" VARCHAR,
        "failure_details" STRUCT(
            "failure_stage" VARCHAR,
            "failure_type" VARCHAR,
            "details" MAP(VARCHAR, VARCHAR[])
        ),
        "step_execution_id" VARCHAR,
        "overridden_parameters" MAP(VARCHAR, VARCHAR[]),
        "is_end" BOOLEAN,
        "next_step" VARCHAR,
        "is_critical" BOOLEAN,
        "valid_next_steps" VARCHAR[],
        "targets" STRUCT(
            "key" VARCHAR,
            "values" VARCHAR[]
        )[],
        "target_location" 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
                )[]
            )
        ),
        "triggered_alarms" STRUCT(
            "name" VARCHAR,
            "state" VARCHAR
        )[],
        "parent_step_details" STRUCT(
            "step_execution_id" VARCHAR,
            "step_name" VARCHAR,
            "action" VARCHAR,
            "iteration" BIGINT,
            "iterator_value" VARCHAR
        )
    )[],
    "step_executions_truncated" BOOLEAN,
    "parameters" MAP(VARCHAR, VARCHAR[]),
    "outputs" MAP(VARCHAR, VARCHAR[]),
    "failure_message" VARCHAR,
    "mode" VARCHAR,
    "parent_automation_execution_id" VARCHAR,
    "executed_by" VARCHAR,
    "current_step_name" VARCHAR,
    "current_action" VARCHAR,
    "target_parameter_name" VARCHAR,
    "targets" STRUCT(
        "key" VARCHAR,
        "values" VARCHAR[]
    )[],
    "target_maps" MAP(VARCHAR, VARCHAR[])[],
    "resolved_targets" STRUCT(
        "parameter_values" VARCHAR[],
        "truncated" BOOLEAN
    ),
    "max_concurrency" VARCHAR,
    "max_errors" VARCHAR,
    "target" 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
            )[]
        )
    )[],
    "progress_counters" STRUCT(
        "total_steps" BIGINT,
        "success_steps" BIGINT,
        "failed_steps" BIGINT,
        "cancelled_steps" BIGINT,
        "timed_out_steps" BIGINT
    ),
    "alarm_configuration" STRUCT(
        "ignore_poll_alarm_failure" BOOLEAN,
        "alarms" STRUCT(
            "name" VARCHAR
        )[]
    ),
    "triggered_alarms" STRUCT(
        "name" VARCHAR,
        "state" VARCHAR
    )[],
    "automation_subtype" VARCHAR,
    "scheduled_time" TIMESTAMP_S,
    "runbooks" 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
                )[]
            )
        )[]
    )[],
    "ops_item_id" VARCHAR,
    "association_id" VARCHAR,
    "change_request_name" VARCHAR,
    "variables" MAP(VARCHAR, VARCHAR[])
)
Show child fields
automation_execution.alarm_configuration

The details for the CloudWatch alarm applied to your automation.

Show child fields
automation_execution.alarm_configuration.alarms[]
Show child fields
automation_execution.alarm_configuration.alarms[].name

The name of your CloudWatch alarm.

automation_execution.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.

automation_execution.association_id

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

automation_execution.automation_execution_id

The execution ID.

automation_execution.automation_execution_status

The execution status of the Automation.

automation_execution.automation_subtype

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

automation_execution.change_request_name

The name of the Change Manager change request.

automation_execution.current_action

The action of the step that is currently running.

automation_execution.current_step_name

The name of the step that is currently running.

automation_execution.document_name

The name of the Automation runbook used during the execution.

automation_execution.document_version

The version of the document to use during execution.

automation_execution.executed_by

The Amazon Resource Name (ARN) of the user who ran the automation.

automation_execution.execution_end_time

The time the execution finished.

automation_execution.execution_start_time

The time the execution started.

automation_execution.failure_message

A message describing why an execution has failed, if the status is set to Failed.

automation_execution.max_concurrency

The MaxConcurrency value specified by the user when the execution started.

automation_execution.max_errors

The MaxErrors value specified by the user when the execution started.

automation_execution.mode

The automation execution mode.

automation_execution.ops_item_id

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

automation_execution.outputs

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

automation_execution.parameters

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

automation_execution.parent_automation_execution_id

The AutomationExecutionId of the parent automation.

automation_execution.progress_counters

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

Show child fields
automation_execution.progress_counters.cancelled_steps

The total number of steps that the system cancelled in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

automation_execution.progress_counters.failed_steps

The total number of steps that failed to run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

automation_execution.progress_counters.success_steps

The total number of steps that successfully completed in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

automation_execution.progress_counters.timed_out_steps

The total number of steps that timed out in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

automation_execution.progress_counters.total_steps

The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

automation_execution.resolved_targets

A list of resolved targets in the rate control execution.

Show child fields
automation_execution.resolved_targets.parameter_values[]
automation_execution.resolved_targets.truncated

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

automation_execution.runbooks[]
Show child fields
automation_execution.runbooks[].document_name

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

automation_execution.runbooks[].document_version

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

automation_execution.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.

automation_execution.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.

automation_execution.runbooks[].parameters

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

automation_execution.runbooks[].target_locations[]
Show child fields
automation_execution.runbooks[].target_locations[].accounts[]
automation_execution.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.

automation_execution.runbooks[].target_locations[].regions[]
automation_execution.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
automation_execution.runbooks[].target_locations[].target_location_alarm_configuration.alarms[]
Show child fields
automation_execution.runbooks[].target_locations[].target_location_alarm_configuration.alarms[].name

The name of your CloudWatch alarm.

automation_execution.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.

automation_execution.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.

automation_execution.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.

automation_execution.runbooks[].target_maps[]
automation_execution.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.

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

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

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

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

automation_execution.step_executions[]
Show child fields
automation_execution.step_executions[].action

The action this step performs. The action determines the behavior of the step.

automation_execution.step_executions[].execution_end_time

If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.

automation_execution.step_executions[].execution_start_time

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.

automation_execution.step_executions[].failure_details

Information about the Automation failure.

Show child fields
automation_execution.step_executions[].failure_details.details

Detailed information about the Automation step failure.

automation_execution.step_executions[].failure_details.failure_stage

The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.

automation_execution.step_executions[].failure_details.failure_type

The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.

automation_execution.step_executions[].failure_message

If a step failed, this message explains why the execution failed.

automation_execution.step_executions[].inputs

Fully-resolved values passed into the step before execution.

automation_execution.step_executions[].is_critical

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

automation_execution.step_executions[].is_end

The flag which can be used to end automation no matter whether the step succeeds or fails.

automation_execution.step_executions[].max_attempts

The maximum number of tries to run the action of the step. The default value is 1.

automation_execution.step_executions[].next_step

The next step after the step succeeds.

automation_execution.step_executions[].on_failure

The action to take if the step fails. The default value is Abort.

automation_execution.step_executions[].outputs

Returned values from the execution of the step.

automation_execution.step_executions[].overridden_parameters

A user-specified list of parameters to override when running a step.

automation_execution.step_executions[].parent_step_details

Information about the parent step.

Show child fields
automation_execution.step_executions[].parent_step_details.action

The name of the automation action.

automation_execution.step_executions[].parent_step_details.iteration

The current repetition of the loop represented by an integer.

automation_execution.step_executions[].parent_step_details.iterator_value

The current value of the specified iterator in the loop.

automation_execution.step_executions[].parent_step_details.step_execution_id

The unique ID of a step execution.

automation_execution.step_executions[].parent_step_details.step_name

The name of the step.

automation_execution.step_executions[].response

A message associated with the response code for an execution.

automation_execution.step_executions[].response_code

The response code returned by the execution of the step.

automation_execution.step_executions[].step_execution_id

The unique ID of a step execution.

automation_execution.step_executions[].step_name

The name of this execution step.

automation_execution.step_executions[].step_status

The execution status for this step.

automation_execution.step_executions[].target_location

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

Show child fields
automation_execution.step_executions[].target_location.accounts[]
automation_execution.step_executions[].target_location.execution_role_name

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

automation_execution.step_executions[].target_location.regions[]
automation_execution.step_executions[].target_location.target_location_alarm_configuration

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

Show child fields
automation_execution.step_executions[].target_location.target_location_alarm_configuration.alarms[]
Show child fields
automation_execution.step_executions[].target_location.target_location_alarm_configuration.alarms[].name

The name of your CloudWatch alarm.

automation_execution.step_executions[].target_location.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.

automation_execution.step_executions[].target_location.target_location_max_concurrency

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

automation_execution.step_executions[].target_location.target_location_max_errors

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

automation_execution.step_executions[].targets[]
Show child fields
automation_execution.step_executions[].targets[].key

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

automation_execution.step_executions[].targets[].values[]
automation_execution.step_executions[].timeout_seconds

The timeout seconds of the step.

automation_execution.step_executions[].triggered_alarms[]
Show child fields
automation_execution.step_executions[].triggered_alarms[].name

The name of your CloudWatch alarm.

automation_execution.step_executions[].triggered_alarms[].state

The state of your CloudWatch alarm.

automation_execution.step_executions[].valid_next_steps[]
automation_execution.step_executions_truncated

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.

automation_execution.target

The target of the execution.

automation_execution.target_locations[]
Show child fields
automation_execution.target_locations[].accounts[]
automation_execution.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.

automation_execution.target_locations[].regions[]
automation_execution.target_locations[].target_location_alarm_configuration

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

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

The name of your CloudWatch alarm.

automation_execution.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.

automation_execution.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.

automation_execution.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.

automation_execution.target_maps[]
automation_execution.target_parameter_name

The parameter name.

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

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

automation_execution.targets[].values[]
automation_execution.triggered_alarms[]
Show child fields
automation_execution.triggered_alarms[].name

The name of your CloudWatch alarm.

automation_execution.triggered_alarms[].state

The state of your CloudWatch alarm.

automation_execution.variables

Variables defined for the automation.