You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::StartAutomationExecutionRequest

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

Overview

Note:

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

Instance Attribute Details

#client_tokenString

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Returns:

  • (String)


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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_nameString

The name of the Automation document to use for this execution.

Returns:

  • (String)


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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_versionString

The version of the Automation document to use for this execution.

Returns:

  • (String)


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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_concurrencyString

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.

Returns:

  • (String)


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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_errorsString

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.

Returns:

  • (String)


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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

#modeString

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Returns:

  • (String)


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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

#parametersHash<String,Array<String>>

A key-value map of execution parameters, which match the declared parameters in the Automation document.

Returns:

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


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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_locationsArray<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.

Returns:



14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.

Returns:

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


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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_nameString

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Returns:

  • (String)


14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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

#targetsArray<Types::Target>

A key-value mapping to target resources. Required if you specify TargetParameterName.

Returns:



14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14515

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