software.amazon.awssdk.services.ssm.model

Interface GetCommandInvocationResponse.Builder

All Superinterfaces:

CopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>, SdkBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>, SsmResponse.Builder

Enclosing class:

GetCommandInvocationResponse

public static interface GetCommandInvocationResponse.Builder
extends SsmResponse.Builder, CopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>

Method Summary

Modifier and Type	Method and Description
GetCommandInvocationResponse.Builder	commandId(String commandId) The parent command ID of the invocation plugin.
GetCommandInvocationResponse.Builder	comment(String comment) The comment text for the command.
GetCommandInvocationResponse.Builder	documentName(String documentName) The name of the document that was executed.
GetCommandInvocationResponse.Builder	executionElapsedTime(String executionElapsedTime) Duration since ExecutionStartDateTime.
GetCommandInvocationResponse.Builder	executionEndDateTime(String executionEndDateTime) The date and time the plugin was finished executing.
GetCommandInvocationResponse.Builder	executionStartDateTime(String executionStartDateTime) The date and time the plugin started executing.
GetCommandInvocationResponse.Builder	instanceId(String instanceId) The ID of the managed instance targeted by the command.
GetCommandInvocationResponse.Builder	pluginName(String pluginName) The name of the plugin for which you want detailed results.
GetCommandInvocationResponse.Builder	responseCode(Integer responseCode) The error level response code for the plugin script.
GetCommandInvocationResponse.Builder	standardErrorContent(String standardErrorContent) The first 8,000 characters written by the plugin to stderr.
GetCommandInvocationResponse.Builder	standardErrorUrl(String standardErrorUrl) The URL for the complete text written by the plugin to stderr.
GetCommandInvocationResponse.Builder	standardOutputContent(String standardOutputContent) The first 24,000 characters written by the plugin to stdout.
GetCommandInvocationResponse.Builder	standardOutputUrl(String standardOutputUrl) The URL for the complete text written by the plugin to stdout in Amazon S3.
GetCommandInvocationResponse.Builder	status(CommandInvocationStatus status) The status of the parent command for this invocation.
GetCommandInvocationResponse.Builder	status(String status) The status of the parent command for this invocation.
GetCommandInvocationResponse.Builder	statusDetails(String statusDetails) A detailed status of the command execution for an invocation.

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

build

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

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 instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

Parameters:

instanceId - The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for 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 executed. For example, AWS-RunShellScript.

Parameters:

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

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 for which you want detailed results. For example, aws:RunShellScript is a plugin.

Parameters:

pluginName - The name of the plugin for which you want detailed results. 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 has not started executing on the instance, or it was not received by the instance.

Parameters:

responseCode - The error level response code for the plugin script. If the response code is -1, then the command has not started executing on the instance, or it was not received by the instance.

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 executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter.

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

If the plugin has not started to execute, the string is empty.

Parameters:

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

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

If the plugin has not started to execute, 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 was finished executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter.

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

If the plugin has not started to execute, the string is empty.

Parameters:

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

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

If the plugin has not started to execute, 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 the parent command for this invocation. This status can be different than StatusDetails.

Parameters:

status - The status of the parent command for this invocation. This status can be different than StatusDetails.

Returns:

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

See Also:

CommandInvocationStatus, CommandInvocationStatus

status

GetCommandInvocationResponse.Builder status(CommandInvocationStatus status)

The status of the parent command for this invocation. This status can be different than StatusDetails.

Parameters:

status - The status of the parent command for this invocation. This status can be different than StatusDetails.

Returns:

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

See Also:

CommandInvocationStatus, CommandInvocationStatus

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 Run Command Status. StatusDetails can be one of the following values:

• Pending: The command has not been sent to the instance.

• In Progress: The command has been sent to the instance but has not reached a terminal state.

• Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.

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

• Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not 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 execute on the instance, but the execution was not 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 executed successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

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

• Undeliverable: The command can't be delivered to the instance. The instance 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 Run Command Status. StatusDetails can be one of the following values:

• Pending: The command has not been sent to the instance.

• In Progress: The command has been sent to the instance but has not reached a terminal state.

• Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.

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

• Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not 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 execute on the instance, but the execution was not 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 executed successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

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

• Undeliverable: The command can't be delivered to the instance. The instance 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 has not finished executing, 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 has not finished executing, 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 S3. If an Amazon S3 bucket was not specified, then this string is empty.

Parameters:

standardOutputUrl - The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not 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 has not finished executing, then this string is empty.

Parameters:

standardErrorContent - The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, 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 has not finished executing, then this string is empty.

Parameters:

standardErrorUrl - The URL for the complete text written by the plugin to stderr. If the command has not finished executing, then this string is empty.

Returns:

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