[ aws . ivs-realtime ]
create-ingest-configuration
Описание
Создаёт новый ресурс IngestConfiguration, используемый для указания протокола приема для этапа.
См. также: Документацию API AWS
Синтаксис
create-ingest-configuration
[--name <value>]
[--stage-arn <value>]
[--user-id <value>]
[--attributes <value>]
--ingest-protocol <value>
[--insecure-ingest | --no-insecure-ingest]
[--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 (строка)
--stage-arn (строка)
--user-id (строка)
--attributes (массив)
Атрибуты, предоставленные приложением, для хранения в IngestConfiguration и привязки к этапу. Ключи и значения массива могут содержать текст в кодировке UTF-8. Максимальная длина этого поля составляет 1 КБ в общей сложности. Это поле доступно всем участникам этапа и не должно использоваться для идентификации личности, конфиденциальной или чувствительной информации.
ключ -> (строка)
значение -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--ingest-protocol (строка)
Тип протокола приема, который пользователь использует для трансляции. Если это установлено в RTMP , insecureIngest должно быть установлено в true .
Возможные значения:
RTMPRTMPS
--insecure-ingest | --no-insecure-ingest (логическое)
true , если ingestProtocol установлено в RTMP . По умолчанию: false .--tags (массив)
Теги, прикрепленные к ресурсу. Массив карт, каждая из которых имеет вид string:string (key:value) . Подробнее см. в разделе «Рекомендации и стратегии по тегированию ресурсов AWS и редактору тегов», включая ограничения, которые применяются к тегам и «Пределы и требования к именованию тегов»; Amazon IVS не накладывает никаких ограничений на теги помимо описанных там.
ключ -> (строка)
значение -> (строка)
Сокращённый синтаксис:
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
- текст
- таблица
- 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 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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры нужно будет адаптировать к правилам цитирования вашего терминала. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.
Для создания конфигурации приема
Следующий create-ingest-configuration пример создает конфигурацию приема, используя протокол RTMPS.
aws ivs-realtime create-ingest-configuration \
--name ingest1 \
--ingest-protocol rtmps
Вывод:
{
"ingestConfiguration": {
"name": "ingest1",
"arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
"ingestProtocol": "RTMPS",
"streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
"stageArn": "",
"participantId": "xyZ654abC321",
"state": "INACTIVE",
"userId": "",
"tags": {}
}
}
Для получения дополнительной информации см. IVS Stream Ingest | Потоковая передача в режиме реального времени в Руководстве пользователя Amazon Interactive Video Service.
Вывод
ingestConfiguration -> (структура)
Созданный IngestConfiguration.
name -> (строка)
arn -> (строка)
ingestProtocol -> (строка)
streamKey -> (строка)
stageArn -> (строка)
participantId -> (строка)
state -> (строка)
ACTIVE, если издатель в настоящее время публикует на этапе, связанном с конфигурацией приема.userId -> (строка)
attributes -> (массив)
Атрибуты, предоставленные приложением, для хранения в IngestConfiguration и привязки к этапу. Ключи и значения массива могут содержать текст в кодировке UTF-8. Максимальная длина этого поля составляет 1 КБ в общей сложности. Это поле доступно всем участникам этапа и не должно использоваться для идентификации личности, конфиденциальной или чувствительной информации.
ключ -> (строка)
значение -> (строка)
tags -> (массив)
Теги, прикрепленные к ресурсу. Массив карт, каждая из которых имеет вид string:string (key:value) . Подробнее см. в разделе «Рекомендации и стратегии по тегированию ресурсов AWS и редактору тегов», включая ограничения, которые применяются к тегам и «Пределы и требования к именованию тегов»; Amazon IVS не накладывает никаких ограничений на теги помимо описанных там.
ключ -> (строка)
значение -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|