Package-level declarations
Types
Summary information on an access control configuration that you created for your documents in an index.
Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources.
You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
Provides information about the column that should be used for filtering the query response by groups.
An attribute returned from an index query.
An attribute returned with a document from a search.
Provides the configuration information to connect to Alfresco as your data source.
Filters the search results based on document attributes or fields.
Gets information on the configuration of document fields/attributes that you want to base query suggestions on. To change your configuration, use AttributeSuggestionsUpdateConfig and then call UpdateQuerySuggestionsConfig.
Provides the configuration information for the document fields/attributes that you want to base query suggestions on.
Updates the configuration information for the document fields/attributes that you want to base query suggestions on.
Provides the configuration information to connect to websites that require user authentication.
Provides the configuration information to connect to websites that require basic user authentication.
Provides information about documents that could not be removed from an index by the BatchDeleteDocument
API.
Provides information about a set of featured results that couldn't be removed from an index by the BatchDeleteFeaturedResultsSet API.
Provides a response when the status of a document could not be retrieved.
Provides information about a document that could not be indexed.
Provides the configuration information to connect to Box as your data source.
Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.
Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback
API to provide click information.
Specifies how to group results by document attribute value, and how to display them collapsed/expanded under a designated primary document for each group.
Provides details about a collapsed group of search results.
Provides information about how Amazon Kendra should use the columns of a database in an index.
A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
Information about a conflicting query used across different sets of featured results. When you create a featured results set, you must check that the queries are unique per featured results set for each index.
Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to Confluence fields. For more information, see Mapping data source fields. The Confuence data source field names must exist in your Confluence custom metadata.
Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns
or InclusionPatterns
fields in the ConfluenceConfiguration
object.
Maps attributes or field names of Confluence blog to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
Provides the configuration information to connect to Confluence as your data source.
Configuration of the page settings for the Confluence data source.
Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
Configuration information for indexing Confluence spaces.
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex
API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
Provides the configuration information that's required to connect to a database.
Provides the configuration information for your content sources, such as data sources, FAQs, and content indexed directly via BatchPutDocument.
A corrected misspelled word in a query.
Provides the configuration information for altering document metadata and content during the document ingestion process.
Provides the configuration information to an Amazon Kendra supported database.
Provides the configuration information for an Amazon Kendra data source.
Data source information for user context filtering.
Summary information for a Amazon Kendra data source.
Provides information about a data source synchronization job.
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.
Maps a particular data source sync job to a particular data source.
Maps attributes or field names of the documents synced from the data source to Amazon Kendra index field names. You can set up field mappings for each data source when calling CreateDataSource or UpdateDataSource API. To create custom fields, use the UpdateIndex
API to first create an index field and then map to the data source field. For more information, see Mapping data source fields.
Provides the configuration information to connect to an Amazon VPC.
A document attribute or metadata field. To create custom document attributes, see Custom attributes.
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition.
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.
The value of a document attribute. You can only provide one value for a document attribute.
Provides the count of documents that match a particular document attribute or field when doing a faceted search.
Identifies a document for which to retrieve status information
Specifies the properties, such as relevance tuning and searchability, of an index field.
Overrides the document relevance properties of a custom index field.
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.
Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience.
Information about the user entity.
Provides the configuration information for users or groups in your IAM Identity Center identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.
Specifies the configuration information needed to customize how collapsed search result groups expand.
A single expanded result in a collapsed group of search results.
Provides the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.
Provides the configuration information for the endpoint for your Amazon Kendra experience.
Summary information for users or groups in your IAM Identity Center identity source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
The facet values for the documents in the response.
Information on the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.
Provides statistical information about the FAQ questions and answers contained in an index.
Summary information for frequently asked questions and answers included in an index.
A featured document. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then the document is featured in the search results.
A document ID doesn't exist but you have specified as a featured document. Amazon Kendra cannot feature the document if it doesn't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.
A featured document with its metadata information. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then the document is featured in the search results.
An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.
A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.
A set of featured results that are displayed at the top of your search results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
Summary information for a set of featured results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
Provides the configuration information to connect to Amazon FSx as your data source.
Provides the configuration information to connect to GitHub as your data source.
Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.
Provides the configuration information to connect to Google Drive as your data source.
A list of users or sub groups that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Summary information on the processing of PUT
and DELETE
actions for mapping users to their groups.
Summary information for groups.
Information to define the hierarchy for which documents users should have access to.
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using PostExtractionHookConfiguration. You can only invoke one Lambda function. However, this function can invoke other functions it requires.
Summary information on the configuration of an index.
Provides information about the number of documents and the number of questions and answers in an index.
Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration.
An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
The input to the request is not valid. Please provide the correct input and try again.
Provides the configuration information to connect to Jira as your data source.
Provides the configuration information for the JSON token type.
Provides the configuration information for the JWT token type.
Base class for all service related exceptions thrown by the Kendra client
The sub groups that belong to a group.
The users that belong to a group.
Provides the configuration information to connect to OneDrive as your data source.
User accounts whose documents should be indexed.
Provides the configuration information to connect to GitHub Enterprise Server (on premises).
Summary information for users or groups in your IAM Identity Center identity source. This applies to users and groups with specific permissions that define their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
Provides user and group information for user context filtering.
Provides the configuration information for a web proxy to connect to website hosts.
A single query result.
Summary information on a query suggestions block list.
Provides the configuration information to connect to Quip as your data source.
Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback
API to provide relevance information.
The resource you want to use already exists. Please check you have provided the correct resource and try again.
The resource you want to use is currently in use. Please check you have provided the correct resource and try again.
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
The resource you want to use isn't available. Please check you have provided the correct resource and try again.
A single retrieved relevant passage result.
Provides the configuration information to connect to an Amazon S3 bucket.
Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).
The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.
Provides the configuration information to connect to Salesforce as your data source.
Provides the configuration information for indexing Salesforce custom articles.
Provides the 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
Provides the configuration information for standard Salesforce knowledge articles.
Provides the configuration information for processing attachments to Salesforce standard objects.
Provides the configuration information for indexing a single standard object.
Provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
Enumeration for query score confidence.
Provides the configuration information for the seed or starting point URLs to crawl.
Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.
Provides the configuration information to connect to ServiceNow as your data source.
Provides the configuration information for crawling knowledge articles in the ServiceNow site.
Provides the configuration information for crawling service catalog items in the ServiceNow site
Provides the configuration information to connect to Microsoft SharePoint as your data source.
Provides the configuration information for the sitemap URLs to crawl.
Provides the configuration information to connect to Slack as your data source.
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 Sortable
flag set to true
, otherwise Amazon Kendra returns an exception.
The document ID and its fields/attributes that are used for a query suggestion, if document fields set to use for query suggestions.
A query with suggested spell corrections.
Provides the configuration information for suggested query spell corrections.
Provides the configuration information to use a SQL database.
Provides the configuration information for a document field/attribute that you want to base query suggestions on.
A single query suggestion.
The text highlights for a single query suggestion.
Provides text and information about where to highlight the query suggestion text.
The SuggestionTextWithHighlights
structure information.
An excerpt from a table within a document. The table excerpt displays up to five columns and three rows, depending on how many table cells are relevant to the query and how many columns are available in the original table. The top most relevant cell is displayed in the table excerpt, along with the next most relevant cells.
Provides a template for the configuration information to connect to your data source.
Provides information about text documents indexed in an index.
Provides text and information about where to highlight the text.
An array of summary information for a thesaurus or multiple thesauri.
The request was denied due to request throttling. Please reduce the number of requests and try again.
Provides information about the user context for an Amazon Kendra index.
Provides the configuration information to get users and groups from an IAM Identity Center identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the PutPrincipalMapping API to map users to their groups so that you only need to provide the user ID when you issue the query.
Provides the configuration information for the identifiers of your users.
Provides the configuration information for a token.
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
Provides the configuration information required for Amazon Kendra Web Crawler.
Provides the configuration information to connect to Amazon WorkDocs as your data source.