@Generated(value="software.amazon.awssdk:codegen") public final class CommandInvocation extends Object implements StructuredPojo, ToCopyableBuilder<CommandInvocation.Builder,CommandInvocation>
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed.
Modifier and Type | Class and Description |
---|---|
static interface |
CommandInvocation.Builder |
Modifier and Type | Method and Description |
---|---|
static CommandInvocation.Builder |
builder() |
String |
commandId()
The command against which this invocation was requested.
|
List<CommandPlugin> |
commandPlugins()
Returns the value of the CommandPlugins property for this object.
|
String |
comment()
User-specified information about the command, such as a brief description of what the command should do.
|
String |
documentName()
The document name that was requested for execution.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
instanceId()
The instance ID in which this invocation was requested.
|
String |
instanceName()
The name of the invocation target.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
NotificationConfig |
notificationConfig()
Configurations for sending notifications about command status changes on a per instance basis.
|
Instant |
requestedDateTime()
The time and date the request was sent to this instance.
|
static Class<? extends CommandInvocation.Builder> |
serializableBuilderClass() |
String |
serviceRole()
The IAM service role that Run Command uses to act on your behalf when sending notifications about command status
changes on a per instance basis.
|
String |
standardErrorUrl()
The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
String |
standardOutputUrl()
The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
CommandInvocationStatus |
status()
Whether or not the invocation succeeded, failed, or is pending.
|
String |
statusAsString()
Whether or not the invocation succeeded, failed, or is pending.
|
String |
statusDetails()
A detailed status of the command execution for each invocation (each instance targeted by the command).
|
CommandInvocation.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
traceOutput()
Gets the trace output sent by the agent.
|
copy
public String commandId()
The command against which this invocation was requested.
public String instanceId()
The instance ID in which this invocation was requested.
public String instanceName()
The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.
public String comment()
User-specified information about the command, such as a brief description of what the command should do.
public String documentName()
The document name that was requested for execution.
public Instant requestedDateTime()
The time and date the request was sent to this instance.
public CommandInvocationStatus status()
Whether or not the invocation succeeded, failed, or is pending.
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()
.
CommandInvocationStatus
public String statusAsString()
Whether or not the invocation succeeded, failed, or is pending.
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()
.
CommandInvocationStatus
public String statusDetails()
A detailed status of the command execution for each invocation (each instance targeted by the command). 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.
Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command was not successful 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.
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.
Success: The execution of the command or plugin was successfully completed. 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: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
Failed: The command was not successful 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 String traceOutput()
Gets the trace output sent by the agent.
public String standardOutputUrl()
The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.
public String standardErrorUrl()
The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.
public List<CommandPlugin> commandPlugins()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String serviceRole()
The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.
public NotificationConfig notificationConfig()
Configurations for sending notifications about command status changes on a per instance basis.
public CommandInvocation.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CommandInvocation.Builder,CommandInvocation>
public static CommandInvocation.Builder builder()
public static Class<? extends CommandInvocation.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.