CommandInvocation

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

The command against which this invocation was requested.

Link copied to clipboard

Plugins processed by the command.

Link copied to clipboard

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

Link copied to clipboard

The document name that was requested for execution.

Link copied to clipboard

The Systems Manager document (SSM document) version.

Link copied to clipboard

The managed node ID in which this invocation was requested.

Link copied to clipboard

The fully qualified host name of the managed node.

Link copied to clipboard

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

Link copied to clipboard

The time and date the request was sent to this managed node.

Link copied to clipboard

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 managed node basis.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

A detailed status of the command execution for each invocation (each managed node 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:

Link copied to clipboard

Gets the trace output sent by the agent.

Functions

Link copied to clipboard
inline fun copy(block: CommandInvocation.Builder.() -> Unit = {}): CommandInvocation
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String