Spec-Zone.ru › AWS CLI v2

[ aws . medialive ]

list-reservations

Описание

Список приобретённых резерваций.

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

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

Синтаксис

  list-reservations
[--channel-class <value>]
[--codec <value>]
[--maximum-bitrate <value>]
[--maximum-framerate <value>]
[--resolution <value>]
[--resource-type <value>]
[--special-feature <value>]
[--video-quality <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]

Параметры

--channel-class (строка) Фильтр по классу канала, ‘STANDARD’ или ‘SINGLE_PIPELINE’

--codec (строка) Фильтр по кодеку, ‘AVC’, ‘HEVC’, ‘MPEG2’, ‘AUDIO’, ‘LINK’ или ‘AV1’

--maximum-bitrate (строка) Фильтр по битрейту, ‘MAX_10_MBPS’, ‘MAX_20_MBPS’ или ‘MAX_50_MBPS’

--maximum-framerate (строка) Фильтр по частоте кадров, ‘MAX_30_FPS’ или ‘MAX_60_FPS’

--resolution (строка) Фильтр по разрешению, ‘SD’, ‘HD’, ‘FHD’ или ‘UHD’

--resource-type (строка) Фильтр по типу ресурса, ‘INPUT’, ‘OUTPUT’, ‘MULTIPLEX’ или ‘CHANNEL’

--special-feature (строка) Фильтр по специальной функции, ‘ADVANCED_AUDIO’ или ‘AUDIO_NORMALIZATION’

--video-quality (строка) Фильтр по качеству видео, ‘STANDARD’, ‘ENHANCED’ или ‘PREMIUM’

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

NextToken -> (строка)

Маркер для получения следующей страницы результатов

Reservations -> (список)

Список резерваций

(структура)

Доступные для использования зарезервированные ресурсы

Arn -> (строка)

Уникальный ARN резервации, например, ‘arn:aws:medialive:us-west-2:123456789012:reservation:1234567’

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

Количество зарезервированных ресурсов

CurrencyCode -> (строка)

Код валюты для использованияPrice и fixedPrice в формате ISO-4217, например, ‘USD’

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

Срок аренды, например, ‘12’

DurationUnits -> (строка)

Единицы для срока, например, ‘MONTHS’

End -> (строка)

Конечная дата и время UTC резервации в формате ISO-8601, например, ‘2019-03-01T00:00:00’

FixedPrice -> (вещественное число)

Одноразовая плата за каждый зарезервированный ресурс, например, ‘0.0’ для предложения NO_UPFRONT

Name -> (строка)

Указанное пользователем имя резервации

OfferingDescription -> (строка)

Описание предложения, например, ‘HD AVC выход с 10-20 Мбит/с, 30 кадр/с и стандартным VQ в US West (Орегон)’

OfferingId -> (строка)

Уникальный идентификатор предложения, например, ‘87654321’

OfferingType -> (строка)

Тип предложения, например, ‘NO_UPFRONT’

Region -> (строка)

AWS регион, например, ‘us-west-2’

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

Настройки продления для резервации

AutomaticRenewal -> (строка)

Статус автоматического продления для резервации

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

Количество продлений для резервации

ReservationId -> (строка)

Уникальный идентификатор резервации, например, ‘1234567’

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

Подробности конфигурации ресурса

ChannelClass -> (строка)

Класс канала, например, ‘STANDARD’

Codec -> (строка)

Кодек, например, ‘AVC’

MaximumBitrate -> (строка)

Максимальный битрейт, например, ‘MAX_20_MBPS’

MaximumFramerate -> (строка)

Максимальная частота кадров, например, ‘MAX_30_FPS’ (Только для вывода)

Resolution -> (строка)

Разрешение, например, ‘HD’

ResourceType -> (строка)

Тип ресурса, ‘INPUT’, ‘OUTPUT’, ‘MULTIPLEX’ или ‘CHANNEL’

SpecialFeature -> (строка)

Специальная функция, например, ‘AUDIO_NORMALIZATION’ (Только для каналов)

VideoQuality -> (строка)

Качество видео, например, ‘STANDARD’ (Только для вывода)

Start -> (строка)

Дата и время начала UTC резервации в формате ISO-8601, например, ‘2018-03-01T00:00:00’

State -> (строка)

Текущее состояние резервации, например, ‘ACTIVE’

Tags -> (массив)

Коллекция пар «ключ-значение»

key -> (строка)

Документация по заполнению для __строки

value -> (строка)

Документация по заполнению для __строки

UsagePrice -> (вещественное число)

Повторяющаяся плата за использование для каждого зарезервированного ресурса, например, ‘157.0’

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

Spec-Zone.ru

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