CreateExperience - Amazon Kendra
Sintaxis de la solicitudParámetros de solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

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.

CreateExperience

Crea una 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, incluido el uso de los SDK de Python y Java, consulteCreación de una experiencia de búsqueda sin código.

Sintaxis de la solicitud

{
   "ClientToken": "string",
   "Configuration": { 
      "ContentSourceConfiguration": { 
         "DataSourceIds": [ "string" ],
         "DirectPutContent": boolean,
         "FaqIds": [ "string" ]
      },
      "UserIdentityConfiguration": { 
         "IdentityAttributeName": "string"
      }
   },
   "Description": "string",
   "IndexId": "string",
   "Name": "string",
   "RoleArn": "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 proporcionas para identificar la solicitud de creación de tu experiencia de Amazon Kendra. Múltiples llamadas alCreateExperienceLa API con el mismo token de cliente crea solo una experiencia de Amazon Kendra.

Type: Cadena

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

Obligatorio: No

Configuration

Información de configuración para su experiencia de Amazon Kendra. Esto incluyeContentSourceConfiguration, que especifica los ID de origen de datos y/o los ID de preguntas frecuentes, yUserIdentityConfiguration, que especifica la información de usuario o grupo para conceder acceso a su experiencia de Amazon Kendra.

Tipo: objeto ExperienceConfiguration

Obligatorio: No

Description

Descripción de tu experiencia de Amazon Kendra.

Type: Cadena

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

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

Obligatorio: No

IndexId

El identificador del índice para su 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í

Name

Un nombre para tu 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_-]*

Obligatorio: Sí

RoleArn

El nombre de recurso de Amazon (ARN) de un rol con permiso para accederQueryAPI,QuerySuggestionsAPI,SubmitFeedbackAPI yIAM Identity Centerque almacena la información de usuario y grupo. Para obtener más información, consulteRoles de IAM para Amazon Kendra.

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

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 de la experiencia de Amazon Kendra creada.

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

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: