Class: Aws::SSM::Types::GetCommandInvocationRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass GetCommandInvocationRequest data as a hash:

{
  command_id: "CommandId", # required
  instance_id: "InstanceId", # required
  plugin_name: "CommandPluginName",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#command_idString

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

Returns:

  • (String)

8412
8413
8414
8415
8416
8417
8418
# File 'lib/aws-sdk-ssm/types.rb', line 8412

class GetCommandInvocationRequest < Struct.new(
  :command_id,
  :instance_id,
  :plugin_name)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

(Required) The ID of the managed node targeted by the command. A *managed node* can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Returns:

  • (String)

8412
8413
8414
8415
8416
8417
8418
# File 'lib/aws-sdk-ssm/types.rb', line 8412

class GetCommandInvocationRequest < Struct.new(
  :command_id,
  :instance_id,
  :plugin_name)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_nameString

The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like `aws:RunShellScript`.

To find the `PluginName`, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the `CommandId` and `Details` parameters. The `PluginName` is the `Name` attribute of the `CommandPlugin` object in the `CommandPlugins` list.

Returns:

  • (String)

8412
8413
8414
8415
8416
8417
8418
# File 'lib/aws-sdk-ssm/types.rb', line 8412

class GetCommandInvocationRequest < Struct.new(
  :command_id,
  :instance_id,
  :plugin_name)
  SENSITIVE = []
  include Aws::Structure
end