@datafire/amazonaws_sqs

Client library for Amazon Simple Queue Service

Installation and Usage

npm install --save @datafire/amazonaws_sqs

let amazonaws_sqs = require('@datafire/amazonaws_sqs').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_sqs.AddPermission({
  "QueueUrl": "",
  "Label": "",
  "AWSAccountIds": [],
  "Actions": []
}).then(data => {
  console.log(data);
});

Description

Actions

AddPermission

amazonaws_sqs.AddPermission({
  "QueueUrl": "",
  "Label": "",
  "AWSAccountIds": [],
  "Actions": []
}, context)

Input

• input object
  • AWSAccountIds required AWSAccountIdList
  • Actions required ActionNameList
  • Label required String
  • QueueUrl required String

Output

Output schema unknown

ChangeMessageVisibility

amazonaws_sqs.ChangeMessageVisibility({
  "QueueUrl": "",
  "ReceiptHandle": "",
  "VisibilityTimeout": 0
}, context)

Input

• input object
  • QueueUrl required String
  • ReceiptHandle required String
  • VisibilityTimeout required Integer

Output

Output schema unknown

ChangeMessageVisibilityBatch

amazonaws_sqs.ChangeMessageVisibilityBatch({
  "QueueUrl": "",
  "Entries": []
}, context)

Input

• input object
  • Entries required ChangeMessageVisibilityBatchRequestEntryList
  • QueueUrl required String

Output

• output ChangeMessageVisibilityBatchResult

CreateQueue

amazonaws_sqs.CreateQueue({
  "QueueName": ""
}, context)

Input

• input object
  • Attributes QueueAttributeMap
  • QueueName required String

Output

• output CreateQueueResult

DeleteMessage

amazonaws_sqs.DeleteMessage({
  "QueueUrl": "",
  "ReceiptHandle": ""
}, context)

Input

• input object
  • QueueUrl required String
  • ReceiptHandle required String

Output

Output schema unknown

DeleteMessageBatch

amazonaws_sqs.DeleteMessageBatch({
  "QueueUrl": "",
  "Entries": []
}, context)

Input

• input object
  • Entries required DeleteMessageBatchRequestEntryList
  • QueueUrl required String

Output

• output DeleteMessageBatchResult

DeleteQueue

amazonaws_sqs.DeleteQueue({
  "QueueUrl": ""
}, context)

Input

• input object
  • QueueUrl required String

Output

Output schema unknown

GetQueueAttributes

amazonaws_sqs.GetQueueAttributes({
  "QueueUrl": ""
}, context)

Input

• input object
  • AttributeNames AttributeNameList
  • QueueUrl required String

Output

• output GetQueueAttributesResult

GetQueueUrl

amazonaws_sqs.GetQueueUrl({
  "QueueName": ""
}, context)

Input

• input object
  • QueueName required String
  • QueueOwnerAWSAccountId String

Output

• output GetQueueUrlResult

ListDeadLetterSourceQueues

amazonaws_sqs.ListDeadLetterSourceQueues({
  "QueueUrl": ""
}, context)

Input

• input object
  • QueueUrl required String

Output

• output ListDeadLetterSourceQueuesResult

ListQueueTags

amazonaws_sqs.ListQueueTags({
  "QueueUrl": ""
}, context)

Input

• input object
  • QueueUrl required String

Output

• output ListQueueTagsResult

ListQueues

amazonaws_sqs.ListQueues({}, context)

Input

• input object
  • QueueNamePrefix String

Output

• output ListQueuesResult

PurgeQueue

amazonaws_sqs.PurgeQueue({
  "QueueUrl": ""
}, context)

Input

• input object
  • QueueUrl required String

Output

Output schema unknown

ReceiveMessage

amazonaws_sqs.ReceiveMessage({
  "QueueUrl": ""
}, context)

Input

• input object
  • AttributeNames AttributeNameList
  • MaxNumberOfMessages Integer
  • MessageAttributeNames MessageAttributeNameList
  • QueueUrl required String
  • ReceiveRequestAttemptId String
  • VisibilityTimeout Integer
  • WaitTimeSeconds Integer

Output

• output ReceiveMessageResult

RemovePermission

amazonaws_sqs.RemovePermission({
  "QueueUrl": "",
  "Label": ""
}, context)

Input

• input object
  • Label required String
  • QueueUrl required String

Output

Output schema unknown

SendMessage

amazonaws_sqs.SendMessage({
  "QueueUrl": "",
  "MessageBody": ""
}, context)

Input

• input object
  • DelaySeconds Integer
  • MessageAttributes MessageBodyAttributeMap
  • MessageBody required String
  • MessageDeduplicationId String
  • MessageGroupId String
  • QueueUrl required String

Output

• output SendMessageResult

SendMessageBatch

amazonaws_sqs.SendMessageBatch({
  "QueueUrl": "",
  "Entries": []
}, context)

Input

• input object
  • Entries required SendMessageBatchRequestEntryList
  • QueueUrl required String

Output

• output SendMessageBatchResult

SetQueueAttributes

amazonaws_sqs.SetQueueAttributes({
  "QueueUrl": "",
  "Attributes": []
}, context)

Input

• input object
  • Attributes required QueueAttributeMap
  • QueueUrl required String

Output

Output schema unknown

TagQueue

amazonaws_sqs.TagQueue({
  "QueueUrl": "",
  "Tags": []
}, context)

Input

• input object
  • QueueUrl required String
  • Tags required TagMap

Output

Output schema unknown

UntagQueue

amazonaws_sqs.UntagQueue({
  "QueueUrl": "",
  "TagKeys": []
}, context)

Input

• input object
  • QueueUrl required String
  • TagKeys required TagKeyList

Output

Output schema unknown

Definitions

AWSAccountIdList

• AWSAccountIdList array
  • items String

ActionNameList

• ActionNameList array
  • items String

AddPermissionRequest

• AddPermissionRequest object:
  • AWSAccountIds required AWSAccountIdList
  • Actions required ActionNameList
  • Label required String
  • QueueUrl required String

AttributeNameList

• AttributeNameList array
  • items QueueAttributeName

BatchEntryIdsNotDistinct

• BatchEntryIdsNotDistinct object: Two or more batch entries in the request have the same Id.

BatchRequestTooLong

• BatchRequestTooLong object: The length of all the messages put together is more than the limit.

BatchResultErrorEntry

• BatchResultErrorEntry object: This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.
  • Code required String
  • Id required String
  • Message String
  • SenderFault required Boolean

BatchResultErrorEntryList

• BatchResultErrorEntryList array
  • items BatchResultErrorEntry

Binary

• Binary string

BinaryList

• BinaryList array
  • items Binary

Boolean

• Boolean boolean

ChangeMessageVisibilityBatchRequest

• ChangeMessageVisibilityBatchRequest object:
  • Entries required ChangeMessageVisibilityBatchRequestEntryList
  • QueueUrl required String

ChangeMessageVisibilityBatchRequestEntry

• ChangeMessageVisibilityBatchRequestEntry object: Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch. All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this: &amp;ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2 &amp;ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=<replaceable>Your_Receipt_Handle</replaceable> &amp;ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
  • Id required String
  • ReceiptHandle required String
  • VisibilityTimeout Integer

ChangeMessageVisibilityBatchRequestEntryList

• ChangeMessageVisibilityBatchRequestEntryList array
  • items ChangeMessageVisibilityBatchRequestEntry

ChangeMessageVisibilityBatchResult

• ChangeMessageVisibilityBatchResult object: For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
  • Failed required BatchResultErrorEntryList
  • Successful required ChangeMessageVisibilityBatchResultEntryList

ChangeMessageVisibilityBatchResultEntry

• ChangeMessageVisibilityBatchResultEntry object: Encloses the Id of an entry in ChangeMessageVisibilityBatch.
  • Id required String

ChangeMessageVisibilityBatchResultEntryList

• ChangeMessageVisibilityBatchResultEntryList array
  • items ChangeMessageVisibilityBatchResultEntry

ChangeMessageVisibilityRequest

• ChangeMessageVisibilityRequest object
  • QueueUrl required String
  • ReceiptHandle required String
  • VisibilityTimeout required Integer

CreateQueueRequest

• CreateQueueRequest object:
  • Attributes QueueAttributeMap
  • QueueName required String

CreateQueueResult

• CreateQueueResult object: Returns the QueueUrl attribute of the created queue.
  • QueueUrl String

DeleteMessageBatchRequest

• DeleteMessageBatchRequest object:
  • Entries required DeleteMessageBatchRequestEntryList
  • QueueUrl required String

DeleteMessageBatchRequestEntry

• DeleteMessageBatchRequestEntry object: Encloses a receipt handle and an identifier for it.
  • Id required String
  • ReceiptHandle required String

DeleteMessageBatchRequestEntryList

• DeleteMessageBatchRequestEntryList array
  • items DeleteMessageBatchRequestEntry

DeleteMessageBatchResult

• DeleteMessageBatchResult object: For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.
  • Failed required BatchResultErrorEntryList
  • Successful required DeleteMessageBatchResultEntryList

DeleteMessageBatchResultEntry

• DeleteMessageBatchResultEntry object: Encloses the Id of an entry in DeleteMessageBatch.
  • Id required String

DeleteMessageBatchResultEntryList

• DeleteMessageBatchResultEntryList array
  • items DeleteMessageBatchResultEntry

DeleteMessageRequest

• DeleteMessageRequest object:
  • QueueUrl required String
  • ReceiptHandle required String

DeleteQueueRequest

• DeleteQueueRequest object:
  • QueueUrl required String

EmptyBatchRequest

• EmptyBatchRequest object: The batch request doesn't contain any entries.

GetQueueAttributesRequest

• GetQueueAttributesRequest object:
  • AttributeNames AttributeNameList
  • QueueUrl required String

GetQueueAttributesResult

• GetQueueAttributesResult object: A list of returned queue attributes.
  • Attributes QueueAttributeMap

GetQueueUrlRequest

• GetQueueUrlRequest object:
  • QueueName required String
  • QueueOwnerAWSAccountId String

GetQueueUrlResult

• GetQueueUrlResult object: For more information, see Responses in the Amazon Simple Queue Service Developer Guide.
  • QueueUrl String

Integer

• Integer integer

InvalidAttributeName

• InvalidAttributeName object: The attribute referred to doesn't exist.

InvalidBatchEntryId

• InvalidBatchEntryId object: The Id of a batch entry in a batch request doesn't abide by the specification.

InvalidIdFormat

• InvalidIdFormat object: The receipt handle isn't valid for the current version.

InvalidMessageContents

• InvalidMessageContents object: The message contains characters outside the allowed set.

ListDeadLetterSourceQueuesRequest

• ListDeadLetterSourceQueuesRequest object:
  • QueueUrl required String

ListDeadLetterSourceQueuesResult

• ListDeadLetterSourceQueuesResult object: A list of your dead letter source queues.
  • queueUrls required QueueUrlList

ListQueueTagsRequest

• ListQueueTagsRequest object
  • QueueUrl required String

ListQueueTagsResult

• ListQueueTagsResult object
  • Tags TagMap

ListQueuesRequest

• ListQueuesRequest object:
  • QueueNamePrefix String

ListQueuesResult

• ListQueuesResult object: A list of your queues.
  • QueueUrls QueueUrlList

Message

• Message object: An Amazon SQS message.
  • Attributes MessageSystemAttributeMap
  • Body String
  • MD5OfBody String
  • MD5OfMessageAttributes String
  • MessageAttributes MessageBodyAttributeMap
  • MessageId String
  • ReceiptHandle String

MessageAttributeName

• MessageAttributeName string

MessageAttributeNameList

• MessageAttributeNameList array
  • items MessageAttributeName

MessageAttributeValue

• MessageAttributeValue object: The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage. Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).
  • BinaryListValues BinaryList
  • BinaryValue Binary
  • DataType required String
  • StringListValues StringList
  • StringValue String

MessageBodyAttributeMap

• MessageBodyAttributeMap array
  • items object
    • key String
    • value MessageAttributeValue

MessageList

• MessageList array
  • items Message

MessageNotInflight

• MessageNotInflight object: The message referred to isn't in flight.

MessageSystemAttributeMap

• MessageSystemAttributeMap array
  • items object
    • key MessageSystemAttributeName
    • value String

MessageSystemAttributeName

• MessageSystemAttributeName string (values: SenderId, SentTimestamp, ApproximateReceiveCount, ApproximateFirstReceiveTimestamp, SequenceNumber, MessageDeduplicationId, MessageGroupId)

OverLimit

• OverLimit object: The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached. AddPermission returns this error if the maximum number of permissions for the queue is reached.

PurgeQueueInProgress

• PurgeQueueInProgress object: Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).

PurgeQueueRequest

• PurgeQueueRequest object:
  • QueueUrl required String

QueueAttributeMap

• QueueAttributeMap array
  • items object
    • key QueueAttributeName
    • value String

QueueAttributeName

• QueueAttributeName string (values: All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds)

QueueDeletedRecently

• QueueDeletedRecently object: You must wait 60 seconds after deleting a queue before you can create another one with the same name.

QueueDoesNotExist

• QueueDoesNotExist object: The queue referred to doesn't exist.

QueueNameExists

• QueueNameExists object: A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.

QueueUrlList

• QueueUrlList array
  • items String

ReceiptHandleIsInvalid

• ReceiptHandleIsInvalid object: The receipt handle provided isn't valid.

ReceiveMessageRequest

• ReceiveMessageRequest object:
  • AttributeNames AttributeNameList
  • MaxNumberOfMessages Integer
  • MessageAttributeNames MessageAttributeNameList
  • QueueUrl required String
  • ReceiveRequestAttemptId String
  • VisibilityTimeout Integer
  • WaitTimeSeconds Integer

ReceiveMessageResult

• ReceiveMessageResult object: A list of received messages.
  • Messages MessageList

RemovePermissionRequest

• RemovePermissionRequest object:
  • Label required String
  • QueueUrl required String

SendMessageBatchRequest

• SendMessageBatchRequest object:
  • Entries required SendMessageBatchRequestEntryList
  • QueueUrl required String

SendMessageBatchRequestEntry

• SendMessageBatchRequestEntry object: Contains the details of a single Amazon SQS message along with an Id.
  • DelaySeconds Integer
  • Id required String
  • MessageAttributes MessageBodyAttributeMap
  • MessageBody required String
  • MessageDeduplicationId String
  • MessageGroupId String

SendMessageBatchRequestEntryList

• SendMessageBatchRequestEntryList array
  • items SendMessageBatchRequestEntry

SendMessageBatchResult

• SendMessageBatchResult object: For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
  • Failed required BatchResultErrorEntryList
  • Successful required SendMessageBatchResultEntryList

SendMessageBatchResultEntry

• SendMessageBatchResultEntry object: Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.
  • Id required String
  • MD5OfMessageAttributes String
  • MD5OfMessageBody required String
  • MessageId required String
  • SequenceNumber String

SendMessageBatchResultEntryList

• SendMessageBatchResultEntryList array
  • items SendMessageBatchResultEntry

SendMessageRequest

• SendMessageRequest object:
  • DelaySeconds Integer
  • MessageAttributes MessageBodyAttributeMap
  • MessageBody required String
  • MessageDeduplicationId String
  • MessageGroupId String
  • QueueUrl required String

SendMessageResult

• SendMessageResult object: The MD5OfMessageBody and MessageId elements.
  • MD5OfMessageAttributes String
  • MD5OfMessageBody String
  • MessageId String
  • SequenceNumber String

SetQueueAttributesRequest

• SetQueueAttributesRequest object:
  • Attributes required QueueAttributeMap
  • QueueUrl required String

String

• String string

StringList

• StringList array
  • items String

TagKey

• TagKey string

TagKeyList

• TagKeyList array
  • items TagKey

TagMap

• TagMap array
  • items object
    • key TagKey
    • value TagValue

TagQueueRequest

• TagQueueRequest object
  • QueueUrl required String
  • Tags required TagMap

TagValue

• TagValue string

TooManyEntriesInBatchRequest

• TooManyEntriesInBatchRequest object: The batch request contains more entries than permissible.

UnsupportedOperation

• UnsupportedOperation object: Error code 400. Unsupported operation.

UntagQueueRequest

• UntagQueueRequest object
  • QueueUrl required String
  • TagKeys required TagKeyList