software.amazon.awssdk.services.ssm.model

Interface GetCommandInvocationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetCommandInvocationRequest.Builder,GetCommandInvocationRequest>, SdkBuilder<GetCommandInvocationRequest.Builder,GetCommandInvocationRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

GetCommandInvocationRequest

public static interface GetCommandInvocationRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<GetCommandInvocationRequest.Builder,GetCommandInvocationRequest>

Method Summary

Modifier and Type	Method and Description
GetCommandInvocationRequest.Builder	commandId(String commandId) (Required) The parent command ID of the invocation plugin.
GetCommandInvocationRequest.Builder	instanceId(String instanceId) (Required) The ID of the managed instance targeted by the command.
GetCommandInvocationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetCommandInvocationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetCommandInvocationRequest.Builder	pluginName(String pluginName) The name of the plugin for which you want detailed results.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

commandId

GetCommandInvocationRequest.Builder commandId(String commandId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceId

GetCommandInvocationRequest.Builder instanceId(String instanceId)

(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.

Parameters:

instanceId - (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:

Returns a reference to this object so that method calls can be chained together.

pluginName

GetCommandInvocationRequest.Builder pluginName(String pluginName)

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.

Parameters:

pluginName - 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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

GetCommandInvocationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetCommandInvocationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder