create-channel

Описание

Создаёт новый канал и связанный ключ потока для начала потоковой передачи.

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

Синтаксис

  create-channel
[--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>]
[--tags <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]

Параметры

--authorized | --no-authorized (boolean)

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

--container-format (string)

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

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

TS
FRAGMENTED_MP4

--insecure-ingest | --no-insecure-ingest (boolean)

Разрешение канала для ненадёжной передачи RTMP и SRT. По умолчанию: false .

--latency-mode (string)

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

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

NORMAL
LOW

--multitrack-input-configuration (structure)

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

enabled -> (boolean)

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

maximumResolution -> (string)

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

policy -> (string)

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

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

enabled=boolean,maximumResolution=string,policy=string

Синтаксис JSON:

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

--name (string)

Имя канала.

--playback-restriction-policy-arn (string)

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

--preset (string)

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

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

HIGHER_BANDWIDTH_DELIVERY
CONSTRAINED_BANDWIDTH_DELIVERY

--recording-configuration-arn (string)

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

--tags (map)

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

key -> (string)

value -> (string)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--type (string)

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

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

BASIC
STANDARD
ADVANCED_SD
ADVANCED_HD

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

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, проверяются входные данные команд и возвращается пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладочную регистрацию.

--endpoint-url (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-службами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команд.

json
text
таблица
yaml
yaml-поток

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

вкл
выкл
авто

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с набором сертификатов CA для проверки сертификатов SSL. Перезаписывает настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пагинацию cli для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

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

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

Пример 1: Создание канала без записи

Следующий пример создаёт новый канал и связанный ключ потока для начала потоковой передачи.

aws ivs create-channel \
    --name 'test-channel' \
    --no-insecure-ingest

Вывод:

{
    "channel": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "authorized": false,
        "containerFormat": "TS",
        "name": "test-channel",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": false,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "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": "",
        "tags": {},
        "type": "STANDARD"
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

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

Пример 2: Создание канала с включённой записью, используя ресурс RecordingConfiguration, указанный по его ARN

Следующий пример создаёт новый канал и связанный ключ потока для начала потоковой передачи и настраивает запись для канала:

aws ivs create-channel \
    --name test-channel-with-recording \
    --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",
        "containerFormat": "TS",
        "name": "test-channel-with-recording",
        "latencyMode": "LOW",
        "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": 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": {},
        "type": "STANDARD"
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

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

Пример 3: Создание канала с политикой ограничения воспроизведения, указанной по её ARN

Следующий пример создаёт новый канал и связанный ключ потока для начала потоковой передачи и настраивает политику ограничения воспроизведения для канала:

aws ivs create-channel \
    --name test-channel-with-playback-restriction-policy\
    --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",
        "containerFormat": "TS",
        "name": "test-channel-with-playback-restriction-policy",
        "latencyMode": "LOW",
        "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": "AB1C2edfGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
        },
        "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": {},
        "type": "STANDARD"
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

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

Пример 4: Создание канала с включённой многоканальной передачей

Следующий пример создаёт новый канал и связанный ключ потока для начала потоковой передачи и включает многоканальную передачу.

aws ivs create-channel \
    --name 'test-channel' \
    --no-insecure-ingest \
    --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",
        "authorized": false,
        "containerFormat": "FRAGMENTED_MP4",
        "name": "test-channel",
        "latencyMode": "LOW",
        "multitrackInputConfiguration": {
            "enabled": true,
            "maximumResolution": "FULL_HD",
            "policy": "ALLOW"
        },
        "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": "",
        "tags": {},
        "type": "STANDARD"
    },
    "streamKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
        "value": "sk_us-west-2_abcdABCDefgh_567890abcdef",
        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
        "tags": {}
    }
}

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

Вывод

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

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

ключ -> (строка)

значение -> (строка)

type -> (строка)

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

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

arn -> (строка)

ARN ключа потока.

channelArn -> (строка)

ARN канала для потока.

tags -> (массив)

ключ -> (строка)

значение -> (строка)

Значение ключа потока.

END_OF_DOCUMENT_MARKER