CreateIndex - Amazon Kendra

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CreateIndex

Crea un índice de Amazon Kendra. La creación de índices es una API asíncrona. Para determinar si se ha completado la creación del índice, compruebe laStatuscampo devuelto de una llamada aDescribeIndex. LaStatusEl campo está establecido enACTIVEcuando el índice esté listo para usar.

Una vez que el índice esté activo, puede indexar los documentos mediante laBatchPutDocumentAPI o utilizando uno de los orígenes de datos compatibles.

Para ver un ejemplo de cómo crear un índice y un origen de datos mediante el SDK de Python, consulteIntroducción al SDK de Python. Para ver un ejemplo de cómo crear un índice y un origen de datos mediante el SDK de Java, consulteIntroducció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 que son comunes a todas las acciones, consulteParámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

ClientToken

Un token que proporciona para identificar la solicitud de creación de un índice. Múltiples llamadas alCreateIndexLa API con el mismo token de cliente creará un solo índice.

Type: Cadena

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

Obligatorio: No

Description

Una descripción del índice.

Type: Cadena

Restricciones 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á para el índice. ElegirDEVELOPER_EDITIONpara índices destinados a desarrollo, pruebas o prueba de concepto. UsarENTERPRISE_EDITIONpara sus bases de datos de producción. Una vez que hayas configurado la edición para un índice, no se puede cambiar.

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

Para obtener más información sobre los límites de cuotas para las ediciones de empresa y desarrollador, consulteCuotas.

Type: Cadena

Valores válidos: DEVELOPER_EDITION | ENTERPRISE_EDITION

Obligatorio: No

Name

El nombre del índice.

Type: Cadena

Restricciones 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

UnAWS Identity and Access Management(IAM) que otorga a Amazon Kendra permisos para acceder a Amazon CloudWatch registros y métricas. Este es también el rol que usas cuando llamas alBatchPutDocumentAPI para indexar documentos de un bucket de Amazon S3

Type: Cadena

Restricciones de longitud: Longitud mínima de 0. Longitud máxima 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 delAWS KMSClave administrada por el cliente (CMK) que se utiliza 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 el índice. Puede utilizar las etiquetas para identificar y organizar los recursos de, así como para controlar el acceso a los recursos.

Type: Matrices deTagobjects

Miembros de matrices: El número mínimo es 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 búsqueda en el contexto del usuario, puede utilizar los filtros de atributos de_user_idy_group_idso puede proporcionar información de usuario y grupo enUserContext.

USER_TOKEN

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

Type: Cadena

Valores válidos: ATTRIBUTE_FILTER | USER_TOKEN

Obligatorio: No

UserGroupResolutionConfiguration

Permite obtener niveles de acceso de grupos y usuarios desde unAWS IAM Identity Center (successor to AWS Single Sign-On)fuente de identidad. Para configurarlo, consulteConfiguración de la solución de grupo de usuarios.

Tipo: objeto UserGroupResolutionConfiguration

Obligatorio: No

UserTokenConfigurations

Configuración del token de usuario.

Type: Matrices deUserTokenConfigurationobjects

Miembros de matrices: 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

Identificador único del índice. Utilice este identificador al consultar un índice, configurar un origen de datos o indexar un documento.

Type: Cadena

Restricciones de longitud: Longitud fija de 36.

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

Errores

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

AccessDeniedException

Código de estado HTTP: 400

ConflictException

Código de estado HTTP: 400

InternalServerException

Código de estado HTTP: 500

ResourceAlreadyExistException

Código de estado HTTP: 400

ServiceQuotaExceededException

Código de estado HTTP: 400

ThrottlingException

Código de estado HTTP: 400

ValidationException

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: