PUT

/2017-08-29/queues/{name}

http://mediaconvert.{region}.amazonaws.com/2017-08-29/queues/{name}

Modify one of your existing queues.

Access Token Required: API Key

Path Parameters

namestringrequired

The name of the queue that you are modifying.

Body Params

statusstring

Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause a queue continue to run until they finish or result in an error.

descriptionstring

The new description for the queue, if you are changing it.

reservationPlanSettingsobject

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://mediaconvert.{region}.amazonaws.com/2017-08-29/queues/{name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT