Documentation

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 runs 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 ran.

See: newCommandInvocation smart constructor.

Create a value of CommandInvocation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:instanceId:CommandInvocation', commandInvocation_instanceId - The instance ID in which this invocation was requested.

$sel:status:CommandInvocation', commandInvocation_status - Whether or not the invocation succeeded, failed, or is pending.

$sel:notificationConfig:CommandInvocation', commandInvocation_notificationConfig - Configurations for sending notifications about command status changes on a per instance basis.

$sel:commandPlugins:CommandInvocation', commandInvocation_commandPlugins - Plugins processed by the command.

$sel:cloudWatchOutputConfig:CommandInvocation', commandInvocation_cloudWatchOutputConfig - Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

$sel:documentName:CommandInvocation', commandInvocation_documentName - The document name that was requested for execution.

$sel:standardErrorUrl:CommandInvocation', commandInvocation_standardErrorUrl - The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the 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 S3 bucket was defined for the command.

$sel:statusDetails:CommandInvocation', commandInvocation_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 Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

• Pending: The command hasn't been sent to the instance.
• In Progress: The command has been sent to the instance but hasn't 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 wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't 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 wasn't 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 wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't 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.

$sel:standardOutputUrl:CommandInvocation', commandInvocation_standardOutputUrl - The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the 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 S3 bucket was defined for the command.

$sel:commandId:CommandInvocation', commandInvocation_commandId - The command against which this invocation was requested.

$sel:documentVersion:CommandInvocation', commandInvocation_documentVersion - The Systems Manager document (SSM document) version.

$sel:comment:CommandInvocation', commandInvocation_comment - User-specified information about the command, such as a brief description of what the command should do.

$sel:traceOutput:CommandInvocation', commandInvocation_traceOutput - Gets the trace output sent by the agent.

$sel:instanceName:CommandInvocation', commandInvocation_instanceName - The fully qualified host name of the managed instance.

$sel:requestedDateTime:CommandInvocation', commandInvocation_requestedDateTime - The time and date the request was sent to this instance.

$sel:serviceRole:CommandInvocation', commandInvocation_serviceRole - The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per instance basis.

The instance ID in which this invocation was requested.

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

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

Plugins processed by the command.

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

The document name that was requested for execution.

The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the 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 S3 bucket was defined for the command.

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 in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

• Pending: The command hasn't been sent to the instance.
• In Progress: The command has been sent to the instance but hasn't 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 wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't 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 wasn't 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 wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't 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.

The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the 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 S3 bucket was defined for the command.

The command against which this invocation was requested.

The Systems Manager document (SSM document) version.

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

Gets the trace output sent by the agent.

The fully qualified host name of the managed instance.

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

The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per instance basis.