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

Interface GetCommandInvocationResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>, SdkBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>, SdkPojo, SdkResponse.Builder, SsmResponse.Builder
Enclosing class:
GetCommandInvocationResponse
public static interface GetCommandInvocationResponse.Builder extends SsmResponse.Builder, SdkPojo, CopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>

  • Method Details

    • commandId

      GetCommandInvocationResponse.Builder commandId(String commandId)

      The parent command ID of the invocation plugin.

      Parameters:
      commandId - The parent command ID of the invocation plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceId

      GetCommandInvocationResponse.Builder instanceId(String instanceId)

      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, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

      Parameters:
      instanceId - 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, or 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.

    • comment

      GetCommandInvocationResponse.Builder comment(String comment)

      The comment text for the command.

      Parameters:
      comment - The comment text for the command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentName

      GetCommandInvocationResponse.Builder documentName(String documentName)

      The name of the document that was run. For example, AWS-RunShellScript.

      Parameters:
      documentName - The name of the document that was run. For example, AWS-RunShellScript.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentVersion

      GetCommandInvocationResponse.Builder documentVersion(String documentVersion)

      The Systems Manager document (SSM document) version used in the request.

      Parameters:
      documentVersion - The Systems Manager document (SSM document) version used in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pluginName

      GetCommandInvocationResponse.Builder pluginName(String pluginName)

      The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.

      Parameters:
      pluginName - The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseCode

      GetCommandInvocationResponse.Builder responseCode(Integer responseCode)

      The error level response code for the plugin script. If the response code is -1, then the command hasn't started running on the managed node, or it wasn't received by the node.

      Parameters:
      responseCode - The error level response code for the plugin script. If the response code is -1, then the command hasn't started running on the managed node, or it wasn't received by the node.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionStartDateTime

      GetCommandInvocationResponse.Builder executionStartDateTime(String executionStartDateTime)

      The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedBefore filter.

      aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z

      If the plugin hasn't started to run, the string is empty.

      Parameters:
      executionStartDateTime - The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedBefore filter.

      aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z

      If the plugin hasn't started to run, the string is empty.

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

    • executionElapsedTime

      GetCommandInvocationResponse.Builder executionElapsedTime(String executionElapsedTime)

      Duration since ExecutionStartDateTime.

      Parameters:
      executionElapsedTime - Duration since ExecutionStartDateTime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionEndDateTime

      GetCommandInvocationResponse.Builder executionEndDateTime(String executionEndDateTime)

      The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter filter.

      aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z

      If the plugin hasn't started to run, the string is empty.

      Parameters:
      executionEndDateTime - The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter filter.

      aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z

      If the plugin hasn't started to run, the string is empty.

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

    • status

      GetCommandInvocationResponse.Builder status(String status)

      The status of this invocation plugin. This status can be different than StatusDetails.

      Parameters:
      status - The status of this invocation plugin. This status can be different than StatusDetails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetCommandInvocationResponse.Builder status(CommandInvocationStatus status)

      The status of this invocation plugin. This status can be different than StatusDetails.

      Parameters:
      status - The status of this invocation plugin. This status can be different than StatusDetails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusDetails

      GetCommandInvocationResponse.Builder statusDetails(String statusDetails)

      A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

      • Pending: The command hasn't been sent to the managed node.

      • In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

      • Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.

      • Success: The command or plugin ran successfully. This is a terminal state.

      • Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

      • Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

      • Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

      • Cancelled: The command was terminated before it was completed. This is a terminal state.

      • Undeliverable: The command can't be delivered to the managed node. The node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

      • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

      Parameters:
      statusDetails - A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

      • Pending: The command hasn't been sent to the managed node.

      • In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

      • Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.

      • Success: The command or plugin ran successfully. This is a terminal state.

      • Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

      • Execution Timed Out: The command started to run on the managed node, but the execution wasn't complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

      • Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

      • Cancelled: The command was terminated before it was completed. This is a terminal state.

      • Undeliverable: The command can't be delivered to the managed node. The node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

      • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

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

    • standardOutputContent

      GetCommandInvocationResponse.Builder standardOutputContent(String standardOutputContent)

      The first 24,000 characters written by the plugin to stdout. If the command hasn't finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.

      Parameters:
      standardOutputContent - The first 24,000 characters written by the plugin to stdout. If the command hasn't finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardOutputUrl

      GetCommandInvocationResponse.Builder standardOutputUrl(String standardOutputUrl)

      The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.

      Parameters:
      standardOutputUrl - The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardErrorContent

      GetCommandInvocationResponse.Builder standardErrorContent(String standardErrorContent)

      The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, then this string is empty.

      Parameters:
      standardErrorContent - The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardErrorUrl

      GetCommandInvocationResponse.Builder standardErrorUrl(String standardErrorUrl)

      The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, then this string is empty.

      Parameters:
      standardErrorUrl - The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cloudWatchOutputConfig

      GetCommandInvocationResponse.Builder cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)

      Amazon CloudWatch Logs information where Systems Manager sent the command output.

      Parameters:
      cloudWatchOutputConfig - Amazon CloudWatch Logs information where Systems Manager sent the command output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cloudWatchOutputConfig

      default GetCommandInvocationResponse.Builder cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)

      Amazon CloudWatch Logs information where Systems Manager sent the command output.

      This is a convenience method that creates an instance of the CloudWatchOutputConfig.Builder avoiding the need to create one manually via CloudWatchOutputConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchOutputConfig(CloudWatchOutputConfig).

      Parameters:
      cloudWatchOutputConfig - a consumer that will call methods on CloudWatchOutputConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: