Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-meetings ]

create-meeting-with-attendees

Описание

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

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

Синтаксис

  create-meeting-with-attendees
[--client-request-token <value>]
--media-region <value>
[--meeting-host-id <value>]
--external-meeting-id <value>
[--meeting-features <value>]
[--notifications-configuration <value>]
--attendees <value>
[--primary-meeting-id <value>]
[--tenant-ids <value>]
[--tags <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]

Параметры

--client-request-token (строка)

Уникальный идентификатор для запроса клиента. Используйте разные токены для разных встреч.

--media-region (строка)

Регион, в котором нужно создать встречу.

Доступные значения: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

Доступные значения в регионах Amazon Web Services GovCloud (US): us-gov-east-1 , us-gov-west-1 .

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

Зарезервировано.

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

Внешний идентификатор встречи.

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

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

--meeting-features (структура)

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

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

Настройки конфигурации функций аудио, доступных для встречи.

EchoReduction -> (строка)

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

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

Настройки конфигурации функций видео, доступных для встречи.

MaxResolution -> (строка)

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

Примечание

По умолчанию HD . Чтобы использовать FHD , вы также должны указать значение MeetingFeatures:Attendee:MaxCount и переопределить стандартное ограничение размера в 250 участников.

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

Настройки конфигурации функций контента, доступных для встречи.

MaxResolution -> (строка)

Максимальное разрешение для контента встречи.

Примечание

По умолчанию FHD . Чтобы использовать UHD , вы также должны указать значение MeetingFeatures:Attendee:MaxCount и переопределить стандартное ограничение размера в 250 участников.

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

Настройки конфигурации функций участников, доступных для встречи.

MaxCount -> (целое число)

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

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

Audio={EchoReduction=string},Video={MaxResolution=string},Content={MaxResolution=string},Attendee={MaxCount=integer}

Синтаксис JSON:

{
  "Audio": {
    "EchoReduction": "AVAILABLE"|"UNAVAILABLE"
  },
  "Video": {
    "MaxResolution": "None"|"HD"|"FHD"
  },
  "Content": {
    "MaxResolution": "None"|"FHD"|"UHD"
  },
  "Attendee": {
    "MaxCount": integer
  }
}

--notifications-configuration (структура)

Настройка целевых ресурсов для получения уведомлений при возникновении событий встречи и участников.

LambdaFunctionArn -> (строка)

ARN функции Amazon Web Services Lambda в конфигурации уведомлений.

SnsTopicArn -> (строка)

ARN темы SNS.

SqsQueueArn -> (строка)

ARN очереди SQS.

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

LambdaFunctionArn=string,SnsTopicArn=string,SqsQueueArn=string

Синтаксис JSON:

{
  "LambdaFunctionArn": "string",
  "SnsTopicArn": "string",
  "SqsQueueArn": "string"
}

--attendees (список)

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

(структура)

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

ExternalUserId -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

При указании дублирует медиа из основной встречи в новую встречу.

--tenant-ids (список)

Постоянный и неявный идентификатор, созданный и поддерживаемый разработчиком для представления части своих пользователей.

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

Теги в запросе.

(структура)

Пара ключ-значение, заданные вами.

Ключ -> (строка)

Ключ тега.

Значение -> (строка)

Значение тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование конкретного профиля из вашего файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

Вывод

Встреча -> (структура)

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

MeetingId -> (строка)

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

MeetingHostId -> (строка)

Зарезервировано.

ExternalMeetingId -> (строка)

Внешний идентификатор встречи.

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

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

MediaRegion -> (строка)

Регион, в котором вы создаете встречу. Доступные значения: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

Доступные значения в регионах Amazon Web Services GovCloud (US): us-gov-east-1, us-gov-west-1.

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

Расположение мультимедиа для встречи.

AudioHostUrl -> (строка)

URL аудиохоста.

AudioFallbackUrl -> (строка)

URL резервного аудио.

SignalingUrl -> (строка)

URL сигнализации.

TurnControlUrl -> (строка)

URL управления поворотом.

Предупреждение

Этот параметр устарел и больше не используется Amazon Chime SDK.

ScreenDataUrl -> (строка)

URL данных экрана.

Предупреждение

Этот параметр устарел и больше не используется Amazon Chime SDK.

ScreenViewingUrl -> (строка)

URL просмотра экрана.

Предупреждение

Этот параметр устарел и больше не используется Amazon Chime SDK.

ScreenSharingUrl -> (строка)

URL совместного использования экрана.

Предупреждение

Этот параметр устарел и больше не используется Amazon Chime SDK.

EventIngestionUrl -> (строка)

URL приема событий.

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

Функции, доступные в рамках встречи, такие как подавление эха.

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

Настройки конфигурации функций аудио, доступных в рамках встречи.

EchoReduction -> (строка)

Обеспечивает доступ к подавлению эха для клиентов, подключенных к встрече.

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

Настройки конфигурации функций видео, доступных в рамках встречи.

MaxResolution -> (строка)

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

Примечание

По умолчанию значение HD. Чтобы использовать FHD, необходимо также указать значение MeetingFeatures:Attendee:MaxCount и переопределить лимит 250 участников по умолчанию.

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

Настройки конфигурации функций контента, доступных в рамках встречи.

MaxResolution -> (строка)

Максимальное разрешение контента для встречи.

Примечание

По умолчанию значение FHD. Чтобы использовать UHD, необходимо также указать значение MeetingFeatures:Attendee:MaxCount и переопределить лимит 250 участников по умолчанию.

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

Настройки конфигурации функций участника, доступных в рамках встречи.

MaxCount -> (целое число)

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

PrimaryMeetingId -> (строка)

При указании дублирует медиаданные из основной встречи в эту встречу.

TenantIds -> (список)

Массив строк.

(строка)

MeetingArn -> (строка)

ARN встречи.

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