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.

As an example:

$service_obj->SendCommand(Att1 => $value1, Att2 => $value2, ...);

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.

ATTRIBUTES

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

Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.

InstanceIds => ArrayRef[Str|Undef]

Required. The instance IDs where the command should execute. You can specify a maximum of 50 IDs.

MaxConcurrency => Str

(Optional) The maximum number of instances that are allowed to execute 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 Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

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 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

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

(Optional) The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.

Parameters => Paws::SSM::Parameters

The required and optional parameters specified in the SSM document being executed.

ServiceRoleArn => Str

The IAM role that Systems Manager uses to send notifications.

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

(Optional) An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

TimeoutSeconds => Int

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

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