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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $ssm = Paws->service('SSM');
my $StartChangeRequestExecutionResult = $ssm->StartChangeRequestExecution(
  DocumentName => 'MyDocumentARN',
  Runbooks     => [
    {
      DocumentName    => 'MyDocumentARN',
      DocumentVersion => 'MyDocumentVersion',    # OPTIONAL
      MaxConcurrency  => 'MyMaxConcurrency',     # min: 1, max: 7; OPTIONAL
      MaxErrors       => 'MyMaxErrors',          # min: 1, max: 7; OPTIONAL
      Parameters      => {
        'MyAutomationParameterKey' => [
          'MyAutomationParameterValue', ...      # min: 1, max: 512
        ],    # key: min: 1, max: 50, value: max: 50
      },    # min: 1, max: 200; 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; OPTIONAL
          TargetLocationMaxErrors =>
            'MyMaxErrors',                     # min: 1, max: 7; OPTIONAL
        },
        ...
      ],    # min: 1, max: 100; OPTIONAL
      TargetParameterName => 'MyAutomationParameterKey',   # min: 1, max: 50
      Targets             => [
        {
          Key    => 'MyTargetKey',              # min: 1, max: 163; OPTIONAL
          Values => [ 'MyTargetValue', ... ],   # max: 50; OPTIONAL
        },
        ...
      ],    # max: 5; OPTIONAL
    },
    ...
  ],
  ChangeDetails     => 'MyChangeDetailsValue',    # OPTIONAL
  ChangeRequestName => 'MyChangeRequestName',     # OPTIONAL
  ClientToken       => 'MyIdempotencyToken',      # OPTIONAL
  DocumentVersion   => 'MyDocumentVersion',       # OPTIONAL
  Parameters        => {
    'MyAutomationParameterKey' => [
      'MyAutomationParameterValue', ...           # min: 1, max: 512
    ],    # key: min: 1, max: 50, value: max: 50
  },    # OPTIONAL
  ScheduledEndTime => '1970-01-01T01:00:00',    # OPTIONAL
  ScheduledTime    => '1970-01-01T01:00:00',    # OPTIONAL
  Tags             => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # min: 1, max: 256

    },
    ...
  ],    # OPTIONAL
);

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

# Returns a L<Paws::SSM::StartChangeRequestExecutionResult> 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/StartChangeRequestExecution

ATTRIBUTES

ChangeDetails => Str

User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

ChangeRequestName => Str

The name of the change request associated with the runbook workflow to be run.

ClientToken => Str

The 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 change template document to run during the runbook workflow.

DocumentVersion => Str

The version of the change template document to run during the runbook workflow.

Parameters => Paws::SSM::AutomationParameterMap

A key-value map of parameters that match the declared parameters in the change template document.

REQUIRED Runbooks => ArrayRef[Paws::SSM::Runbook]

Information about the Automation runbooks (Automation documents) that are run during the runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

ScheduledEndTime => Str

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

ScheduledTime => Str

The date and time specified in the change request to run the Automation runbooks.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Tags => ArrayRef[Paws::SSM::Tag]

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

  • Key=Environment,Value=Production

  • Key=Region,Value=us-east-2

SEE ALSO

This class forms part of Paws, documenting arguments for method StartChangeRequestExecution 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