[ aws . lex-models ]
получить-ассоциации-бота-с-каналом
Описание
Возвращает список всех каналов, связанных с указанным ботом.
Операция GetBotChannelAssociations требует разрешений на выполнение действия lex:GetBotChannelAssociations.
См. также: Документацию API AWS
get-bot-channel-associations является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: botChannelAssociations
Синтаксис
get-bot-channel-associations
--bot-name <value>
--bot-alias <value>
[--name-contains <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--bot-name (строка)
--bot-alias (строка)
--name-contains (строка)
nameContains.--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON-строкой. Невозможно передать произвольные двоичные данные с помощью значения, предоставленного в JSON-строке, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен, определяющий, с чего начать постраничный вывод. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.
--page-size (целое число)
Размер каждой страницы для запроса к службе AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.
--max-items (целое число)
Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя командной строки AWS.
--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.
Вывод
botChannelAssociations -> (список)
Массив объектов, по одному на каждую ассоциацию, который содержит информацию о боте Amazon Lex и его связи с каналом.
(структура)
Представляет ассоциацию между ботом Amazon Lex и внешней платформой обмена сообщениями.
name -> (строка)
description -> (строка)
botAlias -> (строка)
botName -> (строка)
Имя бота Amazon Lex, с которым создается эта ассоциация.
Примечание
В настоящее время Amazon Lex поддерживает ассоциации с Facebook, Slack и Twilio.createdDate -> (временная метка)
type -> (строка)
botConfiguration -> (карта)
Предоставляет информацию, необходимую для связи с платформой обмена сообщениями.
ключ -> (строка)
значение -> (строка)
status -> (строка)
Статус канала бота.
-
CREATED- Канал создан и готов к использованию. -
IN_PROGRESS- Создание канала выполняется. -
FAILED- При создании канала произошла ошибка. Сведения о причинах сбоя см. в полеfailureReason.
failureReason -> (строка)
status равно FAILED, Amazon Lex предоставляет причину, по которой не удалось создать ассоциацию.nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.