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

DescribeIndex

Obtiene información sobre un índice de Amazon Kendra existente.

Sintaxis de la solicitud

{ "Id": "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.

Id

El identificador del índice para el que desea obtener información.

Type: Cadena

Límites de longitud: Longitud fija de 36.

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

Obligatorio: Sí

Sintaxis de la respuesta

{ "CapacityUnits": { "QueryCapacityUnits": number, "StorageCapacityUnits": number }, "CreatedAt": number, "Description": "string", "DocumentMetadataConfigurations": [ { "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" } ], "Edition": "string", "ErrorMessage": "string", "Id": "string", "IndexStatistics": { "FaqStatistics": { "IndexedQuestionAnswersCount": number }, "TextDocumentStatistics": { "IndexedTextBytes": number, "IndexedTextDocumentsCount": number } }, "Name": "string", "RoleArn": "string", "ServerSideEncryptionConfiguration": { "KmsKeyId": "string" }, "Status": "string", "UpdatedAt": number, "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" } } ] }

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.

CapacityUnits

Para los índices de Enterprise Edition, puede optar por utilizar capacidad adicional para satisfacer las necesidades de su aplicación. Contiene las unidades de capacidad utilizadas para el índice. Una capacidad de almacenamiento de consultas o documentos de cero indica que el índice utiliza la capacidad predeterminada. Para obtener más información sobre la capacidad predeterminada de un índice y su ajuste, consulteAjuste de la capacidad.

Tipo: objeto CapacityUnitsConfiguration

CreatedAt

La fecha y hora de Unix en la que se creó el índice.

Type: Marca temporal

Description

La descripción para el índice.

Type: Cadena

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

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

DocumentMetadataConfigurations

Información de configuración para campos o metadatos de documentos. Los metadatos de los documentos son campos o atributos asociados a los documentos. Por ejemplo, el nombre del departamento de la empresa asociado a cada documento.

Type: Matriz deDocumentMetadataConfigurationobjects

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

Edition

La edición de Amazon Kendra utilizada para el índice. Tú decides la edición al crear el índice.

Type: Cadena

Valores válidos: DEVELOPER_EDITION | ENTERPRISE_EDITION

ErrorMessage

Cuando elStatusel valor del campo esFAILED, elErrorMessagecontiene un mensaje que explica por qué.

Type: Cadena

Límites de longitud: Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

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

Id

El identificador del índice.

Type: Cadena

Límites de longitud: Longitud fija de 36.

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

IndexStatistics

Proporciona información sobre el número de preguntas y respuestas a las preguntas frecuentes y el número de documentos de texto indexados.

Tipo: objeto IndexStatistics

Name

El nombre del índice.

Type: Cadena

Límites 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_-]*

RoleArn

El Nombre de recurso de Amazon (ARN) del rol de IAM que otorga a Amazon Kendra permiso para escribir en los registros de Amazon Cloudwatch.

Type: Cadena

Límites de longitud: Longitud mínima de 0. La longitud máxima es de 1284.

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}

ServerSideEncryptionConfiguration

El identificador delAWS KMSla clave maestra de cliente (CMK) que se utiliza para cifrar los datos. Amazon Kendra no admite CMK asimétricas.

Tipo: objeto ServerSideEncryptionConfiguration

Status

El estado actual del índice. Cuando el valor esACTIVE, ya se puede utilizar el índice. Si el archivo deStatusel valor del campo esFAILED, elErrorMessagecontiene un mensaje que explica por qué.

Type: Cadena

Valores válidos: CREATING | ACTIVE | DELETING | FAILED | UPDATING | SYSTEM_UPDATING

UpdatedAt

La fecha y hora de Unix en que se actualizó el índice por última vez.

Type: Marca temporal

UserContextPolicy

La política de contexto de usuario del índice de Amazon Kendra.

Type: Cadena

Valores válidos: ATTRIBUTE_FILTER | USER_TOKEN

UserGroupResolutionConfiguration

Si ha habilitado la configuración para obtener los niveles de acceso de grupos y usuarios desde unAWS IAM Identity Center (successor to AWS Single Sign-On)fuente de Identidad.

Tipo: objeto UserGroupResolutionConfiguration

UserTokenConfigurations

La configuración de token de usuario para el índice de Amazon Kendra.

Type: Matriz deUserTokenConfigurationobjects

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

Errores

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

AccessDeniedException

Código de estado HTTP: 400

InternalServerException

Código de estado HTTP: 500

ResourceNotFoundException

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: