Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-messaging ]

create-channel-flow

Описание

Создаёт поток каналов (channel flow), контейнер для обработчиков. Обработчики — это функции AWS Lambda, которые выполняют действия с сообщениями чата, например, удаляют ненормативную лексику. Вы можете связать потоки каналов с каналами, и обработчики в потоке каналов будут обрабатывать все сообщения, отправленные в этот канал. Это API для разработчиков.

Потоки каналов обрабатывают следующие элементы:

  • Новые и обновлённые сообщения
  • Постоянные и непостоянные сообщения
  • Стандартный тип сообщения

Примечание

Потоки каналов не обрабатывают управляющие или системные сообщения. Для получения дополнительной информации о типах сообщений, предоставляемых Chime SDK messaging, см. Типы сообщений в руководстве для разработчиков Amazon Chime.

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

Синтаксис

  create-channel-flow
--app-instance-arn <value>
--processors <value>
--name <value>
[--tags <value>]
[--client-request-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 запроса потока канала.

--processors (список)

Информация об обработчиках Lambda-функций.

(структура)

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

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

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

Настройка -> (структура)

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

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

Указывает, что обработчик является типом Lambda.

ResourceArn -> (строка)

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

InvocationType -> (строка)

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

ExecutionOrder -> (целое число)

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

FallbackAction -> (строка)

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

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

Name=string,Configuration={Lambda={ResourceArn=string,InvocationType=string}},ExecutionOrder=integer,FallbackAction=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Configuration": {
      "Lambda": {
        "ResourceArn": "string",
        "InvocationType": "ASYNC"
      }
    },
    "ExecutionOrder": integer,
    "FallbackAction": "CONTINUE"|"ABORT"
  }
  ...
]

--name (строка)

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

--tags (список)

Теги для запроса создания.

(структура)

Объект тега, содержащий пару ключ-значение.

Ключ -> (строка)

Ключ в теге.

Значение -> (строка)

Значение в теге.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--client-request-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 для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

ChannelFlowArn -> (строка)

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

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

Spec-Zone.ru

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