Spec-Zone.ru › AWS CLI v2

[ aws . lexv2-models ]

list-bots

Описание

Получает список доступных ботов.

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

Синтаксис

  list-bots
[--sort-by <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--sort-by (структура)

Определяет параметры сортировки списка ботов. Можно указать сортировку по имени бота в порядке возрастания или убывания.

attribute -> (строка)

Атрибут для сортировки списка ботов.

order -> (строка)

Порядок сортировки. Можно выбрать возрастание или убывание.

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

attribute=string,order=string

Синтаксис JSON:

{
  "attribute": "BotName",
  "order": "Ascending"|"Descending"
}

--filters (список)

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

(структура)

Фильтры ответы, возвращаемые операцией ListBots.

name -> (строка)

Имя поля для фильтрации списка ботов.

values -> (список)

Значение для фильтрации списка ботов.

(строка)

operator -> (строка)

Оператор для использования в фильтре. Укажите EQ, если операция ListBots должна возвращать только псевдонимы, равные указанному значению. Укажите CO, если операция ListBots должна возвращать псевдонимы, содержащие указанное значение.

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

name=string,values=string,string,operator=string ...

Синтаксис JSON:

[
  {
    "name": "BotName"|"BotType",
    "values": ["string", ...],
    "operator": "CO"|"EQ"|"NE"
  }
  ...
]

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

Максимальное количество ботов, возвращаемых на каждой странице результатов. Если результатов меньше, чем максимальный размер страницы, возвращается только фактическое количество результатов.

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

Если ответ от операции ListBots содержит больше результатов, чем указано в параметре maxResults, в ответ возвращается маркер.

Используйте возвращенный маркер в параметре nextToken запроса ListBots, чтобы получить следующую страницу результатов. Для получения полного набора результатов вызывайте операцию ListBots, пока поле nextToken, возвращаемое в ответе, не будет пустым.

--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
  • text
  • таблица
  • 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.

Вывод

botSummaries -> (список)

Сводная информация о ботах, соответствующих критериям фильтра, указанным в запросе. Длина списка задается в параметре maxResults запроса. Если доступно больше ботов, поле nextToken содержит маркер для следующей страницы результатов.

(структура)

Сводная информация о боте, возвращенном операцией ListBots.

botId -> (строка)

Уникальный идентификатор, присвоенный боту. Используйте этот идентификатор для получения подробной информации о боте с помощью операции DescribeBot.

botName -> (строка)

Имя бота.

description -> (строка)

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

botStatus -> (строка)

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

latestBotVersion -> (строка)

Последняя используемая числовая версия бота.

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

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

botType -> (строка)

Тип бота.

nextToken -> (строка)

Маркер, указывающий, есть ли больше результатов, которые необходимо вернуть в ответе на операцию ListBots. Если поле nextToken присутствует, вы отправляете содержимое в качестве параметра nextToken запроса операции ListBots для получения следующей страницы результатов.

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

Spec-Zone.ru

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