Skip to main content
GET
Peek at a queue's messages
Requires the IAM action queue:PeekMessages. See QUEUE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

queue_id
string<uuid>
required
Example:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Query Parameters

crn
string

Exact message CRN under this queue. Foreign or mismatched CRNs select an empty page before pagination; malformed CRNs return 400.

Example:

"crn:queue:sa-saopaulo-1:acme:queue/orders/message/019400aa-bbbb-7ccc-8ddd-eeeeffff0000"

visibility
enum<string>

Restrict the peek to one population. available can be received now; in_flight is leased by a consumer; delayed has never been delivered and its send-time delay has not elapsed.

Available options:
available,
in_flight,
delayed
Example:

"available"

marker
string<uuid>

Id of the last item on the previous page.

Example:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

limit
integer
default:50

Maximum items to return. A larger value is clamped to the maximum rather than rejected, so page until meta.has_more is false.

Required range: 1 <= x <= 200
Example:

50

Response

Paginated list of messages.

messages
object[]
required
meta
object