Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-meetings ]

Добавить участника

Описание

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

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

Синтаксис

  create-attendee
--meeting-id <value>
--external-user-id <value>
[--capabilities <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 (строка)

Уникальный идентификатор совещания.

--external-user-id (строка)

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

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

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

--capabilities (структура)

Возможности (audio , video или content ), которые вы хотите предоставить участнику. Если вы не укажете возможности, все пользователи по умолчанию будут иметь возможности отправки и получения на всех каналах мультимедиа.

Примечание

Вы используете возможности с набором значений, определяющих, что эти возможности могут делать, например, 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=string,Video=string,Content=string

Синтаксис JSON:

{
  "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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, который отображается в двоичном блоке, 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.

Вывод

Участник -> (структура)

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

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.

Аудио -> (строка)

Возможность аудио, назначенная участнику.

Видео -> (строка)

Возможность видео, назначенная участнику.

Контент -> (строка)

Возможность контента, назначенная участнику.

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

Spec-Zone.ru

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