Package 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 Details

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • pluginName

      GetCommandInvocationRequest.Builder pluginName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetCommandInvocationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetCommandInvocationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.