Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-models ]

describe-bot-alias

Описание

Получение информации о конкретном алиасе бота.

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

Синтаксис

  describe-bot-alias
--bot-alias-id <value>
--bot-id <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]

Параметры

--bot-alias-id (строка)

Идентификатор алиаса бота для описания.

--bot-id (строка)

Идентификатор бота, связанного с алиасом бота для описания.

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

Вывод

botAliasId -> (строка)

Идентификатор алиаса бота.

botAliasName -> (строка)

Имя алиаса бота.

description -> (строка)

Описание алиаса бота.

botVersion -> (строка)

Версия бота, связанная с алиасом бота.

botAliasLocaleSettings -> (массив)

Настройки региональных параметров, уникальные для алиаса.

key -> (строка)

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

Указывает настройки, уникальные для региональных параметров. Например, можно использовать разные функции Lambda в зависимости от региональных параметров бота.

enabled -> (логическое значение)

Определяет, включен ли региональный параметр для бота. Если значение равно false, региональный параметр недоступен для использования.

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

Указывает функцию Lambda, которая должна использоваться в региональных параметрах.

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

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

lambdaARN -> (строка)

Amazon Resource Name (ARN) функции Lambda.

codeHookInterfaceVersion -> (строка)

Версия запроса-ответа, которую вы хотите, чтобы Amazon Lex использовал для вызова вашей функции Lambda.

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

Указывает, как Amazon Lex регистрирует текстовые и аудио-беседы с ботом, связанным с алиасом.

textLogSettings -> (список)

Настройки Amazon CloudWatch Logs для регистрации текстовых и метаданных.

(структура)

Определяет настройки для включения текстовых журналов разговоров.

enabled -> (логическое значение)

Определяет, должны ли храниться журналы разговоров для алиаса.

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

Определяет место назначения журнала Amazon CloudWatch Logs для текстовых журналов разговоров.

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

Определяет группу журналов Amazon CloudWatch Logs, куда доставляются текстовые и метаданные журналов.

cloudWatchLogGroupArn -> (строка)

Amazon Resource Name (ARN) группы журналов, куда доставляются текстовые и метаданные журналы.

logPrefix -> (строка)

Префикс имени потока журнала в группе журналов, которую вы указали

selectiveLoggingEnabled -> (логическое значение)

Параметр для включения выборочного сбора журналов разговоров для текста.

audioLogSettings -> (список)

Настройки Amazon S3 для записи аудио в ведро S3.

(структура)

Настройки для регистрации аудио из разговоров между Amazon Lex и пользователем. Вы указываете, нужно ли регистрировать аудио и ведро Amazon S3, где хранится аудиофайл.

enabled -> (логическое значение)

Определяет, включена ли регистрация аудио для бота.

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

Расположение файлов журналов аудио, собранных при включенной регистрации разговоров для бота.

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

Ведро Amazon S3, где хранятся файлы журналов аудио. Роль IAM, указанная в параметре roleArn операции CreateBot, должна иметь разрешение на запись в это ведро.

kmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа Amazon Web Services Key Management Service (KMS) для шифрования файлов журналов аудио, хранящихся в ведре S3.

s3BucketArn -> (строка)

Amazon Resource Name (ARN) ведра Amazon S3, где хранятся файлы журналов аудио.

logPrefix -> (строка)

Префикс S3 для файлов журналов аудио.

selectiveLoggingEnabled -> (логическое значение)

Параметр для включения выборочного сбора журналов разговоров для аудио.

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

Определяет, будет ли Amazon Lex использовать Amazon Comprehend для определения настроения пользовательских высказываний.

detectSentiment -> (логическое значение)

Устанавливает, будет ли Amazon Lex использовать Amazon Comprehend для определения настроения пользовательских высказываний.

botAliasHistoryEvents -> (список)

Список событий, влияющих на алиас бота. Например, событие записывается, когда версия, на которую указывает алиас, изменяется.

(структура)

Запись события, влияющего на алиас бота. Например, при изменении версии бота, на который указывает алиас.

botVersion -> (строка)

Версия бота, использованная в событии.

startDate -> (временная метка)

Дата и время начала события.

endDate -> (временная метка)

Дата и время окончания события.

botAliasStatus -> (строка)

Текущий статус алиаса. Когда алиас Available, алиас готов к использованию с вашим ботом.

botId -> (строка)

Идентификатор бота, связанного с алиасом бота.

creationDateTime -> (временная метка)

Временная метка даты и времени создания алиаса.

lastUpdatedDateTime -> (временная метка)

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

parentBotNetworks -> (список)

Список сетей, к которым принадлежит описанный вами алиас бота.

(структура)

Сеть ботов.

botId -> (строка)

Идентификатор сети ботов, назначенный Amazon Lex.

botVersion -> (строка)

Версия сети ботов.

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

Spec-Zone.ru

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