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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::AutomationExecution

Defined in:

(unknown)

Overview

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

Returned by:

• GetAutomationExecutionResult#automation_execution

See Also:

• AWS API Documentation

Instance Attribute Summary

• #automation_execution_id ⇒ String

  The execution ID.

• #automation_execution_status ⇒ String

  The execution status of the Automation.

• #current_action ⇒ String

  The action of the step that is currently running.

• #current_step_name ⇒ String

  The name of the step that is currently running.

• #document_name ⇒ String

  The name of the Automation document used during the execution.

• #document_version ⇒ String

  The version of the document to use during execution.

• #executed_by ⇒ String

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

• #execution_end_time ⇒ Time

  The time the execution finished.

• #execution_start_time ⇒ Time

  The time the execution started.

• #failure_message ⇒ String

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

• #max_concurrency ⇒ String

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

• #max_errors ⇒ String

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

• #mode ⇒ String

  The automation execution mode.

• #outputs ⇒ Hash<String,Array<String>>

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

• #parameters ⇒ Hash<String,Array<String>>

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

• #parent_automation_execution_id ⇒ String

  The AutomationExecutionId of the parent automation.

• #progress_counters ⇒ Types::ProgressCounters

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

• #resolved_targets ⇒ Types::ResolvedTargets

  A list of resolved targets in the rate control execution.

• #step_executions ⇒ Array<Types::StepExecution>

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

• #step_executions_truncated ⇒ Boolean

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

• #target ⇒ String

  The target of the execution.

• #target_locations ⇒ Array<Types::TargetLocation>

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

• #target_maps ⇒ Array<Hash<String,Array<String>>>

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

• #target_parameter_name ⇒ String

  The parameter name.

• #targets ⇒ Array<Types::Target>

  The specified targets.

Instance Attribute Details

#automation_execution_id ⇒ String

The execution ID.

Returns:

• (String) —

  The execution ID.

#automation_execution_status ⇒ String

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_action ⇒ String

The action of the step that is currently running.

Returns:

• (String) —

  The action of the step that is currently running.

#current_step_name ⇒ String

The name of the step that is currently running.

Returns:

• (String) —

  The name of the step that is currently running.

#document_name ⇒ String

The name of the Automation document used during the execution.

Returns:

• (String) —

  The name of the Automation document used during the execution.

#document_version ⇒ String

The version of the document to use during execution.

Returns:

• (String) —

  The version of the document to use during execution.

#executed_by ⇒ String

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_time ⇒ Time

The time the execution finished.

Returns:

• (Time) —

  The time the execution finished.

#execution_start_time ⇒ Time

The time the execution started.

Returns:

• (Time) —

  The time the execution started.

#failure_message ⇒ String

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_concurrency ⇒ String

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_errors ⇒ String

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

Returns:

• (String) —

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

#mode ⇒ String

The automation execution mode.

Possible values:

• Auto
• Interactive

Returns:

• (String) —

  The automation execution mode.

#outputs ⇒ Hash<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.

#parameters ⇒ Hash<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_id ⇒ String

The AutomationExecutionId of the parent automation.

Returns:

• (String) —

  The AutomationExecutionId of the parent automation.

#progress_counters ⇒ Types::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_targets ⇒ Types::ResolvedTargets

A list of resolved targets in the rate control execution.

Returns:

• (Types::ResolvedTargets) —

  A list of resolved targets in the rate control execution.

#step_executions ⇒ Array<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_truncated ⇒ Boolean

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.

#target ⇒ String

The target of the execution.

Returns:

• (String) —

  The target of the execution.

#target_locations ⇒ Array<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_maps ⇒ Array<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_name ⇒ String

The parameter name.

Returns:

• (String) —

  The parameter name.

#targets ⇒ Array<Types::Target>

The specified targets.

Returns:

• (Array<Types::Target>) —

  The specified targets.