SendCommandRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.15.40 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ssm.model.SsmRequest
    - - software.amazon.awssdk.services.ssm.model.SendCommandRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SendCommandRequest
extends SsmRequest
implements ToCopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SendCommandRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SendCommandRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SendCommandRequest.Builder`	`builder()`
`CloudWatchOutputConfig`	`cloudWatchOutputConfig()` Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
`String`	`comment()` User-specified information about the command, such as a brief description of what the command should do.
`String`	`documentHash()` The Sha256 or Sha1 hash created by the system when the document was created.
`DocumentHashType`	`documentHashType()` Sha256 or Sha1.
`String`	`documentHashTypeAsString()` Sha256 or Sha1.
`String`	`documentName()` Required.
`String`	`documentVersion()` The SSM document version to use in the request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInstanceIds()` Returns true if the InstanceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasParameters()` Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTargets()` Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`instanceIds()` The IDs of the instances where the command should run.
`String`	`maxConcurrency()` (Optional) The maximum number of instances that are allowed to run the command at the same time.
`String`	`maxErrors()` The maximum number of errors allowed without the command failing.
`NotificationConfig`	`notificationConfig()` Configurations for sending notifications.
`String`	`outputS3BucketName()` The name of the S3 bucket where command execution responses should be stored.
`String`	`outputS3KeyPrefix()` The directory structure within the S3 bucket where the responses should be stored.
`String`	`outputS3Region()` (Deprecated) You can no longer specify this parameter.
`Map<String,List<String>>`	`parameters()` The required and optional parameters specified in the document being run.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SendCommandRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceRoleArn()` The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
`List<Target>`	`targets()` An array of search criteria that targets instances using a `Key,Value` combination that you specify.
`Integer`	`timeoutSeconds()` If this time is reached and the command has not already started running, it will not run.
`SendCommandRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasInstanceIds
```
public boolean hasInstanceIds()
```
    Returns true if the InstanceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - instanceIds
```
public List<String> instanceIds()
```
    The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.
    
    To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.
    
    For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the AWS Systems Manager User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInstanceIds() to see if a value was sent in this field.
    
    Returns:
    
    The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.
    
    To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.
    
    For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the AWS Systems Manager User Guide.
  - hasTargets
```
public boolean hasTargets()
```
    Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - targets
```
public List<Target> targets()
```
    An array of search criteria that targets instances 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 instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.
    
    To send a command to a smaller number of instances, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Sending commands to a fleet in the AWS Systems Manager User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTargets() to see if a value was sent in this field.
    
    Returns:
    
    An array of search criteria that targets instances 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 instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.
    
    To send a command to a smaller number of instances, you can use the InstanceIds option instead.
    
    For more information about how to use targets, see Sending commands to a fleet in the AWS Systems Manager User Guide.
  - documentName
```
public String documentName()
```
    Required. The name of the Systems Manager document to run. This can be a public document or a custom document.
    
    Returns:
    
    Required. The name of the Systems Manager document to run. This can be a public document or a custom document.
  - documentVersion
```
public 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 AWS 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 AWS 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"
  - documentHash
```
public String documentHash()
```
    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.
  - documentHashType
```
public DocumentHashType documentHashType()
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    If the service returns an enum value that is not available in the current SDK version, documentHashType will return DocumentHashType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentHashTypeAsString().
    
    Returns:
    
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - documentHashTypeAsString
```
public String documentHashTypeAsString()
```
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    If the service returns an enum value that is not available in the current SDK version, documentHashType will return DocumentHashType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentHashTypeAsString().
    
    Returns:
    
    Sha256 or Sha1.
    
    Sha1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - timeoutSeconds
```
public Integer timeoutSeconds()
```
    If this time is reached and the command has not already started running, it will not run.
    
    Returns:
    
    If this time is reached and the command has not already started running, it will not run.
  - comment
```
public String comment()
```
    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.
  - hasParameters
```
public boolean hasParameters()
```
    Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - parameters
```
public Map<String,List<String>> parameters()
```
    The required and optional parameters specified in the document being run.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasParameters() to see if a value was sent in this field.
    
    Returns:
    
    The required and optional parameters specified in the document being run.
  - outputS3Region
```
public String outputS3Region()
```
    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
    
    Returns:
    
    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
  - outputS3BucketName
```
public String outputS3BucketName()
```
    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.
  - outputS3KeyPrefix
```
public String outputS3KeyPrefix()
```
    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.
  - maxConcurrency
```
public String maxConcurrency()
```
    (Optional) The maximum number of instances 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 AWS Systems Manager User Guide.
    
    Returns:
    
    (Optional) The maximum number of instances 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 AWS Systems Manager User Guide.
  - maxErrors
```
public 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 AWS 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 AWS Systems Manager User Guide.
  - serviceRoleArn
```
public String serviceRoleArn()
```
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
    
    Returns:
    
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
  - notificationConfig
```
public NotificationConfig notificationConfig()
```
    Configurations for sending notifications.
    
    Returns:
    
    Configurations for sending notifications.
  - cloudWatchOutputConfig
```
public CloudWatchOutputConfig cloudWatchOutputConfig()
```
    Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
    
    Returns:
    
    Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
  - toBuilder
```
public SendCommandRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
  - builder
```
public static SendCommandRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SendCommandRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SendCommandRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasInstanceIds

instanceIds

hasTargets

targets

documentName

documentVersion

documentHash

documentHashType

documentHashTypeAsString

timeoutSeconds

comment

hasParameters

parameters

outputS3Region

outputS3BucketName

outputS3KeyPrefix

maxConcurrency

maxErrors

serviceRoleArn

notificationConfig

cloudWatchOutputConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields