Menu
AWS Elemental MediaConvert API Reference
API Reference

Queues

URI

/2017-08-29/queues

HTTP Methods

GET

Operation ID: ListQueues

Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.

Query Parameters

Name Type Required Description
listBy String False
nextToken String False
maxResults String False
order String False

Responses

Status Code Response Model Description
200 ListQueuesResponse

200 response

400 ExceptionBody

BadRequestException

500 ExceptionBody

InternalServiceException

403 ExceptionBody

AccessDeniedException

404 ExceptionBody

ResourceNotFoundException

429 ExceptionBody

LimitExceededException

409 ExceptionBody

ResourceInUseException

POST

Operation ID: CreateQueue

Create a new transcoding queue. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Responses

Status Code Response Model Description
201 CreateQueueResponse

201 response

400 ExceptionBody

BadRequestException

500 ExceptionBody

InternalServiceException

403 ExceptionBody

AccessDeniedException

404 ExceptionBody

ResourceNotFoundException

429 ExceptionBody

LimitExceededException

409 ExceptionBody

ResourceInUseException

Schemas

Request Bodies

Example GET

{ "nextToken": "string", "maxResults": integer, "listBy": enum, "order": enum }

Example POST

{ "name": "string", "description": "string", "tags": { } }

Response Bodies

Example ListQueuesResponse

{ "queues": [ { "createdAt": "string", "lastUpdated": "string", "progressingJobsCount": integer, "submittedJobsCount": integer, "name": "string", "description": "string", "arn": "string", "type": enum, "status": enum } ], "nextToken": "string" }

Example CreateQueueResponse

{ "queue": { "createdAt": "string", "lastUpdated": "string", "progressingJobsCount": integer, "submittedJobsCount": integer, "name": "string", "description": "string", "arn": "string", "type": enum, "status": enum } }

Example ExceptionBody

{ "message": "string" }

Properties

CreateQueueRequest

Send your create queue request with the name of the queue.

Property Type Required Description
name

string

True

The name of the queue you are creating.

description

string

False

Optional. A description of the queue you are creating.

tags

object

False

CreateQueueResponse

Successful create queue requests will return the name of the queue you just created and information about it.

Property Type Required Description
queue

Queue

False

ExceptionBody

Property Type Required Description
message

string

False

ListQueuesRequest

You can send list queues requests with an empty body. You can optionally specify the maximum number, up to twenty, of queues to be returned.

Property Type Required Description
nextToken

string

False

Use this string, provided with the response to a previous request, to request the next batch of queues.

maxResults

integer

Format: int32

Minimum: 1

Maximum: 20

False

Optional. Number of queues, up to twenty, that will be returned at one time.

listBy

string

False
order

string

False

ListQueuesResponse

Successful list queues return a JSON array of queues. If you do not specify how they are ordered, you will receive them alphabetically by name.

Property Type Required Description
queues

Array of type Queue

False

List of queues

nextToken

string

False

Use this string to request the next batch of queues.

Order (enum)

When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

  • ASCENDING

  • DESCENDING

Queue

MediaConvert jobs are submitted to a queue. Unless specified otherwise jobs are submitted to a built-in default queue. User can create additional queues to separate the jobs of different categories or priority.

Property Type Required Description
createdAt

string

Format: date-time

False

The timestamp in epoch seconds for queue creation.

lastUpdated

string

Format: date-time

False

The timestamp in epoch seconds when the queue was last updated.

progressingJobsCount

integer

Format: int64

False

Estimated number of jobs in PROGRESSING status.

submittedJobsCount

integer

Format: int64

False

Estimated number of jobs in SUBMITTED status.

name

string

True

A name you create for each queue. Each name must be unique within your account.

description

string

False

An optional description you create for each queue.

arn

string

False

An identifier for this resource that is unique within all of AWS.

type

string

False

A queue can be of two types: system or custom. System or built-in queues can't be modified or deleted by the user.

status

string

False

QueueListBy (enum)

Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.

  • NAME

  • CREATION_DATE

QueueStatus (enum)

Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue will not begin. Jobs running when a queue is paused continue to run until they finish or error out.

  • ACTIVE

  • PAUSED

Type (enum)

  • SYSTEM

  • CUSTOM