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

DescribeExperience

Obtiene información sobre la experiencia de Amazon Kendra, como una aplicación de búsqueda. Para obtener más información sobre cómo crear una experiencia de aplicación de búsqueda, consulteCreación de una experiencia de búsqueda sin código.

Sintaxis de la solicitud

{ "Id": "string", "IndexId": "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 de la experiencia de Amazon Kendra sobre la que desea obtener información.

Type: Cadena

Limitaciones de longitud Longitud mínima de 1. La longitud máxima es de 36 caracteres.

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

Obligatorio: Sí

IndexId

El identificador del índice de la experiencia de Amazon Kendra.

Type: Cadena

Limitaciones de longitud Longitud fija de 36.

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

Obligatorio: Sí

Sintaxis de la respuesta

{ "Configuration": { "ContentSourceConfiguration": { "DataSourceIds": [ "string" ], "DirectPutContent": boolean, "FaqIds": [ "string" ] }, "UserIdentityConfiguration": { "IdentityAttributeName": "string" } }, "CreatedAt": number, "Description": "string", "Endpoints": [ { "Endpoint": "string", "EndpointType": "string" } ], "ErrorMessage": "string", "Id": "string", "IndexId": "string", "Name": "string", "RoleArn": "string", "Status": "string", "UpdatedAt": number }

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.

Configuration

Muestra la información de configuración de su experiencia de Amazon Kendra. Esto incluyeContentSourceConfiguration, que especifica los ID de la fuente de datos o los ID de las preguntas frecuentes yUserIdentityConfiguration, que especifica la información del usuario o grupo para conceder acceso a su experiencia de Amazon Kendra.

Tipo: objeto ExperienceConfiguration

CreatedAt

Muestra la fecha y hora en que se creó la experiencia de Amazon Kendra.

Type: Marca temporal

Description

Muestra la descripción de la experiencia de Amazon Kendra.

Type: Cadena

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

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

Endpoints

Muestra las URL de punto final de sus experiencias de Amazon Kendra. Las URL son únicas y están alojadas en su totalidad porAWS.

Type: Matriz deExperienceEndpointobjects

Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 2 elementos.

ErrorMessage

El motivo por el que tu experiencia con Amazon Kendra no se ha podido procesar correctamente.

Type: Cadena

Limitaciones de longitud Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

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

Id

Muestra el identificador de la experiencia de Amazon Kendra.

Type: Cadena

Limitaciones de longitud Longitud mínima de 1. La longitud máxima es de 36 caracteres.

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

IndexId

Muestra el identificador del índice de la experiencia de Amazon Kendra.

Type: Cadena

Limitaciones de longitud Longitud fija de 36.

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

Name

Muestra el nombre de la experiencia de Amazon Kendra.

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_-]*

RoleArn

Muestra el nombre de recurso de Amazon (ARN) de un rol con permiso para accederQueryAPI,QuerySuggestionsAPI,SubmitFeedbackAPI yIAM Identity Centerque almacena la información del usuario y el grupo.

Type: Cadena

Limitaciones de longitud La longitud mínima es 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}

Status

El estado de procesamiento actual de su experiencia con Amazon Kendra. Cuando el estado esACTIVE, ya se puede utilizar la experiencia de Amazon Kendra. Cuando el estado esFAILED, elErrorMessagecontiene el motivo por el que falló.

Type: Cadena

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

UpdatedAt

Muestra la fecha y hora en que se actualizó por última vez la experiencia de Amazon Kendra.

Type: Marca temporal

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: