Spec-Zone.ru › AWS CLI v2

[ aws . ivs-realtime ]

создание конфигурации кодера

Описание

Создаёт объект EncoderConfiguration.

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

Синтаксис

  create-encoder-configuration
[--name <value>]
[--video <value>]
[--tags <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]

Параметры

--name (строка)

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

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

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

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

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

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

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

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

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

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

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

Сокращённый синтаксис:

width=integer,height=integer,framerate=float,bitrate=integer

Синтаксис JSON:

{
  "width": integer,
  "height": integer,
  "framerate": float,
  "bitrate": integer
}

--tags (массив)

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

key -> (строка)

value -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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
  • text
  • таблица
  • 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.

Создание конфигурации кодера композиции

Следующий create-encoder-configuration пример создаёт конфигурацию кодера композиции со специфицированными свойствами.

aws ivs-realtime create-encoder-configuration \
    --name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920

Вывод:

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

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

Вывод

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