Command (AWS Java SDK for the AWS Simple Systems Management (SSM) Service 1.11.30 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class Command
extends Object
implements Serializable, Cloneable
```
Describes a command request.

See Also:

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.
`String`	`getDocumentName()` The name of the SSM document requested for execution.
`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.
`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.
`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 SSM uses to act on your behalf when sending notifications about command status changes.
`String`	`getStatus()` The status of the command.
`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`	`setDocumentName(String documentName)` The name of the SSM document requested for execution.
`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`	`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`	`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 SSM 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.
`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`	`withDocumentName(String documentName)` The name of the SSM document requested for execution.
`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`	`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`	`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 SSM 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.

Methods inherited from class java.lang.Object
finalize, 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. <p> 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.
  - 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
  - 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.
  - setServiceRole
```
public void setServiceRole(String serviceRole)
```
    The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes.
    
    Parameters:
    
    serviceRole - The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes.
  - getServiceRole
```
public String getServiceRole()
```
    The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes.
    
    Returns:
    
    The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes.
  - withServiceRole
```
public Command withServiceRole(String serviceRole)
```
    The IAM service role that SSM uses to act on your behalf when sending notifications about command status changes.
    
    Parameters:
    
    serviceRole - The IAM service role that SSM 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

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

setRequestedDateTime

getRequestedDateTime

withRequestedDateTime

setStatus

getStatus

withStatus

setStatus

withStatus

setOutputS3BucketName

getOutputS3BucketName

withOutputS3BucketName

setOutputS3KeyPrefix

getOutputS3KeyPrefix

withOutputS3KeyPrefix

setServiceRole

getServiceRole

withServiceRole

setNotificationConfig

getNotificationConfig

withNotificationConfig

toString

equals

hashCode

clone