Skip to main content
PATCH
Update queue attributes
Requires the IAM action queue:UpdateQueue. 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
visibility_timeout_seconds
integer
Required range: 0 <= x <= 43200
Example:

60

message_retention_seconds
integer
Required range: 60 <= x <= 1209600
Example:

345600

max_message_bytes
integer
Required range: 1024 <= x <= 262144
Example:

262144

delay_seconds
integer
Required range: 0 <= x <= 900
Example:

0

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

20

kms_data_key_reuse_period_seconds
integer
Required range: 60 <= x <= 86400
Example:

300

redrive_policy
object | null

Omit to keep the current policy; null removes it. An object replaces the policy.

kms_key
string | null

KMS key UUID, CRN or account-scoped name. Omit to keep the current key; null restores the platform key. Existing messages keep the key that sealed them.

Example:

"crn:kms:sa-saopaulo-1:acme:key/service-key"

tags
object
Example:

Response

Queue updated.

queue
object
required