Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/kendra.ts?docs=full";

§Classes

Kendra

§Interfaces

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.

AssociateEntitiesToExperienceRequest
AssociateEntitiesToExperienceResponse
AssociatePersonasToEntitiesRequest
AssociatePersonasToEntitiesResponse
AttributeFilter

Provides filtering the query results based on document attributes.

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 BatchDeleteDocument operation.

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.

CapacityUnitsConfiguration

Specifies capacity units configured for your enterprise edition index. You can add and remove capacity units to tune an index to your requirements.

ClearQuerySuggestionsRequest
ClickFeedback

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

ColumnConfiguration

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

ConfluenceAttachmentConfiguration

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.

ConfluenceAttachmentToIndexFieldMapping

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

ConfluenceBlogConfiguration

Specifies the 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 type.

ConfluenceBlogToIndexFieldMapping

Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field.

ConfluenceConfiguration

Provides configuration information for data sources that connect to Confluence.

ConfluencePageConfiguration

Specifies the page settings for the Confluence data source.

ConfluencePageToIndexFieldMapping

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

ConfluenceSpaceConfiguration

Specifies the configuration for indexing Confluence spaces.

ConfluenceSpaceToIndexFieldMapping

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

ConnectionConfiguration

Provides the information necessary to connect to a database.

ContentSourceConfiguration

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

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 information necessary to connect a database to an index.

DataSourceConfiguration

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. Returned in a call to the DescribeDataSource operation.

DataSourceSyncJob

Provides information about a 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 UpdateIndex operation.

DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.

DeleteDataSourceRequest
DeleteExperienceRequest
DeleteFaqRequest
DeleteIndexRequest
DeletePrincipalMappingRequest
DeleteQuerySuggestionsBlockListRequest
DeleteThesaurusRequest
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 custom attribute value assigned to a document.

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 custom document attribute. You can only provide one value for a custom 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 of a custom 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 of users or groups in your Amazon Web Services SSO identity source to grant access your Amazon Kendra experience.

EntityDisplayData

Information about the user entity.

EntityPersonaConfiguration

Provides the configuration information of users or groups in your Amazon Web Services SSO 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

Specifies 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 of the endpoint for your Amazon Kendra experience.

ExperienceEntitiesSummary

Summary information for users or groups in your Amazon Web Services SSO 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

FacetResult

The facet values for the documents in the response.

FailedEntity

Information on the users or groups in your Amazon Web Services SSO 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

Provides information about a frequently asked questions and answer contained in an index.

GetQuerySuggestionsRequest
GetQuerySuggestionsResponse
GetSnapshotsRequest
GetSnapshotsResponse
GoogleDriveConfiguration

Provides configuration information for data sources that connect to Google Drive.

GroupMembers

A list of users or sub groups that belong to a group. Users and groups are useful for filtering search results to different users based on their group's access to documents.

GroupOrderingIdSummary

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

GroupSummary

Group summary information.

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

A summary of information about 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.

JsonTokenTypeConfiguration

Configuration information for the JSON token type.

JwtTokenTypeConfiguration

Configuration information for the JWT token type.

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 configuration information for data sources that connect to OneDrive.

OneDriveUsers

User accounts whose documents should be indexed.

PersonasSummary

Summary information for users or groups in your Amazon Web Services SSO 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 document access 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.

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.

RelevanceFeedback

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

S3DataSourceConfiguration

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.

SalesforceChatterFeedConfiguration

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

SalesforceConfiguration

Provides configuration information for connecting to a Salesforce data source.

SalesforceCustomKnowledgeArticleTypeConfiguration

Provides configuration information for indexing Salesforce custom articles.

SalesforceKnowledgeArticleConfiguration

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

SalesforceStandardKnowledgeArticleTypeConfiguration

Provides configuration information for standard Salesforce knowledge articles.

SalesforceStandardObjectAttachmentConfiguration

Provides configuration information for processing attachments to Salesforce standard objects.

SalesforceStandardObjectConfiguration

Specifies 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 of the seed or starting point URLs to crawl.

ServerSideEncryptionConfiguration

Provides the identifier of the KMScustomer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

ServiceNowConfiguration

Provides configuration information required to connect to a ServiceNow data source.

ServiceNowKnowledgeArticleConfiguration

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

ServiceNowServiceCatalogConfiguration

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

SharePointConfiguration

Provides configuration information for connecting to a Microsoft SharePoint data source.

SiteMapsConfiguration

Provides the configuration information of the sitemap URLs to crawl.

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 Sortable flag set to true, otherwise Amazon Kendra returns an exception.

SqlConfiguration

Provides information that configures Amazon Kendra 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 SuggestionTextWithHighlights structure 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: _ . : / = + - @.

TagResourceRequest
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
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 Amazon Web Services Single Sign On identity source. This is useful for setting up user context filtering, where Amazon Kendra filters search results for different users based on their group's access to documents. You can also map your users to their groups for user context filtering using the PutPrincipalMapping operation.

UserIdentityConfiguration

Configuration information for the identifiers of your users.

UserTokenConfiguration

Provides configuration information for a token configuration.

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.

§Type Aliases

AdditionalResultAttributeValueType
ConditionOperator
ConfluenceAttachmentFieldName
ConfluenceBlogFieldName
ConfluencePageFieldName
ConfluenceSpaceFieldName
ConfluenceVersion
ContentType
DatabaseEngineType
DataSourceStatus
DataSourceSyncJobStatus
DataSourceType
DocumentAttributeValueType
DocumentStatus
EndpointType
EntityType
ErrorCode
ExperienceStatus
FaqFileFormat
FaqStatus
HighlightType
IndexEdition
IndexStatus
Interval
KeyLocation
MetricType
Mode
Order
Persona
PrincipalMappingStatus
PrincipalType
QueryIdentifiersEnclosingOption
QueryResultType
QuerySuggestionsBlockListStatus
QuerySuggestionsStatus
ReadAccessType
RelevanceType
SalesforceChatterFeedIncludeFilterType
SalesforceKnowledgeArticleState
SalesforceStandardObjectName
ScoreConfidence

Enumeration for query score confidence.

ServiceNowAuthenticationType
ServiceNowBuildVersionType
SharePointVersion
SortOrder
ThesaurusStatus
UserContextPolicy
UserGroupResolutionMode
WarningCode
WebCrawlerMode