public class AmazonSQSExtendedClient extends Object implements com.amazonaws.services.sqs.AmazonSQS
The Amazon SQS extended client enables sending and receiving large messages via Amazon S3. You can use this library to:
| Constructor and Description |
|---|
AmazonSQSExtendedClient(com.amazonaws.services.sqs.AmazonSQS sqsClient)
Constructs a new Amazon SQS extended client to invoke service methods on
Amazon SQS with extended functionality using the specified Amazon SQS
client object.
|
AmazonSQSExtendedClient(com.amazonaws.services.sqs.AmazonSQS sqsClient,
ExtendedClientConfiguration extendedClientConfig)
Constructs a new Amazon SQS extended client to invoke service methods on
Amazon SQS with extended functionality using the specified Amazon SQS
client object.
|
| Modifier and Type | Method and Description |
|---|---|
com.amazonaws.services.sqs.model.AddPermissionResult |
addPermission(com.amazonaws.services.sqs.model.AddPermissionRequest addPermissionRequest)
Adds a permission to a queue for a specific
principal .
|
com.amazonaws.services.sqs.model.AddPermissionResult |
addPermission(String queueUrl,
String label,
List<String> aWSAccountIds,
List<String> actions)
Adds a permission to a queue for a specific
principal .
|
com.amazonaws.services.sqs.model.ChangeMessageVisibilityResult |
changeMessageVisibility(com.amazonaws.services.sqs.model.ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new
value.
|
com.amazonaws.services.sqs.model.ChangeMessageVisibilityResult |
changeMessageVisibility(String queueUrl,
String receiptHandle,
Integer visibilityTimeout)
Simplified method form for invoking the ChangeMessageVisibility
operation.
|
com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResult |
changeMessageVisibilityBatch(com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
Changes the visibility timeout of multiple messages.
|
com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResult |
changeMessageVisibilityBatch(String queueUrl,
List<com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequestEntry> entries)
Simplified method form for invoking the ChangeMessageVisibilityBatch
operation.
|
com.amazonaws.services.sqs.model.CreateQueueResult |
createQueue(com.amazonaws.services.sqs.model.CreateQueueRequest createQueueRequest)
Creates a new queue, or returns the URL of an existing one.
|
com.amazonaws.services.sqs.model.CreateQueueResult |
createQueue(String queueName)
Creates a new queue, or returns the URL of an existing one.
|
com.amazonaws.services.sqs.model.DeleteMessageResult |
deleteMessage(com.amazonaws.services.sqs.model.DeleteMessageRequest deleteMessageRequest)
Deletes the specified message from the specified queue and deletes the
message payload from Amazon S3 when necessary.
|
com.amazonaws.services.sqs.model.DeleteMessageResult |
deleteMessage(String queueUrl,
String receiptHandle)
Deletes the specified message from the specified queue and deletes the
message payload from Amazon S3 when necessary.
|
com.amazonaws.services.sqs.model.DeleteMessageBatchResult |
deleteMessageBatch(com.amazonaws.services.sqs.model.DeleteMessageBatchRequest deleteMessageBatchRequest)
Deletes up to ten messages from the specified queue.
|
com.amazonaws.services.sqs.model.DeleteMessageBatchResult |
deleteMessageBatch(String queueUrl,
List<com.amazonaws.services.sqs.model.DeleteMessageBatchRequestEntry> entries)
Deletes up to ten messages from the specified queue.
|
com.amazonaws.services.sqs.model.DeleteQueueResult |
deleteQueue(com.amazonaws.services.sqs.model.DeleteQueueRequest deleteQueueRequest)
Deletes the queue specified by the queue URL , regardless of
whether the queue is empty.
|
com.amazonaws.services.sqs.model.DeleteQueueResult |
deleteQueue(String queueUrl)
Deletes the queue specified by the queue URL , regardless of
whether the queue is empty.
|
com.amazonaws.ResponseMetadata |
getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful,
request, typically used for debugging issues where a service isn't acting
as expected.
|
com.amazonaws.services.sqs.model.GetQueueAttributesResult |
getQueueAttributes(com.amazonaws.services.sqs.model.GetQueueAttributesRequest getQueueAttributesRequest)
Gets attributes for the specified queue.
|
com.amazonaws.services.sqs.model.GetQueueAttributesResult |
getQueueAttributes(String queueUrl,
List<String> attributeNames)
Gets attributes for the specified queue.
|
com.amazonaws.services.sqs.model.GetQueueUrlResult |
getQueueUrl(com.amazonaws.services.sqs.model.GetQueueUrlRequest getQueueUrlRequest)
Returns the URL of an existing queue.
|
com.amazonaws.services.sqs.model.GetQueueUrlResult |
getQueueUrl(String queueName)
Returns the URL of an existing queue.
|
com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesResult |
listDeadLetterSourceQueues(com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
Returns a list of your queues that have the RedrivePolicy queue attribute
configured with a dead letter queue.
|
com.amazonaws.services.sqs.model.ListQueuesResult |
listQueues()
Returns a list of your queues.
|
com.amazonaws.services.sqs.model.ListQueuesResult |
listQueues(com.amazonaws.services.sqs.model.ListQueuesRequest listQueuesRequest)
Returns a list of your queues.
|
com.amazonaws.services.sqs.model.ListQueuesResult |
listQueues(String queueNamePrefix)
Returns a list of your queues.
|
com.amazonaws.services.sqs.model.ListQueueTagsResult |
listQueueTags(com.amazonaws.services.sqs.model.ListQueueTagsRequest listQueueTagsRequest) |
com.amazonaws.services.sqs.model.ListQueueTagsResult |
listQueueTags(String queueUrl) |
com.amazonaws.services.sqs.model.PurgeQueueResult |
purgeQueue(com.amazonaws.services.sqs.model.PurgeQueueRequest purgeQueueRequest)
Deletes the messages in a queue specified by the queue URL .
|
com.amazonaws.services.sqs.model.ReceiveMessageResult |
receiveMessage(com.amazonaws.services.sqs.model.ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages, with a maximum limit of 10 messages, from
the specified queue.
|
com.amazonaws.services.sqs.model.ReceiveMessageResult |
receiveMessage(String queueUrl)
Retrieves one or more messages, with a maximum limit of 10 messages, from
the specified queue.
|
com.amazonaws.services.sqs.model.RemovePermissionResult |
removePermission(com.amazonaws.services.sqs.model.RemovePermissionRequest removePermissionRequest)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
com.amazonaws.services.sqs.model.RemovePermissionResult |
removePermission(String queueUrl,
String label)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
com.amazonaws.services.sqs.model.SendMessageResult |
sendMessage(com.amazonaws.services.sqs.model.SendMessageRequest sendMessageRequest)
Delivers a message to the specified queue and uploads the message payload
to Amazon S3 if necessary.
|
com.amazonaws.services.sqs.model.SendMessageResult |
sendMessage(String queueUrl,
String messageBody)
Delivers a message to the specified queue and uploads the message payload
to Amazon S3 if necessary.
|
com.amazonaws.services.sqs.model.SendMessageBatchResult |
sendMessageBatch(com.amazonaws.services.sqs.model.SendMessageBatchRequest sendMessageBatchRequest)
Delivers up to ten messages to the specified queue.
|
com.amazonaws.services.sqs.model.SendMessageBatchResult |
sendMessageBatch(String queueUrl,
List<com.amazonaws.services.sqs.model.SendMessageBatchRequestEntry> entries)
Delivers up to ten messages to the specified queue.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("sqs.us-east-1.amazonaws.com").
|
com.amazonaws.services.sqs.model.SetQueueAttributesResult |
setQueueAttributes(com.amazonaws.services.sqs.model.SetQueueAttributesRequest setQueueAttributesRequest)
Sets the value of one or more queue attributes.
|
com.amazonaws.services.sqs.model.SetQueueAttributesResult |
setQueueAttributes(String queueUrl,
Map<String,String> attributes)
Sets the value of one or more queue attributes.
|
void |
setRegion(com.amazonaws.regions.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.
|
com.amazonaws.services.sqs.model.TagQueueResult |
tagQueue(String queueUrl,
Map<String,String> tags) |
com.amazonaws.services.sqs.model.TagQueueResult |
tagQueue(com.amazonaws.services.sqs.model.TagQueueRequest tagQueueRequest) |
com.amazonaws.services.sqs.model.UntagQueueResult |
untagQueue(String queueUrl,
List<String> tagKeys) |
com.amazonaws.services.sqs.model.UntagQueueResult |
untagQueue(com.amazonaws.services.sqs.model.UntagQueueRequest untagQueueRequest) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddPermission, addPermission, createQueue, createQueue, deleteQueue, deleteQueue, getCachedResponseMetadata, getQueueAttributes, getQueueAttributes, getQueueUrl, getQueueUrl, listDeadLetterSourceQueues, listQueues, listQueues, listQueues, listQueueTags, listQueueTags, removePermission, removePermission, setEndpoint, setQueueAttributes, setQueueAttributes, setRegion, shutdown, tagQueue, tagQueue, untagQueue, untagQueuepublic AmazonSQSExtendedClient(com.amazonaws.services.sqs.AmazonSQS sqsClient)
All service calls made using this new client object are blocking, and will not return until the service call completes.
sqsClient - The Amazon SQS client to use to connect to Amazon SQS.public AmazonSQSExtendedClient(com.amazonaws.services.sqs.AmazonSQS sqsClient,
ExtendedClientConfiguration extendedClientConfig)
All service calls made using this new client object are blocking, and will not return until the service call completes.
sqsClient - The Amazon SQS client to use to connect to Amazon SQS.extendedClientConfig - The extended client configuration options controlling the
functionality of this client.public com.amazonaws.services.sqs.model.SendMessageResult sendMessage(com.amazonaws.services.sqs.model.SendMessageRequest sendMessageRequest)
Delivers a message to the specified queue and uploads the message payload to Amazon S3 if necessary.
IMPORTANT: 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]
IMPORTANT: The input object may be modified by the method.sendMessage in interface com.amazonaws.services.sqs.AmazonSQSsendMessageRequest - Container for the necessary parameters to execute the
SendMessage service method on AmazonSQS.com.amazonaws.services.sqs.model.InvalidMessageContentsExceptionUnsupportedOperationExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.SendMessageResult sendMessage(String queueUrl, String messageBody)
Delivers a message to the specified queue and uploads the message payload to Amazon S3 if necessary.
IMPORTANT: 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 com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.messageBody - The message to send. For a list of allowed characters, see the
preceding important note.com.amazonaws.services.sqs.model.InvalidMessageContentsExceptionUnsupportedOperationExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.ReceiveMessageResult receiveMessage(com.amazonaws.services.sqs.model.ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages, with a maximum limit of 10 messages, from
the specified queue. Downloads the message payloads from Amazon S3 when
necessary. 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 .
NOTE: 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 com.amazonaws.services.sqs.AmazonSQSreceiveMessageRequest - Container for the necessary parameters to execute the
ReceiveMessage service method on AmazonSQS.com.amazonaws.services.sqs.model.OverLimitExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.ReceiveMessageResult receiveMessage(String queueUrl)
Retrieves one or more messages, with a maximum limit of 10 messages, from
the specified queue. Downloads the message payloads from Amazon S3 when
necessary. 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 .
NOTE: 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 com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.com.amazonaws.services.sqs.model.OverLimitExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.DeleteMessageResult deleteMessage(com.amazonaws.services.sqs.model.DeleteMessageRequest deleteMessageRequest)
Deletes the specified message from the specified queue and deletes the
message payload from Amazon S3 when necessary. 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.
NOTE: 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.
IMPORTANT: 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 com.amazonaws.services.sqs.AmazonSQSdeleteMessageRequest - Container for the necessary parameters to execute the
DeleteMessage service method on AmazonSQS.com.amazonaws.services.sqs.model.ReceiptHandleIsInvalidExceptioncom.amazonaws.services.sqs.model.InvalidIdFormatExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.DeleteMessageResult deleteMessage(String queueUrl, String receiptHandle)
Deletes the specified message from the specified queue and deletes the
message payload from Amazon S3 when necessary. 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.
NOTE: 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.
IMPORTANT: 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 com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.receiptHandle - The receipt handle associated with the message to delete.com.amazonaws.services.sqs.model.ReceiptHandleIsInvalidExceptioncom.amazonaws.services.sqs.model.InvalidIdFormatExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.ChangeMessageVisibilityResult changeMessageVisibility(String queueUrl, String receiptHandle, Integer visibilityTimeout)
changeMessageVisibility in interface com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.receiptHandle - The receipt handle associated with the message whose
visibility timeout should be changed. This parameter is
returned by the ReceiveMessage action.visibilityTimeout - The new value (in seconds - from 0 to 43200 - maximum 12
hours) for the message's visibility timeout.changeMessageVisibility(ChangeMessageVisibilityRequest)public com.amazonaws.services.sqs.model.ChangeMessageVisibilityResult changeMessageVisibility(com.amazonaws.services.sqs.model.ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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 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.
NOTE: 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.
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.
changeMessageVisibility in interface com.amazonaws.services.sqs.AmazonSQSchangeMessageVisibilityRequest - Container for the necessary parameters to execute the
ChangeMessageVisibility service method on AmazonSQS.com.amazonaws.services.sqs.model.ReceiptHandleIsInvalidExceptioncom.amazonaws.services.sqs.model.MessageNotInflightExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.SendMessageBatchResult sendMessageBatch(com.amazonaws.services.sqs.model.SendMessageBatchRequest sendMessageBatchRequest)
Delivers 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. Uploads message payloads to Amazon S3 when necessary.
If the DelaySeconds parameter is not specified for an entry,
the default for the queue is used.
IMPORTANT:The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http://www.faqs.org/rfcs/rfc1321.html. If you send any characters that are not included in the list, your request will be rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
IMPORTANT: 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.
IMPORTANT: The input object may be modified by the method.NOTE: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
sendMessageBatch in interface com.amazonaws.services.sqs.AmazonSQSsendMessageBatchRequest - Container for the necessary parameters to execute the
SendMessageBatch service method on AmazonSQS.com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctExceptioncom.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestExceptioncom.amazonaws.services.sqs.model.BatchRequestTooLongExceptionUnsupportedOperationExceptioncom.amazonaws.services.sqs.model.InvalidBatchEntryIdExceptioncom.amazonaws.services.sqs.model.EmptyBatchRequestExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.SendMessageBatchResult sendMessageBatch(String queueUrl, List<com.amazonaws.services.sqs.model.SendMessageBatchRequestEntry> entries)
Delivers 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. Uploads message payloads to Amazon S3 when necessary.
If the DelaySeconds parameter is not specified for an entry,
the default for the queue is used.
IMPORTANT:The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http://www.faqs.org/rfcs/rfc1321.html. If you send any characters that are not included in the list, your request will be rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
IMPORTANT: 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.
NOTE: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
sendMessageBatch in interface com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.entries - A list of SendMessageBatchRequestEntry items.com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctExceptioncom.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestExceptioncom.amazonaws.services.sqs.model.BatchRequestTooLongExceptionUnsupportedOperationExceptioncom.amazonaws.services.sqs.model.InvalidBatchEntryIdExceptioncom.amazonaws.services.sqs.model.EmptyBatchRequestExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.DeleteMessageBatchResult deleteMessageBatch(com.amazonaws.services.sqs.model.DeleteMessageBatchRequest deleteMessageBatchRequest)
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. Also deletes the message payloads from Amazon S3 when necessary.
IMPORTANT: 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.
NOTE: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
deleteMessageBatch in interface com.amazonaws.services.sqs.AmazonSQSdeleteMessageBatchRequest - Container for the necessary parameters to execute the
DeleteMessageBatch service method on AmazonSQS.com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctExceptioncom.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestExceptioncom.amazonaws.services.sqs.model.InvalidBatchEntryIdExceptioncom.amazonaws.services.sqs.model.EmptyBatchRequestExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.DeleteMessageBatchResult deleteMessageBatch(String queueUrl, List<com.amazonaws.services.sqs.model.DeleteMessageBatchRequestEntry> entries)
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. Also deletes the message payloads from Amazon S3 when necessary.
IMPORTANT: 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.
NOTE: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
deleteMessageBatch in interface com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.entries - A list of receipt handles for the messages to be deleted.com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctExceptioncom.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestExceptioncom.amazonaws.services.sqs.model.InvalidBatchEntryIdExceptioncom.amazonaws.services.sqs.model.EmptyBatchRequestExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(String queueUrl, List<com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequestEntry> entries)
changeMessageVisibilityBatch in interface com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.entries - A list of receipt handles of the messages for which the
visibility timeout must be changed.changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest)public com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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.
IMPORTANT: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.
NOTE: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
changeMessageVisibilityBatch in interface com.amazonaws.services.sqs.AmazonSQSchangeMessageVisibilityBatchRequest - Container for the necessary parameters to execute the
ChangeMessageVisibilityBatch service method on AmazonSQS.com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctExceptioncom.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestExceptioncom.amazonaws.services.sqs.model.InvalidBatchEntryIdExceptioncom.amazonaws.services.sqs.model.EmptyBatchRequestExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.PurgeQueueResult purgeQueue(com.amazonaws.services.sqs.model.PurgeQueueRequest purgeQueueRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.AmazonClientException
Deletes the messages in a queue specified by the queue URL .
IMPORTANT:When you use the PurgeQueue API, the deleted messages in the queue cannot be retrieved.
IMPORTANT: This does not delete the message payloads from Amazon S3.
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 com.amazonaws.services.sqs.AmazonSQSpurgeQueueRequest - Container for the necessary parameters to execute the
PurgeQueue service method on AmazonSQS.com.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.SetQueueAttributesResult setQueueAttributes(com.amazonaws.services.sqs.model.SetQueueAttributesRequest setQueueAttributesRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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.
NOTE: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.
setQueueAttributes in interface com.amazonaws.services.sqs.AmazonSQSsetQueueAttributesRequest - Container for the necessary parameters to execute the
SetQueueAttributes service method on AmazonSQS.com.amazonaws.services.sqs.model.InvalidAttributeNameExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.GetQueueUrlResult getQueueUrl(com.amazonaws.services.sqs.model.GetQueueUrlRequest getQueueUrlRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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 go to Shared Queues in the Amazon SQS Developer Guide .
getQueueUrl in interface com.amazonaws.services.sqs.AmazonSQSgetQueueUrlRequest - Container for the necessary parameters to execute the
GetQueueUrl service method on AmazonSQS.com.amazonaws.services.sqs.model.QueueDoesNotExistExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.RemovePermissionResult removePermission(com.amazonaws.services.sqs.model.RemovePermissionRequest removePermissionRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.AmazonClientException
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 com.amazonaws.services.sqs.AmazonSQSremovePermissionRequest - Container for the necessary parameters to execute the
RemovePermission service method on AmazonSQS.com.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.GetQueueAttributesResult getQueueAttributes(com.amazonaws.services.sqs.model.GetQueueAttributesRequest getQueueAttributesRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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.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 .NOTE: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.
NOTE: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
getQueueAttributes in interface com.amazonaws.services.sqs.AmazonSQSgetQueueAttributesRequest - Container for the necessary parameters to execute the
GetQueueAttributes service method on AmazonSQS.com.amazonaws.services.sqs.model.InvalidAttributeNameExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesResult listDeadLetterSourceQueues(com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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 .
listDeadLetterSourceQueues in interface com.amazonaws.services.sqs.AmazonSQSlistDeadLetterSourceQueuesRequest - Container for the necessary parameters to execute the
ListDeadLetterSourceQueues service method on AmazonSQS.com.amazonaws.services.sqs.model.QueueDoesNotExistExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.DeleteQueueResult deleteQueue(com.amazonaws.services.sqs.model.DeleteQueueRequest deleteQueueRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.AmazonClientException
Deletes 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.
IMPORTANT: 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 com.amazonaws.services.sqs.AmazonSQSdeleteQueueRequest - Container for the necessary parameters to execute the
DeleteQueue service method on AmazonSQS.com.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.ListQueuesResult listQueues(com.amazonaws.services.sqs.model.ListQueuesRequest listQueuesRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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.
listQueues in interface com.amazonaws.services.sqs.AmazonSQSlistQueuesRequest - Container for the necessary parameters to execute the
ListQueues service method on AmazonSQS.com.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.CreateQueueResult createQueue(com.amazonaws.services.sqs.model.CreateQueueRequest createQueueRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.AmazonClientException
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.
NOTE: 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.
NOTE: 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.
NOTE: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
createQueue in interface com.amazonaws.services.sqs.AmazonSQScreateQueueRequest - Container for the necessary parameters to execute the
CreateQueue service method on AmazonSQS.com.amazonaws.services.sqs.model.QueueNameExistsExceptioncom.amazonaws.services.sqs.model.QueueDeletedRecentlyExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.AddPermissionResult addPermission(com.amazonaws.services.sqs.model.AddPermissionRequest addPermissionRequest)
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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 .
NOTE: 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.
NOTE: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
addPermission in interface com.amazonaws.services.sqs.AmazonSQSaddPermissionRequest - Container for the necessary parameters to execute the
AddPermission service method on AmazonSQS.com.amazonaws.services.sqs.model.OverLimitExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.ListQueuesResult listQueues()
throws com.amazonaws.AmazonServiceException,
com.amazonaws.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.
listQueues in interface com.amazonaws.services.sqs.AmazonSQScom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.SetQueueAttributesResult setQueueAttributes(String queueUrl, Map<String,String> attributes) throws com.amazonaws.AmazonServiceException, com.amazonaws.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.
NOTE: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.
setQueueAttributes in interface com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.attributes - A map of attributes to set.
The following lists the names, descriptions, and values of the
special request parameters the SetQueueAttributes
action uses:
DelaySeconds - The time in seconds that the
delivery of all messages in the queue will be delayed. An
integer from 0 to 900 (15 minutes). The default for this
attribute is 0 (zero).MaximumMessageSize - The limit of how many
bytes a message can contain before Amazon SQS rejects it. An
integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB).
The default for this attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of
seconds Amazon SQS retains a message. Integer representing
seconds, from 60 (1 minute) to 1209600 (14 days). The default
for this attribute is 345600 (4 days).Policy - The queue's policy. A valid AWS
policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User
Guide.ReceiveMessageWaitTimeSeconds - The time for
which a ReceiveMessage call will wait for a message to arrive.
An integer from 0 to 20 (seconds). The default for this
attribute is 0.VisibilityTimeout - The visibility timeout
for the queue. An integer from 0 to 43200 (12 hours). The
default for this attribute is 30. For more information about
visibility timeout, see Visibility Timeout in the Amazon
SQS Developer Guide.RedrivePolicy - 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.com.amazonaws.services.sqs.model.InvalidAttributeNameExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.GetQueueUrlResult getQueueUrl(String queueName) throws com.amazonaws.AmazonServiceException, com.amazonaws.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 go to Shared Queues in the Amazon SQS Developer Guide .
getQueueUrl in interface com.amazonaws.services.sqs.AmazonSQSqueueName - The name of the queue whose URL must be fetched. Maximum 80
characters; alphanumeric characters, hyphens (-), and
underscores (_) are allowed.com.amazonaws.services.sqs.model.QueueDoesNotExistExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.RemovePermissionResult removePermission(String queueUrl, String label) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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 com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.label - The identification of the permission to remove. This is the
label added with the AddPermission action.com.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.GetQueueAttributesResult getQueueAttributes(String queueUrl, List<String> attributeNames) throws com.amazonaws.AmazonServiceException, com.amazonaws.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.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 .NOTE: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.
NOTE: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
getQueueAttributes in interface com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.attributeNames - A list of attributes to retrieve information for.com.amazonaws.services.sqs.model.InvalidAttributeNameExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.DeleteQueueResult deleteQueue(String queueUrl) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Deletes 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.
IMPORTANT: 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 com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.com.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.ListQueuesResult listQueues(String queueNamePrefix) throws com.amazonaws.AmazonServiceException, com.amazonaws.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.
listQueues in interface com.amazonaws.services.sqs.AmazonSQSqueueNamePrefix - A string to use for filtering the list results. Only those
queues whose name begins with the specified string are
returned.com.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.CreateQueueResult createQueue(String queueName) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
NOTE: 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.
NOTE: 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.
NOTE: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
createQueue in interface com.amazonaws.services.sqs.AmazonSQSqueueName - The name for the queue to be created.com.amazonaws.services.sqs.model.QueueNameExistsExceptioncom.amazonaws.services.sqs.model.QueueDeletedRecentlyExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.services.sqs.model.AddPermissionResult addPermission(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions) throws com.amazonaws.AmazonServiceException, com.amazonaws.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 .
NOTE: 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.
NOTE: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
addPermission in interface com.amazonaws.services.sqs.AmazonSQSqueueUrl - The URL of the Amazon SQS queue to take action on.label - The unique identification of the permission you're setting
(e.g., AliceSendMessage). Constraints: Maximum 80
characters; alphanumeric characters, hyphens (-), and
underscores (_) are allowed.aWSAccountIds - The AWS account number of the principal who will be given permission. The principal
must have an AWS account, but does not need to be signed up
for Amazon SQS. For information about locating the AWS account
identification, see Your AWS Identifiers in the Amazon SQS Developer
Guide.actions - The action the client wants to allow for the specified
principal. The following are valid values:
* | SendMessage |
ReceiveMessage | DeleteMessage | ChangeMessageVisibility |
GetQueueAttributes | GetQueueUrl. For more information about these
actions, see Understanding Permissions in the Amazon SQS Developer
Guide.
Specifying SendMessage,
DeleteMessage, or
ChangeMessageVisibility for the
ActionName.n also grants permissions for the
corresponding batch versions of those actions:
SendMessageBatch, DeleteMessageBatch
, and ChangeMessageVisibilityBatch.
com.amazonaws.services.sqs.model.OverLimitExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonSQS indicating
either a problem with the data in the request, or a server
side issue.public com.amazonaws.ResponseMetadata getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface com.amazonaws.services.sqs.AmazonSQSrequest - The originally executed requestpublic void setEndpoint(String endpoint) throws IllegalArgumentException
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.
setEndpoint in interface com.amazonaws.services.sqs.AmazonSQSendpoint - 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.IllegalArgumentException - If any problems are detected with the specified endpoint.public void setRegion(com.amazonaws.regions.Region region)
throws IllegalArgumentException
AmazonSQS.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 com.amazonaws.services.sqs.AmazonSQSregion - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, AWSCredentialsProvider, ClientConfiguration)public void shutdown()
shutdown in interface com.amazonaws.services.sqs.AmazonSQSpublic com.amazonaws.services.sqs.model.ListQueueTagsResult listQueueTags(com.amazonaws.services.sqs.model.ListQueueTagsRequest listQueueTagsRequest)
listQueueTags in interface com.amazonaws.services.sqs.AmazonSQSpublic com.amazonaws.services.sqs.model.ListQueueTagsResult listQueueTags(String queueUrl)
listQueueTags in interface com.amazonaws.services.sqs.AmazonSQSpublic com.amazonaws.services.sqs.model.TagQueueResult tagQueue(com.amazonaws.services.sqs.model.TagQueueRequest tagQueueRequest)
tagQueue in interface com.amazonaws.services.sqs.AmazonSQSpublic com.amazonaws.services.sqs.model.TagQueueResult tagQueue(String queueUrl, Map<String,String> tags)
tagQueue in interface com.amazonaws.services.sqs.AmazonSQSpublic com.amazonaws.services.sqs.model.UntagQueueResult untagQueue(com.amazonaws.services.sqs.model.UntagQueueRequest untagQueueRequest)
untagQueue in interface com.amazonaws.services.sqs.AmazonSQSCopyright © 2023. All rights reserved.