Menu
AWS Elemental MediaConvert API Reference
API Reference

A Specific Queue

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: OkRresponse

400 ExceptionBody

400: BadRequestException

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

500 ExceptionBody

500: InternalServiceException

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

403 ExceptionBody

403: AccessDeniedException

You don't have permissions for this action with the credentials you sent. Please check your authorization credentials. You should be sending credentials using the AWS Signature Version 4 signing process.

404 ExceptionBody

404: ResourceNotFoundException

The resource you requested does not exist.

429 ExceptionBody

429: LimitExceededException

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. For example, you may be hitting your account limits for preset creation or job submission.

409 ExceptionBody

409: ResourceInUseException

The service could not complete your request because there is a conflict with the current state of the resource. For example, you may be trying to delete a Queue that has jobs processing.

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: OkRresponse

400 ExceptionBody

400: BadRequestException

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

500 ExceptionBody

500: InternalServiceException

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

403 ExceptionBody

403: AccessDeniedException

You don't have permissions for this action with the credentials you sent. Please check your authorization credentials. You should be sending credentials using the AWS Signature Version 4 signing process.

404 ExceptionBody

404: ResourceNotFoundException

The resource you requested does not exist.

429 ExceptionBody

429: LimitExceededException

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. For example, you may be hitting your account limits for preset creation or job submission.

409 ExceptionBody

409: ResourceInUseException

The service could not complete your request because there is a conflict with the current state of the resource. For example, you may be trying to delete a Queue that has jobs processing.

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

400: BadRequestException

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

202 DeleteQueueResponse

202: AcceptedResponse

Your request has been accepted. Processing has not yet begun.

500 ExceptionBody

500: InternalServiceException

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

403 ExceptionBody

403: AccessDeniedException

You don't have permissions for this action with the credentials you sent. Please check your authorization credentials. You should be sending credentials using the AWS Signature Version 4 signing process.

404 ExceptionBody

404: ResourceNotFoundException

The resource you requested does not exist.

429 ExceptionBody

429: LimitExceededException

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. For example, you may be hitting your account limits for preset creation or job submission.

409 ExceptionBody

409: ResourceInUseException

The service could not complete your request because there is a conflict with the current state of the resource. For example, you may be trying to delete a Queue that has jobs processing.

Schemas

Request Bodies

Example GET

{ "name": "string" }

Example PUT

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

Example DELETE

{ "name": "string" }

Response Bodies

Example GetQueueResponse

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

Example UpdateQueueResponse

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

Example DeleteQueueResponse

{ }

Example ExceptionBody

{ "message": "string" }

Properties

DeleteQueueRequest

Property Type Required Description
name

string

True

DeleteQueueResponse

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

Property Type Required Description

ExceptionBody

Property Type Required Description
message

string

False

GetQueueRequest

Property Type Required Description
name

string

True

GetQueueResponse

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

Property Type Required Description
queue

Queue

False

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
lastUpdated

string

Format: date-time

False

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

createdAt

string

Format: date-time

False

The timestamp in epoch seconds for queue creation.

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
status

string

False

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

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

True

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

UpdateQueueResponse

Successful update queue requests will return the new queue JSON.

Property Type Required Description
queue

Queue

False