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)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_statusString

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_typeString

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_actionString

The action of the step that is currently running.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_nameString

The name of the step that is currently running.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_nameString

The name of the Automation document used during execution.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_versionString

The document version used during the execution.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_byString

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_timeTime

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

Returns:

  • (Time)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_timeTime

The time the execution started.>

Returns:

  • (Time)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_messageString

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_fileString

An Amazon S3 bucket where execution information is stored.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_concurrencyString

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_errorsString

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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

#modeString

The Automation execution mode.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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

#outputsHash<String,Array<String>>

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

Returns:

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


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_idString

The ExecutionId of the parent Automation.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_targetsTypes::ResolvedTargets

A list of targets that resolved during the execution.



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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

#targetString

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_mapsArray<Hash<String,Array<String>>>

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

Returns:

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


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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_nameString

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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

#targetsArray<Types::Target>

The targets defined by the user when starting the Automation.

Returns:



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1140

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