Amazon SQS
Send messages to Amazon SQS queues and read them with long polling, ack and nack, in batches, FIFO included. Typical uses: hand work to another application, read a queue in a job.
sqs pingsqs queue_createsqs queue_createsqs queuessqs queuessqs publishsqs publishsqs publish_batchsqs publish_batchsqs queue_infosqs consumesqs consumesqs acksqs nacksqs nacksqs purgesqs queue_drop
sqs ping <config>
Description
Check the endpoint and the credentials with a cheap call (ListQueues of 1). Returns {ok, latency_ms}; a failure is an error
Check the endpoint and the credentials with a cheap call (ListQueues of 1). Returns {ok, latency_ms}; a failure is an error
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
admin
sqs ping "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}"
mentdb
{"ok": true, "latency_ms": 4}
sqs queue_create <config> <queue>
Description
Create a queue (standard, or FIFO when the name ends with .fifo). Creating an existing queue with the same attributes is accepted. Returns {queue, url}
Create a queue (standard, or FIFO when the name ends with .fifo). Creating an existing queue with the same attributes is accepted. Returns {queue, url}
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The name of the queue: 1 to 80 letters, digits, - or _, with the suffix .fifo for a FIFO queue - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The name of the queue: 1 to 80 letters, digits, - or _, with the suffix .fifo for a FIFO queue - String - required
admin
sqs queue_create "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "orders"
mentdb
{"queue": "orders", "url": "http://localhost:9324/123456789012/orders"}
sqs queue_create <config> <queue> <json_params>
Description
Create a queue with parameters: fifo (from the name), content_based_dedup (FIFO only), visibility_timeout (seconds, 0 to 43200), delay_seconds (0 to 900), retention_seconds (60 to 1209600), receive_wait_seconds (0 to 20), attributes (other AWS attributes by their name, as texts: RedrivePolicy, Policy...), tags (a JSON object)
Create a queue with parameters: fifo (from the name), content_based_dedup (FIFO only), visibility_timeout (seconds, 0 to 43200), delay_seconds (0 to 900), retention_seconds (60 to 1209600), receive_wait_seconds (0 to 20), attributes (other AWS attributes by their name, as texts: RedrivePolicy, Policy...), tags (a JSON object)
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The name of the queue - String - required
json_params: The parameters - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The name of the queue - String - required
json_params: The parameters - String - required
admin
sqs queue_create "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "{\"content_based_dedup\": true, \"visibility_timeout\": 60, \"tags\": {\"team\": \"erp\"}}"
mentdb
{"queue": "billing.fifo", "url": "http://localhost:9324/123456789012/billing.fifo"}
sqs queues <config>
Description
List the queues. Returns rows {name, url}
List the queues. Returns rows {name, url}
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
admin
sqs queues "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}"
mentdb
[{"name": "orders", "url": "http://localhost:9324/123456789012/orders"}, {"name": "billing.fifo", "url": "http://localhost:9324/123456789012/billing.fifo"}]
sqs queues <config> <json_params>
Description
List the queues with parameters: prefix (the start of the names), limit (1000, up to 100000; the pages are followed)
List the queues with parameters: prefix (the start of the names), limit (1000, up to 100000; the pages are followed)
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
json_params: The parameters - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
json_params: The parameters - String - required
admin
sqs queues "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "{\"prefix\": \"bill\"}"
mentdb
[{"name": "billing.fifo", "url": "http://localhost:9324/123456789012/billing.fifo"}]
sqs publish <config> <queue> <body>
Description
Send a text. Returns {message_id}, with sequence_number for a FIFO queue when the server gives it
Send a text. Returns {message_id}, with sequence_number for a FIFO queue when the server gives it
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
body: The text, 1 MB at most - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
body: The text, 1 MB at most - String - required
admin
sqs publish "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "orders" "order 1"
mentdb
{"message_id": "00d83808-fcf2-4ee6-a327-27cb7a15f2b5"}
sqs publish <config> <queue> <body> <json_params>
Description
Send with parameters: attributes (a JSON object, 10 at most: texts and booleans as String, numbers as Number), group_id (needed by a FIFO queue), dedup_id (the deduplication id of a FIFO queue without content_based_dedup), delay_seconds (0 to 900, standard queues)
Send with parameters: attributes (a JSON object, 10 at most: texts and booleans as String, numbers as Number), group_id (needed by a FIFO queue), dedup_id (the deduplication id of a FIFO queue without content_based_dedup), delay_seconds (0 to 900, standard queues)
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
body: The text - String - required
json_params: The parameters - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
body: The text - String - required
json_params: The parameters - String - required
admin
sqs publish "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "orders" "{\"id\": 2}" "{\"attributes\": {\"source\": \"erp\", \"amount\": 12.5}}"
mentdb
{"message_id": "5486150f-b247-4472-8528-277886021c97"}
to a FIFO queue (fixed result: a real local moto 5.1.22 server, not AWS)
admin
sqs publish "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "invoice 7" "{\"group_id\": \"client-7\"}"
mentdb
{"message_id": "2f7dd8b3-0cfe-49d1-8d25-85bd6023657a"}
sqs publish_batch <config> <queue> <json_rows>
Description
Send a list of rows {body, attributes, group_id, dedup_id, delay_seconds} (only body is needed) by requests of 10 messages and 1 MB. Returns {sent, failed, not_attempted, errors}: errors has at most 100 entries {row, error}, with row from 0; an invalid row or a message refused by the server does not stop the list; a request that fails stops it, and the next rows are not_attempted
Send a list of rows {body, attributes, group_id, dedup_id, delay_seconds} (only body is needed) by requests of 10 messages and 1 MB. Returns {sent, failed, not_attempted, errors}: errors has at most 100 entries {row, error}, with row from 0; an invalid row or a message refused by the server does not stop the list; a request that fails stops it, and the next rows are not_attempted
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
json_rows: The messages as a JSON array of objects (100000 at most). A body that is not a text is sent as JSON - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
json_rows: The messages as a JSON array of objects (100000 at most). A body that is not a text is sent as JSON - String - required
admin
sqs publish_batch "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "orders" "[{\"body\": \"order 3\"}, {\"text\": \"no body\"}, {\"body\": {\"id\": 4}, \"attributes\": {\"try\": 1}}]"
mentdb
{"sent": 2, "failed": 1, "not_attempted": 0, "errors": [{"row": 1, "error": "the field 'body' is missing"}]}
sqs publish_batch <config> <queue> <json_rows> <json_params>
Description
Send a list with parameters: body_field (body), group_id (for every row without one), attributes (for every row; those of a row are added), delay_seconds
Send a list with parameters: body_field (body), group_id (for every row without one), attributes (for every row; those of a row are added), delay_seconds
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
json_rows: The messages as a JSON array of objects (100000 at most). A body that is not a text is sent as JSON - String - required
json_params: The parameters - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
json_rows: The messages as a JSON array of objects (100000 at most). A body that is not a text is sent as JSON - String - required
json_params: The parameters - String - required
admin
sqs publish_batch "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "[{\"v\": \"invoice 8\"}, {\"v\": \"invoice 9\", \"group_id\": \"client-9\"}]" "{\"body_field\": \"v\", \"group_id\": \"client-7\"}"
mentdb
{"sent": 2, "failed": 0, "not_attempted": 0, "errors": []}
sqs queue_info <config> <queue>
Description
The state of a queue: {queue, exists, url, arn, fifo, messages, messages_in_flight, messages_delayed, attributes} (attributes: all the AWS attributes, as texts). An unknown queue gives {queue, exists: false}, not an error
The state of a queue: {queue, exists, url, arn, fifo, messages, messages_in_flight, messages_delayed, attributes} (attributes: all the AWS attributes, as texts). An unknown queue gives {queue, exists: false}, not an error
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
admin
sqs queue_info "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "orders"
mentdb
{"queue": "orders", "exists": true, "url": "http://localhost:9324/123456789012/orders", "arn": "arn:aws:sqs:us-east-1:123456789012:orders", "fifo": false, "messages": 4, "messages_in_flight": 0, "messages_delayed": 0, "attributes": {"ApproximateNumberOfMessages": "4", "ApproximateNumberOfMessagesDelayed": "0", "ApproximateNumberOfMessagesNotVisible": "0", "CreatedTimestamp": "1794932676.538514", "DelaySeconds": "0", "LastModifiedTimestamp": "1794932676.538514", "MaximumMessageSize": "1048576", "MessageRetentionPeriod": "345600", "QueueArn": "arn:aws:sqs:us-east-1:123456789012:orders", "ReceiveMessageWaitTimeSeconds": "0", "VisibilityTimeout": "30", "SqsManagedSseEnabled": "true"}}
no such queue (fixed result: a real local moto 5.1.22 server, not AWS)
admin
sqs queue_info "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "nothing"
mentdb
{"queue": "nothing", "exists": false}
sqs consume <config> <queue>
Description
Read and delete at most 100 messages and 16 MB, waiting up to 5 seconds on an empty queue (see the top of the page). Returns rows {body, message_id, receipt_handle, attributes, receive_count, sent_timestamp}, with group_id and sequence_number for a FIFO queue. No message gives []
Read and delete at most 100 messages and 16 MB, waiting up to 5 seconds on an empty queue (see the top of the page). Returns rows {body, message_id, receipt_handle, attributes, receive_count, sent_timestamp}, with group_id and sequence_number for a FIFO queue. No message gives []
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
admin
sqs consume "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "orders"
mentdb
[{"body": "order 1", "message_id": "00d83808-fcf2-4ee6-a327-27cb7a15f2b5", "receipt_handle": "bwkswbdvbcsnrhcnccsancygxwnisguqevrpbmrcrbezrrsjbhnizjudpulssfzuegeohjaefpqsbxqkkbbxktvjqlptggqbtxweffsxqtqwcleetreikhdhyszsjbrkdurqooczbpkzptmmceaffnrphaolerpzmhngmbhbpryxemvwequfkthen", "attributes": {}, "receive_count": 1, "sent_timestamp": 1794932679609}, {"body": "{\\"id\\": 2}", "message_id": "5486150f-b247-4472-8528-277886021c97", "receipt_handle": "zzufjvzumktvsutxozrikezzcweceydbovafewpmumkcairfbirrwxrmvydunozagsworoylzdjzmzlzokvbiwajgcrapdramyyuqhxwrdvytfgbatmztxocswfznfkjxdcbzfsijdpfncgifyglhfmbcdsrfvadadhysftwjxhmchprkhgpxzrlg", "attributes": {"source": "erp", "amount": 12.5}, "receive_count": 1, "sent_timestamp": 1794932680390}, {"body": "order 3", "message_id": "084094f4-e510-409a-b0f3-8160b2e2b41e", "receipt_handle": "dobrwuuipidujwcnbgdfdmamgzufrigxhecchmqpxniqbhtoyjuoszvnhcbhpkkbzdfynzudfruneijhcmkcmnedypabxdqpzmfzefyrzbiksoshvoeurcxzeuihwnpbucyhqpdlyrtpsjtcvtmxodyqqlrfdjmmximadeoksmktwktjgwcjmvbdm", "attributes": {}, "receive_count": 1, "sent_timestamp": 1794932681971}, {"body": "{\\"id\\": 4}", "message_id": "5abce213-37eb-4c81-bdb0-b49492161b27", "receipt_handle": "shvkiwwzoprigkuvinfwaqxofocujvfdfqvxifuhrumzqrsptyqqxxkmmlivugqffvhcqqptuhxpimpmqnmjxhjojapacyzsnonejzajtriwkfcihrabcowsfagmqjmkilehdgbtqvgdzifhjogxoxdcjrwumoogihxflcdshlyoyheckvvdlayuw", "attributes": {"try": 1}, "receive_count": 1, "sent_timestamp": 1794932681971}]
sqs consume <config> <queue> <json_params>
Description
Read with parameters: max_messages (100, up to 100000), wait_ms (5000, up to 600000; 0: one request without waiting), visibility_timeout (seconds, for the messages of this reading), ack (true; false: the messages stay in flight, to sqs ack or sqs nack later), max_bytes (16 MB, up to 256 MB, on the sum of the bodies)
Read with parameters: max_messages (100, up to 100000), wait_ms (5000, up to 600000; 0: one request without waiting), visibility_timeout (seconds, for the messages of this reading), ack (true; false: the messages stay in flight, to sqs ack or sqs nack later), max_bytes (16 MB, up to 256 MB, on the sum of the bodies)
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
json_params: The parameters - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
json_params: The parameters - String - required
admin
sqs consume "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "{\"ack\": false, \"max_messages\": 2, \"wait_ms\": 1000}"
mentdb
[{"body": "invoice 7", "message_id": "2f7dd8b3-0cfe-49d1-8d25-85bd6023657a", "receipt_handle": "qnidvgmazbzrtdfmgqdpsyzpxztkepjnykptcuqayhuyfzfmcgcjkruwyurftafrfdynuqrisixtdgksnnqnmjkmanxazazpamcfbdmxfkihtigyheouwsljmzfflqppdsbudzkrenqtuifxxevziwetyyzwdwgyiuhphlfussoyamlsmwlbearxq", "attributes": {}, "receive_count": 1, "sent_timestamp": 1794932681191, "group_id": "client-7"}, {"body": "invoice 8", "message_id": "8c2d2c22-b110-4f7f-ab35-4f3b6a480249", "receipt_handle": "hfyfqlhcsezekqcvnrhaeeemhkyhidfsfecgjkhhwcjocomctekizyqstmpclatfrmxdxjnxytjwfdmkudgcwzdfopqpvujgiuqcgnvtzocisqabniyrihyrhgdppchycwgcplekuocgqyhhimtnbncuhmcphiyqvheytjxcgghpzwganjajduvaf", "attributes": {}, "receive_count": 1, "sent_timestamp": 1794932682744, "group_id": "client-7"}]
a FIFO queue, the next group (fixed result: a real local moto 5.1.22 server, not AWS)
admin
sqs consume "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "{\"ack\": false, \"wait_ms\": 1000}"
mentdb
[{"body": "invoice 9", "message_id": "a6140915-b7ab-490a-a075-ac0686892b23", "receipt_handle": "ljijwdyqdqefjvkegsqloinczfspbjlwhmtykmbnttqepvudyuxvpqqisicovezhamqpkshmoqtgejcozsjcslzmfsxciltmuugzjfmfggibvmfletzhdvyfbdmsicfgpywziistvnkasaerkwkzwrnpikhgtsjdfyejgjnumhecnxrdvyhkmglhv", "attributes": {}, "receive_count": 1, "sent_timestamp": 1794932682744, "group_id": "client-9"}]
sqs ack <config> <queue> <receipt_handles>
Description
Delete messages by their receipt handles, by requests of 10. Returns {acked, failed, errors}; errors has entries {row, error} with the position of the handle
Delete messages by their receipt handles, by requests of 10. Returns {acked, failed, errors}; errors has entries {row, error} with the position of the handle
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
receipt_handles: The receipt handles: one text, a JSON array of texts, or the rows of sqs consume (field receipt_handle); 100000 at most - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
receipt_handles: The receipt handles: one text, a JSON array of texts, or the rows of sqs consume (field receipt_handle); 100000 at most - String - required
admin
sqs ack "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "qnidvgmazbzrtdfmgqdpsyzpxztkepjnykptcuqayhuyfzfmcgcjkruwyurftafrfdynuqrisixtdgksnnqnmjkmanxazazpamcfbdmxfkihtigyheouwsljmzfflqppdsbudzkrenqtuifxxevziwetyyzwdwgyiuhphlfussoyamlsmwlbearxq"
mentdb
{"acked": 1, "failed": 0, "errors": []}
a handle that is not valid (fixed result: a real local moto 5.1.22 server, not AWS)
admin
sqs ack "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "[\"bad-handle\"]"
mentdb
{"acked": 0, "failed": 1, "errors": [{"row": 0, "error": "ReceiptHandleIsInvalid: The input receipt handle \\"bad-handle\\" is not a valid receipt handle."}]}
sqs nack <config> <queue> <receipt_handles>
Description
Make messages visible again at once (visibility timeout 0), by their receipt handles. Returns {nacked, failed, errors}
Make messages visible again at once (visibility timeout 0), by their receipt handles. Returns {nacked, failed, errors}
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
receipt_handles: The receipt handles: one text, a JSON array of texts, or the rows of sqs consume (field receipt_handle); 100000 at most - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
receipt_handles: The receipt handles: one text, a JSON array of texts, or the rows of sqs consume (field receipt_handle); 100000 at most - String - required
admin
sqs nack "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "hfyfqlhcsezekqcvnrhaeeemhkyhidfsfecgjkhhwcjocomctekizyqstmpclatfrmxdxjnxytjwfdmkudgcwzdfopqpvujgiuqcgnvtzocisqabniyrihyrhgdppchycwgcplekuocgqyhhimtnbncuhmcphiyqvheytjxcgghpzwganjajduvaf"
mentdb
{"nacked": 1, "failed": 0, "errors": []}
sqs nack <config> <queue> <receipt_handles> <json_params>
Description
Make messages visible again with parameters: delay_seconds (0; up to 43200: the new visibility timeout)
Make messages visible again with parameters: delay_seconds (0; up to 43200: the new visibility timeout)
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
receipt_handles: The receipt handles: one text, a JSON array of texts, or the rows of sqs consume (field receipt_handle); 100000 at most - String - required
json_params: The parameters - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
receipt_handles: The receipt handles: one text, a JSON array of texts, or the rows of sqs consume (field receipt_handle); 100000 at most - String - required
json_params: The parameters - String - required
admin
sqs nack "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo" "ljijwdyqdqefjvkegsqloinczfspbjlwhmtykmbnttqepvudyuxvpqqisicovezhamqpkshmoqtgejcozsjcslzmfsxciltmuugzjfmfggibvmfletzhdvyfbdmsicfgpywziistvnkasaerkwkzwrnpikhgtsjdfyejgjnumhecnxrdvyhkmglhv" "{\"delay_seconds\": 30}"
mentdb
{"nacked": 1, "failed": 0, "errors": []}
sqs purge <config> <queue>
Description
Delete all the messages of a queue (AWS allows one purge per minute and takes up to 60 seconds). Returns {queue, purged}
Delete all the messages of a queue (AWS allows one purge per minute and takes up to 60 seconds). Returns {queue, purged}
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
admin
sqs purge "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "orders"
mentdb
{"queue": "orders", "purged": true}
sqs queue_drop <config> <queue>
Description
Delete a queue and its messages. Returns {queue, dropped}
Delete a queue and its messages. Returns {queue, dropped}
Parameters
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs..amazonaws.com; another URL for a compatible server: ElasticMQ, LocalStack, moto), timeout_ms (30000, for each HTTP request; a long poll of consume stays below it), max_bytes (64 MB, the largest answer), ca_file (a PEM file of a private CA, with https), allow_plain (false: an http endpoint is refused unless the host is localhost or 127.0.0.1, as the session token and the messages would travel in clear; the secret key itself never travels, only the Signature V4) - String - required
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
config: The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set) for temporary credentials, region (us-east-1), endpoint (https://sqs.
queue: The queue: its name (the function asks for its URL first) or its URL - String - required
admin
sqs queue_drop "{\"endpoint\": \"http://localhost:9324\", \"region\": \"us-east-1\", \"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\"}" "billing.fifo"
mentdb
{"queue": "billing.fifo", "dropped": true}
