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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configurationTypes::AlarmConfiguration

The details for the CloudWatch alarm applied to your automation.



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#association_idString

The ID of a State Manager association used in the Automation operation.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#automation_execution_idString

The execution ID.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#automation_execution_statusString

The execution status of the Automation.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#automation_subtypeString

The subtype of the Automation operation. Currently, the only supported value is ‘ChangeRequest`.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#change_request_nameString

The name of the Change Manager change request.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#current_actionString

The action of the step that is currently running.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#current_step_nameString

The name of the step that is currently running.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#document_nameString

The name of the Automation runbook used during the execution.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

The version of the document to use during execution.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#executed_byString

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

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#execution_end_timeTime

The time the execution finished.

Returns:

  • (Time)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#execution_start_timeTime

The time the execution started.

Returns:

  • (Time)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#failure_messageString

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

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#max_concurrencyString

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

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#max_errorsString

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

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#modeString

The automation execution mode.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#ops_item_idString

The ID of an OpsItem that is created to represent a Change Manager change request.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#outputsHash<String,Array<String>>

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

Returns:

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


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  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>>)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#parent_automation_execution_idString

The AutomationExecutionId of the parent automation.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#progress_countersTypes::ProgressCounters

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#resolved_targetsTypes::ResolvedTargets

A list of resolved targets in the rate control execution.



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#runbooksArray<Types::Runbook>

Information about the Automation runbooks that are run as part of a runbook workflow.

<note markdown=“1”> The Automation runbooks specified for the runbook workflow can’t run until all required approvals for the change request have been received.

</note>

Returns:



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_timeTime

The date and time the Automation operation is scheduled to start.

Returns:

  • (Time)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  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 runbook contains a list of steps that are run in order.

Returns:



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  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 operation to get the full list of step executions.

Returns:

  • (Boolean)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#targetString

The target of the execution.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#target_locationsArray<Types::TargetLocation>

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

Returns:



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#target_locations_urlString

A publicly accessible URL for a file that contains the ‘TargetLocations` body. Currently, only files in presigned Amazon S3 buckets are supported

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  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>>>)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#target_parameter_nameString

The parameter name.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#targetsArray<Types::Target>

The specified targets.

Returns:



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#triggered_alarmsArray<Types::AlarmStateInformation>

The CloudWatch alarm that was invoked by the automation.

Returns:



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end

#variablesHash<String,Array<String>>

Variables defined for the automation.

Returns:

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


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'lib/aws-sdk-ssm/types.rb', line 1375

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,
  :alarm_configuration,
  :triggered_alarms,
  :target_locations_url,
  :automation_subtype,
  :scheduled_time,
  :runbooks,
  :ops_item_id,
  :association_id,
  :change_request_name,
  :variables)
  SENSITIVE = []
  include Aws::Structure
end