Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

создать-чаво

Описание

Создает набор часто задаваемых вопросов (FAQ) с использованием указанного файла FAQ, хранящегося в ведре Amazon S3.

Добавление FAQ в индекс — асинхронная операция.

Пример добавления FAQ в индекс с использованием Python и Java SDK см. в статье Использование файла FAQ .

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

Синтаксис

  create-faq
--index-id <value>
--name <value>
[--description <value>]
--s3-path <value>
--role-arn <value>
[--tags <value>]
[--file-format <value>]
[--client-token <value>]
[--language-code <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 (строка)

Идентификатор индекса для FAQ.

--name (строка)

Название FAQ.

--description (строка)

Описание FAQ.

--s3-path (структура)

Путь к файлу FAQ в S3.

Ведро -> (строка)

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

Ключ -> (строка)

Имя файла.

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

Bucket=string,Key=string

Синтаксис JSON:

{
  "Bucket": "string",
  "Key": "string"
}

--role-arn (строка)

Amazon Resource Name (ARN) роли IAM с разрешением на доступ к ведру S3, содержащему файл FAQ. Дополнительные сведения см. в разделе Роли доступа IAM для Amazon Kendra .

--tags (список)

Список пар ключ-значение, идентифицирующих FAQ. Вы можете использовать теги для идентификации и организации ресурсов, а также для управления доступом к ресурсам.

(структура)

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

Ключ -> (строка)

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

Значение -> (строка)

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

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--file-format (строка)

Формат входного файла FAQ. Вы можете выбрать между базовым форматом CSV, форматом CSV, включающим пользовательские атрибуты в заголовке, и форматом JSON, включающим пользовательские атрибуты.

По умолчанию используется формат CSV.

Формат должен соответствовать формату файла, хранящегося в ведре S3, указанном в параметре S3Path.

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

Возможные значения:

  • CSV
  • CSV_WITH_HEADER
  • JSON

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

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

--language-code (строка)

Код языка. Это позволяет вам поддерживать язык для документа FAQ. По умолчанию поддерживается английский язык. Дополнительные сведения о поддерживаемых языках, включая их коды, см. в статье Добавление документов на языках, отличных от английского .

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.

Вывод

Идентификатор -> (строка)

Идентификатор FAQ.

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

Spec-Zone.ru

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