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

UpdateIndex

Actualiza un índice de Amazon Kendra existente.

Sintaxis de la solicitud

{ "CapacityUnits": { "QueryCapacityUnits": number, "StorageCapacityUnits": number }, "Description": "string", "DocumentMetadataConfigurationUpdates": [ { "Name": "string", "Relevance": { "Duration": "string", "Freshness": boolean, "Importance": number, "RankOrder": "string", "ValueImportanceMap": { "string" : number } }, "Search": { "Displayable": boolean, "Facetable": boolean, "Searchable": boolean, "Sortable": boolean }, "Type": "string" } ], "Id": "string", "Name": "string", "RoleArn": "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 parámetros que son comunes a todas las acciones, consulteParámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

CapacityUnits

Establece el número de unidades de capacidad de consulta y almacenamiento de documentos adicionales que debe utilizar el índice. Puede cambiar la capacidad del índice hasta 5 veces al día o realizar 5 llamadas a la API.

Si utiliza unidades de almacenamiento adicionales, no puede reducir la capacidad de almacenamiento por debajo de lo necesario para satisfacer las necesidades de almacenamiento de su índice.

Tipo: objeto CapacityUnitsConfiguration

Obligatorio: No

Description

La descripción del índice que desea actualizar.

Type: Cadena

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

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

Obligatorio: No

DocumentMetadataConfigurationUpdates

Los metadatos de documento que desea actualizar.

Type: Matriz deDocumentMetadataConfigurationobjects

Miembros de matrices: El número mínimo es 0 elementos. Número máximo de 500 elementos.

Obligatorio: No

Id

Identificador del índice que desea actualizar.

Type: Cadena

Limitaciones de longitud: Longitud fija de 36.

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

Obligatorio: Sí

Name

El nombre del índice que desea actualizar.

Type: Cadena

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: No

RoleArn

UnAWS Identity and Access Management(IAM) que otorga permiso a Amazon Kendra para acceder a Amazon CloudWatch registros y métricas.

Type: Cadena

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: No

UserContextPolicy

Política de contexto de usuario.

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: Matriz deUserTokenConfigurationobjects

Miembros de matrices: Número máximo de 1 elemento.

Obligatorio: No

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200 con un cuerpo HTTP vacío.

Errores

Para obtener información sobre 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

ResourceNotFoundException

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: