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

CreateDataSource

Crea un origen de datos que se desea utilizar con un índice de Amazon Kendra.

Especifique un nombre, un tipo de conector de origen de datos y una descripción para el origen de datos. También se especifica la información de configuración para el conector de origen de datos.

CreateDataSourcees una operación síncrona. La operación devuelve 200 si el origen de datos se ha creado correctamente. En caso contrario, se genera una excepción.

Amazon S3 ypersonalizadolas fuentes de datos son las únicas fuentes de datos admitidas en elAWS GovCloud (EE.UU.-Oeste).

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", "Configuration": { "BoxConfiguration": { "CommentFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "CrawlComments": boolean, "CrawlTasks": boolean, "CrawlWebLinks": boolean, "EnterpriseId": "string", "ExclusionPatterns": [ "string" ], "FileFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "InclusionPatterns": [ "string" ], "SecretArn": "string", "TaskFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "UseChangeLog": boolean, "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] }, "WebLinkFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] }, "ConfluenceConfiguration": { "AttachmentConfiguration": { "AttachmentFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "CrawlAttachments": boolean }, "BlogConfiguration": { "BlogFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] }, "ExclusionPatterns": [ "string" ], "InclusionPatterns": [ "string" ], "PageConfiguration": { "PageFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] }, "SecretArn": "string", "ServerUrl": "string", "SpaceConfiguration": { "CrawlArchivedSpaces": boolean, "CrawlPersonalSpaces": boolean, "ExcludeSpaces": [ "string" ], "IncludeSpaces": [ "string" ], "SpaceFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] }, "Version": "string", "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } }, "DatabaseConfiguration": { "AclConfiguration": { "AllowedGroupsColumnName": "string" }, "ColumnConfiguration": { "ChangeDetectingColumns": [ "string" ], "DocumentDataColumnName": "string", "DocumentIdColumnName": "string", "DocumentTitleColumnName": "string", "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] }, "ConnectionConfiguration": { "DatabaseHost": "string", "DatabaseName": "string", "DatabasePort": number, "SecretArn": "string", "TableName": "string" }, "DatabaseEngineType": "string", "SqlConfiguration": { "QueryIdentifiersEnclosingOption": "string" }, "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } }, "FsxConfiguration": { "ExclusionPatterns": [ "string" ], "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "FileSystemId": "string", "FileSystemType": "string", "InclusionPatterns": [ "string" ], "SecretArn": "string", "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } }, "GitHubConfiguration": { "ExclusionFileNamePatterns": [ "string" ], "ExclusionFileTypePatterns": [ "string" ], "ExclusionFolderNamePatterns": [ "string" ], "GitHubCommitConfigurationFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "GitHubDocumentCrawlProperties": { "CrawlIssue": boolean, "CrawlIssueComment": boolean, "CrawlIssueCommentAttachment": boolean, "CrawlPullRequest": boolean, "CrawlPullRequestComment": boolean, "CrawlPullRequestCommentAttachment": boolean, "CrawlRepositoryDocuments": boolean }, "GitHubIssueAttachmentConfigurationFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "GitHubIssueCommentConfigurationFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "GitHubIssueDocumentConfigurationFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "GitHubPullRequestCommentConfigurationFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "GitHubPullRequestDocumentAttachmentConfigurationFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "GitHubPullRequestDocumentConfigurationFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "GitHubRepositoryConfigurationFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "InclusionFileNamePatterns": [ "string" ], "InclusionFileTypePatterns": [ "string" ], "InclusionFolderNamePatterns": [ "string" ], "OnPremiseConfiguration": { "HostUrl": "string", "OrganizationName": "string", "SslCertificateS3Path": { "Bucket": "string", "Key": "string" } }, "RepositoryFilter": [ "string" ], "SaaSConfiguration": { "HostUrl": "string", "OrganizationName": "string" }, "SecretArn": "string", "Type": "string", "UseChangeLog": boolean, "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } }, "GoogleDriveConfiguration": { "ExcludeMimeTypes": [ "string" ], "ExcludeSharedDrives": [ "string" ], "ExcludeUserAccounts": [ "string" ], "ExclusionPatterns": [ "string" ], "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "InclusionPatterns": [ "string" ], "SecretArn": "string" }, "JiraConfiguration": { "AttachmentFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "CommentFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "ExclusionPatterns": [ "string" ], "InclusionPatterns": [ "string" ], "IssueFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "IssueSubEntityFilter": [ "string" ], "IssueType": [ "string" ], "JiraAccountUrl": "string", "Project": [ "string" ], "ProjectFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "SecretArn": "string", "Status": [ "string" ], "UseChangeLog": boolean, "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] }, "WorkLogFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] }, "OneDriveConfiguration": { "DisableLocalGroups": boolean, "ExclusionPatterns": [ "string" ], "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "InclusionPatterns": [ "string" ], "OneDriveUsers": { "OneDriveUserList": [ "string" ], "OneDriveUserS3Path": { "Bucket": "string", "Key": "string" } }, "SecretArn": "string", "TenantDomain": "string" }, "QuipConfiguration": { "AttachmentFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "CrawlAttachments": boolean, "CrawlChatRooms": boolean, "CrawlFileComments": boolean, "Domain": "string", "ExclusionPatterns": [ "string" ], "FolderIds": [ "string" ], "InclusionPatterns": [ "string" ], "MessageFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "SecretArn": "string", "ThreadFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } }, "S3Configuration": { "AccessControlListConfiguration": { "KeyPath": "string" }, "BucketName": "string", "DocumentsMetadataConfiguration": { "S3Prefix": "string" }, "ExclusionPatterns": [ "string" ], "InclusionPatterns": [ "string" ], "InclusionPrefixes": [ "string" ] }, "SalesforceConfiguration": { "ChatterFeedConfiguration": { "DocumentDataFieldName": "string", "DocumentTitleFieldName": "string", "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "IncludeFilterTypes": [ "string" ] }, "CrawlAttachments": boolean, "ExcludeAttachmentFilePatterns": [ "string" ], "IncludeAttachmentFilePatterns": [ "string" ], "KnowledgeArticleConfiguration": { "CustomKnowledgeArticleTypeConfigurations": [ { "DocumentDataFieldName": "string", "DocumentTitleFieldName": "string", "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "Name": "string" } ], "IncludedStates": [ "string" ], "StandardKnowledgeArticleTypeConfiguration": { "DocumentDataFieldName": "string", "DocumentTitleFieldName": "string", "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] } }, "SecretArn": "string", "ServerUrl": "string", "StandardObjectAttachmentConfiguration": { "DocumentTitleFieldName": "string", "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] }, "StandardObjectConfigurations": [ { "DocumentDataFieldName": "string", "DocumentTitleFieldName": "string", "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "Name": "string" } ] }, "ServiceNowConfiguration": { "AuthenticationType": "string", "HostUrl": "string", "KnowledgeArticleConfiguration": { "CrawlAttachments": boolean, "DocumentDataFieldName": "string", "DocumentTitleFieldName": "string", "ExcludeAttachmentFilePatterns": [ "string" ], "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "FilterQuery": "string", "IncludeAttachmentFilePatterns": [ "string" ] }, "SecretArn": "string", "ServiceCatalogConfiguration": { "CrawlAttachments": boolean, "DocumentDataFieldName": "string", "DocumentTitleFieldName": "string", "ExcludeAttachmentFilePatterns": [ "string" ], "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "IncludeAttachmentFilePatterns": [ "string" ] }, "ServiceNowBuildVersion": "string" }, "SharePointConfiguration": { "CrawlAttachments": boolean, "DisableLocalGroups": boolean, "DocumentTitleFieldName": "string", "ExclusionPatterns": [ "string" ], "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "InclusionPatterns": [ "string" ], "SecretArn": "string", "SharePointVersion": "string", "SslCertificateS3Path": { "Bucket": "string", "Key": "string" }, "Urls": [ "string" ], "UseChangeLog": boolean, "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } }, "SlackConfiguration": { "CrawlBotMessage": boolean, "ExcludeArchived": boolean, "ExclusionPatterns": [ "string" ], "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "InclusionPatterns": [ "string" ], "LookBackPeriod": number, "PrivateChannelFilter": [ "string" ], "PublicChannelFilter": [ "string" ], "SecretArn": "string", "SinceCrawlDate": "string", "SlackEntityList": [ "string" ], "TeamId": "string", "UseChangeLog": boolean, "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } }, "WebCrawlerConfiguration": { "AuthenticationConfiguration": { "BasicAuthentication": [ { "Credentials": "string", "Host": "string", "Port": number } ] }, "CrawlDepth": number, "MaxContentSizePerPageInMegaBytes": number, "MaxLinksPerPage": number, "MaxUrlsPerMinuteCrawlRate": number, "ProxyConfiguration": { "Credentials": "string", "Host": "string", "Port": number }, "UrlExclusionPatterns": [ "string" ], "UrlInclusionPatterns": [ "string" ], "Urls": { "SeedUrlConfiguration": { "SeedUrls": [ "string" ], "WebCrawlerMode": "string" }, "SiteMapsConfiguration": { "SiteMaps": [ "string" ] } } }, "WorkDocsConfiguration": { "CrawlComments": boolean, "ExclusionPatterns": [ "string" ], "FieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "InclusionPatterns": [ "string" ], "OrganizationId": "string", "UseChangeLog": boolean } }, "CustomDocumentEnrichmentConfiguration": { "InlineConfigurations": [ { "Condition": { "ConditionDocumentAttributeKey": "string", "ConditionOnValue": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" }, "Operator": "string" }, "DocumentContentDeletion": boolean, "Target": { "TargetDocumentAttributeKey": "string", "TargetDocumentAttributeValue": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" }, "TargetDocumentAttributeValueDeletion": boolean } } ], "PostExtractionHookConfiguration": { "InvocationCondition": { "ConditionDocumentAttributeKey": "string", "ConditionOnValue": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" }, "Operator": "string" }, "LambdaArn": "string", "S3Bucket": "string" }, "PreExtractionHookConfiguration": { "InvocationCondition": { "ConditionDocumentAttributeKey": "string", "ConditionOnValue": { "DateValue": number, "LongValue": number, "StringListValue": [ "string" ], "StringValue": "string" }, "Operator": "string" }, "LambdaArn": "string", "S3Bucket": "string" }, "RoleArn": "string" }, "Description": "string", "IndexId": "string", "LanguageCode": "string", "Name": "string", "RoleArn": "string", "Schedule": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" }

Parámetros de solicitud

Para obtener información acerca de 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 origen de datos. Múltiples llamadas alCreateDataSourceLa API con el mismo token de cliente creará solo un origen de datos.

Type: Cadena

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

Obligatorio: No

Configuration

Información de configuración necesaria para acceder al repositorio de origen de datos.

No se puede especificar el parámetro Configuration cuando el parámetro Type está establecido en CUSTOM. Si lo haces, recibirás unValidationExceptionexcepción.

El parámetro Configuration es necesario para todos los demás orígenes de datos.

Tipo: objeto DataSourceConfiguration

Obligatorio: No

CustomDocumentEnrichmentConfiguration

Información de configuración para modificar los metadatos y el contenido del documento durante el proceso de ingesta de documentos al crear un origen de datos.

Para obtener más información sobre cómo crear, modificar y eliminar metadatos de documentos, o realizar otras modificaciones de contenido al ingerir documentos en Amazon Kendra, consultePersonalización de metadatos de documentos durante el proceso de ingesta.

Tipo: objeto CustomDocumentEnrichmentConfiguration

Obligatorio: No

Description

Una descripción del origen de datos.

Type: Cadena

Restricciones 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 que se desea utilizar con el origen de datos.

Type: Cadena

Restricciones de longitud: Longitud fija de 36.

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

Obligatorio: Sí

LanguageCode

El código de un idioma. Esto le permite admitir un idioma para todos los documentos al crear la fuente de datos. El inglés se admite de forma predeterminada. Para obtener más información acerca de los lenguajes admitidos por, incluidos sus códigos, consulteAñadir documentos en idiomas distintos del inglés.

Type: Cadena

Restricciones de longitud: Longitud mínima de 2. La longitud máxima es de 10. caracteres.

Patrón: [a-zA-Z-]*

Obligatorio: No

Name

Un nombre único para el origen de datos. El nombre de un origen de datos no se puede cambiar sin eliminar y volver a crear el origen de datos.

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

El nombre de recurso de Amazon (ARN) de un rol con permiso para acceder al origen de datos. Para obtener más información, consulteIAM Roles for Amazon Kendra.

No se puede especificar el parámetro RoleArn cuando el parámetro Type está establecido en CUSTOM. Si lo haces, recibirás unValidationExceptionexcepción.

El parámetro RoleArn es necesario para todos los demás orígenes de datos.

Type: Cadena

Restricciones 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

Schedule

Establece la frecuencia para que Amazon Kendra compruebe los documentos de su repositorio y actualice el índice. Si no establece una programación, Amazon Kendra no actualizará periódicamente el índice. Puede llamar alStartDataSourceSyncJobAPI para actualizar el índice.

No se puede especificar el parámetro Schedule cuando el parámetro Type está establecido en CUSTOM. Si lo haces, recibirás unValidationExceptionexcepción.

Type: Cadena

Obligatorio: No

Tags

Lista de pares clave-valor que identifican el origen de datos. Puede utilizar las etiquetas para identificar y organizar los recursos de, así como para controlar el acceso a los recursos.

Type: Matriz deTagobjects

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

Obligatorio: No

Type

El tipo de repositorio que contiene el origen de datos.

Type: Cadena

Valores válidos: S3 | SHAREPOINT | DATABASE | SALESFORCE | ONEDRIVE | SERVICENOW | CUSTOM | CONFLUENCE | GOOGLEDRIVE | WEBCRAWLER | WORKDOCS | FSX | SLACK | BOX | QUIP | JIRA | GITHUB

Obligatorio: Sí

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

Un identificador único del origen de datos.

Type: Cadena

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

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

Errores

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

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: