@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSQSClient extends AmazonWebServiceClient implements AmazonSQS
Welcome to the Amazon SQS API Reference.
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.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.
You can use Amazon Web Services 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 SQS Developer Guide
Amazon Web Services General Reference
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonSQSClient()
Deprecated.
|
AmazonSQSClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonSQSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonSQSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonSQSClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
AddPermissionResult |
addPermission(AddPermissionRequest request)
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.
|
static AmazonSQSClientBuilder |
builder() |
ChangeMessageVisibilityResult |
changeMessageVisibility(ChangeMessageVisibilityRequest request)
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 request)
Changes the visibility timeout of multiple messages.
|
ChangeMessageVisibilityBatchResult |
changeMessageVisibilityBatch(String queueUrl,
List<ChangeMessageVisibilityBatchRequestEntry> entries)
Simplified method form for invoking the ChangeMessageVisibilityBatch operation.
|
CreateQueueResult |
createQueue(CreateQueueRequest request)
Creates a new standard or FIFO queue.
|
CreateQueueResult |
createQueue(String queueName)
Simplified method form for invoking the CreateQueue operation.
|
DeleteMessageResult |
deleteMessage(DeleteMessageRequest request)
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 request)
Deletes up to ten messages from the specified queue.
|
DeleteMessageBatchResult |
deleteMessageBatch(String queueUrl,
List<DeleteMessageBatchRequestEntry> entries)
Simplified method form for invoking the DeleteMessageBatch operation.
|
DeleteQueueResult |
deleteQueue(DeleteQueueRequest request)
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 request)
Gets attributes for the specified queue.
|
GetQueueAttributesResult |
getQueueAttributes(String queueUrl,
List<String> attributeNames)
Simplified method form for invoking the GetQueueAttributes operation.
|
GetQueueUrlResult |
getQueueUrl(GetQueueUrlRequest request)
Returns the URL of an existing Amazon SQS queue.
|
GetQueueUrlResult |
getQueueUrl(String queueName)
Simplified method form for invoking the GetQueueUrl operation.
|
ListDeadLetterSourceQueuesResult |
listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest request)
Returns a list of your queues that have the
RedrivePolicy queue attribute configured with a
dead-letter queue. |
ListQueuesResult |
listQueues()
Simplified method form for invoking the ListQueues operation.
|
ListQueuesResult |
listQueues(ListQueuesRequest request)
Returns a list of your queues in the current region.
|
ListQueuesResult |
listQueues(String queueNamePrefix)
Simplified method form for invoking the ListQueues operation.
|
ListQueueTagsResult |
listQueueTags(ListQueueTagsRequest request)
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 request)
Deletes the messages in a queue specified by the
QueueURL parameter. |
ReceiveMessageResult |
receiveMessage(ReceiveMessageRequest request)
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 request)
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 request)
Delivers a message to the specified queue.
|
SendMessageResult |
sendMessage(String queueUrl,
String messageBody)
Simplified method form for invoking the SendMessage operation.
|
SendMessageBatchResult |
sendMessageBatch(SendMessageBatchRequest request)
Delivers up to ten messages to the specified queue.
|
SendMessageBatchResult |
sendMessageBatch(String queueUrl,
List<SendMessageBatchRequestEntry> entries)
Simplified method form for invoking the SendMessageBatch operation.
|
SetQueueAttributesResult |
setQueueAttributes(SetQueueAttributesRequest request)
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 |
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 request)
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 request)
Remove cost allocation tags from the specified Amazon SQS queue.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AmazonSQSClient()
AmazonSQSClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonSQSClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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@Deprecated public AmazonSQSClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonSQSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();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.@Deprecated public AmazonSQSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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.@Deprecated public AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonSQSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(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 static AmazonSQSClientBuilder builder()
public AddPermissionResult addPermission(AddPermissionRequest request)
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 Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
AddPermission generates a policy for you. You can use SetQueueAttributes to
upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
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:
&AttributeName.1=first
&AttributeName.2=second
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
addPermission in interface AmazonSQSaddPermissionRequest - OverLimitException - The specified action violates a limit. For example, ReceiveMessage returns this error if the
maximum number of inflight messages is reached and AddPermission returns this error if the
maximum number of permissions for the queue is reached.public AddPermissionResult addPermission(String queueUrl, String label, List<String> aWSAccountIds, List<String> actions)
AmazonSQSaddPermission in interface AmazonSQSAmazonSQS.addPermission(AddPermissionRequest)public ChangeMessageVisibilityResult changeMessageVisibility(ChangeMessageVisibilityRequest request)
Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call
ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call
ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to
extend the visibility timeout beyond the maximum, your request is rejected.
An Amazon SQS message has three basic states:
Sent to a queue by a producer.
Received from the queue by a consumer.
Deleted from the queue.
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can be a maximum of
approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the
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. To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the 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.
changeMessageVisibility in interface AmazonSQSchangeMessageVisibilityRequest - MessageNotInflightException - The specified message isn't in flight.ReceiptHandleIsInvalidException - The specified receipt handle isn't valid.public ChangeMessageVisibilityResult changeMessageVisibility(String queueUrl, String receiptHandle, Integer visibilityTimeout)
AmazonSQSchangeMessageVisibility in interface AmazonSQSAmazonSQS.changeMessageVisibility(ChangeMessageVisibilityRequest)public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest request)
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:
&AttributeName.1=first
&AttributeName.2=second
changeMessageVisibilityBatch in interface AmazonSQSchangeMessageVisibilityBatchRequest - 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.public ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(String queueUrl, List<ChangeMessageVisibilityBatchRequestEntry> entries)
AmazonSQSchangeMessageVisibilityBatch in interface AmazonSQSAmazonSQS.changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest)public CreateQueueResult createQueue(CreateQueueRequest request)
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following 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 SQS 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.
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
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:
&AttributeName.1=first
&AttributeName.2=second
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
createQueue in interface AmazonSQScreateQueueRequest - QueueDeletedRecentlyException - You must wait 60 seconds after deleting a queue before you can create another queue with the same name.QueueNameExistsException - A queue with this name already exists. 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)
AmazonSQScreateQueue in interface AmazonSQSAmazonSQS.createQueue(CreateQueueRequest)public DeleteMessageResult deleteMessage(DeleteMessageRequest request)
Deletes the specified message from the specified queue. To select the message to delete, use the
ReceiptHandle of the message (not the MessageId which you receive when you send
the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the
message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than
the retention period configured for the queue.
The ReceiptHandle is associated with a specific instance of receiving a message. If you
receive a message more than once, the ReceiptHandle is different each time you receive a message.
When you use the DeleteMessage action, you must provide the most recently received
ReceiptHandle for the message (otherwise, 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 which stores 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 during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
deleteMessage in interface AmazonSQSdeleteMessageRequest - InvalidIdFormatException - The specified receipt handle isn't valid for the current version.ReceiptHandleIsInvalidException - The specified receipt handle isn't valid.public DeleteMessageResult deleteMessage(String queueUrl, String receiptHandle)
AmazonSQSdeleteMessage in interface AmazonSQSAmazonSQS.deleteMessage(DeleteMessageRequest)public DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest request)
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:
&AttributeName.1=first
&AttributeName.2=second
deleteMessageBatch in interface AmazonSQSdeleteMessageBatchRequest - 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.public DeleteMessageBatchResult deleteMessageBatch(String queueUrl, List<DeleteMessageBatchRequestEntry> entries)
AmazonSQSdeleteMessageBatch in interface AmazonSQSAmazonSQS.deleteMessageBatch(DeleteMessageBatchRequest)public DeleteQueueResult deleteQueue(DeleteQueueRequest request)
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
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.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
deleteQueue in interface AmazonSQSdeleteQueueRequest - public DeleteQueueResult deleteQueue(String queueUrl)
AmazonSQSdeleteQueue in interface AmazonSQSAmazonSQS.deleteQueue(DeleteQueueRequest)public GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest request)
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you
can check whether QueueName ends with the .fifo suffix.
getQueueAttributes in interface AmazonSQSgetQueueAttributesRequest - InvalidAttributeNameException - The specified attribute doesn't exist.public GetQueueAttributesResult getQueueAttributes(String queueUrl, List<String> attributeNames)
AmazonSQSgetQueueAttributes in interface AmazonSQSAmazonSQS.getQueueAttributes(GetQueueAttributesRequest)public GetQueueUrlResult getQueueUrl(GetQueueUrlRequest request)
Returns the URL of an existing 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 Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
getQueueUrl in interface AmazonSQSgetQueueUrlRequest - QueueDoesNotExistException - The specified queue doesn't exist.public GetQueueUrlResult getQueueUrl(String queueName)
AmazonSQSgetQueueUrl in interface AmazonSQSAmazonSQS.getQueueUrl(GetQueueUrlRequest)public ListDeadLetterSourceQueuesResult listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest request)
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a
dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set parameter MaxResults in
the request to specify the maximum number of results to be returned in the response. If you do not set
MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and
there are additional results to display, the response includes a value for NextToken. Use
NextToken as a parameter in your next request to ListDeadLetterSourceQueues to receive
the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.
listDeadLetterSourceQueues in interface AmazonSQSlistDeadLetterSourceQueuesRequest - QueueDoesNotExistException - The specified queue doesn't exist.public ListQueueTagsResult listQueueTags(ListQueueTagsRequest request)
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
listQueueTags in interface AmazonSQSlistQueueTagsRequest - public ListQueueTagsResult listQueueTags(String queueUrl)
AmazonSQSlistQueueTags in interface AmazonSQSAmazonSQS.listQueueTags(ListQueueTagsRequest)public ListQueuesResult listQueues(ListQueuesRequest request)
Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you
specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with
the specified value are returned.
The listQueues methods supports pagination. Set parameter MaxResults in the request to
specify the maximum number of results to be returned in the response. If you do not set MaxResults,
the response includes a maximum of 1,000 results. If you set MaxResults and there are additional
results to display, the response includes a value for NextToken. Use NextToken as a
parameter in your next request to listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
listQueues in interface AmazonSQSlistQueuesRequest - public ListQueuesResult listQueues()
AmazonSQSlistQueues in interface AmazonSQSAmazonSQS.listQueues(ListQueuesRequest)public ListQueuesResult listQueues(String queueNamePrefix)
AmazonSQSlistQueues in interface AmazonSQSAmazonSQS.listQueues(ListQueuesRequest)public PurgeQueueResult purgeQueue(PurgeQueueRequest request)
Deletes the messages in a queue specified by the QueueURL parameter.
When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.
Messages sent to the queue before you call PurgeQueue might be received but are deleted
within the next minute.
Messages sent to the queue after you call PurgeQueue might be deleted while the queue is
being purged.
purgeQueue in interface AmazonSQSpurgeQueueRequest - QueueDoesNotExistException - The specified queue 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).public ReceiveMessageResult receiveMessage(ReceiveMessageRequest request)
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 SQS 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 SQS 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 SQS 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.
receiveMessage in interface AmazonSQSreceiveMessageRequest - OverLimitException - The specified action violates a limit. For example, ReceiveMessage returns this error if the
maximum number of inflight messages is reached and AddPermission returns this error if the
maximum number of permissions for the queue is reached.public ReceiveMessageResult receiveMessage(String queueUrl)
AmazonSQSreceiveMessage in interface AmazonSQSAmazonSQS.receiveMessage(ReceiveMessageRequest)public RemovePermissionResult removePermission(RemovePermissionRequest request)
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
removePermission in interface AmazonSQSremovePermissionRequest - public RemovePermissionResult removePermission(String queueUrl, String label)
AmazonSQSremovePermission in interface AmazonSQSAmazonSQS.removePermission(RemovePermissionRequest)public SendMessageResult sendMessage(SendMessageRequest request)
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.
sendMessage in interface AmazonSQSsendMessageRequest - InvalidMessageContentsException - The message contains characters outside the allowed set.UnsupportedOperationException - Error code 400. Unsupported operation.public SendMessageResult sendMessage(String queueUrl, String messageBody)
AmazonSQSsendMessage in interface AmazonSQSAmazonSQS.sendMessage(SendMessageRequest)public SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest request)
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:
&AttributeName.1=first
&AttributeName.2=second
sendMessageBatch in interface AmazonSQSsendMessageBatchRequest - 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.public SendMessageBatchResult sendMessageBatch(String queueUrl, List<SendMessageBatchRequestEntry> entries)
AmazonSQSsendMessageBatch in interface AmazonSQSAmazonSQS.sendMessageBatch(SendMessageBatchRequest)public SetQueueAttributesResult setQueueAttributes(SetQueueAttributesRequest request)
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.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission,
RemovePermission, and SetQueueAttributes actions in your IAM policy.
setQueueAttributes in interface AmazonSQSsetQueueAttributesRequest - InvalidAttributeNameException - The specified attribute doesn't exist.public SetQueueAttributesResult setQueueAttributes(String queueUrl, Map<String,String> attributes)
AmazonSQSsetQueueAttributes in interface AmazonSQSAmazonSQS.setQueueAttributes(SetQueueAttributesRequest)public TagQueueResult tagQueue(TagQueueRequest request)
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS 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.
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
tagQueue in interface AmazonSQStagQueueRequest - public TagQueueResult tagQueue(String queueUrl, Map<String,String> tags)
AmazonSQStagQueue in interface AmazonSQSAmazonSQS.tagQueue(TagQueueRequest)public UntagQueueResult untagQueue(UntagQueueRequest request)
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
untagQueue in interface AmazonSQSuntagQueueRequest - public UntagQueueResult untagQueue(String queueUrl, List<String> tagKeys)
AmazonSQSuntagQueue in interface AmazonSQSAmazonSQS.untagQueue(UntagQueueRequest)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 AmazonSQSrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonSQSshutdown in class AmazonWebServiceClient