DescribeDataSource
Gets information about a Amazon Kendra data source.
Request Syntax
{
"Id": "string
",
"IndexId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Id
-
The unique identifier of the data source to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*
Required: Yes
- IndexId
-
The identifier of the index that contains the data source.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]*
Required: Yes
Response Syntax
{
"Configuration": {
"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" ]
}
},
"GoogleDriveConfiguration": {
"ExcludeMimeTypes": [ "string" ],
"ExcludeSharedDrives": [ "string" ],
"ExcludeUserAccounts": [ "string" ],
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"SecretArn": "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"
},
"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": {
"HostUrl": "string",
"KnowledgeArticleConfiguration": {
"CrawlAttachments": boolean,
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"ExcludeAttachmentFilePatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "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",
"Urls": [ "string" ],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
}
},
"CreatedAt": number,
"Description": "string",
"ErrorMessage": "string",
"Id": "string",
"IndexId": "string",
"Name": "string",
"RoleArn": "string",
"Schedule": "string",
"Status": "string",
"Type": "string",
"UpdatedAt": number
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Configuration
-
Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.
Type: DataSourceConfiguration object
- CreatedAt
-
The Unix timestamp of when the data source was created.
Type: Timestamp
- Description
-
The description of the data source.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
^\P{C}*$
- ErrorMessage
-
When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source to fail.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\P{C}*$
- Id
-
The identifier of the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*
- IndexId
-
The identifier of the index that contains the data source.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]*
- Name
-
The name that you gave the data source when it was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*
- RoleArn
-
The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1284.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
- Schedule
-
The schedule that Amazon Kendra will update the data source.
Type: String
- Status
-
The current status of the data source. When the status is
ACTIVE
the data source is ready to use. When the status isFAILED
, theErrorMessage
field contains the reason that the data source failed.Type: String
Valid Values:
CREATING | DELETING | FAILED | UPDATING | ACTIVE
- Type
-
The type of the data source.
Type: String
Valid Values:
S3 | SHAREPOINT | DATABASE | SALESFORCE | ONEDRIVE | SERVICENOW | CUSTOM | CONFLUENCE | GOOGLEDRIVE
- UpdatedAt
-
The Unix timestamp of when the data source was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 400
- InternalServerException
-
HTTP Status Code: 500
- ResourceNotFoundException
-
HTTP Status Code: 400
- ThrottlingException
-
HTTP Status Code: 400
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: