Skip to main content
POST
Lease messages
Requires the IAM action queue:ReceiveMessage. 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"

Body

application/json
max_messages
integer

How many messages to lease. Fewer may be returned even when more are available.

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

10

visibility_timeout_seconds
integer

Overrides the queue's default for this lease only.

Required range: 0 <= x <= 43200
Example:

60

wait_time_seconds
integer

Block up to this long for a message rather than returning empty. Defaults to the queue's receive_wait_time_seconds.

Required range: 0 <= x <= 20
Example:

20

Response

Leased messages, possibly none.

messages
object[]
required