Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-messaging ]

list-channel-flows

Описание

Возвращает отсортированный список всех потоков каналов, созданных под одним Chime. Это API для разработчиков.

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

Синтаксис

  list-channel-flows
--app-instance-arn <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]

Параметры

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

ARN экземпляра приложения.

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

Максимальное количество потоков каналов, которое нужно вернуть.

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

Токен, переданный предыдущими вызовами 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
  • текст
  • таблица
  • 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.

Вывод

ChannelFlows -> (список)

Информация о каждом потоке канала.

(структура)

Краткое описание деталей потока канала.

ChannelFlowArn -> (строка)

ARN потока канала.

Имя -> (строка)

Имя потока канала.

Процессоры -> (список)

Информация о процессорных функциях Lambda.

(структура)

Информация о процессоре в потоке канала.

Имя -> (строка)

Имя потока канала.

Конфигурация -> (структура)

Информация о типе процессора и его идентификаторе.

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

Указывает, что процессор типа Lambda.

ResourceArn -> (строка)

ARN функции обработки сообщений Lambda.

InvocationType -> (строка)

Управляет способом вызова функции Lambda.

Порядок выполнения -> (целое число)

Последовательность выполнения процессоров. Если в потоке канала несколько процессоров, обработка сообщений проходит через каждый процессор в последовательности. Значение определяет последовательность. В настоящий момент мы поддерживаем только 1 процессор в потоке.

FallbackAction -> (строка)

Определяет, продолжать обработку сообщений или остановить ее в случае сбоя связи с процессором. Если у процессора есть fallbackAction ABORT, и связь с ним прерывается, процессор устанавливает состояние сообщения на FAILED и не отправляет сообщение никому. Обратите внимание, что если последний процессор в последовательности потока канала имеет fallbackAction CONTINUE и связь с процессором прерывается, то сообщение считается обработанным и отправляется получателям канала.

NextToken -> (строка)

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

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

Spec-Zone.ru

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