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

DescribeDataSource

Obtiene información sobre un origen de datos de Amazon Kendra.

Sintaxis de la solicitud

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

Id

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

Obligatorio: Sí

IndexId

El identificador del índice que se utiliza 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í

Sintaxis de la respuesta

{ "Configuration": { "AlfrescoConfiguration": { "BlogFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "CrawlComments": boolean, "CrawlSystemFolders": boolean, "DocumentLibraryFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ], "EntityFilter": [ "string" ], "ExclusionPatterns": [ "string" ], "InclusionPatterns": [ "string" ], "SecretArn": "string", "SiteId": "string", "SiteUrl": "string", "SslCertificateS3Path": { "Bucket": "string", "Key": "string" }, "VpcConfiguration": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] }, "WikiFieldMappings": [ { "DataSourceFieldName": "string", "DateFieldFormat": "string", "IndexFieldName": "string" } ] }, "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": { "AuthenticationType": "string", "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 } }, "CreatedAt": number, "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", "ErrorMessage": "string", "Id": "string", "IndexId": "string", "LanguageCode": "string", "Name": "string", "RoleArn": "string", "Schedule": "string", "Status": "string", "Type": "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

Detalles de configuración de la fuente de datos. Esto muestra cómo está configurada la fuente de datos. Las opciones de configuración de una fuente de datos dependen del proveedor de la fuente de datos.

Tipo: objeto DataSourceConfiguration

CreatedAt

Marca temporal Unix del momento en que se creó el origen de datos.

Type: Marca temporal

CustomDocumentEnrichmentConfiguration

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

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

Tipo: objeto CustomDocumentEnrichmentConfiguration

Description

La 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}*$

ErrorMessage

Cuando elStatusvalor del campo esFAILED, elErrorMessagecontiene una descripción del error que provocó que el origen de datos fallara.

Type: Cadena

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

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

Id

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

IndexId

El identificador del índice que contiene el origen de datos.

Type: Cadena

Restricciones de longitud Longitud fija de 36.

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

LanguageCode

El código de un idioma. Muestra un idioma admitido para todos los documentos de la fuente de datos. El inglés se admite de forma predeterminada. Para obtener más información sobre los lenguajes admitidos por, incluidos sus códigos, consulteAgregar 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-]*

Name

El nombre del 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_-]*

RoleArn

El Nombre de recurso de Amazon (ARN) del rol de que concede acceso al origen de datos a sus recursos.

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}

Schedule

Calendario para que Amazon Kendra actualice el índice.

Type: Cadena

Status

El estado actual del origen de datos. Cuando el estado esACTIVEel origen de datos está listo para usar. Cuando el estado esFAILED, elErrorMessagecontiene el motivo por el que falló la fuente de datos.

Type: Cadena

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

Type

El tipo del 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 | ALFRESCO

UpdatedAt

Marca temporal Unix de cuando se actualizó el origen de datos por última vez.

Type: Marca temporal

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

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: