# 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. | ### 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. | ### 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. | ### OPTIONS Supports CORS preflight requests. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | name | String | True | | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | The request completed successfully. | ## Schemas ### Request bodies #### GET schema GET ``` { "name": "string" } ``` #### PUT schema PUT ``` { "description": "string", "status": enum, "name": "string", "reservationPlanSettings": { "reservedSlots": integer, "renewalType": enum, "commitment": enum }, "concurrentJobs": integer } ``` #### DELETE schema DELETE ``` { "name": "string" } ``` ### Response bodies #### GetQueueResponse schema 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 }, "concurrentJobs": integer, "serviceOverrides": [ { "name": "string", "value": "string", "overrideValue": "string", "message": "string" } ] } } ``` #### UpdateQueueResponse schema 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 }, "concurrentJobs": integer, "serviceOverrides": [ { "name": "string", "value": "string", "overrideValue": "string", "message": "string" } ] } } ``` #### DeleteQueueResponse schema DeleteQueueResponse ``` { } ``` #### ExceptionBody schema ExceptionBody ``` { "message": "string" } ``` ## Properties ### Commitment 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. | ### DeleteQueueResponse Delete queue requests return an OK message or error message with an empty body. ### ExceptionBody | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | | ### 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. | ### GetQueueResponse Successful get queue requests return an OK message and information about the queue in JSON. | Property | Type | Required | Description | | --- |--- |--- |--- | | queue | [Queue](#queues-name-model-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. | ### PricingPlan 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. | | concurrentJobs | integerFormat: int64 | False | The maximum number of jobs your queue can process concurrently. | | createdAt | stringFormat: date-time | False | The timestamp in epoch seconds for when you created the queue. | | description | string | False | An optional description that you create for each queue. | | lastUpdated | stringFormat: date-time | False | The timestamp in epoch seconds for when you most recently updated the queue. | | name | string | True | A name that you create for each queue. Each name must be unique within your account. | | pricingPlan | [PricingPlan](#queues-name-model-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. | | progressingJobsCount | integerFormat: int64 | False | The estimated number of jobs with a PROGRESSING status. | | reservationPlan | [ReservationPlan](#queues-name-model-reservationplan) | False | Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues. | | serviceOverrides | Array of type [ServiceOverride](#queues-name-model-serviceoverride) | False | A list of any service overrides applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact Support. | | status | [QueueStatus](#queues-name-model-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. | | submittedJobsCount | integerFormat: int64 | False | The estimated number of jobs with a SUBMITTED status. | | type | [Type](#queues-name-model-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. | ### QueueStatus 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 Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO\$1RENEW) 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 | | --- |--- |--- |--- | | commitment | [Commitment](#queues-name-model-commitment) | False | The length of the term of your reserved queue pricing plan commitment. | | expiresAt | stringFormat: date-time | False | The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires. | | purchasedAt | stringFormat: date-time | False | The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue. | | renewalType | [RenewalType](#queues-name-model-renewaltype) | False | Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO\$1RENEW) or expires (EXPIRE) at the end of the term. | | reservedSlots | integerFormat: 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. | | status | [ReservationPlanStatus](#queues-name-model-reservationplanstatus) | False | Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED. | ### 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 | | --- |--- |--- |--- | | commitment | [Commitment](#queues-name-model-commitment) | True | The length of the term of your reserved queue pricing plan commitment. | | renewalType | [RenewalType](#queues-name-model-renewaltype) | True | Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO\$1RENEW) 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. | | reservedSlots | integerFormat: 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. | ### ReservationPlanStatus Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED. + `ACTIVE` + `EXPIRED` ### ServiceOverride A service override applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact Support. | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | Details about the service override that MediaConvert has applied. | | name | string | False | The name of the setting that MediaConvert has applied an override to. | | overrideValue | string | False | The current value of the service override that MediaConvert has applied. | | value | string | False | The value of the setting that you configured, prior to any overrides that MediaConvert has applied. | ### Type + `SYSTEM` + `CUSTOM` ### UpdateQueueRequest Modify a queue by sending a request with the queue name and any changes to the queue. | Property | Type | Required | Description | | --- |--- |--- |--- | | concurrentJobs | integerFormat: int64 | False | Specify the maximum number of jobs your queue can process concurrently. For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, update your reservation plan instead in order to increase your yearly commitment. | | description | string | False | The new description for the queue, if you are changing it. | | name | string | False | The name of the queue that you are modifying. | | reservationPlanSettings | [ReservationPlanSettings](#queues-name-model-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. | | status | [QueueStatus](#queues-name-model-queuestatus) | 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. | ### UpdateQueueResponse Successful update queue requests return the new queue information in JSON format. | Property | Type | Required | Description | | --- |--- |--- |--- | | queue | [Queue](#queues-name-model-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 For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### GetQueue + [AWS Command Line Interface V2](/goto/cli2/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for Python](/goto/boto3/mediaconvert-2017-08-29/GetQueue) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediaconvert-2017-08-29/GetQueue) ### UpdateQueue + [AWS Command Line Interface V2](/goto/cli2/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for Python](/goto/boto3/mediaconvert-2017-08-29/UpdateQueue) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediaconvert-2017-08-29/UpdateQueue) ### DeleteQueue + [AWS Command Line Interface V2](/goto/cli2/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for Python](/goto/boto3/mediaconvert-2017-08-29/DeleteQueue) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediaconvert-2017-08-29/DeleteQueue)