[ aws . kendra ]

describe-data-source

Description

Gets information about a Amazon Kendra data source.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-data-source
--id <value>
--index-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--id (string)

The unique identifier of the data source to describe.

--index-id (string)

The identifier of the index that contains the data source.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Id -> (string)

The identifier of the data source.

IndexId -> (string)

The identifier of the index that contains the data source.

Name -> (string)

The name that you gave the data source when it was created.

Type -> (string)

The type of the data source.

Configuration -> (structure)

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.

S3Configuration -> (structure)

Provides information to create a connector for a document repository in an Amazon S3 bucket.

BucketName -> (string)

The name of the bucket that contains the documents.

InclusionPrefixes -> (list)

A list of S3 prefixes for the documents that should be included in the index.

(string)

ExclusionPatterns -> (list)

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia .

(string)

DocumentsMetadataConfiguration -> (structure)

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

S3Prefix -> (string)

A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

AccessControlListConfiguration -> (structure)

Provides the path to the S3 bucket that contains the user context filtering files for the data source.

KeyPath -> (string)

Path to the AWS S3 bucket that contains the ACL files.

SharePointConfiguration -> (structure)

Provides information necessary to create a connector for a Microsoft SharePoint site.

SharePointVersion -> (string)

The version of Microsoft SharePoint that you are using as a data source.

Urls -> (list)

The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

(string)

SecretArn -> (string)

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source . For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

CrawlAttachments -> (boolean)

TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE .

UseChangeLog -> (boolean)

Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

InclusionPatterns -> (list)

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

(string)

ExclusionPatterns -> (list)

A list of regulary expression patterns. Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

(string)

VpcConfiguration -> (structure)

Provides information for connecting to an Amazon VPC.

SubnetIds -> (list)

A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

(string)

SecurityGroupIds -> (list)

A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

(string)

FieldMappings -> (list)

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields .

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

DocumentTitleFieldName -> (string)

The Microsoft SharePoint attribute field that contains the title of the document.

DatabaseConfiguration -> (structure)

Provides information necessary to create a connector for a database.

DatabaseEngineType -> (string)

The type of database engine that runs the database.

ConnectionConfiguration -> (structure)

The information necessary to connect to a database.

DatabaseHost -> (string)

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

DatabasePort -> (integer)

The port that the database uses for connections.

DatabaseName -> (string)

The name of the database containing the document data.

TableName -> (string)

The name of the table that contains the document data.

SecretArn -> (string)

The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

VpcConfiguration -> (structure)

Provides information for connecting to an Amazon VPC.

SubnetIds -> (list)

A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

(string)

SecurityGroupIds -> (list)

A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

(string)

ColumnConfiguration -> (structure)

Information about where the index should get the document information from the database.

DocumentIdColumnName -> (string)

The column that provides the document’s unique identifier.

DocumentDataColumnName -> (string)

The column that contains the contents of the document.

DocumentTitleColumnName -> (string)

The column that contains the title of the document.

FieldMappings -> (list)

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

ChangeDetectingColumns -> (list)

One to five columns that indicate when a document in the database has changed.

(string)

AclConfiguration -> (structure)

Information about the database column that provides information for user context filtering.

AllowedGroupsColumnName -> (string)

A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

SalesforceConfiguration -> (structure)

Provides configuration information for data sources that connect to a Salesforce site.

ServerUrl -> (string)

The instance URL for the Salesforce site that you want to index.

SecretArn -> (string)

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

• authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

• consumerKey - The application public key generated when you created your Salesforce application.

• consumerSecret - The application private key generated when you created your Salesforce application.

• password - The password associated with the user logging in to the Salesforce instance.

• securityToken - The token associated with the user account logging in to the Salesforce instance.

• username - The user name of the user logging in to the Salesforce instance.

StandardObjectConfigurations -> (list)

Specifies the Salesforce standard objects that Amazon Kendra indexes.

(structure)

Specifies confguration information for indexing a single standard object.

Name -> (string)

The name of the standard object.

DocumentDataFieldName -> (string)

The name of the field in the standard object table that contains the document contents.

DocumentTitleFieldName -> (string)

The name of the field in the standard object table that contains the document titleB.

FieldMappings -> (list)

One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

KnowledgeArticleConfiguration -> (structure)

Specifies configuration information for the knowlege article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

IncludedStates -> (list)

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

(string)

StandardKnowledgeArticleTypeConfiguration -> (structure)

Provides configuration information for standard Salesforce knowledge articles.

DocumentDataFieldName -> (string)

The name of the field that contains the document data to index.

DocumentTitleFieldName -> (string)

The name of the field that contains the document title.

FieldMappings -> (list)

One or more objects that map fields in the knowledge article to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

CustomKnowledgeArticleTypeConfigurations -> (list)

Provides configuration information for custom Salesforce knowledge articles.

(structure)

Provides configuration information for indexing Salesforce custom articles.

Name -> (string)

The name of the configuration.

DocumentDataFieldName -> (string)

The name of the field in the custom knowledge article that contains the document data to index.

DocumentTitleFieldName -> (string)

The name of the field in the custom knowledge article that contains the document title.

FieldMappings -> (list)

One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

ChatterFeedConfiguration -> (structure)

Specifies configuration information for Salesforce chatter feeds.

DocumentDataFieldName -> (string)

The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

DocumentTitleFieldName -> (string)

The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title collumn.

FieldMappings -> (list)

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

IncludeFilterTypes -> (list)

Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

(string)

CrawlAttachments -> (boolean)

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

StandardObjectAttachmentConfiguration -> (structure)

Provides configuration information for processing attachments to Salesforce standard objects.

DocumentTitleFieldName -> (string)

The name of the field used for the document title.

FieldMappings -> (list)

One or more objects that map fields in attachments to Amazon Kendra index fields.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

IncludeAttachmentFilePatterns -> (list)

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

(string)

ExcludeAttachmentFilePatterns -> (list)

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

(string)

OneDriveConfiguration -> (structure)

Provided configuration for data sources that connect to Microsoft OneDrive.

TenantDomain -> (string)

Tha Azure Active Directory domain of the organization.

SecretArn -> (string)

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

OneDriveUsers -> (structure)

A list of user accounts whose documents should be indexed.

OneDriveUserList -> (list)

A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 100 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.

(string)

OneDriveUserS3Path -> (structure)

The S3 bucket location of a file containing a list of users whose documents should be indexed.

Bucket -> (string)

The name of the S3 bucket that contains the file.

Key -> (string)

The name of the file.

InclusionPatterns -> (list)

A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don’t match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The exclusion pattern is applied to the file name.

(string)

ExclusionPatterns -> (list)

List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn’t indexed.

The exclusion pattern is applied to the file name.

(string)

FieldMappings -> (list)

A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

ServiceNowConfiguration -> (structure)

Provides configuration for data sources that connect to ServiceNow instances.

HostUrl -> (string)

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

SecretArn -> (string)

The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.

ServiceNowBuildVersion -> (string)

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS .

KnowledgeArticleConfiguration -> (structure)

Provides configuration information for crawling knowledge articles in the ServiceNow site.

CrawlAttachments -> (boolean)

Indicates whether Amazon Kendra should index attachments to knowledge articles.

IncludeAttachmentFilePatterns -> (list)

List of regular expressions applied to knowledge articles. Items that don’t match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField .

(string)

ExcludeAttachmentFilePatterns -> (list)

List of regular expressions applied to knowledge articles. Items that don’t match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

(string)

DocumentDataFieldName -> (string)

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

DocumentTitleFieldName -> (string)

The name of the ServiceNow field that is mapped to the index document title field.

FieldMappings -> (list)

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

ServiceCatalogConfiguration -> (structure)

Provides configuration information for crawling service catalogs in the ServiceNow site.

CrawlAttachments -> (boolean)

Indicates whether Amazon Kendra should crawl attachments to the service catalog items.

IncludeAttachmentFilePatterns -> (list)

Determines the types of file attachments that are included in the index.

(string)

ExcludeAttachmentFilePatterns -> (list)

Determines the types of file attachments that are excluded from the index.

(string)

DocumentDataFieldName -> (string)

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

DocumentTitleFieldName -> (string)

The name of the ServiceNow field that is mapped to the index document title field.

FieldMappings -> (list)

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

(structure)

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

DataSourceFieldName -> (string)

The name of the column or attribute in the data source.

DateFieldFormat -> (string)

The type of data stored in the column or attribute.

IndexFieldName -> (string)

The name of the field in the index.

CreatedAt -> (timestamp)

The Unix timestamp of when the data source was created.

UpdatedAt -> (timestamp)

The Unix timestamp of when the data source was last updated.

Description -> (string)

The description of the data source.

Status -> (string)

The current status of the data source. When the status is ACTIVE the data source is ready to use. When the status is FAILED , the ErrorMessage field contains the reason that the data source failed.

Schedule -> (string)

The schedule that Amazon Kendra will update the data source.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.

ErrorMessage -> (string)

When the Status field value is FAILED , the ErrorMessage field contains a description of the error that caused the data source to fail.