com.amazonaws.services.sqs
Class AmazonSQSClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.sqs.AmazonSQSClient

All Implemented Interfaces:

AmazonSQS

Direct Known Subclasses:

AmazonSQSAsyncClient

public class AmazonSQSClient
extends AmazonWebServiceClient
implements AmazonSQS

Client for accessing AmazonSQS. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Simple Queue Service

Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable, hosted queue for storing messages as they travel between computers. By using Amazon SQS, developers can simply move data between distributed components of their applications that perform different tasks, without losing messages or requiring each component to be always available. Amazon SQS makes it easy to build an automated workflow, working in close conjunction with the Amazon Elastic Compute Cloud (Amazon EC2) and the other AWS infrastructure web services.

Amazon SQS works by exposing Amazon's web-scale messaging infrastructure as a web service. Any computer on the Internet can add or read messages without any installed software or special firewall configurations. Components of applications using Amazon SQS can run independently, and do not need to be on the same network, developed with the same technologies, or running at the same time.

Visit http://aws.amazon.com/sqs/ for more information.

Constructor Summary

AmazonSQSClient()
Constructs a new client to invoke service methods on AmazonSQS.

AmazonSQSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials.

AmazonSQSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials and client configuration options.

AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials provider.

AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials provider and client configuration options.

AmazonSQSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonSQS.

Method Summary

void	addPermission(AddPermissionRequest addPermissionRequest) The AddPermission action adds a permission to a queue for a specific principal .
void	changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest) The ChangeMessageVisibility action changes the visibility timeout of a specified message in a queue to a new value.
ChangeMessageVisibilityBatchResult	changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest) This is a batch version of ChangeMessageVisibility.
CreateQueueResult	createQueue(CreateQueueRequest createQueueRequest) The CreateQueue action creates a new queue, or returns the URL of an existing one.
void	deleteMessage(DeleteMessageRequest deleteMessageRequest) The DeleteMessage action unconditionally removes the specified message from the specified queue.
DeleteMessageBatchResult	deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest) This is a batch version of DeleteMessage.
void	deleteQueue(DeleteQueueRequest deleteQueueRequest) This action unconditionally deletes the queue specified by the queue URL.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetQueueAttributesResult	getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest) Gets attributes for the specified queue.
GetQueueUrlResult	getQueueUrl(GetQueueUrlRequest getQueueUrlRequest) The GetQueueUrl action returns the URL of an existing queue.
ListQueuesResult	listQueues() Returns a list of your queues.
ListQueuesResult	listQueues(ListQueuesRequest listQueuesRequest) Returns a list of your queues.
ReceiveMessageResult	receiveMessage(ReceiveMessageRequest receiveMessageRequest) Retrieves one or more messages from the specified queue, including the message body and message ID of each message.
void	removePermission(RemovePermissionRequest removePermissionRequest) The RemovePermission action revokes any permissions in the queue policy that matches the specified Label parameter.
SendMessageResult	sendMessage(SendMessageRequest sendMessageRequest) The SendMessage action delivers a message to the specified queue.
SendMessageBatchResult	sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest) This is a batch version of SendMessage.
void	setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest) Sets an attribute of a queue.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, shutdown

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.sqs.AmazonSQS

setEndpoint, shutdown

Constructor Detail

AmazonSQSClient

public AmazonSQSClient()

Constructs a new client to invoke service methods on AmazonSQS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProvider

AmazonSQSClient

public AmazonSQSClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSQS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonSQS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProvider

AmazonSQSClient

public AmazonSQSClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonSQSClient

public AmazonSQSClient(AWSCredentials awsCredentials,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSQS (ex: proxy settings, retry counts, etc.).

AmazonSQSClient

public AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonSQSClient

public AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonSQS (ex: proxy settings, retry counts, etc.).

Method Detail

setQueueAttributes

public void setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Sets an attribute of a queue. The set of attributes that can be set are - DelaySeconds, MessageRetentionPeriod, MaximumMessageSize, VisibilityTimeout and Policy.

Specified by:

setQueueAttributes in interface AmazonSQS

Parameters:

setQueueAttributesRequest - Container for the necessary parameters to execute the SetQueueAttributes service method on AmazonSQS.

Throws:

InvalidAttributeNameException

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.

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

changeMessageVisibilityBatch

public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

This is a batch version of ChangeMessageVisibility. It takes multiple receipt handles and performs the operation on each of the them. The result of the operation on each message is reported individually in the response.

Specified by:

changeMessageVisibilityBatch in interface AmazonSQS

Parameters:

changeMessageVisibilityBatchRequest - Container for the necessary parameters to execute the ChangeMessageVisibilityBatch service method on AmazonSQS.

Returns:

The response from the ChangeMessageVisibilityBatch service method, as returned by AmazonSQS.

Throws:

BatchEntryIdsNotDistinctException

TooManyEntriesInBatchRequestException

InvalidBatchEntryIdException

EmptyBatchRequestException

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.

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

changeMessageVisibility

public void changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

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 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes.

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

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

Specified by:

changeMessageVisibility in interface AmazonSQS

Parameters:

changeMessageVisibilityRequest - Container for the necessary parameters to execute the ChangeMessageVisibility service method on AmazonSQS.

Throws:

ReceiptHandleIsInvalidException

MessageNotInflightException

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.

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

getQueueUrl

public GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

The GetQueueUrl action returns the URL of an existing queue.

Specified by:

getQueueUrl in interface AmazonSQS

Parameters:

getQueueUrlRequest - Container for the necessary parameters to execute the GetQueueUrl service method on AmazonSQS.

Returns:

The response from the GetQueueUrl service method, as returned by AmazonSQS.

Throws:

QueueDoesNotExistException

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.

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

removePermission

public void removePermission(RemovePermissionRequest removePermissionRequest)
                      throws AmazonServiceException,
                             AmazonClientException

The RemovePermission action revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Specified by:

removePermission in interface AmazonSQS

Parameters:

removePermissionRequest - Container for the necessary parameters to execute the RemovePermission service method on AmazonSQS.

Throws:

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.

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

getQueueAttributes

public GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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

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

Specified by:

getQueueAttributes in interface AmazonSQS

Parameters:

getQueueAttributesRequest - Container for the necessary parameters to execute the GetQueueAttributes service method on AmazonSQS.

Returns:

The response from the GetQueueAttributes service method, as returned by AmazonSQS.

Throws:

InvalidAttributeNameException

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.

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

sendMessageBatch

public SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

This is a batch version of SendMessage. It takes multiple messages and adds each of them to the queue. The result of each add operation is reported individually in the response.

Specified by:

sendMessageBatch in interface AmazonSQS

Parameters:

sendMessageBatchRequest - Container for the necessary parameters to execute the SendMessageBatch service method on AmazonSQS.

Returns:

The response from the SendMessageBatch service method, as returned by AmazonSQS.

Throws:

BatchEntryIdsNotDistinctException

TooManyEntriesInBatchRequestException

BatchRequestTooLongException

InvalidBatchEntryIdException

EmptyBatchRequestException

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.

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

deleteQueue

public void deleteQueue(DeleteQueueRequest deleteQueueRequest)
                 throws AmazonServiceException,
                        AmazonClientException

This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty.

Once a queue has been deleted, the queue name is unavailable for use with new queues for 60 seconds.

Specified by:

deleteQueue in interface AmazonSQS

Parameters:

deleteQueueRequest - Container for the necessary parameters to execute the DeleteQueue service method on AmazonSQS.

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.

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

sendMessage

public SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

The SendMessage action delivers a message to the specified queue.

Specified by:

sendMessage in interface AmazonSQS

Parameters:

sendMessageRequest - Container for the necessary parameters to execute the SendMessage service method on AmazonSQS.

Returns:

The response from the SendMessage service method, as returned by AmazonSQS.

Throws:

InvalidMessageContentsException

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.

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

receiveMessage

public ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Retrieves one or more messages from the specified queue, including the message body and message ID of each message. Messages returned by this action stay in the queue until you delete them. However, once a message is returned to a ReceiveMessage request, it is not returned on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout . If you do not specify a VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.

Specified by:

receiveMessage in interface AmazonSQS

Parameters:

receiveMessageRequest - Container for the necessary parameters to execute the ReceiveMessage service method on AmazonSQS.

Returns:

The response from the ReceiveMessage service method, as returned by AmazonSQS.

Throws:

OverLimitException

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.

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

listQueues

public ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Returns a list of your queues.

Specified by:

listQueues in interface AmazonSQS

Parameters:

listQueuesRequest - Container for the necessary parameters to execute the ListQueues service method on AmazonSQS.

Returns:

The response from the ListQueues service method, as returned by AmazonSQS.

Throws:

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.

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

deleteMessageBatch

public DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

This is a batch version of DeleteMessage. It takes multiple receipt handles and deletes each one of the messages. The result of the delete operation on each message is reported individually in the response.

Specified by:

deleteMessageBatch in interface AmazonSQS

Parameters:

deleteMessageBatchRequest - Container for the necessary parameters to execute the DeleteMessageBatch service method on AmazonSQS.

Returns:

The response from the DeleteMessageBatch service method, as returned by AmazonSQS.

Throws:

BatchEntryIdsNotDistinctException

TooManyEntriesInBatchRequestException

InvalidBatchEntryIdException

EmptyBatchRequestException

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.

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

createQueue

public CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

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

If you provide the name of an existing queue, a new queue isn't created. If the values of attributes provided with the request match up with those on the existing queue, the queue URL is returned. Otherwise, a QueueNameExists error is returned.

Specified by:

createQueue in interface AmazonSQS

Parameters:

createQueueRequest - Container for the necessary parameters to execute the CreateQueue service method on AmazonSQS.

Returns:

The response from the CreateQueue service method, as returned by AmazonSQS.

Throws:

QueueNameExistsException

QueueDeletedRecentlyException

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.

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

addPermission

public void addPermission(AddPermissionRequest addPermissionRequest)
                   throws AmazonServiceException,
                          AmazonClientException

The AddPermission action 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 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 Appendix: The Access Policy Language in the Amazon SQS Developer Guide.

Specified by:

addPermission in interface AmazonSQS

Parameters:

addPermissionRequest - Container for the necessary parameters to execute the AddPermission service method on AmazonSQS.

Throws:

OverLimitException

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.

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

deleteMessage

public void deleteMessage(DeleteMessageRequest deleteMessageRequest)
                   throws AmazonServiceException,
                          AmazonClientException

The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.

Specified by:

deleteMessage in interface AmazonSQS

Parameters:

deleteMessageRequest - Container for the necessary parameters to execute the DeleteMessage service method on AmazonSQS.

Throws:

ReceiptHandleIsInvalidException

InvalidIdFormatException

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.

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

listQueues

public ListQueuesResult listQueues()
                            throws AmazonServiceException,
                                   AmazonClientException

Returns a list of your queues.

Specified by:

listQueues in interface AmazonSQS

Returns:

The response from the ListQueues service method, as returned by AmazonSQS.

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.

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

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonSQS

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.