Share this page

# LrSqsClient

The LrSqsClient class is the main class that is used to interact with the SQS queue. It can be used to send or receive messages and to interact with the queue.

The LrSqsClient class includes the following methods.

Note:
- All methods are static, so to use this class you must initialize the client through the initClient API and not via the new keyword.
- You cannot use multiple instances of LrSqsClient in a thread concurrently. Therefore, a second initialization without a previous closure of the client produces an error.

LrSqsClient.addMessageToBatch | Adds a message to a container that stores messages to be sent.
LrSqsClient.addMessageToBatchEx | Adds a message with multiple attributes to a container that stores messages to be sent.
LrSqsClient.addMessageToChangeVisibilityBatch | Adds a message to the current batch, to be used for the ChangeMessageVisibilityBatch request.
LrSqsClient.addPermission | Adds an SQS permission to the LrSqsClient's current queue.
LrSqsClient.addReceiptHandleToChangeVisibilityBatch | Adds a receipt handle to the current batch, to be used for the ChangeMessageVisibilityBatch request.
LrSqsClient.changeMessageVisibility | Changes a message's visibility timeout.
LrSqsClient.changeMessageVisibilityBatch | Sends the request of visibility change for all messages in the designated container.
LrSqsClient.closeClient | Closes the LrSqsClient for the current Vuser.
LrSqsClient.createMessageAttributeValueBinary | Creates a binary attribute value that can be assigned to a message.
LrSqsClient.createMessageAttributeValueDouble | Creates a double attribute value that can be assigned to a message.
LrSqsClient.createMessageAttributeValueInt | Creates an integer attribute value that can be assigned to a message.
LrSqsClient.createMessageAttributeValueString | Creates a string attribute value that can be assigned to a message.
LrSqsClient.deleteMessage | Deletes a message from the queue.
LrSqsClient.deleteMessageBatch | Deletes a message batch from the queue.
LrSqsClient.getQueueAttributes | Retrieves the specified attributes for the LrSqsClient's current queue.
LrSqsClient.getQueueUrl | Retrieves the queue URL for the specified queue.
LrSqsClient.initChangeMessageVisibilityBatch | Initializes the container for a ChangeMessageVisibilityBatch request.
LrSqsClient.initClient | Initializes the LrSqsClient for the current Vuser.
LrSqsClient.initMessageBatch | Initializes the container used to store messages to be sent.
LrSqsClient.listDeadLetterSourceQueues | Lists the queues that have the LrSqsClient's current queue set as their dead-letter queue.
LrSqsClient.listQueues | Lists the queues available in the current LrSqsClient's region.
LrSqsClient.listQueueTags | Retrieves all tags for the LrSqsClient's current queue.
LrSqsClient.purgeQueue | Deletes all messages from the queue.
LrSqsClient.receiveMessage | Receives messages from the queue.
LrSqsClient.receiveMessagesEx | Receives messages from the queue according to the arguments provided.
LrSqsClient.removePermission | Removes an SQS permission from the LrSqsClient's current queue.
LrSqsClient.resetQueueUrl | Replaces the current queue URL with a new URL.
LrSqsClient.sendMessage | Sends a message to the queue.
LrSqsClient.sendMessageBatch | Sends the batch of messages currently stored in the message container.
LrSqsClient.sendMessageEx | Sends a message with multiple attributes to the queue.
LrSqsClient.setQueueAttributes | Sets the specified attributes for the LrSqsClient's current queue.
LrSqsClient.tagQueue | Adds tags to the LrSqsClient's current queue.
LrSqsClient.untagQueue | Removes tags from the LrSqsClient's current queue.

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: