/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

An invocation is 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. ListCommandInvocations provide status about command execution.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "CommandId": "string",
    "InstanceId": "string",
    "MaxResults": 0,
    "NextToken": "string",
    "Filters": [],
    "Details": true
}'

Response Example

200 - Example 1

{
    "CommandInvocations": [],
    "NextToken": "string"
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

CommandId

string

optional

(Optional) The invocations for a specific command ID.

>= 36 characters<= 36 characters

InstanceId

string

optional

(Optional) The command execution details for a specific managed node ID.

Match pattern:

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

MaxResults

integer

optional

(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

>= 1<= 50

NextToken

string

optional

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

Filters

array[object (CommandFilter) {2}]

optional

(Optional) One or more filters. Use a filter to return a more specific list of results.

>= 1 items<= 5 items

key

enum<string>

required

The name of the filter.

Allowed values:

InvokedAfterInvokedBeforeStatusExecutionStageDocumentName

value

string

required

The filter value. Valid values for each filter key are as follows:

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions occurring July 7, 2021, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions from before July 7, 2021.
Status: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call.

The status values you can specify for ListCommands are:
- Pending
- InProgress
- Success
- Cancelled
- Failed
- TimedOut (this includes both Delivery and Execution time outs)
- AccessDenied
- DeliveryTimedOut
- ExecutionTimedOut
- Incomplete
- NoInstancesInTag
- LimitExceeded
The status values you can specify for ListCommandInvocations are:
- Pending
- InProgress
- Delayed
- Success
- Cancelled
- Failed
- TimedOut (this includes both Delivery and Execution time outs)
- AccessDenied
- DeliveryTimedOut
- ExecutionTimedOut
- Undeliverable
- InvalidPlatform
- Terminated
DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on managed nodes.
ExecutionStage: Specify one of the following values (ListCommands operations only):
- Executing: Returns a list of command executions that are currently still running.
- Complete: Returns a list of command executions that have already completed.

>= 1 characters<= 128 characters

Details

boolean

optional

(Optional) If set this returns the response of the command executions and any command output. The default value is false.

Examples

Responses

🟢200Success

application/json

Body

CommandInvocations

array[object (CommandInvocation) {16}]

optional

(Optional) A list of all invocations.

CommandId

string

optional

The command against which this invocation was requested.

>= 36 characters<= 36 characters

InstanceId

string

optional

The managed node ID in which this invocation was requested.

Match pattern:

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

InstanceName

string

optional

The fully qualified host name of the managed node.

<= 255 characters

Comment

string

optional

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

<= 100 characters

DocumentName

string

optional

The document name that was requested for execution.

Match pattern:

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

DocumentVersion

string

optional

The Systems Manager document (SSM document) version.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

RequestedDateTime

string <date-time>

optional

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

Status

enum<string>

optional

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

Allowed values:

PendingInProgressDelayedSuccessCancelledTimedOutFailedCancelling

StatusDetails

string

optional

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:

Pending: The command hasn't been sent to the managed node.
In Progress: The command has been sent to the managed node 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 managed node 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 managed node, 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 managed node. 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.
Cancelled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the managed node. The managed node 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.
Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.

>= 0 characters<= 100 characters

TraceOutput

string

optional

Gets the trace output sent by the agent.

<= 2500 characters

StandardOutputUrl

string

optional

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.

StandardErrorUrl

string

optional

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.

CommandPlugins

array[object (CommandPlugin) {12}]

optional

Plugins processed by the command.

ServiceRole

string

optional

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.

NotificationConfig

object

optional

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

CloudWatchOutputConfig

object

optional

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

NextToken

string

optional

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

🟠480InternalServerError

🟠481InvalidCommandId

🟠482InvalidInstanceId

🟠483InvalidFilterKey

🟠484InvalidNextToken