Spec-Zone.ru › AWS CLI v2

[ aws . lex-models ]

put-bot-alias

Описание

Создаёт псевдоним для указанной версии бота или заменяет псевдоним для указанного бота. Чтобы изменить версию бота, на которую указывает псевдоним, замените псевдоним. Дополнительную информацию о псевдонимах см. в разделе versioning-aliases .

Для выполнения этой операции требуются разрешения на действие lex:PutBotAlias.

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

Синтаксис

  put-bot-alias
--name <value>
[--description <value>]
--bot-version <value>
--bot-name <value>
[--checksum <value>]
[--conversation-logs <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]

Параметры

--name (строка)

Имя псевдонима. Регистр не учитывается.

--description (строка)

Описание псевдонима.

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

Версия бота.

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

Имя бота.

--checksum (строка)

Идентифицирует конкретный пересмотр версии $LATEST.

При создании нового псевдонима бота оставьте поле checksum пустым. Если вы укажете контрольную сумму, будет получено исключение BadRequestException.

При обновлении псевдонима бота установите поле checksum в контрольную сумму последней ревизии версии $LATEST. Если вы не укажете поле checksum или контрольная сумма не совпадёт с версией $LATEST, будет получено исключение PreconditionFailedException.

--conversation-logs (структура)

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

logSettings -> (список)

Настройки ваших журналов диалога. Вы можете регистрировать текст диалога, аудио диалога или оба.

(структура)

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

logType -> (строка)

Тип регистрации для включения. Текстовые журналы доставляются в группу журналов CloudWatch Logs. Аудио журналы доставляются в ведро S3.

destination -> (строка)

Место доставки журналов. Текстовые журналы доставляются в группу журналов CloudWatch Logs. Аудио журналы доставляются в ведро S3.

kmsKeyArn -> (строка)

Amazon Resource Name (ARN) управляемого клиентом ключа AWS KMS для шифрования аудио журналов, доставляемых в ведро S3. Ключ не применяется к CloudWatch Logs и является необязательным для ведер S3.

resourceArn -> (строка)

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

iamRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM с разрешением на запись в ваши журналы CloudWatch Logs для текстовых журналов и ваше ведро S3 для аудио журналов. Если включено шифрование аудио, эта роль также предоставляет разрешение доступа к ключу AWS KMS, используемому для шифрования аудио журналов. Дополнительную информацию см. в разделе Создание роли IAM и политики для журналов диалога .

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

logSettings=[{logType=string,destination=string,kmsKeyArn=string,resourceArn=string},{logType=string,destination=string,kmsKeyArn=string,resourceArn=string}],iamRoleArn=string

Синтаксис JSON:

{
  "logSettings": [
    {
      "logType": "AUDIO"|"TEXT",
      "destination": "CLOUDWATCH_LOGS"|"S3",
      "kmsKeyArn": "string",
      "resourceArn": "string"
    }
    ...
  ],
  "iamRoleArn": "string"
}

--tags (список)

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

(структура)

Список пар ключ/значение, которые идентифицируют бота, псевдоним бота или канал бота. Ключи и значения тегов могут содержать буквы, цифры, пробелы Unicode и любой из следующих символов: _ . : / = + - @.

key -> (строка)

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

value -> (строка)

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

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

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "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-auto-prompt (логическое)

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

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

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

Вывод

name -> (строка)

Имя псевдонима.

description -> (строка)

Описание псевдонима.

botVersion -> (строка)

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

botName -> (строка)

Имя бота, на который указывает псевдоним.

lastUpdatedDate -> (метка времени)

Дата обновления псевдонима бота. При создании ресурса дата создания и последнего обновления совпадают.

createdDate -> (метка времени)

Дата создания псевдонима бота.

checksum -> (строка)

Контрольная сумма текущей версии псевдонима.

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

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

logSettings -> (список)

Настройки ваших журналов диалога. Вы можете регистрировать текст, аудио или оба.

(структура)

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

logType -> (строка)

Тип регистрации, который включён.

destination -> (строка)

Место назначения, куда доставляются журналы.

kmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа, используемого для шифрования аудио журналов в ведре S3.

resourceArn -> (строка)

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

resourcePrefix -> (строка)

Префикс ресурса — это первая часть ключа объекта S3 в ведре S3, которое вы указали для хранения аудио журналов. Для CloudWatch Logs это префикс имени потока журнала в группе журнала, которую вы указали.

iamRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, используемой для записи журналов в CloudWatch Logs или ведро S3.

tags -> (список)

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

(структура)

Список пар ключ/значение, которые идентифицируют бота, псевдоним бота или канал бота. Ключи и значения тегов могут содержать буквы, цифры, пробелы Unicode и любой из следующих символов: _ . : / = + - @.

key -> (строка)

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

value -> (строка)

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

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

Spec-Zone.ru

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