Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-messaging ]

put-channel-membership-preferences

Описание

Устанавливает параметры членства в канале для AppInstanceUser или AppInstanceBot, указанного канала. Пользователь или бот должен быть участником канала. Лишь пользователь или бот, владеющий членством, могут установить параметры. Пользователи или боты с ролями AppInstanceAdmin и модератора канала не могут устанавливать параметры для других пользователей. Заблокированные пользователи или боты не могут устанавливать параметры членства для канала, из которого они заблокированы.

Примечание

Заголовок запроса x-amz-chime-bearer обязателен. Используйте ARN AppInstanceUser или AppInstanceBot, выполняющего API-вызов, в качестве значения в заголовке.

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

Синтаксис

  put-channel-membership-preferences
--channel-arn <value>
--member-arn <value>
--chime-bearer <value>
--preferences <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 канала.

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

ARN участника, устанавливающего параметры.

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

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

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

Параметры членства в канале для AppInstanceUser.

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

Настройка уведомлений push для сообщения.

AllowNotifications -> (строка)

Значение перечисления, указывающее, какие уведомления push отправлять запрошенному участнику канала. ALL отправляет все уведомления push, NONE не отправляет никаких уведомлений push, FILTERED отправляет только отфильтрованные уведомления push.

FilterRule -> (строка)

Простой JSON-объект, используемый для отправки подмножества уведомлений push запрошенному участнику.

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

PushNotifications={AllowNotifications=string,FilterRule=string}

Синтаксис JSON:

{
  "PushNotifications": {
    "AllowNotifications": "ALL"|"NONE"|"FILTERED",
    "FilterRule": "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
  • таблица
  • 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.

Вывод

ChannelArn -> (строка)

ARN канала.

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

Подробности пользователя.

Arn -> (строка)

ARN в идентификаторе.

Name -> (строка)

Имя в идентификаторе.

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

ARN и метаданные добавляемого участника.

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

Настройка уведомлений push для сообщения.

AllowNotifications -> (строка)

Значение перечисления, указывающее, какие уведомления push отправлять запрошенному участнику канала. ALL отправляет все уведомления push, NONE не отправляет никаких уведомлений push, FILTERED отправляет только отфильтрованные уведомления push.

FilterRule -> (строка)

Простой JSON-объект, используемый для отправки подмножества уведомлений push запрошенному участнику.

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

Spec-Zone.ru

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