Spec-Zone.ru › AWS CLI v2

[ aws . ivs-realtime ]

обновление-настройки-ввода

Описание

Обновляет указанную конфигурацию ввода (IngestConfiguration). Можно обновить только ARN стадии (stage), привязанной к конфигурации ввода. Нельзя обновлять активную конфигурацию ввода.

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

Синтаксис

  update-ingest-configuration
--arn <value>
[--stage-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 конфигурации ввода (IngestConfiguration), для которой необходимо обновить связанный ARN стадии.

--stage-arn (строка)

ARN стадии, которую нужно обновить.

--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 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.

Для обновления конфигурации ввода

Следующий update-inegst-configuration пример обновляет конфигурацию ввода, чтобы привязать ее к стадии.

aws ivs-realtime update-ingest-configuration \
    --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

Вывод:

{
    "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": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "participantId": "xyZ654abC321",
        "state": "INACTIVE",
        "userId": "",
        "tags": {}
    }
}

Для получения дополнительной информации см. IVS Stream Ingest | Real-Time Streaming в Руководстве пользователя Amazon Interactive Video Service.

Вывод

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

Обновленная конфигурация ввода.

name -> (строка)

Название ввода

arn -> (строка)

ARN конфигурации ввода.

ingestProtocol -> (строка)

Тип протокола ввода, используемый пользователем для трансляции.

streamKey -> (строка)

Ключ ввода для протокола RTMP(S).

stageArn -> (строка)

ARN стадии, с которой связана конфигурация ввода.

participantId -> (строка)

ID участника на стадии.

state -> (строка)

Состояние конфигурации ввода. Оно равно ACTIVE, если издатель в настоящее время публикует на стадии, связанной с конфигурацией ввода.

userId -> (строка)

Назначаемое клиентом имя для идентификации участника, использующего конфигурацию ввода; его можно использовать для связи участника с пользователем в собственных системах клиента. Это может быть любой текст UTF-8. Это поле доступно всем участникам стадии и не должно использоваться для идентификации лично, конфиденциальной или чувствительной информации.

attributes -> (массив)

Атрибуты, предоставленные приложением, для хранения в конфигурации ввода и привязки к стадии. Ключи и значения карты могут содержать текст UTF-8. Максимальная длина этого поля составляет 1 КБ в целом. Это поле доступно всем участникам стадии и не должно использоваться для идентификации лично, конфиденциальной или чувствительной информации.

key -> (строка)

value -> (строка)

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