CreateIndex

Crea un índice de Amazon Kendra. La creación de índices es una API asíncrona. Para determinar si la creación del índice se ha completado, compruebe elStatus campo devuelto por una llamada aDescribeIndex. ElStatus campo se establece paraACTIVE cuando el índice esté listo para utilizarse.

Una vez que el índice esté activo, puede indexar los documentos mediante laBatchPutDocument API o mediante una de las fuentes de datos admitidas.

Para ver un ejemplo de cómo crear un índice y una fuente de datos con el SDK de Python, consulte Introducción al SDK de Python. Para ver un ejemplo de cómo crear un índice y una fuente de datos con el SDK de Java, consulte Introducción al SDK de Java.

Sintaxis de la solicitud

{
   "ClientToken": "string",
   "Description": "string",
   "Edition": "string",
   "Name": "string",
   "RoleArn": "string",
   "ServerSideEncryptionConfiguration": { 
      "KmsKeyId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "UserContextPolicy": "string",
   "UserGroupResolutionConfiguration": { 
      "UserGroupResolutionMode": "string"
   },
   "UserTokenConfigurations": [ 
      { 
         "JsonTokenTypeConfiguration": { 
            "GroupAttributeField": "string",
            "UserNameAttributeField": "string"
         },
         "JwtTokenTypeConfiguration": { 
            "ClaimRegex": "string",
            "GroupAttributeField": "string",
            "Issuer": "string",
            "KeyLocation": "string",
            "SecretManagerArn": "string",
            "URL": "string",
            "UserNameAttributeField": "string"
         }
      }
   ]
}

Parámetros de solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

ClientToken

Un token que se proporciona para identificar la solicitud de creación de un índice. Varias llamadas a laCreateIndex API con el mismo token de cliente solo crearán un índice.

Tipo: String

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 100. caracteres.

Obligatorio: no

Description

Una descripción del índice.

Tipo: String

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 1000 caracteres.

Patrón: ^\P{C}*$

Obligatorio: no

Edition

La edición de Amazon Kendra que se utilizará en el índice. Elija los índicesDEVELOPER_EDITION destinados al desarrollo, las pruebas o la prueba de concepto. ÚseloENTERPRISE_EDITION para la producción. Una vez configurada la edición de un índice, no se puede cambiar.

El parámetro Edition es opcional. Si no se proporciona un valor, el valor predeterminado es deENTERPRISE_EDITION.

Para obtener más información sobre los límites de cuota para las ediciones Enterprise y Developer, consulte Cuotas.

Tipo: String

Valores válidos: DEVELOPER_EDITION | ENTERPRISE_EDITION

Obligatorio: no

Name

El nombre del índice.

Tipo: String

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1000 caracteres.

Patrón: [a-zA-Z0-9][a-zA-Z0-9_-]*

Obligatorio: sí

RoleArn

Nombre de recurso de Amazon (ARN) de un rol de IAM con permiso para acceder a sus CloudWatch registros y las métricas de Amazon. Para obtener más información, consulte Roles de acceso de IAM para Amazon Kendra.

Tipo: String

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 1284 caracteres.

Patrón: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Obligatorio: sí

ServerSideEncryptionConfiguration

Identificador de la clave administrada por elAWS KMS cliente (CMK) que se usa para cifrar los datos indexados por Amazon Kendra. Amazon Kendra no admite CMK asimétricas.

Tipo: objeto ServerSideEncryptionConfiguration

Obligatorio: no

Tags

Lista de pares clave-valor que identifican o categorizan el índice. También puede utilizar etiquetas para ayudar a controlar el acceso al índice. las claves y los valores de las etiquetas pueden constar de letras Unicode, números, espacios en blanco y cualquiera de los siguientes símbolos de los siguientes símbolos: _.:/= + - @.

Tipo: Matriz de objetos Tag

Miembros de la matriz: número mínimo de 0 elementos. Número máximo de 200 elementos.

Obligatorio: no

UserContextPolicy

Política de contexto de usuario.

ATTRIBUTE_FILTER

Todo el contenido indexado se puede buscar y mostrar a todos los usuarios. Si desea filtrar los resultados de la búsqueda según el contexto del usuario, puede utilizar los filtros de atributos de _user_id y _group_ids o puede proporcionar información de usuarios y grupos en UserContext.

USER_TOKEN

Habilita el control de acceso de usuario basado en tókenes para filtrar los resultados de búsqueda en función del contexto de usuario. Todos los documentos sin control de acceso y todos los documentos accesibles para el usuario podrán ser buscados y visualizados.

Tipo: String

Valores válidos: ATTRIBUTE_FILTER | USER_TOKEN

Obligatorio: no

UserGroupResolutionConfiguration

Obtiene usuarios y grupos de la fuente deAWS IAM Identity Center (successor to AWS Single Sign-On) identidad. Para configurar esto, consulte UserGroupResolutionConfiguration.

Tipo: objeto UserGroupResolutionConfiguration

Obligatorio: no

UserTokenConfigurations

La configuración del token de usuario.

Tipo: Matriz de objetos UserTokenConfiguration

Miembros de la matriz: número máximo de 1 elemento.

Obligatorio: no

Sintaxis de la respuesta

{
   "Id": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

Id

El identificador del índice. Utilice este identificador cuando consulte un índice, configure una fuente de datos o indexe un documento.

Tipo: String

Limitaciones de longitud: longitud fija de 36.

Patrón: [a-zA-Z0-9][a-zA-Z0-9-]*

Errores

Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

No tiene acceso suficiente para realizar esta acción. Asegúrese de contar con las políticas de permisos y las cuentas de usuario necesarias e inténtelo de nuevo.

Código de estado HTTP: 400

ConflictException

Se ha producido un conflicto con la solicitud. Corrija cualquier incoherencia con sus recursos e inténtelo de nuevo.

Código de estado HTTP: 400

InternalServerException

Se ha producido un problema con el servidor interno utilizado para el servicio Amazon Kendra. Espera unos minutos e inténtalo de nuevo o ponte en contacto con el servicio de Support para obtener ayuda.

Código de estado HTTP: 500

ResourceAlreadyExistException

El recurso que desea utilizar ya existe. Compruebe que ha proporcionado el recurso correcto e inténtelo de nuevo.

Código de estado HTTP: 400

ServiceQuotaExceededException

Has superado los límites establecidos para tu servicio Amazon Kendra. Consulte Cuotas para obtener más información o póngase en contacto con el servicio de Support para solicitar información sobre un aumento de los límites.

Código de estado HTTP: 400

ThrottlingException

La solicitud se denegó debido a una limitación controlada. Reduzca el número de solicitudes e inténtelo de nuevo.

Código de estado HTTP: 400

ValidationException

La entrada no satisface las limitaciones establecidas por el servicio Amazon Kendra. Introduzca la entrada correcta e inténtelo de nuevo.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:

• AWS Command Line Interface

• SDK de AWS para .NET

• AWS SDK para C++

• AWS SDK para Go

• AWS SDK para Java V2

• AWSSDK para JavaScript

• SDK de AWS para PHP V3

• SDK de AWS para Python

• SDK de AWS para Ruby V3