The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.40
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::SSM::CommandInvocation

NAME

Paws::SSM::CommandInvocation

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::CommandInvocation object:

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

Results returned from an API call

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

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

DESCRIPTION

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed.

ATTRIBUTES

CloudWatchOutputConfig => Paws::SSM::CloudWatchOutputConfig

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

CommandId => Str

  The command against which this invocation was requested.

CommandPlugins => ArrayRef[Paws::SSM::CommandPlugin]

Comment => Str

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

DocumentName => Str

  The document name that was requested for execution.

DocumentVersion => Str

  The SSM document version.

InstanceId => Str

  The instance ID in which this invocation was requested.

InstanceName => Str

  The name of the invocation target. For Amazon EC2 instances this is the
value for the aws:Name tag. For on-premises instances, this is the name
of the instance.

NotificationConfig => Paws::SSM::NotificationConfig

  Configurations for sending notifications about command status changes
on a per instance basis.

RequestedDateTime => Str

  The time and date the request was sent to this instance.

ServiceRole => Str

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

StandardErrorUrl => Str

  The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3
bucket was defined for the parent command. For an invocation,
StandardErrorUrl is populated if there is just one plugin defined for
the command, and the Amazon S3 bucket was defined for the command.

StandardOutputUrl => Str

  The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3
bucket was defined for the parent command. For an invocation,
StandardOutputUrl is populated if there is just one plugin defined for
the command, and the Amazon S3 bucket was defined for the command.

Status => Str

  Whether or not the invocation succeeded, failed, or is pending.

StatusDetails => Str

  A detailed status of the command execution for each invocation (each
instance targeted by the command). 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
(http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
in the I<AWS Systems Manager User Guide>. StatusDetails can be one of
the following values:

  • Pending: The command has not been sent to the instance.

  • In Progress: The command has been sent to the instance but has not reached a terminal state.

  • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

  • Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

  • Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

TraceOutput => Str

  Gets the trace output sent by the agent.

SEE ALSO

This class forms part of Paws, describing an object used 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