Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-модели ]

создать-алиас-бота

Описание

Создает алиас для указанной версии бота. Используйте алиас, чтобы изменить версию бота, не обновляя приложения, использующие бота.

Например, вы можете создать алиас «PROD», который ваши приложения используют для вызова бота Amazon Lex.

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

Синтаксис

  create-bot-alias
--bot-alias-name <value>
[--description <value>]
[--bot-version <value>]
[--bot-alias-locale-settings <value>]
[--conversation-log-settings <value>]
[--sentiment-analysis-settings <value>]
--bot-id <value>
[--tags <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-name (строка)

Алиас для создания. Название должно быть уникальным для бота.

--description (строка)

Описание алиаса. Используйте это описание для идентификации алиаса.

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

Версия бота, на которую указывает этот алиас. Вы можете использовать операцию UpdateBotAlias для изменения версии бота, связанной с алиасом.

--bot-alias-locale-settings (массив)

Сопоставляет конфигурационные данные с определенным языковым регионом. Вы можете использовать этот параметр для указания определенной Lambda-функции для выполнения различных функций в разных языковых регионах.

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

значение -> (структура)

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

enabled -> (булево)

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

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

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

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

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

lambdaARN -> (строка)

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

codeHookInterfaceVersion -> (строка)

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

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

KeyName1=enabled=boolean,codeHookSpecification={lambdaCodeHook={lambdaARN=string,codeHookInterfaceVersion=string}},KeyName2=enabled=boolean,codeHookSpecification={lambdaCodeHook={lambdaARN=string,codeHookInterfaceVersion=string}}

Синтаксис JSON:

{"string": {
      "enabled": true|false,
      "codeHookSpecification": {
        "lambdaCodeHook": {
          "lambdaARN": "string",
          "codeHookInterfaceVersion": "string"
        }
      }
    }
  ...}

--conversation-log-settings (структура)

Указывает, регистрирует ли Amazon Lex текст и аудио для разговора с ботом. Когда вы включаете журналы разговоров, текстовые журналы хранят ввод текста, транскрипты аудиоввода и связанные метаданные в Amazon CloudWatch Logs. Аудиожурналы хранят аудиоввод в Amazon S3.

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 -> (булево)

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

Синтаксис JSON:

{
  "textLogSettings": [
    {
      "enabled": true|false,
      "destination": {
        "cloudWatch": {
          "cloudWatchLogGroupArn": "string",
          "logPrefix": "string"
        }
      },
      "selectiveLoggingEnabled": true|false
    }
    ...
  ],
  "audioLogSettings": [
    {
      "enabled": true|false,
      "destination": {
        "s3Bucket": {
          "kmsKeyArn": "string",
          "s3BucketArn": "string",
          "logPrefix": "string"
        }
      },
      "selectiveLoggingEnabled": true|false
    }
    ...
  ]
}

--sentiment-analysis-settings (структура)

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

detectSentiment -> (булево)

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

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

detectSentiment=boolean

Синтаксис JSON:

{
  "detectSentiment": true|false
}

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

Уникальный идентификатор бота, к которому относится алиас.

--tags (массив)

Список тегов для добавления к алиасу бота. Вы можете добавлять теги только при создании алиаса; вы не можете использовать операцию UpdateBotAlias для обновления тегов алиаса бота. Для обновления тегов используйте операцию TagResource.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 (ARN) функции Lambda.

codeHookInterfaceVersion -> (строка)

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

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

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

textLogSettings -> (список)

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

(структура)

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

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

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

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

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

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

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

cloudWatchLogGroupArn -> (строка)

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

logPrefix -> (строка)

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

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

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

audioLogSettings -> (список)

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

(структура)

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

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

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

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

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

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

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

kmsKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа управления ключами Amazon Web Services (KMS) для шифрования файлов журналов аудио, хранящихся в ведре S3.

s3BucketArn -> (строка)

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

logPrefix -> (строка)

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

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

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

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

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

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

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

botAliasStatus -> (строка)

Текущий статус псевдонима. Сначала псевдоним переводится в состояние Creating. Когда псевдоним готов к использованию, он переводится в состояние Available. Вы можете использовать операцию DescribeBotAlias для получения текущего состояния псевдонима.

botId -> (строка)

Уникальный идентификатор бота, к которому относится этот псевдоним.

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

Временная метка Unix, показывающая дату и время создания псевдонима бота.

tags -> (массив)

Список тегов, связанных с псевдонимом бота.

key -> (строка)

value -> (строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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