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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $ssm = Paws->service('SSM');
my $SendCommandResult = $ssm->SendCommand(
  DocumentName           => 'MyDocumentARN',
  CloudWatchOutputConfig => {
    CloudWatchLogGroupName =>
      'MyCloudWatchLogGroupName',    # min: 1, max: 512; OPTIONAL
    CloudWatchOutputEnabled => 1,    # OPTIONAL
  },    # OPTIONAL
  Comment            => 'MyComment',                # OPTIONAL
  DocumentHash       => 'MyDocumentHash',           # OPTIONAL
  DocumentHashType   => 'Sha256',                   # OPTIONAL
  DocumentVersion    => 'MyDocumentVersion',        # OPTIONAL
  InstanceIds        => [ 'MyInstanceId', ... ],    # OPTIONAL
  MaxConcurrency     => 'MyMaxConcurrency',         # OPTIONAL
  MaxErrors          => 'MyMaxErrors',              # OPTIONAL
  NotificationConfig => {
    NotificationArn    => 'MyNotificationArn',      # OPTIONAL
    NotificationEvents => [
      'All',
      ...    # values: All, InProgress, Success, TimedOut, Cancelled, Failed
    ],    # OPTIONAL
    NotificationType => 'Command',   # values: Command, Invocation; OPTIONAL
  },    # OPTIONAL
  OutputS3BucketName => 'MyS3BucketName',    # OPTIONAL
  OutputS3KeyPrefix  => 'MyS3KeyPrefix',     # OPTIONAL
  OutputS3Region     => 'MyS3Region',        # OPTIONAL
  Parameters => { 'MyParameterName' => [ 'MyParameterValue', ... ], }
  ,                                          # OPTIONAL
  ServiceRoleArn => 'MyServiceRole',         # OPTIONAL
  Targets        => [
    {
      Key    => 'MyTargetKey',               # min: 1, max: 163; OPTIONAL
      Values => [ 'MyTargetValue', ... ],    # max: 50; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  TimeoutSeconds => 1,    # OPTIONAL
);

# Results:
my $Command = $SendCommandResult->Command;

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

ATTRIBUTES

CloudWatchOutputConfig => Paws::SSM::CloudWatchOutputConfig

Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

Comment => Str

User-specified information about the command, such as a brief description of what the command should do.

DocumentHash => Str

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

DocumentHashType => Str

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Valid values are: "Sha256", "Sha1"

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 SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

InstanceIds => ArrayRef[Str|Undef]

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) in the AWS Systems Manager User Guide.

MaxConcurrency => Str

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity) in the AWS Systems Manager User Guide.

MaxErrors => Str

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors) in the AWS Systems Manager User Guide.

NotificationConfig => Paws::SSM::NotificationConfig

Configurations for sending notifications.

OutputS3BucketName => Str

The name of the S3 bucket where command execution responses should be stored.

OutputS3KeyPrefix => Str

The directory structure within the S3 bucket where the responses should be stored.

OutputS3Region => Str

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.

Parameters => Paws::SSM::Parameters

The required and optional parameters specified in the document being run.

ServiceRoleArn => Str

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) in the AWS Systems Manager User Guide.

TimeoutSeconds => Int

If this time is reached and the command has not already started running, it will not run.

SEE ALSO

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