Spec-Zone.ru › AWS CLI v2

[ aws . mediaconvert ]

list-queues

Описание

Получение JSON-массива до двадцати ваших очередей. Будут возвращены сами очереди, а не просто список. Чтобы получить следующие двадцать очередей, используйте строку nextToken, возвращаемую в массиве.

См. также: Документацию API AWS

list-queues является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query для ответа с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Queues

Синтаксис

  list-queues
[--list-by <value>]
[--order <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--list-by (строка) Необязательно. При запросе списка очередей вы можете выбрать их сортировку по имени (по алфавиту) или по дате создания. Если вы не укажете, служба отсортирует их по дате создания.

Возможные значения:

  • NAME
  • CREATION_DATE

--order (строка) Необязательно. При запросе списков ресурсов вы можете указать, сортировать ли их по возрастанию (ASCENDING) или убыванию (DESCENDING). Значение по умолчанию зависит от ресурса.

Возможные значения:

  • ASCENDING
  • DESCENDING

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, заданному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет интерпретирована буквально. Это может не быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную навигацию, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла аутентификации.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображаемого в двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-пэджер для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Список ваших очередей

Следующий пример list-queues отображает все ваши очереди MediaConvert.

aws mediaconvert list-queues \
    --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com

Вывод:

{
    "Queues": [
        {
            "PricingPlan": "ON_DEMAND",
            "Type": "SYSTEM",
            "Status": "ACTIVE",
            "CreatedAt": 1503451595,
            "Name": "Default",
            "SubmittedJobsCount": 0,
            "ProgressingJobsCount": 0,
            "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Default",
            "LastUpdated": 1534549158
        },
        {
            "PricingPlan": "ON_DEMAND",
            "Type": "CUSTOM",
            "Status": "ACTIVE",
            "CreatedAt": 1537460025,
            "Name": "Customer1",
            "SubmittedJobsCount": 0,
            "Description": "Jobs we run for our cusotmer.",
            "ProgressingJobsCount": 0,
            "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Customer1",
            "LastUpdated": 1537460025
        },
        {
            "ProgressingJobsCount": 0,
            "Status": "ACTIVE",
            "Name": "transcode-library",
            "SubmittedJobsCount": 0,
            "LastUpdated": 1564066204,
            "ReservationPlan": {
                "Status": "ACTIVE",
                "ReservedSlots": 1,
                "PurchasedAt": 1564066203,
                "Commitment": "ONE_YEAR",
                "ExpiresAt": 1595688603,
                "RenewalType": "EXPIRE"
            },
            "PricingPlan": "RESERVED",
            "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/transcode-library",
            "Type": "CUSTOM",
            "CreatedAt": 1564066204
        }
    ]
}

Дополнительную информацию см. в разделе Работа с очередями AWS Elemental MediaConvert в Руководстве пользователя AWS Elemental MediaConvert.

Вывод

NextToken -> (строка)

Используйте эту строку, чтобы запросить следующую партию очередей.

Queues -> (список)

Список очередей.

(структура)

Вы можете использовать очереди для управления ресурсами, доступными вашей учетной записи AWS для одновременного выполнения нескольких задач транскодирования. Если вы не укажете очередь, служба отправит все задачи в стандартную очередь. Дополнительную информацию см. на странице https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.

Arn -> (строка)

Идентификатор этого ресурса, уникальный в рамках всей AWS.

ConcurrentJobs -> (целое число)

Максимальное количество задач, которые может обрабатывать очередь одновременно.

CreatedAt -> (метка времени)

Метка времени в секундах с начала эпохи для создания очереди.

Description -> (строка)

Необязательное описание, создаваемое для каждой очереди.

LastUpdated -> (метка времени)

Метка времени в секундах с начала эпохи для последнего обновления очереди.

Name -> (строка)

Имя, которое вы создаете для каждой очереди. Каждое имя должно быть уникальным в рамках вашей учетной записи.

PricingPlan -> (строка)

Указывает, является ли тарифный план очереди по требованию или резервированным. Для по требованию вы платите за каждую минуту, с оплатой в increments of .01 минуты. Для резервирования вы оплачиваете транскодировочную емкость всей очереди независимо от того, сколько или как мало вы ее используете. Резервированный тарифный план требует 12-месячного обязательства.

ProgressingJobsCount -> (целое число)

Приблизительное количество задач со статусом PROGRESSING.

ReservationPlan -> (структура)

Подробная информация о тарифном плане для вашей резервированной очереди. Требуется для резервированных очередей и не применяется для очередей по требованию.

Commitment -> (строка)

Срок обязательства по вашему резервированному тарифному плану очереди.

ExpiresAt -> (метка времени)

Метка времени в секундах с начала эпохи для истечения срока действия текущего тарифного плана для этой резервированной очереди.

PurchasedAt -> (метка времени)

Метка времени в секундах с начала эпохи для настройки текущего тарифного плана для этой резервированной очереди.

RenewalType -> (строка)

Указывает, автоматически ли продлевается срок действия вашего резервированного тарифного плана очереди (AUTO_RENEW) или он истекает (EXPIRE) по окончании срока действия.

ReservedSlots -> (целое число)

Указывает количество зарезервированных слотов транскодирования (RTS) для этой очереди. Количество RTS определяет, сколько задач может обрабатывать очередь параллельно; каждый RTS может обрабатывать одну задачу за раз. При увеличении этого числа вы продлеваете свое существующее обязательство новым 12-месячным обязательством для большего количества RTS. Новое обязательство начинается с момента приобретения дополнительной емкости. Вы не можете уменьшить количество RTS в своей резервированной очереди.

Status -> (строка)

Указывает, активен ли тарифный план вашей резервированной очереди (ACTIVE) или истек (EXPIRED).

ServiceOverrides -> (список)

Список любых переопределений служб, примененных MediaConvert к настройкам, которые вы настроили. Если вы видите какие-либо переопределения, мы рекомендуем обратиться в службу поддержки AWS.

(структура)

Переопределение службы, примененное MediaConvert к настройкам, которые вы настроили. Если вы видите какие-либо переопределения, мы рекомендуем обратиться в службу поддержки AWS.

Message -> (строка)

Подробная информация о переопределении службы, примененном MediaConvert.

Name -> (строка)

Имя параметра, к которому MediaConvert применил переопределение.

OverrideValue -> (строка)

Текущее значение переопределения службы, примененного MediaConvert.

Value -> (строка)

Значение параметра, которое вы настроили до применения каких-либо переопределений, примененных MediaConvert.

Status -> (строка)

Очереди могут быть ACTIVE или PAUSED. Если вы приостановите очередь, служба не начнет обработку задач в этой очереди. Задачи, которые выполняются в момент приостановки очереди, продолжают выполняться до завершения или возникновения ошибки.

SubmittedJobsCount -> (целое число)

Приблизительное количество задач со статусом SUBMITTED.

Type -> (строка)

Указывает, является ли эта очередь по требованию системной или пользовательской. Системные очереди встроенные. Вы не можете изменять или удалять системные очереди. Вы можете создавать и изменять пользовательские очереди.

TotalConcurrentJobs -> (целое число)

Максимальное количество задач, которые MediaConvert может обрабатывать одновременно во всех ваших очередях по требованию в текущем регионе AWS.

UnallocatedConcurrentJobs -> (целое число)

Остаток задач, которые не связаны с очередью и доступны для распределения по очереди. Вы можете распределить эти задачи при создании или обновлении очереди.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API