AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::AutomationExecution

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Detailed information about the current state of an individual Automation execution.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#automation_execution_idString

The execution ID.

Returns:

  • (String)

    The execution ID.

#automation_execution_statusString

The execution status of the Automation.

Possible values:

  • Pending
  • InProgress
  • Waiting
  • Success
  • TimedOut
  • Cancelling
  • Cancelled
  • Failed

Returns:

  • (String)

    The execution status of the Automation.

#current_actionString

The action of the step that is currently running.

Returns:

  • (String)

    The action of the step that is currently running.

#current_step_nameString

The name of the step that is currently running.

Returns:

  • (String)

    The name of the step that is currently running.

#document_nameString

The name of the Automation document used during the execution.

Returns:

  • (String)

    The name of the Automation document used during the execution.

#document_versionString

The version of the document to use during execution.

Returns:

  • (String)

    The version of the document to use during execution.

#executed_byString

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

Returns:

  • (String)

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

#execution_end_timeTime

The time the execution finished.

Returns:

  • (Time)

    The time the execution finished.

#execution_start_timeTime

The time the execution started.

Returns:

  • (Time)

    The time the execution started.

#failure_messageString

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

Returns:

  • (String)

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

#max_concurrencyString

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

Returns:

  • (String)

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

#max_errorsString

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

Returns:

  • (String)

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

#modeString

The automation execution mode.

Possible values:

  • Auto
  • Interactive

Returns:

  • (String)

    The automation execution mode.

#outputsHash<String,Array<String>>

The list of execution outputs as defined in the automation document.

Returns:

  • (Hash<String,Array<String>>)

    The list of execution outputs as defined in the automation document.

#parametersHash<String,Array<String>>

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

Returns:

  • (Hash<String,Array<String>>)

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

#parent_automation_execution_idString

The AutomationExecutionId of the parent automation.

Returns:

  • (String)

    The AutomationExecutionId of the parent automation.

#progress_countersTypes::ProgressCounters

An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

Returns:

  • (Types::ProgressCounters)

    An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

#resolved_targetsTypes::ResolvedTargets

A list of resolved targets in the rate control execution.

Returns:

#step_executionsArray<Types::StepExecution>

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.

Returns:

  • (Array<Types::StepExecution>)

    A list of details about the current state of all steps that comprise an execution.

#step_executions_truncatedBoolean

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

Returns:

  • (Boolean)

    A boolean value that indicates if the response contains the full list of the Automation step executions.

#targetString

The target of the execution.

Returns:

  • (String)

    The target of the execution.

#target_locationsArray<Types::TargetLocation>

The combination of AWS Regions and/or AWS accounts where you want to run the Automation.

Returns:

  • (Array<Types::TargetLocation>)

    The combination of AWS Regions and/or AWS accounts where you want to run the Automation.

#target_mapsArray<Hash<String,Array<String>>>

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

Returns:

  • (Array<Hash<String,Array<String>>>)

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

#target_parameter_nameString

The parameter name.

Returns:

  • (String)

    The parameter name.

#targetsArray<Types::Target>

The specified targets.

Returns: