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)

8039
8040
8041
8042
8043
8044
8045
# File 'lib/aws-sdk-ssm/types.rb', line 8039

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

#instance_idString

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Returns:

  • (String)

8039
8040
8041
8042
8043
8044
8045
# File 'lib/aws-sdk-ssm/types.rb', line 8039

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

#plugin_nameString

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as *step names* in Systems Manager documents (SSM documents). For example, `aws:RunShellScript` is a plugin.

To find the `PluginName`, check the document content and find the name of the plugin. 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)

8039
8040
8041
8042
8043
8044
8045
# File 'lib/aws-sdk-ssm/types.rb', line 8039

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