AWS Elemental MediaConvert API Reference
API Reference

Queues name

URI

/2017-08-29/queues/ name

HTTP Methods

GET

Operation ID: GetQueue

Retrieve the JSON for a specific queue.

Path Parameters

Name Type Required Description
name String True

Responses

Status Code Response Model Description
200 GetQueueResponse

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

PUT

Operation ID: UpdateQueue

Modify one of your existing queues.

Path Parameters

Name Type Required Description
name String True

Responses

Status Code Response Model Description
200 UpdateQueueResponse

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

DELETE

Operation ID: DeleteQueue

Permanently delete a queue you have created.

Path Parameters

Name Type Required Description
name String True

Responses

Status Code Response Model Description
202 DeleteQueueResponse

202 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

{ "name": "string" }

Example PUT

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

Example DELETE

{ "name": "string" }

Response Bodies

Example GetQueueResponse

{ "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 UpdateQueueResponse

{ "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 DeleteQueueResponse

{ }

Example ExceptionBody

{ "message": "string" }

Properties

Commitment (enum)

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

  • ONE_YEAR

DeleteQueueRequest

Delete a queue by sending a request with the queue name. You can't delete a queue with an active pricing plan or one that has unprocessed jobs in it.

Property Type Required Description
name

string

False

The name of the queue that you want to delete.

See Also

DeleteQueueResponse

Delete queue requests return an OK message or error message with an empty body.

Property Type Required Description

See Also

ExceptionBody

Property Type Required Description
message

string

False

See Also

GetQueueRequest

Get information about a queue by sending a request with the queue name.

Property Type Required Description
name

string

False

The name of the queue that you want information about.

See Also

GetQueueResponse

Successful get queue requests return an OK message and information about the queue in JSON.

Property Type Required Description
queue

Queue

False

See Also

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

string

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

string

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

string

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

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

string

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

string

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

string

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

string

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

string

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

UpdateQueueRequest

Modify a queue by sending a request with the queue name and any changes to the queue.

Property Type Required Description
description

string

False

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

status

string

False

Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

name

string

False

The name of the queue that you are modifying.

reservationPlanSettings

ReservationPlanSettings

False

The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.

See Also

UpdateQueueResponse

Successful update queue requests return the new queue information in JSON format.

Property Type Required Description
queue

Queue

False

See Also