❤
npm
Sign UpSign In

@datafire/amazonaws_sqs

5.0.0 • Public • Published

@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

Welcome to the Amazon Simple Queue Service API Reference.

Amazon Simple Queue Service (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.

Standard queues are available in all regions. FIFO queues are available in the US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland) regions.

You can use AWS 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

Actions

AddPermission

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

Input

Output

Output schema unknown

ChangeMessageVisibility

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

Input

  • input object

Output

Output schema unknown

ChangeMessageVisibilityBatch

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

Input

Output

CreateQueue

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

Input

Output

DeleteMessage

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

Input

  • input object

Output

Output schema unknown

DeleteMessageBatch

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

Input

Output

DeleteQueue

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

Input

  • input object

Output

Output schema unknown

GetQueueAttributes

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

Input

Output

GetQueueUrl

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

Input

  • input object

Output

ListDeadLetterSourceQueues

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

Input

  • input object

Output

ListQueueTags

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

Input

  • input object

Output

ListQueues

amazonaws_sqs.ListQueues({}, context)

Input

  • input object

Output

PurgeQueue

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

Input

  • input object

Output

Output schema unknown

ReceiveMessage

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

Input

Output

RemovePermission

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

Input

  • input object

Output

Output schema unknown

SendMessage

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

Input

Output

SendMessageBatch

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

Input

Output

SetQueueAttributes

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

Input

Output

Output schema unknown

TagQueue

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

Input

  • input object

Output

Output schema unknown

UntagQueue

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

Input

Output

Output schema unknown

Definitions

AWSAccountIdList

  • AWSAccountIdList array

ActionNameList

  • ActionNameList array

AddPermissionRequest

AttributeNameList

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.

BatchResultErrorEntryList

Binary

  • Binary string

BinaryList

  • BinaryList array

Boolean

  • Boolean boolean

ChangeMessageVisibilityBatchRequest

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:

    &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2

    &amp;ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=<replaceable>Your_Receipt_Handle</replaceable>

    &amp;ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

ChangeMessageVisibilityBatchRequestEntryList

ChangeMessageVisibilityBatchResult

ChangeMessageVisibilityBatchResultEntry

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

ChangeMessageVisibilityBatchResultEntryList

ChangeMessageVisibilityRequest

  • ChangeMessageVisibilityRequest object

CreateQueueRequest

CreateQueueResult

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

DeleteMessageBatchRequest

DeleteMessageBatchRequestEntry

  • DeleteMessageBatchRequestEntry object: Encloses a receipt handle and an identifier for it.

DeleteMessageBatchRequestEntryList

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.

DeleteMessageBatchResultEntry

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

DeleteMessageBatchResultEntryList

DeleteMessageRequest

  • DeleteMessageRequest object:

DeleteQueueRequest

  • DeleteQueueRequest object:

EmptyBatchRequest

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

GetQueueAttributesRequest

GetQueueAttributesResult

  • GetQueueAttributesResult object: A list of returned queue attributes.

GetQueueUrlRequest

  • GetQueueUrlRequest object:

GetQueueUrlResult

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

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:

ListDeadLetterSourceQueuesResult

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

ListQueueTagsRequest

  • ListQueueTagsRequest object

ListQueueTagsResult

  • ListQueueTagsResult object

ListQueuesRequest

  • ListQueuesRequest object:

ListQueuesResult

  • ListQueuesResult object: A list of your queues.

Message

MessageAttributeName

  • MessageAttributeName string

MessageAttributeNameList

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

MessageBodyAttributeMap

MessageList

MessageNotInflight

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

MessageSystemAttributeMap

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:

QueueAttributeMap

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

ReceiptHandleIsInvalid

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

ReceiveMessageRequest

ReceiveMessageResult

  • ReceiveMessageResult object: A list of received messages.

RemovePermissionRequest

  • RemovePermissionRequest object:

SendMessageBatchRequest

SendMessageBatchRequestEntry

  • SendMessageBatchRequestEntry object: Contains the details of a single Amazon SQS message along with an Id.

SendMessageBatchRequestEntryList

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.

SendMessageBatchResultEntry

  • SendMessageBatchResultEntry object: Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.

SendMessageBatchResultEntryList

SendMessageRequest

SendMessageResult

  • SendMessageResult object: The MD5OfMessageBody and MessageId elements.

SetQueueAttributesRequest

String

  • String string

StringList

  • StringList array

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagMap

TagQueueRequest

  • TagQueueRequest object

TagValue

  • TagValue string

TooManyEntriesInBatchRequest

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

UnsupportedOperation

  • UnsupportedOperation object: Error code 400. Unsupported operation.

UntagQueueRequest

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_sqs

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

2

Version

5.0.0

License

MIT

Unpacked Size

164 kB

Total Files

5

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware