Package software.amazon.awssdk.services.ssm.model

Class GetCommandInvocationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.GetCommandInvocationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCommandInvocationRequest.Builder,GetCommandInvocationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetCommandInvocationRequest
extends SsmRequest
implements ToCopyableBuilder<GetCommandInvocationRequest.Builder,GetCommandInvocationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetCommandInvocationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetCommandInvocationRequest.Builder	builder()
String	commandId()	(Required) The parent command ID of the invocation plugin.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	(Required) The ID of the managed node targeted by the command.
String	pluginName()	The name of the step for which you want detailed results.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCommandInvocationRequest.Builder>	serializableBuilderClass()
GetCommandInvocationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

commandId

public final String commandId()

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

Returns:

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

instanceId

public final String instanceId()

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

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

pluginName

public final String pluginName()

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:

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.

toBuilder

public GetCommandInvocationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCommandInvocationRequest.Builder,GetCommandInvocationRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static GetCommandInvocationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetCommandInvocationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo