MediaConvert / Client / list_queues

list_queues#

MediaConvert.Client.list_queues(**kwargs)#

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.

Request Syntax

response = client.list_queues(
    ListBy='NAME'|'CREATION_DATE',
    MaxResults=123,
    NextToken='string',
    Order='ASCENDING'|'DESCENDING'
)

Parameters:

ListBy (string) – 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.
MaxResults (integer) – Optional. Number of queues, up to twenty, that will be returned at one time.
NextToken (string) – Use this string, provided with the response to a previous request, to request the next batch of queues.
Order (string) – Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Queues': [
        {
            'Arn': 'string',
            'ConcurrentJobs': 123,
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'LastUpdated': datetime(2015, 1, 1),
            'Name': 'string',
            'PricingPlan': 'ON_DEMAND'|'RESERVED',
            'ProgressingJobsCount': 123,
            'ReservationPlan': {
                'Commitment': 'ONE_YEAR',
                'ExpiresAt': datetime(2015, 1, 1),
                'PurchasedAt': datetime(2015, 1, 1),
                'RenewalType': 'AUTO_RENEW'|'EXPIRE',
                'ReservedSlots': 123,
                'Status': 'ACTIVE'|'EXPIRED'
            },
            'ServiceOverrides': [
                {
                    'Message': 'string',
                    'Name': 'string',
                    'OverrideValue': 'string',
                    'Value': 'string'
                },
            ],
            'Status': 'ACTIVE'|'PAUSED',
            'SubmittedJobsCount': 123,
            'Type': 'SYSTEM'|'CUSTOM'
        },
    ],
    'TotalConcurrentJobs': 123,
    'UnallocatedConcurrentJobs': 123
}

Response Structure

(dict) –
- NextToken (string) – Use this string to request the next batch of queues.
- Queues (list) – List of queues.
  - (dict) – 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.
    - Arn (string) – An identifier for this resource that is unique within all of AWS.
    - ConcurrentJobs (integer) – The maximum number of jobs your queue can process concurrently.
    - CreatedAt (datetime) – The timestamp in epoch seconds for when you created the queue.
    - Description (string) – An optional description that you create for each queue.
    - LastUpdated (datetime) – The timestamp in epoch seconds for when you most recently updated the queue.
    - Name (string) – A name that you create for each queue. Each name must be unique within your account.
    - PricingPlan (string) – 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 (integer) – The estimated number of jobs with a PROGRESSING status.
    - ReservationPlan (dict) – Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
      - Commitment (string) – The length of the term of your reserved queue pricing plan commitment.
      - ExpiresAt (datetime) – The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.
      - PurchasedAt (datetime) – The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.
      - RenewalType (string) – Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.
      - ReservedSlots (integer) – 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 (string) – Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.
    - ServiceOverrides (list) – 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 AWS Support.
      - (dict) – A service override applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.
        
        Message (string) – Details about the service override that MediaConvert has applied.
        
        Name (string) – The name of the setting that MediaConvert has applied an override to.
        
        OverrideValue (string) – The current value of the service override that MediaConvert has applied.
        
        Value (string) – The value of the setting that you configured, prior to any overrides that MediaConvert has applied.
    - Status (string) – 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 (integer) – The estimated number of jobs with a SUBMITTED status.
    - Type (string) – 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.
- TotalConcurrentJobs (integer) – The maximum number of jobs that MediaConvert can process at one time, across all of your on-demand queues in the current AWS Region.
- UnallocatedConcurrentJobs (integer) – The remaining number of concurrent jobs that are not associated with a queue and are available to allocate to a queue. You can allocate these jobs when you create or update a queue.

Exceptions

MediaConvert.Client.exceptions.BadRequestException
MediaConvert.Client.exceptions.InternalServerErrorException
MediaConvert.Client.exceptions.ForbiddenException
MediaConvert.Client.exceptions.NotFoundException
MediaConvert.Client.exceptions.TooManyRequestsException
MediaConvert.Client.exceptions.ConflictException