Spec-Zone.ru › AWS CLI v2

[ aws . ivs ]

get-channel

Описание

Получает конфигурацию канала для указанного ARN канала. См. также BatchGetChannel.

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

Синтаксис

  get-channel
--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 канала, для которого требуется получить конфигурацию.

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

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

Для получения информации о конфигурации канала

В следующем get-channel примере получается конфигурация канала для указанного ARN канала (имени ресурса Amazon).

aws ivs get-channel \
    --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh'

Вывод:

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

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

Вывод

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

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 -> (строка)

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

passphrase -> (строка)

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

tags -> (массив)

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

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

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

type -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API