@aws-lite/sqs
Official
aws-liteplugin for SQS
Maintained by: @architect
Install
npm i @aws-lite/sqs
Optionally install types:
npm i -D @aws-lite/sqs-types
Reference
Reference documentation with examples at aws-lite.org
Methods
SendMessage
Properties:
MessageBody(string) [required]- Message to send, from 1b - 256KiB
QueueUrl(string) [required]- SQS queue URL to send the message to
DelaySeconds(number)- Seconds, from 0 - 900, to delay a message
MessageAttributes(object)- Message attribute map
- More details (AWS)
MessageDeduplicationId(string)- Ensures request is idempotent; may only be used for FIFO queues
MessageGroupId(string)- Tag specifying a specific message group; may only be used for FIFO queues
MessageSystemAttributes(object)- Message system attribute map
- More details (AWS)
GetQueueAttributes
Properties:
QueueUrl(string) [required]- SQS queue URL to retrieve attribute information from
AttributeNames(array)- List of attribute names (strings) to retrieve
ReceiveMessage
Properties:
QueueUrl(string) [required]- SQS queue URL from which messages are received
AttributeNames(array)- List of attribute names (strings) to be returned along with each message
MaxNumberOfMessages(number)- Maximum number of messages to return
MessageAttributeNames(array)- The name of the message attribute
MessageSystemAttributeNames(array)- A list of attributes that need to be returned along with each message
ReceiveRequestAttemptId(string)- The token used for deduplication of
ReceiveMessagecalls
- The token used for deduplication of
VisibilityTimeout(number)- The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a
ReceiveMessagerequest
- The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a
WaitTimeSeconds(number)- The duration (in seconds) for which the call waits for a message to arrive in the queue before returning
DeleteMessage
Properties:
QueueUrl(string) [required]- SQS queue URL from which messages are deleted
ReceiptHandle(string) [required]- The receipt handle associated with the message to delete
Methods yet to be implemented
Please help out by opening a PR!
AddPermissionCancelMessageMoveTaskChangeMessageVisibilityChangeMessageVisibilityBatchCreateQueueDeleteMessageBatchDeleteQueueGetQueueUrlListDeadLetterSourceQueuesListMessageMoveTasksListQueuesListQueueTagsPurgeQueueRemovePermissionSendMessageBatchSetQueueAttributesStartMessageMoveTaskTagQueueUntagQueue