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)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#automation_execution_statusString

The execution status of the Automation.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#current_actionString

The action of the step that is currently running.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#current_step_nameString

The name of the step that is currently running.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#document_nameString

The name of the Automation document used during the execution.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#document_versionString

The version of the document to use during execution.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#executed_byString

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

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#execution_end_timeTime

The time the execution finished.

Returns:

  • (Time)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#execution_start_timeTime

The time the execution started.

Returns:

  • (Time)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#failure_messageString

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

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#max_concurrencyString

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

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#max_errorsString

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

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#modeString

The automation execution mode.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#outputsHash<String,Array<String>>

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

Returns:

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


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  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>>)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#parent_automation_execution_idString

The AutomationExecutionId of the parent automation.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#progress_countersTypes::ProgressCounters

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



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#resolved_targetsTypes::ResolvedTargets

A list of resolved targets in the rate control execution.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  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 run in order.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#step_executions_truncatedBoolean

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)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#targetString

The target of the execution.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#target_locationsArray<Types::TargetLocation>

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

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  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>>>)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#target_parameter_nameString

The parameter name.

Returns:

  • (String)


963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end

#targetsArray<Types::Target>

The specified targets.

Returns:



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 963

class AutomationExecution < Struct.new(
  :automation_execution_id,
  :document_name,
  :document_version,
  :execution_start_time,
  :execution_end_time,
  :automation_execution_status,
  :step_executions,
  :step_executions_truncated,
  :parameters,
  :outputs,
  :failure_message,
  :mode,
  :parent_automation_execution_id,
  :executed_by,
  :current_step_name,
  :current_action,
  :target_parameter_name,
  :targets,
  :target_maps,
  :resolved_targets,
  :max_concurrency,
  :max_errors,
  :target,
  :target_locations,
  :progress_counters)
  include Aws::Structure
end