ssm_list_commands: Lists the commands requested by users of the AWS account

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Lists the commands requested by users of the AWS account.

Usage

1
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 instance ID.

You can't specify an instance ID in the same command that you specify Status = Pending. This is because the command has not reached the instance 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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
    )
  ),
  NextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
svc$list_commands(
  CommandId = "string",
  InstanceId = "string",
  MaxResults = 123,
  NextToken = "string",
  Filters = list(
    list(
      key = "InvokedAfter"|"InvokedBefore"|"Status"|"ExecutionStage"|"DocumentName",
      value = "string"
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.