Spec-Zone.ru › AWS CLI v2

[ aws . ivs-realtime ]

получение-конфигурации-кодера

Описание

Получает информацию о заданном ресурсе EncoderConfiguration.

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

Синтаксис

  get-encoder-configuration
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--arn (строка)

ARN ресурса EncoderConfiguration.

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

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Примеры

Примечание

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

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

Для получения конфигурации кодера композиции

Следующий get-encoder-configuration пример получает конфигурацию кодера композиции, указанную заданным ARN (именем ресурса Amazon).

aws ivs-realtime get-encoder-configuration \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh"

Вывод:

{
    "encoderConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
        "name": "test-ec",
        "tags": {},
        "video": {
            "bitrate": 3500000,
            "framerate": 30,
            "height": 1080,
            "width": 1920
        }
    }
}

Дополнительную информацию см. в разделе Включение нескольких хостов в потоке Amazon IVS в Руководстве пользователя Amazon Interactive Video Service.

Вывод

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

Возвращенная конфигурация EncoderConfiguration.

arn -> (строка)

ARN ресурса EncoderConfiguration.

name -> (строка)

Необязательное имя для идентификации ресурса.

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

Конфигурация видео. Значение по умолчанию: разрешение видео 1280x720, битрейт 2500 кбит/с, 30 кадров/с

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

Ширина разрешения видео. Это должно быть четное число. Обратите внимание, что максимальное значение определяется width раз height, так что максимальное общее количество пикселей составляет 2073600 (1920x1080 или 1080x1920). Значение по умолчанию: 1280.

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

Высота разрешения видео. Это должно быть четное число. Обратите внимание, что максимальное значение определяется width раз height, так что максимальное общее количество пикселей составляет 2073600 (1920x1080 или 1080x1920). Значение по умолчанию: 720.

framerate -> (число с плавающей точкой)

Частота кадров видео в кадрах/с. Значение по умолчанию: 30.

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

Битрейт генерируемого вывода в битах/с. Значение по умолчанию: 2500000.

tags -> (карта)

Теги, прикрепленные к ресурсу. Массив карт, каждая из которых имеет вид string:string (key:value). Подробности, включая ограничения, которые применяются к тегам, и «Пределы и требования к именованию тегов», см. в разделе «Рекомендации и стратегии по маркировке ресурсов AWS» и «Редактор тегов»; Amazon IVS не имеет ограничений на теги, кроме тех, которые документированы там.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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