@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSQSAsyncClient extends AmazonSQSClient implements AmazonSQSAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Welcome to the Amazon SQS API Reference.
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.
You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional information
Amazon SQS Developer Guide
Amazon Web Services General Reference
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonSQSAsyncClient()
Deprecated.
|
AmazonSQSAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonSQSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonSQSAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonSQSAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
Future<AddPermissionResult> |
addPermissionAsync(AddPermissionRequest request)
Adds a permission to a queue for a specific principal.
|
Future<AddPermissionResult> |
addPermissionAsync(AddPermissionRequest request,
AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
Adds a permission to a queue for a specific principal.
|
Future<AddPermissionResult> |
addPermissionAsync(String queueUrl,
String label,
List<String> aWSAccountIds,
List<String> actions)
Simplified method form for invoking the AddPermission operation.
|
Future<AddPermissionResult> |
addPermissionAsync(String queueUrl,
String label,
List<String> aWSAccountIds,
List<String> actions,
AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
Simplified method form for invoking the AddPermission operation with an AsyncHandler.
|
static AmazonSQSAsyncClientBuilder |
asyncBuilder() |
Future<CancelMessageMoveTaskResult> |
cancelMessageMoveTaskAsync(CancelMessageMoveTaskRequest request)
Cancels a specified message movement task.
|
Future<CancelMessageMoveTaskResult> |
cancelMessageMoveTaskAsync(CancelMessageMoveTaskRequest request,
AsyncHandler<CancelMessageMoveTaskRequest,CancelMessageMoveTaskResult> asyncHandler)
Cancels a specified message movement task.
|
Future<ChangeMessageVisibilityResult> |
changeMessageVisibilityAsync(ChangeMessageVisibilityRequest request)
Changes the visibility timeout of a specified message in a queue to a new value.
|
Future<ChangeMessageVisibilityResult> |
changeMessageVisibilityAsync(ChangeMessageVisibilityRequest request,
AsyncHandler<ChangeMessageVisibilityRequest,ChangeMessageVisibilityResult> asyncHandler)
Changes the visibility timeout of a specified message in a queue to a new value.
|
Future<ChangeMessageVisibilityResult> |
changeMessageVisibilityAsync(String queueUrl,
String receiptHandle,
Integer visibilityTimeout)
Simplified method form for invoking the ChangeMessageVisibility operation.
|
Future<ChangeMessageVisibilityResult> |
changeMessageVisibilityAsync(String queueUrl,
String receiptHandle,
Integer visibilityTimeout,
AsyncHandler<ChangeMessageVisibilityRequest,ChangeMessageVisibilityResult> asyncHandler)
Simplified method form for invoking the ChangeMessageVisibility operation with an AsyncHandler.
|
Future<ChangeMessageVisibilityBatchResult> |
changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest request)
Changes the visibility timeout of multiple messages.
|
Future<ChangeMessageVisibilityBatchResult> |
changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest request,
AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
Changes the visibility timeout of multiple messages.
|
Future<ChangeMessageVisibilityBatchResult> |
changeMessageVisibilityBatchAsync(String queueUrl,
List<ChangeMessageVisibilityBatchRequestEntry> entries)
Simplified method form for invoking the ChangeMessageVisibilityBatch operation.
|
Future<ChangeMessageVisibilityBatchResult> |
changeMessageVisibilityBatchAsync(String queueUrl,
List<ChangeMessageVisibilityBatchRequestEntry> entries,
AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
Simplified method form for invoking the ChangeMessageVisibilityBatch operation with an AsyncHandler.
|
Future<CreateQueueResult> |
createQueueAsync(CreateQueueRequest request)
Creates a new standard or FIFO queue.
|
Future<CreateQueueResult> |
createQueueAsync(CreateQueueRequest request,
AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
Creates a new standard or FIFO queue.
|
Future<CreateQueueResult> |
createQueueAsync(String queueName)
Simplified method form for invoking the CreateQueue operation.
|
Future<CreateQueueResult> |
createQueueAsync(String queueName,
AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
Simplified method form for invoking the CreateQueue operation with an AsyncHandler.
|
Future<DeleteMessageResult> |
deleteMessageAsync(DeleteMessageRequest request)
Deletes the specified message from the specified queue.
|
Future<DeleteMessageResult> |
deleteMessageAsync(DeleteMessageRequest request,
AsyncHandler<DeleteMessageRequest,DeleteMessageResult> asyncHandler)
Deletes the specified message from the specified queue.
|
Future<DeleteMessageResult> |
deleteMessageAsync(String queueUrl,
String receiptHandle)
Simplified method form for invoking the DeleteMessage operation.
|
Future<DeleteMessageResult> |
deleteMessageAsync(String queueUrl,
String receiptHandle,
AsyncHandler<DeleteMessageRequest,DeleteMessageResult> asyncHandler)
Simplified method form for invoking the DeleteMessage operation with an AsyncHandler.
|
Future<DeleteMessageBatchResult> |
deleteMessageBatchAsync(DeleteMessageBatchRequest request)
Deletes up to ten messages from the specified queue.
|
Future<DeleteMessageBatchResult> |
deleteMessageBatchAsync(DeleteMessageBatchRequest request,
AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
Deletes up to ten messages from the specified queue.
|
Future<DeleteMessageBatchResult> |
deleteMessageBatchAsync(String queueUrl,
List<DeleteMessageBatchRequestEntry> entries)
Simplified method form for invoking the DeleteMessageBatch operation.
|
Future<DeleteMessageBatchResult> |
deleteMessageBatchAsync(String queueUrl,
List<DeleteMessageBatchRequestEntry> entries,
AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
Simplified method form for invoking the DeleteMessageBatch operation with an AsyncHandler.
|
Future<DeleteQueueResult> |
deleteQueueAsync(DeleteQueueRequest request)
Deletes the queue specified by the
QueueUrl, regardless of the queue's contents. |
Future<DeleteQueueResult> |
deleteQueueAsync(DeleteQueueRequest request,
AsyncHandler<DeleteQueueRequest,DeleteQueueResult> asyncHandler)
Deletes the queue specified by the
QueueUrl, regardless of the queue's contents. |
Future<DeleteQueueResult> |
deleteQueueAsync(String queueUrl)
Simplified method form for invoking the DeleteQueue operation.
|
Future<DeleteQueueResult> |
deleteQueueAsync(String queueUrl,
AsyncHandler<DeleteQueueRequest,DeleteQueueResult> asyncHandler)
Simplified method form for invoking the DeleteQueue operation with an AsyncHandler.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetQueueAttributesResult> |
getQueueAttributesAsync(GetQueueAttributesRequest request)
Gets attributes for the specified queue.
|
Future<GetQueueAttributesResult> |
getQueueAttributesAsync(GetQueueAttributesRequest request,
AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
Gets attributes for the specified queue.
|
Future<GetQueueAttributesResult> |
getQueueAttributesAsync(String queueUrl,
List<String> attributeNames)
Simplified method form for invoking the GetQueueAttributes operation.
|
Future<GetQueueAttributesResult> |
getQueueAttributesAsync(String queueUrl,
List<String> attributeNames,
AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
Simplified method form for invoking the GetQueueAttributes operation with an AsyncHandler.
|
Future<GetQueueUrlResult> |
getQueueUrlAsync(GetQueueUrlRequest request)
Returns the URL of an existing Amazon SQS queue.
|
Future<GetQueueUrlResult> |
getQueueUrlAsync(GetQueueUrlRequest request,
AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
Returns the URL of an existing Amazon SQS queue.
|
Future<GetQueueUrlResult> |
getQueueUrlAsync(String queueName)
Simplified method form for invoking the GetQueueUrl operation.
|
Future<GetQueueUrlResult> |
getQueueUrlAsync(String queueName,
AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
Simplified method form for invoking the GetQueueUrl operation with an AsyncHandler.
|
Future<ListDeadLetterSourceQueuesResult> |
listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest request)
Returns a list of your queues that have the
RedrivePolicy queue attribute configured with a
dead-letter queue. |
Future<ListDeadLetterSourceQueuesResult> |
listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest request,
AsyncHandler<ListDeadLetterSourceQueuesRequest,ListDeadLetterSourceQueuesResult> asyncHandler)
Returns a list of your queues that have the
RedrivePolicy queue attribute configured with a
dead-letter queue. |
Future<ListMessageMoveTasksResult> |
listMessageMoveTasksAsync(ListMessageMoveTasksRequest request)
Gets the most recent message movement tasks (up to 10) under a specific source queue.
|
Future<ListMessageMoveTasksResult> |
listMessageMoveTasksAsync(ListMessageMoveTasksRequest request,
AsyncHandler<ListMessageMoveTasksRequest,ListMessageMoveTasksResult> asyncHandler)
Gets the most recent message movement tasks (up to 10) under a specific source queue.
|
Future<ListQueuesResult> |
listQueuesAsync()
Simplified method form for invoking the ListQueues operation.
|
Future<ListQueuesResult> |
listQueuesAsync(AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
Simplified method form for invoking the ListQueues operation with an AsyncHandler.
|
Future<ListQueuesResult> |
listQueuesAsync(ListQueuesRequest request)
Returns a list of your queues in the current region.
|
Future<ListQueuesResult> |
listQueuesAsync(ListQueuesRequest request,
AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
Returns a list of your queues in the current region.
|
Future<ListQueuesResult> |
listQueuesAsync(String queueNamePrefix)
Simplified method form for invoking the ListQueues operation.
|
Future<ListQueuesResult> |
listQueuesAsync(String queueNamePrefix,
AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
Simplified method form for invoking the ListQueues operation with an AsyncHandler.
|
Future<ListQueueTagsResult> |
listQueueTagsAsync(ListQueueTagsRequest request)
List all cost allocation tags added to the specified Amazon SQS queue.
|
Future<ListQueueTagsResult> |
listQueueTagsAsync(ListQueueTagsRequest request,
AsyncHandler<ListQueueTagsRequest,ListQueueTagsResult> asyncHandler)
List all cost allocation tags added to the specified Amazon SQS queue.
|
Future<ListQueueTagsResult> |
listQueueTagsAsync(String queueUrl)
Simplified method form for invoking the ListQueueTags operation.
|
Future<ListQueueTagsResult> |
listQueueTagsAsync(String queueUrl,
AsyncHandler<ListQueueTagsRequest,ListQueueTagsResult> asyncHandler)
Simplified method form for invoking the ListQueueTags operation with an AsyncHandler.
|
Future<PurgeQueueResult> |
purgeQueueAsync(PurgeQueueRequest request)
Deletes available messages in a queue (including in-flight messages) specified by the
QueueURL
parameter. |
Future<PurgeQueueResult> |
purgeQueueAsync(PurgeQueueRequest request,
AsyncHandler<PurgeQueueRequest,PurgeQueueResult> asyncHandler)
Deletes available messages in a queue (including in-flight messages) specified by the
QueueURL
parameter. |
Future<ReceiveMessageResult> |
receiveMessageAsync(ReceiveMessageRequest request)
Retrieves one or more messages (up to 10), from the specified queue.
|
Future<ReceiveMessageResult> |
receiveMessageAsync(ReceiveMessageRequest request,
AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
Retrieves one or more messages (up to 10), from the specified queue.
|
Future<ReceiveMessageResult> |
receiveMessageAsync(String queueUrl)
Simplified method form for invoking the ReceiveMessage operation.
|
Future<ReceiveMessageResult> |
receiveMessageAsync(String queueUrl,
AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
Simplified method form for invoking the ReceiveMessage operation with an AsyncHandler.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest request)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest request,
AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
Future<RemovePermissionResult> |
removePermissionAsync(String queueUrl,
String label)
Simplified method form for invoking the RemovePermission operation.
|
Future<RemovePermissionResult> |
removePermissionAsync(String queueUrl,
String label,
AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Simplified method form for invoking the RemovePermission operation with an AsyncHandler.
|
Future<SendMessageResult> |
sendMessageAsync(SendMessageRequest request)
Delivers a message to the specified queue.
|
Future<SendMessageResult> |
sendMessageAsync(SendMessageRequest request,
AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
Delivers a message to the specified queue.
|
Future<SendMessageResult> |
sendMessageAsync(String queueUrl,
String messageBody)
Simplified method form for invoking the SendMessage operation.
|
Future<SendMessageResult> |
sendMessageAsync(String queueUrl,
String messageBody,
AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
Simplified method form for invoking the SendMessage operation with an AsyncHandler.
|
Future<SendMessageBatchResult> |
sendMessageBatchAsync(SendMessageBatchRequest request)
You can use
SendMessageBatch to send up to 10 messages to the specified queue by assigning either
identical or different values to each message (or by not assigning values at all). |
Future<SendMessageBatchResult> |
sendMessageBatchAsync(SendMessageBatchRequest request,
AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
You can use
SendMessageBatch to send up to 10 messages to the specified queue by assigning either
identical or different values to each message (or by not assigning values at all). |
Future<SendMessageBatchResult> |
sendMessageBatchAsync(String queueUrl,
List<SendMessageBatchRequestEntry> entries)
Simplified method form for invoking the SendMessageBatch operation.
|
Future<SendMessageBatchResult> |
sendMessageBatchAsync(String queueUrl,
List<SendMessageBatchRequestEntry> entries,
AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
Simplified method form for invoking the SendMessageBatch operation with an AsyncHandler.
|
Future<SetQueueAttributesResult> |
setQueueAttributesAsync(SetQueueAttributesRequest request)
Sets the value of one or more queue attributes, like a policy.
|
Future<SetQueueAttributesResult> |
setQueueAttributesAsync(SetQueueAttributesRequest request,
AsyncHandler<SetQueueAttributesRequest,SetQueueAttributesResult> asyncHandler)
Sets the value of one or more queue attributes, like a policy.
|
Future<SetQueueAttributesResult> |
setQueueAttributesAsync(String queueUrl,
Map<String,String> attributes)
Simplified method form for invoking the SetQueueAttributes operation.
|
Future<SetQueueAttributesResult> |
setQueueAttributesAsync(String queueUrl,
Map<String,String> attributes,
AsyncHandler<SetQueueAttributesRequest,SetQueueAttributesResult> asyncHandler)
Simplified method form for invoking the SetQueueAttributes operation with an AsyncHandler.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartMessageMoveTaskResult> |
startMessageMoveTaskAsync(StartMessageMoveTaskRequest request)
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
|
Future<StartMessageMoveTaskResult> |
startMessageMoveTaskAsync(StartMessageMoveTaskRequest request,
AsyncHandler<StartMessageMoveTaskRequest,StartMessageMoveTaskResult> asyncHandler)
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
|
Future<TagQueueResult> |
tagQueueAsync(String queueUrl,
Map<String,String> tags)
Simplified method form for invoking the TagQueue operation.
|
Future<TagQueueResult> |
tagQueueAsync(String queueUrl,
Map<String,String> tags,
AsyncHandler<TagQueueRequest,TagQueueResult> asyncHandler)
Simplified method form for invoking the TagQueue operation with an AsyncHandler.
|
Future<TagQueueResult> |
tagQueueAsync(TagQueueRequest request)
Add cost allocation tags to the specified Amazon SQS queue.
|
Future<TagQueueResult> |
tagQueueAsync(TagQueueRequest request,
AsyncHandler<TagQueueRequest,TagQueueResult> asyncHandler)
Add cost allocation tags to the specified Amazon SQS queue.
|
Future<UntagQueueResult> |
untagQueueAsync(String queueUrl,
List<String> tagKeys)
Simplified method form for invoking the UntagQueue operation.
|
Future<UntagQueueResult> |
untagQueueAsync(String queueUrl,
List<String> tagKeys,
AsyncHandler<UntagQueueRequest,UntagQueueResult> asyncHandler)
Simplified method form for invoking the UntagQueue operation with an AsyncHandler.
|
Future<UntagQueueResult> |
untagQueueAsync(UntagQueueRequest request)
Remove cost allocation tags from the specified Amazon SQS queue.
|
Future<UntagQueueResult> |
untagQueueAsync(UntagQueueRequest request,
AsyncHandler<UntagQueueRequest,UntagQueueResult> asyncHandler)
Remove cost allocation tags from the specified Amazon SQS queue.
|
addPermission, addPermission, builder, cancelMessageMoveTask, changeMessageVisibility, changeMessageVisibility, changeMessageVisibilityBatch, changeMessageVisibilityBatch, createQueue, createQueue, deleteMessage, deleteMessage, deleteMessageBatch, deleteMessageBatch, deleteQueue, deleteQueue, getCachedResponseMetadata, getQueueAttributes, getQueueAttributes, getQueueUrl, getQueueUrl, listDeadLetterSourceQueues, listMessageMoveTasks, listQueues, listQueues, listQueues, listQueueTags, listQueueTags, purgeQueue, receiveMessage, receiveMessage, removePermission, removePermission, sendMessage, sendMessage, sendMessageBatch, sendMessageBatch, setQueueAttributes, setQueueAttributes, startMessageMoveTask, tagQueue, tagQueue, untagQueue, untagQueueaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddPermission, addPermission, cancelMessageMoveTask, changeMessageVisibility, changeMessageVisibility, changeMessageVisibilityBatch, changeMessageVisibilityBatch, createQueue, createQueue, deleteMessage, deleteMessage, deleteMessageBatch, deleteMessageBatch, deleteQueue, deleteQueue, getCachedResponseMetadata, getQueueAttributes, getQueueAttributes, getQueueUrl, getQueueUrl, listDeadLetterSourceQueues, listMessageMoveTasks, listQueues, listQueues, listQueues, listQueueTags, listQueueTags, purgeQueue, receiveMessage, receiveMessage, removePermission, removePermission, sendMessage, sendMessage, sendMessageBatch, sendMessageBatch, setEndpoint, setQueueAttributes, setQueueAttributes, setRegion, startMessageMoveTask, tagQueue, tagQueue, untagQueue, untagQueue@Deprecated public AmazonSQSAsyncClient()
AmazonSQSAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonSQSAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Amazon SQS (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonSQSAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonSQSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSQSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AmazonSQSAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest request)
AmazonSQSAsyncAdds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
AddPermission generates a policy for you. You can use SetQueueAttributes to
upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
Amazon SQS AddPermission does not support adding a non-account principal.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
addPermissionAsync in interface AmazonSQSAsyncpublic Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest request, AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
AmazonSQSAsyncAdds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
AddPermission generates a policy for you. You can use SetQueueAttributes to
upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
Amazon SQS AddPermission does not support adding a non-account principal.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
addPermissionAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AddPermissionResult> addPermissionAsync(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions)
addPermissionAsync in interface AmazonSQSAsyncaddPermissionAsync(AddPermissionRequest)public Future<AddPermissionResult> addPermissionAsync(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions, AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
addPermissionAsync in interface AmazonSQSAsyncaddPermissionAsync(AddPermissionRequest, com.amazonaws.handlers.AsyncHandler)public Future<CancelMessageMoveTaskResult> cancelMessageMoveTaskAsync(CancelMessageMoveTaskRequest request)
AmazonSQSAsyncCancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
cancelMessageMoveTaskAsync in interface AmazonSQSAsyncpublic Future<CancelMessageMoveTaskResult> cancelMessageMoveTaskAsync(CancelMessageMoveTaskRequest request, AsyncHandler<CancelMessageMoveTaskRequest,CancelMessageMoveTaskResult> asyncHandler)
AmazonSQSAsyncCancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
cancelMessageMoveTaskAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest request)
AmazonSQSAsyncChanges the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the
message, and you send a ChangeMessageVisibility call with VisibilityTimeout set to 10 seconds, the
10 seconds begin to count from the time that you make the ChangeMessageVisibility call. Thus, any
attempt to change the visibility timeout or to delete that message 10 seconds after you initially change the
visibility timeout (a total of 25 seconds) might result in an error.
An Amazon SQS message has three basic states:
Sent to a queue by a producer.
Received from the queue by a consumer.
Deleted from the queue.
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can be a maximum of
approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the
queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching
the limit, you should delete messages from the queue after they're processed. You can also increase the number of
queues you use to process your messages. To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon
SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum
remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied
immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the
visibility timeout for the message reverts to the original timeout value (not to the value you set using the
ChangeMessageVisibility action) the next time the message is received.
changeMessageVisibilityAsync in interface AmazonSQSAsyncpublic Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest request, AsyncHandler<ChangeMessageVisibilityRequest,ChangeMessageVisibilityResult> asyncHandler)
AmazonSQSAsyncChanges the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the
message, and you send a ChangeMessageVisibility call with VisibilityTimeout set to 10 seconds, the
10 seconds begin to count from the time that you make the ChangeMessageVisibility call. Thus, any
attempt to change the visibility timeout or to delete that message 10 seconds after you initially change the
visibility timeout (a total of 25 seconds) might result in an error.
An Amazon SQS message has three basic states:
Sent to a queue by a producer.
Received from the queue by a consumer.
Deleted from the queue.
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can be a maximum of
approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the
queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching
the limit, you should delete messages from the queue after they're processed. You can also increase the number of
queues you use to process your messages. To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon
SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum
remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied
immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the
visibility timeout for the message reverts to the original timeout value (not to the value you set using the
ChangeMessageVisibility action) the next time the message is received.
changeMessageVisibilityAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(String queueUrl, String receiptHandle, Integer visibilityTimeout)
changeMessageVisibilityAsync in interface AmazonSQSAsyncchangeMessageVisibilityAsync(ChangeMessageVisibilityRequest)public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(String queueUrl, String receiptHandle, Integer visibilityTimeout, AsyncHandler<ChangeMessageVisibilityRequest,ChangeMessageVisibilityResult> asyncHandler)
changeMessageVisibilityAsync in interface AmazonSQSAsyncchangeMessageVisibilityAsync(ChangeMessageVisibilityRequest, com.amazonaws.handlers.AsyncHandler)public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest request)
AmazonSQSAsync
Changes the visibility timeout of multiple messages. This is a batch version of
ChangeMessageVisibility. The result of the action on each message is reported individually
in the response. You can send up to 10 ChangeMessageVisibility requests with each
ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check
for batch errors even when the call returns an HTTP status code of 200.
changeMessageVisibilityBatchAsync in interface AmazonSQSAsyncpublic Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest request, AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
AmazonSQSAsync
Changes the visibility timeout of multiple messages. This is a batch version of
ChangeMessageVisibility. The result of the action on each message is reported individually
in the response. You can send up to 10 ChangeMessageVisibility requests with each
ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check
for batch errors even when the call returns an HTTP status code of 200.
changeMessageVisibilityBatchAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries)
changeMessageVisibilityBatchAsync in interface AmazonSQSAsyncchangeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest)public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries, AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
changeMessageVisibilityBatchAsync in interface AmazonSQSAsyncchangeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest, com.amazonaws.handlers.AsyncHandler)public Future<CreateQueueResult> createQueueAsync(CreateQueueRequest request)
AmazonSQSAsyncCreates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon SQS Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl
requires only the QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes,
CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue
returns an error.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
createQueueAsync in interface AmazonSQSAsyncpublic Future<CreateQueueResult> createQueueAsync(CreateQueueRequest request, AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
AmazonSQSAsyncCreates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon SQS Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl
requires only the QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes,
CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue
returns an error.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
createQueueAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateQueueResult> createQueueAsync(String queueName)
createQueueAsync in interface AmazonSQSAsynccreateQueueAsync(CreateQueueRequest)public Future<CreateQueueResult> createQueueAsync(String queueName, AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
createQueueAsync in interface AmazonSQSAsynccreateQueueAsync(CreateQueueRequest, com.amazonaws.handlers.AsyncHandler)public Future<DeleteMessageResult> deleteMessageAsync(DeleteMessageRequest request)
AmazonSQSAsync
Deletes the specified message from the specified queue. To select the message to delete, use the
ReceiptHandle of the message (not the MessageId which you receive when you send
the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the
message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than
the retention period configured for the queue.
The ReceiptHandle is associated with a specific instance of receiving a message. If you
receive a message more than once, the ReceiptHandle is different each time you receive a message.
When you use the DeleteMessage action, you must provide the most recently received
ReceiptHandle for the message (otherwise, the request succeeds, but the message will not be
deleted).
For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
deleteMessageAsync in interface AmazonSQSAsyncpublic Future<DeleteMessageResult> deleteMessageAsync(DeleteMessageRequest request, AsyncHandler<DeleteMessageRequest,DeleteMessageResult> asyncHandler)
AmazonSQSAsync
Deletes the specified message from the specified queue. To select the message to delete, use the
ReceiptHandle of the message (not the MessageId which you receive when you send
the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the
message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than
the retention period configured for the queue.
The ReceiptHandle is associated with a specific instance of receiving a message. If you
receive a message more than once, the ReceiptHandle is different each time you receive a message.
When you use the DeleteMessage action, you must provide the most recently received
ReceiptHandle for the message (otherwise, the request succeeds, but the message will not be
deleted).
For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
deleteMessageAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteMessageResult> deleteMessageAsync(String queueUrl, String receiptHandle)
deleteMessageAsync in interface AmazonSQSAsyncdeleteMessageAsync(DeleteMessageRequest)public Future<DeleteMessageResult> deleteMessageAsync(String queueUrl, String receiptHandle, AsyncHandler<DeleteMessageRequest,DeleteMessageResult> asyncHandler)
deleteMessageAsync in interface AmazonSQSAsyncdeleteMessageAsync(DeleteMessageRequest, com.amazonaws.handlers.AsyncHandler)public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest request)
AmazonSQSAsync
Deletes up to ten messages from the specified queue. This is a batch version of
DeleteMessage. The result of the action on each message is reported individually in the
response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check
for batch errors even when the call returns an HTTP status code of 200.
deleteMessageBatchAsync in interface AmazonSQSAsyncpublic Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest request, AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
AmazonSQSAsync
Deletes up to ten messages from the specified queue. This is a batch version of
DeleteMessage. The result of the action on each message is reported individually in the
response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check
for batch errors even when the call returns an HTTP status code of 200.
deleteMessageBatchAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(String queueUrl, List<DeleteMessageBatchRequestEntry> entries)
deleteMessageBatchAsync in interface AmazonSQSAsyncdeleteMessageBatchAsync(DeleteMessageBatchRequest)public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(String queueUrl, List<DeleteMessageBatchRequestEntry> entries, AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
deleteMessageBatchAsync in interface AmazonSQSAsyncdeleteMessageBatchAsync(DeleteMessageBatchRequest, com.amazonaws.handlers.AsyncHandler)public Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest request)
AmazonSQSAsync
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no
longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue
during the 60 seconds might succeed. For example, a SendMessage request might succeed, but
after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP GET verb.
deleteQueueAsync in interface AmazonSQSAsyncpublic Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest request, AsyncHandler<DeleteQueueRequest,DeleteQueueResult> asyncHandler)
AmazonSQSAsync
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no
longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue
during the 60 seconds might succeed. For example, a SendMessage request might succeed, but
after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP GET verb.
deleteQueueAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteQueueResult> deleteQueueAsync(String queueUrl)
deleteQueueAsync in interface AmazonSQSAsyncdeleteQueueAsync(DeleteQueueRequest)public Future<DeleteQueueResult> deleteQueueAsync(String queueUrl, AsyncHandler<DeleteQueueRequest,DeleteQueueResult> asyncHandler)
deleteQueueAsync in interface AmazonSQSAsyncdeleteQueueAsync(DeleteQueueRequest, com.amazonaws.handlers.AsyncHandler)public Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest request)
AmazonSQSAsyncGets attributes for the specified queue.
To determine whether a queue is FIFO, you
can check whether QueueName ends with the .fifo suffix.
getQueueAttributesAsync in interface AmazonSQSAsyncpublic Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest request, AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
AmazonSQSAsyncGets attributes for the specified queue.
To determine whether a queue is FIFO, you
can check whether QueueName ends with the .fifo suffix.
getQueueAttributesAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetQueueAttributesResult> getQueueAttributesAsync(String queueUrl, List<String> attributeNames)
getQueueAttributesAsync in interface AmazonSQSAsyncgetQueueAttributesAsync(GetQueueAttributesRequest)public Future<GetQueueAttributesResult> getQueueAttributesAsync(String queueUrl, List<String> attributeNames, AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
getQueueAttributesAsync in interface AmazonSQSAsyncgetQueueAttributesAsync(GetQueueAttributesRequest, com.amazonaws.handlers.AsyncHandler)public Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest request)
AmazonSQSAsyncReturns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to
specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For
more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
getQueueUrlAsync in interface AmazonSQSAsyncpublic Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest request, AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
AmazonSQSAsyncReturns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to
specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For
more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
getQueueUrlAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetQueueUrlResult> getQueueUrlAsync(String queueName)
getQueueUrlAsync in interface AmazonSQSAsyncgetQueueUrlAsync(GetQueueUrlRequest)public Future<GetQueueUrlResult> getQueueUrlAsync(String queueName, AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
getQueueUrlAsync in interface AmazonSQSAsyncgetQueueUrlAsync(GetQueueUrlRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest request)
AmazonSQSAsync
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a
dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set parameter MaxResults in
the request to specify the maximum number of results to be returned in the response. If you do not set
MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and
there are additional results to display, the response includes a value for NextToken. Use
NextToken as a parameter in your next request to ListDeadLetterSourceQueues to receive
the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.
listDeadLetterSourceQueuesAsync in interface AmazonSQSAsyncpublic Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest request, AsyncHandler<ListDeadLetterSourceQueuesRequest,ListDeadLetterSourceQueuesResult> asyncHandler)
AmazonSQSAsync
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a
dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set parameter MaxResults in
the request to specify the maximum number of results to be returned in the response. If you do not set
MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and
there are additional results to display, the response includes a value for NextToken. Use
NextToken as a parameter in your next request to ListDeadLetterSourceQueues to receive
the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.
listDeadLetterSourceQueuesAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListMessageMoveTasksResult> listMessageMoveTasksAsync(ListMessageMoveTasksRequest request)
AmazonSQSAsyncGets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
listMessageMoveTasksAsync in interface AmazonSQSAsyncpublic Future<ListMessageMoveTasksResult> listMessageMoveTasksAsync(ListMessageMoveTasksRequest request, AsyncHandler<ListMessageMoveTasksRequest,ListMessageMoveTasksResult> asyncHandler)
AmazonSQSAsyncGets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
listMessageMoveTasksAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListQueueTagsResult> listQueueTagsAsync(ListQueueTagsRequest request)
AmazonSQSAsyncList all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
listQueueTagsAsync in interface AmazonSQSAsyncpublic Future<ListQueueTagsResult> listQueueTagsAsync(ListQueueTagsRequest request, AsyncHandler<ListQueueTagsRequest,ListQueueTagsResult> asyncHandler)
AmazonSQSAsyncList all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
listQueueTagsAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListQueueTagsResult> listQueueTagsAsync(String queueUrl)
listQueueTagsAsync in interface AmazonSQSAsynclistQueueTagsAsync(ListQueueTagsRequest)public Future<ListQueueTagsResult> listQueueTagsAsync(String queueUrl, AsyncHandler<ListQueueTagsRequest,ListQueueTagsResult> asyncHandler)
listQueueTagsAsync in interface AmazonSQSAsynclistQueueTagsAsync(ListQueueTagsRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest request)
AmazonSQSAsync
Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you
specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with
the specified value are returned.
The listQueues methods supports pagination. Set parameter MaxResults in the request to
specify the maximum number of results to be returned in the response. If you do not set MaxResults,
the response includes a maximum of 1,000 results. If you set MaxResults and there are additional
results to display, the response includes a value for NextToken. Use NextToken as a
parameter in your next request to listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
listQueuesAsync in interface AmazonSQSAsyncpublic Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest request, AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
AmazonSQSAsync
Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you
specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with
the specified value are returned.
The listQueues methods supports pagination. Set parameter MaxResults in the request to
specify the maximum number of results to be returned in the response. If you do not set MaxResults,
the response includes a maximum of 1,000 results. If you set MaxResults and there are additional
results to display, the response includes a value for NextToken. Use NextToken as a
parameter in your next request to listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
listQueuesAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListQueuesResult> listQueuesAsync()
listQueuesAsync in interface AmazonSQSAsynclistQueuesAsync(ListQueuesRequest)public Future<ListQueuesResult> listQueuesAsync(AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
listQueuesAsync in interface AmazonSQSAsynclistQueuesAsync(ListQueuesRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListQueuesResult> listQueuesAsync(String queueNamePrefix)
listQueuesAsync in interface AmazonSQSAsynclistQueuesAsync(ListQueuesRequest)public Future<ListQueuesResult> listQueuesAsync(String queueNamePrefix, AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
listQueuesAsync in interface AmazonSQSAsynclistQueuesAsync(ListQueuesRequest, com.amazonaws.handlers.AsyncHandler)public Future<PurgeQueueResult> purgeQueueAsync(PurgeQueueRequest request)
AmazonSQSAsync
Deletes available messages in a queue (including in-flight messages) specified by the QueueURL
parameter.
When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.
Messages sent to the queue before you call PurgeQueue might be received but are deleted
within the next minute.
Messages sent to the queue after you call PurgeQueue might be deleted while the queue is
being purged.
purgeQueueAsync in interface AmazonSQSAsyncpublic Future<PurgeQueueResult> purgeQueueAsync(PurgeQueueRequest request, AsyncHandler<PurgeQueueRequest,PurgeQueueResult> asyncHandler)
AmazonSQSAsync
Deletes available messages in a queue (including in-flight messages) specified by the QueueURL
parameter.
When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.
Messages sent to the queue before you call PurgeQueue might be received but are deleted
within the next minute.
Messages sent to the queue after you call PurgeQueue might be deleted while the queue is
being purged.
purgeQueueAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest request)
AmazonSQSAsync
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds
parameter enables long-poll support. For more information, see Amazon
SQS Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a
ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of
messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per
ReceiveMessage call. If the number of messages in the queue is extremely small, you might not
receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
For each message returned, the response includes the following:
The message body.
An MD5 digest of the message body. For information about MD5, see RFC1321.
The MessageId you received when you sent the message to the queue.
The receipt handle.
The message attributes.
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the
messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility
timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
receiveMessageAsync in interface AmazonSQSAsyncpublic Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest request, AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
AmazonSQSAsync
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds
parameter enables long-poll support. For more information, see Amazon
SQS Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a
ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of
messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per
ReceiveMessage call. If the number of messages in the queue is extremely small, you might not
receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
For each message returned, the response includes the following:
The message body.
An MD5 digest of the message body. For information about MD5, see RFC1321.
The MessageId you received when you sent the message to the queue.
The receipt handle.
The message attributes.
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the
messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility
timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
receiveMessageAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReceiveMessageResult> receiveMessageAsync(String queueUrl)
receiveMessageAsync in interface AmazonSQSAsyncreceiveMessageAsync(ReceiveMessageRequest)public Future<ReceiveMessageResult> receiveMessageAsync(String queueUrl, AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
receiveMessageAsync in interface AmazonSQSAsyncreceiveMessageAsync(ReceiveMessageRequest, com.amazonaws.handlers.AsyncHandler)public Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request)
AmazonSQSAsync
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
removePermissionAsync in interface AmazonSQSAsyncpublic Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
AmazonSQSAsync
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
removePermissionAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemovePermissionResult> removePermissionAsync(String queueUrl, String label)
removePermissionAsync in interface AmazonSQSAsyncremovePermissionAsync(RemovePermissionRequest)public Future<RemovePermissionResult> removePermissionAsync(String queueUrl, String label, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
removePermissionAsync in interface AmazonSQSAsyncremovePermissionAsync(RemovePermissionRequest, com.amazonaws.handlers.AsyncHandler)public Future<SendMessageResult> sendMessageAsync(SendMessageRequest request)
AmazonSQSAsyncDelivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9 | #xA | #xD | #x20 to #xD7FF |
#xE000 to #xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue,
as long as the message body contains at least one valid character.
sendMessageAsync in interface AmazonSQSAsyncpublic Future<SendMessageResult> sendMessageAsync(SendMessageRequest request, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
AmazonSQSAsyncDelivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9 | #xA | #xD | #x20 to #xD7FF |
#xE000 to #xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue,
as long as the message body contains at least one valid character.
sendMessageAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendMessageResult> sendMessageAsync(String queueUrl, String messageBody)
sendMessageAsync in interface AmazonSQSAsyncsendMessageAsync(SendMessageRequest)public Future<SendMessageResult> sendMessageAsync(String queueUrl, String messageBody, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
sendMessageAsync in interface AmazonSQSAsyncsendMessageAsync(SendMessageRequest, com.amazonaws.handlers.AsyncHandler)public Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest request)
AmazonSQSAsync
You can use SendMessageBatch to send up to 10 messages to the specified queue by assigning either
identical or different values to each message (or by not assigning values at all). This is a batch version of
SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the
order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result
in a combination of successful and unsuccessful actions, you should check for batch errors even when the call
returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9 | #xA | #xD | #x20 to #xD7FF |
#xE000 to #xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue,
as long as the message body contains at least one valid character.
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for
the queue.
sendMessageBatchAsync in interface AmazonSQSAsyncpublic Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest request, AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
AmazonSQSAsync
You can use SendMessageBatch to send up to 10 messages to the specified queue by assigning either
identical or different values to each message (or by not assigning values at all). This is a batch version of
SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the
order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result
in a combination of successful and unsuccessful actions, you should check for batch errors even when the call
returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
#x9 | #xA | #xD | #x20 to #xD7FF |
#xE000 to #xFFFD | #x10000 to #x10FFFF
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters.
Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue,
as long as the message body contains at least one valid character.
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for
the queue.
sendMessageBatchAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendMessageBatchResult> sendMessageBatchAsync(String queueUrl, List<SendMessageBatchRequestEntry> entries)
sendMessageBatchAsync in interface AmazonSQSAsyncsendMessageBatchAsync(SendMessageBatchRequest)public Future<SendMessageBatchResult> sendMessageBatchAsync(String queueUrl, List<SendMessageBatchRequestEntry> entries, AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
sendMessageBatchAsync in interface AmazonSQSAsyncsendMessageBatchAsync(SendMessageBatchRequest, com.amazonaws.handlers.AsyncHandler)public Future<SetQueueAttributesResult> setQueueAttributesAsync(SetQueueAttributesRequest request)
AmazonSQSAsync
Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change
can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made
to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages
in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is
reduced below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
setQueueAttributesAsync in interface AmazonSQSAsyncpublic Future<SetQueueAttributesResult> setQueueAttributesAsync(SetQueueAttributesRequest request, AsyncHandler<SetQueueAttributesRequest,SetQueueAttributesResult> asyncHandler)
AmazonSQSAsync
Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes, the change
can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made
to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages
in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is
reduced below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
setQueueAttributesAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetQueueAttributesResult> setQueueAttributesAsync(String queueUrl, Map<String,String> attributes)
setQueueAttributesAsync in interface AmazonSQSAsyncsetQueueAttributesAsync(SetQueueAttributesRequest)public Future<SetQueueAttributesResult> setQueueAttributesAsync(String queueUrl, Map<String,String> attributes, AsyncHandler<SetQueueAttributesRequest,SetQueueAttributesResult> asyncHandler)
setQueueAttributesAsync in interface AmazonSQSAsyncsetQueueAttributesAsync(SetQueueAttributesRequest, com.amazonaws.handlers.AsyncHandler)public Future<StartMessageMoveTaskResult> startMessageMoveTaskAsync(StartMessageMoveTaskRequest request)
AmazonSQSAsyncStarts an asynchronous task to move messages from a specified source queue to a specified destination queue.
This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while
the destination queue can be the original source queue (from which the messages were driven to the
dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
startMessageMoveTaskAsync in interface AmazonSQSAsyncpublic Future<StartMessageMoveTaskResult> startMessageMoveTaskAsync(StartMessageMoveTaskRequest request, AsyncHandler<StartMessageMoveTaskRequest,StartMessageMoveTaskResult> asyncHandler)
AmazonSQSAsyncStarts an asynchronous task to move messages from a specified source queue to a specified destination queue.
This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while
the destination queue can be the original source queue (from which the messages were driven to the
dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given time.
startMessageMoveTaskAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagQueueResult> tagQueueAsync(TagQueueRequest request)
AmazonSQSAsyncAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
tagQueueAsync in interface AmazonSQSAsyncpublic Future<TagQueueResult> tagQueueAsync(TagQueueRequest request, AsyncHandler<TagQueueRequest,TagQueueResult> asyncHandler)
AmazonSQSAsyncAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
tagQueueAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagQueueResult> tagQueueAsync(String queueUrl, Map<String,String> tags)
tagQueueAsync in interface AmazonSQSAsynctagQueueAsync(TagQueueRequest)public Future<TagQueueResult> tagQueueAsync(String queueUrl, Map<String,String> tags, AsyncHandler<TagQueueRequest,TagQueueResult> asyncHandler)
tagQueueAsync in interface AmazonSQSAsynctagQueueAsync(TagQueueRequest, com.amazonaws.handlers.AsyncHandler)public Future<UntagQueueResult> untagQueueAsync(UntagQueueRequest request)
AmazonSQSAsyncRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
untagQueueAsync in interface AmazonSQSAsyncpublic Future<UntagQueueResult> untagQueueAsync(UntagQueueRequest request, AsyncHandler<UntagQueueRequest,UntagQueueResult> asyncHandler)
AmazonSQSAsyncRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
untagQueueAsync in interface AmazonSQSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagQueueResult> untagQueueAsync(String queueUrl, List<String> tagKeys)
untagQueueAsync in interface AmazonSQSAsyncuntagQueueAsync(UntagQueueRequest)public Future<UntagQueueResult> untagQueueAsync(String queueUrl, List<String> tagKeys, AsyncHandler<UntagQueueRequest,UntagQueueResult> asyncHandler)
untagQueueAsync in interface AmazonSQSAsyncuntagQueueAsync(UntagQueueRequest, com.amazonaws.handlers.AsyncHandler)public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonSQSshutdown in class AmazonSQSClient