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

BadRequestException

500 ExceptionBody

InternalServiceException

403 ExceptionBody

AccessDeniedException

404 ExceptionBody

ResourceNotFoundException

429 ExceptionBody

LimitExceededException

409 ExceptionBody

ResourceInUseException

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

BadRequestException

500 ExceptionBody

InternalServiceException

403 ExceptionBody

AccessDeniedException

404 ExceptionBody

ResourceNotFoundException

429 ExceptionBody

LimitExceededException

409 ExceptionBody

ResourceInUseException

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
400 ExceptionBody

BadRequestException

202 DeleteQueueResponse

202 response

500 ExceptionBody

InternalServiceException

403 ExceptionBody

AccessDeniedException

404 ExceptionBody

ResourceNotFoundException

429 ExceptionBody

LimitExceededException

409 ExceptionBody

ResourceInUseException

See Also

Schemas

Request Bodies

Example GET

{ "name": "string" }

Example PUT

{ "name": "string", "description": "string", "status": enum }

Example DELETE

{ "name": "string" }

Response Bodies

Example GetQueueResponse

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

Example UpdateQueueResponse

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

Example DeleteQueueResponse

{ }

Example ExceptionBody

{ "message": "string" }

Properties

DeleteQueueRequest

Delete a queue by sending a request with the queue name

Property Type Required Description
name

string

False

The name of the queue to be deleted.

See Also

DeleteQueueResponse

Delete queue requests will 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

Query a queue by sending a request with the queue name.

Property Type Required Description
name

string

False

The name of the queue.

See Also

GetQueueResponse

Successful get queue requests will return an OK message and the queue JSON.

Property Type Required Description
queue

Queue

False

See Also

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

See Also

QueueStatus (enum)

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

  • ACTIVE

  • PAUSED

Type (enum)

  • SYSTEM

  • CUSTOM

UpdateQueueRequest

Modify a queue by sending a request with the queue name and any of the following that you wish to change - description, status. You pause or activate a queue by changing its status between ACTIVE and PAUSED.

Property Type Required Description
name

string

False

The name of the queue you are modifying.

description

string

False

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

status

string

False

See Also

UpdateQueueResponse

Successful update queue requests will return the new queue JSON.

Property Type Required Description
queue

Queue

False

See Also