[ aws . chime-sdk-messaging ]
поиск-каналов
Описание
Позволяет ChimeBearer искать каналы по членам канала. Пользователи или боты могут искать среди каналов, к которым они принадлежат. Пользователи с ролью AppInstanceAdmin могут искать во всех каналах.
Заголовок запроса x-amz-chime-bearer является обязательным. Используйте ARN AppInstanceUser или AppInstanceBot, которые выполняют вызов API, в качестве значения в заголовке.
См. также: Документация AWS API
Синтаксис
search-channels
[--chime-bearer <value>]
--fields <value>
[--max-results <value>]
[--next-token <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]
Параметры
--chime-bearer (строка)
--fields (список)
Список объектов Field в канале, по которому выполняется поиск.
(структура)
Field канала, который требуется найти.
Ключ -> (строка)
enum, которое указывает ключ для поиска в канале. MEMBERS позволяет искать каналы на основе членства. Вы можете использовать оператор EQUALS для получения каналов, членство в которых равно указанным значениям, и оператор INCLUDES для получения каналов, членство в которых включает указанные значения.Значения -> (список)
Значения, которые требуется найти, список строк. Значения должны быть AppInstanceUserArns указаны как список строк.
Примечание
Данная операция не поддерживается дляAppInstanceUsers с большим количеством участников.(строка)
Оператор -> (строка)
EQUALS или INCLUDES. Используйте оператор EQUALS, чтобы найти каналы, членство в которых равно указанным значениям. Используйте оператор INCLUDES, чтобы найти каналы, членство в которых включает указанные значения.Сокращенный синтаксис:
Key=string,Values=string,string,Operator=string ...
Синтаксис JSON:
[
{
"Key": "MEMBERS",
"Values": ["string", ...],
"Operator": "EQUALS"|"INCLUDES"
}
...
]
--max-results (целое число)
--next-token (строка)
--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров CLI.
Вывод
Каналы -> (список)
Список каналов в запросе.
(структура)
Краткое описание деталей Channel.
Имя -> (строка)
ChannelArn -> (строка)
Режим -> (строка)
Конфиденциальность -> (строка)
Метаданные -> (строка)
LastMessageTimestamp -> (метка времени)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.