обновить-канал

Описание

Обновляет конфигурацию канала. Живые каналы не могут быть обновлены. Необходимо остановить текущий поток, обновить канал и перезапустить поток, чтобы изменения вступили в силу.

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

Синтаксис

  update-channel
--arn <value>
[--authorized | --no-authorized]
[--container-format <value>]
[--insecure-ingest | --no-insecure-ingest]
[--latency-mode <value>]
[--multitrack-input-configuration <value>]
[--name <value>]
[--playback-restriction-policy-arn <value>]
[--preset <value>]
[--recording-configuration-arn <value>]
[--type <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 канала, который необходимо обновить.

--authorized | --no-authorized (логическое значение)

Является ли канал частным (разрешен ли доступ к воспроизведению)?

--container-format (строка)

Указывает, какой формат упаковки содержимого используется (MPEG-TS или fMP4). Если multitrackInputConfiguration указан и enabled равен true , то containerFormat требуется и должен быть установлен на FRAGMENTED_MP4 . В противном случае, containerFormat может быть установлен на TS или FRAGMENTED_MP4 . По умолчанию: TS .

Возможные значения:

TS
FRAGMENTED_MP4

--insecure-ingest | --no-insecure-ingest (логическое значение)

Разрешает ли канал небезопасный RTMP и SRT ввод. По умолчанию: false .

--latency-mode (строка)

Режим задержки канала. Используйте NORMAL для трансляции и доставки видео в прямом эфире до Full HD. Используйте LOW для взаимодействия в режиме реального времени с зрителями.

Возможные значения:

NORMAL
LOW

--multitrack-input-configuration (структура)

Объект, определяющий конфигурацию входных данных мультитрека. По умолчанию: конфигурация входных данных мультитрека не указана.

enabled -> (логическое значение)

Указывает, включен ли мультитрековый вход. Может быть установлен на true только в том случае, если тип канала STANDARD . Установка enabled на true с любым другим типом канала приведет к возникновению исключения. Если true , то policy , maximumResolution и containerFormat обязательны, а containerFormat должен быть установлен на FRAGMENTED_MP4 . По умолчанию: false .

maximumResolution -> (строка)

Максимальное разрешение для входных данных мультитрека. Требуется, если enabled равен true .

policy -> (строка)

Указывает, разрешен или необходим ли мультитрековый вход. Требуется, если enabled равен true .

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

enabled=boolean,maximumResolution=string,policy=string

Синтаксис JSON:

{
  "enabled": true|false,
  "maximumResolution": "SD"|"HD"|"FULL_HD",
  "policy": "ALLOW"|"REQUIRE"
}

--name (строка)

Имя канала.

--playback-restriction-policy-arn (строка)

ARN политики ограничения воспроизведения. Действительное значение ARN здесь указывает как ARN, так и разрешает ограничение воспроизведения. Если это значение установлено на пустую строку, политика ограничения воспроизведения отключена.

--preset (строка)

Необязательная предварительно настроенная транскодировка для канала. Это выбирается только для каналов типов ADVANCED_HD и ADVANCED_SD . Для этих типов каналов значение по умолчанию preset равно HIGHER_BANDWIDTH_DELIVERY . Для других типов каналов (BASIC и STANDARD ), preset это пустая строка ("" ).

Возможные значения:

HIGHER_BANDWIDTH_DELIVERY
CONSTRAINED_BANDWIDTH_DELIVERY

--recording-configuration-arn (строка)

ARN конфигурации записи. Действительное значение ARN здесь указывает как ARN, так и разрешает запись. Если это значение установлено на пустую строку, запись отключена.

--type (строка)

Тип канала, который определяет допустимое разрешение и битрейт. Если вы превысите допустимое разрешение или битрейт входных данных, поток, вероятно, прервется сразу же. По умолчанию: STANDARD . Подробнее см. в разделе Типы каналов.

Возможные значения:

BASIC
STANDARD
ADVANCED_SD
ADVANCED_HD

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

Пример 1: Обновление конфигурации канала

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

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --name 'channel-1' \
    --insecure-ingest

Вывод:

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "channel-1",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": true,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
}

Для получения дополнительной информации, см. Создание канала в руководстве пользователя IVS Low-Latency.

Пример 2: Обновление конфигурации канала для включения записи

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

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --no-insecure-ingest \
    --recording-configuration-arn 'arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh'

Вывод:

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel-with-recording",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Для получения дополнительной информации, см. Запись в Amazon S3 в руководстве пользователя IVS Low-Latency.

Пример 3: Обновление конфигурации канала для отключения записи

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

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --recording-configuration-arn ''

Вывод:

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel-with-recording",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2edfGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Для получения дополнительной информации, см. Запись в Amazon S3 в руководстве пользователя IVS Low-Latency.

Пример 4: Обновление конфигурации канала для включения ограничений на воспроизведение

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

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --no-insecure-ingest \
    --playback-restriction-policy-arn 'arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ'

Вывод:

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel-with-playback-restriction-policy",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Для получения дополнительной информации, см. Нежелательное содержимое и зрители в руководстве пользователя IVS Low-Latency.

Пример 5: Обновление конфигурации канала для отключения ограничений на воспроизведение

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

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --playback-restriction-policy-arn ''

Вывод:

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "name": "test-channel-with-playback-restriction-policy",
        "latencyMode": "LOW",
        "containerFormat": "TS",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDeFghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Пример 6: Обновление конфигурации канала для включения режима многодорожек

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

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --container-format 'FRAGMENTED_MP4' \
    --multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}'

Вывод:

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "containerFormat": "FRAGMENTED_MP4",
        "name": "test-channel-with-multitrack",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": true,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Пример 7: Обновление конфигурации канала для отключения режима многодорожек

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

aws ivs update-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
    --container-format 'TS' \
    --multitrack-input-configuration '{"enabled": false}'

Вывод:

{
    "channel": {
        ""arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "containerFormat": "TS",
        "name": "test-channel-with-multitrack",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "type": "STANDARD",
        "playbackRestrictionPolicyArn": "",
        "recordingConfigurationArn": "",
        "srt": {
            "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
            "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaCBDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
        "insecureIngest": false,
        "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8",
        "preset": "",
        "authorized": false,
        "tags": {}
    }
}

Вывод

канал -> (структура)

Объект, определяющий обновленный канал.

arn -> (строка)

ARN канала.

authorized -> (булево)

Приватность канала (включена авторизация воспроизведения). По умолчанию: false.

containerFormat -> (строка)

Указывает формат упаковки содержимого (MPEG-TS или fMP4). Если multitrackInputConfiguration указано и enabled равно true, то containerFormat обязательно и должно быть установлено в FRAGMENTED_MP4. В противном случае, containerFormat может быть установлено в TS или FRAGMENTED_MP4. По умолчанию: TS.

ingestEndpoint -> (строка)

Точка входа канала, часть определения сервера приема, используемая при настройке потокового программного обеспечения.

insecureIngest -> (булево)

Разрешает ли канал небезопасный RTMP вход. По умолчанию: false.

latencyMode -> (строка)

Режим задержки канала. Используйте NORMAL для трансляции и доставки видео в прямом эфире до Full HD. Используйте LOW для взаимодействия с зрителями в режиме близкой к реальному времени. По умолчанию: LOW.

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

Объект, определяющий конфигурацию многодорожечного входа. По умолчанию: не указана конфигурация многодорожечного входа.

enabled -> (булево)

Указывает, включен ли многодорожечный вход. Может быть установлен в true только если тип канала STANDARD. Установка enabled в true с любым другим типом канала приведет к ошибке. Если true, то policy, maximumResolution и containerFormat обязательны, и containerFormat должно быть установлено в FRAGMENTED_MP4. По умолчанию: false.

maximumResolution -> (строка)

Максимальное разрешение для многодорожечного входа. Необходимо, если enabled равно true.

policy -> (строка)

Указывает, разрешен ли многодорожечный вход или он обязателен. Необходимо, если enabled равно true.

name -> (строка)

Имя канала.

playbackRestrictionPolicyArn -> (строка)

ARN политики ограничений воспроизведения. Действительное значение ARN здесь одновременно определяет ARN и включает ограничения на воспроизведение. По умолчанию: "" (пустая строка, политика ограничений воспроизведения не применяется).

playbackUrl -> (строка)

URL воспроизведения канала.

preset -> (строка)

Необязательный пресет транскодирования для канала. Выбирается только для каналов типа ADVANCED_HD и ADVANCED_SD. Для этих типов каналов по умолчанию preset равно HIGHER_BANDWIDTH_DELIVERY. Для других типов каналов (BASIC и STANDARD), preset равно пустой строке ("").

recordingConfigurationArn -> (строка)

ARN конфигурации записи. Действительное значение ARN здесь одновременно определяет ARN и включает запись. По умолчанию: "" (запись отключена).

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

Указывает конечную точку и необязательный пароль для потоковой передачи с протоколом SRT.

endpoint -> (строка)

Конечная точка, используемая при потоковой передаче с IVS с помощью протокола SRT.

passphrase -> (строка)

Автоматически сгенерированный пароль для включения шифрования. Это поле применимо только если пользователь не включил опцию insecureIngest для канала.

tags -> (карта)

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

key -> (строка)

value -> (строка)

type -> (строка)

Тип канала, который определяет допустимое разрешение и битрейт. Если вы превысите допустимое разрешение или битрейт ввода, поток, вероятно, немедленно прервется. По умолчанию: STANDARD. Подробнее см. Типы каналов.