Command (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

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)`
`Command`	`clearParametersEntries()` Removes all the entries added into Parameters.
`Command`	`clone()`
`boolean`	`equals(Object obj)`
`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.
`String`	`getDocumentName()` The name of the SSM document requested for execution.
`Integer`	`getErrorCount()` The number of targets for which the status is `Failed` or `Execution Timed Out`.
`Date`	`getExpiresAfter()` If this time is reached and the command has not already started executing, it will not execute.
`List<String>`	`getInstanceIds()` The instance IDs against which this command was requested.
`String`	`getMaxConcurrency()` The maximum number of instances that are allowed to execute 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()` The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located.
`Map<String,List<String>>`	`getParameters()` The parameter values to be inserted in the SSM document when executing the command.
`Date`	`getRequestedDateTime()` The date and time the command was requested.
`String`	`getServiceRole()` The IAM service role that Run Command 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 instances using a `Key`;`Value` combination that you specify.
`int`	`hashCode()`
`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`	`setDocumentName(String documentName)` The name of the SSM document requested for execution.
`void`	`setErrorCount(Integer errorCount)` The number of targets for which the status is `Failed` or `Execution Timed Out`.
`void`	`setExpiresAfter(Date expiresAfter)` If this time is reached and the command has not already started executing, it will not execute.
`void`	`setInstanceIds(Collection<String> instanceIds)` The instance IDs against which this command was requested.
`void`	`setMaxConcurrency(String maxConcurrency)` The maximum number of instances that are allowed to execute 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)` The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located.
`void`	`setParameters(Map<String,List<String>> parameters)` The parameter values to be inserted in the SSM document when executing the command.
`void`	`setRequestedDateTime(Date requestedDateTime)` The date and time the command was requested.
`void`	`setServiceRole(String serviceRole)` The IAM service role that Run Command 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 instances using a `Key`;`Value` combination that you specify.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`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`	`withDocumentName(String documentName)` The name of the SSM document requested for execution.
`Command`	`withErrorCount(Integer errorCount)` The number of targets for which the status is `Failed` or `Execution Timed Out`.
`Command`	`withExpiresAfter(Date expiresAfter)` If this time is reached and the command has not already started executing, it will not execute.
`Command`	`withInstanceIds(Collection<String> instanceIds)` The instance IDs against which this command was requested.
`Command`	`withInstanceIds(String... instanceIds)` The instance IDs against which this command was requested.
`Command`	`withMaxConcurrency(String maxConcurrency)` The maximum number of instances that are allowed to execute 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)` The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located.
`Command`	`withParameters(Map<String,List<String>> parameters)` The parameter values to be inserted in the SSM document when executing the command.
`Command`	`withRequestedDateTime(Date requestedDateTime)` The date and time the command was requested.
`Command`	`withServiceRole(String serviceRole)` The IAM service role that Run Command 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 instances using a `Key`;`Value` combination that you specify.
`Command`	`withTargets(Target... targets)` An array of search criteria that targets instances using a `Key`;`Value` combination that you specify.

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 SSM document requested for execution.
    
    Parameters:
    
    documentName - The name of the SSM document requested for execution.
  - getDocumentName
```
public String getDocumentName()
```
    The name of the SSM document requested for execution.
    
    Returns:
    
    The name of the SSM document requested for execution.
  - withDocumentName
```
public Command withDocumentName(String documentName)
```
    The name of the SSM document requested for execution.
    
    Parameters:
    
    documentName - The name of the SSM document requested for execution.
    
    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 this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
    
    Parameters:
    
    expiresAfter - If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
  - getExpiresAfter
```
public Date getExpiresAfter()
```
    If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
    
    Returns:
    
    If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
  - withExpiresAfter
```
public Command withExpiresAfter(Date expiresAfter)
```
    If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
    
    Parameters:
    
    expiresAfter - If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
    
    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 SSM document when executing the command.
    
    Returns:
    
    The parameter values to be inserted in the SSM document when executing the command.
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    The parameter values to be inserted in the SSM document when executing the command.
    
    Parameters:
    
    parameters - The parameter values to be inserted in the SSM document when executing the command.
  - withParameters
```
public Command withParameters(Map<String,List<String>> parameters)
```
    The parameter values to be inserted in the SSM document when executing the command.
    
    Parameters:
    
    parameters - The parameter values to be inserted in the SSM document when executing 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)
```
  - 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 instance IDs against which this command was requested.
    
    Returns:
    
    The instance IDs against which this command was requested.
  - setInstanceIds
```
public void setInstanceIds(Collection<String> instanceIds)
```
    The instance IDs against which this command was requested.
    
    Parameters:
    
    instanceIds - The instance IDs against which this command was requested.
  - withInstanceIds
```
public Command withInstanceIds(String... instanceIds)
```
    The instance 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 instance 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 instance IDs against which this command was requested.
    
    Parameters:
    
    instanceIds - The instance 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 instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
    
    Returns:
    
    An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
  - setTargets
```
public void setTargets(Collection<Target> targets)
```
    An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
    
    Parameters:
    
    targets - An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
  - withTargets
```
public Command withTargets(Target... targets)
```
    An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance 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 instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance 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 instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
    
    Parameters:
    
    targets - An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance 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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:
    - Pending – The command has not been sent to any instances.
    - In Progress – The command has been sent to at least one instance but has not reached a final state on all instances.
    - Success – The command successfully executed 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 instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    - Canceled – The command was terminated before it was completed. This is a terminal state.
    - Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
    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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:
    
    Pending – The command has not been sent to any instances.
    
    In Progress – The command has been sent to at least one instance but has not reached a final state on all instances.
    
    Success – The command successfully executed 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 instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    
    Canceled – The command was terminated before it was completed. This is a terminal state.
    
    Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
  - 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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:
    - Pending – The command has not been sent to any instances.
    - In Progress – The command has been sent to at least one instance but has not reached a final state on all instances.
    - Success – The command successfully executed 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 instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    - Canceled – The command was terminated before it was completed. This is a terminal state.
    - Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
    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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:
    
    Pending – The command has not been sent to any instances.
    
    In Progress – The command has been sent to at least one instance but has not reached a final state on all instances.
    
    Success – The command successfully executed 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 instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    
    Canceled – The command was terminated before it was completed. This is a terminal state.
    
    Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
  - 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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:
    - Pending – The command has not been sent to any instances.
    - In Progress – The command has been sent to at least one instance but has not reached a final state on all instances.
    - Success – The command successfully executed 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 instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    - Canceled – The command was terminated before it was completed. This is a terminal state.
    - Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
    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 Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:
    
    Pending – The command has not been sent to any instances.
    
    In Progress – The command has been sent to at least one instance but has not reached a final state on all instances.
    
    Success – The command successfully executed 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 instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    
    Canceled – The command was terminated before it was completed. This is a terminal state.
    
    Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputS3Region
```
public void setOutputS3Region(String outputS3Region)
```
    The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
    
    Parameters:
    
    outputS3Region - The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
  - getOutputS3Region
```
public String getOutputS3Region()
```
    The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
    
    Returns:
    
    The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
  - withOutputS3Region
```
public Command withOutputS3Region(String outputS3Region)
```
    The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
    
    Parameters:
    
    outputS3Region - The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.
    
    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 instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
    
    Parameters:
    
    maxConcurrency - The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
  - getMaxConcurrency
```
public String getMaxConcurrency()
```
    The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
    
    Returns:
    
    The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
  - withMaxConcurrency
```
public Command withMaxConcurrency(String maxConcurrency)
```
    The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
    
    Parameters:
    
    maxConcurrency - The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
    
    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 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
    
    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 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
  - 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 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
    
    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 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
  - 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 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
    
    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 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).
    
    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, Canceled, 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, Canceled, 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, Canceled, 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, Canceled, 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, Canceled, 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, Canceled, 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.
  - setServiceRole
```
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.
    
    Parameters:
    
    serviceRole - The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
  - getServiceRole
```
public String getServiceRole()
```
    The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
    
    Returns:
    
    The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
  - withServiceRole
```
public Command withServiceRole(String serviceRole)
```
    The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
    
    Parameters:
    
    serviceRole - The IAM service role that Run Command 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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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

Did this page help you?

Class Command

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Command

Method Detail

setCommandId

getCommandId

withCommandId

setDocumentName

getDocumentName

withDocumentName

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

setServiceRole

getServiceRole

withServiceRole

setNotificationConfig

getNotificationConfig

withNotificationConfig

toString

equals

hashCode

clone