Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

list-experiences

Описание

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

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

Синтаксис

  list-experiences
--index-id <value>
[--next-token <value>]
[--max-results <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]

Параметры

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

Идентификатор индекса для вашего опыта Amazon Kendra.

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

Если предыдущий ответ был неполным (потому что для получения данных требуется больше запросов), Amazon Kendra возвращает маркер пагинации в ответе. Этот маркер пагинации можно использовать для получения следующего набора опытов Amazon Kendra.

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

Максимальное количество возвращаемых опытов Amazon Kendra.

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

--cli-auto-prompt (логическое значение)

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

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

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

Вывод

SummaryItems -> (список)

Массив сводной информации об одном или нескольких опытах Amazon Kendra.

(структура)

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

Name -> (строка)

Название вашего опыта Amazon Kendra.

Id -> (строка)

Идентификатор вашего опыта Amazon Kendra.

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

Маркер времени Unix, когда был создан ваш опыт Amazon Kendra.

Status -> (строка)

Статус обработки вашего опыта Amazon Kendra.

Endpoints -> (список)

URL-адреса конечных точек для ваших опытов Amazon Kendra. URL-адреса уникальны и полностью размещаются Amazon Web Services.

(структура)

Предоставляет конфигурационную информацию для конечной точки вашего опыта Amazon Kendra.

EndpointType -> (строка)

Тип конечной точки для вашего опыта Amazon Kendra. В настоящее время доступен тип HOME, который представляет собой уникальный и полностью размещенный URL-адрес домашней страницы вашего опыта Amazon Kendra.

Endpoint -> (строка)

Конечная точка вашего опыта Amazon Kendra.

NextToken -> (строка)

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

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

Spec-Zone.ru

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