public class AbstractAmazonSQS extends Object implements AmazonSQS
AmazonSQS. Convenient method forms pass
through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
void |
addPermission(AddPermissionRequest request)
Adds a permission to a queue for a specific principal.
|
void |
addPermission(String queueUrl,
String label,
List<String> aWSAccountIds,
List<String> actions)
Simplified method form for invoking the AddPermission operation.
|
void |
changeMessageVisibility(ChangeMessageVisibilityRequest request)
Changes the visibility timeout of a specified message in a queue to a new
value.
|
void |
changeMessageVisibility(String queueUrl,
String receiptHandle,
Integer visibilityTimeout)
Simplified method form for invoking the ChangeMessageVisibility
operation.
|
ChangeMessageVisibilityBatchResult |
changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest request)
Changes the visibility timeout of multiple messages.
|
ChangeMessageVisibilityBatchResult |
changeMessageVisibilityBatch(String queueUrl,
List<ChangeMessageVisibilityBatchRequestEntry> entries)
Simplified method form for invoking the ChangeMessageVisibilityBatch
operation.
|
CreateQueueResult |
createQueue(CreateQueueRequest request)
Creates a new queue, or returns the URL of an existing one.
|
CreateQueueResult |
createQueue(String queueName)
Simplified method form for invoking the CreateQueue operation.
|
void |
deleteMessage(DeleteMessageRequest request)
Deletes the specified message from the specified queue.
|
void |
deleteMessage(String queueUrl,
String receiptHandle)
Simplified method form for invoking the DeleteMessage operation.
|
DeleteMessageBatchResult |
deleteMessageBatch(DeleteMessageBatchRequest request)
Deletes up to ten messages from the specified queue.
|
DeleteMessageBatchResult |
deleteMessageBatch(String queueUrl,
List<DeleteMessageBatchRequestEntry> entries)
Simplified method form for invoking the DeleteMessageBatch operation.
|
void |
deleteQueue(DeleteQueueRequest request)
Deletes the queue specified by the queue URL, regardless of
whether the queue is empty.
|
void |
deleteQueue(String queueUrl)
Simplified method form for invoking the DeleteQueue operation.
|
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 request)
Gets attributes for the specified queue.
|
GetQueueAttributesResult |
getQueueAttributes(String queueUrl,
List<String> attributeNames)
Simplified method form for invoking the GetQueueAttributes operation.
|
GetQueueUrlResult |
getQueueUrl(GetQueueUrlRequest request)
Returns the URL of an existing queue.
|
GetQueueUrlResult |
getQueueUrl(String queueName)
Simplified method form for invoking the GetQueueUrl operation.
|
ListDeadLetterSourceQueuesResult |
listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest request)
Returns a list of your queues that have the RedrivePolicy queue attribute
configured with a dead letter queue.
|
ListQueuesResult |
listQueues()
Simplified method form for invoking the ListQueues operation.
|
ListQueuesResult |
listQueues(ListQueuesRequest request)
Returns a list of your queues.
|
ListQueuesResult |
listQueues(String queueNamePrefix)
Simplified method form for invoking the ListQueues operation.
|
void |
purgeQueue(PurgeQueueRequest request)
Deletes the messages in a queue specified by the queue URL.
|
ReceiveMessageResult |
receiveMessage(ReceiveMessageRequest request)
Retrieves one or more messages, with a maximum limit of 10 messages, from
the specified queue.
|
ReceiveMessageResult |
receiveMessage(String queueUrl)
Simplified method form for invoking the ReceiveMessage operation.
|
void |
removePermission(RemovePermissionRequest request)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
void |
removePermission(String queueUrl,
String label)
Simplified method form for invoking the RemovePermission operation.
|
SendMessageResult |
sendMessage(SendMessageRequest request)
Delivers a message to the specified queue.
|
SendMessageResult |
sendMessage(String queueUrl,
String messageBody)
Simplified method form for invoking the SendMessage operation.
|
SendMessageBatchResult |
sendMessageBatch(SendMessageBatchRequest request)
Delivers up to ten messages to the specified queue.
|
SendMessageBatchResult |
sendMessageBatch(String queueUrl,
List<SendMessageBatchRequestEntry> entries)
Simplified method form for invoking the SendMessageBatch operation.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("https://sqs.us-east-1.amazonaws.com").
|
void |
setQueueAttributes(SetQueueAttributesRequest request)
Sets the value of one or more queue attributes.
|
void |
setQueueAttributes(String queueUrl,
Map<String,String> attributes)
Simplified method form for invoking the SetQueueAttributes operation.
|
void |
setRegion(Region region)
An alternative to
AmazonSQS.setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
public void setEndpoint(String endpoint)
AmazonSQS
Callers can pass in just the endpoint (ex: "sqs.us-east-1.amazonaws.com")
or a full URL, including the protocol (ex:
"https://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.
setEndpoint in interface AmazonSQSendpoint - The endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://sqs.us-east-1.amazonaws.com")
of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonSQSAmazonSQS.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.
setRegion in interface AmazonSQSregion - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public void addPermission(AddPermissionRequest request)
AmazonSQSAdds 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.
param.n notation. Values of
n are integers starting from 1. For example, a parameter
list with two elements looks like this:
addPermission in interface AmazonSQSpublic void addPermission(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions)
AmazonSQSaddPermission in interface AmazonSQSAmazonSQS.addPermission(AddPermissionRequest)public void changeMessageVisibility(ChangeMessageVisibilityRequest request)
AmazonSQSChanges 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.
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.ChangeMessageVisibility action.changeMessageVisibility in interface AmazonSQSpublic void changeMessageVisibility(String queueUrl, String receiptHandle, Integer visibilityTimeout)
AmazonSQSchangeMessageVisibility in interface AmazonSQSAmazonSQS.changeMessageVisibility(ChangeMessageVisibilityRequest)public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest request)
AmazonSQS
Changes the visibility timeout of multiple messages. This is a batch
version of ChangeMessageVisibility. The result of the action on
each message is reported individually in the response. You can send up to
10 ChangeMessageVisibility requests with each
ChangeMessageVisibilityBatch action.
param.n notation. Values of
n are integers starting from 1. For example, a parameter
list with two elements looks like this:
changeMessageVisibilityBatch in interface AmazonSQSpublic ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries)
AmazonSQSchangeMessageVisibilityBatch in interface AmazonSQSAmazonSQS.changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest)public CreateQueueResult createQueue(CreateQueueRequest request)
AmazonSQS
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.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes.
Use GetQueueUrl to get a queue's URL. GetQueueUrl requires
only the QueueName parameter.
If you provide the name of an existing queue, along with the exact names
and values of all the queue's attributes, CreateQueue
returns the queue URL for the existing queue. If the queue name,
attribute names, or attribute values do not match an existing queue,
CreateQueue returns an error.
param.n notation. Values of
n are integers starting from 1. For example, a parameter
list with two elements looks like this:
createQueue in interface AmazonSQSpublic CreateQueueResult createQueue(String queueName)
AmazonSQScreateQueue in interface AmazonSQSAmazonSQS.createQueue(CreateQueueRequest)public void deleteMessage(DeleteMessageRequest request)
AmazonSQS
Deletes the specified message from the specified queue. You specify the
message by using the message's receipt handle and not the
message ID you received when you sent the message. Even if
the message is locked by another reader due to the visibility timeout
setting, it is still deleted from the queue. If you leave a message in
the queue for longer than the queue's configured retention period, Amazon
SQS automatically deletes it.
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.
deleteMessage in interface AmazonSQSpublic void deleteMessage(String queueUrl, String receiptHandle)
AmazonSQSdeleteMessage in interface AmazonSQSAmazonSQS.deleteMessage(DeleteMessageRequest)public DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest request)
AmazonSQSDeletes 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.
param.n notation. Values of
n are integers starting from 1. For example, a parameter
list with two elements looks like this:
deleteMessageBatch in interface AmazonSQSpublic DeleteMessageBatchResult deleteMessageBatch(String queueUrl, List<DeleteMessageBatchRequestEntry> entries)
AmazonSQSdeleteMessageBatch in interface AmazonSQSAmazonSQS.deleteMessageBatch(DeleteMessageBatchRequest)public void deleteQueue(DeleteQueueRequest request)
AmazonSQSDeletes the queue specified by the queue URL, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response.
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.
deleteQueue in interface AmazonSQSpublic void deleteQueue(String queueUrl)
AmazonSQSdeleteQueue in interface AmazonSQSAmazonSQS.deleteQueue(DeleteQueueRequest)public GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest request)
AmazonSQSGets attributes for the specified queue. The following attributes are supported:
All - returns all values.ApproximateNumberOfMessages - returns the approximate
number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.ApproximateNumberOfMessagesNotVisible - returns the
approximate number of messages that are not timed-out and not deleted.
For more information, see Resources Required to Process Messages in the Amazon SQS
Developer Guide.VisibilityTimeout - returns the visibility timeout for
the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.CreatedTimestamp - returns the time when the queue was
created (epoch time in seconds).LastModifiedTimestamp - returns the time when the queue
was last changed (epoch time in seconds).Policy - returns the queue's policy.MaximumMessageSize - returns the limit of how many bytes
a message can contain before Amazon SQS rejects it.MessageRetentionPeriod - returns the number of seconds
Amazon SQS retains a message.QueueArn - returns the queue's Amazon resource name
(ARN).ApproximateNumberOfMessagesDelayed - returns the
approximate number of messages that are pending to be added to the queue.
DelaySeconds - returns the default delay on the queue in
seconds.ReceiveMessageWaitTimeSeconds - returns the time for
which a ReceiveMessage call will wait for a message to arrive.RedrivePolicy - returns the parameters for dead letter
queue functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer
Guide.param.n notation. Values of n are integers
starting from 1. For example, a parameter list with two elements looks
like this:
getQueueAttributes in interface AmazonSQSpublic GetQueueAttributesResult getQueueAttributes(String queueUrl, List<String> attributeNames)
AmazonSQSgetQueueAttributes in interface AmazonSQSAmazonSQS.getQueueAttributes(GetQueueAttributesRequest)public GetQueueUrlResult getQueueUrl(GetQueueUrlRequest request)
AmazonSQSReturns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.
To access a queue that belongs to another AWS account, use the
QueueOwnerAWSAccountId parameter to specify the account ID
of the queue's owner. The queue's owner must grant you permission to
access the queue. For more information about shared queue access, see
AddPermission or go to Shared Queues in the Amazon SQS Developer Guide.
getQueueUrl in interface AmazonSQSpublic GetQueueUrlResult getQueueUrl(String queueName)
AmazonSQSgetQueueUrl in interface AmazonSQSAmazonSQS.getQueueUrl(GetQueueUrlRequest)public ListDeadLetterSourceQueuesResult listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest request)
AmazonSQSReturns 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.
listDeadLetterSourceQueues in interface AmazonSQSpublic ListQueuesResult listQueues(ListQueuesRequest request)
AmazonSQS
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.
listQueues in interface AmazonSQSpublic ListQueuesResult listQueues()
AmazonSQSlistQueues in interface AmazonSQSAmazonSQS.listQueues(ListQueuesRequest)public ListQueuesResult listQueues(String queueNamePrefix)
AmazonSQSlistQueues in interface AmazonSQSAmazonSQS.listQueues(ListQueuesRequest)public void purgeQueue(PurgeQueueRequest request)
AmazonSQSDeletes the messages in a queue specified by the queue URL.
PurgeQueue API, the deleted
messages in the queue cannot 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 may be deleted. While the queue is being purged,
messages sent to the queue before PurgeQueue was called may
be received, but will be deleted within the next minute.
purgeQueue in interface AmazonSQSpublic ReceiveMessageResult receiveMessage(ReceiveMessageRequest request)
AmazonSQS
Retrieves one or more messages, with a maximum limit of 10 messages, from
the specified queue. Long poll support is enabled by using the
WaitTimeSeconds parameter. For more information, see Amazon SQS Long Poll in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of
machines is sampled on a ReceiveMessage call. This means
only the messages on the sampled machines are returned. If the number of
messages in the queue is small (less than 1000), it is likely you will
get fewer messages than you requested per ReceiveMessage
call. If the number of messages in the queue is extremely small, you
might not receive any messages in a particular
ReceiveMessage response; in which case you should repeat the
request.
For each message returned, the response includes the following:
Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your
request, which will be applied to the messages that Amazon SQS returns in
the response. If you do not include the parameter, the overall visibility
timeout for the queue is used for the returned messages. For more
information, see Visibility Timeout in the Amazon SQS Developer Guide.
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.
receiveMessage in interface AmazonSQSpublic ReceiveMessageResult receiveMessage(String queueUrl)
AmazonSQSreceiveMessage in interface AmazonSQSAmazonSQS.receiveMessage(ReceiveMessageRequest)public void removePermission(RemovePermissionRequest request)
AmazonSQS
Revokes any permissions in the queue policy that matches the specified
Label parameter. Only the owner of the queue can remove
permissions.
removePermission in interface AmazonSQSpublic void removePermission(String queueUrl, String label)
AmazonSQSremovePermission in interface AmazonSQSAmazonSQS.removePermission(RemovePermissionRequest)public SendMessageResult sendMessage(SendMessageRequest request)
AmazonSQSDelivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC -xml/#charsets If you send any characters not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
sendMessage in interface AmazonSQSpublic SendMessageResult sendMessage(String queueUrl, String messageBody)
AmazonSQSsendMessage in interface AmazonSQSAmazonSQS.sendMessage(SendMessageRequest)public SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest request)
AmazonSQSDelivers up to ten messages to the specified queue. This is a batch version of SendMessage. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes).
The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
If the DelaySeconds parameter is not specified for an entry,
the default for the queue is used.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
param.n notation. Values of
n are integers starting from 1. For example, a parameter
list with two elements looks like this:
sendMessageBatch in interface AmazonSQSpublic SendMessageBatchResult sendMessageBatch(String queueUrl, List<SendMessageBatchRequestEntry> entries)
AmazonSQSsendMessageBatch in interface AmazonSQSAmazonSQS.sendMessageBatch(SendMessageBatchRequest)public void setQueueAttributes(SetQueueAttributesRequest request)
AmazonSQS
Sets the value of one or more queue attributes. When you change a queue's
attributes, the change can take up to 60 seconds for most of the
attributes to propagate throughout the SQS system. Changes made to the
MessageRetentionPeriod attribute can take up to 15 minutes.
setQueueAttributes in interface AmazonSQSpublic void setQueueAttributes(String queueUrl, Map<String,String> attributes)
AmazonSQSsetQueueAttributes in interface AmazonSQSAmazonSQS.setQueueAttributes(SetQueueAttributesRequest)public void shutdown()
AmazonSQSpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonSQSResponse 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.
getCachedResponseMetadata in interface AmazonSQSrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.