Spec-Zone.ru › AWS CLI v2

[ aws . lex-models ]

get-bot-aliases

Описание

Возвращает список псевдонимов для указанного бота Amazon Lex.

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

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

get-bot-aliases — это постраничная операция. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: BotAliases

Синтаксис

  get-bot-aliases
--bot-name <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 (строка)

Имя бота.

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

Подстрока для поиска в именах псевдонимов ботов. Псевдоним будет возвращен, если любая часть его имени соответствует подстроке. Например, «xyz» соответствует как «xyzabc», так и «abcxyz».

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, с какой точки начать постраничный вывод. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы, получаемой в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет параметры конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/отключение цветного вывода.

  • on
  • off
  • auto

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

Вывод

BotAliases -> (список)

Массив объектов BotAliasMetadata, каждый из которых описывает псевдоним бота.

(структура)

Предоставляет информацию о псевдониме бота.

name -> (строка)

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

description -> (строка)

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

botVersion -> (строка)

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

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.

nextToken -> (строка)

Токен постраничного вывода для извлечения следующей страницы псевдонимов. Если ответ на этот вызов усечен, Amazon Lex возвращает токен постраничного вывода в ответе. Чтобы извлечь следующую страницу псевдонимов, укажите токен постраничного вывода в следующем запросе.

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

Spec-Zone.ru

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