com.amazonaws.services.sqs
Interface AmazonSQS

All Known Subinterfaces:

AmazonSQSAsync

All Known Implementing Classes:

AmazonSQSAsyncClient, AmazonSQSBufferedAsyncClient, AmazonSQSClient

public interface AmazonSQS

Interface for accessing AmazonSQS.

Method Summary

void	addPermission(AddPermissionRequest addPermissionRequest)
void	changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
ChangeMessageVisibilityBatchResult	changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
CreateQueueResult	createQueue(CreateQueueRequest createQueueRequest)
void	deleteMessage(DeleteMessageRequest deleteMessageRequest)
DeleteMessageBatchResult	deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
void	deleteQueue(DeleteQueueRequest deleteQueueRequest)
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)
GetQueueUrlResult	getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
ListQueuesResult	listQueues()
ListQueuesResult	listQueues(ListQueuesRequest listQueuesRequest)
ReceiveMessageResult	receiveMessage(ReceiveMessageRequest receiveMessageRequest)
void	removePermission(RemovePermissionRequest removePermissionRequest)
SendMessageResult	sendMessage(SendMessageRequest sendMessageRequest)
SendMessageBatchResult	sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("sqs.us-east-1.amazonaws.com").
void	setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

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

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

Callers can pass in just the endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "sqs.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "sqs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

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

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

setQueueAttributes

void setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
                        throws AmazonServiceException,
                               AmazonClientException

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

ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

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

void changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

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

GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

void removePermission(RemovePermissionRequest removePermissionRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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

GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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

SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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

void deleteQueue(DeleteQueueRequest deleteQueueRequest)
                 throws AmazonServiceException,
                        AmazonClientException

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

SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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

DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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

CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

void addPermission(AddPermissionRequest addPermissionRequest)
                   throws AmazonServiceException,
                          AmazonClientException

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

void deleteMessage(DeleteMessageRequest deleteMessageRequest)
                   throws AmazonServiceException,
                          AmazonClientException

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

ListQueuesResult listQueues()
                            throws AmazonServiceException,
                                   AmazonClientException

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.

shutdown

void shutdown()

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

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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