public class CommandInvocation extends Object implements Serializable, Cloneable
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.
Constructor and Description |
---|
CommandInvocation() |
Modifier and Type | Method and Description |
---|---|
CommandInvocation |
clone() |
boolean |
equals(Object obj) |
String |
getCommandId()
The command against which this invocation was requested.
|
List<CommandPlugin> |
getCommandPlugins() |
String |
getComment()
User-specified information about the command, such as a brief description of what the command should do.
|
String |
getDocumentName()
The document name that was requested for execution.
|
String |
getInstanceId()
The instance ID in which this invocation was requested.
|
String |
getInstanceName()
The name of the invocation target.
|
NotificationConfig |
getNotificationConfig()
Configurations for sending notifications about command status changes on a per instance basis.
|
Date |
getRequestedDateTime()
The time and date the request was sent to this instance.
|
String |
getServiceRole()
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 |
getStandardErrorUrl()
The URL to the plugin’s StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
String |
getStandardOutputUrl()
The URL to the plugin’s StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
String |
getStatus()
Whether or not the invocation succeeded, failed, or is pending.
|
String |
getStatusDetails()
A detailed status of the command execution for each invocation (each instance targeted by the command).
|
String |
getTraceOutput()
Gets the trace output sent by the agent.
|
int |
hashCode() |
void |
setCommandId(String commandId)
The command against which this invocation was requested.
|
void |
setCommandPlugins(Collection<CommandPlugin> commandPlugins) |
void |
setComment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
void |
setDocumentName(String documentName)
The document name that was requested for execution.
|
void |
setInstanceId(String instanceId)
The instance ID in which this invocation was requested.
|
void |
setInstanceName(String instanceName)
The name of the invocation target.
|
void |
setNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications about command status changes on a per instance basis.
|
void |
setRequestedDateTime(Date requestedDateTime)
The time and date the request was sent to this instance.
|
void |
setServiceRole(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.
|
void |
setStandardErrorUrl(String standardErrorUrl)
The URL to the plugin’s StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
void |
setStandardOutputUrl(String standardOutputUrl)
The URL to the plugin’s StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
void |
setStatus(CommandInvocationStatus status)
Whether or not the invocation succeeded, failed, or is pending.
|
void |
setStatus(String status)
Whether or not the invocation succeeded, failed, or is pending.
|
void |
setStatusDetails(String statusDetails)
A detailed status of the command execution for each invocation (each instance targeted by the command).
|
void |
setTraceOutput(String traceOutput)
Gets the trace output sent by the agent.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
CommandInvocation |
withCommandId(String commandId)
The command against which this invocation was requested.
|
CommandInvocation |
withCommandPlugins(Collection<CommandPlugin> commandPlugins) |
CommandInvocation |
withCommandPlugins(CommandPlugin... commandPlugins)
NOTE: This method appends the values to the existing list (if any).
|
CommandInvocation |
withComment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
CommandInvocation |
withDocumentName(String documentName)
The document name that was requested for execution.
|
CommandInvocation |
withInstanceId(String instanceId)
The instance ID in which this invocation was requested.
|
CommandInvocation |
withInstanceName(String instanceName)
The name of the invocation target.
|
CommandInvocation |
withNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications about command status changes on a per instance basis.
|
CommandInvocation |
withRequestedDateTime(Date requestedDateTime)
The time and date the request was sent to this instance.
|
CommandInvocation |
withServiceRole(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.
|
CommandInvocation |
withStandardErrorUrl(String standardErrorUrl)
The URL to the plugin’s StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
CommandInvocation |
withStandardOutputUrl(String standardOutputUrl)
The URL to the plugin’s StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
CommandInvocation |
withStatus(CommandInvocationStatus status)
Whether or not the invocation succeeded, failed, or is pending.
|
CommandInvocation |
withStatus(String status)
Whether or not the invocation succeeded, failed, or is pending.
|
CommandInvocation |
withStatusDetails(String statusDetails)
A detailed status of the command execution for each invocation (each instance targeted by the command).
|
CommandInvocation |
withTraceOutput(String traceOutput)
Gets the trace output sent by the agent.
|
public void setCommandId(String commandId)
The command against which this invocation was requested.
commandId
- The command against which this invocation was requested.public String getCommandId()
The command against which this invocation was requested.
public CommandInvocation withCommandId(String commandId)
The command against which this invocation was requested.
commandId
- The command against which this invocation was requested.public void setInstanceId(String instanceId)
The instance ID in which this invocation was requested.
instanceId
- The instance ID in which this invocation was requested.public String getInstanceId()
The instance ID in which this invocation was requested.
public CommandInvocation withInstanceId(String instanceId)
The instance ID in which this invocation was requested.
instanceId
- The instance ID in which this invocation was requested.public void setInstanceName(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.
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 getInstanceName()
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.
aws:Name
tag. For on-premises instances, this is the name of the instance.public CommandInvocation withInstanceName(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.
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 void setComment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
comment
- User-specified information about the command, such as a brief description of what the command should do.public String getComment()
User-specified information about the command, such as a brief description of what the command should do.
public CommandInvocation withComment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
comment
- User-specified information about the command, such as a brief description of what the command should do.public void setDocumentName(String documentName)
The document name that was requested for execution.
documentName
- The document name that was requested for execution.public String getDocumentName()
The document name that was requested for execution.
public CommandInvocation withDocumentName(String documentName)
The document name that was requested for execution.
documentName
- The document name that was requested for execution.public void setRequestedDateTime(Date requestedDateTime)
The time and date the request was sent to this instance.
requestedDateTime
- The time and date the request was sent to this instance.public Date getRequestedDateTime()
The time and date the request was sent to this instance.
public CommandInvocation withRequestedDateTime(Date requestedDateTime)
The time and date the request was sent to this instance.
requestedDateTime
- The time and date the request was sent to this instance.public void setStatus(String status)
Whether or not the invocation succeeded, failed, or is pending.
status
- Whether or not the invocation succeeded, failed, or is pending.CommandInvocationStatus
public String getStatus()
Whether or not the invocation succeeded, failed, or is pending.
CommandInvocationStatus
public CommandInvocation withStatus(String status)
Whether or not the invocation succeeded, failed, or is pending.
status
- Whether or not the invocation succeeded, failed, or is pending.CommandInvocationStatus
public void setStatus(CommandInvocationStatus status)
Whether or not the invocation succeeded, failed, or is pending.
status
- Whether or not the invocation succeeded, failed, or is pending.CommandInvocationStatus
public CommandInvocation withStatus(CommandInvocationStatus status)
Whether or not the invocation succeeded, failed, or is pending.
status
- Whether or not the invocation succeeded, failed, or is pending.CommandInvocationStatus
public void setStatusDetails(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 Monitor Commands (Linux) or
Monitor Commands
(Windows). 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.
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 Monitor Commands
(Linux) or Monitor
Commands (Windows). 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.
public String getStatusDetails()
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 Monitor Commands (Linux) or
Monitor Commands
(Windows). 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.
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 Monitor Commands
(Linux) or Monitor
Commands (Windows). 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.
public CommandInvocation withStatusDetails(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 Monitor Commands (Linux) or
Monitor Commands
(Windows). 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.
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 Monitor Commands
(Linux) or Monitor
Commands (Windows). 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.
public void setTraceOutput(String traceOutput)
Gets the trace output sent by the agent.
traceOutput
- Gets the trace output sent by the agent.public String getTraceOutput()
Gets the trace output sent by the agent.
public CommandInvocation withTraceOutput(String traceOutput)
Gets the trace output sent by the agent.
traceOutput
- Gets the trace output sent by the agent.public void setStandardOutputUrl(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.
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 getStandardOutputUrl()
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.
StandardOutputUrl
is populated if there is just one plugin
defined for the command, and the Amazon S3 bucket was defined for the command.public CommandInvocation withStandardOutputUrl(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.
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 void setStandardErrorUrl(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.
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 String getStandardErrorUrl()
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.
StandardErrorUrl
is populated if there is just one plugin
defined for the command, and the Amazon S3 bucket was defined for the command.public CommandInvocation withStandardErrorUrl(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.
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> getCommandPlugins()
public void setCommandPlugins(Collection<CommandPlugin> commandPlugins)
commandPlugins
- public CommandInvocation withCommandPlugins(CommandPlugin... commandPlugins)
NOTE: This method appends the values to the existing list (if any). Use
setCommandPlugins(java.util.Collection)
or withCommandPlugins(java.util.Collection)
if you want
to override the existing values.
commandPlugins
- public CommandInvocation withCommandPlugins(Collection<CommandPlugin> commandPlugins)
commandPlugins
- public void setServiceRole(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.
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 String getServiceRole()
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 CommandInvocation withServiceRole(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.
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 void setNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications about command status changes on a per instance basis.
notificationConfig
- Configurations for sending notifications about command status changes on a per instance basis.public NotificationConfig getNotificationConfig()
Configurations for sending notifications about command status changes on a per instance basis.
public CommandInvocation withNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications about command status changes on a per instance basis.
notificationConfig
- Configurations for sending notifications about command status changes on a per instance basis.public String toString()
toString
in class Object
Object.toString()
public CommandInvocation clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.