* Welcome to the Amazon Simple Queue Service API Reference. This section * describes who should read this guide, how the guide is organized, and other * resources related to the Amazon Simple Queue Service (Amazon SQS). *
** Amazon SQS offers reliable and scalable hosted queues for storing messages as * they travel between computers. By using Amazon SQS, you can move data between * distributed components of your applications that perform different tasks * without losing messages or requiring each component to be always available. *
** Topics *
**
*
* CommonParameters *
** CommonErrors *
** Helpful Links *
** We also provide SDKs that enable you to access Amazon SQS from your preferred * programming language. The SDKs contain functionality that automatically takes * care of tasks such as: *
** Cryptographically signing your service requests *
** Retrying requests *
** Handling error responses *
** For a list of available SDKs, see Tools for Amazon Web Services. *
**/ public class AmazonSQSAsyncClient extends AmazonSQSClient implements AmazonSQSAsync { /** * Executor service for executing asynchronous requests. */ private ExecutorService executorService; private static final int DEFAULT_THREAD_POOL_SIZE = 10; /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS. A credentials provider chain will be used that searches for * credentials in this order: ** All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @see DefaultAWSCredentialsProviderChain */ @Deprecated public AmazonSQSAsyncClient() { this(new DefaultAWSCredentialsProviderChain()); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS. A credentials provider chain will be used that searches for * credentials in this order: *
* All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @param clientConfiguration The client configuration options controlling * how this client connects to Amazon SQS (ex: proxy settings, * retry counts, etc.). * @see DefaultAWSCredentialsProviderChain */ @Deprecated public AmazonSQSAsyncClient(ClientConfiguration clientConfiguration) { this(new DefaultAWSCredentialsProviderChain(), clientConfiguration, Executors .newFixedThreadPool(clientConfiguration.getMaxConnections())); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS using the specified AWS account credentials. Default client settings * will be used, and a fixed size thread pool will be created for executing * the asynchronous tasks. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. */ public AmazonSQSAsyncClient(AWSCredentials awsCredentials) { this(awsCredentials, Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE)); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS using the specified AWS account credentials and executor service. * Default client settings will be used. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonSQSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) { super(awsCredentials); this.executorService = executorService; } /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS using the specified AWS account credentials, executor service, and * client configuration options. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonSQSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) { super(awsCredentials, clientConfiguration); this.executorService = executorService; } /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS using the specified AWS account credentials provider. Default client * settings will be used, and a fixed size thread pool will be created for * executing the asynchronous tasks. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. */ public AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE)); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS using the specified AWS account credentials provider and executor * service. Default client settings will be used. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) { this(awsCredentialsProvider, new ClientConfiguration(), executorService); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS using the specified AWS account credentials provider and client * configuration options. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). */ public AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, Executors .newFixedThreadPool(clientConfiguration.getMaxConnections())); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * SQS using the specified AWS account credentials provider, executor * service, and client configuration options. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonSQSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) { super(awsCredentialsProvider, clientConfiguration); this.executorService = executorService; } /** * Returns the executor service used by this async client to execute * requests. * * @return The executor service used by this async client to execute * requests. */ public ExecutorService getExecutorService() { return executorService; } /** * Shuts down the client, releasing all managed resources. This includes * forcibly terminating all pending asynchronous service calls. Clients who * wish to give pending asynchronous service calls time to complete should * call getExecutorService().shutdown() followed by * getExecutorService().awaitTermination() prior to calling this method. */ @Override public void shutdown() { super.shutdown(); executorService.shutdownNow(); } /** *
* Adds a permission to a queue for a specific principal. This allows for sharing access to the queue. *
** When you create a queue, you have full control access rights for the * queue. Only you (as owner of the queue) can grant or deny permissions to * the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide. *
*
* AddPermission writes an Amazon SQS-generated policy. If you
* want to write your own policy, use SetQueueAttributes to upload
* your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer
* Guide.
*
* Some API actions take lists of parameters. These lists are specified
* using the param.n notation. Values of n are
* integers starting from 1. For example, a parameter list with two elements
* looks like this:
*
* &Attribute.1=this
*
* &Attribute.2=that
*
* Adds a permission to a queue for a specific principal. This allows for sharing access to the queue. *
** When you create a queue, you have full control access rights for the * queue. Only you (as owner of the queue) can grant or deny permissions to * the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide. *
*
* AddPermission writes an Amazon SQS-generated policy. If you
* want to write your own policy, use SetQueueAttributes to upload
* your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer
* Guide.
*
* Some API actions take lists of parameters. These lists are specified
* using the param.n notation. Values of n are
* integers starting from 1. For example, a parameter list with two elements
* looks like this:
*
* &Attribute.1=this
*
* &Attribute.2=that
*
* Changes the visibility timeout of a specified message in a queue to a new * value. The maximum allowed timeout value you can set the value to is 12 * hours. This means you can't extend the timeout of a message in an * existing queue to more than a total visibility timeout of 12 hours. (For * more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.) *
*
* For example, let's say you have a message and its default message
* visibility timeout is 5 minutes. After 3 minutes, you call
* ChangeMessageVisiblity with a timeout of 10 minutes. At that
* time, the timeout for the message would be extended by 10 minutes beyond
* the time of the ChangeMessageVisibility call. This results in a total
* visibility timeout of 13 minutes. You can continue to call
* ChangeMessageVisibility to extend the visibility timeout to a maximum of
* 12 hours. If you try to extend beyond 12 hours, the request will be
* rejected.
*
* There is a 120,000 limit for the number of inflight messages per queue. * Messages are inflight after they have been received from the queue by a * consuming component, but have not yet been deleted from the queue. If you * reach the 120,000 limit, you will receive an OverLimit error message from * Amazon SQS. To help avoid reaching the limit, you should delete the * messages from the queue after they have been processed. You can also * increase the number of queues you use to process the messages. *
*
* If you attempt to set the VisibilityTimeout to an amount
* more than the maximum time left, Amazon SQS returns an error. It will not
* automatically recalculate and increase the timeout to the maximum time
* remaining.
*
* Unlike with a queue, when you change the visibility timeout for a
* specific message, that timeout value is applied immediately but is not
* saved in memory for that message. If you don't delete a message after it
* is received, the visibility timeout for the message the next time it is
* received reverts to the original timeout value, not the value you set
* with the ChangeMessageVisibility action.
*
* Changes the visibility timeout of a specified message in a queue to a new * value. The maximum allowed timeout value you can set the value to is 12 * hours. This means you can't extend the timeout of a message in an * existing queue to more than a total visibility timeout of 12 hours. (For * more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.) *
*
* For example, let's say you have a message and its default message
* visibility timeout is 5 minutes. After 3 minutes, you call
* ChangeMessageVisiblity with a timeout of 10 minutes. At that
* time, the timeout for the message would be extended by 10 minutes beyond
* the time of the ChangeMessageVisibility call. This results in a total
* visibility timeout of 13 minutes. You can continue to call
* ChangeMessageVisibility to extend the visibility timeout to a maximum of
* 12 hours. If you try to extend beyond 12 hours, the request will be
* rejected.
*
* There is a 120,000 limit for the number of inflight messages per queue. * Messages are inflight after they have been received from the queue by a * consuming component, but have not yet been deleted from the queue. If you * reach the 120,000 limit, you will receive an OverLimit error message from * Amazon SQS. To help avoid reaching the limit, you should delete the * messages from the queue after they have been processed. You can also * increase the number of queues you use to process the messages. *
*
* If you attempt to set the VisibilityTimeout to an amount
* more than the maximum time left, Amazon SQS returns an error. It will not
* automatically recalculate and increase the timeout to the maximum time
* remaining.
*
* Unlike with a queue, when you change the visibility timeout for a
* specific message, that timeout value is applied immediately but is not
* saved in memory for that message. If you don't delete a message after it
* is received, the visibility timeout for the message the next time it is
* received reverts to the original timeout value, not the value you set
* with the ChangeMessageVisibility action.
*
* Changes the visibility timeout of multiple messages. This is a batch
* version of ChangeMessageVisibility. The result of the action on
* each message is reported individually in the response. You can send up to
* 10 ChangeMessageVisibility requests with each
* ChangeMessageVisibilityBatch action.
*
* Because the batch request can result in a combination of successful and * unsuccessful actions, you should check for batch errors even when the * call returns an HTTP status code of 200. *
*
* Some API actions take lists of parameters. These lists are specified
* using the param.n notation. Values of n are
* integers starting from 1. For example, a parameter list with two elements
* looks like this:
*
* &Attribute.1=this
*
* &Attribute.2=that
*
* Changes the visibility timeout of multiple messages. This is a batch
* version of ChangeMessageVisibility. The result of the action on
* each message is reported individually in the response. You can send up to
* 10 ChangeMessageVisibility requests with each
* ChangeMessageVisibilityBatch action.
*
* Because the batch request can result in a combination of successful and * unsuccessful actions, you should check for batch errors even when the * call returns an HTTP status code of 200. *
*
* Some API actions take lists of parameters. These lists are specified
* using the param.n notation. Values of n are
* integers starting from 1. For example, a parameter list with two elements
* looks like this:
*
* &Attribute.1=this
*
* &Attribute.2=that
*
* Creates a new standard or FIFO queue or returns the URL of an existing * queue. You can pass one or more attributes in the request. *
*
* If you don't specify the FifoQueue attribute, Amazon SQS
* creates a standard queue.
*
* You can't change the queue type after you create it and you can't convert * an existing standard queue into a FIFO queue. You must either create a * new FIFO queue for your application or delete your existing standard * queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon SQS * Developer Guide. *
** If you don't provide a value for an attribute, the queue is created with * the default value for the attribute. *
** If you delete a queue, you must wait at least 60 seconds before creating * a queue with the same name. *
** To successfully create a new queue, you must provide a queue name that * adheres to the limits related to queues and is unique within the scope of your * queues. *
*
* To get the queue URL, use the GetQueueUrl action.
* 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 don't match an
* existing queue, CreateQueue returns an error.
*
* Some API actions take lists of parameters. Specify these lists using the
* param.n notation. Values of n are integers
* starting from 1. The following is an example of a parameter list with two
* elements:
*
* &Attribute.1=this
*
* &Attribute.2=that
*
* Creates a new standard or FIFO queue or returns the URL of an existing * queue. You can pass one or more attributes in the request. *
*
* If you don't specify the FifoQueue attribute, Amazon SQS
* creates a standard queue.
*
* You can't change the queue type after you create it and you can't convert * an existing standard queue into a FIFO queue. You must either create a * new FIFO queue for your application or delete your existing standard * queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon SQS * Developer Guide. *
** If you don't provide a value for an attribute, the queue is created with * the default value for the attribute. *
** If you delete a queue, you must wait at least 60 seconds before creating * a queue with the same name. *
** To successfully create a new queue, you must provide a queue name that * adheres to the limits related to queues and is unique within the scope of your * queues. *
*
* To get the queue URL, use the GetQueueUrl action.
* 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 don't match an
* existing queue, CreateQueue returns an error.
*
* Some API actions take lists of parameters. Specify these lists using the
* param.n notation. Values of n are integers
* starting from 1. The following is an example of a parameter list with two
* elements:
*
* &Attribute.1=this
*
* &Attribute.2=that
*
* 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.
*
* The receipt handle is associated with a specific instance of receiving
* the message. If you receive a message more than once, the receipt handle
* you get each time you receive the message is different. When you request
* DeleteMessage, if you don't provide the most recently
* received receipt handle for the message, the request will still succeed,
* but the message might not be deleted.
*
* It is possible you will receive a message even after you have deleted it. * This might happen on rare occasions if one of the servers storing a copy * of the message is unavailable when you request to delete the message. The * copy remains on the server and might be returned to you again on a * subsequent receive request. You should create your system to be * idempotent so that receiving a particular message more than once is not a * problem. *
*
* 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.
*
* The receipt handle is associated with a specific instance of receiving
* the message. If you receive a message more than once, the receipt handle
* you get each time you receive the message is different. When you request
* DeleteMessage, if you don't provide the most recently
* received receipt handle for the message, the request will still succeed,
* but the message might not be deleted.
*
* It is possible you will receive a message even after you have deleted it. * This might happen on rare occasions if one of the servers storing a copy * of the message is unavailable when you request to delete the message. The * copy remains on the server and might be returned to you again on a * subsequent receive request. You should create your system to be * idempotent so that receiving a particular message more than once is not a * problem. *
** Deletes up to ten messages from the specified queue. This is a batch * version of DeleteMessage. The result of the delete action on each * message is reported individually in the response. *
** Because the batch request can result in a combination of successful and * unsuccessful actions, you should check for batch errors even when the * call returns an HTTP status code of 200. *
*
* Some API actions take lists of parameters. These lists are specified
* using the param.n notation. Values of n are
* integers starting from 1. For example, a parameter list with two elements
* looks like this:
*
* &Attribute.1=this
*
* &Attribute.2=that
*
* Deletes up to ten messages from the specified queue. This is a batch * version of DeleteMessage. The result of the delete action on each * message is reported individually in the response. *
** Because the batch request can result in a combination of successful and * unsuccessful actions, you should check for batch errors even when the * call returns an HTTP status code of 200. *
*
* Some API actions take lists of parameters. These lists are specified
* using the param.n notation. Values of n are
* integers starting from 1. For example, a parameter list with two elements
* looks like this:
*
* &Attribute.1=this
*
* &Attribute.2=that
*
* Deletes the queue specified by the queue URL, regardless of * whether the queue is empty. If the specified queue doesn't exist, Amazon * SQS returns a successful response. *
*
* Use DeleteQueue with care; once you delete your queue, any
* messages in the queue are no longer available.
*
* When you delete a queue, the deletion process takes up to 60 seconds. * Requests you send involving that queue during the 60 seconds might * succeed. For example, a SendMessage request might succeed, but * after the 60 seconds, the queue and that message you sent no longer * exist. Also, when you delete a queue, you must wait at least 60 seconds * before creating a queue with the same name. *
** We reserve the right to delete queues that have had no activity for more * than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide. *
* * @param deleteQueueRequest * @return A Java Future object containing the response from the DeleteQueue * service method, as returned by Amazon SQS. * @throws 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. * @throws AmazonServiceException If an error response is returned by Amazon * SQS indicating either a problem with the data in the request, * or a server side issue. */ public Future* Deletes the queue specified by the queue URL, regardless of * whether the queue is empty. If the specified queue doesn't exist, Amazon * SQS returns a successful response. *
*
* Use DeleteQueue with care; once you delete your queue, any
* messages in the queue are no longer available.
*
* When you delete a queue, the deletion process takes up to 60 seconds. * Requests you send involving that queue during the 60 seconds might * succeed. For example, a SendMessage request might succeed, but * after the 60 seconds, the queue and that message you sent no longer * exist. Also, when you delete a queue, you must wait at least 60 seconds * before creating a queue with the same name. *
** We reserve the right to delete queues that have had no activity for more * than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide. *
* * @param deleteQueueRequest * @return A Java Future object containing the response from the DeleteQueue * service method, as returned by Amazon SQS. * @throws 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. * @throws AmazonServiceException If an error response is returned by Amazon * SQS indicating either a problem with the data in the request, * or a server side issue. */ public Future* Gets attributes for the specified queue. *
*
* 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
*
* Gets attributes for the specified queue. *
*
* 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
*
* Returns the URL of an existing queue. This action provides a simple way * to retrieve the URL of an Amazon SQS queue. *
*
* To access a queue that belongs to another AWS account, use the
* QueueOwnerAWSAccountId parameter to specify the account ID
* of the queue's owner. The queue's owner must grant you permission to
* access the queue. For more information about shared queue access, see
* AddPermission or see Shared Queues in the Amazon SQS Developer Guide.
*
* Returns the URL of an existing queue. This action provides a simple way * to retrieve the URL of an Amazon SQS queue. *
*
* To access a queue that belongs to another AWS account, use the
* QueueOwnerAWSAccountId parameter to specify the account ID
* of the queue's owner. The queue's owner must grant you permission to
* access the queue. For more information about shared queue access, see
* AddPermission or see Shared Queues in the Amazon SQS Developer Guide.
*
* Returns a list of your queues that have the RedrivePolicy queue attribute * configured with a dead letter queue. *
** For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer * Guide. *
* * @param listDeadLetterSourceQueuesRequest * @return A Java Future object containing the response from the * ListDeadLetterSourceQueues service method, as returned by Amazon * SQS. * @throws QueueDoesNotExistException * @throws 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. * @throws AmazonServiceException If an error response is returned by Amazon * SQS indicating either a problem with the data in the request, * or a server side issue. */ public Future* Returns a list of your queues that have the RedrivePolicy queue attribute * configured with a dead letter queue. *
** For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer * Guide. *
* * @param listDeadLetterSourceQueuesRequest * @return A Java Future object containing the response from the * ListDeadLetterSourceQueues service method, as returned by Amazon * SQS. * @throws QueueDoesNotExistException * @throws 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. * @throws AmazonServiceException If an error response is returned by Amazon * SQS indicating either a problem with the data in the request, * or a server side issue. */ public Future
* 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.
*
* 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.
*
* Deletes the messages in a queue specified by the queue URL. *
*
* When you use the PurgeQueue API, the deleted messages in the
* queue can't be retrieved.
*
* When you purge a queue, the message deletion process takes up to 60
* seconds. All messages sent to the queue before calling
* PurgeQueue will be deleted; messages sent to the queue while
* it is being purged might be deleted. While the queue is being purged,
* messages sent to the queue before PurgeQueue was called
* might be received, but will be deleted within the next minute.
*
* Deletes the messages in a queue specified by the queue URL. *
*
* When you use the PurgeQueue API, the deleted messages in the
* queue can't be retrieved.
*
* When you purge a queue, the message deletion process takes up to 60
* seconds. All messages sent to the queue before calling
* PurgeQueue will be deleted; messages sent to the queue while
* it is being purged might be deleted. While the queue is being purged,
* messages sent to the queue before PurgeQueue was called
* might be received, but will be deleted within the next minute.
*
* 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, see RFC1321. *
** 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 don't include the parameter, the overall visibility
* timeout for the queue is used for the returned messages. For more
* information, see Visibility Timeout in the Amazon SQS Developer Guide.
*
* A message that is not deleted or a message whose visibility is not * extended before the visibility timeout expires counts as a failed * receive. Depending on the configuration of the queue, the message might * be sent to the dead letter queue. *
** 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. *
*
* 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, see RFC1321. *
** 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 don't include the parameter, the overall visibility
* timeout for the queue is used for the returned messages. For more
* information, see Visibility Timeout in the Amazon SQS Developer Guide.
*
* A message that is not deleted or a message whose visibility is not * extended before the visibility timeout expires counts as a failed * receive. Depending on the configuration of the queue, the message might * be sent to the dead letter queue. *
** 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. *
*
* Revokes any permissions in the queue policy that matches the specified
* Label parameter. Only the owner of the queue can remove
* permissions.
*
* Revokes any permissions in the queue policy that matches the specified
* Label parameter. Only the owner of the queue can remove
* permissions.
*
* Delivers a message to the specified queue. *
** The following list shows the characters (in Unicode) that are allowed in * your message, according to the W3C XML specification: *
*
* #x9 | #xA | #xD | [
* #x20 to #xD7FF] | [#xE000 to
* #xFFFD] | [#x10000 to #x10FFFF]
*
* For more information, see RFC1321. If you send any * characters that aren't included in this list, your request will be * rejected. *
** Delivers a message to the specified queue. *
** The following list shows the characters (in Unicode) that are allowed in * your message, according to the W3C XML specification: *
*
* #x9 | #xA | #xD | [
* #x20 to #xD7FF] | [#xE000 to
* #xFFFD] | [#x10000 to #x10FFFF]
*
* For more information, see RFC1321. If you send any * characters that aren't included in this list, your request will be * rejected. *
*
* Delivers up to ten messages to the specified queue. This is a batch
* version of SendMessage . For a FIFO queue, multiple
* messages within a single batch are enqueued in the order they are sent.
*
* The result of sending each message is reported individually in the * response. Because the batch request can result in a combination of * successful and unsuccessful actions, you should check for batch errors * even when the call returns an HTTP status code of 200. *
** The maximum allowed individual message size and the maximum total payload * size (the sum of the individual lengths of all of the batched messages) * are both 256 KB (262,144 bytes). *
** The following list shows the characters (in Unicode) that are allowed in * your message, according to the W3C XML specification: *
*
* #x9 | #xA | #xD | [
* #x20 to #xD7FF] | [#xE000 to
* #xFFFD] | [#x10000 to #x10FFFF]
*
* For more information, see RFC1321. If you send any * characters that aren't included in this list, your request will be * rejected. *
*
* If you don't specify the DelaySeconds parameter for an
* entry, Amazon SQS uses the default for the queue.
*
* 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
*
* Delivers up to ten messages to the specified queue. This is a batch
* version of SendMessage . For a FIFO queue, multiple
* messages within a single batch are enqueued in the order they are sent.
*
* The result of sending each message is reported individually in the * response. Because the batch request can result in a combination of * successful and unsuccessful actions, you should check for batch errors * even when the call returns an HTTP status code of 200. *
** The maximum allowed individual message size and the maximum total payload * size (the sum of the individual lengths of all of the batched messages) * are both 256 KB (262,144 bytes). *
** The following list shows the characters (in Unicode) that are allowed in * your message, according to the W3C XML specification: *
*
* #x9 | #xA | #xD | [
* #x20 to #xD7FF] | [#xE000 to
* #xFFFD] | [#x10000 to #x10FFFF]
*
* For more information, see RFC1321. If you send any * characters that aren't included in this list, your request will be * rejected. *
*
* If you don't specify the DelaySeconds parameter for an
* entry, Amazon SQS uses the default for the queue.
*
* 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
*
* 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.
*
* In the future, new attributes might be added. When you write code that * calls this action, we recommend structuring your code so that it can * handle new attributes gracefully. *
*
* 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.
*
* In the future, new attributes might be added. When you write code that * calls this action, we recommend structuring your code so that it can * handle new attributes gracefully. *
*