Command (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.Command

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Command
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a command request.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Command()

Constructors
Constructor and Description
`Command()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Command`	`addParametersEntry(String key, List<String> value)` Add a single Parameters entry
`Command`	`clearParametersEntries()` Removes all the entries added into Parameters.
`Command`	`clone()`
`boolean`	`equals(Object obj)`
`AlarmConfiguration`	`getAlarmConfiguration()` The details for the CloudWatch alarm applied to your command.
`CloudWatchOutputConfig`	`getCloudWatchOutputConfig()` Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
`String`	`getCommandId()` A unique identifier for this command.
`String`	`getComment()` User-specified information about the command, such as a brief description of what the command should do.
`Integer`	`getCompletedCount()` The number of targets for which the command invocation reached a terminal state.
`Integer`	`getDeliveryTimedOutCount()` The number of targets for which the status is Delivery Timed Out.
`String`	`getDocumentName()` The name of the document requested for execution.
`String`	`getDocumentVersion()` The Systems Manager document (SSM document) version.
`Integer`	`getErrorCount()` The number of targets for which the status is Failed or Execution Timed Out.
`Date`	`getExpiresAfter()` If a command expires, it changes status to `DeliveryTimedOut` for all invocations that have the status `InProgress`, `Pending`, or `Delayed`.
`List<String>`	`getInstanceIds()` The managed node IDs against which this command was requested.
`String`	`getMaxConcurrency()` The maximum number of managed nodes that are allowed to run the command at the same time.
`String`	`getMaxErrors()` The maximum number of errors allowed before the system stops sending the command to additional targets.
`NotificationConfig`	`getNotificationConfig()` Configurations for sending notifications about command status changes.
`String`	`getOutputS3BucketName()` The S3 bucket where the responses to the command executions should be stored.
`String`	`getOutputS3KeyPrefix()` The S3 directory path inside the bucket where the responses to the command executions should be stored.
`String`	`getOutputS3Region()` (Deprecated) You can no longer specify this parameter.
`Map<String,List<String>>`	`getParameters()` The parameter values to be inserted in the document when running the command.
`Date`	`getRequestedDateTime()` The date and time the command was requested.
`String`	`getServiceRole()` The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
`String`	`getStatus()` The status of the command.
`String`	`getStatusDetails()` A detailed status of the command execution.
`Integer`	`getTargetCount()` The number of targets for the command.
`List<Target>`	`getTargets()` An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
`Integer`	`getTimeoutSeconds()` The `TimeoutSeconds` value specified for a command.
`List<AlarmStateInformation>`	`getTriggeredAlarms()` The CloudWatch alarm that was invoked by the command.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAlarmConfiguration(AlarmConfiguration alarmConfiguration)` The details for the CloudWatch alarm applied to your command.
`void`	`setCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)` Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
`void`	`setCommandId(String commandId)` A unique identifier for this command.
`void`	`setComment(String comment)` User-specified information about the command, such as a brief description of what the command should do.
`void`	`setCompletedCount(Integer completedCount)` The number of targets for which the command invocation reached a terminal state.
`void`	`setDeliveryTimedOutCount(Integer deliveryTimedOutCount)` The number of targets for which the status is Delivery Timed Out.
`void`	`setDocumentName(String documentName)` The name of the document requested for execution.
`void`	`setDocumentVersion(String documentVersion)` The Systems Manager document (SSM document) version.
`void`	`setErrorCount(Integer errorCount)` The number of targets for which the status is Failed or Execution Timed Out.
`void`	`setExpiresAfter(Date expiresAfter)` If a command expires, it changes status to `DeliveryTimedOut` for all invocations that have the status `InProgress`, `Pending`, or `Delayed`.
`void`	`setInstanceIds(Collection<String> instanceIds)` The managed node IDs against which this command was requested.
`void`	`setMaxConcurrency(String maxConcurrency)` The maximum number of managed nodes that are allowed to run the command at the same time.
`void`	`setMaxErrors(String maxErrors)` The maximum number of errors allowed before the system stops sending the command to additional targets.
`void`	`setNotificationConfig(NotificationConfig notificationConfig)` Configurations for sending notifications about command status changes.
`void`	`setOutputS3BucketName(String outputS3BucketName)` The S3 bucket where the responses to the command executions should be stored.
`void`	`setOutputS3KeyPrefix(String outputS3KeyPrefix)` The S3 directory path inside the bucket where the responses to the command executions should be stored.
`void`	`setOutputS3Region(String outputS3Region)` (Deprecated) You can no longer specify this parameter.
`void`	`setParameters(Map<String,List<String>> parameters)` The parameter values to be inserted in the document when running the command.
`void`	`setRequestedDateTime(Date requestedDateTime)` The date and time the command was requested.
`void`	`setServiceRole(String serviceRole)` The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
`void`	`setStatus(CommandStatus status)` The status of the command.
`void`	`setStatus(String status)` The status of the command.
`void`	`setStatusDetails(String statusDetails)` A detailed status of the command execution.
`void`	`setTargetCount(Integer targetCount)` The number of targets for the command.
`void`	`setTargets(Collection<Target> targets)` An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
`void`	`setTimeoutSeconds(Integer timeoutSeconds)` The `TimeoutSeconds` value specified for a command.
`void`	`setTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)` The CloudWatch alarm that was invoked by the command.
`String`	`toString()` Returns a string representation of this object.
`Command`	`withAlarmConfiguration(AlarmConfiguration alarmConfiguration)` The details for the CloudWatch alarm applied to your command.
`Command`	`withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)` Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
`Command`	`withCommandId(String commandId)` A unique identifier for this command.
`Command`	`withComment(String comment)` User-specified information about the command, such as a brief description of what the command should do.
`Command`	`withCompletedCount(Integer completedCount)` The number of targets for which the command invocation reached a terminal state.
`Command`	`withDeliveryTimedOutCount(Integer deliveryTimedOutCount)` The number of targets for which the status is Delivery Timed Out.
`Command`	`withDocumentName(String documentName)` The name of the document requested for execution.
`Command`	`withDocumentVersion(String documentVersion)` The Systems Manager document (SSM document) version.
`Command`	`withErrorCount(Integer errorCount)` The number of targets for which the status is Failed or Execution Timed Out.
`Command`	`withExpiresAfter(Date expiresAfter)` If a command expires, it changes status to `DeliveryTimedOut` for all invocations that have the status `InProgress`, `Pending`, or `Delayed`.
`Command`	`withInstanceIds(Collection<String> instanceIds)` The managed node IDs against which this command was requested.
`Command`	`withInstanceIds(String... instanceIds)` The managed node IDs against which this command was requested.
`Command`	`withMaxConcurrency(String maxConcurrency)` The maximum number of managed nodes that are allowed to run the command at the same time.
`Command`	`withMaxErrors(String maxErrors)` The maximum number of errors allowed before the system stops sending the command to additional targets.
`Command`	`withNotificationConfig(NotificationConfig notificationConfig)` Configurations for sending notifications about command status changes.
`Command`	`withOutputS3BucketName(String outputS3BucketName)` The S3 bucket where the responses to the command executions should be stored.
`Command`	`withOutputS3KeyPrefix(String outputS3KeyPrefix)` The S3 directory path inside the bucket where the responses to the command executions should be stored.
`Command`	`withOutputS3Region(String outputS3Region)` (Deprecated) You can no longer specify this parameter.
`Command`	`withParameters(Map<String,List<String>> parameters)` The parameter values to be inserted in the document when running the command.
`Command`	`withRequestedDateTime(Date requestedDateTime)` The date and time the command was requested.
`Command`	`withServiceRole(String serviceRole)` The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
`Command`	`withStatus(CommandStatus status)` The status of the command.
`Command`	`withStatus(String status)` The status of the command.
`Command`	`withStatusDetails(String statusDetails)` A detailed status of the command execution.
`Command`	`withTargetCount(Integer targetCount)` The number of targets for the command.
`Command`	`withTargets(Collection<Target> targets)` An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
`Command`	`withTargets(Target... targets)` An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
`Command`	`withTimeoutSeconds(Integer timeoutSeconds)` The `TimeoutSeconds` value specified for a command.
`Command`	`withTriggeredAlarms(AlarmStateInformation... triggeredAlarms)` The CloudWatch alarm that was invoked by the command.
`Command`	`withTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)` The CloudWatch alarm that was invoked by the command.

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

- Constructor Detail
  - Command
```
public Command()
```
- Method Detail
  - setCommandId
```
public void setCommandId(String commandId)
```
    A unique identifier for this command.
    
    Parameters:
    
    commandId - A unique identifier for this command.
  - getCommandId
```
public String getCommandId()
```
    A unique identifier for this command.
    
    Returns:
    
    A unique identifier for this command.
  - withCommandId
```
public Command withCommandId(String commandId)
```
    A unique identifier for this command.
    
    Parameters:
    
    commandId - A unique identifier for this 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 requested for execution.
    
    Parameters:
    
    documentName - The name of the document requested for execution.
  - getDocumentName
```
public String getDocumentName()
```
    The name of the document requested for execution.
    
    Returns:
    
    The name of the document requested for execution.
  - withDocumentName
```
public Command withDocumentName(String documentName)
```
    The name of the document requested for execution.
    
    Parameters:
    
    documentName - The name of the document requested for execution.
    
    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.
    
    Parameters:
    
    documentVersion - The Systems Manager document (SSM document) version.
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The Systems Manager document (SSM document) version.
    
    Returns:
    
    The Systems Manager document (SSM document) version.
  - withDocumentVersion
```
public Command withDocumentVersion(String documentVersion)
```
    The Systems Manager document (SSM document) version.
    
    Parameters:
    
    documentVersion - The Systems Manager document (SSM document) version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComment
```
public void setComment(String comment)
```
    User-specified information about the command, such as a brief description of what the command should do.
    
    Parameters:
    
    comment - User-specified information about the command, such as a brief description of what the command should do.
  - getComment
```
public String getComment()
```
    User-specified information about the command, such as a brief description of what the command should do.
    
    Returns:
    
    User-specified information about the command, such as a brief description of what the command should do.
  - withComment
```
public Command withComment(String comment)
```
    User-specified information about the command, such as a brief description of what the command should do.
    
    Parameters:
    
    comment - User-specified information about the command, such as a brief description of what the command should do.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpiresAfter
```
public void setExpiresAfter(Date expiresAfter)
```
    If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    expiresAfter - If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
  - getExpiresAfter
```
public Date getExpiresAfter()
```
    If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
  - withExpiresAfter
```
public Command withExpiresAfter(Date expiresAfter)
```
    If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    expiresAfter - If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,List<String>> getParameters()
```
    The parameter values to be inserted in the document when running the command.
    
    Returns:
    
    The parameter values to be inserted in the document when running the command.
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    The parameter values to be inserted in the document when running the command.
    
    Parameters:
    
    parameters - The parameter values to be inserted in the document when running the command.
  - withParameters
```
public Command withParameters(Map<String,List<String>> parameters)
```
    The parameter values to be inserted in the document when running the command.
    
    Parameters:
    
    parameters - The parameter values to be inserted in the document when running the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public Command addParametersEntry(String key,
                                  List<String> value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearParametersEntries
```
public Command clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInstanceIds
```
public List<String> getInstanceIds()
```
    The managed node IDs against which this command was requested.
    
    Returns:
    
    The managed node IDs against which this command was requested.
  - setInstanceIds
```
public void setInstanceIds(Collection<String> instanceIds)
```
    The managed node IDs against which this command was requested.
    
    Parameters:
    
    instanceIds - The managed node IDs against which this command was requested.
  - withInstanceIds
```
public Command withInstanceIds(String... instanceIds)
```
    The managed node IDs against which this command was requested.
    
    NOTE: This method appends the values to the existing list (if any). Use setInstanceIds(java.util.Collection) or withInstanceIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    instanceIds - The managed node IDs against which this command was requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInstanceIds
```
public Command withInstanceIds(Collection<String> instanceIds)
```
    The managed node IDs against which this command was requested.
    
    Parameters:
    
    instanceIds - The managed node IDs against which this command was requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargets
```
public List<Target> getTargets()
```
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.
    
    Returns:
    
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.
  - setTargets
```
public void setTargets(Collection<Target> targets)
```
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.
    
    Parameters:
    
    targets - An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.
  - withTargets
```
public Command withTargets(Target... targets)
```
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.
    
    NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    targets - An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public Command withTargets(Collection<Target> targets)
```
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.
    
    Parameters:
    
    targets - An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequestedDateTime
```
public void setRequestedDateTime(Date requestedDateTime)
```
    The date and time the command was requested.
    
    Parameters:
    
    requestedDateTime - The date and time the command was requested.
  - getRequestedDateTime
```
public Date getRequestedDateTime()
```
    The date and time the command was requested.
    
    Returns:
    
    The date and time the command was requested.
  - withRequestedDateTime
```
public Command withRequestedDateTime(Date requestedDateTime)
```
    The date and time the command was requested.
    
    Parameters:
    
    requestedDateTime - The date and time the command was requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the command.
    
    Parameters:
    
    status - The status of the command.
    
    See Also:
    
    CommandStatus
  - getStatus
```
public String getStatus()
```
    The status of the command.
    
    Returns:
    
    The status of the command.
    
    See Also:
    
    CommandStatus
  - withStatus
```
public Command withStatus(String status)
```
    The status of the command.
    
    Parameters:
    
    status - The status of the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CommandStatus
  - setStatus
```
public void setStatus(CommandStatus status)
```
    The status of the command.
    
    Parameters:
    
    status - The status of the command.
    
    See Also:
    
    CommandStatus
  - withStatus
```
public Command withStatus(CommandStatus status)
```
    The status of the command.
    
    Parameters:
    
    status - The status of the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CommandStatus
  - setStatusDetails
```
public void setStatusDetails(String statusDetails)
```
    A detailed status of the command execution. 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 any managed nodes.
    - In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
    - Success: The command successfully ran on all invocations. This is a terminal state.
    - Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    - Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    - Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    - Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    - Cancelled: The command was terminated before it was completed. This is a terminal state.
    - Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
    - Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
    Parameters:
    statusDetails - A detailed status of the command execution. 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 any managed nodes.
    
    In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
    
    Success: The command successfully ran on all invocations. This is a terminal state.
    
    Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    
    Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    
    Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    
    Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    
    Cancelled: The command was terminated before it was completed. This is a terminal state.
    
    Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
    
    Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
  - getStatusDetails
```
public String getStatusDetails()
```
    A detailed status of the command execution. 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 any managed nodes.
    - In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
    - Success: The command successfully ran on all invocations. This is a terminal state.
    - Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    - Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    - Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    - Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    - Cancelled: The command was terminated before it was completed. This is a terminal state.
    - Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
    - Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
    Returns:
    A detailed status of the command execution. 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 any managed nodes.
    
    In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
    
    Success: The command successfully ran on all invocations. This is a terminal state.
    
    Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    
    Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    
    Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    
    Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    
    Cancelled: The command was terminated before it was completed. This is a terminal state.
    
    Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
    
    Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
  - withStatusDetails
```
public Command withStatusDetails(String statusDetails)
```
    A detailed status of the command execution. 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 any managed nodes.
    - In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
    - Success: The command successfully ran on all invocations. This is a terminal state.
    - Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    - Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    - Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    - Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    - Cancelled: The command was terminated before it was completed. This is a terminal state.
    - Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
    - Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
    Parameters:
    statusDetails - A detailed status of the command execution. 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 any managed nodes.
    
    In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
    
    Success: The command successfully ran on all invocations. This is a terminal state.
    
    Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    
    Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    
    Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    
    Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    
    Cancelled: The command was terminated before it was completed. This is a terminal state.
    
    Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
    
    Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputS3Region
```
public void setOutputS3Region(String outputS3Region)
```
    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
    
    Parameters:
    
    outputS3Region - (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
  - getOutputS3Region
```
public String getOutputS3Region()
```
    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
    
    Returns:
    
    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
  - withOutputS3Region
```
public Command withOutputS3Region(String outputS3Region)
```
    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
    
    Parameters:
    
    outputS3Region - (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputS3BucketName
```
public void setOutputS3BucketName(String outputS3BucketName)
```
    The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Parameters:
    
    outputS3BucketName - The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
  - getOutputS3BucketName
```
public String getOutputS3BucketName()
```
    The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Returns:
    
    The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
  - withOutputS3BucketName
```
public Command withOutputS3BucketName(String outputS3BucketName)
```
    The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Parameters:
    
    outputS3BucketName - The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputS3KeyPrefix
```
public void setOutputS3KeyPrefix(String outputS3KeyPrefix)
```
    The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Parameters:
    
    outputS3KeyPrefix - The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
  - getOutputS3KeyPrefix
```
public String getOutputS3KeyPrefix()
```
    The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Returns:
    
    The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
  - withOutputS3KeyPrefix
```
public Command withOutputS3KeyPrefix(String outputS3KeyPrefix)
```
    The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Parameters:
    
    outputS3KeyPrefix - The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxConcurrency
```
public void setMaxConcurrency(String maxConcurrency)
```
    The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    maxConcurrency - The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
  - getMaxConcurrency
```
public String getMaxConcurrency()
```
    The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
  - withMaxConcurrency
```
public Command withMaxConcurrency(String maxConcurrency)
```
    The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    maxConcurrency - The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxErrors
```
public void setMaxErrors(String maxErrors)
```
    The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
  - getMaxErrors
```
public String getMaxErrors()
```
    The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
  - withMaxErrors
```
public Command withMaxErrors(String maxErrors)
```
    The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Amazon Web Services Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetCount
```
public void setTargetCount(Integer targetCount)
```
    The number of targets for the command.
    
    Parameters:
    
    targetCount - The number of targets for the command.
  - getTargetCount
```
public Integer getTargetCount()
```
    The number of targets for the command.
    
    Returns:
    
    The number of targets for the command.
  - withTargetCount
```
public Command withTargetCount(Integer targetCount)
```
    The number of targets for the command.
    
    Parameters:
    
    targetCount - The number of targets for the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletedCount
```
public void setCompletedCount(Integer completedCount)
```
    The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
    
    Parameters:
    
    completedCount - The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
  - getCompletedCount
```
public Integer getCompletedCount()
```
    The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
    
    Returns:
    
    The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
  - withCompletedCount
```
public Command withCompletedCount(Integer completedCount)
```
    The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
    
    Parameters:
    
    completedCount - The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorCount
```
public void setErrorCount(Integer errorCount)
```
    The number of targets for which the status is Failed or Execution Timed Out.
    
    Parameters:
    
    errorCount - The number of targets for which the status is Failed or Execution Timed Out.
  - getErrorCount
```
public Integer getErrorCount()
```
    The number of targets for which the status is Failed or Execution Timed Out.
    
    Returns:
    
    The number of targets for which the status is Failed or Execution Timed Out.
  - withErrorCount
```
public Command withErrorCount(Integer errorCount)
```
    The number of targets for which the status is Failed or Execution Timed Out.
    
    Parameters:
    
    errorCount - The number of targets for which the status is Failed or Execution Timed Out.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeliveryTimedOutCount
```
public void setDeliveryTimedOutCount(Integer deliveryTimedOutCount)
```
    The number of targets for which the status is Delivery Timed Out.
    
    Parameters:
    
    deliveryTimedOutCount - The number of targets for which the status is Delivery Timed Out.
  - getDeliveryTimedOutCount
```
public Integer getDeliveryTimedOutCount()
```
    The number of targets for which the status is Delivery Timed Out.
    
    Returns:
    
    The number of targets for which the status is Delivery Timed Out.
  - withDeliveryTimedOutCount
```
public Command withDeliveryTimedOutCount(Integer deliveryTimedOutCount)
```
    The number of targets for which the status is Delivery Timed Out.
    
    Parameters:
    
    deliveryTimedOutCount - The number of targets for which the status is Delivery Timed Out.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceRole
```
public void setServiceRole(String serviceRole)
```
    The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
    
    Parameters:
    
    serviceRole - The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
  - getServiceRole
```
public String getServiceRole()
```
    The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
    
    Returns:
    
    The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
  - withServiceRole
```
public Command withServiceRole(String serviceRole)
```
    The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
    
    Parameters:
    
    serviceRole - The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotificationConfig
```
public void setNotificationConfig(NotificationConfig notificationConfig)
```
    Configurations for sending notifications about command status changes.
    
    Parameters:
    
    notificationConfig - Configurations for sending notifications about command status changes.
  - getNotificationConfig
```
public NotificationConfig getNotificationConfig()
```
    Configurations for sending notifications about command status changes.
    
    Returns:
    
    Configurations for sending notifications about command status changes.
  - withNotificationConfig
```
public Command withNotificationConfig(NotificationConfig notificationConfig)
```
    Configurations for sending notifications about command status changes.
    
    Parameters:
    
    notificationConfig - Configurations for sending notifications about command status changes.
    
    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 you want Amazon Web Services Systems Manager to send the command output.
    
    Parameters:
    
    cloudWatchOutputConfig - Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
  - getCloudWatchOutputConfig
```
public CloudWatchOutputConfig getCloudWatchOutputConfig()
```
    Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
    
    Returns:
    
    Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
  - withCloudWatchOutputConfig
```
public Command withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
```
    Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
    
    Parameters:
    
    cloudWatchOutputConfig - Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutSeconds
```
public void setTimeoutSeconds(Integer timeoutSeconds)
```
    The TimeoutSeconds value specified for a command.
    
    Parameters:
    
    timeoutSeconds - The TimeoutSeconds value specified for a command.
  - getTimeoutSeconds
```
public Integer getTimeoutSeconds()
```
    The TimeoutSeconds value specified for a command.
    
    Returns:
    
    The TimeoutSeconds value specified for a command.
  - withTimeoutSeconds
```
public Command withTimeoutSeconds(Integer timeoutSeconds)
```
    The TimeoutSeconds value specified for a command.
    
    Parameters:
    
    timeoutSeconds - The TimeoutSeconds value specified for a command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlarmConfiguration
```
public void setAlarmConfiguration(AlarmConfiguration alarmConfiguration)
```
    The details for the CloudWatch alarm applied to your command.
    
    Parameters:
    
    alarmConfiguration - The details for the CloudWatch alarm applied to your command.
  - getAlarmConfiguration
```
public AlarmConfiguration getAlarmConfiguration()
```
    The details for the CloudWatch alarm applied to your command.
    
    Returns:
    
    The details for the CloudWatch alarm applied to your command.
  - withAlarmConfiguration
```
public Command withAlarmConfiguration(AlarmConfiguration alarmConfiguration)
```
    The details for the CloudWatch alarm applied to your command.
    
    Parameters:
    
    alarmConfiguration - The details for the CloudWatch alarm applied to your command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTriggeredAlarms
```
public List<AlarmStateInformation> getTriggeredAlarms()
```
    The CloudWatch alarm that was invoked by the command.
    
    Returns:
    
    The CloudWatch alarm that was invoked by the command.
  - setTriggeredAlarms
```
public void setTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
```
    The CloudWatch alarm that was invoked by the command.
    
    Parameters:
    
    triggeredAlarms - The CloudWatch alarm that was invoked by the command.
  - withTriggeredAlarms
```
public Command withTriggeredAlarms(AlarmStateInformation... triggeredAlarms)
```
    The CloudWatch alarm that was invoked by the command.
    
    NOTE: This method appends the values to the existing list (if any). Use setTriggeredAlarms(java.util.Collection) or withTriggeredAlarms(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    triggeredAlarms - The CloudWatch alarm that was invoked by the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTriggeredAlarms
```
public Command withTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
```
    The CloudWatch alarm that was invoked by the command.
    
    Parameters:
    
    triggeredAlarms - The CloudWatch alarm that was invoked by the command.
    
    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 Command clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class Command

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Command

Method Detail

setCommandId

getCommandId

withCommandId

setDocumentName

getDocumentName

withDocumentName

setDocumentVersion

getDocumentVersion

withDocumentVersion

setComment

getComment

withComment

setExpiresAfter

getExpiresAfter

withExpiresAfter

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

getInstanceIds

setInstanceIds

withInstanceIds

withInstanceIds

getTargets

setTargets

withTargets

withTargets

setRequestedDateTime

getRequestedDateTime

withRequestedDateTime

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusDetails

getStatusDetails

withStatusDetails

setOutputS3Region

getOutputS3Region

withOutputS3Region

setOutputS3BucketName

getOutputS3BucketName

withOutputS3BucketName

setOutputS3KeyPrefix

getOutputS3KeyPrefix

withOutputS3KeyPrefix

setMaxConcurrency

getMaxConcurrency

withMaxConcurrency

setMaxErrors

getMaxErrors

withMaxErrors

setTargetCount

getTargetCount

withTargetCount

setCompletedCount

getCompletedCount

withCompletedCount

setErrorCount

getErrorCount

withErrorCount

setDeliveryTimedOutCount

getDeliveryTimedOutCount

withDeliveryTimedOutCount

setServiceRole

getServiceRole

withServiceRole

setNotificationConfig

getNotificationConfig

withNotificationConfig