Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-messaging ]

создание_нескольких_участников_канала

Описание

Добавляет заданное количество пользователей и ботов в канал.

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

Синтаксис

  batch-create-channel-membership
--channel-arn <value>
[--type <value>]
--member-arns <value>
--chime-bearer <value>
[--sub-channel-id <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]

Параметры

--channel-arn (строка)

ARN канала, к которому добавляются пользователи или боты.

--type (строка)

Тип членства пользователя, DEFAULT или HIDDEN. По умолчанию члены всегда возвращаются как часть ListChannelMemberships. Скрытые члены возвращаются только если тип фильтра в ListChannelMemberships равен HIDDEN. В противном случае скрытые члены не возвращаются. Это поддерживается только модераторами.

Возможные значения:

  • DEFAULT
  • HIDDEN

--member-arns (список)

ARN участников, которых нужно добавить в канал. Только AppInstanceUsers и AppInstanceBots могут быть добавлены как члены канала.

(строка)

Синтаксис:

"string" "string" ...

--chime-bearer (строка)

ARN AppInstanceUser или AppInstanceBot, выполняющего вызов API.

--sub-channel-id (строка)

Идентификатор подканала в запросе.

Примечание

Требуется только при создании членства в подканале для модератора в эластичном канале.

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

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

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

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

Вывод

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

Список членств в канале в ответе.

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

Идентификатор члена, пригласивший другого члена.

Arn -> (строка)

ARN в идентитете.

Name -> (строка)

Имя в идентитете.

Type -> (строка)

Типы членства, установленные для членов канала.

Members -> (список)

Пользователи, успешно добавленные в запрос.

(структура)

Детали пользователя или бота.

Arn -> (строка)

ARN в идентитете.

Name -> (строка)

Имя в идентитете.

ChannelArn -> (строка)

ARN канала, к которому добавляются члены.

SubChannelId -> (строка)

Идентификатор подканала.

Errors -> (список)

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

(структура)

Список ARN членов, которые не были добавлены, коды ошибок и сообщения об ошибках.

MemberArn -> (строка)

AppInstanceUserArn члена, которого служба не смогла добавить.

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

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

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

Spec-Zone.ru

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