NAME

Paws::SSM::Command

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::SSM::Command object:

  $service_obj->Method(Att1 => { CloudWatchOutputConfig => $value, ..., TimeoutSeconds => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::Command object:

  $result = $service_obj->Method(...);
  $result->Att1->CloudWatchOutputConfig

DESCRIPTION

Describes a command request.

ATTRIBUTES

CloudWatchOutputConfig => Paws::SSM::CloudWatchOutputConfig

CloudWatch Logs information where you want Systems Manager to send the command output.

Comment => Str

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

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

DeliveryTimedOutCount => Int

The number of targets for which the status is Delivery Timed Out.

DocumentName => Str

The name of the document requested for execution.

DocumentVersion => Str

The SSM document version.

ErrorCount => Int

The number of targets for which the status is Failed or Execution Timed Out.

ExpiresAfter => Str

If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

InstanceIds => ArrayRef[Str|Undef]

The instance IDs against which this command was requested.

MaxConcurrency => Str

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

MaxErrors => Str

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command (https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html) in the AWS Systems Manager User Guide.

NotificationConfig => Paws::SSM::NotificationConfig

Configurations for sending notifications about command status changes.

OutputS3BucketName => Str

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

OutputS3KeyPrefix => Str

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

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 parameter values to be inserted in the document when running the command.

RequestedDateTime => Str

The date and time the command was requested.

ServiceRole => Str

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Status => Str

The status of the command.

StatusDetails => Str

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

Pending: The command has not been sent to any instances.
In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.
Success: The command successfully ran on all invocations. This is a terminal state.
Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

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>