GetCommandInvocationResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.simplesystemsmanagement.model.GetCommandInvocationResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetCommandInvocationResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetCommandInvocationResult()

Constructors
Constructor and Description
`GetCommandInvocationResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetCommandInvocationResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCommandId()` The parent command ID of the invocation plugin.
`String`	`getComment()` The comment text for the command.
`String`	`getDocumentName()` The name of the document that was executed.
`String`	`getExecutionElapsedTime()` Duration since ExecutionStartDateTime.
`String`	`getExecutionEndDateTime()` The date and time the plugin was finished executing.
`String`	`getExecutionStartDateTime()` The date and time the plugin started executing.
`String`	`getInstanceId()` The ID of the managed instance targeted by the command.
`String`	`getPluginName()` The name of the plugin for which you want detailed results.
`Integer`	`getResponseCode()` The error level response code for the plugin script.
`String`	`getStandardErrorContent()` The first 8,000 characters written by the plugin to stderr.
`String`	`getStandardErrorUrl()` The URL for the complete text written by the plugin to stderr.
`String`	`getStandardOutputContent()` The first 24,000 characters written by the plugin to stdout.
`String`	`getStandardOutputUrl()` The URL for the complete text written by the plugin to stdout in Amazon S3.
`String`	`getStatus()` The status of the parent command for this invocation.
`String`	`getStatusDetails()` A detailed status of the command execution for an invocation.
`int`	`hashCode()`
`void`	`setCommandId(String commandId)` The parent command ID of the invocation plugin.
`void`	`setComment(String comment)` The comment text for the command.
`void`	`setDocumentName(String documentName)` The name of the document that was executed.
`void`	`setExecutionElapsedTime(String executionElapsedTime)` Duration since ExecutionStartDateTime.
`void`	`setExecutionEndDateTime(String executionEndDateTime)` The date and time the plugin was finished executing.
`void`	`setExecutionStartDateTime(String executionStartDateTime)` The date and time the plugin started executing.
`void`	`setInstanceId(String instanceId)` The ID of the managed instance targeted by the command.
`void`	`setPluginName(String pluginName)` The name of the plugin for which you want detailed results.
`void`	`setResponseCode(Integer responseCode)` The error level response code for the plugin script.
`void`	`setStandardErrorContent(String standardErrorContent)` The first 8,000 characters written by the plugin to stderr.
`void`	`setStandardErrorUrl(String standardErrorUrl)` The URL for the complete text written by the plugin to stderr.
`void`	`setStandardOutputContent(String standardOutputContent)` The first 24,000 characters written by the plugin to stdout.
`void`	`setStandardOutputUrl(String standardOutputUrl)` The URL for the complete text written by the plugin to stdout in Amazon S3.
`void`	`setStatus(CommandInvocationStatus status)` The status of the parent command for this invocation.
`void`	`setStatus(String status)` The status of the parent command for this invocation.
`void`	`setStatusDetails(String statusDetails)` A detailed status of the command execution for an invocation.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetCommandInvocationResult`	`withCommandId(String commandId)` The parent command ID of the invocation plugin.
`GetCommandInvocationResult`	`withComment(String comment)` The comment text for the command.
`GetCommandInvocationResult`	`withDocumentName(String documentName)` The name of the document that was executed.
`GetCommandInvocationResult`	`withExecutionElapsedTime(String executionElapsedTime)` Duration since ExecutionStartDateTime.
`GetCommandInvocationResult`	`withExecutionEndDateTime(String executionEndDateTime)` The date and time the plugin was finished executing.
`GetCommandInvocationResult`	`withExecutionStartDateTime(String executionStartDateTime)` The date and time the plugin started executing.
`GetCommandInvocationResult`	`withInstanceId(String instanceId)` The ID of the managed instance targeted by the command.
`GetCommandInvocationResult`	`withPluginName(String pluginName)` The name of the plugin for which you want detailed results.
`GetCommandInvocationResult`	`withResponseCode(Integer responseCode)` The error level response code for the plugin script.
`GetCommandInvocationResult`	`withStandardErrorContent(String standardErrorContent)` The first 8,000 characters written by the plugin to stderr.
`GetCommandInvocationResult`	`withStandardErrorUrl(String standardErrorUrl)` The URL for the complete text written by the plugin to stderr.
`GetCommandInvocationResult`	`withStandardOutputContent(String standardOutputContent)` The first 24,000 characters written by the plugin to stdout.
`GetCommandInvocationResult`	`withStandardOutputUrl(String standardOutputUrl)` The URL for the complete text written by the plugin to stdout in Amazon S3.
`GetCommandInvocationResult`	`withStatus(CommandInvocationStatus status)` The status of the parent command for this invocation.
`GetCommandInvocationResult`	`withStatus(String status)` The status of the parent command for this invocation.
`GetCommandInvocationResult`	`withStatusDetails(String statusDetails)` A detailed status of the command execution for an invocation.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetCommandInvocationResult
```
public GetCommandInvocationResult()
```
- Method Detail
  - setCommandId
```
public void setCommandId(String commandId)
```
    The parent command ID of the invocation plugin.
    
    Parameters:
    
    commandId - The parent command ID of the invocation plugin.
  - getCommandId
```
public String getCommandId()
```
    The parent command ID of the invocation plugin.
    
    Returns:
    
    The parent command ID of the invocation plugin.
  - withCommandId
```
public GetCommandInvocationResult withCommandId(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.
  - setInstanceId
```
public void setInstanceId(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.
  - getInstanceId
```
public String getInstanceId()
```
    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:
    
    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.
  - withInstanceId
```
public GetCommandInvocationResult withInstanceId(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.
  - setComment
```
public void setComment(String comment)
```
    The comment text for the command.
    
    Parameters:
    
    comment - The comment text for the command.
  - getComment
```
public String getComment()
```
    The comment text for the command.
    
    Returns:
    
    The comment text for the command.
  - withComment
```
public GetCommandInvocationResult withComment(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.
  - setDocumentName
```
public void setDocumentName(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.
  - getDocumentName
```
public String getDocumentName()
```
    The name of the document that was executed. For example, AWS-RunShellScript.
    
    Returns:
    
    The name of the document that was executed. For example, AWS-RunShellScript.
  - withDocumentName
```
public GetCommandInvocationResult withDocumentName(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.
  - setPluginName
```
public void setPluginName(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.
  - getPluginName
```
public String getPluginName()
```
    The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.
    
    Returns:
    
    The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.
  - withPluginName
```
public GetCommandInvocationResult withPluginName(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.
  - setResponseCode
```
public void setResponseCode(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.
  - getResponseCode
```
public Integer getResponseCode()
```
    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:
    
    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.
  - withResponseCode
```
public GetCommandInvocationResult withResponseCode(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.
  - setExecutionStartDateTime
```
public void setExecutionStartDateTime(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.
  - getExecutionStartDateTime
```
public String getExecutionStartDateTime()
```
    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:
    
    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.
  - withExecutionStartDateTime
```
public GetCommandInvocationResult withExecutionStartDateTime(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.
  - setExecutionElapsedTime
```
public void setExecutionElapsedTime(String executionElapsedTime)
```
    Duration since ExecutionStartDateTime.
    
    Parameters:
    
    executionElapsedTime - Duration since ExecutionStartDateTime.
  - getExecutionElapsedTime
```
public String getExecutionElapsedTime()
```
    Duration since ExecutionStartDateTime.
    
    Returns:
    
    Duration since ExecutionStartDateTime.
  - withExecutionElapsedTime
```
public GetCommandInvocationResult withExecutionElapsedTime(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.
  - setExecutionEndDateTime
```
public void setExecutionEndDateTime(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.
  - getExecutionEndDateTime
```
public String getExecutionEndDateTime()
```
    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:
    
    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.
  - withExecutionEndDateTime
```
public GetCommandInvocationResult withExecutionEndDateTime(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.
  - setStatus
```
public void setStatus(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.
    
    See Also:
    
    CommandInvocationStatus
  - getStatus
```
public String getStatus()
```
    The status of the parent command for this invocation. This status can be different than StatusDetails.
    
    Returns:
    
    The status of the parent command for this invocation. This status can be different than StatusDetails.
    
    See Also:
    
    CommandInvocationStatus
  - withStatus
```
public GetCommandInvocationResult withStatus(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
  - setStatus
```
public void setStatus(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.
    
    See Also:
    
    CommandInvocationStatus
  - withStatus
```
public GetCommandInvocationResult withStatus(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
  - setStatusDetails
```
public void setStatusDetails(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.
  - getStatusDetails
```
public String getStatusDetails()
```
    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:
    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.
  - withStatusDetails
```
public GetCommandInvocationResult withStatusDetails(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.
  - setStandardOutputContent
```
public void setStandardOutputContent(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.
  - getStandardOutputContent
```
public String getStandardOutputContent()
```
    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:
    
    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.
  - withStandardOutputContent
```
public GetCommandInvocationResult withStandardOutputContent(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.
  - setStandardOutputUrl
```
public void setStandardOutputUrl(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.
  - getStandardOutputUrl
```
public String getStandardOutputUrl()
```
    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:
    
    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.
  - withStandardOutputUrl
```
public GetCommandInvocationResult withStandardOutputUrl(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.
  - setStandardErrorContent
```
public void setStandardErrorContent(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.
  - getStandardErrorContent
```
public String getStandardErrorContent()
```
    The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, then this string is empty.
    
    Returns:
    
    The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, then this string is empty.
  - withStandardErrorContent
```
public GetCommandInvocationResult withStandardErrorContent(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.
  - setStandardErrorUrl
```
public void setStandardErrorUrl(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.
  - getStandardErrorUrl
```
public String getStandardErrorUrl()
```
    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:
    
    The URL for the complete text written by the plugin to stderr. If the command has not finished executing, then this string is empty.
  - withStandardErrorUrl
```
public GetCommandInvocationResult withStandardErrorUrl(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetCommandInvocationResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetCommandInvocationResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetCommandInvocationResult

Method Detail

setCommandId

getCommandId

withCommandId

setInstanceId

getInstanceId

withInstanceId

setComment

getComment

withComment

setDocumentName

getDocumentName

withDocumentName

setPluginName

getPluginName

withPluginName

setResponseCode

getResponseCode

withResponseCode

setExecutionStartDateTime

getExecutionStartDateTime

withExecutionStartDateTime

setExecutionElapsedTime

getExecutionElapsedTime

withExecutionElapsedTime

setExecutionEndDateTime

getExecutionEndDateTime

withExecutionEndDateTime

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusDetails

getStatusDetails

withStatusDetails

setStandardOutputContent

getStandardOutputContent

withStandardOutputContent

setStandardOutputUrl

getStandardOutputUrl

withStandardOutputUrl

setStandardErrorContent

getStandardErrorContent

withStandardErrorContent

setStandardErrorUrl

getStandardErrorUrl

withStandardErrorUrl

toString

equals

hashCode

clone