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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#automation_execution_idString

The execution ID.

Returns:

  • (String)


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#automation_execution_statusString

The execution status of the Automation.

Returns:

  • (String)


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#document_nameString

The name of the Automation document used during the execution.

Returns:

  • (String)


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#document_versionString

The version of the document to use during execution.

Returns:

  • (String)


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#execution_end_timeTime

The time the execution finished.

Returns:

  • (Time)


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#execution_start_timeTime

The time the execution started.

Returns:

  • (Time)


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#failure_messageString

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

Returns:

  • (String)


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#outputsHash<String,Array<String>>

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

Returns:

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


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#parametersHash<String,Array<String>>

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

Returns:

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


473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end

#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 executed in order.

Returns:



473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 473

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :parameters,
  :outputs,
  :failure_message)
  include Aws::Structure
end