создать-индекс

Описание

Создает индекс Amazon Kendra. Создание индекса — асинхронный API. Чтобы определить, завершено ли создание индекса, проверьте поле Status, возвращаемое при вызове DescribeIndex. Поле Status устанавливается в значение ACTIVE, когда индекс готов к использованию.

После активации индекса вы можете индексировать свои документы с помощью API BatchPutDocument или с помощью одного из поддерживаемых источников данных.

Пример создания индекса и источника данных с помощью Python SDK см. в разделе Начало работы с Python SDK. Пример создания индекса и источника данных с помощью Java SDK см. в разделе Начало работы с Java SDK.

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

Синтаксис

  create-index
--name <value>
[--edition <value>]
--role-arn <value>
[--server-side-encryption-configuration <value>]
[--description <value>]
[--client-token <value>]
[--tags <value>]
[--user-token-configurations <value>]
[--user-context-policy <value>]
[--user-group-resolution-configuration <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]

Параметры

--name (строка)

--edition (строка)

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

--server-side-encryption-configuration (структура)

Сокращенная синтаксическая запись:

KmsKeyId=string

Синтаксис JSON:

{
  "KmsKeyId": "string"
}

--description (строка)

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

--tags (список)

Сокращенная синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

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

--user-token-configurations (список)

Сокращенная синтаксическая запись:

JwtTokenTypeConfiguration={KeyLocation=string,URL=string,SecretManagerArn=string,UserNameAttributeField=string,GroupAttributeField=string,Issuer=string,ClaimRegex=string},JsonTokenTypeConfiguration={UserNameAttributeField=string,GroupAttributeField=string} ...

Синтаксис JSON:

[
  {
    "JwtTokenTypeConfiguration": {
      "KeyLocation": "URL"|"SECRET_MANAGER",
      "URL": "string",
      "SecretManagerArn": "string",
      "UserNameAttributeField": "string",
      "GroupAttributeField": "string",
      "Issuer": "string",
      "ClaimRegex": "string"
    },
    "JsonTokenTypeConfiguration": {
      "UserNameAttributeField": "string",
      "GroupAttributeField": "string"
    }
  }
  ...
]

--user-context-policy (строка)

--user-group-resolution-configuration (структура)

Сокращенная синтаксическая запись:

UserGroupResolutionMode=string

Синтаксис JSON:

{
  "UserGroupResolutionMode": "AWS_SSO"|"NONE"
}

--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 (boolean)

Включить отладовую запись журнала.

--endpoint-url (string)

Заменить стандартный URL команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр изменяет поведение по умолчанию, связанное с проверкой сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

Включить/выключить вывод в цвете.

• on
• off
• auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки в конфигурации/среде.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение равно 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить вывод страницы AWS CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Создание индекса Amazon Kendra

Следующий create-index создает и настраивает индекс Amazon Kendra. Вы можете использовать describe-index для просмотра состояния индекса и чтения любых сообщений об ошибках, если состояние индекса показывает «FAILED» при полном создании.

aws kendra create-index \
    --name "example index 1" \
    --description "Example index 1 contains the first set of example documents" \
    --tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \
    --role-arn "arn:aws:iam::my-account-id:role/KendraRoleForExampleIndex" \
    --edition "DEVELOPER_EDITION" \
    --server-side-encryption-configuration '{"KmsKeyId": "my-kms-key-id"}' \
    --user-context-policy "USER_TOKEN" \
    --user-token-configurations '{"JsonTokenTypeConfiguration": {"GroupAttributeField": "groupNameField", "UserNameAttributeField": "userNameField"}}'

Вывод:

{
   "Id": index1
}

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

Вывод

Id -> (string)