Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . mediaconvert ]

list-queues

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-queues
[--list-by <value>]
[--max-results <value>]
[--next-token <value>]
[--order <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--list-by (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.

Possible values:

  • NAME
  • CREATION_DATE

--max-results (integer) Optional. Number of queues, up to twenty, that will be returned at one time.

--next-token (string) Use this string, provided with the response to a previous request, to request the next batch of queues.

--order (string) When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Possible values:

  • ASCENDING
  • DESCENDING

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

NextToken -> (string)

Use this string to request the next batch of queues.

Queues -> (list)

List of queues

(structure)

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.

Arn -> (string)

An identifier for this resource that is unique within all of AWS.

CreatedAt -> (timestamp)

The timestamp in epoch seconds for queue creation.

Description -> (string)

An optional description you create for each queue.

LastUpdated -> (timestamp)

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

Name -> (string)

A name you create for each queue. Each name must be unique within your account.

ProgressingJobsCount -> (integer)

Estimated number of jobs in PROGRESSING status.

Status -> (string)

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.

SubmittedJobsCount -> (integer)

Estimated number of jobs in SUBMITTED status.

Type -> (string)

A queue can be of two types: system or custom. System or built-in queues can't be modified or deleted by the user.