GetCommandInvocationResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.ssm.model.SsmResponse
    - - software.amazon.awssdk.services.ssm.model.GetCommandInvocationResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetCommandInvocationResponse
extends SsmResponse
implements ToCopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetCommandInvocationResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetCommandInvocationResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetCommandInvocationResponse.Builder`	`builder()`
`CloudWatchOutputConfig`	`cloudWatchOutputConfig()` Amazon CloudWatch Logs information where Systems Manager sent the command output.
`String`	`commandId()` The parent command ID of the invocation plugin.
`String`	`comment()` The comment text for the command.
`String`	`documentName()` The name of the document that was run.
`String`	`documentVersion()` The Systems Manager document (SSM document) version used in the request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`String`	`executionElapsedTime()` Duration since `ExecutionStartDateTime`.
`String`	`executionEndDateTime()` The date and time the plugin finished running.
`String`	`executionStartDateTime()` The date and time the plugin started running.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`String`	`instanceId()` The ID of the managed instance targeted by the command.
`String`	`pluginName()` The name of the plugin, or step name, for which details are reported.
`Integer`	`responseCode()` The error level response code for the plugin script.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetCommandInvocationResponse.Builder>`	`serializableBuilderClass()`
`String`	`standardErrorContent()` The first 8,000 characters written by the plugin to `stderr`.
`String`	`standardErrorUrl()` The URL for the complete text written by the plugin to `stderr`.
`String`	`standardOutputContent()` The first 24,000 characters written by the plugin to `stdout`.
`String`	`standardOutputUrl()` The URL for the complete text written by the plugin to `stdout` in Amazon Simple Storage Service (Amazon S3).
`CommandInvocationStatus`	`status()` The status of this invocation plugin.
`String`	`statusAsString()` The status of this invocation plugin.
`String`	`statusDetails()` A detailed status of the command execution for an invocation.
`GetCommandInvocationResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - commandId
```
public final String commandId()
```
    The parent command ID of the invocation plugin.
    
    Returns:
    
    The parent command ID of the invocation plugin.
  - instanceId
```
public final String instanceId()
```
    The ID of the managed instance targeted by the command. A managed instance can be an 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 EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.
  - comment
```
public final String comment()
```
    The comment text for the command.
    
    Returns:
    
    The comment text for the command.
  - documentName
```
public final String documentName()
```
    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.
  - documentVersion
```
public final String documentVersion()
```
    The Systems Manager document (SSM document) version used in the request.
    
    Returns:
    
    The Systems Manager document (SSM document) version used in the request.
  - pluginName
```
public final String pluginName()
```
    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.
  - responseCode
```
public final 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 instance, or it wasn't received by the instance.
    
    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 instance, or it wasn't received by the instance.
  - executionStartDateTime
```
public final 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.
    
    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.
  - executionElapsedTime
```
public final String executionElapsedTime()
```
    Duration since ExecutionStartDateTime.
    
    Returns:
    
    Duration since ExecutionStartDateTime.
  - executionEndDateTime
```
public final 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.
    
    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.
  - status
```
public final CommandInvocationStatus status()
```
    The status of this invocation plugin. This status can be different than StatusDetails.
    
    If the service returns an enum value that is not available in the current SDK version, status will return CommandInvocationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of this invocation plugin. This status can be different than StatusDetails.
    
    See Also:
    
    CommandInvocationStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of this invocation plugin. This status can be different than StatusDetails.
    
    If the service returns an enum value that is not available in the current SDK version, status will return CommandInvocationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of this invocation plugin. This status can be different than StatusDetails.
    
    See Also:
    
    CommandInvocationStatus
  - statusDetails
```
public final 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 instance.
    - In Progress: The command has been sent to the instance 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 instance might not be available because of network issues, because the instance 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 instance 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 instance, 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 instance. 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.
    - 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 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 instance.
    
    In Progress: The command has been sent to the instance 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 instance might not be available because of network issues, because the instance 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 instance 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 instance, 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 instance. 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.
    
    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.
  - standardOutputContent
```
public final 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.
    
    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.
  - standardOutputUrl
```
public final 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.
    
    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.
  - standardErrorContent
```
public final 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.
    
    Returns:
    
    The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, then this string is empty.
  - standardErrorUrl
```
public final 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.
    
    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.
  - cloudWatchOutputConfig
```
public final CloudWatchOutputConfig cloudWatchOutputConfig()
```
    Amazon CloudWatch Logs information where Systems Manager sent the command output.
    
    Returns:
    
    Amazon CloudWatch Logs information where Systems Manager sent the command output.
  - toBuilder
```
public GetCommandInvocationResponse.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetCommandInvocationResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetCommandInvocationResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.67

Class GetCommandInvocationResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

commandId

instanceId

comment

documentName

documentVersion

pluginName

responseCode

executionStartDateTime

executionElapsedTime

executionEndDateTime

status

statusAsString

statusDetails

standardOutputContent

standardOutputUrl

standardErrorContent

standardErrorUrl

cloudWatchOutputConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields