Spec-Zone.ru › AWS CLI v2

[ aws . ivs ]

batch-get-channel

Описание

Выполняет GetChannel для нескольких ARNs одновременно.

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

Синтаксис

  batch-get-channel
--arns <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]

Параметры

--arns (список)

Массив ARNs, по одному на канал.

(строка)

Синтаксис:

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

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

Следующий batch-get-channel пример выводит информацию о заданных каналах.

aws ivs batch-get-channel \
    --arns arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
        arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl

Вывод:

{
    "channels": [
        {
            "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",
            "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-1.abcdEFGH.m3u8",
            "preset": "",
            "playbackRestrictionPolicyArn": "",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
            "srt": {
                "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
                "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
            },
            "tags": {},
            "type": "STANDARD"
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
            "authorized": false,
            "containerFormat": "FRAGMENTED_MP4",
            "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
            "insecureIngest": false,
            "latencyMode": "LOW",
            "multitrackInputConfiguration": {
                "enabled": true,
                "maximumResolution": "FULL_HD",
                "policy": "ALLOW"
            },
            "name": "channel-2",
            "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-2.abcdEFGH.m3u8",
            "preset": "",
            "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"",
            "recordingConfigurationArn": "",
            "srt": {
                "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
                "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
            },
            "tags": {},
            "type": "STANDARD"
        }
    ]
}

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

Вывод

каналы -> (список)

(структура)

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

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. Для получения подробной информации см. Типы каналов.

errors -> (список)

Каждый объект ошибки связан с конкретным ARN в запросе.

(структура)

Ошибка, связанная с конкретным каналом, определенным его ARN.

arn -> (строка)

ARN IVS-ресурса; например, канала.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке, определенное приложением.

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

Spec-Zone.ru

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