Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-meetings ]

create-meeting

Описание

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

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

Синтаксис

  create-meeting
[--client-request-token <value>]
--media-region <value>
[--meeting-host-id <value>]
--external-meeting-id <value>
[--notifications-configuration <value>]
[--meeting-features <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-gov-east-1 , us-gov-west-1 .

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

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

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

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

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

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

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

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

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

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

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

EchoReduction -> (строка)

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

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

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

MaxResolution -> (строка)

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

Примечание

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

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

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

MaxResolution -> (строка)

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

Примечание

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

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

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

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

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

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

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

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

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

Применяет один или несколько тегов к встрече Amazon Chime SDK. Обратите внимание на следующее:

  • Не все ресурсы имеют теги. Список служб с ресурсами, которые поддерживают тегирование с помощью этой операции, см. в разделе Services that support the Resource Groups Tagging API. Если ресурс ещё не поддерживает эту операцию, служба ресурса может поддерживать тегирование с помощью собственных операций API. Для получения дополнительной информации см. документацию по этой службе.
  • Каждый ресурс может иметь до 50 тегов. Другие ограничения см. в разделе Tag Naming and Usage Conventions в AWS General Reference.
  • Вы можете тегировать только ресурсы, расположенные в указанном регионе Amazon Web Services для учётной записи Amazon Web Services.
  • Для добавления тегов к ресурсу необходимы необходимые разрешения для службы, к которой принадлежит ресурс, а также разрешения на добавление тегов. Дополнительную информацию см. в документации по каждой службе.

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

Не храните в тегах персональную информацию (PII) или другую конфиденциальную или чувствительную информацию. Мы используем теги для предоставления вам услуг выставления счетов и администрирования. Теги не предназначены для использования с конфиденциальными или чувствительными данными.

Минимальные разрешения

В дополнение к разрешению tag:TagResources, необходимому для этой операции, необходимо также иметь разрешение на тегирование, определённое службой, которая создала ресурс. Например, чтобы добавить теги к экземпляру ChimeSDKMeetings, используя операцию TagResources, необходимо иметь оба следующих разрешения:

tag:TagResources

ChimeSDKMeetings:CreateTags

Примечание

Некоторые службы могут иметь особые требования к тегированию некоторых ресурсов. Например, для тегирования ведра Amazon S3 необходимо также иметь разрешение s3:GetBucketTagging. Если ожидаемые минимальные разрешения не работают, см. документацию API тегирования этой службы для получения дополнительной информации.

(структура)

Пара ключ-значение, которую вы определяете.

Key -> (строка)

Ключ тега.

Value -> (строка)

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

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

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 заседания.

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

Spec-Zone.ru

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