/* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.sqs; import java.util.concurrent.Future; import com.amazonaws.AmazonClientException; import com.amazonaws.AmazonServiceException; import com.amazonaws.handlers.AsyncHandler; import com.amazonaws.services.sqs.model.*; /** * Interface for accessing Amazon SQS asynchronously. *

* 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 *

* *

* 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: *

* *

* For a list of available SDKs, see Tools for Amazon Web Services. *

**/ public interface AmazonSQSAsync extends AmazonSQS { /** *

* 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 *

* * @param addPermissionRequest

* @return A Java Future object containing the response from the * AddPermission service method, as returned by Amazon SQS. * @throws OverLimitException * @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. */ Future addPermissionAsync(AddPermissionRequest addPermissionRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param addPermissionRequest

* @param 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. * @return A Java Future object containing the response from the * AddPermission service method, as returned by Amazon SQS. * @throws OverLimitException * @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. */ Future addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param changeMessageVisibilityRequest * @return A Java Future object containing the response from the * ChangeMessageVisibility service method, as returned by Amazon * SQS. * @throws MessageNotInflightException * @throws ReceiptHandleIsInvalidException * @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. */ Future changeMessageVisibilityAsync( ChangeMessageVisibilityRequest changeMessageVisibilityRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param changeMessageVisibilityRequest * @param 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. * @return A Java Future object containing the response from the * ChangeMessageVisibility service method, as returned by Amazon * SQS. * @throws MessageNotInflightException * @throws ReceiptHandleIsInvalidException * @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. */ Future changeMessageVisibilityAsync( ChangeMessageVisibilityRequest changeMessageVisibilityRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param changeMessageVisibilityBatchRequest

* @return A Java Future object containing the response from the * ChangeMessageVisibilityBatch service method, as returned by * Amazon SQS. * @throws TooManyEntriesInBatchRequestException * @throws EmptyBatchRequestException * @throws BatchEntryIdsNotDistinctException * @throws InvalidBatchEntryIdException * @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. */ Future changeMessageVisibilityBatchAsync( ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param changeMessageVisibilityBatchRequest

* @param 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. * @return A Java Future object containing the response from the * ChangeMessageVisibilityBatch service method, as returned by * Amazon SQS. * @throws TooManyEntriesInBatchRequestException * @throws EmptyBatchRequestException * @throws BatchEntryIdsNotDistinctException * @throws InvalidBatchEntryIdException * @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. */ Future changeMessageVisibilityBatchAsync( ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param createQueueRequest

* @return A Java Future object containing the response from the CreateQueue * service method, as returned by Amazon SQS. * @throws QueueDeletedRecentlyException * @throws QueueNameExistsException * @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. */ Future createQueueAsync(CreateQueueRequest createQueueRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param createQueueRequest

* @param 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. * @return A Java Future object containing the response from the CreateQueue * service method, as returned by Amazon SQS. * @throws QueueDeletedRecentlyException * @throws QueueNameExistsException * @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. */ Future createQueueAsync(CreateQueueRequest createQueueRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param deleteMessageRequest

* @return A Java Future object containing the response from the * DeleteMessage service method, as returned by Amazon SQS. * @throws InvalidIdFormatException * @throws ReceiptHandleIsInvalidException * @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. */ Future deleteMessageAsync(DeleteMessageRequest deleteMessageRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param deleteMessageRequest

* @param 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. * @return A Java Future object containing the response from the * DeleteMessage service method, as returned by Amazon SQS. * @throws InvalidIdFormatException * @throws ReceiptHandleIsInvalidException * @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. */ Future deleteMessageAsync(DeleteMessageRequest deleteMessageRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param deleteMessageBatchRequest

* @return A Java Future object containing the response from the * DeleteMessageBatch service method, as returned by Amazon SQS. * @throws TooManyEntriesInBatchRequestException * @throws EmptyBatchRequestException * @throws BatchEntryIdsNotDistinctException * @throws InvalidBatchEntryIdException * @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. */ Future deleteMessageBatchAsync( DeleteMessageBatchRequest deleteMessageBatchRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param deleteMessageBatchRequest

* @param 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. * @return A Java Future object containing the response from the * DeleteMessageBatch service method, as returned by Amazon SQS. * @throws TooManyEntriesInBatchRequestException * @throws EmptyBatchRequestException * @throws BatchEntryIdsNotDistinctException * @throws InvalidBatchEntryIdException * @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. */ Future deleteMessageBatchAsync( DeleteMessageBatchRequest deleteMessageBatchRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. */ Future deleteQueueAsync(DeleteQueueRequest deleteQueueRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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

* @param 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. * @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. */ Future deleteQueueAsync(DeleteQueueRequest deleteQueueRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param getQueueAttributesRequest

* @return A Java Future object containing the response from the * GetQueueAttributes service method, as returned by Amazon SQS. * @throws InvalidAttributeNameException * @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. */ Future getQueueAttributesAsync( GetQueueAttributesRequest getQueueAttributesRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param getQueueAttributesRequest

* @param 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. * @return A Java Future object containing the response from the * GetQueueAttributes service method, as returned by Amazon SQS. * @throws InvalidAttributeNameException * @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. */ Future getQueueAttributesAsync( GetQueueAttributesRequest getQueueAttributesRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

* * @param getQueueUrlRequest

* @return A Java Future object containing the response from the GetQueueUrl * 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. */ Future getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

* * @param getQueueUrlRequest

* @param 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. * @return A Java Future object containing the response from the GetQueueUrl * 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. */ Future getQueueUrlAsync(GetQueueUrlRequest getQueueUrlRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. */ Future listDeadLetterSourceQueuesAsync( ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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

* @param 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. * @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. */ Future listDeadLetterSourceQueuesAsync( ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

* * @param listQueuesRequest

* @return A Java Future object containing the response from the ListQueues * 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. */ Future listQueuesAsync(ListQueuesRequest listQueuesRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

* * @param listQueuesRequest

* @param 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. * @return A Java Future object containing the response from the ListQueues * 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. */ Future listQueuesAsync(ListQueuesRequest listQueuesRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

* * @param purgeQueueRequest

* @return A Java Future object containing the response from the PurgeQueue * service method, as returned by Amazon SQS. * @throws QueueDoesNotExistException * @throws PurgeQueueInProgressException * @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. */ Future purgeQueueAsync(PurgeQueueRequest purgeQueueRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

* * @param purgeQueueRequest

* @param 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. * @return A Java Future object containing the response from the PurgeQueue * service method, as returned by Amazon SQS. * @throws QueueDoesNotExistException * @throws PurgeQueueInProgressException * @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. */ Future purgeQueueAsync(PurgeQueueRequest purgeQueueRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param receiveMessageRequest

* @return A Java Future object containing the response from the * ReceiveMessage service method, as returned by Amazon SQS. * @throws OverLimitException * @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. */ Future receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param receiveMessageRequest

* @param 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. * @return A Java Future object containing the response from the * ReceiveMessage service method, as returned by Amazon SQS. * @throws OverLimitException * @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. */ Future receiveMessageAsync(ReceiveMessageRequest receiveMessageRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

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

* * @param removePermissionRequest

* @return A Java Future object containing the response from the * RemovePermission 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. */ Future removePermissionAsync(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException; /** *

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

* * @param removePermissionRequest

* @param 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. * @return A Java Future object containing the response from the * RemovePermission 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. */ Future removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param sendMessageRequest

* @return A Java Future object containing the response from the SendMessage * service method, as returned by Amazon SQS. * @throws InvalidMessageContentsException * @throws UnsupportedOperationException * @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. */ Future sendMessageAsync(SendMessageRequest sendMessageRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param sendMessageRequest

* @param 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. * @return A Java Future object containing the response from the SendMessage * service method, as returned by Amazon SQS. * @throws InvalidMessageContentsException * @throws UnsupportedOperationException * @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. */ Future sendMessageAsync(SendMessageRequest sendMessageRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param sendMessageBatchRequest

* @return A Java Future object containing the response from the * SendMessageBatch service method, as returned by Amazon SQS. * @throws TooManyEntriesInBatchRequestException * @throws EmptyBatchRequestException * @throws BatchEntryIdsNotDistinctException * @throws BatchRequestTooLongException * @throws InvalidBatchEntryIdException * @throws UnsupportedOperationException * @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. */ Future sendMessageBatchAsync( SendMessageBatchRequest sendMessageBatchRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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 *

* * @param sendMessageBatchRequest

* @param 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. * @return A Java Future object containing the response from the * SendMessageBatch service method, as returned by Amazon SQS. * @throws TooManyEntriesInBatchRequestException * @throws EmptyBatchRequestException * @throws BatchEntryIdsNotDistinctException * @throws BatchRequestTooLongException * @throws InvalidBatchEntryIdException * @throws UnsupportedOperationException * @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. */ Future sendMessageBatchAsync( SendMessageBatchRequest sendMessageBatchRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param setQueueAttributesRequest

* @return A Java Future object containing the response from the * SetQueueAttributes service method, as returned by Amazon SQS. * @throws InvalidAttributeNameException * @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. */ Future setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest) throws AmazonServiceException, AmazonClientException; /** *

* 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. *

*
* * @param setQueueAttributesRequest

* @param 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. * @return A Java Future object containing the response from the * SetQueueAttributes service method, as returned by Amazon SQS. * @throws InvalidAttributeNameException * @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. */ Future setQueueAttributesAsync(SetQueueAttributesRequest setQueueAttributesRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; }