Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

описание-списка-блоков-предложений-поиска

Описание

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

Это используется для проверки текущих настроек, применяемых к списку блоков.

DescribeQuerySuggestionsBlockList в настоящее время не поддерживается в регионе Amazon Web Services GovCloud (US-West).

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

Синтаксис

  describe-query-suggestions-block-list
--index-id <value>
--id <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 (строка)

Идентификатор индекса для списка блоков.

--id (строка)

Идентификатор списка блоков, информацию о котором вы хотите получить.

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

Вывод

IndexId -> (строка)

Идентификатор индекса для списка блоков.

Id -> (строка)

Идентификатор списка блоков.

Name -> (строка)

Название списка блоков.

Description -> (строка)

Описание списка блоков.

Status -> (строка)

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

ErrorMessage -> (строка)

Сообщение об ошибке, содержащее детали, если есть проблемы с обработкой списка блоков.

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

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

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

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

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

Показывает текущий путь к файлу текста списка блоков в вашем ведре S3.

Каждое слово или фраза блока должно быть на отдельной строке в текстовом файле.

Дополнительную информацию о текущих ограничениях квот для списков блоков см. в разделе Квоты для Amazon Kendra.

Bucket -> (строка)

Имя ведра S3, содержащего файл.

Key -> (строка)

Имя файла.

ItemCount -> (целое число)

Текущее количество допустимых, непустых слов или фраз в текстовом файле списка блоков.

FileSizeBytes -> (длинное целое число)

Текущий размер текстового файла списка блоков в S3.

RoleArn -> (строка)

Используемая роль IAM (Identity and Access Management) Amazon Kendra для доступа к текстовому файлу списка блоков в S3.

Роли необходимы разрешения на чтение для вашего файла в S3 и должны предоставлять разрешения на доверие STS (Security Token Service) Amazon Kendra.

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

Spec-Zone.ru

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