Interface SqsClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SqsClient extends AwsClient
Service client for accessing Amazon SQS. This can be created using the staticbuilder()
method.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
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AddPermissionResponse
addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest)
Adds a permission to a queue for a specific principal.default AddPermissionResponse
addPermission(AddPermissionRequest 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 aSqsClient
.default CancelMessageMoveTaskResponse
cancelMessageMoveTask(Consumer<CancelMessageMoveTaskRequest.Builder> cancelMessageMoveTaskRequest)
Cancels a specified message movement task.default CancelMessageMoveTaskResponse
cancelMessageMoveTask(CancelMessageMoveTaskRequest cancelMessageMoveTaskRequest)
Cancels a specified message movement task.default ChangeMessageVisibilityResponse
changeMessageVisibility(Consumer<ChangeMessageVisibilityRequest.Builder> changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new value.default ChangeMessageVisibilityResponse
changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
Changes the visibility timeout of a specified message in a queue to a new value.default ChangeMessageVisibilityBatchResponse
changeMessageVisibilityBatch(Consumer<ChangeMessageVisibilityBatchRequest.Builder> changeMessageVisibilityBatchRequest)
Changes the visibility timeout of multiple messages.default ChangeMessageVisibilityBatchResponse
changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
Changes the visibility timeout of multiple messages.static SqsClient
create()
Create aSqsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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 theQueueUrl
, regardless of the queue's contents.default DeleteQueueResponse
deleteQueue(DeleteQueueRequest deleteQueueRequest)
Deletes the queue specified by theQueueUrl
, 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 theRedrivePolicy
queue attribute configured with a dead-letter queue.default ListDeadLetterSourceQueuesResponse
listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
Returns a list of your queues that have theRedrivePolicy
queue attribute configured with a dead-letter queue.default ListDeadLetterSourceQueuesIterable
listDeadLetterSourceQueuesPaginator(Consumer<ListDeadLetterSourceQueuesRequest.Builder> listDeadLetterSourceQueuesRequest)
This is a variant oflistDeadLetterSourceQueues(software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest)
operation.default ListDeadLetterSourceQueuesIterable
listDeadLetterSourceQueuesPaginator(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest)
This is a variant oflistDeadLetterSourceQueues(software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest)
operation.default ListMessageMoveTasksResponse
listMessageMoveTasks(Consumer<ListMessageMoveTasksRequest.Builder> listMessageMoveTasksRequest)
Gets the most recent message movement tasks (up to 10) under a specific source queue.default ListMessageMoveTasksResponse
listMessageMoveTasks(ListMessageMoveTasksRequest listMessageMoveTasksRequest)
Gets the most recent message movement tasks (up to 10) under a specific source queue.default ListQueuesResponse
listQueues()
Returns a list of your queues in the current region.default ListQueuesResponse
listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
Returns a list of your queues in the current region.default ListQueuesResponse
listQueues(ListQueuesRequest listQueuesRequest)
Returns a list of your queues in the current region.default ListQueuesIterable
listQueuesPaginator()
This is a variant oflistQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation.default ListQueuesIterable
listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
This is a variant oflistQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation.default ListQueuesIterable
listQueuesPaginator(ListQueuesRequest listQueuesRequest)
This is a variant oflistQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation.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 available messages in a queue (including in-flight messages) specified by theQueueURL
parameter.default PurgeQueueResponse
purgeQueue(PurgeQueueRequest purgeQueueRequest)
Deletes available messages in a queue (including in-flight messages) specified by theQueueURL
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 specifiedLabel
parameter.default RemovePermissionResponse
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes any permissions in the queue policy that matches the specifiedLabel
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)
You can useSendMessageBatch
to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all).default SendMessageBatchResponse
sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
You can useSendMessageBatch
to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all).default SqsServiceClientConfiguration
serviceClientConfiguration()
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 StartMessageMoveTaskResponse
startMessageMoveTask(Consumer<StartMessageMoveTaskRequest.Builder> startMessageMoveTaskRequest)
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.default StartMessageMoveTaskResponse
startMessageMoveTask(StartMessageMoveTaskRequest startMessageMoveTaskRequest)
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.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.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
addPermission
default AddPermissionResponse addPermission(AddPermissionRequest addPermissionRequest) throws OverLimitException, RequestThrottledException, QueueDoesNotExistException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, 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 SQS Developer Guide.
-
AddPermission
generates a policy for you. You can useSetQueueAttributes
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 seven actions per statement.
-
To remove the ability to change queue permissions, you must deny permission to the
AddPermission
,RemovePermission
, andSetQueueAttributes
actions in your IAM policy. -
Amazon SQS
AddPermission
does not support adding a non-account principal.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
- Parameters:
addPermissionRequest
-- Returns:
- Result of the AddPermission operation returned by the service.
- Throws:
OverLimitException
- The specified action violates a limit. For example,ReceiveMessage
returns this error if the maximum number of in flight messages is reached andAddPermission
returns this error if the maximum number of permissions for the queue is reached.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
addPermission
default AddPermissionResponse addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest) throws OverLimitException, RequestThrottledException, QueueDoesNotExistException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, 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 SQS Developer Guide.
-
AddPermission
generates a policy for you. You can useSetQueueAttributes
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 seven actions per statement.
-
To remove the ability to change queue permissions, you must deny permission to the
AddPermission
,RemovePermission
, andSetQueueAttributes
actions in your IAM policy. -
Amazon SQS
AddPermission
does not support adding a non-account principal.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
This is a convenience which creates an instance of the
AddPermissionRequest.Builder
avoiding the need to create one manually viaAddPermissionRequest.builder()
- Parameters:
addPermissionRequest
- AConsumer
that will call methods onAddPermissionRequest.Builder
to create a request.- Returns:
- Result of the AddPermission operation returned by the service.
- Throws:
OverLimitException
- The specified action violates a limit. For example,ReceiveMessage
returns this error if the maximum number of in flight messages is reached andAddPermission
returns this error if the maximum number of permissions for the queue is reached.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
cancelMessageMoveTask
default CancelMessageMoveTaskResponse cancelMessageMoveTask(CancelMessageMoveTaskRequest cancelMessageMoveTaskRequest) throws ResourceNotFoundException, RequestThrottledException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
-
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
-
Currently, only standard queues are supported.
-
Only one active message movement task is supported per queue at any given time.
- Parameters:
cancelMessageMoveTaskRequest
-- Returns:
- Result of the CancelMessageMoveTask operation returned by the service.
- Throws:
ResourceNotFoundException
- One or more specified resources don't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
cancelMessageMoveTask
default CancelMessageMoveTaskResponse cancelMessageMoveTask(Consumer<CancelMessageMoveTaskRequest.Builder> cancelMessageMoveTaskRequest) throws ResourceNotFoundException, RequestThrottledException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
-
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
-
Currently, only standard queues are supported.
-
Only one active message movement task is supported per queue at any given time.
This is a convenience which creates an instance of the
CancelMessageMoveTaskRequest.Builder
avoiding the need to create one manually viaCancelMessageMoveTaskRequest.builder()
- Parameters:
cancelMessageMoveTaskRequest
- AConsumer
that will call methods onCancelMessageMoveTaskRequest.Builder
to create a request.- Returns:
- Result of the CancelMessageMoveTask operation returned by the service.
- Throws:
ResourceNotFoundException
- One or more specified resources don't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
changeMessageVisibility
default ChangeMessageVisibilityResponse changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest) throws MessageNotInflightException, ReceiptHandleIsInvalidException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidAddressException, InvalidSecurityException, 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 SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the message, and you send a ChangeMessageVisibility call with
VisibilityTimeout
set to 10 seconds, the 10 seconds begin to count from the time that you make theChangeMessageVisibility
call. Thus, any attempt to change the visibility timeout or to delete that message 10 seconds after you initially change the visibility timeout (a total of 25 seconds) might result in an error.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 in flight messages.
Limits that apply to in flight 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 in flight 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 in flight 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.- Parameters:
changeMessageVisibilityRequest
-- Returns:
- Result of the ChangeMessageVisibility operation returned by the service.
- Throws:
MessageNotInflightException
- The specified message isn't in flight.ReceiptHandleIsInvalidException
- The specified receipt handle isn't valid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
changeMessageVisibility
default ChangeMessageVisibilityResponse changeMessageVisibility(Consumer<ChangeMessageVisibilityRequest.Builder> changeMessageVisibilityRequest) throws MessageNotInflightException, ReceiptHandleIsInvalidException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidAddressException, InvalidSecurityException, 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 SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the message, and you send a ChangeMessageVisibility call with
VisibilityTimeout
set to 10 seconds, the 10 seconds begin to count from the time that you make theChangeMessageVisibility
call. Thus, any attempt to change the visibility timeout or to delete that message 10 seconds after you initially change the visibility timeout (a total of 25 seconds) might result in an error.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 in flight messages.
Limits that apply to in flight 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 in flight 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 in flight 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 viaChangeMessageVisibilityRequest.builder()
- Parameters:
changeMessageVisibilityRequest
- AConsumer
that will call methods onChangeMessageVisibilityRequest.Builder
to create a request.- Returns:
- Result of the ChangeMessageVisibility operation returned by the service.
- Throws:
MessageNotInflightException
- The specified message isn't in flight.ReceiptHandleIsInvalidException
- The specified receipt handle isn't valid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
changeMessageVisibilityBatch
default ChangeMessageVisibilityBatchResponse changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, InvalidBatchEntryIdException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidAddressException, InvalidSecurityException, 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 10ChangeMessageVisibility
requests with eachChangeMessageVisibilityBatch
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
.- Parameters:
changeMessageVisibilityBatchRequest
-- Returns:
- Result of the ChangeMessageVisibilityBatch operation returned by the service.
- Throws:
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 sameId
.InvalidBatchEntryIdException
- TheId
of a batch entry in a batch request doesn't abide by the specification.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
changeMessageVisibilityBatch
default ChangeMessageVisibilityBatchResponse changeMessageVisibilityBatch(Consumer<ChangeMessageVisibilityBatchRequest.Builder> changeMessageVisibilityBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, InvalidBatchEntryIdException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidAddressException, InvalidSecurityException, 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 10ChangeMessageVisibility
requests with eachChangeMessageVisibilityBatch
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
.
This is a convenience which creates an instance of the
ChangeMessageVisibilityBatchRequest.Builder
avoiding the need to create one manually viaChangeMessageVisibilityBatchRequest.builder()
- Parameters:
changeMessageVisibilityBatchRequest
- AConsumer
that will call methods onChangeMessageVisibilityBatchRequest.Builder
to create a request.- Returns:
- Result of the ChangeMessageVisibilityBatch operation returned by the service.
- Throws:
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 sameId
.InvalidBatchEntryIdException
- TheId
of a batch entry in a batch request doesn't abide by the specification.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
createQueue
default CreateQueueResponse createQueue(CreateQueueRequest createQueueRequest) throws QueueDeletedRecentlyException, QueueNameExistsException, RequestThrottledException, InvalidAddressException, InvalidAttributeNameException, InvalidAttributeValueException, UnsupportedOperationException, InvalidSecurityException, AwsServiceException, SdkClientException, SqsException
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 theQueueName
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.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
- Parameters:
createQueueRequest
-- Returns:
- Result of the CreateQueue operation returned by the service.
- Throws:
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.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidAttributeNameException
- The specified attribute doesn't exist.InvalidAttributeValueException
- A queue attribute value is invalid.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createQueue
default CreateQueueResponse createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest) throws QueueDeletedRecentlyException, QueueNameExistsException, RequestThrottledException, InvalidAddressException, InvalidAttributeNameException, InvalidAttributeValueException, UnsupportedOperationException, InvalidSecurityException, AwsServiceException, SdkClientException, SqsException
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 theQueueName
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.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
This is a convenience which creates an instance of the
CreateQueueRequest.Builder
avoiding the need to create one manually viaCreateQueueRequest.builder()
- Parameters:
createQueueRequest
- AConsumer
that will call methods onCreateQueueRequest.Builder
to create a request.- Returns:
- Result of the CreateQueue operation returned by the service.
- Throws:
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.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidAttributeNameException
- The specified attribute doesn't exist.InvalidAttributeValueException
- A queue attribute value is invalid.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
deleteMessage
default DeleteMessageResponse deleteMessage(DeleteMessageRequest deleteMessageRequest) throws InvalidIdFormatException, ReceiptHandleIsInvalidException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidSecurityException, InvalidAddressException, AwsServiceException, SdkClientException, SqsException
Deletes the specified message from the specified queue. To select the message to delete, use the
ReceiptHandle
of the message (not theMessageId
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, theReceiptHandle
is different each time you receive a message. When you use theDeleteMessage
action, you must provide the most recently receivedReceiptHandle
for the message (otherwise, the request succeeds, but the message will 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.
- Parameters:
deleteMessageRequest
-- Returns:
- Result of the DeleteMessage operation returned by the service.
- Throws:
InvalidIdFormatException
- The specified receipt handle isn't valid for the current version.ReceiptHandleIsInvalidException
- The specified receipt handle isn't valid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteMessage
default DeleteMessageResponse deleteMessage(Consumer<DeleteMessageRequest.Builder> deleteMessageRequest) throws InvalidIdFormatException, ReceiptHandleIsInvalidException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidSecurityException, InvalidAddressException, AwsServiceException, SdkClientException, SqsException
Deletes the specified message from the specified queue. To select the message to delete, use the
ReceiptHandle
of the message (not theMessageId
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, theReceiptHandle
is different each time you receive a message. When you use theDeleteMessage
action, you must provide the most recently receivedReceiptHandle
for the message (otherwise, the request succeeds, but the message will 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 viaDeleteMessageRequest.builder()
- Parameters:
deleteMessageRequest
- AConsumer
that will call methods onDeleteMessageRequest.Builder
to create a request.- Returns:
- Result of the DeleteMessage operation returned by the service.
- Throws:
InvalidIdFormatException
- The specified receipt handle isn't valid for the current version.ReceiptHandleIsInvalidException
- The specified receipt handle isn't valid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteMessageBatch
default DeleteMessageBatchResponse deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, InvalidBatchEntryIdException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidAddressException, InvalidSecurityException, 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
.- Parameters:
deleteMessageBatchRequest
-- Returns:
- Result of the DeleteMessageBatch operation returned by the service.
- Throws:
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 sameId
.InvalidBatchEntryIdException
- TheId
of a batch entry in a batch request doesn't abide by the specification.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteMessageBatch
default DeleteMessageBatchResponse deleteMessageBatch(Consumer<DeleteMessageBatchRequest.Builder> deleteMessageBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, InvalidBatchEntryIdException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidAddressException, InvalidSecurityException, 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
.
This is a convenience which creates an instance of the
DeleteMessageBatchRequest.Builder
avoiding the need to create one manually viaDeleteMessageBatchRequest.builder()
- Parameters:
deleteMessageBatchRequest
- AConsumer
that will call methods onDeleteMessageBatchRequest.Builder
to create a request.- Returns:
- Result of the DeleteMessageBatch operation returned by the service.
- Throws:
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 sameId
.InvalidBatchEntryIdException
- TheId
of a batch entry in a batch request doesn't abide by the specification.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteQueue
default DeleteQueueResponse deleteQueue(DeleteQueueRequest deleteQueueRequest) throws RequestThrottledException, QueueDoesNotExistException, InvalidAddressException, UnsupportedOperationException, InvalidSecurityException, AwsServiceException, SdkClientException, SqsException
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 username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP
GET
verb.- Parameters:
deleteQueueRequest
-- Returns:
- Result of the DeleteQueue operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidAddressException
- TheaccountId
is invalid.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteQueue
default DeleteQueueResponse deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest) throws RequestThrottledException, QueueDoesNotExistException, InvalidAddressException, UnsupportedOperationException, InvalidSecurityException, AwsServiceException, SdkClientException, SqsException
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 username in the Amazon SQS Developer Guide.
The delete operation uses the HTTP
GET
verb.
This is a convenience which creates an instance of the
DeleteQueueRequest.Builder
avoiding the need to create one manually viaDeleteQueueRequest.builder()
- Parameters:
deleteQueueRequest
- AConsumer
that will call methods onDeleteQueueRequest.Builder
to create a request.- Returns:
- Result of the DeleteQueue operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidAddressException
- TheaccountId
is invalid.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
getQueueAttributes
default GetQueueAttributesResponse getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest) throws InvalidAttributeNameException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidSecurityException, InvalidAddressException, 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.- Parameters:
getQueueAttributesRequest
-- Returns:
- Result of the GetQueueAttributes operation returned by the service.
- Throws:
InvalidAttributeNameException
- The specified attribute doesn't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
getQueueAttributes
default GetQueueAttributesResponse getQueueAttributes(Consumer<GetQueueAttributesRequest.Builder> getQueueAttributesRequest) throws InvalidAttributeNameException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidSecurityException, InvalidAddressException, 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.
This is a convenience which creates an instance of the
GetQueueAttributesRequest.Builder
avoiding the need to create one manually viaGetQueueAttributesRequest.builder()
- Parameters:
getQueueAttributesRequest
- AConsumer
that will call methods onGetQueueAttributesRequest.Builder
to create a request.- Returns:
- Result of the GetQueueAttributes operation returned by the service.
- Throws:
InvalidAttributeNameException
- The specified attribute doesn't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
getQueueUrl
default GetQueueUrlResponse getQueueUrl(GetQueueUrlRequest getQueueUrlRequest) throws RequestThrottledException, QueueDoesNotExistException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, 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, seeAddPermission
or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.- Parameters:
getQueueUrlRequest
-- Returns:
- Result of the GetQueueUrl operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
getQueueUrl
default GetQueueUrlResponse getQueueUrl(Consumer<GetQueueUrlRequest.Builder> getQueueUrlRequest) throws RequestThrottledException, QueueDoesNotExistException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, 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, seeAddPermission
or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
This is a convenience which creates an instance of the
GetQueueUrlRequest.Builder
avoiding the need to create one manually viaGetQueueUrlRequest.builder()
- Parameters:
getQueueUrlRequest
- AConsumer
that will call methods onGetQueueUrlRequest.Builder
to create a request.- Returns:
- Result of the GetQueueUrl operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listDeadLetterSourceQueues
default ListDeadLetterSourceQueuesResponse listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest) throws QueueDoesNotExistException, RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Returns a list of your queues that have the
RedrivePolicy
queue attribute configured with a dead-letter queue.The
ListDeadLetterSourceQueues
methods supports pagination. Set parameterMaxResults
in the request to specify the maximum number of results to be returned in the response. If you do not setMaxResults
, the response includes a maximum of 1,000 results. If you setMaxResults
and there are additional results to display, the response includes a value forNextToken
. UseNextToken
as a parameter in your next request toListDeadLetterSourceQueues
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.
- Parameters:
listDeadLetterSourceQueuesRequest
-- Returns:
- Result of the ListDeadLetterSourceQueues operation returned by the service.
- Throws:
QueueDoesNotExistException
- The specified queue doesn't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listDeadLetterSourceQueues
default ListDeadLetterSourceQueuesResponse listDeadLetterSourceQueues(Consumer<ListDeadLetterSourceQueuesRequest.Builder> listDeadLetterSourceQueuesRequest) throws QueueDoesNotExistException, RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Returns a list of your queues that have the
RedrivePolicy
queue attribute configured with a dead-letter queue.The
ListDeadLetterSourceQueues
methods supports pagination. Set parameterMaxResults
in the request to specify the maximum number of results to be returned in the response. If you do not setMaxResults
, the response includes a maximum of 1,000 results. If you setMaxResults
and there are additional results to display, the response includes a value forNextToken
. UseNextToken
as a parameter in your next request toListDeadLetterSourceQueues
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.
This is a convenience which creates an instance of the
ListDeadLetterSourceQueuesRequest.Builder
avoiding the need to create one manually viaListDeadLetterSourceQueuesRequest.builder()
- Parameters:
listDeadLetterSourceQueuesRequest
- AConsumer
that will call methods onListDeadLetterSourceQueuesRequest.Builder
to create a request.- Returns:
- Result of the ListDeadLetterSourceQueues operation returned by the service.
- Throws:
QueueDoesNotExistException
- The specified queue doesn't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listDeadLetterSourceQueuesPaginator
default ListDeadLetterSourceQueuesIterable listDeadLetterSourceQueuesPaginator(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest) throws QueueDoesNotExistException, RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
This is a variant of
listDeadLetterSourceQueues(software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sqs.paginators.ListDeadLetterSourceQueuesIterable responses = client.listDeadLetterSourceQueuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sqs.paginators.ListDeadLetterSourceQueuesIterable responses = client .listDeadLetterSourceQueuesPaginator(request); for (software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sqs.paginators.ListDeadLetterSourceQueuesIterable responses = client.listDeadLetterSourceQueuesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeadLetterSourceQueues(software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest)
operation.- Parameters:
listDeadLetterSourceQueuesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
QueueDoesNotExistException
- The specified queue doesn't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listDeadLetterSourceQueuesPaginator
default ListDeadLetterSourceQueuesIterable listDeadLetterSourceQueuesPaginator(Consumer<ListDeadLetterSourceQueuesRequest.Builder> listDeadLetterSourceQueuesRequest) throws QueueDoesNotExistException, RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
This is a variant of
listDeadLetterSourceQueues(software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sqs.paginators.ListDeadLetterSourceQueuesIterable responses = client.listDeadLetterSourceQueuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sqs.paginators.ListDeadLetterSourceQueuesIterable responses = client .listDeadLetterSourceQueuesPaginator(request); for (software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sqs.paginators.ListDeadLetterSourceQueuesIterable responses = client.listDeadLetterSourceQueuesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeadLetterSourceQueues(software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest)
operation.
This is a convenience which creates an instance of the
ListDeadLetterSourceQueuesRequest.Builder
avoiding the need to create one manually viaListDeadLetterSourceQueuesRequest.builder()
- Parameters:
listDeadLetterSourceQueuesRequest
- AConsumer
that will call methods onListDeadLetterSourceQueuesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
QueueDoesNotExistException
- The specified queue doesn't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listMessageMoveTasks
default ListMessageMoveTasksResponse listMessageMoveTasks(ListMessageMoveTasksRequest listMessageMoveTasksRequest) throws ResourceNotFoundException, RequestThrottledException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Gets the most recent message movement tasks (up to 10) under a specific source queue.
-
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
-
Currently, only standard queues are supported.
-
Only one active message movement task is supported per queue at any given time.
- Parameters:
listMessageMoveTasksRequest
-- Returns:
- Result of the ListMessageMoveTasks operation returned by the service.
- Throws:
ResourceNotFoundException
- One or more specified resources don't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
listMessageMoveTasks
default ListMessageMoveTasksResponse listMessageMoveTasks(Consumer<ListMessageMoveTasksRequest.Builder> listMessageMoveTasksRequest) throws ResourceNotFoundException, RequestThrottledException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Gets the most recent message movement tasks (up to 10) under a specific source queue.
-
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
-
Currently, only standard queues are supported.
-
Only one active message movement task is supported per queue at any given time.
This is a convenience which creates an instance of the
ListMessageMoveTasksRequest.Builder
avoiding the need to create one manually viaListMessageMoveTasksRequest.builder()
- Parameters:
listMessageMoveTasksRequest
- AConsumer
that will call methods onListMessageMoveTasksRequest.Builder
to create a request.- Returns:
- Result of the ListMessageMoveTasks operation returned by the service.
- Throws:
ResourceNotFoundException
- One or more specified resources don't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
listQueueTags
default ListQueueTagsResponse listQueueTags(ListQueueTagsRequest listQueueTagsRequest) throws RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidAddressException, InvalidSecurityException, 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 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 username in the Amazon SQS Developer Guide.
- Parameters:
listQueueTagsRequest
-- Returns:
- Result of the ListQueueTags operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listQueueTags
default ListQueueTagsResponse listQueueTags(Consumer<ListQueueTagsRequest.Builder> listQueueTagsRequest) throws RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, InvalidAddressException, InvalidSecurityException, 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 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 username in the Amazon SQS Developer Guide.
This is a convenience which creates an instance of the
ListQueueTagsRequest.Builder
avoiding the need to create one manually viaListQueueTagsRequest.builder()
- Parameters:
listQueueTagsRequest
- AConsumer
that will call methods onListQueueTagsRequest.Builder
to create a request.- Returns:
- Result of the ListQueueTags operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listQueues
default ListQueuesResponse listQueues(ListQueuesRequest listQueuesRequest) throws RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
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 parameterMaxResults
in the request to specify the maximum number of results to be returned in the response. If you do not setMaxResults
, the response includes a maximum of 1,000 results. If you setMaxResults
and there are additional results to display, the response includes a value forNextToken
. UseNextToken
as a parameter in your next request tolistQueues
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 username in the Amazon SQS Developer Guide.
- Parameters:
listQueuesRequest
-- Returns:
- Result of the ListQueues operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listQueues
default ListQueuesResponse listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest) throws RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
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 parameterMaxResults
in the request to specify the maximum number of results to be returned in the response. If you do not setMaxResults
, the response includes a maximum of 1,000 results. If you setMaxResults
and there are additional results to display, the response includes a value forNextToken
. UseNextToken
as a parameter in your next request tolistQueues
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 username in the Amazon SQS Developer Guide.
This is a convenience which creates an instance of the
ListQueuesRequest.Builder
avoiding the need to create one manually viaListQueuesRequest.builder()
- Parameters:
listQueuesRequest
- AConsumer
that will call methods onListQueuesRequest.Builder
to create a request.- Returns:
- Result of the ListQueues operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listQueues
default ListQueuesResponse listQueues() throws RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
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 parameterMaxResults
in the request to specify the maximum number of results to be returned in the response. If you do not setMaxResults
, the response includes a maximum of 1,000 results. If you setMaxResults
and there are additional results to display, the response includes a value forNextToken
. UseNextToken
as a parameter in your next request tolistQueues
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 username in the Amazon SQS Developer Guide.
- Returns:
- Result of the ListQueues operation returned by the service.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
listQueues(ListQueuesRequest)
, AWS API Documentation
-
listQueuesPaginator
default ListQueuesIterable listQueuesPaginator() throws RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
This is a variant of
listQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); for (software.amazon.awssdk.services.sqs.model.ListQueuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
listQueuesPaginator(ListQueuesRequest)
, AWS API Documentation
-
listQueuesPaginator
default ListQueuesIterable listQueuesPaginator(ListQueuesRequest listQueuesRequest) throws RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
This is a variant of
listQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); for (software.amazon.awssdk.services.sqs.model.ListQueuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation.- Parameters:
listQueuesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
listQueuesPaginator
default ListQueuesIterable listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest) throws RequestThrottledException, InvalidSecurityException, InvalidAddressException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
This is a variant of
listQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); for (software.amazon.awssdk.services.sqs.model.ListQueuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sqs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueues(software.amazon.awssdk.services.sqs.model.ListQueuesRequest)
operation.
This is a convenience which creates an instance of the
ListQueuesRequest.Builder
avoiding the need to create one manually viaListQueuesRequest.builder()
- Parameters:
listQueuesRequest
- AConsumer
that will call methods onListQueuesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
purgeQueue
default PurgeQueueResponse purgeQueue(PurgeQueueRequest purgeQueueRequest) throws QueueDoesNotExistException, PurgeQueueInProgressException, RequestThrottledException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Deletes available messages in a queue (including in-flight messages) 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.- Parameters:
purgeQueueRequest
-- Returns:
- Result of the PurgeQueue operation returned by the service.
- Throws:
QueueDoesNotExistException
- The specified queue doesn't exist.PurgeQueueInProgressException
- Indicates that the specified queue previously received aPurgeQueue
request within the last 60 seconds (the time it can take to delete the messages in the queue).RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
purgeQueue
default PurgeQueueResponse purgeQueue(Consumer<PurgeQueueRequest.Builder> purgeQueueRequest) throws QueueDoesNotExistException, PurgeQueueInProgressException, RequestThrottledException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Deletes available messages in a queue (including in-flight messages) 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 viaPurgeQueueRequest.builder()
- Parameters:
purgeQueueRequest
- AConsumer
that will call methods onPurgeQueueRequest.Builder
to create a request.- Returns:
- Result of the PurgeQueue operation returned by the service.
- Throws:
QueueDoesNotExistException
- The specified queue doesn't exist.PurgeQueueInProgressException
- Indicates that the specified queue previously received aPurgeQueue
request within the last 60 seconds (the time it can take to delete the messages in the queue).RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
receiveMessage
default ReceiveMessageResponse receiveMessage(ReceiveMessageRequest receiveMessageRequest) throws UnsupportedOperationException, OverLimitException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottledException, KmsAccessDeniedException, KmsInvalidKeyUsageException, InvalidAddressException, 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 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 perReceiveMessage
call. If the number of messages in the queue is extremely small, you might not receive any messages in a particularReceiveMessage
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.
- Parameters:
receiveMessageRequest
-- Returns:
- Result of the ReceiveMessage operation returned by the service.
- Throws:
UnsupportedOperationException
- Error code 400. Unsupported operation.OverLimitException
- The specified action violates a limit. For example,ReceiveMessage
returns this error if the maximum number of in flight messages is reached andAddPermission
returns this error if the maximum number of permissions for the queue is reached.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.KmsDisabledException
- The request was denied due to request throttling.KmsInvalidStateException
- The request was rejected because the state of the specified resource is not valid for this request.KmsNotFoundException
- The request was rejected because the specified entity or resource could not be found.KmsOptInRequiredException
- The request was rejected because the specified key policy isn't syntactically or semantically correct.KmsThrottledException
- Amazon Web Services KMS throttles requests for the following conditions.KmsAccessDeniedException
- The caller doesn't have the required KMS access.KmsInvalidKeyUsageException
- The request was rejected for one of the following reasons:-
The KeyUsage value of the KMS key is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).
-
InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
receiveMessage
default ReceiveMessageResponse receiveMessage(Consumer<ReceiveMessageRequest.Builder> receiveMessageRequest) throws UnsupportedOperationException, OverLimitException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottledException, KmsAccessDeniedException, KmsInvalidKeyUsageException, InvalidAddressException, 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 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 perReceiveMessage
call. If the number of messages in the queue is extremely small, you might not receive any messages in a particularReceiveMessage
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.
This is a convenience which creates an instance of the
ReceiveMessageRequest.Builder
avoiding the need to create one manually viaReceiveMessageRequest.builder()
- Parameters:
receiveMessageRequest
- AConsumer
that will call methods onReceiveMessageRequest.Builder
to create a request.- Returns:
- Result of the ReceiveMessage operation returned by the service.
- Throws:
UnsupportedOperationException
- Error code 400. Unsupported operation.OverLimitException
- The specified action violates a limit. For example,ReceiveMessage
returns this error if the maximum number of in flight messages is reached andAddPermission
returns this error if the maximum number of permissions for the queue is reached.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.KmsDisabledException
- The request was denied due to request throttling.KmsInvalidStateException
- The request was rejected because the state of the specified resource is not valid for this request.KmsNotFoundException
- The request was rejected because the specified entity or resource could not be found.KmsOptInRequiredException
- The request was rejected because the specified key policy isn't syntactically or semantically correct.KmsThrottledException
- Amazon Web Services KMS throttles requests for the following conditions.KmsAccessDeniedException
- The caller doesn't have the required KMS access.KmsInvalidKeyUsageException
- The request was rejected for one of the following reasons:-
The KeyUsage value of the KMS key is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).
-
InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
removePermission
default RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest) throws InvalidAddressException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, UnsupportedOperationException, 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 username in the Amazon SQS Developer Guide.
-
To remove the ability to change queue permissions, you must deny permission to the
AddPermission
,RemovePermission
, andSetQueueAttributes
actions in your IAM policy.
- Parameters:
removePermissionRequest
-- Returns:
- Result of the RemovePermission operation returned by the service.
- Throws:
InvalidAddressException
- TheaccountId
is invalid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
removePermission
default RemovePermissionResponse removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest) throws InvalidAddressException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, UnsupportedOperationException, 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 username in the Amazon SQS Developer Guide.
-
To remove the ability to change queue permissions, you must deny permission to the
AddPermission
,RemovePermission
, andSetQueueAttributes
actions in your IAM policy.
This is a convenience which creates an instance of the
RemovePermissionRequest.Builder
avoiding the need to create one manually viaRemovePermissionRequest.builder()
- Parameters:
removePermissionRequest
- AConsumer
that will call methods onRemovePermissionRequest.Builder
to create a request.- Returns:
- Result of the RemovePermission operation returned by the service.
- Throws:
InvalidAddressException
- TheaccountId
is invalid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
sendMessage
default SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws InvalidMessageContentsException, UnsupportedOperationException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottledException, KmsAccessDeniedException, KmsInvalidKeyUsageException, InvalidAddressException, 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.
- Parameters:
sendMessageRequest
-- Returns:
- Result of the SendMessage operation returned by the service.
- Throws:
InvalidMessageContentsException
- The message contains characters outside the allowed set.UnsupportedOperationException
- Error code 400. Unsupported operation.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.KmsDisabledException
- The request was denied due to request throttling.KmsInvalidStateException
- The request was rejected because the state of the specified resource is not valid for this request.KmsNotFoundException
- The request was rejected because the specified entity or resource could not be found.KmsOptInRequiredException
- The request was rejected because the specified key policy isn't syntactically or semantically correct.KmsThrottledException
- Amazon Web Services KMS throttles requests for the following conditions.KmsAccessDeniedException
- The caller doesn't have the required KMS access.KmsInvalidKeyUsageException
- The request was rejected for one of the following reasons:-
The KeyUsage value of the KMS key is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).
-
InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
sendMessage
default SendMessageResponse sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest) throws InvalidMessageContentsException, UnsupportedOperationException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottledException, KmsAccessDeniedException, KmsInvalidKeyUsageException, InvalidAddressException, 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 viaSendMessageRequest.builder()
- Parameters:
sendMessageRequest
- AConsumer
that will call methods onSendMessageRequest.Builder
to create a request.- Returns:
- Result of the SendMessage operation returned by the service.
- Throws:
InvalidMessageContentsException
- The message contains characters outside the allowed set.UnsupportedOperationException
- Error code 400. Unsupported operation.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.KmsDisabledException
- The request was denied due to request throttling.KmsInvalidStateException
- The request was rejected because the state of the specified resource is not valid for this request.KmsNotFoundException
- The request was rejected because the specified entity or resource could not be found.KmsOptInRequiredException
- The request was rejected because the specified key policy isn't syntactically or semantically correct.KmsThrottledException
- Amazon Web Services KMS throttles requests for the following conditions.KmsAccessDeniedException
- The caller doesn't have the required KMS access.KmsInvalidKeyUsageException
- The request was rejected for one of the following reasons:-
The KeyUsage value of the KMS key is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).
-
InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
sendMessageBatch
default SendMessageBatchResponse sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, BatchRequestTooLongException, InvalidBatchEntryIdException, UnsupportedOperationException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottledException, KmsAccessDeniedException, KmsInvalidKeyUsageException, InvalidAddressException, AwsServiceException, SdkClientException, SqsException
You can use
SendMessageBatch
to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version ofSendMessage.
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 KiB (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.- Parameters:
sendMessageBatchRequest
-- Returns:
- Result of the SendMessageBatch operation returned by the service.
- Throws:
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 sameId
.BatchRequestTooLongException
- The length of all the messages put together is more than the limit.InvalidBatchEntryIdException
- TheId
of a batch entry in a batch request doesn't abide by the specification.UnsupportedOperationException
- Error code 400. Unsupported operation.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.KmsDisabledException
- The request was denied due to request throttling.KmsInvalidStateException
- The request was rejected because the state of the specified resource is not valid for this request.KmsNotFoundException
- The request was rejected because the specified entity or resource could not be found.KmsOptInRequiredException
- The request was rejected because the specified key policy isn't syntactically or semantically correct.KmsThrottledException
- Amazon Web Services KMS throttles requests for the following conditions.KmsAccessDeniedException
- The caller doesn't have the required KMS access.KmsInvalidKeyUsageException
- The request was rejected for one of the following reasons:-
The KeyUsage value of the KMS key is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).
-
InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
sendMessageBatch
default SendMessageBatchResponse sendMessageBatch(Consumer<SendMessageBatchRequest.Builder> sendMessageBatchRequest) throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException, BatchRequestTooLongException, InvalidBatchEntryIdException, UnsupportedOperationException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, KmsDisabledException, KmsInvalidStateException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottledException, KmsAccessDeniedException, KmsInvalidKeyUsageException, InvalidAddressException, AwsServiceException, SdkClientException, SqsException
You can use
SendMessageBatch
to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version ofSendMessage.
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 KiB (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.
This is a convenience which creates an instance of the
SendMessageBatchRequest.Builder
avoiding the need to create one manually viaSendMessageBatchRequest.builder()
- Parameters:
sendMessageBatchRequest
- AConsumer
that will call methods onSendMessageBatchRequest.Builder
to create a request.- Returns:
- Result of the SendMessageBatch operation returned by the service.
- Throws:
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 sameId
.BatchRequestTooLongException
- The length of all the messages put together is more than the limit.InvalidBatchEntryIdException
- TheId
of a batch entry in a batch request doesn't abide by the specification.UnsupportedOperationException
- Error code 400. Unsupported operation.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.KmsDisabledException
- The request was denied due to request throttling.KmsInvalidStateException
- The request was rejected because the state of the specified resource is not valid for this request.KmsNotFoundException
- The request was rejected because the specified entity or resource could not be found.KmsOptInRequiredException
- The request was rejected because the specified key policy isn't syntactically or semantically correct.KmsThrottledException
- Amazon Web Services KMS throttles requests for the following conditions.KmsAccessDeniedException
- The caller doesn't have the required KMS access.KmsInvalidKeyUsageException
- The request was rejected for one of the following reasons:-
The KeyUsage value of the KMS key is incompatible with the API operation.
-
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).
-
InvalidAddressException
- TheaccountId
is invalid.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.AwsServiceException
- See Also:
- AWS API Documentation
-
setQueueAttributes
default SetQueueAttributesResponse setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest) throws InvalidAttributeNameException, InvalidAttributeValueException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, OverLimitException, InvalidAddressException, InvalidSecurityException, 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 and will impact existing messages in the queue potentially causing them to be expired and deleted if theMessageRetentionPeriod
is reduced below the age of existing messages.-
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 username in the Amazon SQS Developer Guide.
-
To remove the ability to change queue permissions, you must deny permission to the
AddPermission
,RemovePermission
, andSetQueueAttributes
actions in your IAM policy.
- Parameters:
setQueueAttributesRequest
-- Returns:
- Result of the SetQueueAttributes operation returned by the service.
- Throws:
InvalidAttributeNameException
- The specified attribute doesn't exist.InvalidAttributeValueException
- A queue attribute value is invalid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.OverLimitException
- The specified action violates a limit. For example,ReceiveMessage
returns this error if the maximum number of in flight messages is reached andAddPermission
returns this error if the maximum number of permissions for the queue is reached.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
setQueueAttributes
default SetQueueAttributesResponse setQueueAttributes(Consumer<SetQueueAttributesRequest.Builder> setQueueAttributesRequest) throws InvalidAttributeNameException, InvalidAttributeValueException, RequestThrottledException, QueueDoesNotExistException, UnsupportedOperationException, OverLimitException, InvalidAddressException, InvalidSecurityException, 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 and will impact existing messages in the queue potentially causing them to be expired and deleted if theMessageRetentionPeriod
is reduced below the age of existing messages.-
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 username in the Amazon SQS Developer Guide.
-
To remove the ability to change queue permissions, you must deny permission to the
AddPermission
,RemovePermission
, andSetQueueAttributes
actions in your IAM policy.
This is a convenience which creates an instance of the
SetQueueAttributesRequest.Builder
avoiding the need to create one manually viaSetQueueAttributesRequest.builder()
- Parameters:
setQueueAttributesRequest
- AConsumer
that will call methods onSetQueueAttributesRequest.Builder
to create a request.- Returns:
- Result of the SetQueueAttributes operation returned by the service.
- Throws:
InvalidAttributeNameException
- The specified attribute doesn't exist.InvalidAttributeValueException
- A queue attribute value is invalid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.UnsupportedOperationException
- Error code 400. Unsupported operation.OverLimitException
- The specified action violates a limit. For example,ReceiveMessage
returns this error if the maximum number of in flight messages is reached andAddPermission
returns this error if the maximum number of permissions for the queue is reached.InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
startMessageMoveTask
default StartMessageMoveTaskResponse startMessageMoveTask(StartMessageMoveTaskRequest startMessageMoveTaskRequest) throws ResourceNotFoundException, RequestThrottledException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
-
This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported.
-
In dead-letter queues redrive context, the
StartMessageMoveTask
the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. -
Currently, only standard queues support redrive. FIFO queues don't support redrive.
-
Only one active message movement task is supported per queue at any given time.
- Parameters:
startMessageMoveTaskRequest
-- Returns:
- Result of the StartMessageMoveTask operation returned by the service.
- Throws:
ResourceNotFoundException
- One or more specified resources don't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
startMessageMoveTask
default StartMessageMoveTaskResponse startMessageMoveTask(Consumer<StartMessageMoveTaskRequest.Builder> startMessageMoveTaskRequest) throws ResourceNotFoundException, RequestThrottledException, InvalidAddressException, InvalidSecurityException, UnsupportedOperationException, AwsServiceException, SdkClientException, SqsException
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
-
This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported.
-
In dead-letter queues redrive context, the
StartMessageMoveTask
the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. -
Currently, only standard queues support redrive. FIFO queues don't support redrive.
-
Only one active message movement task is supported per queue at any given time.
This is a convenience which creates an instance of the
StartMessageMoveTaskRequest.Builder
avoiding the need to create one manually viaStartMessageMoveTaskRequest.builder()
- Parameters:
startMessageMoveTaskRequest
- AConsumer
that will call methods onStartMessageMoveTaskRequest.Builder
to create a request.- Returns:
- Result of the StartMessageMoveTask operation returned by the service.
- Throws:
ResourceNotFoundException
- One or more specified resources don't exist.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
InvalidAddressException
- TheaccountId
is invalid.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
tagQueue
default TagQueueResponse tagQueue(TagQueueRequest tagQueueRequest) throws InvalidAddressException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, UnsupportedOperationException, 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 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 username in the Amazon SQS Developer Guide.
- Parameters:
tagQueueRequest
-- Returns:
- Result of the TagQueue operation returned by the service.
- Throws:
InvalidAddressException
- TheaccountId
is invalid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
tagQueue
default TagQueueResponse tagQueue(Consumer<TagQueueRequest.Builder> tagQueueRequest) throws InvalidAddressException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, UnsupportedOperationException, 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 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 username in the Amazon SQS Developer Guide.
This is a convenience which creates an instance of the
TagQueueRequest.Builder
avoiding the need to create one manually viaTagQueueRequest.builder()
- Parameters:
tagQueueRequest
- AConsumer
that will call methods onTagQueueRequest.Builder
to create a request.- Returns:
- Result of the TagQueue operation returned by the service.
- Throws:
InvalidAddressException
- TheaccountId
is invalid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
-
untagQueue
default UntagQueueResponse untagQueue(UntagQueueRequest untagQueueRequest) throws InvalidAddressException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, UnsupportedOperationException, 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 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 username in the Amazon SQS Developer Guide.
- Parameters:
untagQueueRequest
-- Returns:
- Result of the UntagQueue operation returned by the service.
- Throws:
InvalidAddressException
- TheaccountId
is invalid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
untagQueue
default UntagQueueResponse untagQueue(Consumer<UntagQueueRequest.Builder> untagQueueRequest) throws InvalidAddressException, RequestThrottledException, QueueDoesNotExistException, InvalidSecurityException, UnsupportedOperationException, 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 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 username in the Amazon SQS Developer Guide.
This is a convenience which creates an instance of the
UntagQueueRequest.Builder
avoiding the need to create one manually viaUntagQueueRequest.builder()
- Parameters:
untagQueueRequest
- AConsumer
that will call methods onUntagQueueRequest.Builder
to create a request.- Returns:
- Result of the UntagQueue operation returned by the service.
- Throws:
InvalidAddressException
- TheaccountId
is invalid.RequestThrottledException
- The request was denied due to request throttling.-
The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region.
-
A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key."
-
Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
-
QueueDoesNotExistException
- The specified queue doesn't exist.InvalidSecurityException
- When the request to a queue is not HTTPS and SigV4.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.AwsServiceException
- See Also:
- AWS API Documentation
-
create
static SqsClient create()
Create aSqsClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static SqsClientBuilder builder()
Create a builder that can be used to configure and create aSqsClient
.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SqsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
-