List Commands

ssm_list_commands

R Documentation

Lists the commands requested by users of the Amazon Web Services account

Description

Lists the commands requested by users of the Amazon Web Services account.

Usage

ssm_list_commands(CommandId, InstanceId, MaxResults, NextToken, Filters)

Arguments

CommandId

(Optional) If provided, lists only the specified command.

InstanceId

(Optional) Lists commands issued against this managed node ID.

You can't specify a managed node ID in the same command that you specify Status = Pending. This is because the command hasn't reached the managed node yet.

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.

Value

A list with the following syntax:

list(
  Commands = list(
    list(
      CommandId = "string",
      DocumentName = "string",
      DocumentVersion = "string",
      Comment = "string",
      ExpiresAfter = as.POSIXct(
        "2015-01-01"
      ),
      Parameters = list(
        list(
          "string"
        )
      ),
      InstanceIds = list(
        "string"
      ),
      Targets = list(
        list(
          Key = "string",
          Values = list(
            "string"
          )
        )
      ),
      RequestedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      Status = "Pending"|"InProgress"|"Success"|"Cancelled"|"Failed"|"TimedOut"|"Cancelling",
      StatusDetails = "string",
      OutputS3Region = "string",
      OutputS3BucketName = "string",
      OutputS3KeyPrefix = "string",
      MaxConcurrency = "string",
      MaxErrors = "string",
      TargetCount = 123,
      CompletedCount = 123,
      ErrorCount = 123,
      DeliveryTimedOutCount = 123,
      ServiceRole = "string",
      NotificationConfig = list(
        NotificationArn = "string",
        NotificationEvents = list(
          "All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"
        ),
        NotificationType = "Command"|"Invocation"
      ),
      CloudWatchOutputConfig = list(
        CloudWatchLogGroupName = "string",
        CloudWatchOutputEnabled = TRUE|FALSE
      ),
      TimeoutSeconds = 123,
      AlarmConfiguration = list(
        IgnorePollAlarmFailure = TRUE|FALSE,
        Alarms = list(
          list(
            Name = "string"
          )
        )
      ),
      TriggeredAlarms = list(
        list(
          Name = "string",
          State = "UNKNOWN"|"ALARM"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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