Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-messaging ]

list-channel-memberships-for-app-instance-user

Описание

Отображает все каналы, участником которых является AppInstanceUser или AppInstanceBot. Только AppInstanceAdmin может вызвать API с ARN пользователя, который не является их собственным.

Примечание

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

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

Синтаксис

  list-channel-memberships-for-app-instance-user
[--app-instance-user-arn <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--app-instance-user-arn (строка)

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

--max-results (целое число)

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

--next-token (строка)

Токен, возвращённый предыдущими запросами API, пока не будет достигнуто число членств в канале.

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

Вывод

ChannelMemberships -> (список)

Информация о запрошенных членствах в канале.

(структура)

Резюме данных о членстве в канале AppInstanceUser.

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

Возвращает данные канала для AppInstance.

Name -> (строка)

Имя канала.

ChannelArn -> (строка)

ARN канала.

Mode -> (строка)

Режим канала.

Privacy -> (строка)

Настройка конфиденциальности канала.

Metadata -> (строка)

Метаданные канала.

LastMessageTimestamp -> (метка времени)

Время отправки последнего постоянного сообщения, видимого для вызывающего абонента в канале.

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

Возвращает данные членства в канале для AppInstance.

Type -> (строка)

Тип ChannelMembership.

ReadMarkerTimestamp -> (метка времени)

Время, когда AppInstanceUser в последний раз пометил канал как прочитанный.

SubChannelId -> (строка)

ID подканала, членом которого является AppInstanceUser.

NextToken -> (строка)

Токен, передаваемый предыдущими вызовами API, пока не будут возвращены все запрошенные пользователи.

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

Spec-Zone.ru

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