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)`
`CloudWatchOutputConfig`	`getCloudWatchOutputConfig()` Amazon CloudWatch Logs information where Systems Manager sent the command output.
`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 run.
`String`	`getDocumentVersion()` The Systems Manager document (SSM document) version used in the request.
`String`	`getExecutionElapsedTime()` Duration since `ExecutionStartDateTime`.
`String`	`getExecutionEndDateTime()` The date and time the plugin finished running.
`String`	`getExecutionStartDateTime()` The date and time the plugin started running.
`String`	`getInstanceId()` The ID of the managed node targeted by the command.
`String`	`getPluginName()` The name of the plugin, or step name, for which details are reported.
`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 Simple Storage Service (Amazon S3).
`String`	`getStatus()` The status of this invocation plugin.
`String`	`getStatusDetails()` A detailed status of the command execution for an invocation.
`int`	`hashCode()`
`void`	`setCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)` Amazon CloudWatch Logs information where Systems Manager sent the command output.
`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 run.
`void`	`setDocumentVersion(String documentVersion)` The Systems Manager document (SSM document) version used in the request.
`void`	`setExecutionElapsedTime(String executionElapsedTime)` Duration since `ExecutionStartDateTime`.
`void`	`setExecutionEndDateTime(String executionEndDateTime)` The date and time the plugin finished running.
`void`	`setExecutionStartDateTime(String executionStartDateTime)` The date and time the plugin started running.
`void`	`setInstanceId(String instanceId)` The ID of the managed node targeted by the command.
`void`	`setPluginName(String pluginName)` The name of the plugin, or step name, for which details are reported.
`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 Simple Storage Service (Amazon S3).
`void`	`setStatus(CommandInvocationStatus status)` The status of this invocation plugin.
`void`	`setStatus(String status)` The status of this invocation plugin.
`void`	`setStatusDetails(String statusDetails)` A detailed status of the command execution for an invocation.
`String`	`toString()` Returns a string representation of this object.
`GetCommandInvocationResult`	`withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)` Amazon CloudWatch Logs information where Systems Manager sent the command output.
`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 run.
`GetCommandInvocationResult`	`withDocumentVersion(String documentVersion)` The Systems Manager document (SSM document) version used in the request.
`GetCommandInvocationResult`	`withExecutionElapsedTime(String executionElapsedTime)` Duration since `ExecutionStartDateTime`.
`GetCommandInvocationResult`	`withExecutionEndDateTime(String executionEndDateTime)` The date and time the plugin finished running.
`GetCommandInvocationResult`	`withExecutionStartDateTime(String executionStartDateTime)` The date and time the plugin started running.
`GetCommandInvocationResult`	`withInstanceId(String instanceId)` The ID of the managed node targeted by the command.
`GetCommandInvocationResult`	`withPluginName(String pluginName)` The name of the plugin, or step name, for which details are reported.
`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 Simple Storage Service (Amazon S3).
`GetCommandInvocationResult`	`withStatus(CommandInvocationStatus status)` The status of this invocation plugin.
`GetCommandInvocationResult`	`withStatus(String status)` The status of this invocation plugin.
`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 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.
  - getInstanceId
```
public String getInstanceId()
```
    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:
    
    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.
  - withInstanceId
```
public GetCommandInvocationResult withInstanceId(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.
  - 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 run. For example, AWS-RunShellScript.
    
    Parameters:
    
    documentName - The name of the document that was run. For example, AWS-RunShellScript.
  - getDocumentName
```
public String getDocumentName()
```
    The name of the document that was run. For example, AWS-RunShellScript.
    
    Returns:
    
    The name of the document that was run. For example, AWS-RunShellScript.
  - withDocumentName
```
public GetCommandInvocationResult withDocumentName(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.
  - setDocumentVersion
```
public void setDocumentVersion(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.
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The Systems Manager document (SSM document) version used in the request.
    
    Returns:
    
    The Systems Manager document (SSM document) version used in the request.
  - withDocumentVersion
```
public GetCommandInvocationResult withDocumentVersion(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.
  - setPluginName
```
public void setPluginName(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.
  - getPluginName
```
public String getPluginName()
```
    The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.
    
    Returns:
    
    The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.
  - withPluginName
```
public GetCommandInvocationResult withPluginName(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.
  - setResponseCode
```
public void setResponseCode(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.
  - getResponseCode
```
public Integer getResponseCode()
```
    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:
    
    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.
  - withResponseCode
```
public GetCommandInvocationResult withResponseCode(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.
  - setExecutionStartDateTime
```
public void setExecutionStartDateTime(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.
  - getExecutionStartDateTime
```
public String getExecutionStartDateTime()
```
    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:
    
    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.
  - withExecutionStartDateTime
```
public GetCommandInvocationResult withExecutionStartDateTime(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.
  - 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 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.
  - getExecutionEndDateTime
```
public String getExecutionEndDateTime()
```
    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:
    
    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.
  - withExecutionEndDateTime
```
public GetCommandInvocationResult withExecutionEndDateTime(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.
  - setStatus
```
public void setStatus(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.
    
    See Also:
    
    CommandInvocationStatus
  - getStatus
```
public String getStatus()
```
    The status of this invocation plugin. This status can be different than StatusDetails.
    
    Returns:
    
    The status of this invocation plugin. This status can be different than StatusDetails.
    
    See Also:
    
    CommandInvocationStatus
  - withStatus
```
public GetCommandInvocationResult withStatus(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:
    
    CommandInvocationStatus
  - setStatus
```
public void setStatus(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.
    
    See Also:
    
    CommandInvocationStatus
  - withStatus
```
public GetCommandInvocationResult withStatus(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:
    
    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 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.
  - 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 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:
    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.
  - 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 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.
  - setStandardOutputContent
```
public void setStandardOutputContent(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.
  - getStandardOutputContent
```
public String getStandardOutputContent()
```
    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:
    
    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.
  - withStandardOutputContent
```
public GetCommandInvocationResult withStandardOutputContent(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.
  - setStandardOutputUrl
```
public void setStandardOutputUrl(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.
  - getStandardOutputUrl
```
public String getStandardOutputUrl()
```
    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:
    
    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.
  - withStandardOutputUrl
```
public GetCommandInvocationResult withStandardOutputUrl(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.
  - setStandardErrorContent
```
public void setStandardErrorContent(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.
  - getStandardErrorContent
```
public String getStandardErrorContent()
```
    The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
    
    Returns:
    
    The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, 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 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.
  - setStandardErrorUrl
```
public void setStandardErrorUrl(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.
  - getStandardErrorUrl
```
public String getStandardErrorUrl()
```
    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:
    
    The URL for the complete text written by the plugin to stderr. If the command hasn't finished running, 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 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.
  - setCloudWatchOutputConfig
```
public void setCloudWatchOutputConfig(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.
  - getCloudWatchOutputConfig
```
public CloudWatchOutputConfig getCloudWatchOutputConfig()
```
    Amazon CloudWatch Logs information where Systems Manager sent the command output.
    
    Returns:
    
    Amazon CloudWatch Logs information where Systems Manager sent the command output.
  - withCloudWatchOutputConfig
```
public GetCommandInvocationResult withCloudWatchOutputConfig(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.
  - toString
```
public 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
    
    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

AWS SDK for Java 1.x API Reference - 1.12.772

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

setDocumentVersion

getDocumentVersion

withDocumentVersion

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

setCloudWatchOutputConfig

getCloudWatchOutputConfig

withCloudWatchOutputConfig

toString

equals

hashCode

clone