Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-meetings ]

batch-create-attendee

Описание

Создаёт до 100 участников для активного собрания Amazon Chime SDK. Для получения дополнительной информации об Amazon Chime SDK см. Использование Amazon Chime SDK в Руководстве разработчика Amazon Chime.

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

Синтаксис

  batch-create-attendee
--meeting-id <value>
--attendees <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 собрания, к которому вы добавляете участников.

--attendees (список)

Информация о участниках, включая их идентификаторы и токены присоединения.

(структура)

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

ExternalUserId -> (строка)

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

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

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

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

Список одного или нескольких свойств.

Audio -> (строка)

Свойство звука, назначенное участнику.

Video -> (строка)

Свойство видео, назначенное участнику.

Content -> (строка)

Свойство контента, назначенное участнику.

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

ExternalUserId=string,Capabilities={Audio=string,Video=string,Content=string} ...

Синтаксис JSON:

[
  {
    "ExternalUserId": "string",
    "Capabilities": {
      "Audio": "SendReceive"|"Send"|"Receive"|"None",
      "Video": "SendReceive"|"Send"|"Receive"|"None",
      "Content": "SendReceive"|"Send"|"Receive"|"None"
    }
  }
  ...
]

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

Вывод

Attendees -> (список)

Информация о участниках, включая их идентификаторы и токены присоединения.

(структура)

Участник собрания 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 -> (строка)

Свойство контента, назначенное участнику.

Errors -> (список)

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

(структура)

Список ошибок, возвращаемый при возникновении ошибок во время действий BatchCreateAttendee и CreateAttendee. Это включает внешние идентификаторы пользователей, коды ошибок и сообщения об ошибках.

ExternalUserId -> (строка)

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

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

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

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

Сообщение об ошибке.

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

Spec-Zone.ru

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