Expand description
Amazon Kendra is a service for indexing large document sets.
If you’re using the service, you’re probably looking for KendraClient and Kendra.
Structs§
- Access
Control List Configuration Access Control List files for the documents in a data source.
- AclConfiguration
Provides information about the column that should be used for filtering the query response by groups.
- Additional
Result Attribute An attribute returned from an index query.
- Additional
Result Attribute Value An attribute returned with a document from a search.
- Attribute
Filter Provides filtering the query results based on document attributes.
When you use the
AndAllFiltersorOrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:<AndAllFilters>-
<OrAllFilters> -
<EqualTo>
If you use more than 2 layers, you receive a
ValidationExceptionexception with the message "AttributeFiltercannot have a depth of more than 2."-
- Batch
Delete Document Request - Batch
Delete Document Response - Batch
Delete Document Response Failed Document Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation.
- Batch
PutDocument Request - Batch
PutDocument Response - Batch
PutDocument Response Failed Document Provides information about a document that could not be indexed.
- Capacity
Units Configuration Specifies capacity units configured for your index. You can add and remove capacity units to tune an index to your requirements.
- Click
Feedback Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback operation to provide click information.
- Column
Configuration Provides information about how Amazon Kendra should use the columns of a database in an index.
- Connection
Configuration Provides the information necessary to connect to a database.
- Create
Data Source Request - Create
Data Source Response - Create
FaqRequest - Create
FaqResponse - Create
Index Request - Create
Index Response - Data
Source Configuration Configuration information for a Amazon Kendra data source.
- Data
Source Summary Summary information for a Amazon Kendra data source. Returned in a call to .
- Data
Source Sync Job Provides information about a synchronization job.
- Data
Source Sync JobMetric Target Maps a particular data source sync job to a particular data source.
- Data
Source Sync JobMetrics Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a connector.
- Data
Source ToIndex Field Mapping 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.
- Data
Source VpcConfiguration Provides information for connecting to an Amazon VPC.
- Database
Configuration Provides the information necessary to connect a database to an index.
- Delete
Data Source Request - Delete
FaqRequest - Delete
Index Request - Describe
Data Source Request - Describe
Data Source Response - Describe
FaqRequest - Describe
FaqResponse - Describe
Index Request - Describe
Index Response - Document
A document in an index.
- Document
Attribute A custom attribute value assigned to a document.
- Document
Attribute Value The value of a custom document attribute. You can only provide one value for a custom attribute.
- Document
Attribute Value Count Pair Provides the count of documents that match a particular attribute when doing a faceted search.
- Document
Metadata Configuration Specifies the properties of a custom index field.
- Documents
Metadata Configuration 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.
- Facet
Information about a document attribute
- Facet
Result The facet values for the documents in the response.
- FaqStatistics
Provides statistical information about the FAQ questions and answers contained in an index.
- FaqSummary
Provides information about a frequently asked questions and answer contained in an index.
- Highlight
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
- Index
Configuration Summary A summary of information about an index.
- Index
Statistics Provides information about the number of documents and the number of questions and answers in an index.
- Kendra
Client - A client for the kendra API.
- List
Data Source Sync Jobs Request - List
Data Source Sync Jobs Response - List
Data Sources Request - List
Data Sources Response - List
Faqs Request - List
Faqs Response - List
Indices Request - List
Indices Response - List
Tags ForResource Request - List
Tags ForResource Response - OneDrive
Configuration Provides configuration information for data sources that connect to OneDrive.
- OneDrive
Users User accounts whose documents should be indexed.
- Principal
Provides user and group information for document access filtering.
- Query
Request - Query
Result - Query
Result Item A single query result.
A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
- Relevance
Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
- Relevance
Feedback Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback operation to provide relevance information.
- S3Data
Source Configuration Provides configuration information for a data source to index documents in an Amazon S3 bucket.
- S3Path
Information required to find a specific file in an Amazon S3 bucket.
- Salesforce
Chatter Feed Configuration Defines configuration for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.
- Salesforce
Configuration Provides configuration information for connecting to a Salesforce data source.
- Salesforce
Custom Knowledge Article Type Configuration Provides configuration information for indexing Salesforce custom articles.
- Salesforce
Knowledge Article Configuration 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
- Salesforce
Standard Knowledge Article Type Configuration Provides configuration information for standard Salesforce knowledge articles.
- Salesforce
Standard Object Attachment Configuration Provides configuration information for processing attachments to Salesforce standard objects.
- Salesforce
Standard Object Configuration Specifies confguration information for indexing a single standard object.
- Search
Provides information about how a custom index field is used during a search.
- Server
Side Encryption Configuration Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
- Service
NowConfiguration Provides configuration information required to connect to a ServiceNow data source.
- Service
NowKnowledge Article Configuration Provides configuration information for crawling knowledge articles in the ServiceNow site.
- Service
NowService Catalog Configuration Provides configuration information for crawling service catalog items in the ServiceNow site
- Share
Point Configuration Provides configuration information for connecting to a Microsoft SharePoint data source.
- Start
Data Source Sync JobRequest - Start
Data Source Sync JobResponse - Stop
Data Source Sync JobRequest - Submit
Feedback Request - Tag
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- TagResource
Request - TagResource
Response - Text
Document Statistics Provides information about text documents indexed in an index.
- Text
With Highlights Provides text and information about where to highlight the text.
- Time
Range Provides a range of time.
- Untag
Resource Request - Untag
Resource Response - Update
Data Source Request - Update
Index Request
Enums§
- Batch
Delete Document Error - Errors returned by BatchDeleteDocument
- Batch
PutDocument Error - Errors returned by BatchPutDocument
- Create
Data Source Error - Errors returned by CreateDataSource
- Create
FaqError - Errors returned by CreateFaq
- Create
Index Error - Errors returned by CreateIndex
- Delete
Data Source Error - Errors returned by DeleteDataSource
- Delete
FaqError - Errors returned by DeleteFaq
- Delete
Index Error - Errors returned by DeleteIndex
- Describe
Data Source Error - Errors returned by DescribeDataSource
- Describe
FaqError - Errors returned by DescribeFaq
- Describe
Index Error - Errors returned by DescribeIndex
- List
Data Source Sync Jobs Error - Errors returned by ListDataSourceSyncJobs
- List
Data Sources Error - Errors returned by ListDataSources
- List
Faqs Error - Errors returned by ListFaqs
- List
Indices Error - Errors returned by ListIndices
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Query
Error - Errors returned by Query
- Start
Data Source Sync JobError - Errors returned by StartDataSourceSyncJob
- Stop
Data Source Sync JobError - Errors returned by StopDataSourceSyncJob
- Submit
Feedback Error - Errors returned by SubmitFeedback
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Data Source Error - Errors returned by UpdateDataSource
- Update
Index Error - Errors returned by UpdateIndex
Traits§
- Kendra
- Trait representing the capabilities of the kendra API. kendra clients implement this trait.