Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-meetings ]

list-attendees

Описание

Перечисляет участников для указанного собрания Amazon Chime SDK. Дополнительную информацию о Amazon Chime SDK см. в руководстве разработчика Amazon Chime в разделе «Использование Amazon Chime SDK».

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

Синтаксис

  list-attendees
--meeting-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]

Параметры

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

Идентификатор собрания Amazon Chime SDK.

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

Токен для получения следующей страницы результатов.

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

Максимальное количество результатов, возвращаемых за один вызов.

--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 (логическое значение)

Отключить показ результатов на странице AWS CLI.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Участники -> (список)

Информация о участнике Amazon Chime SDK.

(структура)

Участник собрания Amazon Chime SDK. Включает уникальный AttendeeId и JoinToken. JoinToken позволяет клиенту пройти аутентификацию и присоединиться в качестве указанного участника. JoinToken истекает по окончании собрания или при вызове DeleteAttendee. После этого участник не может присоединиться к собранию.

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

ExternalUserId -> (строка)

Внешний идентификатор пользователя Amazon Chime SDK. Маркер идемпотентности. Связывает участника с идентификатором, управляемым приложением-строителем.

Шаблон: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Значения, начинающиеся с aws:, зарезервированы. Вы не можете настроить значение, использующее этот префикс. Регистронезависимо.

AttendeeId -> (строка)

Идентификатор участника Amazon Chime SDK.

JoinToken -> (строка)

Токен присоединения, используемый участником Amazon Chime SDK.

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

Функциональные возможности, назначенные участнику: аудио, видео или контент.

Примечание

Вы используете функциональные возможности со значениями, которые управляют тем, что функциональные возможности могут делать, например, с данными SendReceive. Дополнительную информацию об этих значениях см. в .

При использовании функциональных возможностей обратите внимание на эти частные случаи:

  • Если вы указали MeetingFeatures:Video:MaxResolution:None при создании собрания, все API-запросы, содержащие SendReceive, Send или Receive для AttendeeCapabilities:Video, будут отклоняться с кодом ошибки ValidationError 400.
  • Если вы указали MeetingFeatures:Content:MaxResolution:None при создании собрания, все API-запросы, содержащие SendReceive, Send или Receive для AttendeeCapabilities:Content, будут отклоняться с кодом ошибки ValidationError 400.
  • Вы не можете установить функциональные возможности content в SendReceive или Receive, если вы не установите также функциональные возможности video в SendReceive или Receive. Если вы не установите функциональность video для приема, ответ будет содержать код состояния HTTP 400 Bad Request. Однако вы можете установить функциональность video для приема и установить функциональность content для отказа от приема.
  • При изменении функциональности audio с None или Receive на Send или SendReceive, и если участник оставил микрофон не выключенным, аудиопоток будет поступать от участника к другим участникам собрания.
  • При изменении функциональности video или content с None или Receive на Send или SendReceive, и если участник включил потоки видео или контента, удаленные участники смогут получать эти потоки, но только после переподключения между клиентом и сервером Amazon Chime.

Audio -> (строка)

Функциональность аудио, назначенная участнику.

Video -> (строка)

Функциональность видео, назначенная участнику.

Content -> (строка)

Функциональность контента, назначенная участнику.

NextToken -> (строка)

Токен для получения следующей страницы результатов.

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

Spec-Zone.ru

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