Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-messaging ]

получение-предпочтений-членства-в-канале

Описание

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

Примечание

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

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

Синтаксис

  get-channel-membership-preferences
--channel-arn <value>
--member-arn <value>
--chime-bearer <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 (строка)

AppInstanceUserArn члена, получающего предпочтения.

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

ARN AppInstanceUser или AppInstanceBot, совершающего вызов API.

--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-auto-prompt (булево)

Автоматическое запрограммирование параметров входных данных CLI.

--no-cli-auto-prompt (булево)

Отключение автоматического запрограммирования параметров входных данных CLI.

Вывод

ChannelArn -> (строка)

ARN канала.

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

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

Arn -> (строка)

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

Name -> (строка)

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

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

Предпочтения членства в канале для AppInstanceUser.

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