Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

CommandInvocation

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.

Contents

CommandId

The command against which this invocation was requested.

Type: String

Length Constraints: Fixed length of 36.

Required: No

CommandPlugins

Type: Array of CommandPlugin objects

Required: No

Comment

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

Type: String

Length Constraints: Maximum length of 100.

Required: No

DocumentName

The document name that was requested for execution.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Required: No

InstanceId

The instance ID in which this invocation was requested.

Type: String

Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

Required: No

InstanceName

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.

Type: String

Length Constraints: Maximum length of 255.

Required: No

NotificationConfig

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

Type: NotificationConfig object

Required: No

RequestedDateTime

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

Type: Timestamp

Required: No

ServiceRole

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.

Type: String

Required: No

StandardErrorUrl

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.

Type: String

Required: No

StandardOutputUrl

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.

Type: String

Required: No

Status

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

Type: String

Valid Values: Pending | InProgress | Delayed | Success | Cancelled | TimedOut | Failed | Cancelling

Required: No

StatusDetails

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 Run Command Status. 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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Required: No

TraceOutput

Gets the trace output sent by the agent.

Type: String

Length Constraints: Maximum length of 2500.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: