SendCommandRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.simplesystemsmanagement.model.SendCommandRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

SendCommandRequest()

Constructors
Constructor and Description
`SendCommandRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SendCommandRequest`	`addParametersEntry(String key, List<String> value)` Add a single Parameters entry
`SendCommandRequest`	`clearParametersEntries()` Removes all the entries added into Parameters.
`SendCommandRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`AlarmConfiguration`	`getAlarmConfiguration()` The CloudWatch alarm you want to apply to your command.
`CloudWatchOutputConfig`	`getCloudWatchOutputConfig()` Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs.
`String`	`getComment()` User-specified information about the command, such as a brief description of what the command should do.
`String`	`getDocumentHash()` The Sha256 or Sha1 hash created by the system when the document was created.
`String`	`getDocumentHashType()` Sha256 or Sha1.
`String`	`getDocumentName()` The name of the Amazon Web Services Systems Manager document (SSM document) to run.
`String`	`getDocumentVersion()` The SSM document version to use in the request.
`List<String>`	`getInstanceIds()` The IDs of the managed nodes where the command should run.
`String`	`getMaxConcurrency()` (Optional) 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 without the command failing.
`NotificationConfig`	`getNotificationConfig()` Configurations for sending notifications.
`String`	`getOutputS3BucketName()` The name of the S3 bucket where command execution responses should be stored.
`String`	`getOutputS3KeyPrefix()` The directory structure within the S3 bucket where the responses should be stored.
`String`	`getOutputS3Region()` (Deprecated) You can no longer specify this parameter.
`Map<String,List<String>>`	`getParameters()` The required and optional parameters specified in the document being run.
`String`	`getServiceRoleArn()` The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
`List<Target>`	`getTargets()` An array of search criteria that targets managed nodes using a `Key,Value` combination that you specify.
`Integer`	`getTimeoutSeconds()` If this time is reached and the command hasn't already started running, it won't run.
`int`	`hashCode()`
`void`	`setAlarmConfiguration(AlarmConfiguration alarmConfiguration)` The CloudWatch alarm you want to apply to your command.
`void`	`setCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)` Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs.
`void`	`setComment(String comment)` User-specified information about the command, such as a brief description of what the command should do.
`void`	`setDocumentHash(String documentHash)` The Sha256 or Sha1 hash created by the system when the document was created.
`void`	`setDocumentHashType(DocumentHashType documentHashType)` Sha256 or Sha1.
`void`	`setDocumentHashType(String documentHashType)` Sha256 or Sha1.
`void`	`setDocumentName(String documentName)` The name of the Amazon Web Services Systems Manager document (SSM document) to run.
`void`	`setDocumentVersion(String documentVersion)` The SSM document version to use in the request.
`void`	`setInstanceIds(Collection<String> instanceIds)` The IDs of the managed nodes where the command should run.
`void`	`setMaxConcurrency(String maxConcurrency)` (Optional) 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 without the command failing.
`void`	`setNotificationConfig(NotificationConfig notificationConfig)` Configurations for sending notifications.
`void`	`setOutputS3BucketName(String outputS3BucketName)` The name of the S3 bucket where command execution responses should be stored.
`void`	`setOutputS3KeyPrefix(String outputS3KeyPrefix)` The directory structure within the S3 bucket where the responses should be stored.
`void`	`setOutputS3Region(String outputS3Region)` (Deprecated) You can no longer specify this parameter.
`void`	`setParameters(Map<String,List<String>> parameters)` The required and optional parameters specified in the document being run.
`void`	`setServiceRoleArn(String serviceRoleArn)` The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
`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)` If this time is reached and the command hasn't already started running, it won't run.
`String`	`toString()` Returns a string representation of this object.
`SendCommandRequest`	`withAlarmConfiguration(AlarmConfiguration alarmConfiguration)` The CloudWatch alarm you want to apply to your command.
`SendCommandRequest`	`withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)` Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs.
`SendCommandRequest`	`withComment(String comment)` User-specified information about the command, such as a brief description of what the command should do.
`SendCommandRequest`	`withDocumentHash(String documentHash)` The Sha256 or Sha1 hash created by the system when the document was created.
`SendCommandRequest`	`withDocumentHashType(DocumentHashType documentHashType)` Sha256 or Sha1.
`SendCommandRequest`	`withDocumentHashType(String documentHashType)` Sha256 or Sha1.
`SendCommandRequest`	`withDocumentName(String documentName)` The name of the Amazon Web Services Systems Manager document (SSM document) to run.
`SendCommandRequest`	`withDocumentVersion(String documentVersion)` The SSM document version to use in the request.
`SendCommandRequest`	`withInstanceIds(Collection<String> instanceIds)` The IDs of the managed nodes where the command should run.
`SendCommandRequest`	`withInstanceIds(String... instanceIds)` The IDs of the managed nodes where the command should run.
`SendCommandRequest`	`withMaxConcurrency(String maxConcurrency)` (Optional) The maximum number of managed nodes that are allowed to run the command at the same time.
`SendCommandRequest`	`withMaxErrors(String maxErrors)` The maximum number of errors allowed without the command failing.
`SendCommandRequest`	`withNotificationConfig(NotificationConfig notificationConfig)` Configurations for sending notifications.
`SendCommandRequest`	`withOutputS3BucketName(String outputS3BucketName)` The name of the S3 bucket where command execution responses should be stored.
`SendCommandRequest`	`withOutputS3KeyPrefix(String outputS3KeyPrefix)` The directory structure within the S3 bucket where the responses should be stored.
`SendCommandRequest`	`withOutputS3Region(String outputS3Region)` (Deprecated) You can no longer specify this parameter.
`SendCommandRequest`	`withParameters(Map<String,List<String>> parameters)` The required and optional parameters specified in the document being run.
`SendCommandRequest`	`withServiceRoleArn(String serviceRoleArn)` The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
`SendCommandRequest`	`withTargets(Collection<Target> targets)` An array of search criteria that targets managed nodes using a `Key,Value` combination that you specify.
`SendCommandRequest`	`withTargets(Target... targets)` An array of search criteria that targets managed nodes using a `Key,Value` combination that you specify.
`SendCommandRequest`	`withTimeoutSeconds(Integer timeoutSeconds)` If this time is reached and the command hasn't already started running, it won't run.

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

- Constructor Detail
  - SendCommandRequest
```
public SendCommandRequest()
```
- Method Detail
  - getInstanceIds
```
public List<String> getInstanceIds()
```
    The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
    
    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
    
    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
  - setInstanceIds
```
public void setInstanceIds(Collection<String> instanceIds)
```
    The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
    
    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    instanceIds - The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
    
    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
  - withInstanceIds
```
public SendCommandRequest withInstanceIds(String... instanceIds)
```
    The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
    
    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    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 IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
    
    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInstanceIds
```
public SendCommandRequest withInstanceIds(Collection<String> instanceIds)
```
    The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
    
    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    instanceIds - The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
    
    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    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. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
    
    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
    
    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
  - setTargets
```
public void setTargets(Collection<Target> targets)
```
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
    
    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    targets - An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
    
    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
  - withTargets
```
public SendCommandRequest withTargets(Target... targets)
```
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
    
    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    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. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
    
    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public SendCommandRequest withTargets(Collection<Target> targets)
```
    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
    
    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    targets - An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
    
    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
    
    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 Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.
    
    If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.
    
    Parameters:
    
    documentName - The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.
    
    If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.
  - getDocumentName
```
public String getDocumentName()
```
    The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.
    
    If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.
    
    Returns:
    
    The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.
    
    If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.
  - withDocumentName
```
public SendCommandRequest withDocumentName(String documentName)
```
    The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.
    
    If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.
    
    Parameters:
    
    documentName - The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.
    
    If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentVersion
```
public void setDocumentVersion(String documentVersion)
```
    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
    
    Parameters:
    
    documentVersion - The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
    
    Returns:
    
    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
  - withDocumentVersion
```
public SendCommandRequest withDocumentVersion(String documentVersion)
```
    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
    
    Parameters:
    
    documentVersion - The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentHash
```
public void setDocumentHash(String documentHash)
```
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    documentHash - The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
  - getDocumentHash
```
public String getDocumentHash()
```
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
  - withDocumentHash
```
public SendCommandRequest withDocumentHash(String documentHash)
```
    The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    documentHash - The Sha256 or Sha1 hash created by the system when the document was created.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentHashType
```
public void setDocumentHashType(String documentHashType)
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    documentHashType - Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - getDocumentHashType
```
public String getDocumentHashType()
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - withDocumentHashType
```
public SendCommandRequest withDocumentHashType(String documentHashType)
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    documentHashType - Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentHashType
  - setDocumentHashType
```
public void setDocumentHashType(DocumentHashType documentHashType)
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    documentHashType - Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - withDocumentHashType
```
public SendCommandRequest withDocumentHashType(DocumentHashType documentHashType)
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Parameters:
    
    documentHashType - Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentHashType
  - setTimeoutSeconds
```
public void setTimeoutSeconds(Integer timeoutSeconds)
```
    If this time is reached and the command hasn't already started running, it won't run.
    
    Parameters:
    
    timeoutSeconds - If this time is reached and the command hasn't already started running, it won't run.
  - getTimeoutSeconds
```
public Integer getTimeoutSeconds()
```
    If this time is reached and the command hasn't already started running, it won't run.
    
    Returns:
    
    If this time is reached and the command hasn't already started running, it won't run.
  - withTimeoutSeconds
```
public SendCommandRequest withTimeoutSeconds(Integer timeoutSeconds)
```
    If this time is reached and the command hasn't already started running, it won't run.
    
    Parameters:
    
    timeoutSeconds - If this time is reached and the command hasn't already started running, it won't run.
    
    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 SendCommandRequest 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.
  - getParameters
```
public Map<String,List<String>> getParameters()
```
    The required and optional parameters specified in the document being run.
    
    Returns:
    
    The required and optional parameters specified in the document being run.
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    The required and optional parameters specified in the document being run.
    
    Parameters:
    
    parameters - The required and optional parameters specified in the document being run.
  - withParameters
```
public SendCommandRequest withParameters(Map<String,List<String>> parameters)
```
    The required and optional parameters specified in the document being run.
    
    Parameters:
    
    parameters - The required and optional parameters specified in the document being run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public SendCommandRequest 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 SendCommandRequest clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    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 SendCommandRequest 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 name of the S3 bucket where command execution responses should be stored.
    
    Parameters:
    
    outputS3BucketName - The name of the S3 bucket where command execution responses should be stored.
  - getOutputS3BucketName
```
public String getOutputS3BucketName()
```
    The name of the S3 bucket where command execution responses should be stored.
    
    Returns:
    
    The name of the S3 bucket where command execution responses should be stored.
  - withOutputS3BucketName
```
public SendCommandRequest withOutputS3BucketName(String outputS3BucketName)
```
    The name of the S3 bucket where command execution responses should be stored.
    
    Parameters:
    
    outputS3BucketName - The name of the S3 bucket where command execution responses should be stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputS3KeyPrefix
```
public void setOutputS3KeyPrefix(String outputS3KeyPrefix)
```
    The directory structure within the S3 bucket where the responses should be stored.
    
    Parameters:
    
    outputS3KeyPrefix - The directory structure within the S3 bucket where the responses should be stored.
  - getOutputS3KeyPrefix
```
public String getOutputS3KeyPrefix()
```
    The directory structure within the S3 bucket where the responses should be stored.
    
    Returns:
    
    The directory structure within the S3 bucket where the responses should be stored.
  - withOutputS3KeyPrefix
```
public SendCommandRequest withOutputS3KeyPrefix(String outputS3KeyPrefix)
```
    The directory structure within the S3 bucket where the responses should be stored.
    
    Parameters:
    
    outputS3KeyPrefix - The directory structure within the S3 bucket where the responses should be stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxConcurrency
```
public void setMaxConcurrency(String maxConcurrency)
```
    (Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    maxConcurrency - (Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
  - getMaxConcurrency
```
public String getMaxConcurrency()
```
    (Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    (Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
  - withMaxConcurrency
```
public SendCommandRequest withMaxConcurrency(String maxConcurrency)
```
    (Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    maxConcurrency - (Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls 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 without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
  - getMaxErrors
```
public String getMaxErrors()
```
    The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
  - withMaxErrors
```
public SendCommandRequest withMaxErrors(String maxErrors)
```
    The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceRoleArn
```
public void setServiceRoleArn(String serviceRoleArn)
```
    The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
    
    This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    serviceRoleArn - The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
    
    This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
  - getServiceRoleArn
```
public String getServiceRoleArn()
```
    The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
    
    This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
    
    This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
  - withServiceRoleArn
```
public SendCommandRequest withServiceRoleArn(String serviceRoleArn)
```
    The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
    
    This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    serviceRoleArn - The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
    
    This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
    
    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.
    
    Parameters:
    
    notificationConfig - Configurations for sending notifications.
  - getNotificationConfig
```
public NotificationConfig getNotificationConfig()
```
    Configurations for sending notifications.
    
    Returns:
    
    Configurations for sending notifications.
  - withNotificationConfig
```
public SendCommandRequest withNotificationConfig(NotificationConfig notificationConfig)
```
    Configurations for sending notifications.
    
    Parameters:
    
    notificationConfig - Configurations for sending notifications.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchOutputConfig
```
public void setCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
```
    Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
    
    Parameters:
    
    cloudWatchOutputConfig - Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
  - getCloudWatchOutputConfig
```
public CloudWatchOutputConfig getCloudWatchOutputConfig()
```
    Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
    
    Returns:
    
    Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
  - withCloudWatchOutputConfig
```
public SendCommandRequest withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
```
    Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
    
    Parameters:
    
    cloudWatchOutputConfig - Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlarmConfiguration
```
public void setAlarmConfiguration(AlarmConfiguration alarmConfiguration)
```
    The CloudWatch alarm you want to apply to your command.
    
    Parameters:
    
    alarmConfiguration - The CloudWatch alarm you want to apply to your command.
  - getAlarmConfiguration
```
public AlarmConfiguration getAlarmConfiguration()
```
    The CloudWatch alarm you want to apply to your command.
    
    Returns:
    
    The CloudWatch alarm you want to apply to your command.
  - withAlarmConfiguration
```
public SendCommandRequest withAlarmConfiguration(AlarmConfiguration alarmConfiguration)
```
    The CloudWatch alarm you want to apply to your command.
    
    Parameters:
    
    alarmConfiguration - The CloudWatch alarm you want to apply to your 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 SendCommandRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.778

Class SendCommandRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SendCommandRequest

Method Detail

getInstanceIds

setInstanceIds

withInstanceIds

withInstanceIds

getTargets

setTargets

withTargets

withTargets

setDocumentName

getDocumentName

withDocumentName

setDocumentVersion

getDocumentVersion

withDocumentVersion

setDocumentHash

getDocumentHash

withDocumentHash

setDocumentHashType

getDocumentHashType

withDocumentHashType

setDocumentHashType

withDocumentHashType

setTimeoutSeconds

getTimeoutSeconds

withTimeoutSeconds

setComment

getComment

withComment

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setOutputS3Region

getOutputS3Region

withOutputS3Region

setOutputS3BucketName

getOutputS3BucketName

withOutputS3BucketName

setOutputS3KeyPrefix

getOutputS3KeyPrefix

withOutputS3KeyPrefix

setMaxConcurrency

getMaxConcurrency

withMaxConcurrency

setMaxErrors

getMaxErrors

withMaxErrors

setServiceRoleArn

getServiceRoleArn

withServiceRoleArn

setNotificationConfig

getNotificationConfig

withNotificationConfig

setCloudWatchOutputConfig

getCloudWatchOutputConfig

withCloudWatchOutputConfig

setAlarmConfiguration

getAlarmConfiguration

withAlarmConfiguration

toString

equals

hashCode

clone