@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSQS
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSQS instead.
Welcome to the Amazon Simple Queue Service API Reference.
Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
Standard queues are available in all regions. FIFO queues are available in the US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland) regions.
You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional Information
Amazon Simple Queue Service Developer Guide
Amazon Web Services General Reference
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddPermissionResult |
addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to a queue for a specific principal.
|
AddPermissionResult |
addPermission(String queueUrl,
String label,
List<String> aWSAccountIds,
List<String> actions)
Simplified method form for invoking the AddPermission operation.
|
ChangeMessageVisibilityResult |
changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new value.
|
ChangeMessageVisibilityResult |
changeMessageVisibility(String queueUrl,
String receiptHandle,
Integer visibilityTimeout)
Simplified method form for invoking the ChangeMessageVisibility operation.
|
ChangeMessageVisibilityBatchResult |
changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
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 createQueueRequest)
Creates a new standard or FIFO queue.
|
CreateQueueResult |
createQueue(String queueName)
Simplified method form for invoking the CreateQueue operation.
|
DeleteMessageResult |
deleteMessage(DeleteMessageRequest deleteMessageRequest)
Deletes the specified message from the specified queue.
|
DeleteMessageResult |
deleteMessage(String queueUrl,
String receiptHandle)
Simplified method form for invoking the DeleteMessage operation.
|
DeleteMessageBatchResult |
deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
Deletes up to ten messages from the specified queue.
|
DeleteMessageBatchResult |
deleteMessageBatch(String queueUrl,
List<DeleteMessageBatchRequestEntry> entries)
Simplified method form for invoking the DeleteMessageBatch operation.
|
DeleteQueueResult |
deleteQueue(DeleteQueueRequest deleteQueueRequest)
Deletes the queue specified by the
QueueUrl, regardless of the queue's contents. |
DeleteQueueResult |
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 getQueueAttributesRequest)
Gets attributes for the specified queue.
|
GetQueueAttributesResult |
getQueueAttributes(String queueUrl,
List<String> attributeNames)
Simplified method form for invoking the GetQueueAttributes operation.
|
GetQueueUrlResult |
getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
Returns the URL of an existing queue.
|
GetQueueUrlResult |
getQueueUrl(String queueName)
Simplified method form for invoking the GetQueueUrl operation.
|
ListDeadLetterSourceQueuesResult |
listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
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 listQueuesRequest)
Returns a list of your queues.
|
ListQueuesResult |
listQueues(String queueNamePrefix)
Simplified method form for invoking the ListQueues operation.
|
ListQueueTagsResult |
listQueueTags(ListQueueTagsRequest listQueueTagsRequest)
List all cost allocation tags added to the specified Amazon SQS queue.
|
ListQueueTagsResult |
listQueueTags(String queueUrl)
Simplified method form for invoking the ListQueueTags operation.
|
PurgeQueueResult |
purgeQueue(PurgeQueueRequest purgeQueueRequest)
Deletes the messages in a queue specified by the
QueueURL parameter. |
ReceiveMessageResult |
receiveMessage(ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages (up to 10), from the specified queue.
|
ReceiveMessageResult |
receiveMessage(String queueUrl)
Simplified method form for invoking the ReceiveMessage operation.
|
RemovePermissionResult |
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
RemovePermissionResult |
removePermission(String queueUrl,
String label)
Simplified method form for invoking the RemovePermission operation.
|
SendMessageResult |
sendMessage(SendMessageRequest sendMessageRequest)
Delivers a message to the specified queue.
|
SendMessageResult |
sendMessage(String queueUrl,
String messageBody)
Simplified method form for invoking the SendMessage operation.
|
SendMessageBatchResult |
sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
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)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetQueueAttributesResult |
setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
Sets the value of one or more queue attributes.
|
SetQueueAttributesResult |
setQueueAttributes(String queueUrl,
Map<String,String> attributes)
Simplified method form for invoking the SetQueueAttributes operation.
|
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagQueueResult |
tagQueue(String queueUrl,
Map<String,String> tags)
Simplified method form for invoking the TagQueue operation.
|
TagQueueResult |
tagQueue(TagQueueRequest tagQueueRequest)
Add cost allocation tags to the specified Amazon SQS queue.
|
UntagQueueResult |
untagQueue(String queueUrl,
List<String> tagKeys)
Simplified method form for invoking the UntagQueue operation.
|
UntagQueueResult |
untagQueue(UntagQueueRequest untagQueueRequest)
Remove cost allocation tags from the specified Amazon SQS queue.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
endpoint - 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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
region - 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)AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
Some 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
addPermissionRequest - OverLimitException - The action that you requested would violate a limit. For example, ReceiveMessage returns
this error if the maximum number of inflight messages is reached. AddPermission
returns this error if the maximum number of permissions for the queue is reached.AddPermissionResult addPermission(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions)
addPermission(AddPermissionRequest)ChangeMessageVisibilityResult changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, 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, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call
ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is
extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a
total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to
extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12
hours, your request is rejected.
A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.
For standard queues, there can be a maximum of 120,000 inflight messages per queue. If you reach this limit,
Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete
messages from the queue after they're processed. You can also increase the number of queues you use to process
your messages.
For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon
SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum
remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied
immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the
visibility timeout for the message reverts to the original timeout value (not to the value you set using the
ChangeMessageVisibility action) the next time the message is received.
changeMessageVisibilityRequest - MessageNotInflightException - The message referred to isn't in flight.ReceiptHandleIsInvalidException - The receipt handle provided isn't valid.ChangeMessageVisibilityResult changeMessageVisibility(String queueUrl, String receiptHandle, Integer visibilityTimeout)
ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
Changes the visibility timeout of multiple messages. This is a batch version of
ChangeMessageVisibility. The result of the action on each message is reported individually
in the response. You can send up to 10 ChangeMessageVisibility requests with each
ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check
for batch errors even when the call returns an HTTP status code of 200.
Some 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
changeMessageVisibilityBatchRequest - TooManyEntriesInBatchRequestException - The batch request contains more entries than permissible.EmptyBatchRequestException - The batch request doesn't contain any entries.BatchEntryIdsNotDistinctException - Two or more batch entries in the request have the same Id.InvalidBatchEntryIdException - The Id of a batch entry in a batch request doesn't abide by the specification.ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries)
CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind:
If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl
requires only the QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes,
CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue
returns an error.
Some 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
createQueueRequest - QueueDeletedRecentlyException - You must wait 60 seconds after deleting a queue before you can create another one with the same name.QueueNameExistsException - A queue already exists with this name. Amazon SQS returns this error only if the request includes
attributes whose values differ from those of the existing queue.AmazonSQS client = new AmazonSQSClient();
CreateQueueRequest request = new CreateQueueRequest()
.withQueueName("MyQueue");
CreateQueueResult response = client.createQueue(request);CreateQueueResult createQueue(String queueName)
createQueue(CreateQueueRequest)DeleteMessageResult deleteMessage(DeleteMessageRequest deleteMessageRequest)
Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send 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 the message.
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. If you don't provide the
most recently received receipt handle for the message when you use the DeleteMessage action, the
request succeeds, but the message might not be deleted.
For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
deleteMessageRequest - InvalidIdFormatException - The receipt handle isn't valid for the current version.ReceiptHandleIsInvalidException - The receipt handle provided isn't valid.DeleteMessageResult deleteMessage(String queueUrl, String receiptHandle)
deleteMessage(DeleteMessageRequest)DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
Deletes up to ten messages from the specified queue. This is a batch version of
DeleteMessage. The result of the action on each message is reported individually in the
response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check
for batch errors even when the call returns an HTTP status code of 200.
Some 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
deleteMessageBatchRequest - TooManyEntriesInBatchRequestException - The batch request contains more entries than permissible.EmptyBatchRequestException - The batch request doesn't contain any entries.BatchEntryIdsNotDistinctException - Two or more batch entries in the request have the same Id.InvalidBatchEntryIdException - The Id of a batch entry in a batch request doesn't abide by the specification.DeleteMessageBatchResult deleteMessageBatch(String queueUrl, List<DeleteMessageBatchRequestEntry> entries)
DeleteQueueResult deleteQueue(DeleteQueueRequest deleteQueueRequest)
Deletes the queue specified by the QueueUrl, regardless of the queue's contents. If the specified
queue doesn't exist, Amazon SQS returns a successful response.
Be careful with the DeleteQueue action: When you delete a 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 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
deleteQueueRequest - DeleteQueueResult deleteQueue(String queueUrl)
deleteQueue(DeleteQueueRequest)GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you
can check whether QueueName ends with the .fifo suffix.
Some 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
getQueueAttributesRequest - InvalidAttributeNameException - The attribute referred to doesn't exist.GetQueueAttributesResult getQueueAttributes(String queueUrl, List<String> attributeNames)
GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to
specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For
more information about shared queue access, see AddPermission or see Shared
Queues in the Amazon Simple Queue Service Developer Guide.
getQueueUrlRequest - QueueDoesNotExistException - The queue referred to doesn't exist.AmazonSQS client = new AmazonSQSClient();
GetQueueUrlRequest request = new GetQueueUrlRequest().withQueueName(
"MyQueue").withQueueOwnerAWSAccountId("12345678910");
GetQueueUrlResult response = client.getQueueUrl(request);GetQueueUrlResult getQueueUrl(String queueName)
getQueueUrl(GetQueueUrlRequest)ListDeadLetterSourceQueuesResult listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a
dead-letter queue.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
listDeadLetterSourceQueuesRequest - QueueDoesNotExistException - The queue referred to doesn't exist.ListQueueTagsResult listQueueTags(ListQueueTagsRequest listQueueTagsRequest)
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
listQueueTagsRequest - ListQueueTagsResult listQueueTags(String queueUrl)
listQueueTags(ListQueueTagsRequest)ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value
for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified
value are returned.
listQueuesRequest - ListQueuesResult listQueues()
listQueues(ListQueuesRequest)ListQueuesResult listQueues(String queueNamePrefix)
listQueues(ListQueuesRequest)PurgeQueueResult purgeQueue(PurgeQueueRequest purgeQueueRequest)
Deletes the messages in a queue specified by the QueueURL parameter.
When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue
before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being
purged might be deleted. While the queue is being purged, messages sent to the queue before
PurgeQueue is called might be received, but are deleted within the next minute.
purgeQueueRequest - QueueDoesNotExistException - The queue referred to doesn't exist.PurgeQueueInProgressException - Indicates that the specified queue previously received a PurgeQueue request within the last
60 seconds (the time it can take to delete the messages in the queue).ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds
parameter enables long-poll support. For more information, see Amazon SQS
Long Polling in the Amazon Simple Queue Service Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a
ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of
messages in the queue is small (fewer than 1,000), you most likely 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. If this happens, repeat the request.
For each message returned, the response includes the following:
The message body.
An MD5 digest of the message body. For information about MD5, see RFC1321.
The MessageId you received when you sent the message to the queue.
The receipt handle.
The message attributes.
An 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 Simple Queue Service Developer Guide.
You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the
messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility
timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
receiveMessageRequest - OverLimitException - The action that you requested would violate a limit. For example, ReceiveMessage returns
this error if the maximum number of inflight messages is reached. AddPermission
returns this error if the maximum number of permissions for the queue is reached.ReceiveMessageResult receiveMessage(String queueUrl)
receiveMessage(ReceiveMessageRequest)RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest)
Revokes any permissions in the queue policy that matches the specified Label parameter. Only the
owner of the queue can remove permissions.
removePermissionRequest - RemovePermissionResult removePermission(String queueUrl, String label)
SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF |
#xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
sendMessageRequest - InvalidMessageContentsException - The message contains characters outside the allowed set.UnsupportedOperationException - Error code 400. Unsupported operation.SendMessageResult sendMessage(String queueUrl, String messageBody)
sendMessage(SendMessageRequest)SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result
in a combination of successful and unsuccessful actions, you should check for batch errors even when the call
returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF |
#xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for
the queue.
Some 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
sendMessageBatchRequest - TooManyEntriesInBatchRequestException - The batch request contains more entries than permissible.EmptyBatchRequestException - The batch request doesn't contain any entries.BatchEntryIdsNotDistinctException - Two or more batch entries in the request have the same Id.BatchRequestTooLongException - The length of all the messages put together is more than the limit.InvalidBatchEntryIdException - The Id of a batch entry in a batch request doesn't abide by the specification.UnsupportedOperationException - Error code 400. Unsupported operation.SendMessageBatchResult sendMessageBatch(String queueUrl, List<SendMessageBatchRequestEntry> entries)
SetQueueAttributesResult setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
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 Amazon SQS system. Changes made to the
MessageRetentionPeriod attribute can take up to 15 minutes.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
setQueueAttributesRequest - InvalidAttributeNameException - The attribute referred to doesn't exist.SetQueueAttributesResult setQueueAttributes(String queueUrl, Map<String,String> attributes)
TagQueueResult tagQueue(TagQueueRequest tagQueueRequest)
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
tagQueueRequest - TagQueueResult tagQueue(String queueUrl, Map<String,String> tags)
tagQueue(TagQueueRequest)UntagQueueResult untagQueue(UntagQueueRequest untagQueueRequest)
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging API actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support request.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
untagQueueRequest - UntagQueueResult untagQueue(String queueUrl, List<String> tagKeys)
untagQueue(UntagQueueRequest)void shutdown()
ResponseMetadata getCachedResponseMetadata(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 a request.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.