import * as mod from "https://aws-api.deno.dev/v0.4/services/kendra.ts?docs=full";
AccessControlConfigurationSummary | Summary information on an access control configuration that you created for your documents in an index. |
AccessControlListConfiguration | 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. |
AdditionalResultAttribute | An attribute returned from an index query. |
AdditionalResultAttributeValue | An attribute returned with a document from a search. |
AlfrescoConfiguration | Provides the configuration information to connect to Alfresco as your data source. |
AssociateEntitiesToExperienceRequest | |
AssociateEntitiesToExperienceResponse | |
AssociatePersonasToEntitiesRequest | |
AssociatePersonasToEntitiesResponse | |
AttributeFilter | Provides filtering the query results based on document attributes or metadata fields. |
AuthenticationConfiguration | Provides the configuration information to connect to websites that require user authentication. |
BasicAuthenticationConfiguration | Provides the configuration information to connect to websites that require basic user authentication. |
BatchDeleteDocumentRequest | |
BatchDeleteDocumentResponse | |
BatchDeleteDocumentResponseFailedDocument | Provides information about documents that could not be removed from an index by the |
BatchGetDocumentStatusRequest | |
BatchGetDocumentStatusResponse | |
BatchGetDocumentStatusResponseError | Provides a response when the status of a document could not be retrieved. |
BatchPutDocumentRequest | |
BatchPutDocumentResponse | |
BatchPutDocumentResponseFailedDocument | Provides information about a document that could not be indexed. |
BoxConfiguration | Provides the configuration information to connect to Box as your data source. |
CapacityUnitsConfiguration | Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements. |
ClearQuerySuggestionsRequest | |
ClickFeedback | Gathers information about when a particular result was clicked by a user.
Your application uses the |
ColumnConfiguration | Provides information about how Amazon Kendra should use the columns of a database in an index. |
ConfluenceAttachmentConfiguration | 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. |
ConfluenceAttachmentToIndexFieldMapping | Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
To create custom fields, use the |
ConfluenceBlogConfiguration | Configuration of blog settings for the Confluence data source.
Blogs are always indexed unless filtered from the index by the |
ConfluenceBlogToIndexFieldMapping | Maps attributes or field names of Confluence blog to Amazon Kendra index field names.
To create custom fields, use the |
ConfluenceConfiguration | Provides the configuration information to connect to Confluence as your data source. |
ConfluencePageConfiguration | Configuration of the page settings for the Confluence data source. |
ConfluencePageToIndexFieldMapping | Maps attributes or field names of Confluence pages to Amazon Kendra index field names.
To create custom fields, use the |
ConfluenceSpaceConfiguration | Configuration information for indexing Confluence spaces. |
ConfluenceSpaceToIndexFieldMapping | Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.
To create custom fields, use the |
ConnectionConfiguration | Provides the configuration information that's required to connect to a database. |
ContentSourceConfiguration | Provides the configuration information for your content sources, such as data sources, FAQs, and content indexed directly via BatchPutDocument. |
Correction | A corrected misspelled word in a query. |
CreateAccessControlConfigurationRequest | |
CreateAccessControlConfigurationResponse | |
CreateDataSourceRequest | |
CreateDataSourceResponse | |
CreateExperienceRequest | |
CreateExperienceResponse | |
CreateFaqRequest | |
CreateFaqResponse | |
CreateIndexRequest | |
CreateIndexResponse | |
CreateQuerySuggestionsBlockListRequest | |
CreateQuerySuggestionsBlockListResponse | |
CreateThesaurusRequest | |
CreateThesaurusResponse | |
CustomDocumentEnrichmentConfiguration | Provides the configuration information for altering document metadata and content during the document ingestion process. |
DatabaseConfiguration | Provides the configuration information to connect to a index. |
DataSourceConfiguration | Provides the configuration information for an Amazon Kendra data source. |
DataSourceGroup | Data source information for user context filtering. |
DataSourceSummary | Summary information for a Amazon Kendra data source. |
DataSourceSyncJob | Provides information about a data source synchronization job. |
DataSourceSyncJobMetrics | 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. |
DataSourceSyncJobMetricTarget | Maps a particular data source sync job to a particular data source. |
DataSourceToIndexFieldMapping | Maps a column or attribute in the data source to an index field.
You must first create the fields in the index using the |
DataSourceVpcConfiguration | Provides the configuration information to connect to an Amazon VPC. |
DeleteAccessControlConfigurationRequest | |
DeleteDataSourceRequest | |
DeleteExperienceRequest | |
DeleteFaqRequest | |
DeleteIndexRequest | |
DeletePrincipalMappingRequest | |
DeleteQuerySuggestionsBlockListRequest | |
DeleteThesaurusRequest | |
DescribeAccessControlConfigurationRequest | |
DescribeAccessControlConfigurationResponse | |
DescribeDataSourceRequest | |
DescribeDataSourceResponse | |
DescribeExperienceRequest | |
DescribeExperienceResponse | |
DescribeFaqRequest | |
DescribeFaqResponse | |
DescribeIndexRequest | |
DescribeIndexResponse | |
DescribePrincipalMappingRequest | |
DescribePrincipalMappingResponse | |
DescribeQuerySuggestionsBlockListRequest | |
DescribeQuerySuggestionsBlockListResponse | |
DescribeQuerySuggestionsConfigRequest | |
DescribeQuerySuggestionsConfigResponse | |
DescribeThesaurusRequest | |
DescribeThesaurusResponse | |
DisassociateEntitiesFromExperienceRequest | |
DisassociateEntitiesFromExperienceResponse | |
DisassociatePersonasFromEntitiesRequest | |
DisassociatePersonasFromEntitiesResponse | |
Document | A document in an index. |
DocumentAttribute | A document attribute or metadata field. To create custom document attributes, see Custom attributes. |
DocumentAttributeCondition | 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. |
DocumentAttributeTarget | The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra. |
DocumentAttributeValue | The value of a document attribute. You can only provide one value for a document attribute. |
DocumentAttributeValueCountPair | Provides the count of documents that match a particular attribute when doing a faceted search. |
DocumentInfo | Identifies a document for which to retrieve status information |
DocumentMetadataConfiguration | Specifies the properties, such as relevance tuning and searchability, of an index field. |
DocumentRelevanceConfiguration | Overrides the document relevance properties of a custom index field. |
DocumentsMetadataConfiguration | 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. |
EntityConfiguration | Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience. |
EntityDisplayData | Information about the user entity. |
EntityPersonaConfiguration | 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. |
ExperienceConfiguration | 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. |
ExperienceEndpoint | Provides the configuration information for the endpoint for your Amazon Kendra experience. |
ExperienceEntitiesSummary | 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. |
ExperiencesSummary | 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. |
Facet | Information about a document attribute. You can use document attributes as facets. |
FacetResult | The facet values for the documents in the response. |
FailedEntity | Information on the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience. |
FaqStatistics | Provides statistical information about the FAQ questions and answers contained in an index. |
FaqSummary | Summary information for frequently asked questions and answers included in an index. |
FsxConfiguration | Provides the configuration information to connect to Amazon FSx as your data source. |
GetQuerySuggestionsRequest | |
GetQuerySuggestionsResponse | |
GetSnapshotsRequest | |
GetSnapshotsResponse | |
GitHubConfiguration | Provides the configuration information to connect to GitHub as your data source. |
GitHubDocumentCrawlProperties | 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. |
GoogleDriveConfiguration | Provides the configuration information to connect to Google Drive as your data source. |
GroupMembers | 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. |
GroupOrderingIdSummary | Summary information on the processing of |
GroupSummary | Summary information for groups. |
HierarchicalPrincipal | Information to define the hierarchy for which documents users should have access to. |
Highlight | Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response. |
HookConfiguration | 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. |
IndexConfigurationSummary | Summary information on the configuration of an index. |
IndexStatistics | Provides information about the number of documents and the number of questions and answers in an index. |
InlineCustomDocumentEnrichmentConfiguration | 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. |
JiraConfiguration | Provides the configuration information to connect to Jira as your data source. |
JsonTokenTypeConfiguration | Provides the configuration information for the JSON token type. |
JwtTokenTypeConfiguration | Provides the configuration information for the JWT token type. |
ListAccessControlConfigurationsRequest | |
ListAccessControlConfigurationsResponse | |
ListDataSourcesRequest | |
ListDataSourcesResponse | |
ListDataSourceSyncJobsRequest | |
ListDataSourceSyncJobsResponse | |
ListEntityPersonasRequest | |
ListEntityPersonasResponse | |
ListExperienceEntitiesRequest | |
ListExperienceEntitiesResponse | |
ListExperiencesRequest | |
ListExperiencesResponse | |
ListFaqsRequest | |
ListFaqsResponse | |
ListGroupsOlderThanOrderingIdRequest | |
ListGroupsOlderThanOrderingIdResponse | |
ListIndicesRequest | |
ListIndicesResponse | |
ListQuerySuggestionsBlockListsRequest | |
ListQuerySuggestionsBlockListsResponse | |
ListTagsForResourceRequest | |
ListTagsForResourceResponse | |
ListThesauriRequest | |
ListThesauriResponse | |
MemberGroup | The sub groups that belong to a group. |
MemberUser | The users that belong to a group. |
OneDriveConfiguration | Provides the configuration information to connect to OneDrive as your data source. |
OneDriveUsers | User accounts whose documents should be indexed. |
OnPremiseConfiguration | Provides the configuration information to connect to GitHub Enterprise Server (on premises). |
PersonasSummary | 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. |
Principal | Provides user and group information for user context filtering. |
ProxyConfiguration | Provides the configuration information for a web proxy to connect to website hosts. |
PutPrincipalMappingRequest | |
QueryRequest | |
QueryResult | |
QueryResultItem | A single query result. |
QuerySuggestionsBlockListSummary | Summary information on a query suggestions block list. |
QuipConfiguration | Provides the configuration information to connect to Quip as your data source. |
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. |
RelevanceFeedback | Provides feedback on how relevant a document is to a search.
Your application uses the |
S3DataSourceConfiguration | Provides the configuration information to connect to an Amazon S3 bucket. |
S3Path | Information required to find a specific file in an Amazon S3 bucket. |
SaaSConfiguration | Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS). |
SalesforceChatterFeedConfiguration | The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table. |
SalesforceConfiguration | Provides the configuration information to connect to Salesforce as your data source. |
SalesforceCustomKnowledgeArticleTypeConfiguration | Provides the configuration information for indexing Salesforce custom articles. |
SalesforceKnowledgeArticleConfiguration | 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 |
SalesforceStandardKnowledgeArticleTypeConfiguration | Provides the configuration information for standard Salesforce knowledge articles. |
SalesforceStandardObjectAttachmentConfiguration | Provides the configuration information for processing attachments to Salesforce standard objects. |
SalesforceStandardObjectConfiguration | Provides the configuration information for indexing a single standard object. |
ScoreAttributes | 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. |
SeedUrlConfiguration | Provides the configuration information for the seed or starting point URLs to crawl. |
ServerSideEncryptionConfiguration | Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys. |
ServiceNowConfiguration | Provides the configuration information to connect to ServiceNow as your data source. |
ServiceNowKnowledgeArticleConfiguration | Provides the configuration information for crawling knowledge articles in the ServiceNow site. |
ServiceNowServiceCatalogConfiguration | Provides the configuration information for crawling service catalog items in the ServiceNow site |
SharePointConfiguration | Provides the configuration information to connect to Microsoft SharePoint as your data source. |
SiteMapsConfiguration | Provides the configuration information for the sitemap URLs to crawl. |
SlackConfiguration | Provides the configuration information to connect to Slack as your data source. |
SortingConfiguration | 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 |
SpellCorrectedQuery | A query with suggested spell corrections. |
SpellCorrectionConfiguration | Provides the configuration information for suggested query spell corrections. |
SqlConfiguration | Provides the configuration information to use a SQL database. |
StartDataSourceSyncJobRequest | |
StartDataSourceSyncJobResponse | |
Status | Provides information about the status of documents submitted for indexing. |
StopDataSourceSyncJobRequest | |
SubmitFeedbackRequest | |
Suggestion | A single query suggestion. |
SuggestionHighlight | The text highlights for a single query suggestion. |
SuggestionTextWithHighlights | Provides text and information about where to highlight the query suggestion text. |
SuggestionValue | The |
TableCell | Provides information about a table cell in a table excerpt. |
TableExcerpt | 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. |
TableRow | Information about a row in a table excerpt. |
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: _ . : / = + - @. |
TagResourceRequest | |
Template | The template schema used for the data source, where templates schemas are supported. |
TemplateConfiguration | Provides a template for the configuration information to connect to your data source. |
TextDocumentStatistics | Provides information about text documents indexed in an index. |
TextWithHighlights | Provides text and information about where to highlight the text. |
ThesaurusSummary | An array of summary information for a thesaurus or multiple thesauri. |
TimeRange | Provides a range of time. |
UntagResourceRequest | |
UpdateAccessControlConfigurationRequest | |
UpdateDataSourceRequest | |
UpdateExperienceRequest | |
UpdateIndexRequest | |
UpdateQuerySuggestionsBlockListRequest | |
UpdateQuerySuggestionsConfigRequest | |
UpdateThesaurusRequest | |
Urls | Provides the configuration information of the URLs to crawl. |
UserContext | Provides information about the user context for an Amazon Kendra index. |
UserGroupResolutionConfiguration | Provides the configuration information to fetch access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) 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. |
UserIdentityConfiguration | Provides the configuration information for the identifiers of your users. |
UserTokenConfiguration | Provides the configuration information for a token. |
Warning | The warning code and message that explains a problem with a query. |
WebCrawlerConfiguration | Provides the configuration information required for Amazon Kendra Web Crawler. |
WorkDocsConfiguration | Provides the configuration information to connect to Amazon WorkDocs as your data source. |