ssm_get_command_invocation: Returns detailed information about command execution for an...

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Returns detailed information about command execution for an invocation or plugin.

Usage

1
ssm_get_command_invocation(CommandId, InstanceId, PluginName)

Arguments

CommandId

[required] (Required) The parent command ID of the invocation plugin.

InstanceId

[required] (Required) The ID of the managed instance targeted by the command. A managed instance can be an EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

PluginName

(Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned.

Plugin names are also referred to as step names in Systems Manager documents.

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
list(
  CommandId = "string",
  InstanceId = "string",
  Comment = "string",
  DocumentName = "string",
  DocumentVersion = "string",
  PluginName = "string",
  ResponseCode = 123,
  ExecutionStartDateTime = "string",
  ExecutionElapsedTime = "string",
  ExecutionEndDateTime = "string",
  Status = "Pending"|"InProgress"|"Delayed"|"Success"|"Cancelled"|"TimedOut"|"Failed"|"Cancelling",
  StatusDetails = "string",
  StandardOutputContent = "string",
  StandardOutputUrl = "string",
  StandardErrorContent = "string",
  StandardErrorUrl = "string",
  CloudWatchOutputConfig = list(
    CloudWatchLogGroupName = "string",
    CloudWatchOutputEnabled = TRUE|FALSE
  )
)

Request syntax

1
2
3
4
5
svc$get_command_invocation(
  CommandId = "string",
  InstanceId = "string",
  PluginName = "string"
)

paws.management documentation built on March 8, 2021, 1:07 a.m.