AmazonSQSBufferedAsyncClient (AWS SDK for Android

Overview

Package

Class

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.sqs.buffered
Class AmazonSQSBufferedAsyncClient

java.lang.Object
  com.amazonaws.services.sqs.buffered.AmazonSQSBufferedAsyncClient

All Implemented Interfaces:: AmazonSQS, AmazonSQSAsync

public class AmazonSQSBufferedAsyncClient
extends java.lang.Object
implements AmazonSQSAsync
extends java.lang.Object
implements AmazonSQSAsync

AmazonSQSBufferedAsyncClient provides client-side batching of outgoing sendMessage, deleteMessage and changeMessageVisibility calls.
After receiving a call, rather than executing it right away, this client waits for a configurable period of time ( default=200ms) for other calls of the same type to come in; if such calls do come in, they are also not executed immediately, but instead are added to the batch. When the batch becomes full or the timeout period expires, the entire batch is executed at once and the results are returned to the callers. This method of operation leads to reduced operating costs (since SQS charges per call and fewer calls are made) and increased overall throughput (since more work is performed per call, and all fixed costs of making a call are amortized over a greater amount of work). The cost of this method is increased latency for individual calls, since calls spend some time waiting on the client side for the potential batch-mates to appear before they are actually executed.
This client also performs pre-fetching of messages from SQS. After the first receiveMessage call is made, the client attempts not only to satisfy that call, but also pre-fetch extra messages to store in a temporary buffer. Future receiveMessage calls will be satisfied from the buffer, and only if the buffer is empty will the calling thread have to wait for the messages to be fetched. The size of the buffer and the maximum number of threads used for prefetching are configurable.
AmazonSQSBufferedAsyncClient is thread-safe.

Field Summary
`static java.lang.String`	`USER_AGENT`

Constructor Summary
`AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS)`
`AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS, QueueBufferConfig config)`

Method Summary
`void`	`addPermission(AddPermissionRequest addPermissionRequest)` Adds a permission to a queue for a specific principal .
`void`	`addPermission(java.lang.String queueUrl, java.lang.String label, java.util.List<java.lang.String> aWSAccountIds, java.util.List<java.lang.String> actions)` Adds a permission to a queue for a specific principal .
`java.util.concurrent.Future<java.lang.Void>`	`addPermissionAsync(AddPermissionRequest addPermissionRequest)` Adds a permission to a queue for a specific principal .
`java.util.concurrent.Future<java.lang.Void>`	`addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler<AddPermissionRequest,java.lang.Void> asyncHandler)` Adds a permission to a queue for a specific principal .
`void`	`changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)` Changes the visibility timeout of a specified message in a queue to a new value.
`void`	`changeMessageVisibility(java.lang.String queueUrl, java.lang.String receiptHandle, java.lang.Integer visibilityTimeout)` Changes the visibility timeout of a specified message in a queue to a new value.
`java.util.concurrent.Future<java.lang.Void>`	`changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)` Changes the visibility timeout of a specified message in a queue to a new value.
`java.util.concurrent.Future<java.lang.Void>`	`changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest, AsyncHandler<ChangeMessageVisibilityRequest,java.lang.Void> asyncHandler)` Changes the visibility timeout of a specified message in a queue to a new value.
`ChangeMessageVisibilityBatchResult`	`changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)` Changes the visibility timeout of multiple messages.
`ChangeMessageVisibilityBatchResult`	`changeMessageVisibilityBatch(java.lang.String queueUrl, java.util.List<ChangeMessageVisibilityBatchRequestEntry> entries)` Changes the visibility timeout of multiple messages.
`java.util.concurrent.Future<ChangeMessageVisibilityBatchResult>`	`changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)` Changes the visibility timeout of multiple messages.
`java.util.concurrent.Future<ChangeMessageVisibilityBatchResult>`	`changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest, AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)` Changes the visibility timeout of multiple messages.
`CreateQueueResult`	`createQueue(CreateQueueRequest createQueueRequest)` Creates a new queue, or returns the URL of an existing one.
`CreateQueueResult`	`createQueue(java.lang.String queueName)` Creates a new queue, or returns the URL of an existing one.
`java.util.concurrent.Future<CreateQueueResult>`	`createQueueAsync(CreateQueueRequest createQueueRequest)` Creates a new queue, or returns the URL of an existing one.
`java.util.concurrent.Future<CreateQueueResult>`	`createQueueAsync(CreateQueueRequest createQueueRequest, AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)` Creates a new queue, or returns the URL of an existing one.
`void`	`deleteMessage(DeleteMessageRequest deleteMessageRequest)` Deletes the specified message from the specified queue.
`void`	`deleteMessage(java.lang.String queueUrl, java.lang.String receiptHandle)` Deletes the specified message from the specified queue.
`java.util.concurrent.Future<java.lang.Void>`	`deleteMessageAsync(DeleteMessageRequest deleteMessageRequest)` Deletes the specified message from the specified queue.
`java.util.concurrent.Future<java.lang.Void>`	`deleteMessageAsync(DeleteMessageRequest deleteMessageRequest, AsyncHandler<DeleteMessageRequest,java.lang.Void> asyncHandler)` Deletes the specified message from the specified queue.
`DeleteMessageBatchResult`	`deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)` Deletes multiple messages.
`DeleteMessageBatchResult`	`deleteMessageBatch(java.lang.String queueUrl, java.util.List<DeleteMessageBatchRequestEntry> entries)` Deletes multiple messages.
`java.util.concurrent.Future<DeleteMessageBatchResult>`	`deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest)` Deletes multiple messages.
`java.util.concurrent.Future<DeleteMessageBatchResult>`	`deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest, AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)` Deletes multiple messages.
`void`	`deleteQueue(DeleteQueueRequest deleteQueueRequest)` Deletes the queue specified by the queue URL , regardless of whether the queue is empty.
`void`	`deleteQueue(java.lang.String queueUrl)` Deletes the queue specified by the queue URL , regardless of whether the queue is empty.
`java.util.concurrent.Future<java.lang.Void>`	`deleteQueueAsync(DeleteQueueRequest deleteQueueRequest)` Deletes the queue specified by the queue URL , regardless of whether the queue is empty.
`java.util.concurrent.Future<java.lang.Void>`	`deleteQueueAsync(DeleteQueueRequest deleteQueueRequest, AsyncHandler<DeleteQueueRequest,java.lang.Void> asyncHandler)` Deletes the queue specified by the queue URL , regardless of whether the queue is empty.
`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(java.lang.String queueUrl, java.util.List<java.lang.String> attributeNames)` Gets attributes for the specified queue.
`java.util.concurrent.Future<GetQueueAttributesResult>`	`getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest)` Gets attributes for the specified queue.
`java.util.concurrent.Future<GetQueueAttributesResult>`	`getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest, AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)` Gets attributes for the specified queue.
`GetQueueUrlResult`	`getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)` Returns the URL of an existing queue.
`GetQueueUrlResult`	`getQueueUrl(java.lang.String queueName)` Returns the URL of an existing queue.
`java.util.concurrent.Future<GetQueueUrlResult>`	`getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest)` Returns the URL of an existing queue.
`java.util.concurrent.Future<GetQueueUrlResult>`	`getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest, AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)` Returns the URL of an existing queue.
`ListDeadLetterSourceQueuesResult`	`listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)` Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
`java.util.concurrent.Future<ListDeadLetterSourceQueuesResult>`	`listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)` Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.
`java.util.concurrent.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()` Returns a list of your queues.
`ListQueuesResult`	`listQueues(ListQueuesRequest listQueuesRequest)` Returns a list of your queues.
`ListQueuesResult`	`listQueues(java.lang.String queueNamePrefix)` Returns a list of your queues.
`java.util.concurrent.Future<ListQueuesResult>`	`listQueuesAsync(ListQueuesRequest listQueuesRequest)` Returns a list of your queues.
`java.util.concurrent.Future<ListQueuesResult>`	`listQueuesAsync(ListQueuesRequest listQueuesRequest, AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)` Returns a list of your queues.
`ReceiveMessageResult`	`receiveMessage(ReceiveMessageRequest receiveMessageRequest)` Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue.
`ReceiveMessageResult`	`receiveMessage(java.lang.String queueUrl)` Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue.
`java.util.concurrent.Future<ReceiveMessageResult>`	`receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest)` Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue.
`java.util.concurrent.Future<ReceiveMessageResult>`	`receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest, AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)` Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue.
`void`	`removePermission(RemovePermissionRequest removePermissionRequest)` Revokes any permissions in the queue policy that matches the specified `Label` parameter.
`void`	`removePermission(java.lang.String queueUrl, java.lang.String label)` Revokes any permissions in the queue policy that matches the specified `Label` parameter.
`java.util.concurrent.Future<java.lang.Void>`	`removePermissionAsync(RemovePermissionRequest removePermissionRequest)` Revokes any permissions in the queue policy that matches the specified `Label` parameter.
`java.util.concurrent.Future<java.lang.Void>`	`removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,java.lang.Void> asyncHandler)` Revokes any permissions in the queue policy that matches the specified `Label` parameter.
`SendMessageResult`	`sendMessage(SendMessageRequest sendMessageRequest)` Delivers a message to the specified queue.
`SendMessageResult`	`sendMessage(java.lang.String queueUrl, java.lang.String messageBody)` Delivers a message to the specified queue.
`java.util.concurrent.Future<SendMessageResult>`	`sendMessageAsync(SendMessageRequest sendMessageRequest)` Delivers a message to the specified queue.
`java.util.concurrent.Future<SendMessageResult>`	`sendMessageAsync(SendMessageRequest sendMessageRequest, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)` Delivers a message to the specified queue.
`SendMessageBatchResult`	`sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)` Delivers up to ten messages to the specified queue.
`SendMessageBatchResult`	`sendMessageBatch(java.lang.String queueUrl, java.util.List<SendMessageBatchRequestEntry> entries)` Delivers up to ten messages to the specified queue.
`java.util.concurrent.Future<SendMessageBatchResult>`	`sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest)` Delivers up to ten messages to the specified queue.
`java.util.concurrent.Future<SendMessageBatchResult>`	`sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest, AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)` Delivers up to ten messages to the specified queue.
`void`	`setEndpoint(java.lang.String endpoint)` Overrides the default endpoint for this client ("sqs.us-east-1.amazonaws.com").
`void`	`setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)` Sets the value of one or more queue attributes.
`void`	`setQueueAttributes(java.lang.String queueUrl, java.util.Map<java.lang.String,java.lang.String> attributes)` Sets the value of one or more queue attributes.
`java.util.concurrent.Future<java.lang.Void>`	`setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest)` Sets the value of one or more queue attributes.
`java.util.concurrent.Future<java.lang.Void>`	`setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest, AsyncHandler<SetQueueAttributesRequest,java.lang.Void> asyncHandler)` Sets the value of one or more queue attributes.
`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.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

USER_AGENT

public static final java.lang.String USER_AGENT

Constructor Detail

AmazonSQSBufferedAsyncClient

public AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS)

AmazonSQSBufferedAsyncClient

public AmazonSQSBufferedAsyncClient(AmazonSQSAsync paramRealSQS,
                                    QueueBufferConfig config)

Method Detail

setRegion

public void setRegion(Region region)
               throws java.lang.IllegalArgumentException

Description copied from interface: AmazonSQS

An alternative to 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.

Specified by:: setRegion in interface AmazonSQS

Parameters:: region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.
Throws:: java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)
See Also:: Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

setQueueAttributes

public void setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Description copied from interface: 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 SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

NOTE:Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Specified by:: setQueueAttributes in interface AmazonSQS

Parameters:: setQueueAttributesRequest - Container for the necessary parameters to execute the SetQueueAttributes service method on AmazonSQS.
Throws:: InvalidAttributeNameException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

changeMessageVisibilityBatch

public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Description copied from interface: 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.

IMPORTANT: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.

NOTE:Some API 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

Specified by:: changeMessageVisibilityBatch in interface AmazonSQS

Parameters:: changeMessageVisibilityBatchRequest - Container for the necessary parameters to execute the ChangeMessageVisibilityBatch service method on AmazonSQS.
Returns:: The response from the ChangeMessageVisibilityBatch service method, as returned by AmazonSQS.
Throws:: BatchEntryIdsNotDistinctException; TooManyEntriesInBatchRequestException; InvalidBatchEntryIdException; EmptyBatchRequestException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

changeMessageVisibility

public void changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Description copied from interface: AmazonSQS

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .)

For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes.

NOTE: There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.

IMPORTANT:If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.

IMPORTANT:Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.

Specified by:: changeMessageVisibility in interface AmazonSQS

Parameters:: changeMessageVisibilityRequest - Container for the necessary parameters to execute the ChangeMessageVisibility service method on AmazonSQS.
Throws:: ReceiptHandleIsInvalidException; MessageNotInflightException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

sendMessageBatch

public SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Description copied from interface: AmazonSQS

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes).

The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).

If the DelaySeconds parameter is not specified for an entry, the default for the queue is used.

IMPORTANT:The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http://www.faqs.org/rfcs/rfc1321.html. If you send any characters that are not included in the list, your request will be rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]

IMPORTANT: 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.

&Attribute.1=this

&Attribute.2=that

Specified by:: sendMessageBatch in interface AmazonSQS

Parameters:: sendMessageBatchRequest - Container for the necessary parameters to execute the SendMessageBatch service method on AmazonSQS.
Returns:: The response from the SendMessageBatch service method, as returned by AmazonSQS.
Throws:: BatchEntryIdsNotDistinctException; TooManyEntriesInBatchRequestException; BatchRequestTooLongException; UnsupportedOperationException; InvalidBatchEntryIdException; EmptyBatchRequestException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

sendMessage

public SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Description copied from interface: AmazonSQS

Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.

IMPORTANT: The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets If you send any characters not included in the list, your request will be rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]

Specified by:: sendMessage in interface AmazonSQS

Parameters:: sendMessageRequest - Container for the necessary parameters to execute the SendMessage service method on AmazonSQS.
Returns:: The response from the SendMessage service method, as returned by AmazonSQS.
Throws:: InvalidMessageContentsException; UnsupportedOperationException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

receiveMessage

public ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Description copied from interface: AmazonSQS

Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the WaitTimeSeconds parameter. For more information, see Amazon SQS Long Poll in the Amazon SQS Developer Guide .

Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested 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; in which case you should repeat the request.

For each message returned, the response includes the following:

Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html .
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .

You can provide the VisibilityTimeout parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide .

NOTE: Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Specified by:: receiveMessage in interface AmazonSQS

Parameters:: receiveMessageRequest - Container for the necessary parameters to execute the ReceiveMessage service method on AmazonSQS.
Returns:: The response from the ReceiveMessage service method, as returned by AmazonSQS.
Throws:: OverLimitException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteMessageBatch

public DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Description copied from interface: AmazonSQS

Deletes multiple messages. This is a batch version of DeleteMessage. The result of the delete action on each message is reported individually in the response.

IMPORTANT: 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.

&Attribute.1=this

&Attribute.2=that

Specified by:: deleteMessageBatch in interface AmazonSQS

Parameters:: deleteMessageBatchRequest - Container for the necessary parameters to execute the DeleteMessageBatch service method on AmazonSQS.
Returns:: The response from the DeleteMessageBatch service method, as returned by AmazonSQS.
Throws:: BatchEntryIdsNotDistinctException; TooManyEntriesInBatchRequestException; InvalidBatchEntryIdException; EmptyBatchRequestException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteMessage

public void deleteMessage(DeleteMessageRequest deleteMessageRequest)
                   throws AmazonServiceException,
                          AmazonClientException

Description copied from interface: AmazonSQS

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the message ID you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it.

NOTE: The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request DeleteMessage, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted.

IMPORTANT: It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.

Specified by:: deleteMessage in interface AmazonSQS

Parameters:: deleteMessageRequest - Container for the necessary parameters to execute the DeleteMessage service method on AmazonSQS.
Throws:: ReceiptHandleIsInvalidException; InvalidIdFormatException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

shutdown

public void shutdown()

Description copied from interface: AmazonSQS

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:: shutdown in interface AmazonSQS

changeMessageVisibilityBatchAsync

public java.util.concurrent.Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                                                  throws AmazonServiceException,
                                                                                                         AmazonClientException

Description copied from interface: AmazonSQSAsync

IMPORTANT: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.

&Attribute.1=this

&Attribute.2=that

Specified by:: changeMessageVisibilityBatchAsync in interface AmazonSQSAsync

Parameters:: changeMessageVisibilityBatchRequest - Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation on AmazonSQS.
Returns:: A Java Future object containing the response from the ChangeMessageVisibilityBatch service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

changeMessageVisibilityAsync

public java.util.concurrent.Future<java.lang.Void> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                                                                         throws AmazonServiceException,
                                                                                AmazonClientException

Description copied from interface: AmazonSQSAsync

Specified by:: changeMessageVisibilityAsync in interface AmazonSQSAsync

Parameters:: changeMessageVisibilityRequest - Container for the necessary parameters to execute the ChangeMessageVisibility operation on AmazonSQS.
Returns:: A Java Future object containing the response from the ChangeMessageVisibility service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

sendMessageBatchAsync

public java.util.concurrent.Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

Description copied from interface: AmazonSQSAsync

The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).

If the DelaySeconds parameter is not specified for an entry, the default for the queue is used.

IMPORTANT: 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.

&Attribute.1=this

&Attribute.2=that

Specified by:: sendMessageBatchAsync in interface AmazonSQSAsync

Parameters:: sendMessageBatchRequest - Container for the necessary parameters to execute the SendMessageBatch operation on AmazonSQS.
Returns:: A Java Future object containing the response from the SendMessageBatch service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

sendMessageAsync

public java.util.concurrent.Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Description copied from interface: AmazonSQSAsync

Specified by:: sendMessageAsync in interface AmazonSQSAsync

Parameters:: sendMessageRequest - Container for the necessary parameters to execute the SendMessage operation on AmazonSQS.
Returns:: A Java Future object containing the response from the SendMessage service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

receiveMessageAsync

public java.util.concurrent.Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest)
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

Description copied from interface: AmazonSQSAsync

For each message returned, the response includes the following:

Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html .
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .

NOTE: Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Specified by:: receiveMessageAsync in interface AmazonSQSAsync

Parameters:: receiveMessageRequest - Container for the necessary parameters to execute the ReceiveMessage operation on AmazonSQS.
Returns:: A Java Future object containing the response from the ReceiveMessage service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteMessageBatchAsync

public java.util.concurrent.Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Description copied from interface: AmazonSQSAsync

Deletes multiple messages. This is a batch version of DeleteMessage. The result of the delete action on each message is reported individually in the response.

IMPORTANT: 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.

&Attribute.1=this

&Attribute.2=that

Specified by:: deleteMessageBatchAsync in interface AmazonSQSAsync

Parameters:: deleteMessageBatchRequest - Container for the necessary parameters to execute the DeleteMessageBatch operation on AmazonSQS.
Returns:: A Java Future object containing the response from the DeleteMessageBatch service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

setEndpoint

public void setEndpoint(java.lang.String endpoint)
                 throws java.lang.IllegalArgumentException

Description copied from interface: AmazonSQS

Overrides the default endpoint for this client ("sqs.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "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.

Specified by:: setEndpoint in interface AmazonSQS

Parameters:: endpoint - The endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "sqs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
Throws:: java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setQueueAttributesAsync

public java.util.concurrent.Future<java.lang.Void> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Description copied from interface: AmazonSQSAsync

NOTE:Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Specified by:: setQueueAttributesAsync in interface AmazonSQSAsync

Parameters:: setQueueAttributesRequest - Container for the necessary parameters to execute the SetQueueAttributes operation on AmazonSQS.
Returns:: A Java Future object containing the response from the SetQueueAttributes service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getQueueUrlAsync

public java.util.concurrent.Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Description copied from interface: AmazonSQSAsync

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.

To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or go to Shared Queues in the Amazon SQS Developer Guide .

Specified by:: getQueueUrlAsync in interface AmazonSQSAsync

Parameters:: getQueueUrlRequest - Container for the necessary parameters to execute the GetQueueUrl operation on AmazonSQS.
Returns:: A Java Future object containing the response from the GetQueueUrl service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

removePermissionAsync

public java.util.concurrent.Future<java.lang.Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Description copied from interface: AmazonSQSAsync

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Specified by:: removePermissionAsync in interface AmazonSQSAsync

Parameters:: removePermissionRequest - Container for the necessary parameters to execute the RemovePermission operation on AmazonSQS.
Returns:: A Java Future object containing the response from the RemovePermission service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getQueueUrl

public GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Description copied from interface: AmazonSQS

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.

Specified by:: getQueueUrl in interface AmazonSQS

Parameters:: getQueueUrlRequest - Container for the necessary parameters to execute the GetQueueUrl service method on AmazonSQS.
Returns:: The response from the GetQueueUrl service method, as returned by AmazonSQS.
Throws:: QueueDoesNotExistException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

removePermission

public void removePermission(RemovePermissionRequest removePermissionRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Description copied from interface: AmazonSQS

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Specified by:: removePermission in interface AmazonSQS

Parameters:: removePermissionRequest - Container for the necessary parameters to execute the RemovePermission service method on AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getQueueAttributesAsync

public java.util.concurrent.Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Description copied from interface: AmazonSQSAsync

Gets attributes for the specified queue. The following attributes are supported:

All - returns all values.
ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .
ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .
VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .
CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).
LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).
Policy - returns the queue's policy.
MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.
QueueArn - returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.
DelaySeconds - returns the default delay on the queue in seconds.
ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide .

NOTE:Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

&Attribute.1=this

&Attribute.2=that

Specified by:: getQueueAttributesAsync in interface AmazonSQSAsync

Parameters:: getQueueAttributesRequest - Container for the necessary parameters to execute the GetQueueAttributes operation on AmazonSQS.
Returns:: A Java Future object containing the response from the GetQueueAttributes service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getQueueAttributes

public GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Description copied from interface: AmazonSQS

Gets attributes for the specified queue. The following attributes are supported:

All - returns all values.
ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .
ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .
VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .
CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).
LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).
Policy - returns the queue's policy.
MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.
QueueArn - returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.
DelaySeconds - returns the default delay on the queue in seconds.
ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide .

NOTE:Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

&Attribute.1=this

&Attribute.2=that

Specified by:: getQueueAttributes in interface AmazonSQS

Parameters:: getQueueAttributesRequest - Container for the necessary parameters to execute the GetQueueAttributes service method on AmazonSQS.
Returns:: The response from the GetQueueAttributes service method, as returned by AmazonSQS.
Throws:: InvalidAttributeNameException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteQueueAsync

public java.util.concurrent.Future<java.lang.Void> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest)
                                                             throws AmazonServiceException,
                                                                    AmazonClientException

Description copied from interface: AmazonSQSAsync

Deletes the queue specified by the queue URL , regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.

IMPORTANT: Use DeleteQueue with care; once you delete your queue, any messages in the queue are no longer available.

When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide .

Specified by:: deleteQueueAsync in interface AmazonSQSAsync

Parameters:: deleteQueueRequest - Container for the necessary parameters to execute the DeleteQueue operation on AmazonSQS.
Returns:: A Java Future object containing the response from the DeleteQueue service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteQueue

public void deleteQueue(DeleteQueueRequest deleteQueueRequest)
                 throws AmazonServiceException,
                        AmazonClientException

Description copied from interface: AmazonSQS

Deletes the queue specified by the queue URL , regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.

IMPORTANT: Use DeleteQueue with care; once you delete your queue, any messages in the queue are no longer available.

We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide .

Specified by:: deleteQueue in interface AmazonSQS

Parameters:: deleteQueueRequest - Container for the necessary parameters to execute the DeleteQueue service method on AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

listQueuesAsync

public java.util.concurrent.Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Description copied from interface: AmazonSQSAsync

Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name beginning with the specified value are returned.

Specified by:: listQueuesAsync in interface AmazonSQSAsync

Parameters:: listQueuesRequest - Container for the necessary parameters to execute the ListQueues operation on AmazonSQS.
Returns:: A Java Future object containing the response from the ListQueues service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

listQueues

public ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Description copied from interface: AmazonSQS

Specified by:: listQueues in interface AmazonSQS

Parameters:: listQueuesRequest - Container for the necessary parameters to execute the ListQueues service method on AmazonSQS.
Returns:: The response from the ListQueues service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

createQueueAsync

public java.util.concurrent.Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Description copied from interface: AmazonSQSAsync

Creates a new queue, or returns the URL of an existing one. When you request CreateQueue , you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues.

NOTE: If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes.

NOTE: Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the QueueName parameter.

If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, CreateQueue returns an error.

&Attribute.1=this

&Attribute.2=that

Specified by:: createQueueAsync in interface AmazonSQSAsync

Parameters:: createQueueRequest - Container for the necessary parameters to execute the CreateQueue operation on AmazonSQS.
Returns:: A Java Future object containing the response from the CreateQueue service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

createQueue

public CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Description copied from interface: AmazonSQS

NOTE: If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

NOTE: Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the QueueName parameter.

&Attribute.1=this

&Attribute.2=that

Specified by:: createQueue in interface AmazonSQS

Parameters:: createQueueRequest - Container for the necessary parameters to execute the CreateQueue service method on AmazonSQS.
Returns:: The response from the CreateQueue service method, as returned by AmazonSQS.
Throws:: QueueNameExistsException; QueueDeletedRecentlyException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

addPermissionAsync

public java.util.concurrent.Future<java.lang.Void> addPermissionAsync(AddPermissionRequest addPermissionRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Description copied from interface: AmazonSQSAsync

Adds a permission to a queue for a specific principal . This allows for sharing access to the queue.

When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide .

NOTE: AddPermission writes an Amazon SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.

&Attribute.1=this

&Attribute.2=that

Specified by:: addPermissionAsync in interface AmazonSQSAsync

Parameters:: addPermissionRequest - Container for the necessary parameters to execute the AddPermission operation on AmazonSQS.
Returns:: A Java Future object containing the response from the AddPermission service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

addPermission

public void addPermission(AddPermissionRequest addPermissionRequest)
                   throws AmazonServiceException,
                          AmazonClientException

Description copied from interface: AmazonSQS

Adds a permission to a queue for a specific principal . This allows for sharing access to the queue.

&Attribute.1=this

&Attribute.2=that

Specified by:: addPermission in interface AmazonSQS

Parameters:: addPermissionRequest - Container for the necessary parameters to execute the AddPermission service method on AmazonSQS.
Throws:: OverLimitException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

listQueues

public ListQueuesResult listQueues()
                            throws AmazonServiceException,
                                   AmazonClientException

Description copied from interface: AmazonSQS

Specified by:: listQueues in interface AmazonSQS

Returns:: The response from the ListQueues service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonSQS

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:: getCachedResponseMetadata in interface AmazonSQS

Parameters:: request - The originally executed request.
Returns:: The response metadata for the specified request, or null if none is available.

deleteMessageAsync

public java.util.concurrent.Future<java.lang.Void> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Description copied from interface: AmazonSQSAsync

Specified by:: deleteMessageAsync in interface AmazonSQSAsync

Parameters:: deleteMessageRequest - Container for the necessary parameters to execute the DeleteMessage operation on AmazonSQS.
Returns:: A Java Future object containing the response from the DeleteMessage service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

changeMessageVisibilityAsync

public java.util.concurrent.Future<java.lang.Void> changeMessageVisibilityAsync(ChangeMessageVisibilityRequest changeMessageVisibilityRequest,
                                                                                AsyncHandler<ChangeMessageVisibilityRequest,java.lang.Void> asyncHandler)
                                                                         throws AmazonServiceException,
                                                                                AmazonClientException

Description copied from interface: AmazonSQSAsync

Specified by:: changeMessageVisibilityAsync in interface AmazonSQSAsync

Parameters:: changeMessageVisibilityRequest - Container for the necessary parameters to execute the ChangeMessageVisibility operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the ChangeMessageVisibility service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

sendMessageAsync

public java.util.concurrent.Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest,
                                                                       AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Description copied from interface: AmazonSQSAsync

Specified by:: sendMessageAsync in interface AmazonSQSAsync

Parameters:: sendMessageRequest - Container for the necessary parameters to execute the SendMessage operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the SendMessage service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

receiveMessageAsync

public java.util.concurrent.Future<ReceiveMessageResult> receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest,
                                                                             AsyncHandler<ReceiveMessageRequest,ReceiveMessageResult> asyncHandler)
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

Description copied from interface: AmazonSQSAsync

For each message returned, the response includes the following:

Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html .
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .

NOTE: Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Specified by:: receiveMessageAsync in interface AmazonSQSAsync

Parameters:: receiveMessageRequest - Container for the necessary parameters to execute the ReceiveMessage operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the ReceiveMessage service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteMessageAsync

public java.util.concurrent.Future<java.lang.Void> deleteMessageAsync(DeleteMessageRequest deleteMessageRequest,
                                                                      AsyncHandler<DeleteMessageRequest,java.lang.Void> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Description copied from interface: AmazonSQSAsync

Specified by:: deleteMessageAsync in interface AmazonSQSAsync

Parameters:: deleteMessageRequest - Container for the necessary parameters to execute the DeleteMessage operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the DeleteMessage service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

setQueueAttributesAsync

public java.util.concurrent.Future<java.lang.Void> setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest,
                                                                           AsyncHandler<SetQueueAttributesRequest,java.lang.Void> asyncHandler)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Description copied from interface: AmazonSQSAsync

NOTE:Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Specified by:: setQueueAttributesAsync in interface AmazonSQSAsync

Parameters:: setQueueAttributesRequest - Container for the necessary parameters to execute the SetQueueAttributes operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the SetQueueAttributes service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

changeMessageVisibilityBatchAsync

public java.util.concurrent.Future<ChangeMessageVisibilityBatchResult> changeMessageVisibilityBatchAsync(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest,
                                                                                                         AsyncHandler<ChangeMessageVisibilityBatchRequest,ChangeMessageVisibilityBatchResult> asyncHandler)
                                                                                                  throws AmazonServiceException,
                                                                                                         AmazonClientException

Description copied from interface: AmazonSQSAsync

IMPORTANT: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.

&Attribute.1=this

&Attribute.2=that

Specified by:: changeMessageVisibilityBatchAsync in interface AmazonSQSAsync

Parameters:: changeMessageVisibilityBatchRequest - Container for the necessary parameters to execute the ChangeMessageVisibilityBatch operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the ChangeMessageVisibilityBatch service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getQueueUrlAsync

public java.util.concurrent.Future<GetQueueUrlResult> getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest,
                                                                       AsyncHandler<GetQueueUrlRequest,GetQueueUrlResult> asyncHandler)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Description copied from interface: AmazonSQSAsync

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.

Specified by:: getQueueUrlAsync in interface AmazonSQSAsync

Parameters:: getQueueUrlRequest - Container for the necessary parameters to execute the GetQueueUrl operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the GetQueueUrl service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

removePermissionAsync

public java.util.concurrent.Future<java.lang.Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest,
                                                                         AsyncHandler<RemovePermissionRequest,java.lang.Void> asyncHandler)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Description copied from interface: AmazonSQSAsync

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Specified by:: removePermissionAsync in interface AmazonSQSAsync

Parameters:: removePermissionRequest - Container for the necessary parameters to execute the RemovePermission operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the RemovePermission service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getQueueAttributesAsync

public java.util.concurrent.Future<GetQueueAttributesResult> getQueueAttributesAsync(GetQueueAttributesRequest getQueueAttributesRequest,
                                                                                     AsyncHandler<GetQueueAttributesRequest,GetQueueAttributesResult> asyncHandler)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Description copied from interface: AmazonSQSAsync

Gets attributes for the specified queue. The following attributes are supported:

All - returns all values.
ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .
ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .
VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .
CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).
LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).
Policy - returns the queue's policy.
MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.
QueueArn - returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.
DelaySeconds - returns the default delay on the queue in seconds.
ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide .

NOTE:Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

&Attribute.1=this

&Attribute.2=that

Specified by:: getQueueAttributesAsync in interface AmazonSQSAsync

Parameters:: getQueueAttributesRequest - Container for the necessary parameters to execute the GetQueueAttributes operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the GetQueueAttributes service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

sendMessageBatchAsync

public java.util.concurrent.Future<SendMessageBatchResult> sendMessageBatchAsync(SendMessageBatchRequest sendMessageBatchRequest,
                                                                                 AsyncHandler<SendMessageBatchRequest,SendMessageBatchResult> asyncHandler)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

Description copied from interface: AmazonSQSAsync

The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).

If the DelaySeconds parameter is not specified for an entry, the default for the queue is used.

IMPORTANT: 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.

&Attribute.1=this

&Attribute.2=that

Specified by:: sendMessageBatchAsync in interface AmazonSQSAsync

Parameters:: sendMessageBatchRequest - Container for the necessary parameters to execute the SendMessageBatch operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the SendMessageBatch service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteQueueAsync

public java.util.concurrent.Future<java.lang.Void> deleteQueueAsync(DeleteQueueRequest deleteQueueRequest,
                                                                    AsyncHandler<DeleteQueueRequest,java.lang.Void> asyncHandler)
                                                             throws AmazonServiceException,
                                                                    AmazonClientException

Description copied from interface: AmazonSQSAsync

Deletes the queue specified by the queue URL , regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.

IMPORTANT: Use DeleteQueue with care; once you delete your queue, any messages in the queue are no longer available.

We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide .

Specified by:: deleteQueueAsync in interface AmazonSQSAsync

Parameters:: deleteQueueRequest - Container for the necessary parameters to execute the DeleteQueue operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the DeleteQueue service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

listQueuesAsync

public java.util.concurrent.Future<ListQueuesResult> listQueuesAsync(ListQueuesRequest listQueuesRequest,
                                                                     AsyncHandler<ListQueuesRequest,ListQueuesResult> asyncHandler)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Description copied from interface: AmazonSQSAsync

Specified by:: listQueuesAsync in interface AmazonSQSAsync

Parameters:: listQueuesRequest - Container for the necessary parameters to execute the ListQueues operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the ListQueues service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteMessageBatchAsync

public java.util.concurrent.Future<DeleteMessageBatchResult> deleteMessageBatchAsync(DeleteMessageBatchRequest deleteMessageBatchRequest,
                                                                                     AsyncHandler<DeleteMessageBatchRequest,DeleteMessageBatchResult> asyncHandler)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Description copied from interface: AmazonSQSAsync

Deletes multiple messages. This is a batch version of DeleteMessage. The result of the delete action on each message is reported individually in the response.

IMPORTANT: 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.

&Attribute.1=this

&Attribute.2=that

Specified by:: deleteMessageBatchAsync in interface AmazonSQSAsync

Parameters:: deleteMessageBatchRequest - Container for the necessary parameters to execute the DeleteMessageBatch operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the DeleteMessageBatch service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

createQueueAsync

public java.util.concurrent.Future<CreateQueueResult> createQueueAsync(CreateQueueRequest createQueueRequest,
                                                                       AsyncHandler<CreateQueueRequest,CreateQueueResult> asyncHandler)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Description copied from interface: AmazonSQSAsync

NOTE: If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

NOTE: Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the QueueName parameter.

&Attribute.1=this

&Attribute.2=that

Specified by:: createQueueAsync in interface AmazonSQSAsync

Parameters:: createQueueRequest - Container for the necessary parameters to execute the CreateQueue operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the CreateQueue service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

addPermissionAsync

public java.util.concurrent.Future<java.lang.Void> addPermissionAsync(AddPermissionRequest addPermissionRequest,
                                                                      AsyncHandler<AddPermissionRequest,java.lang.Void> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Description copied from interface: AmazonSQSAsync

Adds a permission to a queue for a specific principal . This allows for sharing access to the queue.

&Attribute.1=this

&Attribute.2=that

Specified by:: addPermissionAsync in interface AmazonSQSAsync

Parameters:: addPermissionRequest - Container for the necessary parameters to execute the AddPermission operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the AddPermission service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

listDeadLetterSourceQueues

public ListDeadLetterSourceQueuesResult listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Description copied from interface: 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 .

Specified by:: listDeadLetterSourceQueues in interface AmazonSQS

Parameters:: listDeadLetterSourceQueuesRequest - Container for the necessary parameters to execute the ListDeadLetterSourceQueues service method on AmazonSQS.
Returns:: The response from the ListDeadLetterSourceQueues service method, as returned by AmazonSQS.
Throws:: QueueDoesNotExistException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

listDeadLetterSourceQueuesAsync

public java.util.concurrent.Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
                                                                                              throws AmazonServiceException,
                                                                                                     AmazonClientException

Description copied from interface: AmazonSQSAsync

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues .

Specified by:: listDeadLetterSourceQueuesAsync in interface AmazonSQSAsync

Parameters:: listDeadLetterSourceQueuesRequest - Container for the necessary parameters to execute the ListDeadLetterSourceQueues operation on AmazonSQS.
Returns:: A Java Future object containing the response from the ListDeadLetterSourceQueues service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

listDeadLetterSourceQueuesAsync

public java.util.concurrent.Future<ListDeadLetterSourceQueuesResult> listDeadLetterSourceQueuesAsync(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest,
                                                                                                     AsyncHandler<ListDeadLetterSourceQueuesRequest,ListDeadLetterSourceQueuesResult> asyncHandler)
                                                                                              throws AmazonServiceException,
                                                                                                     AmazonClientException

Description copied from interface: AmazonSQSAsync

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues .

Specified by:: listDeadLetterSourceQueuesAsync in interface AmazonSQSAsync

Parameters:: listDeadLetterSourceQueuesRequest - Container for the necessary parameters to execute the ListDeadLetterSourceQueues operation on AmazonSQS.; asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:: A Java Future object containing the response from the ListDeadLetterSourceQueues service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

setQueueAttributes

public void setQueueAttributes(java.lang.String queueUrl,
                               java.util.Map<java.lang.String,java.lang.String> attributes)
                        throws AmazonServiceException,
                               AmazonClientException

Description copied from interface: AmazonSQS

NOTE:Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Specified by:: setQueueAttributes in interface AmazonSQS

Parameters:

queueUrl - The URL of the Amazon SQS queue to take action on.

attributes - A map of attributes to set.

The following lists the names, descriptions, and values of the special request parameters the SetQueueAttributes action uses:

DelaySeconds - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).
MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
MessageRetentionPeriod - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
Policy - The queue's policy. A valid form-url-encoded policy. For more information about policy structure, see Basic Policy Structure in the Amazon SQS Developer Guide. For more information about form-url-encoding, see http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.
ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0.
VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
RedrivePolicy - The parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

Throws:

InvalidAttributeNameException

AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

changeMessageVisibilityBatch

public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(java.lang.String queueUrl,
                                                                       java.util.List<ChangeMessageVisibilityBatchRequestEntry> entries)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Description copied from interface: AmazonSQS

IMPORTANT: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.

&Attribute.1=this

&Attribute.2=that

Specified by:: changeMessageVisibilityBatch in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; entries - A list of receipt handles of the messages for which the visibility timeout must be changed.
Returns:: The response from the ChangeMessageVisibilityBatch service method, as returned by AmazonSQS.
Throws:: BatchEntryIdsNotDistinctException; TooManyEntriesInBatchRequestException; InvalidBatchEntryIdException; EmptyBatchRequestException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

changeMessageVisibility

public void changeMessageVisibility(java.lang.String queueUrl,
                                    java.lang.String receiptHandle,
                                    java.lang.Integer visibilityTimeout)
                             throws AmazonServiceException,
                                    AmazonClientException

Description copied from interface: AmazonSQS

Specified by:: changeMessageVisibility in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; receiptHandle - The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.; visibilityTimeout - The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.
Throws:: ReceiptHandleIsInvalidException; MessageNotInflightException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getQueueUrl

public GetQueueUrlResult getQueueUrl(java.lang.String queueName)
                              throws AmazonServiceException,
                                     AmazonClientException

Description copied from interface: AmazonSQS

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.

Specified by:: getQueueUrl in interface AmazonSQS

Parameters:: queueName - The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
Returns:: The response from the GetQueueUrl service method, as returned by AmazonSQS.
Throws:: QueueDoesNotExistException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

removePermission

public void removePermission(java.lang.String queueUrl,
                             java.lang.String label)
                      throws AmazonServiceException,
                             AmazonClientException

Description copied from interface: AmazonSQS

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Specified by:: removePermission in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; label - The identification of the permission to remove. This is the label added with the AddPermission action.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

sendMessageBatch

public SendMessageBatchResult sendMessageBatch(java.lang.String queueUrl,
                                               java.util.List<SendMessageBatchRequestEntry> entries)
                                        throws AmazonServiceException,
                                               AmazonClientException

Description copied from interface: AmazonSQS

The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).

If the DelaySeconds parameter is not specified for an entry, the default for the queue is used.

IMPORTANT: 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.

&Attribute.1=this

&Attribute.2=that

Specified by:: sendMessageBatch in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; entries - A list of SendMessageBatchRequestEntry items.
Returns:: The response from the SendMessageBatch service method, as returned by AmazonSQS.
Throws:: BatchEntryIdsNotDistinctException; TooManyEntriesInBatchRequestException; BatchRequestTooLongException; UnsupportedOperationException; InvalidBatchEntryIdException; EmptyBatchRequestException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteQueue

public void deleteQueue(java.lang.String queueUrl)
                 throws AmazonServiceException,
                        AmazonClientException

Description copied from interface: AmazonSQS

Deletes the queue specified by the queue URL , regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.

IMPORTANT: Use DeleteQueue with care; once you delete your queue, any messages in the queue are no longer available.

We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide .

Specified by:: deleteQueue in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

sendMessage

public SendMessageResult sendMessage(java.lang.String queueUrl,
                                     java.lang.String messageBody)
                              throws AmazonServiceException,
                                     AmazonClientException

Description copied from interface: AmazonSQS

Specified by:: sendMessage in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; messageBody - The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
Returns:: The response from the SendMessage service method, as returned by AmazonSQS.
Throws:: InvalidMessageContentsException; UnsupportedOperationException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

receiveMessage

public ReceiveMessageResult receiveMessage(java.lang.String queueUrl)
                                    throws AmazonServiceException,
                                           AmazonClientException

Description copied from interface: AmazonSQS

For each message returned, the response includes the following:

Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html .
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide .

NOTE: Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

Specified by:: receiveMessage in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.
Returns:: The response from the ReceiveMessage service method, as returned by AmazonSQS.
Throws:: OverLimitException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

listQueues

public ListQueuesResult listQueues(java.lang.String queueNamePrefix)
                            throws AmazonServiceException,
                                   AmazonClientException

Description copied from interface: AmazonSQS

Specified by:: listQueues in interface AmazonSQS

Parameters:: queueNamePrefix - A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
Returns:: The response from the ListQueues service method, as returned by AmazonSQS.
Throws:: AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteMessageBatch

public DeleteMessageBatchResult deleteMessageBatch(java.lang.String queueUrl,
                                                   java.util.List<DeleteMessageBatchRequestEntry> entries)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Description copied from interface: AmazonSQS

Deletes multiple messages. This is a batch version of DeleteMessage. The result of the delete action on each message is reported individually in the response.

IMPORTANT: 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.

&Attribute.1=this

&Attribute.2=that

Specified by:: deleteMessageBatch in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; entries - A list of receipt handles for the messages to be deleted.
Returns:: The response from the DeleteMessageBatch service method, as returned by AmazonSQS.
Throws:: BatchEntryIdsNotDistinctException; TooManyEntriesInBatchRequestException; InvalidBatchEntryIdException; EmptyBatchRequestException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

createQueue

public CreateQueueResult createQueue(java.lang.String queueName)
                              throws AmazonServiceException,
                                     AmazonClientException

Description copied from interface: AmazonSQS

NOTE: If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

NOTE: Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the QueueName parameter.

&Attribute.1=this

&Attribute.2=that

Specified by:: createQueue in interface AmazonSQS

Parameters:: queueName - The name for the queue to be created.
Returns:: The response from the CreateQueue service method, as returned by AmazonSQS.
Throws:: QueueNameExistsException; QueueDeletedRecentlyException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

addPermission

public void addPermission(java.lang.String queueUrl,
                          java.lang.String label,
                          java.util.List<java.lang.String> aWSAccountIds,
                          java.util.List<java.lang.String> actions)
                   throws AmazonServiceException,
                          AmazonClientException

Description copied from interface: AmazonSQS

Adds a permission to a queue for a specific principal . This allows for sharing access to the queue.

&Attribute.1=this

&Attribute.2=that

Specified by:: addPermission in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; label - The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.; aWSAccountIds - The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.; actions - The action the client wants to allow for the specified principal. The following are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl. For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for the ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
Throws:: OverLimitException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

deleteMessage

public void deleteMessage(java.lang.String queueUrl,
                          java.lang.String receiptHandle)
                   throws AmazonServiceException,
                          AmazonClientException

Description copied from interface: AmazonSQS

Specified by:: deleteMessage in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; receiptHandle - The receipt handle associated with the message to delete.
Throws:: ReceiptHandleIsInvalidException; InvalidIdFormatException; AmazonServiceException - If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.; AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

getQueueAttributes

public GetQueueAttributesResult getQueueAttributes(java.lang.String queueUrl,
                                                   java.util.List<java.lang.String> attributeNames)

Description copied from interface: AmazonSQS

Gets attributes for the specified queue. The following attributes are supported:

All - returns all values.
ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .
ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide .
VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .
CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).
LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).
Policy - returns the queue's policy.
MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.
QueueArn - returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.
DelaySeconds - returns the default delay on the queue in seconds.
ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive.
RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide .

NOTE:Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

&Attribute.1=this

&Attribute.2=that

Specified by:: getQueueAttributes in interface AmazonSQS

Parameters:: queueUrl - The URL of the Amazon SQS queue to take action on.; attributeNames - A list of attributes to retrieve information for.
Returns:: The response from the GetQueueAttributes service method, as returned by AmazonSQS.

Overview

Package

Class

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.sqs.buffered Class AmazonSQSBufferedAsyncClient

USER_AGENT

AmazonSQSBufferedAsyncClient

AmazonSQSBufferedAsyncClient

setRegion

setQueueAttributes

changeMessageVisibilityBatch

changeMessageVisibility

sendMessageBatch

sendMessage

receiveMessage

deleteMessageBatch

deleteMessage

shutdown

changeMessageVisibilityBatchAsync

changeMessageVisibilityAsync

sendMessageBatchAsync

sendMessageAsync

receiveMessageAsync

deleteMessageBatchAsync

setEndpoint

setQueueAttributesAsync

getQueueUrlAsync

removePermissionAsync

getQueueUrl

removePermission

getQueueAttributesAsync

getQueueAttributes

deleteQueueAsync

deleteQueue

listQueuesAsync

listQueues

createQueueAsync

createQueue

addPermissionAsync

addPermission

listQueues

getCachedResponseMetadata

deleteMessageAsync

changeMessageVisibilityAsync

sendMessageAsync

receiveMessageAsync

deleteMessageAsync

setQueueAttributesAsync

changeMessageVisibilityBatchAsync

getQueueUrlAsync

removePermissionAsync

getQueueAttributesAsync

sendMessageBatchAsync

deleteQueueAsync

listQueuesAsync

deleteMessageBatchAsync

createQueueAsync

addPermissionAsync

listDeadLetterSourceQueues

listDeadLetterSourceQueuesAsync

listDeadLetterSourceQueuesAsync

setQueueAttributes

changeMessageVisibilityBatch

changeMessageVisibility

getQueueUrl

removePermission

sendMessageBatch

deleteQueue

sendMessage

receiveMessage

listQueues

deleteMessageBatch

createQueue

addPermission

deleteMessage

getQueueAttributes

com.amazonaws.services.sqs.buffered
Class AmazonSQSBufferedAsyncClient