public class AmazonSQSBufferedAsyncClient extends Object implements AmazonSQSAsync
Modifier and Type | Field and Description |
---|---|
static String |
USER_AGENT |
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS) |
AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS,
QueueBufferConfig config) |
Modifier and Type | Method and Description |
---|---|
AddPermissionResult |
addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to a queue for a specific principal.
|
AddPermissionResult |
addPermission(String queueUrl,
String label,
List<String> aWSAccountIds,
List<String> actions)
Simplified method form for invoking the AddPermission operation.
|
Future<AddPermissionResult> |
addPermissionAsync(AddPermissionRequest addPermissionRequest)
Adds a permission to a queue for a specific principal.
|
Future<AddPermissionResult> |
addPermissionAsync(AddPermissionRequest addPermissionRequest,
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.
|
ChangeMessageVisibilityResult |
changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new value.
|
ChangeMessageVisibilityResult |
changeMessageVisibility(String queueUrl,
String receiptHandle,
Integer visibilityTimeout)
Simplified method form for invoking the ChangeMessageVisibility operation.
|
Future<ChangeMessageVisibilityResult> |
changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new value.
|
Future<ChangeMessageVisibilityResult> |
changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest,
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.
|
ChangeMessageVisibilityBatchResult |
changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
Changes the visibility timeout of multiple messages.
|
ChangeMessageVisibilityBatchResult |
changeMessageVisibilityBatch(String queueUrl,
List<ChangeMessageVisibilityBatchRequestEntry> entries)
Simplified method form for invoking the ChangeMessageVisibilityBatch operation.
|
Future<ChangeMessageVisibilityBatchResult> |
changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
Changes the visibility timeout of multiple messages.
|
Future<ChangeMessageVisibilityBatchResult> |
changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest,
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.
|
CreateQueueResult |
createQueue(CreateQueueRequest createQueueRequest)
Creates a new standard or FIFO queue.
|
CreateQueueResult |
createQueue(String queueName)
Simplified method form for invoking the CreateQueue operation.
|
Future<CreateQueueResult> |
createQueueAsync(CreateQueueRequest createQueueRequest)
Creates a new standard or FIFO queue.
|
Future<CreateQueueResult> |
createQueueAsync(CreateQueueRequest createQueueRequest,
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.
|
DeleteMessageResult |
deleteMessage(DeleteMessageRequest deleteMessageRequest)
Deletes the specified message from the specified queue.
|
DeleteMessageResult |
deleteMessage(String queueUrl,
String receiptHandle)
Simplified method form for invoking the DeleteMessage operation.
|
Future<DeleteMessageResult> |
deleteMessageAsync(DeleteMessageRequest deleteMessageRequest)
Deletes the specified message from the specified queue.
|
Future<DeleteMessageResult> |
deleteMessageAsync(DeleteMessageRequest deleteMessageRequest,
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.
|
DeleteMessageBatchResult |
deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
Deletes up to ten messages from the specified queue.
|
DeleteMessageBatchResult |
deleteMessageBatch(String queueUrl,
List<DeleteMessageBatchRequestEntry> entries)
Simplified method form for invoking the DeleteMessageBatch operation.
|
Future<DeleteMessageBatchResult> |
deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest)
Deletes up to ten messages from the specified queue.
|
Future<DeleteMessageBatchResult> |
deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest,
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.
|
DeleteQueueResult |
deleteQueue(DeleteQueueRequest deleteQueueRequest)
Deletes the queue specified by the
QueueUrl , regardless of the queue's contents. |
DeleteQueueResult |
deleteQueue(String queueUrl)
Simplified method form for invoking the DeleteQueue operation.
|
Future<DeleteQueueResult> |
deleteQueueAsync(DeleteQueueRequest deleteQueueRequest)
Deletes the queue specified by the
QueueUrl , regardless of the queue's contents. |
Future<DeleteQueueResult> |
deleteQueueAsync(DeleteQueueRequest deleteQueueRequest,
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.
|
void |
flush()
Flushes all outstanding outbound requests.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetQueueAttributesResult |
getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
Gets attributes for the specified queue.
|
GetQueueAttributesResult |
getQueueAttributes(String queueUrl,
List<String> attributeNames)
Simplified method form for invoking the GetQueueAttributes operation.
|
Future<GetQueueAttributesResult> |
getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest)
Gets attributes for the specified queue.
|
Future<GetQueueAttributesResult> |
getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest,
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.
|
GetQueueUrlResult |
getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
Returns the URL of an existing queue.
|
GetQueueUrlResult |
getQueueUrl(String queueName)
Simplified method form for invoking the GetQueueUrl operation.
|
Future<GetQueueUrlResult> |
getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest)
Returns the URL of an existing queue.
|
Future<GetQueueUrlResult> |
getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest,
AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
Returns the URL of an existing 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.
|
ListDeadLetterSourceQueuesResult |
listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
Returns a list of your queues that have the
RedrivePolicy queue attribute configured with a
dead-letter queue. |
Future<ListDeadLetterSourceQueuesResult> |
listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
Returns a list of your queues that have the
RedrivePolicy queue attribute configured with a
dead-letter queue. |
Future<ListDeadLetterSourceQueuesResult> |
listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest,
AsyncHandler<ListDeadLetterSourceQueuesRequest,ListDeadLetterSourceQueuesResult> asyncHandler)
Returns a list of your queues that have the
RedrivePolicy queue attribute configured with a
dead-letter queue. |
ListQueuesResult |
listQueues()
Simplified method form for invoking the ListQueues operation.
|
ListQueuesResult |
listQueues(ListQueuesRequest listQueuesRequest)
Returns a list of your queues.
|
ListQueuesResult |
listQueues(String queueNamePrefix)
Simplified method form for invoking the ListQueues operation.
|
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 listQueuesRequest)
Returns a list of your queues.
|
Future<ListQueuesResult> |
listQueuesAsync(ListQueuesRequest listQueuesRequest,
AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
Returns a list of your queues.
|
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.
|
ListQueueTagsResult |
listQueueTags(ListQueueTagsRequest listQueueTagsRequest)
List all cost allocation tags added to the specified Amazon SQS queue.
|
ListQueueTagsResult |
listQueueTags(String queueUrl)
Simplified method form for invoking the ListQueueTags operation.
|
Future<ListQueueTagsResult> |
listQueueTagsAsync(ListQueueTagsRequest listQueueTagsRequest)
List all cost allocation tags added to the specified Amazon SQS queue.
|
Future<ListQueueTagsResult> |
listQueueTagsAsync(ListQueueTagsRequest listQueueTagsRequest,
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.
|
PurgeQueueResult |
purgeQueue(PurgeQueueRequest purgeQueueRequest)
Deletes the messages in a queue specified by the
QueueURL parameter. |
Future<PurgeQueueResult> |
purgeQueueAsync(PurgeQueueRequest purgeQueueRequest)
Deletes the messages in a queue specified by the
QueueURL parameter. |
Future<PurgeQueueResult> |
purgeQueueAsync(PurgeQueueRequest purgeQueueRequest,
AsyncHandler<PurgeQueueRequest,PurgeQueueResult> asyncHandler)
Deletes the messages in a queue specified by the
QueueURL parameter. |
ReceiveMessageResult |
receiveMessage(ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages (up to 10), from the specified queue.
|
ReceiveMessageResult |
receiveMessage(String queueUrl)
Simplified method form for invoking the ReceiveMessage operation.
|
Future<ReceiveMessageResult> |
receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages (up to 10), from the specified queue.
|
Future<ReceiveMessageResult> |
receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest,
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.
|
RemovePermissionResult |
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
RemovePermissionResult |
removePermission(String queueUrl,
String label)
Simplified method form for invoking the RemovePermission operation.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest,
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.
|
SendMessageResult |
sendMessage(SendMessageRequest sendMessageRequest)
Delivers a message to the specified queue.
|
SendMessageResult |
sendMessage(String queueUrl,
String messageBody)
Simplified method form for invoking the SendMessage operation.
|
Future<SendMessageResult> |
sendMessageAsync(SendMessageRequest sendMessageRequest)
Delivers a message to the specified queue.
|
Future<SendMessageResult> |
sendMessageAsync(SendMessageRequest sendMessageRequest,
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.
|
SendMessageBatchResult |
sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
Delivers up to ten messages to the specified queue.
|
SendMessageBatchResult |
sendMessageBatch(String queueUrl,
List<SendMessageBatchRequestEntry> entries)
Simplified method form for invoking the SendMessageBatch operation.
|
Future<SendMessageBatchResult> |
sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest)
Delivers up to ten messages to the specified queue.
|
Future<SendMessageBatchResult> |
sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest,
AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
Delivers up to ten messages to the specified queue.
|
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.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://sqs.us-east-1.amazonaws.com").
|
SetQueueAttributesResult |
setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
Sets the value of one or more queue attributes.
|
SetQueueAttributesResult |
setQueueAttributes(String queueUrl,
Map<String,String> attributes)
Simplified method form for invoking the SetQueueAttributes operation.
|
Future<SetQueueAttributesResult> |
setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest)
Sets the value of one or more queue attributes.
|
Future<SetQueueAttributesResult> |
setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest,
AsyncHandler<SetQueueAttributesRequest,SetQueueAttributesResult> asyncHandler)
Sets the value of one or more queue attributes.
|
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 |
setRegion(Region region)
An alternative to
AmazonSQS.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagQueueResult |
tagQueue(String queueUrl,
Map<String,String> tags)
Simplified method form for invoking the TagQueue operation.
|
TagQueueResult |
tagQueue(TagQueueRequest tagQueueRequest)
Add cost allocation tags to the specified Amazon SQS 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 tagQueueRequest)
Add cost allocation tags to the specified Amazon SQS queue.
|
Future<TagQueueResult> |
tagQueueAsync(TagQueueRequest tagQueueRequest,
AsyncHandler<TagQueueRequest,TagQueueResult> asyncHandler)
Add cost allocation tags to the specified Amazon SQS queue.
|
UntagQueueResult |
untagQueue(String queueUrl,
List<String> tagKeys)
Simplified method form for invoking the UntagQueue operation.
|
UntagQueueResult |
untagQueue(UntagQueueRequest untagQueueRequest)
Remove cost allocation tags from 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 untagQueueRequest)
Remove cost allocation tags from the specified Amazon SQS queue.
|
Future<UntagQueueResult> |
untagQueueAsync(UntagQueueRequest untagQueueRequest,
AsyncHandler<UntagQueueRequest,UntagQueueResult> asyncHandler)
Remove cost allocation tags from the specified Amazon SQS queue.
|
public static final String USER_AGENT
public AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS)
public AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS, QueueBufferConfig config)
public void setRegion(Region region) throws IllegalArgumentException
AmazonSQS
AmazonSQS.setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonSQS
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.IllegalArgumentException
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public SetQueueAttributesResult setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
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 Amazon SQS system. Changes made to the
MessageRetentionPeriod
attribute can take up to 15 minutes.
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.
setQueueAttributes
in interface AmazonSQS
InvalidAttributeNameException
- The attribute referred to doesn't exist.AmazonServiceException
AmazonClientException
public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
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 actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
changeMessageVisibilityBatch
in interface AmazonSQS
TooManyEntriesInBatchRequestException
- The batch request contains more entries than permissible.EmptyBatchRequestException
- The batch request doesn't contain any entries.BatchEntryIdsNotDistinctException
- Two or more batch entries in the request have the same Id
.InvalidBatchEntryIdException
- The Id
of a batch entry in a batch request doesn't abide by the specification.AmazonServiceException
AmazonClientException
public ChangeMessageVisibilityResult changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call
ChangeMessageVisiblity
with a timeout of 10 minutes. At that time, the timeout for the message is
extended by 10 minutes beyond the time of the ChangeMessageVisibility
action. This results in a
total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility
to
extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12
hours, your request is rejected.
A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.
For standard queues, there can be a maximum of 120,000 inflight messages per 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.
For FIFO queues, there can be a maximum of 20,000 inflight messages per 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.
changeMessageVisibility
in interface AmazonSQS
MessageNotInflightException
- The message referred to isn't in flight.ReceiptHandleIsInvalidException
- The receipt handle provided isn't valid.AmazonServiceException
AmazonClientException
public SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Delivers up to ten messages to the specified queue. 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 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses the default value for
the queue.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
sendMessageBatch
in interface AmazonSQS
TooManyEntriesInBatchRequestException
- The batch request contains more entries than permissible.EmptyBatchRequestException
- The batch request doesn't contain any entries.BatchEntryIdsNotDistinctException
- Two or more batch entries in the request have the same Id
.BatchRequestTooLongException
- The length of all the messages put together is more than the limit.InvalidBatchEntryIdException
- The Id
of a batch entry in a batch request doesn't abide by the specification.UnsupportedOperationException
- Error code 400. Unsupported operation.AmazonServiceException
AmazonClientException
public SendMessageResult sendMessage(SendMessageRequest sendMessageRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
sendMessage
in interface AmazonSQS
InvalidMessageContentsException
- The message contains characters outside the allowed set.UnsupportedOperationException
- Error code 400. Unsupported operation.AmazonServiceException
AmazonClientException
public ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
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 Simple Queue Service 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 Simple Queue Service 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 Simple Queue Service 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.
receiveMessage
in interface AmazonSQS
OverLimitException
- The action that you requested would violate a limit. For example, ReceiveMessage
returns
this error if the maximum number of inflight messages is reached. AddPermission
returns this error if the maximum number of permissions for the queue is reached.AmazonServiceException
AmazonClientException
public DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
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
.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
deleteMessageBatch
in interface AmazonSQS
TooManyEntriesInBatchRequestException
- The batch request contains more entries than permissible.EmptyBatchRequestException
- The batch request doesn't contain any entries.BatchEntryIdsNotDistinctException
- Two or more batch entries in the request have the same Id
.InvalidBatchEntryIdException
- The Id
of a batch entry in a batch request doesn't abide by the specification.AmazonServiceException
AmazonClientException
public DeleteMessageResult deleteMessage(DeleteMessageRequest deleteMessageRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send 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 the message.
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. If you don't provide the
most recently received receipt handle for the message when you use the DeleteMessage
action, the
request succeeds, but the message might 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 storing 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 on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
deleteMessage
in interface AmazonSQS
InvalidIdFormatException
- The receipt handle isn't valid for the current version.ReceiptHandleIsInvalidException
- The receipt handle provided isn't valid.AmazonServiceException
AmazonClientException
public void shutdown()
AmazonSQS
public void flush()
QueueBuffer
to finish.public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest) throws AmazonServiceException, AmazonClientException
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 actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
changeMessageVisibilityBatchAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call
ChangeMessageVisiblity
with a timeout of 10 minutes. At that time, the timeout for the message is
extended by 10 minutes beyond the time of the ChangeMessageVisibility
action. This results in a
total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility
to
extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12
hours, your request is rejected.
A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.
For standard queues, there can be a maximum of 120,000 inflight messages per 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.
For FIFO queues, there can be a maximum of 20,000 inflight messages per 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 AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Delivers up to ten messages to the specified queue. 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 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses the default value for
the queue.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
sendMessageBatchAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
sendMessageAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest) throws AmazonServiceException, AmazonClientException
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 Simple Queue Service 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 Simple Queue Service 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 Simple Queue Service 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 AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest) throws AmazonServiceException, AmazonClientException
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
.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
deleteMessageBatchAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public void setEndpoint(String endpoint) throws IllegalArgumentException
AmazonSQS
Callers can pass in just the endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://sqs.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonSQS
endpoint
- The endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://sqs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.IllegalArgumentException
public Future<SetQueueAttributesResult> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest) throws AmazonServiceException, AmazonClientException
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 Amazon SQS system. Changes made to the
MessageRetentionPeriod
attribute can take up to 15 minutes.
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.
setQueueAttributesAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest) throws AmazonServiceException, AmazonClientException
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 see Shared
Queues in the Amazon Simple Queue Service Developer Guide.
getQueueUrlAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Revokes any permissions in the queue policy that matches the specified Label
parameter. Only the
owner of the queue can remove permissions.
removePermissionAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
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 see Shared
Queues in the Amazon Simple Queue Service Developer Guide.
getQueueUrl
in interface AmazonSQS
QueueDoesNotExistException
- The queue referred to doesn't exist.AmazonServiceException
AmazonClientException
public RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Revokes any permissions in the queue policy that matches the specified Label
parameter. Only the
owner of the queue can remove permissions.
removePermission
in interface AmazonSQS
AmazonServiceException
AmazonClientException
public Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you
can check whether QueueName
ends with the .fifo
suffix.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
getQueueAttributesAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you
can check whether QueueName
ends with the .fifo
suffix.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
getQueueAttributes
in interface AmazonSQS
InvalidAttributeNameException
- The attribute referred to doesn't exist.AmazonServiceException
AmazonClientException
public Future<PurgeQueueResult> purgeQueueAsync(PurgeQueueRequest purgeQueueRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Deletes the messages in a queue specified by the QueueURL
parameter.
When you use the PurgeQueue
action, you can't retrieve a message deleted from a queue.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue
before calling the PurgeQueue
action are deleted. Messages sent to the queue while it is being
purged might be deleted. While the queue is being purged, messages sent to the queue before
PurgeQueue
is called might be received, but are deleted within the next minute.
purgeQueueAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public PurgeQueueResult purgeQueue(PurgeQueueRequest purgeQueueRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Deletes the messages in a queue specified by the QueueURL
parameter.
When you use the PurgeQueue
action, you can't retrieve a message deleted from a queue.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue
before calling the PurgeQueue
action are deleted. Messages sent to the queue while it is being
purged might be deleted. While the queue is being purged, messages sent to the queue before
PurgeQueue
is called might be received, but are deleted within the next minute.
purgeQueue
in interface AmazonSQS
QueueDoesNotExistException
- The queue referred to doesn't exist.PurgeQueueInProgressException
- Indicates that the specified queue previously received a PurgeQueue
request within the last
60 seconds (the time it can take to delete the messages in the queue).AmazonServiceException
AmazonClientException
public Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Deletes the queue specified by the QueueUrl
, regardless of the queue's contents. If the specified
queue doesn't exist, Amazon SQS returns a successful response.
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.
deleteQueueAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public DeleteQueueResult deleteQueue(DeleteQueueRequest deleteQueueRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Deletes the queue specified by the QueueUrl
, regardless of the queue's contents. If the specified
queue doesn't exist, Amazon SQS returns a successful response.
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.
deleteQueue
in interface AmazonSQS
AmazonServiceException
AmazonClientException
public Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value
for the optional QueueNamePrefix
parameter, only queues with a name that begins with the specified
value are returned.
listQueuesAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value
for the optional QueueNamePrefix
parameter, only queues with a name that begins with the specified
value are returned.
listQueues
in interface AmazonSQS
AmazonServiceException
AmazonClientException
public Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats 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 Simple Queue Service 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.
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.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
createQueueAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public CreateQueueResult createQueue(CreateQueueRequest createQueueRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats 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 Simple Queue Service 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.
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.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
createQueue
in interface AmazonSQS
QueueDeletedRecentlyException
- You must wait 60 seconds after deleting a queue before you can create another one with the same name.QueueNameExistsException
- A queue already exists with this name. Amazon SQS returns this error only if the request includes
attributes whose values differ from those of the existing queue.AmazonServiceException
AmazonClientException
public Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest addPermissionRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Adds 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 Shared Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
addPermissionAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<AddPermissionResult> addPermissionAsync(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions)
AmazonSQSAsync
addPermissionAsync
in interface AmazonSQSAsync
AmazonSQSAsync.addPermissionAsync(AddPermissionRequest)
public Future<AddPermissionResult> addPermissionAsync(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions, AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
AmazonSQSAsync
addPermissionAsync
in interface AmazonSQSAsync
AmazonSQSAsync.addPermissionAsync(AddPermissionRequest, com.amazonaws.handlers.AsyncHandler)
public AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
Adds 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 Shared Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
addPermission
in interface AmazonSQS
OverLimitException
- The action that you requested would violate a limit. For example, ReceiveMessage
returns
this error if the maximum number of inflight messages is reached. AddPermission
returns this error if the maximum number of permissions for the queue is reached.AmazonServiceException
AmazonClientException
public ListQueuesResult listQueues() throws AmazonServiceException, AmazonClientException
AmazonSQS
listQueues
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.listQueues(ListQueuesRequest)
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonSQS
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonSQS
request
- The originally executed request.public Future<DeleteMessageResult> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send 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 the message.
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. If you don't provide the
most recently received receipt handle for the message when you use the DeleteMessage
action, the
request succeeds, but the message might 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 storing 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 on 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 AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest, AsyncHandler<ChangeMessageVisibilityRequest,ChangeMessageVisibilityResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call
ChangeMessageVisiblity
with a timeout of 10 minutes. At that time, the timeout for the message is
extended by 10 minutes beyond the time of the ChangeMessageVisibility
action. This results in a
total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility
to
extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12
hours, your request is rejected.
A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.
For standard queues, there can be a maximum of 120,000 inflight messages per 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.
For FIFO queues, there can be a maximum of 20,000 inflight messages per 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 AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(String queueUrl, String receiptHandle, Integer visibilityTimeout)
AmazonSQSAsync
changeMessageVisibilityAsync
in interface AmazonSQSAsync
AmazonSQSAsync.changeMessageVisibilityAsync(ChangeMessageVisibilityRequest)
public Future<ChangeMessageVisibilityResult> changeMessageVisibilityAsync(String queueUrl, String receiptHandle, Integer visibilityTimeout, AsyncHandler<ChangeMessageVisibilityRequest,ChangeMessageVisibilityResult> asyncHandler)
AmazonSQSAsync
changeMessageVisibilityAsync
in interface AmazonSQSAsync
AmazonSQSAsync.changeMessageVisibilityAsync(ChangeMessageVisibilityRequest, com.amazonaws.handlers.AsyncHandler)
public Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
sendMessageAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<SendMessageResult> sendMessageAsync(String queueUrl, String messageBody)
AmazonSQSAsync
sendMessageAsync
in interface AmazonSQSAsync
AmazonSQSAsync.sendMessageAsync(SendMessageRequest)
public Future<SendMessageResult> sendMessageAsync(String queueUrl, String messageBody, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
AmazonSQSAsync
sendMessageAsync
in interface AmazonSQSAsync
AmazonSQSAsync.sendMessageAsync(SendMessageRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest, AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 Simple Queue Service 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 Simple Queue Service 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 Simple Queue Service 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 AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<ReceiveMessageResult> receiveMessageAsync(String queueUrl)
AmazonSQSAsync
receiveMessageAsync
in interface AmazonSQSAsync
AmazonSQSAsync.receiveMessageAsync(ReceiveMessageRequest)
public Future<ReceiveMessageResult> receiveMessageAsync(String queueUrl, AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
AmazonSQSAsync
receiveMessageAsync
in interface AmazonSQSAsync
AmazonSQSAsync.receiveMessageAsync(ReceiveMessageRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DeleteMessageResult> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest, AsyncHandler<DeleteMessageRequest,DeleteMessageResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send 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 the message.
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. If you don't provide the
most recently received receipt handle for the message when you use the DeleteMessage
action, the
request succeeds, but the message might 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 storing 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 on 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 AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<DeleteMessageResult> deleteMessageAsync(String queueUrl, String receiptHandle)
AmazonSQSAsync
deleteMessageAsync
in interface AmazonSQSAsync
AmazonSQSAsync.deleteMessageAsync(DeleteMessageRequest)
public Future<DeleteMessageResult> deleteMessageAsync(String queueUrl, String receiptHandle, AsyncHandler<DeleteMessageRequest,DeleteMessageResult> asyncHandler)
AmazonSQSAsync
deleteMessageAsync
in interface AmazonSQSAsync
AmazonSQSAsync.deleteMessageAsync(DeleteMessageRequest, com.amazonaws.handlers.AsyncHandler)
public Future<SetQueueAttributesResult> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest, AsyncHandler<SetQueueAttributesRequest,SetQueueAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 Amazon SQS system. Changes made to the
MessageRetentionPeriod
attribute can take up to 15 minutes.
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.
setQueueAttributesAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<SetQueueAttributesResult> setQueueAttributesAsync(String queueUrl, Map<String,String> attributes) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
setQueueAttributesAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
AmazonSQSAsync.setQueueAttributesAsync(SetQueueAttributesRequest)
public Future<SetQueueAttributesResult> setQueueAttributesAsync(String queueUrl, Map<String,String> attributes, AsyncHandler<SetQueueAttributesRequest,SetQueueAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
setQueueAttributesAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
AmazonSQSAsync.setQueueAttributesAsync(SetQueueAttributesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest, AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
changeMessageVisibilityBatchAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries)
AmazonSQSAsync
changeMessageVisibilityBatchAsync
in interface AmazonSQSAsync
AmazonSQSAsync.changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest)
public Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries, AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
AmazonSQSAsync
public Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest, AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 see Shared
Queues in the Amazon Simple Queue Service Developer Guide.
getQueueUrlAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<GetQueueUrlResult> getQueueUrlAsync(String queueName)
AmazonSQSAsync
getQueueUrlAsync
in interface AmazonSQSAsync
AmazonSQSAsync.getQueueUrlAsync(GetQueueUrlRequest)
public Future<GetQueueUrlResult> getQueueUrlAsync(String queueName, AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
AmazonSQSAsync
getQueueUrlAsync
in interface AmazonSQSAsync
AmazonSQSAsync.getQueueUrlAsync(GetQueueUrlRequest, com.amazonaws.handlers.AsyncHandler)
public Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Revokes any permissions in the queue policy that matches the specified Label
parameter. Only the
owner of the queue can remove permissions.
removePermissionAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<RemovePermissionResult> removePermissionAsync(String queueUrl, String label)
AmazonSQSAsync
removePermissionAsync
in interface AmazonSQSAsync
AmazonSQSAsync.removePermissionAsync(RemovePermissionRequest)
public Future<RemovePermissionResult> removePermissionAsync(String queueUrl, String label, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
AmazonSQSAsync
removePermissionAsync
in interface AmazonSQSAsync
AmazonSQSAsync.removePermissionAsync(RemovePermissionRequest, com.amazonaws.handlers.AsyncHandler)
public Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest, AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you
can check whether QueueName
ends with the .fifo
suffix.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
getQueueAttributesAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<GetQueueAttributesResult> getQueueAttributesAsync(String queueUrl, List<String> attributeNames)
AmazonSQSAsync
getQueueAttributesAsync
in interface AmazonSQSAsync
AmazonSQSAsync.getQueueAttributesAsync(GetQueueAttributesRequest)
public Future<GetQueueAttributesResult> getQueueAttributesAsync(String queueUrl, List<String> attributeNames, AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
AmazonSQSAsync
getQueueAttributesAsync
in interface AmazonSQSAsync
AmazonSQSAsync.getQueueAttributesAsync(GetQueueAttributesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest, AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Delivers up to ten messages to the specified queue. 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 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9
| #xA
| #xD
| #x20
to #xD7FF
|
#xE000
to #xFFFD
| #x10000
to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses the default value for
the queue.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
sendMessageBatchAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<SendMessageBatchResult> sendMessageBatchAsync(String queueUrl, List<SendMessageBatchRequestEntry> entries)
AmazonSQSAsync
sendMessageBatchAsync
in interface AmazonSQSAsync
AmazonSQSAsync.sendMessageBatchAsync(SendMessageBatchRequest)
public Future<SendMessageBatchResult> sendMessageBatchAsync(String queueUrl, List<SendMessageBatchRequestEntry> entries, AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
AmazonSQSAsync
sendMessageBatchAsync
in interface AmazonSQSAsync
AmazonSQSAsync.sendMessageBatchAsync(SendMessageBatchRequest, com.amazonaws.handlers.AsyncHandler)
public Future<PurgeQueueResult> purgeQueueAsync(PurgeQueueRequest purgeQueueRequest, AsyncHandler<PurgeQueueRequest,PurgeQueueResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Deletes the messages in a queue specified by the QueueURL
parameter.
When you use the PurgeQueue
action, you can't retrieve a message deleted from a queue.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue
before calling the PurgeQueue
action are deleted. Messages sent to the queue while it is being
purged might be deleted. While the queue is being purged, messages sent to the queue before
PurgeQueue
is called might be received, but are deleted within the next minute.
purgeQueueAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<DeleteQueueResult> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest, AsyncHandler<DeleteQueueRequest,DeleteQueueResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Deletes the queue specified by the QueueUrl
, regardless of the queue's contents. If the specified
queue doesn't exist, Amazon SQS returns a successful response.
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.
deleteQueueAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<DeleteQueueResult> deleteQueueAsync(String queueUrl)
AmazonSQSAsync
deleteQueueAsync
in interface AmazonSQSAsync
AmazonSQSAsync.deleteQueueAsync(DeleteQueueRequest)
public Future<DeleteQueueResult> deleteQueueAsync(String queueUrl, AsyncHandler<DeleteQueueRequest,DeleteQueueResult> asyncHandler)
AmazonSQSAsync
deleteQueueAsync
in interface AmazonSQSAsync
AmazonSQSAsync.deleteQueueAsync(DeleteQueueRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest, AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value
for the optional QueueNamePrefix
parameter, only queues with a name that begins with the specified
value are returned.
listQueuesAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<ListQueuesResult> listQueuesAsync()
AmazonSQSAsync
listQueuesAsync
in interface AmazonSQSAsync
AmazonSQSAsync.listQueuesAsync(ListQueuesRequest)
public Future<ListQueuesResult> listQueuesAsync(AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
AmazonSQSAsync
listQueuesAsync
in interface AmazonSQSAsync
AmazonSQSAsync.listQueuesAsync(ListQueuesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListQueuesResult> listQueuesAsync(String queueNamePrefix)
AmazonSQSAsync
listQueuesAsync
in interface AmazonSQSAsync
AmazonSQSAsync.listQueuesAsync(ListQueuesRequest)
public Future<ListQueuesResult> listQueuesAsync(String queueNamePrefix, AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
AmazonSQSAsync
listQueuesAsync
in interface AmazonSQSAsync
AmazonSQSAsync.listQueuesAsync(ListQueuesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest, AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
deleteMessageBatchAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(String queueUrl, List<DeleteMessageBatchRequestEntry> entries)
AmazonSQSAsync
deleteMessageBatchAsync
in interface AmazonSQSAsync
AmazonSQSAsync.deleteMessageBatchAsync(DeleteMessageBatchRequest)
public Future<DeleteMessageBatchResult> deleteMessageBatchAsync(String queueUrl, List<DeleteMessageBatchRequestEntry> entries, AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
AmazonSQSAsync
deleteMessageBatchAsync
in interface AmazonSQSAsync
AmazonSQSAsync.deleteMessageBatchAsync(DeleteMessageBatchRequest, com.amazonaws.handlers.AsyncHandler)
public Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest, AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats 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 Simple Queue Service 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.
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.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
createQueueAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public Future<CreateQueueResult> createQueueAsync(String queueName)
AmazonSQSAsync
createQueueAsync
in interface AmazonSQSAsync
AmazonSQSAsync.createQueueAsync(CreateQueueRequest)
public Future<CreateQueueResult> createQueueAsync(String queueName, AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
AmazonSQSAsync
createQueueAsync
in interface AmazonSQSAsync
AmazonSQSAsync.createQueueAsync(CreateQueueRequest, com.amazonaws.handlers.AsyncHandler)
public Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
AmazonSQSAsync
Adds 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 Shared Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&Attribute.1=this
&Attribute.2=that
addPermissionAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public ListDeadLetterSourceQueuesResult listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest) throws AmazonServiceException, AmazonClientException
AmazonSQS
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 in the Amazon Simple Queue Service Developer Guide.
listDeadLetterSourceQueues
in interface AmazonSQS
QueueDoesNotExistException
- The queue referred to doesn't exist.AmazonServiceException
AmazonClientException
public Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest) throws AmazonServiceException, AmazonClientException
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 in the Amazon Simple Queue Service Developer Guide.
listDeadLetterSourceQueuesAsync
in interface AmazonSQSAsync
AmazonServiceException
AmazonClientException
public Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest, AsyncHandler<ListDeadLetterSourceQueuesRequest,ListDeadLetterSourceQueuesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 in the Amazon Simple Queue Service Developer Guide.
listDeadLetterSourceQueuesAsync
in interface AmazonSQSAsync
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.AmazonServiceException
AmazonClientException
public SetQueueAttributesResult setQueueAttributes(String queueUrl, Map<String,String> attributes) throws AmazonServiceException, AmazonClientException
AmazonSQS
setQueueAttributes
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.setQueueAttributes(SetQueueAttributesRequest)
public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries) throws AmazonServiceException, AmazonClientException
AmazonSQS
changeMessageVisibilityBatch
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest)
public ChangeMessageVisibilityResult changeMessageVisibility(String queueUrl, String receiptHandle, Integer visibilityTimeout) throws AmazonServiceException, AmazonClientException
AmazonSQS
changeMessageVisibility
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.changeMessageVisibility(ChangeMessageVisibilityRequest)
public GetQueueUrlResult getQueueUrl(String queueName) throws AmazonServiceException, AmazonClientException
AmazonSQS
getQueueUrl
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.getQueueUrl(GetQueueUrlRequest)
public RemovePermissionResult removePermission(String queueUrl, String label) throws AmazonServiceException, AmazonClientException
AmazonSQS
removePermission
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.removePermission(RemovePermissionRequest)
public SendMessageBatchResult sendMessageBatch(String queueUrl, List<SendMessageBatchRequestEntry> entries) throws AmazonServiceException, AmazonClientException
AmazonSQS
sendMessageBatch
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.sendMessageBatch(SendMessageBatchRequest)
public DeleteQueueResult deleteQueue(String queueUrl) throws AmazonServiceException, AmazonClientException
AmazonSQS
deleteQueue
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.deleteQueue(DeleteQueueRequest)
public SendMessageResult sendMessage(String queueUrl, String messageBody) throws AmazonServiceException, AmazonClientException
AmazonSQS
sendMessage
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.sendMessage(SendMessageRequest)
public ReceiveMessageResult receiveMessage(String queueUrl) throws AmazonServiceException, AmazonClientException
AmazonSQS
receiveMessage
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.receiveMessage(ReceiveMessageRequest)
public ListQueuesResult listQueues(String queueNamePrefix) throws AmazonServiceException, AmazonClientException
AmazonSQS
listQueues
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.listQueues(ListQueuesRequest)
public DeleteMessageBatchResult deleteMessageBatch(String queueUrl, List<DeleteMessageBatchRequestEntry> entries) throws AmazonServiceException, AmazonClientException
AmazonSQS
deleteMessageBatch
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.deleteMessageBatch(DeleteMessageBatchRequest)
public CreateQueueResult createQueue(String queueName) throws AmazonServiceException, AmazonClientException
AmazonSQS
createQueue
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.createQueue(CreateQueueRequest)
public AddPermissionResult addPermission(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions) throws AmazonServiceException, AmazonClientException
AmazonSQS
addPermission
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.addPermission(AddPermissionRequest)
public DeleteMessageResult deleteMessage(String queueUrl, String receiptHandle) throws AmazonServiceException, AmazonClientException
AmazonSQS
deleteMessage
in interface AmazonSQS
AmazonServiceException
AmazonClientException
AmazonSQS.deleteMessage(DeleteMessageRequest)
public GetQueueAttributesResult getQueueAttributes(String queueUrl, List<String> attributeNames)
AmazonSQS
getQueueAttributes
in interface AmazonSQS
AmazonSQS.getQueueAttributes(GetQueueAttributesRequest)
public TagQueueResult tagQueue(TagQueueRequest tagQueueRequest)
AmazonSQS
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
tagQueue
in interface AmazonSQS
public TagQueueResult tagQueue(String queueUrl, Map<String,String> tags)
AmazonSQS
tagQueue
in interface AmazonSQS
AmazonSQS.tagQueue(TagQueueRequest)
public Future<TagQueueResult> tagQueueAsync(TagQueueRequest tagQueueRequest)
AmazonSQSAsync
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
tagQueueAsync
in interface AmazonSQSAsync
public Future<TagQueueResult> tagQueueAsync(TagQueueRequest tagQueueRequest, AsyncHandler<TagQueueRequest,TagQueueResult> asyncHandler)
AmazonSQSAsync
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
tagQueueAsync
in interface AmazonSQSAsync
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.public Future<TagQueueResult> tagQueueAsync(String queueUrl, Map<String,String> tags)
AmazonSQSAsync
tagQueueAsync
in interface AmazonSQSAsync
AmazonSQSAsync.tagQueueAsync(TagQueueRequest)
public Future<TagQueueResult> tagQueueAsync(String queueUrl, Map<String,String> tags, AsyncHandler<TagQueueRequest,TagQueueResult> asyncHandler)
AmazonSQSAsync
tagQueueAsync
in interface AmazonSQSAsync
AmazonSQSAsync.tagQueueAsync(TagQueueRequest, com.amazonaws.handlers.AsyncHandler)
public UntagQueueResult untagQueue(UntagQueueRequest untagQueueRequest)
AmazonSQS
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
untagQueue
in interface AmazonSQS
public UntagQueueResult untagQueue(String queueUrl, List<String> tagKeys)
AmazonSQS
untagQueue
in interface AmazonSQS
AmazonSQS.untagQueue(UntagQueueRequest)
public Future<UntagQueueResult> untagQueueAsync(UntagQueueRequest untagQueueRequest)
AmazonSQSAsync
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
untagQueueAsync
in interface AmazonSQSAsync
public Future<UntagQueueResult> untagQueueAsync(UntagQueueRequest untagQueueRequest, AsyncHandler<UntagQueueRequest,UntagQueueResult> asyncHandler)
AmazonSQSAsync
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
untagQueueAsync
in interface AmazonSQSAsync
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.public Future<UntagQueueResult> untagQueueAsync(String queueUrl, List<String> tagKeys)
AmazonSQSAsync
untagQueueAsync
in interface AmazonSQSAsync
AmazonSQSAsync.untagQueueAsync(UntagQueueRequest)
public Future<UntagQueueResult> untagQueueAsync(String queueUrl, List<String> tagKeys, AsyncHandler<UntagQueueRequest,UntagQueueResult> asyncHandler)
AmazonSQSAsync
untagQueueAsync
in interface AmazonSQSAsync
AmazonSQSAsync.untagQueueAsync(UntagQueueRequest, com.amazonaws.handlers.AsyncHandler)
public ListQueueTagsResult listQueueTags(ListQueueTagsRequest listQueueTagsRequest)
AmazonSQS
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
listQueueTags
in interface AmazonSQS
public ListQueueTagsResult listQueueTags(String queueUrl)
AmazonSQS
listQueueTags
in interface AmazonSQS
AmazonSQS.listQueueTags(ListQueueTagsRequest)
public Future<ListQueueTagsResult> listQueueTagsAsync(ListQueueTagsRequest listQueueTagsRequest)
AmazonSQSAsync
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
listQueueTagsAsync
in interface AmazonSQSAsync
public Future<ListQueueTagsResult> listQueueTagsAsync(ListQueueTagsRequest listQueueTagsRequest, AsyncHandler<ListQueueTagsRequest,ListQueueTagsResult> asyncHandler)
AmazonSQSAsync
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service 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.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
listQueueTagsAsync
in interface AmazonSQSAsync
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.public Future<ListQueueTagsResult> listQueueTagsAsync(String queueUrl)
AmazonSQSAsync
listQueueTagsAsync
in interface AmazonSQSAsync
AmazonSQSAsync.listQueueTagsAsync(ListQueueTagsRequest)
public Future<ListQueueTagsResult> listQueueTagsAsync(String queueUrl, AsyncHandler<ListQueueTagsRequest,ListQueueTagsResult> asyncHandler)
AmazonSQSAsync
listQueueTagsAsync
in interface AmazonSQSAsync
AmazonSQSAsync.listQueueTagsAsync(ListQueueTagsRequest, com.amazonaws.handlers.AsyncHandler)
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.