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

Class: Aws::SSM::Types::AutomationExecutionMetadata

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

Overview

Details about a specific Automation execution.

Instance Attribute Summary collapse

Instance Attribute Details

#automation_execution_idString

The execution ID.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#automation_execution_statusString

The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#current_actionString

The action of the currently executing step.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#current_step_nameString

The name of the currently executing step.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#document_nameString

The name of the Automation document used during execution.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#document_versionString

The document version used during the execution.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#executed_byString

The IAM role ARN of the user who executed the Automation.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#execution_end_timeTime

The time the execution finished. This is not populated if the execution is still in progress.

Returns:

  • (Time)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#execution_start_timeTime

The time the execution started.>

Returns:

  • (Time)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#failure_messageString

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

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#log_fileString

An Amazon S3 bucket where execution information is stored.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#max_concurrencyString

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

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#max_errorsString

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

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#modeString

The Automation execution mode.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#outputsHash<String,Array<String>>

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

Returns:

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


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#parent_automation_execution_idString

The ExecutionId of the parent Automation.

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#resolved_targetsTypes::ResolvedTargets

A list of targets that resolved during the execution.



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#targetString

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

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#target_parameter_nameString

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

Returns:

  • (String)


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets defined by the user when starting the Automation.

Returns:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 671

class AutomationExecutionMetadata < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :automation_execution_status,
  :execution_start_time,
  :execution_end_time,
  :executed_by,
  :log_file,
  :outputs,
  :mode,
  :parent_automation_execution_id,
  :current_step_name,
  :current_action,
  :failure_message,
  :target_parameter_name,
  :targets,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target)
  include Aws::Structure
end