Spec-Zone.ru › AWS CLI v2

[ aws . ivs-realtime ]

list-participant-events

Описание

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

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

Синтаксис

  list-participant-events
--stage-arn <value>
--session-id <value>
--participant-id <value>
[--next-token <value>]
[--max-results <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]

Параметры

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

ARN стадии.

--session-id (строка)

Идентификатор сессии на стадии.

--participant-id (строка)

Уникальный идентификатор этого участника. Назначается IVS и возвращается функцией CreateParticipantToken.

--next-token (строка)

Первое событие участника для извлечения. Используется для пагинации; см. поле ответа nextToken.

--max-results (целое число)

Максимальное количество результатов для возврата. По умолчанию: 50.

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

Для получения списка событий участника стадии

Следующий пример list-participant-events показывает список всех событий участника для указанного идентификатора участника и идентификатора сессии указанного ARN стадии (имя ресурса Amazon).

aws ivs-realtime list-participant-events \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g \
    --participant-id abCDEf12GHIj

Вывод:

{
    "events": [
        {
            "eventTime": "2023-04-26T20:36:28+00:00",
            "name": "LEFT",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:36:28+00:00",
            "name": "PUBLISH_STOPPED",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:30:34+00:00",
            "name": "JOINED",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:30:34+00:00",
            "name": "PUBLISH_STARTED",
            "participantId": "abCDEf12GHIj"
        }
    ]
}

Для получения дополнительной информации, ознакомьтесь с разделами «Включение нескольких хостов в потоке Amazon IVS» в Руководстве пользователя Amazon Interactive Video Service.

Вывод

events -> (список)

Список соответствующих событий.

(структура)

Происшествие во время сессии стадии.

name -> (строка)

Название события.

participantId -> (строка)

Уникальный идентификатор участника, который вызвал событие. Назначается IVS.

eventTime -> (временная метка)

Маркер времени ISO 8601 (возвращается как строка) момента возникновения события.

remoteParticipantId -> (строка)

Уникальный идентификатор удаленного участника. Для события subscribe, это издатель. Для событий publish или join, это null. Назначается IVS.

errorCode -> (строка)

Если событие — это событие ошибки, код ошибки предоставляется для получения информации о конкретной ошибке, которая произошла. Если событие не является событием ошибки, это поле равно null.

  • B_FRAME_PRESENT — Поток участника содержит B-кадры. Подробнее см. IVS RTMP Publishing.
  • BITRATE_EXCEEDED — Участник превысил максимальную поддерживаемую скорость передачи данных. Подробнее см. Квоты сервиса.
  • INSUFFICIENT_CAPABILITIES — Участник пытался выполнить действие, которое не разрешено токены участника. Подробнее о возможностях участников см. поле capabilities в CreateParticipantToken.
  • INTERNAL_SERVER_EXCEPTION — Участник не смог опубликовать поток на стадию из-за внутренней ошибки сервера.
  • INVALID_AUDIO_CODEC — Участник использует недопустимый аудиокодек. Подробнее см. Stream Ingest.
  • INVALID_INPUT — Участник использует недопустимый входной поток.
  • INVALID_PROTOCOL — Ресурс IngestConfiguration участника настроен на RTMPS, но они пытались транслировать с помощью RTMP. Подробнее см. IVS RTMP Publishing.
  • INVALID_STREAM_KEY — Участник использует недопустимый ключ потока. Подробнее см. IVS RTMP Publishing.
  • INVALID_VIDEO_CODEC — Участник использует недопустимый кодек видео. Подробнее см. Stream Ingest.
  • PUBLISHER_NOT_FOUND — Участник попытался подписаться на издателя, которого не существует.
  • QUOTA_EXCEEDED — Количество участников, которые хотят опубликовать/подписаться на стадию, превысило квоту. Подробнее см. Квоты сервиса.
  • RESOLUTION_EXCEEDED — Участник превысил максимальное разрешение. Подробнее см. Квоты сервиса.
  • REUSE_OF_STREAM_KEY — Участник попытался использовать ключ потока, связанный с другой активной сессией стадии.
  • STREAM_DURATION_EXCEEDED — Участник превысил максимальную длительность потока. Подробнее см. Квоты сервиса.

nextToken -> (строка)

Если событий больше, чем maxResults , используйте nextToken в запросе, чтобы получить следующий набор.

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

Spec-Zone.ru

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