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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

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)

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#document_nameString

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see [Using shared SSM documents] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html

Returns:

  • (String)

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

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

Returns:

  • (String)

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  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)

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  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)

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  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)

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,Array<String>>

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

Returns:

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

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • `Key=environment,Value=test`

  • `Key=OS,Value=Windows`

<note markdown=“1”> To add tags to an existing patch baseline, use the AddTagsToResource operation.

</note>

Returns:


18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_locationsArray<Types::TargetLocation>

A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see [Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html

Returns:


18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_mapsArray<Hash<String,Array<String>>>

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

Returns:

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

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  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)

18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#targetsArray<Types::Target>

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

Returns:


18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
# File 'lib/aws-sdk-ssm/types.rb', line 18747

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end