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

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403 ExceptionBody

You don't have permissions for this action with the credentials you sent.

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429 ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500 ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

See Also

POST

Operation ID: CreateQueue

Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html

Responses

Status Code Response Model Description
201 CreateQueueResponse

201 response

400 ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403 ExceptionBody

You don't have permissions for this action with the credentials you sent.

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429 ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500 ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

See Also

Schemas

Request Bodies

Example GET

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

Example POST

{ "description": "string", "tags": { }, "name": "string", "pricingPlan": enum, "reservationPlanSettings": { "reservedSlots": integer, "renewalType": enum, "commitment": enum } }

Response Bodies

Example ListQueuesResponse

{ "queues": [ { "arn": "string", "createdAt": "string", "lastUpdated": "string", "type": enum, "pricingPlan": enum, "status": enum, "description": "string", "name": "string", "submittedJobsCount": integer, "progressingJobsCount": integer, "reservationPlan": { "reservedSlots": integer, "renewalType": enum, "commitment": enum, "purchasedAt": "string", "expiresAt": "string", "status": enum } } ], "nextToken": "string" }

Example CreateQueueResponse

{ "queue": { "arn": "string", "createdAt": "string", "lastUpdated": "string", "type": enum, "pricingPlan": enum, "status": enum, "description": "string", "name": "string", "submittedJobsCount": integer, "progressingJobsCount": integer, "reservationPlan": { "reservedSlots": integer, "renewalType": enum, "commitment": enum, "purchasedAt": "string", "expiresAt": "string", "status": enum } } }

Example ExceptionBody

{ "message": "string" }

Properties

Commitment (enum)

The length of the term of your reserved queue pricing plan commitment.

  • ONE_YEAR

CreateQueueRequest

Create an on-demand queue by sending a CreateQueue request with the name of the queue. Create a reserved queue by sending a CreateQueue request with the pricing plan set to RESERVED and with values specified for the settings under reservationPlanSettings. When you create a reserved queue, you enter into a 12-month commitment to purchase the RTS that you specify. You can't cancel this commitment.

Property Type Required Description
description

string

False

Optional. A description of the queue that you are creating.

tags

object

False

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

name

string

True

The name of the queue that you are creating.

pricingPlan

PricingPlan

False

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.

reservationPlanSettings

ReservationPlanSettings

False

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

See Also

CreateQueueResponse

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

Property Type Required Description
queue

Queue

False

You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.

See Also

ExceptionBody

Property Type Required Description
message

string

False

See Also

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
listBy

QueueListBy

False

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.

order

Order

False

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

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.

See Also

ListQueuesResponse

Successful list queues requests return a JSON array of queues. If you don't specify how they are ordered, you will receive them alphabetically by name.

Property Type Required Description
queues

array

False

List of queues.

nextToken

string

False

Use this string to request the next batch of queues.

See Also

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

PricingPlan (enum)

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

  • ON_DEMAND

  • RESERVED

Queue

You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.

Property Type Required Description
arn

string

False

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

createdAt

string

Format: date-time

False

The timestamp in epoch seconds for when you created the queue.

lastUpdated

string

Format: date-time

False

The timestamp in epoch seconds for when you most recently updated the queue.

type

Type

False

Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

pricingPlan

PricingPlan

False

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

status

QueueStatus

False

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

description

string

False

An optional description that you create for each queue.

name

string

True

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

submittedJobsCount

integer

Format: int64

False

The estimated number of jobs with a SUBMITTED status.

progressingJobsCount

integer

Format: int64

False

The estimated number of jobs with a PROGRESSING status.

reservationPlan

ReservationPlan

False

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

See Also

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 won't begin. Jobs that are running when you pause a queue continue to run until they finish or result in an error.

  • ACTIVE

  • PAUSED

RenewalType (enum)

Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.

  • AUTO_RENEW

  • EXPIRE

ReservationPlan

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

Property Type Required Description
reservedSlots

integer

Format: int32

False

Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue.

renewalType

RenewalType

False

Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.

commitment

Commitment

False

The length of the term of your reserved queue pricing plan commitment.

purchasedAt

string

Format: date-time

False

The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.

expiresAt

string

Format: date-time

False

The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.

status

ReservationPlanStatus

False

Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.

See Also

ReservationPlanSettings

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

Property Type Required Description
reservedSlots

integer

Format: int32

True

Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity.

renewalType

RenewalType

True

Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the auto renew date. You can cancel this commitment.

commitment

Commitment

True

The length of the term of your reserved queue pricing plan commitment.

See Also

ReservationPlanStatus (enum)

Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.

  • ACTIVE

  • EXPIRED

Type (enum)

  • SYSTEM

  • CUSTOM