Class: Aws::SSM::Types::StartAutomationExecutionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::StartAutomationExecutionRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
When making an API call, you may pass StartAutomationExecutionRequest data as a hash:
{
document_name: "DocumentARN", # required
document_version: "DocumentVersion",
parameters: {
"AutomationParameterKey" => ["AutomationParameterValue"],
},
client_token: "IdempotencyToken",
mode: "Auto", # accepts Auto, Interactive
target_parameter_name: "AutomationParameterKey",
targets: [
{
key: "TargetKey",
values: ["TargetValue"],
},
],
target_maps: [
{
"TargetMapKey" => ["TargetMapValue"],
},
],
max_concurrency: "MaxConcurrency",
max_errors: "MaxErrors",
target_locations: [
{
accounts: ["Account"],
regions: ["Region"],
target_location_max_concurrency: "MaxConcurrency",
target_location_max_errors: "MaxErrors",
execution_role_name: "ExecutionRoleName",
},
],
}
Instance Attribute Summary collapse
-
#client_token ⇒ String
User-provided idempotency token.
-
#document_name ⇒ String
The name of the Automation document to use for this execution.
-
#document_version ⇒ String
The version of the Automation document to use for this execution.
-
#max_concurrency ⇒ String
The maximum number of targets allowed to run this task in parallel.
-
#max_errors ⇒ String
The number of errors that are allowed before the system stops running the automation on additional targets.
-
#mode ⇒ String
The execution mode of the automation.
-
#parameters ⇒ Hash<String,Array<String>>
A key-value map of execution parameters, which match the declared parameters in the Automation document.
-
#target_locations ⇒ Array<Types::TargetLocation>
A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
-
#target_maps ⇒ Array<Hash<String,Array<String>>>
A key-value mapping of document parameters to target resources.
-
#target_parameter_name ⇒ String
The name of the parameter used as the target resource for the rate-controlled execution.
-
#targets ⇒ Array<Types::Target>
A key-value mapping to target resources.
Instance Attribute Details
#client_token ⇒ String
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can’t be reused.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#document_name ⇒ String
The name of the Automation document to use for this execution.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#document_version ⇒ String
The version of the Automation document to use for this execution.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#max_concurrency ⇒ String
The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#max_errors ⇒ String
The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.
Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won’t be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#mode ⇒ String
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#parameters ⇒ Hash<String,Array<String>>
A key-value map of execution parameters, which match the declared parameters in the Automation document.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#target_locations ⇒ Array<Types::TargetLocation>
A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see [Executing Automations in Multiple AWS Regions and Accounts] in the *AWS Systems Manager User Guide*.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#target_maps ⇒ Array<Hash<String,Array<String>>>
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#target_parameter_name ⇒ String
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |
#targets ⇒ Array<Types::Target>
A key-value mapping to target resources. Required if you specify TargetParameterName.
15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 |
# File 'lib/aws-sdk-ssm/types.rb', line 15088 class StartAutomationExecutionRequest < Struct.new( :document_name, :document_version, :parameters, :client_token, :mode, :target_parameter_name, :targets, :target_maps, :max_concurrency, :max_errors, :target_locations) include Aws::Structure end |