0.2.2 • Published 2 months ago

@aws-lite/sqs v0.2.2

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 months ago

@aws-lite/sqs

Official aws-lite plugin 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

Canonical AWS API doc

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)
  • 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)

GetQueueAttributes

Canonical AWS API doc

Properties:

  • QueueUrl (string) required
    • SQS queue URL to retrieve attribute information from
  • AttributeNames (array)
    • List of attribute names (strings) to retrieve

ReceiveMessage

Canonical AWS API doc

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 ReceiveMessage calls
  • VisibilityTimeout (number)
    • The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request
  • WaitTimeSeconds (number)
    • The duration (in seconds) for which the call waits for a message to arrive in the queue before returning

DeleteMessage

Canonical AWS API doc

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!

Learn more

0.2.2

2 months ago

0.2.1

3 months ago

0.1.0

4 months ago

0.2.0

4 months ago

0.0.4

5 months ago

0.0.3

5 months ago

0.0.2

6 months ago

0.0.1

7 months ago

0.0.0

7 months ago