Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Amazon SQS

Least Privileged User

Navigate to the AWS console and create an IAM user with programmatic access. The user will need the following permissions. You can create a policy specifically for these permissions and apply the permissions to the user.

For more information, see: High Level AWS Source Configuration

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "sqs:GetQueueUrl",
                "sqs:ListDeadLetterSourceQueues",
                "sqs:GetQueueAttributes",
                "sqs:ListQueueTags",
                "sqs:ListQueues"
            ],
            "Resource": "arn:aws:sqs:*:*:*"
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "cloudwatch:GetMetricStatistics",
                "cloudwatch:ListMetrics"
            ],
            "Resource": "*"
        }
    ]
}

Connection Parameters

NameRequired?Description
Region
Access Key IDRequired
Secret Access KeyRequired
Additional ThreadsThe number of additional threads allowed to be utilized during collection.
Request Timeout (seconds)The number of seconds to allow for the API to return a response.
Collect CloudWatch Metrics
CloudWatch Historic ModeIf enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

Queue

NameDescription
Approximate Age of Oldest Message (Seconds)The approximate age of the oldest non-deleted message in the queue.
Approximate Number of Delayed MessagesThe number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
Approximate Number of Hidden MessagesThe number of messages that are "in flight." Messages are considered in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
Approximate Number of MessagesThe approximate number of visible messages in a queue.
Approximate Number of Visible MessagesThe number of messages available for retrieval from the queue.
ARNThe Amazon Resource Name of the Queue.
Content Based DeduplicationWhether content-based deduplication is enabled for the queue.
Created Timestamp (Seconds)The time when the queue was created (epoch time).
Dead Letter Target ARNThe Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
DelayThe default delay on the queue.
First-In First-OutWhether the queue is FIFO.
Key Management Service Data Key Reuse Period (Seconds)The length of time for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.
Key Management Service Master Key IDThe ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.
Last Modified Timestamp (Seconds)The time when the queue was last changed (epoch time).
Maximum Message Size (Bytes)The size limit of a message before Amazon SQS rejects it.
Maximum Receive CountThe number of times a message is delivered to the source queue before being moved to the dead-letter queue.
Message Retention Period (Seconds)The length of time for which Amazon SQS retains a message.
NameThe name of the queue
Number of Empty ReceivesThe number of ReceiveMessage API calls that did not return a message.
Number of Messages DeletedThe number of messages deleted from the queue.
Number of Messages ReceivedThe number of messages returned by calls to the ReceiveMessage API action.
Number of Messages SentThe number of messages added to a queue.
policyThe policy of the queue.
Receive Message Wait Time (Seconds)The length of time for which the ReceiveMessage action waits for a message to arrive.
RegionThe AWS Region this object belongs to.
Sent Message Size (Bytes)The size of messages added to a queue.
Visibility Timeout (Seconds)The visibility timeout for the queue.

Updated 11 months ago

Amazon SQS


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.