/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SSM::StartAutomationExecution

NAME

Paws::SSM::StartAutomationExecution - Arguments for method StartAutomationExecution on Paws::SSM

DESCRIPTION

This class represents the parameters used for calling the method StartAutomationExecution on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method StartAutomationExecution.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartAutomationExecution.

SYNOPSIS

my $ssm = Paws->service('SSM');
my $StartAutomationExecutionResult = $ssm->StartAutomationExecution(
  DocumentName    => 'MyDocumentARN',
  ClientToken     => 'MyIdempotencyToken',    # OPTIONAL
  DocumentVersion => 'MyDocumentVersion',     # OPTIONAL
  MaxConcurrency  => 'MyMaxConcurrency',      # OPTIONAL
  MaxErrors       => 'MyMaxErrors',           # OPTIONAL
  Mode            => 'Auto',                  # OPTIONAL
  Parameters      => {
    'MyAutomationParameterKey' => [
      'MyAutomationParameterValue', ...       # min: 1, max: 512
    ],    # key: min: 1, max: 50, value: max: 50
  },    # OPTIONAL
  Tags => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # min: 1, max: 256

    },
    ...
  ],    # OPTIONAL
  TargetLocations => [
    {
      Accounts          => [ 'MyAccount', ... ], # min: 1, max: 50; OPTIONAL
      ExecutionRoleName =>
        'MyExecutionRoleName',                   # min: 1, max: 64; OPTIONAL
      Regions => [ 'MyRegion', ... ],            # min: 1, max: 50; OPTIONAL
      TargetLocationMaxConcurrency => 'MyMaxConcurrency',   # min: 1, max: 7
      TargetLocationMaxErrors      => 'MyMaxErrors',        # min: 1, max: 7
    },
    ...
  ],    # OPTIONAL
  TargetMaps => [
    {
      'MyTargetMapKey' => [
        'MyTargetMapValue', ...    # min: 1, max: 50
      ],    # key: min: 1, max: 50, value: max: 25
    },
    ...     # min: 1, max: 20
  ],    # OPTIONAL
  TargetParameterName => 'MyAutomationParameterKey',    # OPTIONAL
  Targets             => [
    {
      Key    => 'MyTargetKey',               # min: 1, max: 163; OPTIONAL
      Values => [ 'MyTargetValue', ... ],    # max: 50; OPTIONAL
    },
    ...
  ],    # OPTIONAL
);

# Results:
my $AutomationExecutionId =
  $StartAutomationExecutionResult->AutomationExecutionId;

# Returns a L<Paws::SSM::StartAutomationExecutionResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ssm/StartAutomationExecution

ATTRIBUTES

ClientToken => Str

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

REQUIRED DocumentName => Str

The name of the Systems Manager 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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) in the AWS Systems Manager User Guide.

DocumentVersion => Str

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

MaxConcurrency => Str

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.

MaxErrors => Str

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.

Mode => Str

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

Valid values are: "Auto", "Interactive"

Parameters => Paws::SSM::AutomationParameterMap

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

Tags => ArrayRef[Paws::SSM::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 name/value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource action.

TargetLocations => ArrayRef[Paws::SSM::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 Running Automation workflows in multiple AWS Regions and accounts (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) in the AWS Systems Manager User Guide.

TargetMaps => ArrayRef[Paws::SSM::TargetMap]

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

TargetParameterName => Str

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

Targets => ArrayRef[Paws::SSM::Target]

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

SEE ALSO

This class forms part of Paws, documenting arguments for method StartAutomationExecution in Paws::SSM

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues