@Generated(value="software.amazon.awssdk:codegen") public final class GetCommandInvocationResponse extends SsmResponse implements ToCopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetCommandInvocationResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetCommandInvocationResponse.Builder |
builder() |
CloudWatchOutputConfig |
cloudWatchOutputConfig()
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 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.
|
responseMetadatasdkHttpResponsecopypublic final String commandId()
The parent command ID of the invocation plugin.
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.
public final String comment()
The comment text for the command.
public final String documentName()
The name of the document that was run. For example, AWS-RunShellScript.
AWS-RunShellScript.public final String documentVersion()
The SSM document version used in the request.
public final String pluginName()
The name of the plugin, or step name, for which details are reported. For example,
aws:RunShellScript is a plugin.
aws:RunShellScript is a plugin.public final Integer responseCode()
The error level response code for the plugin script. If the response code is -1, then the command
has not started running on the instance, or it was not received by the instance.
-1, then the
command has not started running on the instance, or it was not received by the instance.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 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 run, the string is empty.
InvokedBefore filter.
aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
If the plugin has not started to run, the string is empty.
public final String executionElapsedTime()
Duration since ExecutionStartDateTime.
ExecutionStartDateTime.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 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 run, the string is empty.
InvokedAfter filter.
aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
If the plugin has not started to run, the string is empty.
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().
StatusDetails.CommandInvocationStatuspublic 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().
StatusDetails.CommandInvocationStatuspublic 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 AWS Systems Manager User Guide. 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, 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 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 run 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 run 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.
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 AWS Systems Manager User Guide. 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, 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 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 run 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 run 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.
public final String standardOutputContent()
The first 24,000 characters written by the plugin to stdout. If the command has not finished
running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
stdout. If the command has not finished
running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.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 was not specified, then this string is empty.
stdout in Amazon Simple Storage
Service (Amazon S3). If an S3 bucket was not specified, then this string is empty.public final String standardErrorContent()
The first 8,000 characters written by the plugin to stderr. If the command has not finished running,
then this string is empty.
stderr. If the command has not finished
running, then this string is empty.public final String standardErrorUrl()
The URL for the complete text written by the plugin to stderr. If the command has not finished
running, then this string is empty.
stderr. If the command has not
finished running, then this string is empty.public final CloudWatchOutputConfig cloudWatchOutputConfig()
CloudWatch Logs information where Systems Manager sent the command output.
public GetCommandInvocationResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetCommandInvocationResponse.Builder,GetCommandInvocationResponse>toBuilder in class AwsResponsepublic static GetCommandInvocationResponse.Builder builder()
public static Class<? extends GetCommandInvocationResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.