@Generated(value="software.amazon.awssdk:codegen") public interface SqsClient extends SdkClient
builder() method.
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.
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 |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddPermissionResponse |
addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to a queue for a specific principal.
|
default AddPermissionResponse |
addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest)
Adds a permission to a queue for a specific principal.
|
static SqsClientBuilder |
builder()
Create a builder that can be used to configure and create a
SqsClient. |
default ChangeMessageVisibilityResponse |
changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new value.
|
default ChangeMessageVisibilityResponse |
changeMessageVisibility(Consumer<ChangeMessageVisibilityRequest.Builder> changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new value.
|
default ChangeMessageVisibilityBatchResponse |
changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
Changes the visibility timeout of multiple messages.
|
default ChangeMessageVisibilityBatchResponse |
changeMessageVisibilityBatch(Consumer<ChangeMessageVisibilityBatchRequest.Builder> changeMessageVisibilityBatchRequest)
Changes the visibility timeout of multiple messages.
|
static SqsClient |
create()
Create a
SqsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateQueueResponse |
createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest)
Creates a new standard or FIFO queue.
|
default CreateQueueResponse |
createQueue(CreateQueueRequest createQueueRequest)
Creates a new standard or FIFO queue.
|
default DeleteMessageResponse |
deleteMessage(Consumer<DeleteMessageRequest.Builder> deleteMessageRequest)
Deletes the specified message from the specified queue.
|
default DeleteMessageResponse |
deleteMessage(DeleteMessageRequest deleteMessageRequest)
Deletes the specified message from the specified queue.
|
default DeleteMessageBatchResponse |
deleteMessageBatch(Consumer<DeleteMessageBatchRequest.Builder> deleteMessageBatchRequest)
Deletes up to ten messages from the specified queue.
|
default DeleteMessageBatchResponse |
deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
Deletes up to ten messages from the specified queue.
|
default DeleteQueueResponse |
deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest)
Deletes the queue specified by the
QueueUrl, regardless of the queue's contents. |
default DeleteQueueResponse |
deleteQueue(DeleteQueueRequest deleteQueueRequest)
Deletes the queue specified by the
QueueUrl, regardless of the queue's contents. |
default GetQueueAttributesResponse |
getQueueAttributes(Consumer<GetQueueAttributesRequest.Builder> getQueueAttributesRequest)
Gets attributes for the specified queue.
|
default GetQueueAttributesResponse |
getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
Gets attributes for the specified queue.
|
default GetQueueUrlResponse |
getQueueUrl(Consumer<GetQueueUrlRequest.Builder> getQueueUrlRequest)
Returns the URL of an existing Amazon SQS queue.
|
default GetQueueUrlResponse |
getQueueUrl(GetQueueUrlRequest getQueueUrlRequest)
Returns the URL of an existing Amazon SQS queue.
|
default ListDeadLetterSourceQueuesResponse |
listDeadLetterSourceQueues(Consumer<ListDeadLetterSourceQueuesRequest.Builder> listDeadLetterSourceQueuesRequest)
Returns a list of your queues that have the
RedrivePolicy queue attribute configured with a
dead-letter queue. |
default ListDeadLetterSourceQueuesResponse |
listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
Returns a list of your queues that have the
RedrivePolicy queue attribute configured with a
dead-letter queue. |
default ListQueuesResponse |
listQueues()
Returns a list of your queues.
|
default ListQueuesResponse |
listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
Returns a list of your queues.
|
default ListQueuesResponse |
listQueues(ListQueuesRequest listQueuesRequest)
Returns a list of your queues.
|
default ListQueueTagsResponse |
listQueueTags(Consumer<ListQueueTagsRequest.Builder> listQueueTagsRequest)
List all cost allocation tags added to the specified Amazon SQS queue.
|
default ListQueueTagsResponse |
listQueueTags(ListQueueTagsRequest listQueueTagsRequest)
List all cost allocation tags added to the specified Amazon SQS queue.
|
default PurgeQueueResponse |
purgeQueue(Consumer<PurgeQueueRequest.Builder> purgeQueueRequest)
Deletes the messages in a queue specified by the
QueueURL parameter. |
default PurgeQueueResponse |
purgeQueue(PurgeQueueRequest purgeQueueRequest)
Deletes the messages in a queue specified by the
QueueURL parameter. |
default ReceiveMessageResponse |
receiveMessage(Consumer<ReceiveMessageRequest.Builder> receiveMessageRequest)
Retrieves one or more messages (up to 10), from the specified queue.
|
default ReceiveMessageResponse |
receiveMessage(ReceiveMessageRequest receiveMessageRequest)
Retrieves one or more messages (up to 10), from the specified queue.
|
default RemovePermissionResponse |
removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
default RemovePermissionResponse |
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes any permissions in the queue policy that matches the specified
Label parameter. |
default SendMessageResponse |
sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest)
Delivers a message to the specified queue.
|
default SendMessageResponse |
sendMessage(SendMessageRequest sendMessageRequest)
Delivers a message to the specified queue.
|
default SendMessageBatchResponse |
sendMessageBatch(Consumer<SendMessageBatchRequest.Builder> sendMessageBatchRequest)
Delivers up to ten messages to the specified queue.
|
default SendMessageBatchResponse |
sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
Delivers up to ten messages to the specified queue.
|
static ServiceMetadata |
serviceMetadata() |
default SetQueueAttributesResponse |
setQueueAttributes(Consumer<SetQueueAttributesRequest.Builder> setQueueAttributesRequest)
Sets the value of one or more queue attributes.
|
default SetQueueAttributesResponse |
setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
Sets the value of one or more queue attributes.
|
default TagQueueResponse |
tagQueue(Consumer<TagQueueRequest.Builder> tagQueueRequest)
Add cost allocation tags to the specified Amazon SQS queue.
|
default TagQueueResponse |
tagQueue(TagQueueRequest tagQueueRequest)
Add cost allocation tags to the specified Amazon SQS queue.
|
default UntagQueueResponse |
untagQueue(Consumer<UntagQueueRequest.Builder> untagQueueRequest)
Remove cost allocation tags from the specified Amazon SQS queue.
|
default UntagQueueResponse |
untagQueue(UntagQueueRequest untagQueueRequest)
Remove cost allocation tags from the specified Amazon SQS queue.
|
serviceNameclosestatic final String SERVICE_NAME
static SqsClient create()
SqsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SqsClientBuilder builder()
SqsClient.default AddPermissionResponse addPermission(AddPermissionRequest addPermissionRequest) throws OverLimitException, AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service 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 Simple Queue Service
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:
&Attribute.1=first
&Attribute.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 Simple Queue Service Developer Guide.
addPermissionRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddPermissionResponse addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest) throws OverLimitException, AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service 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 Simple Queue Service
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:
&Attribute.1=first
&Attribute.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 Simple Queue Service Developer Guide.
This is a convenience which creates an instance of the AddPermissionRequest.Builder avoiding the need to
create one manually via AddPermissionRequest.builder()
addPermissionRequest - A Consumer that will call methods on AddPermissionRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ChangeMessageVisibilityResponse changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest) throws MessageNotInflightException, ReceiptHandleIsInvalidException, AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service 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.
changeMessageVisibilityRequest - MessageNotInflightException - The specified message isn't in flight.ReceiptHandleIsInvalidException - The specified receipt handle isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ChangeMessageVisibilityResponse changeMessageVisibility(Consumer<ChangeMessageVisibilityRequest.Builder> changeMessageVisibilityRequest) throws MessageNotInflightException, ReceiptHandleIsInvalidException, AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service 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.
This is a convenience which creates an instance of the ChangeMessageVisibilityRequest.Builder avoiding
the need to create one manually via ChangeMessageVisibilityRequest.builder()
changeMessageVisibilityRequest - A Consumer that will call methods on ChangeMessageVisibilityRequest.Builder to create a
request.MessageNotInflightException - The specified message isn't in flight.ReceiptHandleIsInvalidException - The specified receipt handle isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ChangeMessageVisibilityBatchResponse changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, InvalidBatchEntryIdException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.2=second
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ChangeMessageVisibilityBatchResponse changeMessageVisibilityBatch(Consumer<ChangeMessageVisibilityBatchRequest.Builder> changeMessageVisibilityBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, InvalidBatchEntryIdException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.2=second
This is a convenience which creates an instance of the ChangeMessageVisibilityBatchRequest.Builder
avoiding the need to create one manually via ChangeMessageVisibilityBatchRequest.builder()
changeMessageVisibilityBatchRequest - A Consumer that will call methods on ChangeMessageVisibilityBatchRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateQueueResponse createQueue(CreateQueueRequest createQueueRequest) throws QueueDeletedRecentlyException, QueueNameExistsException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.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 Simple Queue Service Developer Guide.
createQueueRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateQueueResponse createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest) throws QueueDeletedRecentlyException, QueueNameExistsException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.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 Simple Queue Service Developer Guide.
This is a convenience which creates an instance of the CreateQueueRequest.Builder avoiding the need to
create one manually via CreateQueueRequest.builder()
createQueueRequest - A Consumer that will call methods on CreateQueueRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMessageResponse deleteMessage(DeleteMessageRequest deleteMessageRequest) throws InvalidIdFormatException, ReceiptHandleIsInvalidException, AwsServiceException, SdkClientException, SqsException
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.
deleteMessageRequest - InvalidIdFormatException - The specified receipt handle isn't valid for the current version.ReceiptHandleIsInvalidException - The specified receipt handle isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMessageResponse deleteMessage(Consumer<DeleteMessageRequest.Builder> deleteMessageRequest) throws InvalidIdFormatException, ReceiptHandleIsInvalidException, AwsServiceException, SdkClientException, SqsException
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.
This is a convenience which creates an instance of the DeleteMessageRequest.Builder avoiding the need to
create one manually via DeleteMessageRequest.builder()
deleteMessageRequest - A Consumer that will call methods on DeleteMessageRequest.Builder to create a request.InvalidIdFormatException - The specified receipt handle isn't valid for the current version.ReceiptHandleIsInvalidException - The specified receipt handle isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMessageBatchResponse deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, InvalidBatchEntryIdException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.2=second
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMessageBatchResponse deleteMessageBatch(Consumer<DeleteMessageBatchRequest.Builder> deleteMessageBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, InvalidBatchEntryIdException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.2=second
This is a convenience which creates an instance of the DeleteMessageBatchRequest.Builder avoiding the
need to create one manually via DeleteMessageBatchRequest.builder()
deleteMessageBatchRequest - A Consumer that will call methods on DeleteMessageBatchRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteQueueResponse deleteQueue(DeleteQueueRequest deleteQueueRequest) throws AwsServiceException, SdkClientException, SqsException
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.
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 Simple Queue Service Developer Guide.
deleteQueueRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteQueueResponse deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest) throws AwsServiceException, SdkClientException, SqsException
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.
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 Simple Queue Service Developer Guide.
This is a convenience which creates an instance of the DeleteQueueRequest.Builder avoiding the need to
create one manually via DeleteQueueRequest.builder()
deleteQueueRequest - A Consumer that will call methods on DeleteQueueRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueueAttributesResponse getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest) throws InvalidAttributeNameException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.2=second
getQueueAttributesRequest - InvalidAttributeNameException - The specified attribute doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueueAttributesResponse getQueueAttributes(Consumer<GetQueueAttributesRequest.Builder> getQueueAttributesRequest) throws InvalidAttributeNameException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.2=second
This is a convenience which creates an instance of the GetQueueAttributesRequest.Builder avoiding the
need to create one manually via GetQueueAttributesRequest.builder()
getQueueAttributesRequest - A Consumer that will call methods on GetQueueAttributesRequest.Builder to create a
request.InvalidAttributeNameException - The specified attribute doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueueUrlResponse getQueueUrl(GetQueueUrlRequest getQueueUrlRequest) throws QueueDoesNotExistException, AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service Developer
Guide.
getQueueUrlRequest - QueueDoesNotExistException - The specified queue doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueueUrlResponse getQueueUrl(Consumer<GetQueueUrlRequest.Builder> getQueueUrlRequest) throws QueueDoesNotExistException, AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service Developer
Guide.
This is a convenience which creates an instance of the GetQueueUrlRequest.Builder avoiding the need to
create one manually via GetQueueUrlRequest.builder()
getQueueUrlRequest - A Consumer that will call methods on GetQueueUrlRequest.Builder to create a request.QueueDoesNotExistException - The specified queue doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeadLetterSourceQueuesResponse listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest) throws QueueDoesNotExistException, AwsServiceException, SdkClientException, SqsException
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 specified queue doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDeadLetterSourceQueuesResponse listDeadLetterSourceQueues(Consumer<ListDeadLetterSourceQueuesRequest.Builder> listDeadLetterSourceQueuesRequest) throws QueueDoesNotExistException, AwsServiceException, SdkClientException, SqsException
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.
This is a convenience which creates an instance of the ListDeadLetterSourceQueuesRequest.Builder avoiding
the need to create one manually via ListDeadLetterSourceQueuesRequest.builder()
listDeadLetterSourceQueuesRequest - A Consumer that will call methods on ListDeadLetterSourceQueuesRequest.Builder to create a
request.QueueDoesNotExistException - The specified queue doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueueTagsResponse listQueueTags(ListQueueTagsRequest listQueueTagsRequest) throws AwsServiceException, SdkClientException, SqsException
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
listQueueTagsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueueTagsResponse listQueueTags(Consumer<ListQueueTagsRequest.Builder> listQueueTagsRequest) throws AwsServiceException, SdkClientException, SqsException
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
This is a convenience which creates an instance of the ListQueueTagsRequest.Builder avoiding the need to
create one manually via ListQueueTagsRequest.builder()
listQueueTagsRequest - A Consumer that will call methods on ListQueueTagsRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueuesResponse listQueues() throws AwsServiceException, SdkClientException, SqsException
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.
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 Simple Queue Service Developer Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistQueues(ListQueuesRequest),
AWS API
Documentationdefault ListQueuesResponse listQueues(ListQueuesRequest listQueuesRequest) throws AwsServiceException, SdkClientException, SqsException
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.
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 Simple Queue Service Developer Guide.
listQueuesRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueuesResponse listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest) throws AwsServiceException, SdkClientException, SqsException
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.
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 Simple Queue Service Developer Guide.
This is a convenience which creates an instance of the ListQueuesRequest.Builder avoiding the need to
create one manually via ListQueuesRequest.builder()
listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PurgeQueueResponse purgeQueue(PurgeQueueRequest purgeQueueRequest) throws QueueDoesNotExistException, PurgeQueueInProgressException, AwsServiceException, SdkClientException, SqsException
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.
purgeQueueRequest - 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).SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PurgeQueueResponse purgeQueue(Consumer<PurgeQueueRequest.Builder> purgeQueueRequest) throws QueueDoesNotExistException, PurgeQueueInProgressException, AwsServiceException, SdkClientException, SqsException
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.
This is a convenience which creates an instance of the PurgeQueueRequest.Builder avoiding the need to
create one manually via PurgeQueueRequest.builder()
purgeQueueRequest - A Consumer that will call methods on PurgeQueueRequest.Builder to create a request.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).SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ReceiveMessageResponse receiveMessage(ReceiveMessageRequest receiveMessageRequest) throws OverLimitException, AwsServiceException, SdkClientException, SqsException
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ReceiveMessageResponse receiveMessage(Consumer<ReceiveMessageRequest.Builder> receiveMessageRequest) throws OverLimitException, AwsServiceException, SdkClientException, SqsException
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.
This is a convenience which creates an instance of the ReceiveMessageRequest.Builder avoiding the need to
create one manually via ReceiveMessageRequest.builder()
receiveMessageRequest - A Consumer that will call methods on ReceiveMessageRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest) throws AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service 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.
removePermissionRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemovePermissionResponse removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest) throws AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service 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.
This is a convenience which creates an instance of the RemovePermissionRequest.Builder avoiding the need
to create one manually via RemovePermissionRequest.builder()
removePermissionRequest - A Consumer that will call methods on RemovePermissionRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws InvalidMessageContentsException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault SendMessageResponse sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest) throws InvalidMessageContentsException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
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.
This is a convenience which creates an instance of the SendMessageRequest.Builder avoiding the need to
create one manually via SendMessageRequest.builder()
sendMessageRequest - A Consumer that will call methods on SendMessageRequest.Builder to create a request.InvalidMessageContentsException - The message contains characters outside the allowed set.UnsupportedOperationException - Error code 400. Unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault SendMessageBatchResponse sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, BatchRequestTooLongException, InvalidBatchEntryIdException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.2=second
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault SendMessageBatchResponse sendMessageBatch(Consumer<SendMessageBatchRequest.Builder> sendMessageBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, BatchRequestTooLongException, InvalidBatchEntryIdException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
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=first
&Attribute.2=second
This is a convenience which creates an instance of the SendMessageBatchRequest.Builder avoiding the need
to create one manually via SendMessageBatchRequest.builder()
sendMessageBatchRequest - A Consumer that will call methods on SendMessageBatchRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault SetQueueAttributesResponse setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest) throws InvalidAttributeNameException, AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service 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.
setQueueAttributesRequest - InvalidAttributeNameException - The specified attribute doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetQueueAttributesResponse setQueueAttributes(Consumer<SetQueueAttributesRequest.Builder> setQueueAttributesRequest) throws InvalidAttributeNameException, AwsServiceException, SdkClientException, SqsException
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 Simple Queue Service 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.
This is a convenience which creates an instance of the SetQueueAttributesRequest.Builder avoiding the
need to create one manually via SetQueueAttributesRequest.builder()
setQueueAttributesRequest - A Consumer that will call methods on SetQueueAttributesRequest.Builder to create a
request.InvalidAttributeNameException - The specified attribute doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagQueueResponse tagQueue(TagQueueRequest tagQueueRequest) throws AwsServiceException, SdkClientException, SqsException
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your 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.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
tagQueueRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagQueueResponse tagQueue(Consumer<TagQueueRequest.Builder> tagQueueRequest) throws AwsServiceException, SdkClientException, SqsException
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your 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.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
This is a convenience which creates an instance of the TagQueueRequest.Builder avoiding the need to
create one manually via TagQueueRequest.builder()
tagQueueRequest - A Consumer that will call methods on TagQueueRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagQueueResponse untagQueue(UntagQueueRequest untagQueueRequest) throws AwsServiceException, SdkClientException, SqsException
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
untagQueueRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagQueueResponse untagQueue(Consumer<UntagQueueRequest.Builder> untagQueueRequest) throws AwsServiceException, SdkClientException, SqsException
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
This is a convenience which creates an instance of the UntagQueueRequest.Builder avoiding the need to
create one manually via UntagQueueRequest.builder()
untagQueueRequest - A Consumer that will call methods on UntagQueueRequest.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SqsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.