@ThreadSafe public class AmazonSQSClient extends AmazonWebServiceClient implements AmazonSQS
Welcome to the Amazon Simple Queue Service API Reference. This section describes who should read this guide, how the guide is organized, and other resources related to the Amazon Simple Queue Service (Amazon SQS).
Amazon SQS offers reliable and scalable hosted queues for storing messages as they travel between computers. By using Amazon SQS, you can move data between distributed components of your applications that perform different tasks without losing messages or requiring each component to be always available.
Helpful Links:
We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as:
Cryptographically signing your service requests
Retrying requests
Handling error responses
For a list of available SDKs, go to Tools for Amazon Web Services.
Modifier and Type | Field and Description |
---|---|
protected static com.amazonaws.services.sqs.AmazonSQSClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonSQSClient()
Constructs a new client to invoke service methods on Amazon SQS.
|
AmazonSQSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon SQS using the specified AWS account credentials.
|
AmazonSQSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SQS using the specified AWS account credentials and
client configuration options.
|
AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon SQS using the specified AWS account credentials
provider.
|
AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SQS using the specified AWS account credentials
provider and client configuration options.
|
AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon SQS using the specified AWS account credentials
provider, client configuration options, and request metric collector.
|
AmazonSQSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SQS.
|
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 queue, or returns the URL of an existing one.
|
CreateQueueResult |
createQueue(String queueName)
Simplified method form for invoking the CreateQueue operation.
|
protected com.amazonaws.internal.auth.SignerProvider |
createSignerProvider(Signer signer) |
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 queue URL, regardless of whether the queue is empty.
|
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.
|
PurgeQueueResult |
purgeQueue(PurgeQueueRequest purgeQueueRequest)
Deletes the messages in a queue specified by the queue URL.
|
ReceiveMessageResult |
receiveMessage(ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue.
|
ReceiveMessageResult |
receiveMessage(String queueUrl)
Simplified method form for invoking the ReceiveMessage operation.
|
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.
|
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.
|
addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final com.amazonaws.services.sqs.AmazonSQSClientConfigurationFactory configFactory
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonSQSClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonSQSClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon SQS (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonSQSClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.public AmazonSQSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SQS (ex: proxy settings,
retry counts, etc.).public AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.public AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SQS (ex: proxy settings,
retry counts, etc.).public AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SQS (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to a queue for a specific principal. This allows for sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission
writes an 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.
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:
addPermission
in interface AmazonSQS
addPermissionRequest
- OverLimitException
- The action that you requested would violate a limit. For example, ReceiveMessage returns this error if
the maximum number of messages inflight has already been reached. AddPermission returns this error
if the maximum number of permissions for the queue has already been reached.public AddPermissionResult addPermission(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions)
AmazonSQS
addPermission
in interface AmazonSQS
AmazonSQS.addPermission(AddPermissionRequest)
public ChangeMessageVisibilityResult changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
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 5 minutes. After 3
minutes, you call ChangeMessageVisiblity
with a timeout of 10 minutes. At that time, the timeout for
the message would be extended by 10 minutes beyond the time of the ChangeMessageVisibility call. This results in
a total visibility timeout of 13 minutes. You can continue to call ChangeMessageVisibility to extend the
visibility timeout to a maximum of 12 hours. If you try to extend beyond 12 hours, the request will be rejected.
There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.
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.
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 AmazonSQS
changeMessageVisibilityRequest
- MessageNotInflightException
- The message referred to is not in flight.ReceiptHandleIsInvalidException
- The receipt handle provided is not valid.public ChangeMessageVisibilityResult changeMessageVisibility(String queueUrl, String receiptHandle, Integer visibilityTimeout)
AmazonSQS
changeMessageVisibility
in interface AmazonSQS
AmazonSQS.changeMessageVisibility(ChangeMessageVisibilityRequest)
public 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 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:
changeMessageVisibilityBatch
in interface AmazonSQS
changeMessageVisibilityBatchRequest
- TooManyEntriesInBatchRequestException
- Batch request contains more number of entries than permissible.EmptyBatchRequestException
- Batch request does not contain an entry.BatchEntryIdsNotDistinctException
- Two or more batch entries have the same Id
in the request.InvalidBatchEntryIdException
- The Id
of a batch entry in a batch request does not abide by the specification.public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries)
AmazonSQS
changeMessageVisibilityBatch
in interface AmazonSQS
AmazonSQS.changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest)
public CreateQueueResult createQueue(CreateQueueRequest createQueueRequest)
Creates a new queue, or returns the URL of an existing one. When you request CreateQueue
, you
provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within
the scope of your own queues.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute.
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.
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:
createQueue
in interface AmazonSQS
createQueueRequest
- QueueDeletedRecentlyException
- You must wait 60 seconds after deleting a queue before you can create another 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.public CreateQueueResult createQueue(String queueName)
AmazonSQS
createQueue
in interface AmazonSQS
AmazonSQS.createQueue(CreateQueueRequest)
public 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 message ID
you received when you sent the message. Even if
the message is locked by another reader due to the visibility timeout setting, it is still deleted from the
queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS
automatically deletes it.
The receipt handle is associated with a specific instance of receiving the message. If you receive a message more
than once, the receipt handle you get each time you receive the message is different. When you request
DeleteMessage
, if you don't provide the most recently received receipt handle for the message, the
request will still succeed, but the message might not be deleted.
It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
deleteMessage
in interface AmazonSQS
deleteMessageRequest
- InvalidIdFormatException
- The receipt handle is not valid for the current version.ReceiptHandleIsInvalidException
- The receipt handle provided is not valid.public DeleteMessageResult deleteMessage(String queueUrl, String receiptHandle)
AmazonSQS
deleteMessage
in interface AmazonSQS
AmazonSQS.deleteMessage(DeleteMessageRequest)
public DeleteMessageBatchResult deleteMessageBatch(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.
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 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:
deleteMessageBatch
in interface AmazonSQS
deleteMessageBatchRequest
- TooManyEntriesInBatchRequestException
- Batch request contains more number of entries than permissible.EmptyBatchRequestException
- Batch request does not contain an entry.BatchEntryIdsNotDistinctException
- Two or more batch entries have the same Id
in the request.InvalidBatchEntryIdException
- The Id
of a batch entry in a batch request does not abide by the specification.public DeleteMessageBatchResult deleteMessageBatch(String queueUrl, List<DeleteMessageBatchRequestEntry> entries)
AmazonSQS
deleteMessageBatch
in interface AmazonSQS
AmazonSQS.deleteMessageBatch(DeleteMessageBatchRequest)
public DeleteQueueResult deleteQueue(DeleteQueueRequest deleteQueueRequest)
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.
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 AmazonSQS
deleteQueueRequest
- public DeleteQueueResult deleteQueue(String queueUrl)
AmazonSQS
deleteQueue
in interface AmazonSQS
AmazonSQS.deleteQueue(DeleteQueueRequest)
public GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
Gets attributes for the specified queue.
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:
getQueueAttributes
in interface AmazonSQS
getQueueAttributesRequest
- InvalidAttributeNameException
- The attribute referred to does not exist.public GetQueueAttributesResult getQueueAttributes(String queueUrl, List<String> attributeNames)
AmazonSQS
getQueueAttributes
in interface AmazonSQS
AmazonSQS.getQueueAttributes(GetQueueAttributesRequest)
public 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 go to Shared
Queues in the Amazon SQS Developer Guide.
getQueueUrl
in interface AmazonSQS
getQueueUrlRequest
- QueueDoesNotExistException
- The queue referred to does not exist.public GetQueueUrlResult getQueueUrl(String queueName)
AmazonSQS
getQueueUrl
in interface AmazonSQS
AmazonSQS.getQueueUrl(GetQueueUrlRequest)
public 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.
listDeadLetterSourceQueues
in interface AmazonSQS
listDeadLetterSourceQueuesRequest
- QueueDoesNotExistException
- The queue referred to does not exist.public ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest)
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 AmazonSQS
listQueuesRequest
- public ListQueuesResult listQueues()
AmazonSQS
listQueues
in interface AmazonSQS
AmazonSQS.listQueues(ListQueuesRequest)
public ListQueuesResult listQueues(String queueNamePrefix)
AmazonSQS
listQueues
in interface AmazonSQS
AmazonSQS.listQueues(ListQueuesRequest)
public PurgeQueueResult purgeQueue(PurgeQueueRequest purgeQueueRequest)
Deletes the messages in a queue specified by the queue URL.
When you use the PurgeQueue
API, the deleted messages in the queue cannot be retrieved.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue
before calling PurgeQueue
will be deleted; messages sent to the queue while it is being purged may
be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue
was called
may be received, but will be deleted within the next minute.
purgeQueue
in interface AmazonSQS
purgeQueueRequest
- QueueDoesNotExistException
- The queue referred to does not 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.public ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support
is enabled by using the WaitTimeSeconds
parameter. For more information, see Amazon SQS
Long Poll in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a
ReceiveMessage
call. This means only the messages on the sampled machines are returned. If the
number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you
requested per ReceiveMessage
call. If the number of messages in the queue is extremely small, you
might not receive any messages in a particular ReceiveMessage
response; in which case you should
repeat the request.
For each message returned, the response includes the following:
Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout
parameter in your request, which will be applied to the
messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility
timeout for the queue is used for the returned messages. For more information, see Visibility
Timeout in the Amazon SQS Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
receiveMessage
in interface AmazonSQS
receiveMessageRequest
- OverLimitException
- The action that you requested would violate a limit. For example, ReceiveMessage returns this error if
the maximum number of messages inflight has already been reached. AddPermission returns this error
if the maximum number of permissions for the queue has already been reached.public ReceiveMessageResult receiveMessage(String queueUrl)
AmazonSQS
receiveMessage
in interface AmazonSQS
AmazonSQS.receiveMessage(ReceiveMessageRequest)
public 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.
removePermission
in interface AmazonSQS
removePermissionRequest
- public RemovePermissionResult removePermission(String queueUrl, String label)
AmazonSQS
removePermission
in interface AmazonSQS
AmazonSQS.removePermission(RemovePermissionRequest)
public SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.
The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets If you send any characters not included in the list, your request will be rejected.
#x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
sendMessage
in interface AmazonSQS
sendMessageRequest
- InvalidMessageContentsException
- The message contains characters outside the allowed set.UnsupportedOperationException
- Error code 400. Unsupported operation.public SendMessageResult sendMessage(String queueUrl, String messageBody)
AmazonSQS
sendMessage
in interface AmazonSQS
AmazonSQS.sendMessage(SendMessageRequest)
public SendMessageBatchResult sendMessageBatch(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. The maximum allowed individual message size is 256 KB (262,144 bytes).
The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
If the DelaySeconds
parameter is not specified for an entry, the default for the queue is used.
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]
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 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:
sendMessageBatch
in interface AmazonSQS
sendMessageBatchRequest
- TooManyEntriesInBatchRequestException
- Batch request contains more number of entries than permissible.EmptyBatchRequestException
- Batch request does not contain an entry.BatchEntryIdsNotDistinctException
- Two or more batch entries have the same Id
in the request.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 does not abide by the specification.UnsupportedOperationException
- Error code 400. Unsupported operation.public SendMessageBatchResult sendMessageBatch(String queueUrl, List<SendMessageBatchRequestEntry> entries)
AmazonSQS
sendMessageBatch
in interface AmazonSQS
AmazonSQS.sendMessageBatch(SendMessageBatchRequest)
public 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 SQS system. Changes made to the
MessageRetentionPeriod
attribute can take up to 15 minutes.
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 AmazonSQS
setQueueAttributesRequest
- InvalidAttributeNameException
- The attribute referred to does not exist.public SetQueueAttributesResult setQueueAttributes(String queueUrl, Map<String,String> attributes)
AmazonSQS
setQueueAttributes
in interface AmazonSQS
AmazonSQS.setQueueAttributes(SetQueueAttributesRequest)
public 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 the request.
getCachedResponseMetadata
in interface AmazonSQS
request
- The originally executed requestprotected final com.amazonaws.internal.auth.SignerProvider createSignerProvider(Signer signer)
createSignerProvider
in class AmazonWebServiceClient
Copyright © 2016. All rights reserved.