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

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

Overview

Details about a specific Automation execution.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#automation_execution_id ⇒ String

The execution ID.

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#automation_execution_status ⇒ String

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

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#automation_type ⇒ String

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that executes in multiple AWS Regions and accounts. For more information, see [Concurrently Executing Automations in Multiple AWS Regions and Accounts] in the *AWS Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#current_action ⇒ String

The action of the currently executing step.

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#current_step_name ⇒ String

The name of the currently executing step.

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#document_name ⇒ String

The name of the Automation document used during execution.

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#document_version ⇒ String

The document version used during the execution.

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#executed_by ⇒ String

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

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#execution_end_time ⇒ Time

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

Returns:

  • (Time) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#execution_start_time ⇒ Time

The time the execution started.&gt;

Returns:

  • (Time) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#failure_message ⇒ String

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

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#log_file ⇒ String

An Amazon S3 bucket where execution information is stored.

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#max_concurrency ⇒ String

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

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#max_errors ⇒ String

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

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#mode ⇒ String

The Automation execution mode.

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

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

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

Returns:

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


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#parent_automation_execution_id ⇒ String

The ExecutionId of the parent Automation.

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#resolved_targets ⇒ Types::ResolvedTargets

A list of targets that resolved during the execution.

Returns:



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#target ⇒ String

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

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

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

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

Returns:

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


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#target_parameter_name ⇒ String

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

Returns:

  • (String) 


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end

#targets ⇒ Array<Types::Target>

The targets defined by the user when starting the Automation.

Returns:



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/aws-sdk-ssm/types.rb', line 1050

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,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :automation_type)
  include Aws::Structure
end