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. For the format of the file, see Access control for S3 data sources.
- 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."-
- Authentication
Configuration Provides the configuration information to connect to websites that require user authentication.
- Basic
Authentication Configuration Provides the configuration information to connect to websites that require basic user authentication.
- 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
BatchDeleteDocumentoperation.- Batch
GetDocument Status Request - Batch
GetDocument Status Response - Batch
GetDocument Status Response Error Provides a response when the status of a document could not be retrieved.
- 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 enterprise edition index. You can add and remove capacity units to tune an index to your requirements.
- Clear
Query Suggestions Request - Click
Feedback Gathers information about when a particular result was clicked by a user. Your application uses the
SubmitFeedbackoperation to provide click information.- Column
Configuration Provides information about how Amazon Kendra should use the columns of a database in an index.
- Confluence
Attachment Configuration Specifies the attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.
- Confluence
Attachment ToIndex Field Mapping Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the
UpdateIndexoperation.- Confluence
Blog Configuration Specifies the blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the
ExclusionPatternsorInclusionPatternsfields in theConfluenceConfigurationtype.- Confluence
Blog ToIndex Field Mapping Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the
UpdateIndexoperation.- Confluence
Configuration Provides configuration information for data sources that connect to Confluence.
- Confluence
Page Configuration Specifies the page settings for the Confluence data source.
- Confluence
Page ToIndex Field Mapping Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the
UpdateIndexoperation.- Confluence
Space Configuration Specifies the configuration for indexing Confluence spaces.
- Confluence
Space ToIndex Field Mapping Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.
You must first create the index field using the
UpdateIndexoperation.- 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 - Create
Query Suggestions Block List Request - Create
Query Suggestions Block List Response - Create
Thesaurus Request - Create
Thesaurus 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 the
DescribeDataSourceoperation.- 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 data source 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
UpdateIndexoperation.- 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 - Delete
Query Suggestions Block List Request - Delete
Thesaurus Request - Describe
Data Source Request - Describe
Data Source Response - Describe
FaqRequest - Describe
FaqResponse - Describe
Index Request - Describe
Index Response - Describe
Query Suggestions Block List Request - Describe
Query Suggestions Block List Response - Describe
Query Suggestions Config Request - Describe
Query Suggestions Config Response - Describe
Thesaurus Request - Describe
Thesaurus 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
Info Identifies a document for which to retrieve status information
- Document
Metadata Configuration Specifies the properties of a custom index field.
- Document
Relevance Configuration Overrides the document relevance 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.
- GetQuery
Suggestions Request - GetQuery
Suggestions Response - Google
Drive Configuration Provides configuration information for data sources that connect to Google Drive.
- 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.
- Json
Token Type Configuration Configuration information for the JSON token type.
- JwtToken
Type Configuration Configuration information for the JWT token type.
- 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
Query Suggestions Block Lists Request - List
Query Suggestions Block Lists Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Thesauri Request - List
Thesauri 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.
- Proxy
Configuration Provides the configuration information for a web proxy to connect to website hosts.
- 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.
- Query
Suggestions Block List Summary Summary information on a query suggestions block list.
This includes information on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
- 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
SubmitFeedbackoperation 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 knowledge 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 configuration information for indexing a single standard object.
- Score
Attributes Provides a relative ranking that indicates how confident Amazon Kendra is that the response matches the query.
- Search
Provides information about how a custom index field is used during a search.
- Seed
UrlConfiguration Provides the configuration information of the seed or starting point URLs to crawl.
When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
- 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.
- Site
Maps Configuration Provides the configuration information of the sitemap URLs to crawl.
When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
- Sorting
Configuration Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the
Sortableflag set totrue, otherwise Amazon Kendra returns an exception.You can sort attributes of the following types.
-
Date value
-
Long value
-
String value
You can't sort attributes of the following type.
-
String list value
-
- SqlConfiguration
Provides information that configures Amazon Kendra to use a SQL database.
- Start
Data Source Sync JobRequest - Start
Data Source Sync JobResponse - Status
Provides information about the status of documents submitted for indexing.
- Stop
Data Source Sync JobRequest - Submit
Feedback Request - Suggestion
A single query suggestion.
- Suggestion
Highlight The text highlights for a single query suggestion.
- Suggestion
Text With Highlights Provides text and information about where to highlight the query suggestion text.
- Suggestion
Value The
SuggestionTextWithHighlightsstructure information.- 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.
- Thesaurus
Summary An array of summary information for one or more thesauruses.
- Time
Range Provides a range of time.
- Untag
Resource Request - Untag
Resource Response - Update
Data Source Request - Update
Index Request - Update
Query Suggestions Block List Request - Update
Query Suggestions Config Request - Update
Thesaurus Request - Urls
Provides the configuration information of the URLs to crawl.
When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.
- User
Context Provides information about the user context for a Amazon Kendra index.
- User
Token Configuration Provides configuration information for a token configuration.
- WebCrawler
Configuration Provides the configuration information required for Amazon Kendra web crawler.
Enums§
- Batch
Delete Document Error - Errors returned by BatchDeleteDocument
- Batch
GetDocument Status Error - Errors returned by BatchGetDocumentStatus
- Batch
PutDocument Error - Errors returned by BatchPutDocument
- Clear
Query Suggestions Error - Errors returned by ClearQuerySuggestions
- Create
Data Source Error - Errors returned by CreateDataSource
- Create
FaqError - Errors returned by CreateFaq
- Create
Index Error - Errors returned by CreateIndex
- Create
Query Suggestions Block List Error - Errors returned by CreateQuerySuggestionsBlockList
- Create
Thesaurus Error - Errors returned by CreateThesaurus
- Delete
Data Source Error - Errors returned by DeleteDataSource
- Delete
FaqError - Errors returned by DeleteFaq
- Delete
Index Error - Errors returned by DeleteIndex
- Delete
Query Suggestions Block List Error - Errors returned by DeleteQuerySuggestionsBlockList
- Delete
Thesaurus Error - Errors returned by DeleteThesaurus
- Describe
Data Source Error - Errors returned by DescribeDataSource
- Describe
FaqError - Errors returned by DescribeFaq
- Describe
Index Error - Errors returned by DescribeIndex
- Describe
Query Suggestions Block List Error - Errors returned by DescribeQuerySuggestionsBlockList
- Describe
Query Suggestions Config Error - Errors returned by DescribeQuerySuggestionsConfig
- Describe
Thesaurus Error - Errors returned by DescribeThesaurus
- GetQuery
Suggestions Error - Errors returned by GetQuerySuggestions
- 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
Query Suggestions Block Lists Error - Errors returned by ListQuerySuggestionsBlockLists
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Thesauri Error - Errors returned by ListThesauri
- 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
- Update
Query Suggestions Block List Error - Errors returned by UpdateQuerySuggestionsBlockList
- Update
Query Suggestions Config Error - Errors returned by UpdateQuerySuggestionsConfig
- Update
Thesaurus Error - Errors returned by UpdateThesaurus
Traits§
- Kendra
- Trait representing the capabilities of the kendra API. kendra clients implement this trait.