Skip to content

List Command Invocations

ssm_list_command_invocations R Documentation

An invocation is copy of a command sent to a specific managed node

Description

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 send_command against three managed nodes, then a command invocation is created for each requested managed node ID. list_command_invocations provide status about command execution.

Usage

ssm_list_command_invocations(CommandId, InstanceId, MaxResults,
  NextToken, Filters, Details)

Arguments

CommandId

(Optional) The invocations for a specific command ID.

InstanceId

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

MaxResults

(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.

NextToken

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

Filters

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

Details

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

Value

A list with the following syntax: 

list(
  CommandInvocations = list(
    list(
      CommandId = "string",
      InstanceId = "string",
      InstanceName = "string",
      Comment = "string",
      DocumentName = "string",
      DocumentVersion = "string",
      RequestedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      Status = "Pending"|"InProgress"|"Delayed"|"Success"|"Cancelled"|"TimedOut"|"Failed"|"Cancelling",
      StatusDetails = "string",
      TraceOutput = "string",
      StandardOutputUrl = "string",
      StandardErrorUrl = "string",
      CommandPlugins = list(
        list(
          Name = "string",
          Status = "Pending"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed",
          StatusDetails = "string",
          ResponseCode = 123,
          ResponseStartDateTime = as.POSIXct(
            "2015-01-01"
          ),
          ResponseFinishDateTime = as.POSIXct(
            "2015-01-01"
          ),
          Output = "string",
          StandardOutputUrl = "string",
          StandardErrorUrl = "string",
          OutputS3Region = "string",
          OutputS3BucketName = "string",
          OutputS3KeyPrefix = "string"
        )
      ),
      ServiceRole = "string",
      NotificationConfig = list(
        NotificationArn = "string",
        NotificationEvents = list(
          "All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"
        ),
        NotificationType = "Command"|"Invocation"
      ),
      CloudWatchOutputConfig = list(
        CloudWatchLogGroupName = "string",
        CloudWatchOutputEnabled = TRUE|FALSE
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_command_invocations(
  CommandId = "string",
  InstanceId = "string",
  MaxResults = 123,
  NextToken = "string",
  Filters = list(
    list(
      key = "InvokedAfter"|"InvokedBefore"|"Status"|"ExecutionStage"|"DocumentName",
      value = "string"
    )
  ),
  Details = TRUE|FALSE
)