Class AbstractAmazonSQSAsync
- All Implemented Interfaces:
AmazonSQS
,AmazonSQSAsync
AmazonSQSAsync
. Convenient method forms
pass through to the corresponding overload that takes a request object and an
AsyncHandler
, which throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddPermissionAsync
(AddPermissionRequest request) Adds a permission to a queue for a specific principal.addPermissionAsync
(AddPermissionRequest request, AsyncHandler<AddPermissionRequest, AddPermissionResult> asyncHandler) Adds a permission to a queue for a specific principal.Simplified method form for invoking the AddPermission operation.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.Changes the visibility timeout of a specified message in a queue to a new value.changeMessageVisibilityAsync
(ChangeMessageVisibilityRequest request, AsyncHandler<ChangeMessageVisibilityRequest, ChangeMessageVisibilityResult> asyncHandler) Changes the visibility timeout of a specified message in a queue to a new value.changeMessageVisibilityAsync
(String queueUrl, String receiptHandle, Integer visibilityTimeout) Simplified method form for invoking the ChangeMessageVisibility operation.changeMessageVisibilityAsync
(String queueUrl, String receiptHandle, Integer visibilityTimeout, AsyncHandler<ChangeMessageVisibilityRequest, ChangeMessageVisibilityResult> asyncHandler) Simplified method form for invoking the ChangeMessageVisibility operation with an AsyncHandler.Changes the visibility timeout of multiple messages.changeMessageVisibilityBatchAsync
(ChangeMessageVisibilityBatchRequest request, AsyncHandler<ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityBatchResult> asyncHandler) Changes the visibility timeout of multiple messages.changeMessageVisibilityBatchAsync
(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries) Simplified method form for invoking the ChangeMessageVisibilityBatch operation.changeMessageVisibilityBatchAsync
(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries, AsyncHandler<ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityBatchResult> asyncHandler) Simplified method form for invoking the ChangeMessageVisibilityBatch operation with an AsyncHandler.createQueueAsync
(CreateQueueRequest request) Creates a new queue, or returns the URL of an existing one.createQueueAsync
(CreateQueueRequest request, AsyncHandler<CreateQueueRequest, CreateQueueResult> asyncHandler) Creates a new queue, or returns the URL of an existing one.createQueueAsync
(String queueName) Simplified method form for invoking the CreateQueue operation.createQueueAsync
(String queueName, AsyncHandler<CreateQueueRequest, CreateQueueResult> asyncHandler) Simplified method form for invoking the CreateQueue operation with an AsyncHandler.deleteMessageAsync
(DeleteMessageRequest request) Deletes the specified message from the specified queue.deleteMessageAsync
(DeleteMessageRequest request, AsyncHandler<DeleteMessageRequest, DeleteMessageResult> asyncHandler) Deletes the specified message from the specified queue.deleteMessageAsync
(String queueUrl, String receiptHandle) Simplified method form for invoking the DeleteMessage operation.deleteMessageAsync
(String queueUrl, String receiptHandle, AsyncHandler<DeleteMessageRequest, DeleteMessageResult> asyncHandler) Simplified method form for invoking the DeleteMessage operation with an AsyncHandler.Deletes up to ten messages from the specified queue.deleteMessageBatchAsync
(DeleteMessageBatchRequest request, AsyncHandler<DeleteMessageBatchRequest, DeleteMessageBatchResult> asyncHandler) Deletes up to ten messages from the specified queue.deleteMessageBatchAsync
(String queueUrl, List<DeleteMessageBatchRequestEntry> entries) Simplified method form for invoking the DeleteMessageBatch operation.deleteMessageBatchAsync
(String queueUrl, List<DeleteMessageBatchRequestEntry> entries, AsyncHandler<DeleteMessageBatchRequest, DeleteMessageBatchResult> asyncHandler) Simplified method form for invoking the DeleteMessageBatch operation with an AsyncHandler.deleteQueueAsync
(DeleteQueueRequest request) Deletes the queue specified by the queue URL, regardless of whether the queue is empty.deleteQueueAsync
(DeleteQueueRequest request, AsyncHandler<DeleteQueueRequest, DeleteQueueResult> asyncHandler) Deletes the queue specified by the queue URL, regardless of whether the queue is empty.deleteQueueAsync
(String queueUrl) Simplified method form for invoking the DeleteQueue operation.deleteQueueAsync
(String queueUrl, AsyncHandler<DeleteQueueRequest, DeleteQueueResult> asyncHandler) Simplified method form for invoking the DeleteQueue operation with an AsyncHandler.Gets attributes for the specified queue.getQueueAttributesAsync
(GetQueueAttributesRequest request, AsyncHandler<GetQueueAttributesRequest, GetQueueAttributesResult> asyncHandler) Gets attributes for the specified queue.getQueueAttributesAsync
(String queueUrl, List<String> attributeNames) Simplified method form for invoking the GetQueueAttributes operation.getQueueAttributesAsync
(String queueUrl, List<String> attributeNames, AsyncHandler<GetQueueAttributesRequest, GetQueueAttributesResult> asyncHandler) Simplified method form for invoking the GetQueueAttributes operation with an AsyncHandler.getQueueUrlAsync
(GetQueueUrlRequest request) Returns the URL of an existing queue.getQueueUrlAsync
(GetQueueUrlRequest request, AsyncHandler<GetQueueUrlRequest, GetQueueUrlResult> asyncHandler) Returns the URL of an existing queue.getQueueUrlAsync
(String queueName) Simplified method form for invoking the GetQueueUrl operation.getQueueUrlAsync
(String queueName, AsyncHandler<GetQueueUrlRequest, GetQueueUrlResult> asyncHandler) Simplified method form for invoking the GetQueueUrl operation with an AsyncHandler.Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.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.Simplified method form for invoking the ListQueues operation.listQueuesAsync
(AsyncHandler<ListQueuesRequest, ListQueuesResult> asyncHandler) Simplified method form for invoking the ListQueues operation with an AsyncHandler.listQueuesAsync
(ListQueuesRequest request) Returns a list of your queues.listQueuesAsync
(ListQueuesRequest request, AsyncHandler<ListQueuesRequest, ListQueuesResult> asyncHandler) Returns a list of your queues.listQueuesAsync
(String queueNamePrefix) Simplified method form for invoking the ListQueues operation.listQueuesAsync
(String queueNamePrefix, AsyncHandler<ListQueuesRequest, ListQueuesResult> asyncHandler) Simplified method form for invoking the ListQueues operation with an AsyncHandler.purgeQueueAsync
(PurgeQueueRequest request) Deletes the messages in a queue specified by the queue URL.purgeQueueAsync
(PurgeQueueRequest request, AsyncHandler<PurgeQueueRequest, PurgeQueueResult> asyncHandler) Deletes the messages in a queue specified by the queue URL.receiveMessageAsync
(ReceiveMessageRequest request) Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue.receiveMessageAsync
(ReceiveMessageRequest request, AsyncHandler<ReceiveMessageRequest, ReceiveMessageResult> asyncHandler) Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue.receiveMessageAsync
(String queueUrl) Simplified method form for invoking the ReceiveMessage operation.receiveMessageAsync
(String queueUrl, AsyncHandler<ReceiveMessageRequest, ReceiveMessageResult> asyncHandler) Simplified method form for invoking the ReceiveMessage operation with an AsyncHandler.Revokes any permissions in the queue policy that matches the specifiedLabel
parameter.removePermissionAsync
(RemovePermissionRequest request, AsyncHandler<RemovePermissionRequest, RemovePermissionResult> asyncHandler) Revokes any permissions in the queue policy that matches the specifiedLabel
parameter.removePermissionAsync
(String queueUrl, String label) Simplified method form for invoking the RemovePermission operation.removePermissionAsync
(String queueUrl, String label, AsyncHandler<RemovePermissionRequest, RemovePermissionResult> asyncHandler) Simplified method form for invoking the RemovePermission operation with an AsyncHandler.sendMessageAsync
(SendMessageRequest request) Delivers a message to the specified queue.sendMessageAsync
(SendMessageRequest request, AsyncHandler<SendMessageRequest, SendMessageResult> asyncHandler) Delivers a message to the specified queue.sendMessageAsync
(String queueUrl, String messageBody) Simplified method form for invoking the SendMessage operation.sendMessageAsync
(String queueUrl, String messageBody, AsyncHandler<SendMessageRequest, SendMessageResult> asyncHandler) Simplified method form for invoking the SendMessage operation with an AsyncHandler.Delivers up to ten messages to the specified queue.sendMessageBatchAsync
(SendMessageBatchRequest request, AsyncHandler<SendMessageBatchRequest, SendMessageBatchResult> asyncHandler) Delivers up to ten messages to the specified queue.sendMessageBatchAsync
(String queueUrl, List<SendMessageBatchRequestEntry> entries) Simplified method form for invoking the SendMessageBatch operation.sendMessageBatchAsync
(String queueUrl, List<SendMessageBatchRequestEntry> entries, AsyncHandler<SendMessageBatchRequest, SendMessageBatchResult> asyncHandler) Simplified method form for invoking the SendMessageBatch operation with an AsyncHandler.Sets the value of one or more queue attributes.setQueueAttributesAsync
(SetQueueAttributesRequest request, AsyncHandler<SetQueueAttributesRequest, SetQueueAttributesResult> asyncHandler) Sets the value of one or more queue attributes.setQueueAttributesAsync
(String queueUrl, Map<String, String> attributes) Simplified method form for invoking the SetQueueAttributes operation.setQueueAttributesAsync
(String queueUrl, Map<String, String> attributes, AsyncHandler<SetQueueAttributesRequest, SetQueueAttributesResult> asyncHandler) Simplified method form for invoking the SetQueueAttributes operation with an AsyncHandler.Methods inherited from class com.amazonaws.services.sqs.AbstractAmazonSQS
addPermission, addPermission, changeMessageVisibility, changeMessageVisibility, changeMessageVisibilityBatch, changeMessageVisibilityBatch, createQueue, createQueue, deleteMessage, deleteMessage, deleteMessageBatch, deleteMessageBatch, deleteQueue, deleteQueue, getCachedResponseMetadata, getQueueAttributes, getQueueAttributes, getQueueUrl, getQueueUrl, listDeadLetterSourceQueues, listQueues, listQueues, listQueues, purgeQueue, receiveMessage, receiveMessage, removePermission, removePermission, sendMessage, sendMessage, sendMessageBatch, sendMessageBatch, setEndpoint, setQueueAttributes, setQueueAttributes, setRegion, shutdown
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.sqs.AmazonSQS
addPermission, addPermission, changeMessageVisibility, changeMessageVisibility, changeMessageVisibilityBatch, changeMessageVisibilityBatch, createQueue, createQueue, deleteMessage, deleteMessage, deleteMessageBatch, deleteMessageBatch, deleteQueue, deleteQueue, getCachedResponseMetadata, getQueueAttributes, getQueueAttributes, getQueueUrl, getQueueUrl, listDeadLetterSourceQueues, listQueues, listQueues, listQueues, purgeQueue, receiveMessage, receiveMessage, removePermission, removePermission, sendMessage, sendMessage, sendMessageBatch, sendMessageBatch, setEndpoint, setQueueAttributes, setQueueAttributes, setRegion, shutdown
-
Constructor Details
-
AbstractAmazonSQSAsync
protected AbstractAmazonSQSAsync()
-
-
Method Details
-
addPermissionAsync
Description copied from interface:AmazonSQSAsync
Adds a permission to a queue for a specific principal. This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission
writes an Amazon SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
addPermissionAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the AddPermission operation returned by the service.
-
addPermissionAsync
public Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest request, AsyncHandler<AddPermissionRequest, AddPermissionResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Adds a permission to a queue for a specific principal. This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission
writes an Amazon SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
addPermissionAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the AddPermission operation returned by the service.
-
addPermissionAsync
public Future<AddPermissionResult> addPermissionAsync(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions) Simplified method form for invoking the AddPermission operation.- Specified by:
addPermissionAsync
in interfaceAmazonSQSAsync
- See Also:
-
addPermissionAsync
public 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.- Specified by:
addPermissionAsync
in interfaceAmazonSQSAsync
- See Also:
-
changeMessageVisibilityAsync
public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest request) Description copied from interface:AmazonSQSAsync
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)
For example, let's say you have a message and its default message visibility timeout is 5 minutes. After 3 minutes, you call
ChangeMessageVisiblity
with a timeout of 10 minutes. At that time, the timeout for the message would be extended by 10 minutes beyond the time of the ChangeMessageVisibility call. This results in a total visibility timeout of 13 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend beyond 12 hours, the request will be rejected.There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.
If you attempt to set the
VisibilityTimeout
to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the
ChangeMessageVisibility
action.- Specified by:
changeMessageVisibilityAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ChangeMessageVisibility operation returned by the service.
-
changeMessageVisibilityAsync
public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest request, AsyncHandler<ChangeMessageVisibilityRequest, ChangeMessageVisibilityResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)
For example, let's say you have a message and its default message visibility timeout is 5 minutes. After 3 minutes, you call
ChangeMessageVisiblity
with a timeout of 10 minutes. At that time, the timeout for the message would be extended by 10 minutes beyond the time of the ChangeMessageVisibility call. This results in a total visibility timeout of 13 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend beyond 12 hours, the request will be rejected.There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.
If you attempt to set the
VisibilityTimeout
to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the
ChangeMessageVisibility
action.- Specified by:
changeMessageVisibilityAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the ChangeMessageVisibility operation returned by the service.
-
changeMessageVisibilityAsync
public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(String queueUrl, String receiptHandle, Integer visibilityTimeout) Simplified method form for invoking the ChangeMessageVisibility operation.- Specified by:
changeMessageVisibilityAsync
in interfaceAmazonSQSAsync
- See Also:
-
changeMessageVisibilityAsync
public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(String queueUrl, String receiptHandle, Integer visibilityTimeout, AsyncHandler<ChangeMessageVisibilityRequest, ChangeMessageVisibilityResult> asyncHandler) Simplified method form for invoking the ChangeMessageVisibility operation with an AsyncHandler.- Specified by:
changeMessageVisibilityAsync
in interfaceAmazonSQSAsync
- See Also:
-
changeMessageVisibilityBatchAsync
public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest request) Description copied from interface: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.
Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
changeMessageVisibilityBatchAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ChangeMessageVisibilityBatch operation returned by the service.
-
changeMessageVisibilityBatchAsync
public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest request, AsyncHandler<ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityBatchResult> asyncHandler) Description copied from interface: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.
Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
changeMessageVisibilityBatchAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the ChangeMessageVisibilityBatch operation returned by the service.
-
changeMessageVisibilityBatchAsync
public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries) Simplified method form for invoking the ChangeMessageVisibilityBatch operation.- Specified by:
changeMessageVisibilityBatchAsync
in interfaceAmazonSQSAsync
- See Also:
-
changeMessageVisibilityBatchAsync
public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries, AsyncHandler<ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityBatchResult> asyncHandler) Simplified method form for invoking the ChangeMessageVisibilityBatch operation with an AsyncHandler.- Specified by:
changeMessageVisibilityBatchAsync
in interfaceAmazonSQSAsync
- See Also:
-
createQueueAsync
Description copied from interface:AmazonSQSAsync
Creates a new queue, or returns the URL of an existing one. When you request
CreateQueue
, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues.If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute.
Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the
QueueName
parameter.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 do not match an existing queue,CreateQueue
returns an error.Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
createQueueAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the CreateQueue operation returned by the service.
-
createQueueAsync
public Future<CreateQueueResult> createQueueAsync(CreateQueueRequest request, AsyncHandler<CreateQueueRequest, CreateQueueResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Creates a new queue, or returns the URL of an existing one. When you request
CreateQueue
, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues.If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute.
Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the
QueueName
parameter.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 do not match an existing queue,CreateQueue
returns an error.Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
createQueueAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the CreateQueue operation returned by the service.
-
createQueueAsync
Simplified method form for invoking the CreateQueue operation.- Specified by:
createQueueAsync
in interfaceAmazonSQSAsync
- See Also:
-
createQueueAsync
public Future<CreateQueueResult> createQueueAsync(String queueName, AsyncHandler<CreateQueueRequest, CreateQueueResult> asyncHandler) Simplified method form for invoking the CreateQueue operation with an AsyncHandler.- Specified by:
createQueueAsync
in interfaceAmazonSQSAsync
- See Also:
-
deleteMessageAsync
Description copied from interface:AmazonSQSAsync
Deletes the specified message from the specified queue. You specify the message by using the message's
receipt handle
and not themessage ID
you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it.The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request
DeleteMessage
, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted.It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
- Specified by:
deleteMessageAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the DeleteMessage operation returned by the service.
-
deleteMessageAsync
public Future<DeleteMessageResult> deleteMessageAsync(DeleteMessageRequest request, AsyncHandler<DeleteMessageRequest, DeleteMessageResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Deletes the specified message from the specified queue. You specify the message by using the message's
receipt handle
and not themessage ID
you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it.The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request
DeleteMessage
, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted.It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
- Specified by:
deleteMessageAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the DeleteMessage operation returned by the service.
-
deleteMessageAsync
Simplified method form for invoking the DeleteMessage operation.- Specified by:
deleteMessageAsync
in interfaceAmazonSQSAsync
- See Also:
-
deleteMessageAsync
public Future<DeleteMessageResult> deleteMessageAsync(String queueUrl, String receiptHandle, AsyncHandler<DeleteMessageRequest, DeleteMessageResult> asyncHandler) Simplified method form for invoking the DeleteMessage operation with an AsyncHandler.- Specified by:
deleteMessageAsync
in interfaceAmazonSQSAsync
- See Also:
-
deleteMessageBatchAsync
Description copied from interface:AmazonSQSAsync
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the delete 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.
Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
deleteMessageBatchAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the DeleteMessageBatch operation returned by the service.
-
deleteMessageBatchAsync
public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest request, AsyncHandler<DeleteMessageBatchRequest, DeleteMessageBatchResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the delete 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.
Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
deleteMessageBatchAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the DeleteMessageBatch operation returned by the service.
-
deleteMessageBatchAsync
public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(String queueUrl, List<DeleteMessageBatchRequestEntry> entries) Simplified method form for invoking the DeleteMessageBatch operation.- Specified by:
deleteMessageBatchAsync
in interfaceAmazonSQSAsync
- See Also:
-
deleteMessageBatchAsync
public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(String queueUrl, List<DeleteMessageBatchRequestEntry> entries, AsyncHandler<DeleteMessageBatchRequest, DeleteMessageBatchResult> asyncHandler) Simplified method form for invoking the DeleteMessageBatch operation with an AsyncHandler.- Specified by:
deleteMessageBatchAsync
in interfaceAmazonSQSAsync
- See Also:
-
deleteQueueAsync
Description copied from interface:AmazonSQSAsync
Deletes the queue specified by the queue URL, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.
Use
DeleteQueue
with care; once you delete your 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 the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide.
- Specified by:
deleteQueueAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the DeleteQueue operation returned by the service.
-
deleteQueueAsync
public Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest request, AsyncHandler<DeleteQueueRequest, DeleteQueueResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Deletes the queue specified by the queue URL, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.
Use
DeleteQueue
with care; once you delete your 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 the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide.
- Specified by:
deleteQueueAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the DeleteQueue operation returned by the service.
-
deleteQueueAsync
Simplified method form for invoking the DeleteQueue operation.- Specified by:
deleteQueueAsync
in interfaceAmazonSQSAsync
- See Also:
-
deleteQueueAsync
public Future<DeleteQueueResult> deleteQueueAsync(String queueUrl, AsyncHandler<DeleteQueueRequest, DeleteQueueResult> asyncHandler) Simplified method form for invoking the DeleteQueue operation with an AsyncHandler.- Specified by:
deleteQueueAsync
in interfaceAmazonSQSAsync
- See Also:
-
getQueueAttributesAsync
Description copied from interface:AmazonSQSAsync
Gets attributes for the specified queue.
Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
getQueueAttributesAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the GetQueueAttributes operation returned by the service.
-
getQueueAttributesAsync
public Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest request, AsyncHandler<GetQueueAttributesRequest, GetQueueAttributesResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Gets attributes for the specified queue.
Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
getQueueAttributesAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the GetQueueAttributes operation returned by the service.
-
getQueueAttributesAsync
public Future<GetQueueAttributesResult> getQueueAttributesAsync(String queueUrl, List<String> attributeNames) Simplified method form for invoking the GetQueueAttributes operation.- Specified by:
getQueueAttributesAsync
in interfaceAmazonSQSAsync
- See Also:
-
getQueueAttributesAsync
public Future<GetQueueAttributesResult> getQueueAttributesAsync(String queueUrl, List<String> attributeNames, AsyncHandler<GetQueueAttributesRequest, GetQueueAttributesResult> asyncHandler) Simplified method form for invoking the GetQueueAttributes operation with an AsyncHandler.- Specified by:
getQueueAttributesAsync
in interfaceAmazonSQSAsync
- See Also:
-
getQueueUrlAsync
Description copied from interface:AmazonSQSAsync
Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 go to Shared Queues in the Amazon SQS Developer Guide.- Specified by:
getQueueUrlAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the GetQueueUrl operation returned by the service.
-
getQueueUrlAsync
public Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest request, AsyncHandler<GetQueueUrlRequest, GetQueueUrlResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 go to Shared Queues in the Amazon SQS Developer Guide.- Specified by:
getQueueUrlAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the GetQueueUrl operation returned by the service.
-
getQueueUrlAsync
Simplified method form for invoking the GetQueueUrl operation.- Specified by:
getQueueUrlAsync
in interfaceAmazonSQSAsync
- See Also:
-
getQueueUrlAsync
public Future<GetQueueUrlResult> getQueueUrlAsync(String queueName, AsyncHandler<GetQueueUrlRequest, GetQueueUrlResult> asyncHandler) Simplified method form for invoking the GetQueueUrl operation with an AsyncHandler.- Specified by:
getQueueUrlAsync
in interfaceAmazonSQSAsync
- See Also:
-
listDeadLetterSourceQueuesAsync
public Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest request) Description copied from interface:AmazonSQSAsync
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues.
- Specified by:
listDeadLetterSourceQueuesAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ListDeadLetterSourceQueues operation returned by the service.
-
listDeadLetterSourceQueuesAsync
public Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest request, AsyncHandler<ListDeadLetterSourceQueuesRequest, ListDeadLetterSourceQueuesResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues.
- Specified by:
listDeadLetterSourceQueuesAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the ListDeadLetterSourceQueues operation returned by the service.
-
listQueuesAsync
Description copied from interface:AmazonSQSAsync
Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional
QueueNamePrefix
parameter, only queues with a name beginning with the specified value are returned.- Specified by:
listQueuesAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ListQueues operation returned by the service.
-
listQueuesAsync
public Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest request, AsyncHandler<ListQueuesRequest, ListQueuesResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional
QueueNamePrefix
parameter, only queues with a name beginning with the specified value are returned.- Specified by:
listQueuesAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the ListQueues operation returned by the service.
-
listQueuesAsync
Simplified method form for invoking the ListQueues operation.- Specified by:
listQueuesAsync
in interfaceAmazonSQSAsync
- See Also:
-
listQueuesAsync
public Future<ListQueuesResult> listQueuesAsync(AsyncHandler<ListQueuesRequest, ListQueuesResult> asyncHandler) Simplified method form for invoking the ListQueues operation with an AsyncHandler.- Specified by:
listQueuesAsync
in interfaceAmazonSQSAsync
- See Also:
-
listQueuesAsync
Simplified method form for invoking the ListQueues operation.- Specified by:
listQueuesAsync
in interfaceAmazonSQSAsync
- See Also:
-
listQueuesAsync
public Future<ListQueuesResult> listQueuesAsync(String queueNamePrefix, AsyncHandler<ListQueuesRequest, ListQueuesResult> asyncHandler) Simplified method form for invoking the ListQueues operation with an AsyncHandler.- Specified by:
listQueuesAsync
in interfaceAmazonSQSAsync
- See Also:
-
purgeQueueAsync
Description copied from interface:AmazonSQSAsync
Deletes the messages in a queue specified by the queue URL.
When you use the
PurgeQueue
API, the deleted messages in the queue cannot be retrieved.When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling
PurgeQueue
will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue beforePurgeQueue
was called may be received, but will be deleted within the next minute.- Specified by:
purgeQueueAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the PurgeQueue operation returned by the service.
-
purgeQueueAsync
public Future<PurgeQueueResult> purgeQueueAsync(PurgeQueueRequest request, AsyncHandler<PurgeQueueRequest, PurgeQueueResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Deletes the messages in a queue specified by the queue URL.
When you use the
PurgeQueue
API, the deleted messages in the queue cannot be retrieved.When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling
PurgeQueue
will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue beforePurgeQueue
was called may be received, but will be deleted within the next minute.- Specified by:
purgeQueueAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the PurgeQueue operation returned by the service.
-
receiveMessageAsync
Description copied from interface:AmazonSQSAsync
Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the
WaitTimeSeconds
parameter. For more information, see Amazon SQS Long Poll 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. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested perReceiveMessage
call. If the number of messages in the queue is extremely small, you might not receive any messages in a particularReceiveMessage
response; in which case you should repeat the request.For each message returned, the response includes the following:
-
Message body
-
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
-
Message ID you received when you sent the message to the queue.
-
Receipt handle.
-
Message attributes.
-
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, which will be applied to the messages that Amazon SQS returns in the response. If you do not 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.Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
- Specified by:
receiveMessageAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the ReceiveMessage operation returned by the service.
-
-
receiveMessageAsync
public Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest request, AsyncHandler<ReceiveMessageRequest, ReceiveMessageResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the
WaitTimeSeconds
parameter. For more information, see Amazon SQS Long Poll 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. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested perReceiveMessage
call. If the number of messages in the queue is extremely small, you might not receive any messages in a particularReceiveMessage
response; in which case you should repeat the request.For each message returned, the response includes the following:
-
Message body
-
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
-
Message ID you received when you sent the message to the queue.
-
Receipt handle.
-
Message attributes.
-
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, which will be applied to the messages that Amazon SQS returns in the response. If you do not 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.Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
- Specified by:
receiveMessageAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the ReceiveMessage operation returned by the service.
-
-
receiveMessageAsync
Simplified method form for invoking the ReceiveMessage operation.- Specified by:
receiveMessageAsync
in interfaceAmazonSQSAsync
- See Also:
-
receiveMessageAsync
public Future<ReceiveMessageResult> receiveMessageAsync(String queueUrl, AsyncHandler<ReceiveMessageRequest, ReceiveMessageResult> asyncHandler) Simplified method form for invoking the ReceiveMessage operation with an AsyncHandler.- Specified by:
receiveMessageAsync
in interfaceAmazonSQSAsync
- See Also:
-
removePermissionAsync
Description copied from interface:AmazonSQSAsync
Revokes any permissions in the queue policy that matches the specified
Label
parameter. Only the owner of the queue can remove permissions.- Specified by:
removePermissionAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the RemovePermission operation returned by the service.
-
removePermissionAsync
public Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request, AsyncHandler<RemovePermissionRequest, RemovePermissionResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Revokes any permissions in the queue policy that matches the specified
Label
parameter. Only the owner of the queue can remove permissions.- Specified by:
removePermissionAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the RemovePermission operation returned by the service.
-
removePermissionAsync
Simplified method form for invoking the RemovePermission operation.- Specified by:
removePermissionAsync
in interfaceAmazonSQSAsync
- See Also:
-
removePermissionAsync
public Future<RemovePermissionResult> removePermissionAsync(String queueUrl, String label, AsyncHandler<RemovePermissionRequest, RemovePermissionResult> asyncHandler) Simplified method form for invoking the RemovePermission operation with an AsyncHandler.- Specified by:
removePermissionAsync
in interfaceAmazonSQSAsync
- See Also:
-
sendMessageAsync
Description copied from interface:AmazonSQSAsync
Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC -xml/#charsets If you send any characters not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
- Specified by:
sendMessageAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the SendMessage operation returned by the service.
-
sendMessageAsync
public Future<SendMessageResult> sendMessageAsync(SendMessageRequest request, AsyncHandler<SendMessageRequest, SendMessageResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC -xml/#charsets If you send any characters not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
- Specified by:
sendMessageAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the SendMessage operation returned by the service.
-
sendMessageAsync
Simplified method form for invoking the SendMessage operation.- Specified by:
sendMessageAsync
in interfaceAmazonSQSAsync
- See Also:
-
sendMessageAsync
public Future<SendMessageResult> sendMessageAsync(String queueUrl, String messageBody, AsyncHandler<SendMessageRequest, SendMessageResult> asyncHandler) Simplified method form for invoking the SendMessage operation with an AsyncHandler.- Specified by:
sendMessageAsync
in interfaceAmazonSQSAsync
- See Also:
-
sendMessageBatchAsync
Description copied from interface:AmazonSQSAsync
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes).
The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
If the
DelaySeconds
parameter is not specified for an entry, the default for the queue is used.The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http:// www.faqs.org/rfcs/rfc1321.html. If you send any characters that are not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
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.
Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
sendMessageBatchAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the SendMessageBatch operation returned by the service.
-
sendMessageBatchAsync
public Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest request, AsyncHandler<SendMessageBatchRequest, SendMessageBatchResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes).
The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
If the
DelaySeconds
parameter is not specified for an entry, the default for the queue is used.The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http:// www.faqs.org/rfcs/rfc1321.html. If you send any characters that are not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
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.
Some API actions take lists of parameters. These lists are specified using the
param.n
notation. Values ofn
are integers starting from 1. For example, a parameter list with two elements looks like this:- Specified by:
sendMessageBatchAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the SendMessageBatch operation returned by the service.
-
sendMessageBatchAsync
public Future<SendMessageBatchResult> sendMessageBatchAsync(String queueUrl, List<SendMessageBatchRequestEntry> entries) Simplified method form for invoking the SendMessageBatch operation.- Specified by:
sendMessageBatchAsync
in interfaceAmazonSQSAsync
- See Also:
-
sendMessageBatchAsync
public Future<SendMessageBatchResult> sendMessageBatchAsync(String queueUrl, List<SendMessageBatchRequestEntry> entries, AsyncHandler<SendMessageBatchRequest, SendMessageBatchResult> asyncHandler) Simplified method form for invoking the SendMessageBatch operation with an AsyncHandler.- Specified by:
sendMessageBatchAsync
in interfaceAmazonSQSAsync
- See Also:
-
setQueueAttributesAsync
Description copied from interface:AmazonSQSAsync
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the
MessageRetentionPeriod
attribute can take up to 15 minutes.Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
- Specified by:
setQueueAttributesAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-- Returns:
- A Java Future containing the result of the SetQueueAttributes operation returned by the service.
-
setQueueAttributesAsync
public Future<SetQueueAttributesResult> setQueueAttributesAsync(SetQueueAttributesRequest request, AsyncHandler<SetQueueAttributesRequest, SetQueueAttributesResult> asyncHandler) Description copied from interface:AmazonSQSAsync
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the
MessageRetentionPeriod
attribute can take up to 15 minutes.Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
- Specified by:
setQueueAttributesAsync
in interfaceAmazonSQSAsync
- Parameters:
request
-asyncHandler
- 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.- Returns:
- A Java Future containing the result of the SetQueueAttributes operation returned by the service.
-
setQueueAttributesAsync
public Future<SetQueueAttributesResult> setQueueAttributesAsync(String queueUrl, Map<String, String> attributes) Simplified method form for invoking the SetQueueAttributes operation.- Specified by:
setQueueAttributesAsync
in interfaceAmazonSQSAsync
- See Also:
-
setQueueAttributesAsync
public Future<SetQueueAttributesResult> setQueueAttributesAsync(String queueUrl, Map<String, String> attributes, AsyncHandler<SetQueueAttributesRequest, SetQueueAttributesResult> asyncHandler) Simplified method form for invoking the SetQueueAttributes operation with an AsyncHandler.- Specified by:
setQueueAttributesAsync
in interfaceAmazonSQSAsync
- See Also:
-