Operations (sample payloads)

Main operations

Delete Messages

Delete multiple messages from an SQS queue Sample Input

{
    "queue_name": "my-sqs-queue",
    "entries_to_delete": [
        \{
            "Id": "msg1",
            "ReceiptHandle": "AQEBwJnKyrHigUMZj6rYigCgxlaS3SLy0a..."
        \},
        \{
            "Id": "msg2",
            "ReceiptHandle": "AQEBzWwaftRI0KuVm4tP+/7q1rGgNqicHq..."
        \},
        \{
            "Id": "msg3",
            "ReceiptHandle": "AQEB9nLDh8bvfQMts8o+GbHfssY0rbjhSv..."
        \}
    ]
}

Sample Output

{
    "ResponseMetadata": {
        "RequestId": "5fea1756-0ec7-5c24-b3fc-9ce5b744f4df"
    },
    "Successful": [
        {
            "Id": "msg1"
        },
        {
            "Id": "msg2"
        },
        {
            "Id": "msg3"
        }
    ],
    "Failed": []
}

Get queue attributes

Gets attributes for the specified queue. Sample Input

\{
    "queue_name": "my-sqs-queue",
    "attribute_names": [
        "All"
    ]
\}

Sample Output

{
    "headers": {},
    "body": {
        "ResponseMetadata": {
            "RequestId": "a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p"
        },
        "Attributes": \{
            "QueueArn": "arn:aws:sqs:us-east-1:123456789012:my-sqs-queue",
            "ApproximateNumberOfMessages": "42",
            "ApproximateNumberOfMessagesNotVisible": "5",
            "ApproximateNumberOfMessagesDelayed": "0",
            "CreatedTimestamp": "1620000000",
            "LastModifiedTimestamp": "1620100000",
            "VisibilityTimeout": "30",
            "MaximumMessageSize": "262144",
            "MessageRetentionPeriod": "345600",
            "DelaySeconds": "0",
            "ReceiveMessageWaitTimeSeconds": "0"
        \}
    }
}

List Queues

List queues available for this account. Sample Input

{}

Sample Output

\{
    "queues": [
        "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue1",
        "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue2",
        "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue3"
    ]
\}

Purge Queue

Deletes the messages in a queue. When you use the Purge Queue action, you can't retrieve a message deleted from a queue. Sample Input

{
    "queue_name": "my-important-queue"
}

Sample Output

{
    "ResponseMetadata": {
        "RequestId": "a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6"
    }
}

Receive and Delete Messages

Receive and delete messages from an SQS queue in multiple batches to create one large batch. This may result in loss of some messages if the operation times out or fails internally Sample Input

\{
    "queue_name": "my-sqs-queue",
    "max_number_of_messages": 50,
    "message_attribute_names": [
        "All"
    ],
    "attribute_names": [
        "All"
    ],
    "parse_json": true
\}

Sample Output

{
    "messages": [
        {
            "Attributes": \{
                "ApproximateFirstReceiveTimestamp": "1623456789012",
                "ApproximateReceiveCount": "1",
                "SenderId": "AIDACKCEVSQ6C2EXAMPLE",
                "SentTimestamp": "1623456788000"
            \},
            "Body": "\{\"orderId\": \"12345\", \"customerName\": \"John Doe\", \"totalAmount\": 99.99\}",
            "MD5OfBody": "51b0a325...e39a90b0",
            "MD5OfMessageAttributes": "00484c68...59e71517",
            "MessageAttributes": {
                "City": \{
                    "DataType": "String",
                    "StringValue": "New York"
                \},
                "PostalCode": \{
                    "DataType": "String",
                    "StringValue": "10001"
                \}
            },
            "MessageId": "5fea7756-0ea4-451a-a703-a558b933e274",
            "ReceiptHandle": "AQEBZWQgX...fqNzFbWC"
        }
    ],
    "entries_to_delete": [
        \{
            "Id": "5fea7756-0ea4-451a-a703-a558b933e274",
            "ReceiptHandle": "AQEBZWQgX...fqNzFbWC"
        \}
    ]
}

Receive Messages

Receive multiple messages from an SQS queue. The messages are not deleted from the queue. Sample Input

\{
    "queue_name": "my-sqs-queue",
    "max_number_of_messages": 5,
    "wait_time_seconds": 10,
    "visibility_timeout": 60,
    "message_attribute_names": [
        "All"
    ],
    "attribute_names": [
        "ApproximateReceiveCount",
        "SentTimestamp"
    ],
    "parse_json": true
\}

Sample Output

{
    "messages": [
        {
            "Attributes": \{
                "ApproximateFirstReceiveTimestamp": "1623456789012",
                "ApproximateReceiveCount": "1",
                "SenderId": "AIDACKCEVSQ6C2EXAMPLE",
                "SentTimestamp": "1623456788000"
            \},
            "Body": "\{\"orderId\": \"12345\", \"status\": \"shipped\"\}",
            "MD5OfBody": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
            "MD5OfMessageAttributes": "q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1",
            "MessageAttributes": {
                "City": \{
                    "DataType": "String",
                    "StringValue": "Seattle"
                \},
                "PostalCode": \{
                    "DataType": "String",
                    "StringValue": "98101"
                \}
            },
            "MessageId": "abcdef12-3456-7890-abcd-ef1234567890",
            "ReceiptHandle": "AQEBwJnKyrHigUMZj6rYigCgxlaS3SLy0a..."
        }
    ],
    "entries_to_delete": [
        \{
            "messageIndex": "0",
            "messageId": "abcdef12-3456-7890-abcd-ef1234567890",
            "ReceiptHandle": "AQEBwJnKyrHigUMZj6rYigCgxlaS3SLy0a..."
        \}
    ],
    "errors": []
}

Send Message

Send a message to an SQS queue Sample Input

{
    "queue_name": "my-sqs-queue",
    "queue_type": {
        "delay_seconds": 30
    },
    "body": "This is a sample message for SQS",
    "message_attributes": \{
        "priority": "high",
        "department": "sales"
    \}
}

Sample Output

{
    "ResponseMetadata": {
        "RequestId": "a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p"
    },
    "MD5OfMessageBody": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "MD5OfMessageAttributes": "q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2",
    "MessageId": "12345678-90ab-cdef-ghij-klmnopqrstuv",
    "SequenceNumber": "987654321"
}