Package-level declarations

Types

Link copied to clipboard

Summary information on an access control configuration that you created for your documents in an index.

Link copied to clipboard

Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources.

Link copied to clipboard

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

Link copied to clipboard

Provides information about the column that should be used for filtering the query response by groups.

Link copied to clipboard

An attribute returned from an index query.

Link copied to clipboard

An attribute returned with a document from a search.

Link copied to clipboard

Provides the configuration information to connect to Alfresco as your data source.

Link copied to clipboard
sealed class AlfrescoEntity
Link copied to clipboard

Filters the search results based on document attributes or fields.

Link copied to clipboard

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.

Link copied to clipboard

Provides the configuration information for the document fields/attributes that you want to base query suggestions on.

Link copied to clipboard
Link copied to clipboard

Updates the configuration information for the document fields/attributes that you want to base query suggestions on.

Link copied to clipboard

Provides the configuration information to connect to websites that require user authentication.

Link copied to clipboard

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.

Link copied to clipboard

Provides information about a set of featured results that couldn't be removed from an index by the BatchDeleteFeaturedResultsSet API.

Link copied to clipboard

Provides a response when the status of a document could not be retrieved.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides information about a document that could not be indexed.

Link copied to clipboard

Provides the configuration information to connect to Box as your data source.

Link copied to clipboard

Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.

Link copied to clipboard

Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback API to provide click information.

Link copied to clipboard

Specifies how to group results by document attribute value, and how to display them collapsed/expanded under a designated primary document for each group.

Link copied to clipboard

Provides details about a collapsed group of search results.

Link copied to clipboard

Provides information about how Amazon Kendra should use the columns of a database in an index.

Link copied to clipboard
sealed class ConditionOperator
Link copied to clipboard

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Provides the configuration information to connect to Confluence as your data source.

Link copied to clipboard

Configuration of the page settings for the Confluence data source.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Configuration information for indexing Confluence spaces.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
sealed class ConfluenceVersion
Link copied to clipboard

Provides the configuration information that's required to connect to a database.

Link copied to clipboard

Provides the configuration information for your content sources, such as data sources, FAQs, and content indexed directly via BatchPutDocument.

Link copied to clipboard
sealed class ContentType
Link copied to clipboard

A corrected misspelled word in a query.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides the configuration information for altering document metadata and content during the document ingestion process.

Link copied to clipboard

Provides the configuration information to an Amazon Kendra supported database.

Link copied to clipboard
sealed class DatabaseEngineType
Link copied to clipboard

Provides the configuration information for an Amazon Kendra data source.

Link copied to clipboard

Data source information for user context filtering.

Link copied to clipboard
sealed class DataSourceStatus
Link copied to clipboard

Summary information for a Amazon Kendra data source.

Link copied to clipboard

Provides information about a data source synchronization job.

Link copied to clipboard

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.

Link copied to clipboard

Maps a particular data source sync job to a particular data source.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
sealed class DataSourceType
Link copied to clipboard

Provides the configuration information to connect to an Amazon VPC.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Document

A document in an index.

Link copied to clipboard

A document attribute or metadata field. To create custom document attributes, see Custom attributes.

Link copied to clipboard

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.

Link copied to clipboard

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.

Link copied to clipboard

The value of a document attribute. You can only provide one value for a document attribute.

Link copied to clipboard

Provides the count of documents that match a particular document attribute or field when doing a faceted search.

Link copied to clipboard
Link copied to clipboard

Identifies a document for which to retrieve status information

Link copied to clipboard

Specifies the properties, such as relevance tuning and searchability, of an index field.

Link copied to clipboard

Overrides the document relevance properties of a custom index field.

Link copied to clipboard

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.

Link copied to clipboard
sealed class DocumentStatus
Link copied to clipboard
sealed class EndpointType
Link copied to clipboard

Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience.

Link copied to clipboard

Information about the user entity.

Link copied to clipboard

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.

Link copied to clipboard
sealed class EntityType
Link copied to clipboard
sealed class ErrorCode
Link copied to clipboard

Specifies the configuration information needed to customize how collapsed search result groups expand.

Link copied to clipboard

A single expanded result in a collapsed group of search results.

Link copied to clipboard

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.

Link copied to clipboard

Provides the configuration information for the endpoint for your Amazon Kendra experience.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
sealed class ExperienceStatus
Link copied to clipboard
class Facet

Information about a document attribute or field. You can use document attributes as facets.

Link copied to clipboard

The facet values for the documents in the response.

Link copied to clipboard

Information on the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

Link copied to clipboard
sealed class FaqFileFormat
Link copied to clipboard

Provides statistical information about the FAQ questions and answers contained in an index.

Link copied to clipboard
sealed class FaqStatus
Link copied to clipboard

Summary information for frequently asked questions and answers included in an index.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Provides the configuration information to connect to Amazon FSx as your data source.

Link copied to clipboard
sealed class FsxFileSystemType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides the configuration information to connect to GitHub as your data source.

Link copied to clipboard

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.

Link copied to clipboard

Provides the configuration information to connect to Google Drive as your data source.

Link copied to clipboard

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.

Link copied to clipboard

Summary information on the processing of PUT and DELETE actions for mapping users to their groups.

Link copied to clipboard

Summary information for groups.

Link copied to clipboard

Information to define the hierarchy for which documents users should have access to.

Link copied to clipboard
class Highlight

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

Link copied to clipboard
sealed class HighlightType
Link copied to clipboard

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.

Link copied to clipboard

Summary information on the configuration of an index.

Link copied to clipboard
sealed class IndexEdition
Link copied to clipboard

Provides information about the number of documents and the number of questions and answers in an index.

Link copied to clipboard
sealed class IndexStatus

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.

Link copied to clipboard

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.

Link copied to clipboard
sealed class Interval
Link copied to clipboard

The input to the request is not valid. Please provide the correct input and try again.

Link copied to clipboard
sealed class IssueSubEntity
Link copied to clipboard

Provides the configuration information to connect to Jira as your data source.

Link copied to clipboard

Provides the configuration information for the JSON token type.

Link copied to clipboard

Provides the configuration information for the JWT token type.

Link copied to clipboard

Base class for all service related exceptions thrown by the Kendra client

Link copied to clipboard
sealed class KeyLocation
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The sub groups that belong to a group.

Link copied to clipboard

The users that belong to a group.

Link copied to clipboard
sealed class MetricType
Link copied to clipboard
Link copied to clipboard
sealed class Mode
Link copied to clipboard

Provides the configuration information to connect to OneDrive as your data source.

Link copied to clipboard

User accounts whose documents should be indexed.

Link copied to clipboard

Provides the configuration information to connect to GitHub Enterprise Server (on premises).

Link copied to clipboard
sealed class Order
Link copied to clipboard
sealed class Persona
Link copied to clipboard

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.

Link copied to clipboard
class Principal

Provides user and group information for user context filtering.

Link copied to clipboard
Link copied to clipboard
sealed class PrincipalType
Link copied to clipboard

Provides the configuration information for a web proxy to connect to website hosts.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class QueryResultFormat
Link copied to clipboard

A single query result.

Link copied to clipboard
sealed class QueryResultType
Link copied to clipboard

Summary information on a query suggestions block list.

Link copied to clipboard
Link copied to clipboard

Provides the configuration information to connect to Quip as your data source.

Link copied to clipboard
sealed class ReadAccessType
Link copied to clipboard
class Relevance

Provides information for 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.

Link copied to clipboard

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback API to provide relevance information.

Link copied to clipboard
sealed class RelevanceType
Link copied to clipboard

The resource you want to use already exists. Please check you have provided the correct resource and try again.

Link copied to clipboard

The resource you want to use is currently in use. Please check you have provided the correct resource and try again.

Link copied to clipboard

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

Link copied to clipboard

The resource you want to use isn't available. Please check you have provided the correct resource and try again.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A single retrieved relevant passage result.

Link copied to clipboard

Provides the configuration information to connect to an Amazon S3 bucket.

Link copied to clipboard
class S3Path

Information required to find a specific file in an Amazon S3 bucket.

Link copied to clipboard

Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).

Link copied to clipboard

The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.

Link copied to clipboard

Provides the configuration information to connect to Salesforce as your data source.

Provides the configuration information for indexing Salesforce custom articles.

Link copied to clipboard

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.

Link copied to clipboard

Provides the configuration information for indexing a single standard object.

Link copied to clipboard
Link copied to clipboard

Provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

Link copied to clipboard
sealed class ScoreConfidence

Enumeration for query score confidence.

Link copied to clipboard
class Search

Provides information about how a custom index field is used during a search.

Link copied to clipboard

Provides the configuration information for the seed or starting point URLs to crawl.

Link copied to clipboard

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides the configuration information to connect to ServiceNow as your data source.

Link copied to clipboard

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

Link copied to clipboard

Provides the configuration information for crawling service catalog items in the ServiceNow site

Link copied to clipboard

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.

Link copied to clipboard

Provides the configuration information to connect to Microsoft SharePoint as your data source.

Link copied to clipboard
sealed class SharePointVersion
Link copied to clipboard

Provides the configuration information for the sitemap URLs to crawl.

Link copied to clipboard

Provides the configuration information to connect to Slack as your data source.

Link copied to clipboard
sealed class SlackEntity
Link copied to clipboard

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.

Link copied to clipboard
sealed class SortOrder
Link copied to clipboard

The document ID and its fields/attributes that are used for a query suggestion, if document fields set to use for query suggestions.

Link copied to clipboard

A query with suggested spell corrections.

Link copied to clipboard

Provides the configuration information for suggested query spell corrections.

Link copied to clipboard

Provides the configuration information to use a SQL database.

Link copied to clipboard
class Status

Provides information about the status of documents submitted for indexing.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides the configuration information for a document field/attribute that you want to base query suggestions on.

Link copied to clipboard

A single query suggestion.

Link copied to clipboard

The text highlights for a single query suggestion.

Link copied to clipboard

Provides text and information about where to highlight the query suggestion text.

Link copied to clipboard
sealed class SuggestionType
Link copied to clipboard

The SuggestionTextWithHighlights structure information.

Link copied to clipboard
class TableCell

Provides information about a table cell in a table excerpt.

Link copied to clipboard

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.

Link copied to clipboard
class TableRow

Information about a row in a table excerpt.

Link copied to clipboard
class 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: _ . : / = + - @.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides a template for the configuration information to connect to your data source.

Link copied to clipboard

Provides information about text documents indexed in an index.

Link copied to clipboard

Provides text and information about where to highlight the text.

Link copied to clipboard
sealed class ThesaurusStatus
Link copied to clipboard

An array of summary information for a thesaurus or multiple thesauri.

Link copied to clipboard

The request was denied due to request throttling. Please reduce the number of requests and try again.

Link copied to clipboard
class TimeRange

Provides a range of time.

Link copied to clipboard
sealed class Type
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Urls

Provides the configuration information of the URLs to crawl.

Link copied to clipboard

Provides information about the user context for an Amazon Kendra index.

Link copied to clipboard
sealed class UserContextPolicy
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

Provides the configuration information for the identifiers of your users.

Link copied to clipboard

Provides the configuration information for a token.

Link copied to clipboard

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

Link copied to clipboard
class Warning

The warning code and message that explains a problem with a query.

Link copied to clipboard
sealed class WarningCode
Link copied to clipboard

Provides the configuration information required for Amazon Kendra Web Crawler.

Link copied to clipboard
sealed class WebCrawlerMode
Link copied to clipboard

Provides the configuration information to connect to Amazon WorkDocs as your data source.