Summary information on an access control configuration that you created for your * documents in an index.
* @public */ export interface AccessControlConfigurationSummary { /** *The identifier of the access control configuration.
* @public */ Id: string | undefined; } /** *Access Control List files for the documents in a data source. For the format of the * file, see Access control * for S3 data sources.
* @public */ export interface AccessControlListConfiguration { /** *Path to the Amazon S3 bucket that contains the ACL files.
* @public */ KeyPath?: string | undefined; } /** *Provides information about the column that should be used for filtering the query * response by groups.
* @public */ export interface AclConfiguration { /** *A list of groups, separated by semi-colons, that filters a query response based on
* user context. The document is only returned to users that are in one of the groups
* specified in the UserContext field of the Query API.
Provides information that you can use to highlight a search result so that your users * can quickly identify terms in the response.
* @public */ export interface Highlight { /** *The zero-based location in the response string where the highlight starts.
* @public */ BeginOffset: number | undefined; /** *The zero-based location in the response string where the highlight ends.
* @public */ EndOffset: number | undefined; /** *Indicates whether the response is the best response. True if this is the best * response; otherwise, false.
* @public */ TopAnswer?: boolean | undefined; /** *The highlight type.
* @public */ Type?: HighlightType | undefined; } /** *Provides text and information about where to highlight the text.
* @public */ export interface TextWithHighlights { /** *The text to display to the user.
* @public */ Text?: string | undefined; /** *The beginning and end of the text that should be highlighted.
* @public */ Highlights?: Highlight[] | undefined; } /** *An attribute returned with a document from a search.
* @public */ export interface AdditionalResultAttributeValue { /** *The text associated with the attribute and information about the highlight to apply to * the text.
* @public */ TextWithHighlightsValue?: TextWithHighlights | undefined; } /** *An attribute returned from an index query.
* @public */ export interface AdditionalResultAttribute { /** *The key that identifies the attribute.
* @public */ Key: string | undefined; /** *The data type of the Value property.
An object that contains the attribute value.
* @public */ Value: AdditionalResultAttributeValue | undefined; } /** *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.
The name of the field in the data source. You must first create the index field
* using the UpdateIndex API.
The format for date fields in the data source. If the field specified in
* DataSourceFieldName is a date field, you must specify the date
* format. If the field is not a date field, an exception is thrown.
The name of the index field to map to the data source field. The index field type * must match the data source field type.
* @public */ IndexFieldName: string | undefined; } /** *Information required to find a specific file in an Amazon S3 bucket.
* @public */ export interface S3Path { /** *The name of the S3 bucket that contains the file.
* @public */ Bucket: string | undefined; /** *The name of the file.
* @public */ Key: string | undefined; } /** *Provides the configuration information to connect to an Amazon VPC.
* @public */ export interface DataSourceVpcConfiguration { /** *A list of identifiers for subnets within your Amazon VPC. The subnets should be able to * connect to each other in the VPC, and they should have outgoing access to the Internet through * a NAT device.
* @public */ SubnetIds: string[] | undefined; /** *A list of identifiers of security groups within your Amazon VPC. The security groups * should enable Amazon Kendra to connect to the data source.
* @public */ SecurityGroupIds: string[] | undefined; } /** *Provides the configuration information to connect to Alfresco as your data * source.
*Support for AlfrescoConfiguration ended May 2023.
* We recommend migrating to or using the Alfresco data source template
* schema / TemplateConfiguration API.
The URL of the Alfresco site. For example, * https://hostname:8080.
* @public */ SiteUrl: string | undefined; /** *The identifier of the Alfresco site. For example, my-site.
* @public */ SiteId: string | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the * key-value pairs required to connect to your Alfresco data source. The secret must * contain a JSON structure with the following keys:
*username—The user name of the Alfresco account.
*password—The password of the Alfresco account.
*The path to the SSL certificate stored in an Amazon S3 bucket. You use this to * connect to Alfresco if you require a secure SSL connection.
*You can simply generate a self-signed X509 certificate on any computer using OpenSSL. * For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
* @public */ SslCertificateS3Path: S3Path | undefined; /** *
* TRUE to index shared files.
* TRUE to index comments of blogs and other content.
Specify whether to index document libraries, wikis, or blogs. You can specify one or * more of these options.
* @public */ EntityFilter?: AlfrescoEntity[] | undefined; /** *A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Alfresco document libraries to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to Alfresco fields.
* For more information, see Mapping data source fields. The
* Alfresco data source field names must exist in your Alfresco custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Alfresco blogs to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Alfresco fields. For more
* information, see
* Mapping data source fields. The Alfresco data source field names must exist
* in your Alfresco custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Alfresco wikis to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Alfresco fields. For more
* information, see
* Mapping data source fields. The Alfresco data source field names must exist
* in your Alfresco custom metadata.
A list of regular expression patterns to include certain files in your Alfresco data * source. Files that match the patterns are included in the index. Files that don't match * the patterns are excluded from the index. If a file matches both an inclusion pattern * and an exclusion pattern, the exclusion pattern takes precedence and the file isn't * included in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain files in your Alfresco data * source. Files that match the patterns are excluded from the index. Files that don't * match the patterns are included in the index. If a file matches both an inclusion * pattern and an exclusion pattern, the exclusion pattern takes precedence and the file * isn't included in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. * For more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; } /** *Provides the configuration information for users or groups in * your IAM Identity Center identity source to grant access your Amazon Kendra * experience.
* @public */ export interface EntityConfiguration { /** *The identifier of a user or group in your IAM Identity Center identity * source. For example, a user ID could be an email.
* @public */ EntityId: string | undefined; /** *Specifies whether you are configuring a User or a
* Group.
The identifier of your Amazon Kendra experience.
* @public */ Id: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *Lists users or groups in your IAM Identity Center identity source.
* @public */ EntityList: EntityConfiguration[] | undefined; } /** *Information on the users or groups in your IAM Identity Center identity * source that failed to properly configure with your Amazon Kendra experience.
* @public */ export interface FailedEntity { /** *The identifier of the user or group in your IAM Identity Center identity * source. For example, a user ID could be an email.
* @public */ EntityId?: string | undefined; /** *The reason the user or group in your IAM Identity Center identity source * failed to properly configure with your Amazon Kendra experience.
* @public */ ErrorMessage?: string | undefined; } /** * @public */ export interface AssociateEntitiesToExperienceResponse { /** *Lists the users or groups in your IAM Identity Center identity source that * failed to properly configure with your Amazon Kendra experience.
* @public */ FailedEntityList?: FailedEntity[] | undefined; } /** *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.
* @public */ export interface EntityPersonaConfiguration { /** *The identifier of a user or group in your IAM Identity Center identity * source. For example, a user ID could be an email.
* @public */ EntityId: string | undefined; /** *The persona that defines the specific permissions of the user or group
* in your IAM Identity Center identity source. The available personas or
* access roles are Owner and Viewer. For more
* information on these personas, see Providing
* access to your search page.
The identifier of your Amazon Kendra experience.
* @public */ Id: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *The personas that define the specific permissions of users or groups in
* your IAM Identity Center identity source. The available personas or access
* roles are Owner and Viewer. For more information
* on these personas, see Providing
* access to your search page.
Lists the users or groups in your IAM Identity Center identity source that * failed to properly configure with your Amazon Kendra experience.
* @public */ FailedEntityList?: FailedEntity[] | undefined; } /** *The value of a document attribute. You can only provide one value for a document * attribute.
* @public */ export interface DocumentAttributeValue { /** *A string, such as "department".
* @public */ StringValue?: string | undefined; /** *A list of strings. The default maximum length or number of strings is 10.
* @public */ StringListValue?: string[] | undefined; /** *A long integer value.
* @public */ LongValue?: number | undefined; /** *A date expressed as an ISO 8601 string.
*It is important for the time zone to be included in the ISO 8601 date-time format. For * example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 * at 12:30PM (plus 10 seconds) in Central European Time.
* @public */ DateValue?: Date | undefined; } /** *A document attribute or metadata field. To create custom document attributes, see * Custom * attributes.
* @public */ export interface DocumentAttribute { /** *The identifier for the attribute.
* @public */ Key: string | undefined; /** *The value of the attribute.
* @public */ Value: DocumentAttributeValue | undefined; } /** *Provides the configuration information for a document field/attribute that you want to base query * suggestions on.
* @public */ export interface SuggestableConfig { /** *The name of the document field/attribute.
* @public */ AttributeName?: string | undefined; /** *
* TRUE means the document field/attribute is suggestible, so the contents within the
* field can be used for query suggestions.
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.
* @public */ export interface AttributeSuggestionsDescribeConfig { /** *The list of fields/attributes that you want to set as suggestible for query suggestions.
* @public */ SuggestableConfigList?: SuggestableConfig[] | undefined; /** *The mode is set to either ACTIVE or INACTIVE. If the Mode
* for query history is set to ENABLED when calling UpdateQuerySuggestionsConfig
* and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE,
* and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES,
* then Amazon Kendra uses the query history.
Data source information for user context filtering.
* @public */ export interface DataSourceGroup { /** *The identifier of the group you want to add to your list of groups. This is for * filtering search results based on the groups' access to documents.
* @public */ GroupId: string | undefined; /** *The identifier of the data source group you want to add to your list of data source * groups. This is for filtering search results based on the groups' access to documents in * that data source.
* @public */ DataSourceId: string | undefined; } /** *Provides information about the user context for an Amazon Kendra index.
*User context filtering is a kind of personalized search with the benefit of controlling * access to documents. For example, not all teams that search the company portal for * information should access top-secret company documents, nor are these documents relevant to * all users. Only specific users or groups of teams given access to top-secret documents * should see these documents in their search results.
*You provide one of the following:
*User token
*User ID, the groups the user belongs to, and any data sources the groups can * access.
*If you provide both, an exception is thrown.
*If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can use
* UserId, Groups, and DataSourceGroups to filter
* content. If you set the UserId to a particular user ID, it also includes
* all public documents.
Amazon Kendra Gen AI Enterprise Edition indices don't support token based document filtering.
* If you're using an Amazon Kendra Gen AI Enterprise Edition index, Amazon Kendra returns a
* ValidationException error if the Token field has a non-null
* value.
The user context token for filtering search results for a user. It must be a JWT or a * JSON token.
* @public */ Token?: string | undefined; /** *The identifier of the user you want to filter search results based on their access to * documents.
* @public */ UserId?: string | undefined; /** *The list of groups you want to filter search results based on the groups' access to * documents.
* @public */ Groups?: string[] | undefined; /** *The list of data source groups you want to filter search results based on groups' access * to documents in that data source.
* @public */ DataSourceGroups?: DataSourceGroup[] | undefined; } /** *Updates the configuration information for the document fields/attributes that you want * to base query suggestions on.
*To deactivate using documents fields for query suggestions, set the mode to
* INACTIVE. You must also set SuggestionTypes as either
* QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If you set to QUERY, then
* Amazon Kendra uses the query history to base suggestions on. If you set to
* DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the contents of document
* fields to base suggestions on.
The list of fields/attributes that you want to set as suggestible for query * suggestions.
* @public */ SuggestableConfigList?: SuggestableConfig[] | undefined; /** *You can set the mode to ACTIVE or INACTIVE. You must also set
* SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES
* and then call GetQuerySuggestions. If Mode to use query history is set to
* ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use
* fields/attributes is set to ACTIVE, and you haven't set your
* SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then
* Amazon Kendra uses the query history.
Provides the configuration information to connect to websites that require basic user * authentication.
* @public */ export interface BasicAuthenticationConfiguration { /** *The name of the website host you want to connect to using authentication * credentials.
*For example, the host name of https://a.example.com/page1.html is * "a.example.com".
* @public */ Host: string | undefined; /** *The port number of the website host you want to connect to using authentication * credentials.
*For example, the port for https://a.example.com/page1.html is 443, the standard port * for HTTPS.
* @public */ Port: number | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a * secret to store your credentials in Secrets Manager *
*You use a secret if basic authentication credentials are required to connect to a * website. The secret stores your credentials of user name and password.
* @public */ Credentials: string | undefined; } /** *Provides the configuration information to connect to websites that require user * authentication.
* @public */ export interface AuthenticationConfiguration { /** *The list of configuration information that's required to connect to and crawl a * website host using basic authentication credentials.
*The list includes the name and port number of the website host.
* @public */ BasicAuthentication?: BasicAuthenticationConfiguration[] | undefined; } /** *Maps a particular data source sync job to a particular data source.
* @public */ export interface DataSourceSyncJobMetricTarget { /** *The ID of the data source that is running the sync job.
* @public */ DataSourceId: string | undefined; /** *The ID of the sync job that is running on the data source.
*If the ID of a sync job is not provided and there is a sync job running, then the ID of * this sync job is used and metrics are generated for this sync job.
*If the ID of a sync job is not provided and there is no sync job running, then no metrics * are generated and documents are indexed/deleted at the index level without sync job metrics * included.
* @public */ DataSourceSyncJobId?: string | undefined; } /** * @public */ export interface BatchDeleteDocumentRequest { /** *The identifier of the index that contains the documents to delete.
* @public */ IndexId: string | undefined; /** *One or more identifiers for documents to delete from the index.
* @public */ DocumentIdList: string[] | undefined; /** *Maps a particular data source sync job to a particular data source.
* @public */ DataSourceSyncJobMetricTarget?: DataSourceSyncJobMetricTarget | undefined; } /** *Provides information about documents that could not be removed from an index by the
* BatchDeleteDocument API.
The identifier of the document that couldn't be removed from the index.
* @public */ Id?: string | undefined; /** *The identifier of the data source connector that the document belongs to.
* @public */ DataSourceId?: string | undefined; /** *The error code for why the document couldn't be removed from the index.
* @public */ ErrorCode?: ErrorCode | undefined; /** *An explanation for why the document couldn't be removed from the index.
* @public */ ErrorMessage?: string | undefined; } /** * @public */ export interface BatchDeleteDocumentResponse { /** *A list of documents that could not be removed from the index. Each entry contains an * error message that indicates why the document couldn't be removed from the index.
* @public */ FailedDocuments?: BatchDeleteDocumentResponseFailedDocument[] | undefined; } /** * @public */ export interface BatchDeleteFeaturedResultsSetRequest { /** *The identifier of the index used for featuring results.
* @public */ IndexId: string | undefined; /** *The identifiers of the featured results sets that you want to delete.
* @public */ FeaturedResultsSetIds: string[] | undefined; } /** *Provides information about a set of featured results that couldn't be * removed from an index by the BatchDeleteFeaturedResultsSet API.
* @public */ export interface BatchDeleteFeaturedResultsSetError { /** *The identifier of the set of featured results that couldn't be removed * from the index.
* @public */ Id: string | undefined; /** *The error code for why the set of featured results couldn't be removed * from the index.
* @public */ ErrorCode: ErrorCode | undefined; /** *An explanation for why the set of featured results couldn't be removed * from the index.
* @public */ ErrorMessage: string | undefined; } /** * @public */ export interface BatchDeleteFeaturedResultsSetResponse { /** *The list of errors for the featured results set IDs, explaining why they * couldn't be removed from the index.
* @public */ Errors: BatchDeleteFeaturedResultsSetError[] | undefined; } /** *Identifies a document for which to retrieve status information
* @public */ export interface DocumentInfo { /** *The identifier of the document.
* @public */ DocumentId: string | undefined; /** *Attributes that identify a specific version of a document to check.
*The only valid attributes are:
*version
*datasourceId
*jobExecutionId
*The attributes follow these rules:
*
* dataSourceId and jobExecutionId must be used
* together.
* version is ignored if dataSourceId and
* jobExecutionId are not provided.
If dataSourceId and jobExecutionId are provided, but
* version is not, the version defaults to "0".
The identifier of the index to add documents to. The index ID is returned by the * CreateIndex * API.
* @public */ IndexId: string | undefined; /** *A list of DocumentInfo objects that identify the documents for which to
* get the status. You identify the documents by their document ID and optional
* attributes.
Provides information about the status of documents submitted for indexing.
* @public */ export interface Status { /** *The identifier of the document.
* @public */ DocumentId?: string | undefined; /** *The current status of a document.
*If the document was submitted for deletion, the status is NOT_FOUND after
* the document is deleted.
Indicates the source of the error.
* @public */ FailureCode?: string | undefined; /** *Provides detailed information about why the document couldn't be indexed. Use this * information to correct the error before you resubmit the document for indexing.
* @public */ FailureReason?: string | undefined; } /** *Provides a response when the status of a document could not be retrieved.
* @public */ export interface BatchGetDocumentStatusResponseError { /** *The identifier of the document whose status could not be retrieved.
* @public */ DocumentId?: string | undefined; /** *The identifier of the data source connector that the failed document belongs to. *
* @public */ DataSourceId?: string | undefined; /** *Indicates the source of the error.
* @public */ ErrorCode?: ErrorCode | undefined; /** *States that the API could not get the status of a document. This could be because the * request is not valid or there is a system error.
* @public */ ErrorMessage?: string | undefined; } /** * @public */ export interface BatchGetDocumentStatusResponse { /** *A list of documents that Amazon Kendra couldn't get the status for. The list * includes the ID of the document and the reason that the status couldn't be found.
* @public */ Errors?: BatchGetDocumentStatusResponseError[] | undefined; /** *The status of documents. The status indicates if the document is waiting to be * indexed, is in the process of indexing, has completed indexing, or failed indexing. If a * document failed indexing, the status provides the reason why.
* @public */ DocumentStatusList?: Status[] | undefined; } /** *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.
*For example, you can create the 'Department' target field and have it prefill * department names associated with the documents based on information in the 'Source_URI' * field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI * value, then prefill the target field 'Department' with the target value 'Finance' for * the document.
*Amazon Kendra cannot create a target field if it has not already been created as
* an index field. After you create your index field, you can create a document metadata
* field using DocumentAttributeTarget. Amazon Kendra then will map your
* newly created metadata field to your index field.
The identifier of the document attribute used for the condition.
*For example, 'Source_URI' could be an identifier for the attribute or metadata field * that contains source URIs associated with the documents.
*Amazon Kendra currently does not support _document_body as an
* attribute key used for the condition.
The condition operator.
*For example, you can use 'Contains' to partially match a string.
* @public */ Operator: ConditionOperator | undefined; /** *The value used by the operator.
*For example, you can specify the value 'financial' for strings in the 'Source_URI' * field that partially match or contain this value.
* @public */ ConditionOnValue?: DocumentAttributeValue | undefined; } /** *The target document attribute or metadata field you want to alter when ingesting * documents into Amazon Kendra.
*For example, you can delete customer identification numbers associated with the
* documents, stored in the document metadata field called 'Customer_ID'. You set the
* target key as 'Customer_ID' and the deletion flag to TRUE. This removes all
* customer ID values in the field 'Customer_ID'. This would scrub personally identifiable
* information from each document's metadata.
Amazon Kendra cannot create a target field if it has not already been created as
* an index field. After you create your index field, you can create a document metadata
* field using DocumentAttributeTarget. Amazon Kendra then will map your
* newly created metadata field to your index field.
You can also use this with DocumentAttributeCondition.
* @public */ export interface DocumentAttributeTarget { /** *The identifier of the target document attribute or metadata field.
*For example, 'Department' could be an identifier for the target attribute or metadata * field that includes the department names associated with the documents.
* @public */ TargetDocumentAttributeKey?: string | undefined; /** *
* TRUE to delete the existing target value for your specified target
* attribute key. You cannot create a target value and set this to TRUE. To
* create a target value (TargetDocumentAttributeValue), set this to
* FALSE.
The target value you want to create for the target attribute.
*For example, 'Finance' could be the target value for the target attribute key * 'Department'.
* @public */ TargetDocumentAttributeValue?: DocumentAttributeValue | undefined; } /** *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.
*For more information, see Customizing document metadata * during the ingestion process.
* @public */ export interface InlineCustomDocumentEnrichmentConfiguration { /** *Configuration of the condition used for the target document attribute or metadata * field when ingesting documents into Amazon Kendra.
* @public */ Condition?: DocumentAttributeCondition | undefined; /** *Configuration of the target document attribute or metadata field when ingesting * documents into Amazon Kendra. You can also include a value.
* @public */ Target?: DocumentAttributeTarget | undefined; /** *
* TRUE to delete content if the condition used for the target attribute is
* met.
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.
*For more information, see Customizing document metadata * during the ingestion process.
* @public */ export interface HookConfiguration { /** *The condition used for when a Lambda function should be invoked.
*For example, you can specify a condition that if there are empty date-time values, * then Amazon Kendra should invoke a function that inserts the current * date-time.
* @public */ InvocationCondition?: DocumentAttributeCondition | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function * during ingestion. For more information, see an IAM roles for Amazon Kendra.
* @public */ LambdaArn: string | undefined; /** *Stores the original, raw documents or the structured, parsed documents before and * after altering them. For more information, see Data contracts for Lambda functions.
* @public */ S3Bucket: string | undefined; } /** *Provides the configuration information for altering document metadata and content * during the document ingestion process.
*For more information, see Customizing document metadata * during the ingestion process.
* @public */ export interface CustomDocumentEnrichmentConfiguration { /** *Configuration information to alter document attributes or metadata fields and content * when ingesting documents into Amazon Kendra.
* @public */ InlineConfigurations?: InlineCustomDocumentEnrichmentConfiguration[] | undefined; /** *Configuration information for invoking a Lambda function in Lambda on * the original or raw documents before extracting their metadata and text. You can use a * Lambda function to apply advanced logic for creating, modifying, or deleting document * metadata and content. For more information, see Advanced data manipulation.
* @public */ PreExtractionHookConfiguration?: HookConfiguration | undefined; /** *Configuration information for invoking a Lambda function in Lambda on * the structured documents with their metadata and text extracted. You can use a Lambda * function to apply advanced logic for creating, modifying, or deleting document metadata * and content. For more information, see Advanced data manipulation.
* @public */ PostExtractionHookConfiguration?: HookConfiguration | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission to run
* PreExtractionHookConfiguration and
* PostExtractionHookConfiguration for altering document metadata and
* content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra.
Provides user and group information for user context * filtering.
* @public */ export interface Principal { /** *The name of the user or group.
* @public */ Name: string | undefined; /** *The type of principal.
* @public */ Type: PrincipalType | undefined; /** *Whether to allow or deny document access to the principal.
* @public */ Access: ReadAccessType | undefined; /** *The identifier of the data source the principal should access documents from.
* @public */ DataSourceId?: string | undefined; } /** *Information to define the hierarchy for which documents users should have access to. *
* @public */ export interface HierarchicalPrincipal { /** *A list of principal lists that define the hierarchy for which documents users should * have access to. Each hierarchical list specifies which user or group has allow or deny * access for each document.
* @public */ PrincipalList: Principal[] | undefined; } /** *A document in an index.
* @public */ export interface Document { /** *A identifier of the document in the index.
*Note, each document ID must be unique per index. You cannot create a data source to
* index your documents with their unique IDs and then use the
* BatchPutDocument API to index the same documents, or vice versa. You
* can delete a data source and then use the BatchPutDocument API to index the
* same documents, or vice versa.
The title of the document.
* @public */ Title?: string | undefined; /** *The contents of the document.
*Documents passed to the Blob parameter must be base64 encoded. Your code
* might not need to encode the document file bytes if you're using an Amazon Web Services
* SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint
* directly using REST, you must base64 encode the contents before sending.
Information required to find a specific file in an Amazon S3 bucket.
* @public */ S3Path?: S3Path | undefined; /** *Custom attributes to apply to the document. Use the custom attributes to provide * additional information for searching, to provide facets for refining searches, and to * provide additional information in the query response.
*For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that * provide information on the synchronization of documents running on a data source. Note, * 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of * a running sync job.
* @public */ Attributes?: DocumentAttribute[] | undefined; /** *Information on principals (users and/or groups) and which documents they should have * access to. This is useful for user context filtering, where search results are filtered * based on the user or their group access to documents.
* @public */ AccessControlList?: Principal[] | undefined; /** *The list of principal lists that define the hierarchy for which documents users should * have access to.
* @public */ HierarchicalAccessControlList?: HierarchicalPrincipal[] | undefined; /** *The file type of the document in the Blob field.
If you want to index snippets or subsets of HTML documents instead of the entirety of
* the HTML documents, you must add the HTML start and closing tags
* (content) around the content.
The identifier of the access control configuration that you want to apply to the * document.
* @public */ AccessControlConfigurationId?: string | undefined; } /** * @public */ export interface BatchPutDocumentRequest { /** *The identifier of the index to add the documents to. You need to create the index
* first using the CreateIndex API.
The Amazon Resource Name (ARN) of an IAM role with permission to access * your S3 bucket. For more information, see IAM access roles for Amazon Kendra.
* @public */ RoleArn?: string | undefined; /** *One or more documents to add to the index.
*Documents have the following file size limits.
*50 MB total size for any file
*5 MB extracted text for any file
*For more information, see Quotas.
* @public */ Documents: Document[] | undefined; /** *Configuration information for altering your document metadata and content during the
* document ingestion process when you use the BatchPutDocument API.
For more information on how to create, modify and delete document metadata, or make * other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
* @public */ CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | undefined; } /** *Provides information about a document that could not be indexed.
* @public */ export interface BatchPutDocumentResponseFailedDocument { /** *The identifier of the document.
* @public */ Id?: string | undefined; /** *The identifier of the data source connector that the failed document belongs to. *
* @public */ DataSourceId?: string | undefined; /** *The type of error that caused the document to fail to be indexed.
* @public */ ErrorCode?: ErrorCode | undefined; /** *A description of the reason why the document could not be indexed.
* @public */ ErrorMessage?: string | undefined; } /** * @public */ export interface BatchPutDocumentResponse { /** *A list of documents that were not added to the index because the document failed a * validation check. Each document contains an error message that indicates why the * document couldn't be added to the index.
*If there was an error adding a document to an index the error is reported in your * Amazon Web Services CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon CloudWatch logs.
* @public */ FailedDocuments?: BatchPutDocumentResponseFailedDocument[] | undefined; } /** * @public */ export interface ClearQuerySuggestionsRequest { /** *The identifier of the index you want to clear query suggestions from.
* @public */ IndexId: string | undefined; } /** * @public */ export interface CreateAccessControlConfigurationRequest { /** *The identifier of the index to create an access control configuration for your * documents.
* @public */ IndexId: string | undefined; /** *A name for the access control configuration.
* @public */ Name: string | undefined; /** *A description for the access control configuration.
* @public */ Description?: string | undefined; /** *Information on principals (users and/or groups) and which documents they should have * access to. This is useful for user context filtering, where search results are filtered * based on the user or their group access to documents.
* @public */ AccessControlList?: Principal[] | undefined; /** *The list of principal lists that define the hierarchy for which documents users should * have access to.
* @public */ HierarchicalAccessControlList?: HierarchicalPrincipal[] | undefined; /** *A token that you provide to identify the request to create an access control
* configuration. Multiple calls to the CreateAccessControlConfiguration API
* with the same client token will create only one access control configuration.
The identifier of the access control configuration for your documents in an * index.
* @public */ Id: string | undefined; } /** *Provides the configuration information to connect to Box as * your data source.
* @public */ export interface BoxConfiguration { /** *The identifier of the Box Enterprise platform. You can find the enterprise * ID in the Box Developer Console settings or when you create an app in Box and * download your authentication credentials. For example, 801234567.
* @public */ EnterpriseId: string | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that contains * the key-value pairs required to connect to your Box platform. The secret must * contain a JSON structure with the following keys:
*clientID—The identifier of the client OAuth 2.0 authentication * application created in Box.
*clientSecret—A set of characters known only to the OAuth 2.0 * authentication application created in Box.
*publicKeyId—The identifier of the public key contained within an * identity certificate.
*privateKey—A set of characters that make up an encryption key.
*passphrase—A set of characters that act like a password.
*You create an application in Box to generate the keys or credentials required * for the secret. For more information, see Using a Box data source.
* @public */ SecretArn: string | undefined; /** *
* TRUE to use the Slack change log to determine which documents require
* updating in the index. Depending on the data source change log's size, it may take
* longer for Amazon Kendra to use the change log than to scan all of your
* documents.
* TRUE to index comments.
* TRUE to index the contents of tasks.
* TRUE to index web links.
A
* list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Box files to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Box fields. For more
* information, see Mapping data source fields.
* The Box field names must exist in your Box custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes
* or field names of Box tasks to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to Box fields.
* For more information, see Mapping data source fields.
* The Box field names must exist in your Box custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes
* or field names of Box comments to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to Box fields.
* For more information, see Mapping data source fields.
* The Box field names must exist in your Box custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes
* or field names of Box web links to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to Box fields.
* For more information, see Mapping data source fields.
* The Box field names must exist in your Box custom metadata.
A list of regular expression patterns to include certain files and folders in your * Box platform. Files and folders that match the patterns are included in the index. * Files and folders that don't match the patterns are excluded from the index. If a * file or folder matches both an inclusion and exclusion pattern, the exclusion pattern * takes precedence and the file or folder isn't included in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain files and folders from * your Box platform. Files and folders that match the patterns are excluded from the * index.Files and folders that don't match the patterns are included in the index. * If a file or folder matches both an inclusion and exclusion pattern, the exclusion * pattern takes precedence and the file or folder isn't included in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *Configuration information for an Amazon VPC to connect to your Box. For * more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; } /** *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.
The name of the field in the data source.
*You must first create the index field using the UpdateIndex API.
The format for date fields in the data source. If the field specified in
* DataSourceFieldName is a date field you must specify the date format.
* If the field is not a date field, an exception is thrown.
The name of the index field to map to the Confluence data source field. The index * field type must match the Confluence field type.
* @public */ IndexFieldName?: string | undefined; } /** *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.
* @public */ export interface ConfluenceAttachmentConfiguration { /** *
* TRUE to index attachments of pages and blogs in Confluence.
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
* Confluence data source field names must exist in your Confluence custom metadata.
If you specify the AttachentFieldMappings parameter, you must specify at
* least one field mapping.
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.
The name of the field in the data source.
* @public */ DataSourceFieldName?: ConfluenceBlogFieldName | undefined; /** *The format for date fields in the data source. If the field specified in
* DataSourceFieldName is a date field you must specify the date format.
* If the field is not a date field, an exception is thrown.
The name of the index field to map to the Confluence data source field. The index * field type must match the Confluence field type.
* @public */ IndexFieldName?: string | undefined; } /** *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 blogs 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.
If you specify the BlogFieldMappings parameter, you must specify at least
* one field mapping.
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.
The name of the field in the data source.
* @public */ DataSourceFieldName?: ConfluencePageFieldName | undefined; /** *The format for date fields in the data source. If the field specified in
* DataSourceFieldName is a date field you must specify the date format.
* If the field is not a date field, an exception is thrown.
The name of the index field to map to the Confluence data source field. The index * field type must match the Confluence field type.
* @public */ IndexFieldName?: string | undefined; } /** *Configuration of the page settings for the Confluence data source.
* @public */ export interface ConfluencePageConfiguration { /** *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.
If you specify the PageFieldMappings parameter, you must specify at least
* one field mapping.
Provides the configuration information for a web proxy to connect to website * hosts.
* @public */ export interface ProxyConfiguration { /** *The name of the website host you want to connect to via a web proxy server.
*For example, the host name of https://a.example.com/page1.html is * "a.example.com".
* @public */ Host: string | undefined; /** *The port number of the website host you want to connect to via a web proxy server.
*For example, the port for https://a.example.com/page1.html is 443, the standard port * for HTTPS.
* @public */ Port: number | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret. You create a * secret to store your credentials in Secrets Manager *
*The credentials are optional. You use a secret if web proxy credentials are required * to connect to a website host. Amazon Kendra currently support basic authentication * to connect to a web proxy server. The secret stores your credentials.
* @public */ Credentials?: string | undefined; } /** *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.
The name of the field in the data source.
* @public */ DataSourceFieldName?: ConfluenceSpaceFieldName | undefined; /** *The format for date fields in the data source. If the field specified in
* DataSourceFieldName is a date field you must specify the date format.
* If the field is not a date field, an exception is thrown.
The name of the index field to map to the Confluence data source field. The index * field type must match the Confluence field type.
* @public */ IndexFieldName?: string | undefined; } /** *Configuration information for indexing Confluence spaces.
* @public */ export interface ConfluenceSpaceConfiguration { /** *
* TRUE to index personal spaces. You can add restrictions to items in
* personal spaces. If personal spaces are indexed, queries without user context
* information may return restricted items from a personal space in their results. For more
* information, see Filtering on user
* context.
* TRUE to index archived spaces.
A list of space keys for Confluence spaces. If you include a key, the blogs,
* documents, and attachments in the space are indexed. Spaces that aren't in the list
* aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an
* error when the data source is synchronized. If a space is in both the
* IncludeSpaces and the ExcludeSpaces list, the space is
* excluded.
A list of space keys of Confluence spaces. If you include a key, the blogs, documents,
* and attachments in the space are not indexed. If a space is in both the
* ExcludeSpaces and the IncludeSpaces list, the space is
* excluded.
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.
If you specify the SpaceFieldMappings parameter, you must specify at
* least one field mapping.
Provides the configuration information to connect to Confluence as your data * source.
* @public */ export interface ConfluenceConfiguration { /** *The URL of your Confluence instance. Use the full URL of the server. For example, * https://server.example.com:port/. You can also use an IP * address, for example, https://192.168.1.113/.
* @public */ ServerUrl: string | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the * user name and password required to connect to the Confluence instance. If you use * Confluence Cloud, you use a generated API token as the password.
*You can also provide authentication credentials in the form of a personal access * token. For more information, see Using a Confluence data * source.
* @public */ SecretArn: string | undefined; /** *The version or the type of Confluence installation to connect to.
* @public */ Version: ConfluenceVersion | undefined; /** *Configuration information for indexing Confluence spaces.
* @public */ SpaceConfiguration?: ConfluenceSpaceConfiguration | undefined; /** *Configuration information for indexing Confluence pages.
* @public */ PageConfiguration?: ConfluencePageConfiguration | undefined; /** *Configuration information for indexing Confluence blogs.
* @public */ BlogConfiguration?: ConfluenceBlogConfiguration | undefined; /** *Configuration information for indexing attachments to Confluence blogs and * pages.
* @public */ AttachmentConfiguration?: ConfluenceAttachmentConfiguration | undefined; /** *Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. * For more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; /** *A list of regular expression patterns to include certain blog posts, pages, spaces, or * attachments in your Confluence. Content that matches the patterns are included in the * index. Content that doesn't match the patterns is excluded from the index. If content * matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence * and the content isn't included in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain blog posts, pages, spaces, or * attachments in your Confluence. Content that matches the patterns are excluded from the * index. Content that doesn't match the patterns is included in the index. If content * matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence * and the content isn't included in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *Configuration information to connect to your Confluence URL instance via a web proxy. * You can use this option for Confluence Server.
*You must provide the website host name and port number. For example, the host name of * https://a.example.com/page1.html is "a.example.com" and the * port is 443, the standard port for HTTPS.
*Web proxy credentials are optional and you can use them to connect to a web proxy * server that requires basic authentication of user name and password. To store web proxy * credentials, you use a secret in Secrets Manager.
*It is recommended that you follow best security practices when configuring your web * proxy. This includes setting up throttling, setting up logging and monitoring, and * applying security patches on a regular basis. If you use your web proxy with multiple * data sources, sync jobs that occur at the same time could strain the load on your proxy. * It is recommended you prepare your proxy beforehand for any security and load * requirements.
* @public */ ProxyConfiguration?: ProxyConfiguration | undefined; /** *Whether you want to connect to Confluence using basic authentication of user name and * password, or a personal access token. You can use a personal access token for Confluence * Server.
* @public */ AuthenticationType?: ConfluenceAuthenticationType | undefined; } /** *Provides information about how Amazon Kendra should use the columns of a database * in an index.
* @public */ export interface ColumnConfiguration { /** *The column that provides the document's identifier.
* @public */ DocumentIdColumnName: string | undefined; /** *The column that contains the contents of the document.
* @public */ DocumentDataColumnName: string | undefined; /** *The column that contains the title of the document.
* @public */ DocumentTitleColumnName?: string | undefined; /** *An array of objects that map database column names to the corresponding fields in an
* index. You must first create the fields in the index using the UpdateIndex
* API.
One to five columns that indicate when a document in the database has changed.
* @public */ ChangeDetectingColumns: string[] | undefined; } /** *Provides the configuration information that's required to connect to a * database.
* @public */ export interface ConnectionConfiguration { /** *The name of the host for the database. Can be either a string * (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
* @public */ DatabaseHost: string | undefined; /** *The port that the database uses for connections.
* @public */ DatabasePort: number | undefined; /** *The name of the database containing the document data.
* @public */ DatabaseName: string | undefined; /** *The name of the table that contains the document data.
* @public */ TableName: string | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that stores * the credentials. The credentials should be a user-password pair. For more information, see Using a * Database Data Source. For more information about Secrets Manager, see * What * Is Secrets Manager in the Secrets Manager * user guide.
* @public */ SecretArn: string | undefined; } /** *Provides the configuration information to use a SQL database.
* @public */ export interface SqlConfiguration { /** *Determines whether Amazon Kendra encloses SQL identifiers for tables and column * names in double quotes (") when making a database query.
*By default, Amazon Kendra passes SQL identifiers the way that they are entered * into the data source configuration. It does not change the case of identifiers or * enclose them in quotes.
*PostgreSQL internally converts uppercase characters to lower case characters in * identifiers unless they are quoted. Choosing this option encloses identifiers in quotes * so that PostgreSQL does not convert the character's case.
*For MySQL databases, you must enable the ansi_quotes option when you set
* this field to DOUBLE_QUOTES.
Provides the configuration information to an Amazon Kendra supported * database.
* @public */ export interface DatabaseConfiguration { /** *The type of database engine that runs the database.
* @public */ DatabaseEngineType: DatabaseEngineType | undefined; /** *Configuration information that's required to connect to a database.
* @public */ ConnectionConfiguration: ConnectionConfiguration | undefined; /** *Provides the configuration information to connect to an Amazon VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; /** *Information about where the index should get the document information from the * database.
* @public */ ColumnConfiguration: ColumnConfiguration | undefined; /** *Information about the database column that provides information for user context * filtering.
* @public */ AclConfiguration?: AclConfiguration | undefined; /** *Provides information about how Amazon Kendra uses quote marks around SQL * identifiers when querying a database data source.
* @public */ SqlConfiguration?: SqlConfiguration | undefined; } /** *Provides the configuration information to connect to Amazon FSx as your data * source.
*Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
*You must now use the TemplateConfiguration object instead of the
* FsxConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to * function as configured. However, you won't be able to edit or update them. If you want * to edit or update your connector configuration, you must create a new connector.
*We recommended migrating your connector workflow to the upgraded version. Support for * connectors configured using the older architecture is scheduled to end by June 2024.
*The identifier of the Amazon FSx file system.
*You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx * console, using Windows File Server as an example, see Amazon FSx Getting * started guide.
* @public */ FileSystemId: string | undefined; /** *The Amazon FSx file system type. Windows is currently the only supported * type.
* @public */ FileSystemType: FsxFileSystemType | undefined; /** *Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
* @public */ VpcConfiguration: DataSourceVpcConfiguration | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the * key-value pairs required to connect to your Amazon FSx file system. Windows is * currently the only supported type. The secret must contain a JSON structure with the * following keys:
*username—The Active Directory user name, along with the Domain Name * System (DNS) domain name. For example, * user@corp.example.com. The Active Directory user * account must have read and mounting access to the Amazon FSx file system * for Windows.
*password—The password of the Active Directory user account with read * and mounting access to the Amazon FSx Windows file system.
*A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. * Files that don't match the patterns are excluded from the index. If a file matches both * an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file * isn't included in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. * Files that don't match the patterns are included in the index. If a file matches both an * inclusion and exclusion pattern, the exclusion pattern takes precedence and the file * isn't included in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To
* create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The
* Amazon FSx data source field names must exist in your Amazon FSx
* custom metadata.
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.
* @public */ export interface GitHubDocumentCrawlProperties { /** *
* TRUE to index all files with a repository.
* TRUE to index all issues within a repository.
* TRUE to index all comments on issues.
* TRUE to include all comment attachments for issues.
* TRUE to index all pull requests within a repository.
* TRUE to index all comments on pull requests.
* TRUE to include all comment attachments for pull requests.
Provides the configuration information to connect to GitHub Enterprise Server (on * premises).
* @public */ export interface OnPremiseConfiguration { /** *The GitHub host URL or API endpoint URL. For example, * https://on-prem-host-url/api/v3/ *
* @public */ HostUrl: string | undefined; /** *The name of the organization of the GitHub Enterprise Server (on-premises) account you * want to connect to. You can find your organization name by logging into GitHub desktop * and selecting Your organizations under your profile * picture dropdown.
* @public */ OrganizationName: string | undefined; /** *The path to the SSL certificate stored in an Amazon S3 bucket. You use this to * connect to GitHub if you require a secure SSL connection.
*You can simply generate a self-signed X509 certificate on any computer using OpenSSL. * For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
* @public */ SslCertificateS3Path: S3Path | undefined; } /** *Provides the configuration information to connect to GitHub Enterprise Cloud * (SaaS).
* @public */ export interface SaaSConfiguration { /** *The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to * connect to. You can find your organization name by logging into GitHub desktop and * selecting Your organizations under your profile picture * dropdown.
* @public */ OrganizationName: string | undefined; /** *The GitHub host URL or API endpoint URL. For example, * https://api.github.com.
* @public */ HostUrl: string | undefined; } /** *Provides the configuration information to connect to GitHub as your data * source.
*Amazon Kendra now supports an upgraded GitHub connector.
*You must now use the TemplateConfiguration object instead of the
* GitHubConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue * to function as configured. However, you won’t be able to edit or update them. If you * want to edit or update your connector configuration, you must create a new * connector.
*We recommended migrating your connector workflow to the upgraded version. Support * for connectors configured using the older architecture is scheduled to end by June * 2024.
*Configuration information to connect to GitHub Enterprise Cloud (SaaS).
* @public */ SaaSConfiguration?: SaaSConfiguration | undefined; /** *Configuration information to connect to GitHub Enterprise Server (on premises).
* @public */ OnPremiseConfiguration?: OnPremiseConfiguration | undefined; /** *The type of GitHub service you want to connect to—GitHub Enterprise Cloud * (SaaS) or GitHub Enterprise Server (on premises).
* @public */ Type?: Type | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the * key-value pairs required to connect to your GitHub. The secret must contain a JSON * structure with the following keys:
*personalToken—The access token created in GitHub. For more information * on creating a token in GitHub, see Using a GitHub data * source.
*
* TRUE to use the GitHub change log to determine which documents require
* updating in the index. Depending on the GitHub change log's size, it may take longer for
* Amazon Kendra to use the change log than to scan all of your documents in
* GitHub.
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.
* @public */ GitHubDocumentCrawlProperties?: GitHubDocumentCrawlProperties | undefined; /** *A list of names of the specific repositories you want to index.
* @public */ RepositoryFilter?: string[] | undefined; /** *A list of regular expression patterns to include certain folder names in your GitHub * repository or repositories. Folder names that match the patterns are included in the * index. Folder names that don't match the patterns are excluded from the index. If a * folder matches both an inclusion and exclusion pattern, the exclusion pattern takes * precedence and the folder isn't included in the index.
* @public */ InclusionFolderNamePatterns?: string[] | undefined; /** *A list of regular expression patterns to include certain file types in your GitHub * repository or repositories. File types that match the patterns are included in the * index. File types that don't match the patterns are excluded from the index. If a file * matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence * and the file isn't included in the index.
* @public */ InclusionFileTypePatterns?: string[] | undefined; /** *A list of regular expression patterns to include certain file names in your GitHub * repository or repositories. File names that match the patterns are included in the * index. File names that don't match the patterns are excluded from the index. If a file * matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence * and the file isn't included in the index.
* @public */ InclusionFileNamePatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain folder names in your GitHub * repository or repositories. Folder names that match the patterns are excluded from the * index. Folder names that don't match the patterns are included in the index. If a folder * matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence * and the folder isn't included in the index.
* @public */ ExclusionFolderNamePatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain file types in your GitHub * repository or repositories. File types that match the patterns are excluded from the * index. File types that don't match the patterns are included in the index. If a file * matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence * and the file isn't included in the index.
* @public */ ExclusionFileTypePatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain file names in your GitHub * repository or repositories. File names that match the patterns are excluded from the * index. File names that don't match the patterns are included in the index. If a file * matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence * and the file isn't included in the index.
* @public */ ExclusionFileNamePatterns?: string[] | undefined; /** *Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For * more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; /** *A list of DataSourceToIndexFieldMapping objects that map GitHub
* repository attributes or field names to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to GitHub fields. For
* more information, see Mapping data source fields. The
* GitHub data source field names must exist in your GitHub custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of GitHub commits to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to GitHub fields. For more
* information, see Mapping data source fields. The GitHub data source field names must exist
* in your GitHub custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of GitHub issues to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to GitHub fields. For more
* information, see Mapping data source fields. The GitHub data source field names must exist
* in your GitHub custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of GitHub issue comments to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to GitHub fields. For
* more information, see Mapping data source fields. The
* GitHub data source field names must exist in your GitHub custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of GitHub issue attachments to Amazon Kendra index field names. To
* create custom fields, use the UpdateIndex API before you map to GitHub
* fields. For more information, see Mapping data source fields. The
* GitHub data source field names must exist in your GitHub custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of GitHub pull request comments to Amazon Kendra index field names. To
* create custom fields, use the UpdateIndex API before you map to GitHub
* fields. For more information, see Mapping data source fields. The
* GitHub data source field names must exist in your GitHub custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of GitHub pull requests to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to GitHub fields. For
* more information, see Mapping data source fields. The
* GitHub data source field names must exist in your GitHub custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of GitHub pull request attachments to Amazon Kendra index field names.
* To create custom fields, use the UpdateIndex API before you map to GitHub
* fields. For more information, see Mapping data source fields. The
* GitHub data source field names must exist in your GitHub custom metadata.
Provides the configuration information to connect to Google Drive as your data * source.
* @public */ export interface GoogleDriveConfiguration { /** *The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the * credentials required to connect to Google Drive. For more information, see Using a * Google Workspace Drive data source.
* @public */ SecretArn: string | undefined; /** *A list of regular expression patterns to include certain items in your Google Drive, * including shared drives and users' My Drives. Items that match the patterns are included * in the index. Items that don't match the patterns are excluded from the index. If an * item matches both an inclusion and exclusion pattern, the exclusion pattern takes * precedence and the item isn't included in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain items in your Google Drive, * including shared drives and users' My Drives. Items that match the patterns are excluded * from the index. Items that don't match the patterns are included in the index. If an * item matches both an inclusion and exclusion pattern, the exclusion pattern takes * precedence and the item isn't included in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *Maps Google Drive data source attributes or field names to Amazon Kendra index
* field names. To create custom fields, use the UpdateIndex API before you
* map to Google Drive fields. For more information, see Mapping data source fields. The
* Google Drive data source field names must exist in your Google Drive custom
* metadata.
A list of MIME types to exclude from the index. All documents matching the specified * MIME type are excluded.
*For a list of MIME types, see Using a * Google Workspace Drive data source.
* @public */ ExcludeMimeTypes?: string[] | undefined; /** *A list of email addresses of the users. Documents owned by these users are excluded * from the index. Documents shared with excluded users are indexed unless they are * excluded in another way.
* @public */ ExcludeUserAccounts?: string[] | undefined; /** *A list of identifiers or shared drives to exclude from the index. All files and * folders stored on the shared drive are excluded.
* @public */ ExcludeSharedDrives?: string[] | undefined; } /** *Provides the configuration information to connect to Jira as your data source.
* @public */ export interface JiraConfiguration { /** *The URL of the Jira account. For example, * company.atlassian.net.
* @public */ JiraAccountUrl: string | undefined; /** *The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the * key-value pairs required to connect to your Jira data source. The secret must contain a * JSON structure with the following keys:
*jiraId—The Jira user name or email.
*jiraCredentials—The Jira API token. For more information, see Using a * Jira data source.
*
* TRUE to use the Jira change log to determine which documents require
* updating in the index. Depending on the change log's size, it may take longer for
* Amazon Kendra to use the change log than to scan all of your documents in
* Jira.
Specify which projects to crawl in your Jira data source. You can specify one or more * Jira project IDs.
* @public */ Project?: string[] | undefined; /** *Specify which issue types to crawl in your Jira data source. You can specify one or * more of these options to crawl.
* @public */ IssueType?: string[] | undefined; /** *Specify which statuses to crawl in your Jira data source. You can specify one or more * of these options to crawl.
* @public */ Status?: string[] | undefined; /** *Specify whether to crawl comments, attachments, and work logs. You can specify one or * more of these options.
* @public */ IssueSubEntityFilter?: IssueSubEntity[] | undefined; /** *A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Jira attachments to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to Jira fields. For
* more information, see Mapping data source fields. The
* Jira data source field names must exist in your Jira custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Jira comments to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Jira fields. For more
* information, see
* Mapping data source fields. The Jira data source field names must exist in
* your Jira custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Jira issues to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Jira fields. For more
* information, see
* Mapping data source fields. The Jira data source field names must exist in
* your Jira custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Jira projects to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Jira fields. For more
* information, see
* Mapping data source fields. The Jira data source field names must exist in
* your Jira custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Jira work logs to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Jira fields. For more
* information, see
* Mapping data source fields. The Jira data source field names must exist in
* your Jira custom metadata.
A list of regular expression patterns to include certain file paths, file names, and * file types in your Jira data source. Files that match the patterns are included in the * index. Files that don't match the patterns are excluded from the index. If a file * matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes * precedence and the file isn't included in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain file paths, file names, and * file types in your Jira data source. Files that match the patterns are excluded from the * index. Files that don’t match the patterns are included in the index. If a file matches * both an inclusion pattern and an exclusion pattern, the exclusion pattern takes * precedence and the file isn't included in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. For * more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; } /** *User accounts whose documents should be indexed.
* @public */ export interface OneDriveUsers { /** *A list of users whose documents should be indexed. Specify the user names in email
* format, for example, username@tenantdomain. If you need to index the
* documents of more than 10 users, use the OneDriveUserS3Path field to
* specify the location of a file containing a list of users.
The S3 bucket location of a file containing a list of users whose documents should be * indexed.
* @public */ OneDriveUserS3Path?: S3Path | undefined; } /** *Provides the configuration information to connect to OneDrive as your data * source.
* @public */ export interface OneDriveConfiguration { /** *The Azure Active Directory domain of the organization.
* @public */ TenantDomain: string | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the * user name and password to connect to OneDrive. The user name should be the application * ID for the OneDrive application, and the password is the application key for the * OneDrive application.
* @public */ SecretArn: string | undefined; /** *A list of user accounts whose documents should be indexed.
* @public */ OneDriveUsers: OneDriveUsers | undefined; /** *A list of regular expression patterns to include certain documents in your OneDrive. * Documents that match the patterns are included in the index. Documents that don't match * the patterns are excluded from the index. If a document matches both an inclusion and * exclusion pattern, the exclusion pattern takes precedence and the document isn't * included in the index.
*The pattern is applied to the file name.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain documents in your OneDrive. * Documents that match the patterns are excluded from the index. Documents that don't * match the patterns are included in the index. If a document matches both an inclusion * and exclusion pattern, the exclusion pattern takes precedence and the document isn't * included in the index.
*The pattern is applied to the file name.
* @public */ ExclusionPatterns?: string[] | undefined; /** *A list of DataSourceToIndexFieldMapping objects that map OneDrive data
* source attributes or field names to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to OneDrive fields.
* For more information, see Mapping data source fields. The
* OneDrive data source field names must exist in your OneDrive custom metadata.
* TRUE to disable local groups information.
Provides the configuration information to connect to Quip as your data source.
* @public */ export interface QuipConfiguration { /** *The Quip site domain. For example, * https://quip-company.quipdomain.com/browse. The domain in this * example is "quipdomain".
* @public */ Domain: string | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the * key-value pairs that are required to connect to your Quip. The secret must contain a * JSON structure with the following keys:
*accessToken—The token created in Quip. For more information, see Using a * Quip data source.
*
* TRUE to index file comments.
* TRUE to index the contents of chat rooms.
* TRUE to index attachments.
The identifiers of the Quip folders you want to index. You can find the folder ID in * your browser URL when you access your folder in Quip. For example, * https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. * The folder ID in this example is "zlLuOVNSarTL".
* @public */ FolderIds?: string[] | undefined; /** *A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Quip threads to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Quip fields. For more
* information, see Mapping data source fields. The Quip field names must exist in your Quip
* custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Quip messages to Amazon Kendra index field names. To create custom
* fields, use the UpdateIndex API before you map to Quip fields. For more
* information, see Mapping data source fields. The Quip field names must exist in your Quip
* custom metadata.
A list of DataSourceToIndexFieldMapping objects that map attributes or
* field names of Quip attachments to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to Quip fields. For
* more information, see Mapping data source fields. The
* Quip field names must exist in your Quip custom metadata.
A list of regular expression patterns to include certain files in your Quip file * system. Files that match the patterns are included in the index. Files that don't match * the patterns are excluded from the index. If a file matches both an inclusion pattern * and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't * included in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain files in your Quip file * system. Files that match the patterns are excluded from the index. Files that don’t * match the patterns are included in the index. If a file matches both an inclusion * pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file * isn't included in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. * For more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; } /** *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.
* @public */ export interface DocumentsMetadataConfiguration { /** *A prefix used to filter metadata configuration files in the Amazon Web Services S3
* bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix
* to include only the desired metadata files.
Provides the configuration information to connect to an Amazon S3 * bucket.
*Amazon Kendra now supports an upgraded Amazon S3 connector.
*You must now use the TemplateConfiguration object instead of the
* S3DataSourceConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to * function as configured. However, you won't be able to edit or update them. If you want * to edit or update your connector configuration, you must create a new connector.
*We recommended migrating your connector workflow to the upgraded version. Support for * connectors configured using the older architecture is scheduled to end by June 2024.
*The name of the bucket that contains the documents.
* @public */ BucketName: string | undefined; /** *A list of S3 prefixes for the documents that should be included in the index.
* @public */ InclusionPrefixes?: string[] | undefined; /** *A list of glob patterns (patterns that can expand a wildcard pattern into a list of * path names that match the given pattern) for certain file names and file types to include * in your index. If a document matches both an inclusion and exclusion prefix or pattern, * the exclusion prefix takes precendence and the document is not indexed. Examples of glob * patterns include:
** /myapp/config/*—All files inside config directory.
** **\/*.png—All .png files in all directories.
** **\/*.\{png, ico, md\}—All .png, .ico or .md files in all * directories.
** /myapp/src/**\/*.ts—All .ts files inside src directory (and all * its subdirectories).
** **\/!(*.module).ts—All .ts files but not .module.ts
** *.png , *.jpg—All PNG and JPEG image files * in a directory (files with the extensions .png and .jpg).
** *internal*—All files in a directory that * contain 'internal' in the file name, such as 'internal', 'internal_only', * 'company_internal'.
** **\/*internal*—All internal-related files in * a directory and its subdirectories.
*For more examples, see Use of Exclude and * Include Filters in the Amazon Web Services CLI Command Reference.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of glob patterns (patterns that can expand a wildcard pattern into a list of * path names that match the given pattern) for certain file names and file types to exclude * from your index. If a document matches both an inclusion and exclusion prefix or pattern, * the exclusion prefix takes precendence and the document is not indexed. Examples of glob * patterns include:
** /myapp/config/*—All files inside config directory.
** **\/*.png—All .png files in all directories.
** **\/*.\{png, ico, md\}—All .png, .ico or .md files in all * directories.
** /myapp/src/**\/*.ts—All .ts files inside src directory (and all * its subdirectories).
** **\/!(*.module).ts—All .ts files but not .module.ts
** *.png , *.jpg—All PNG and JPEG image files * in a directory (files with the extensions .png and .jpg).
** *internal*—All files in a directory that * contain 'internal' in the file name, such as 'internal', 'internal_only', * 'company_internal'.
** **\/*internal*—All internal-related files in * a directory and its subdirectories.
*For more examples, see Use of Exclude and * Include Filters in the Amazon Web Services CLI Command Reference.
* @public */ ExclusionPatterns?: string[] | undefined; /** *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.
* @public */ DocumentsMetadataConfiguration?: DocumentsMetadataConfiguration | undefined; /** *Provides the path to the S3 bucket that contains the user context filtering files for * the data source. For the format of the file, see Access control for S3 data * sources.
* @public */ AccessControlListConfiguration?: AccessControlListConfiguration | undefined; } /** *The configuration information for syncing a Salesforce chatter feed. The contents of * the object comes from the Salesforce FeedItem table.
* @public */ export interface SalesforceChatterFeedConfiguration { /** *The name of the column in the Salesforce FeedItem table that contains the content to
* index. Typically this is the Body column.
The name of the column in the Salesforce FeedItem table that contains the title of the
* document. This is typically the Title column.
Maps fields from a Salesforce chatter feed into Amazon Kendra index * fields.
* @public */ FieldMappings?: DataSourceToIndexFieldMapping[] | undefined; /** *Filters the documents in the feed based on status of the user. When you specify
* ACTIVE_USERS only documents from users who have an active account are
* indexed. When you specify STANDARD_USER only documents for Salesforce
* standard users are documented. You can specify both.
Provides the configuration information for indexing Salesforce custom articles.
* @public */ export interface SalesforceCustomKnowledgeArticleTypeConfiguration { /** *The name of the configuration.
* @public */ Name: string | undefined; /** *The name of the field in the custom knowledge article that contains the document data * to index.
* @public */ DocumentDataFieldName: string | undefined; /** *The name of the field in the custom knowledge article that contains the document * title.
* @public */ DocumentTitleFieldName?: string | undefined; /** *Maps attributes or field names of the custom knowledge article to Amazon Kendra
* index field names. To create custom fields, use the UpdateIndex API before
* you map to Salesforce fields. For more information, see Mapping data source fields. The
* Salesforce data source field names must exist in your Salesforce custom metadata.
Provides the configuration information for standard Salesforce knowledge * articles.
* @public */ export interface SalesforceStandardKnowledgeArticleTypeConfiguration { /** *The name of the field that contains the document data to index.
* @public */ DocumentDataFieldName: string | undefined; /** *The name of the field that contains the document title.
* @public */ DocumentTitleFieldName?: string | undefined; /** *Maps attributes or field names of the knowledge article to Amazon Kendra index
* field names. To create custom fields, use the UpdateIndex API before you
* map to Salesforce fields. For more information, see Mapping data source fields. The
* Salesforce data source field names must exist in your Salesforce custom metadata.
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
* @public */ export interface SalesforceKnowledgeArticleConfiguration { /** *Specifies the document states that should be included when Amazon Kendra indexes * knowledge articles. You must specify at least one state.
* @public */ IncludedStates: SalesforceKnowledgeArticleState[] | undefined; /** *Configuration information for standard Salesforce knowledge articles.
* @public */ StandardKnowledgeArticleTypeConfiguration?: SalesforceStandardKnowledgeArticleTypeConfiguration | undefined; /** *Configuration information for custom Salesforce knowledge articles.
* @public */ CustomKnowledgeArticleTypeConfigurations?: SalesforceCustomKnowledgeArticleTypeConfiguration[] | undefined; } /** *Provides the configuration information for processing attachments to Salesforce * standard objects.
* @public */ export interface SalesforceStandardObjectAttachmentConfiguration { /** *The name of the field used for the document title.
* @public */ DocumentTitleFieldName?: string | undefined; /** *One or more objects that map fields in attachments to Amazon Kendra index * fields.
* @public */ FieldMappings?: DataSourceToIndexFieldMapping[] | undefined; } /** *Provides the configuration information for indexing a single standard object.
* @public */ export interface SalesforceStandardObjectConfiguration { /** *The name of the standard object.
* @public */ Name: SalesforceStandardObjectName | undefined; /** *The name of the field in the standard object table that contains the document * contents.
* @public */ DocumentDataFieldName: string | undefined; /** *The name of the field in the standard object table that contains the document * title.
* @public */ DocumentTitleFieldName?: string | undefined; /** *Maps attributes or field names of the standard object to Amazon Kendra index
* field names. To create custom fields, use the UpdateIndex API before you
* map to Salesforce fields. For more information, see Mapping data source fields. The
* Salesforce data source field names must exist in your Salesforce custom metadata.
Provides the configuration information to connect to Salesforce as your data * source.
* @public */ export interface SalesforceConfiguration { /** *The instance URL for the Salesforce site that you want to index.
* @public */ ServerUrl: string | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the * key/value pairs required to connect to your Salesforce instance. The secret must contain * a JSON structure with the following keys:
*authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get * an OAUTH token.
*consumerKey - The application public key generated when you created your * Salesforce application.
*consumerSecret - The application private key generated when you created your * Salesforce application.
*password - The password associated with the user logging in to the Salesforce * instance.
*securityToken - The token associated with the user logging in to the * Salesforce instance.
*username - The user name of the user logging in to the Salesforce * instance.
*Configuration of the Salesforce standard objects that Amazon Kendra * indexes.
* @public */ StandardObjectConfigurations?: SalesforceStandardObjectConfiguration[] | undefined; /** *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.
* @public */ KnowledgeArticleConfiguration?: SalesforceKnowledgeArticleConfiguration | undefined; /** *Configuration information for Salesforce chatter feeds.
* @public */ ChatterFeedConfiguration?: SalesforceChatterFeedConfiguration | undefined; /** *Indicates whether Amazon Kendra should index attachments to Salesforce * objects.
* @public */ CrawlAttachments?: boolean | undefined; /** *Configuration information for processing attachments to Salesforce standard objects. *
* @public */ StandardObjectAttachmentConfiguration?: SalesforceStandardObjectAttachmentConfiguration | undefined; /** *A list of regular expression patterns to include certain documents in your Salesforce. * Documents that match the patterns are included in the index. Documents that don't match * the patterns are excluded from the index. If a document matches both an inclusion and * exclusion pattern, the exclusion pattern takes precedence and the document isn't * included in the index.
*The pattern is applied to the name of the attached file.
* @public */ IncludeAttachmentFilePatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain documents in your Salesforce. * Documents that match the patterns are excluded from the index. Documents that don't * match the patterns are included in the index. If a document matches both an inclusion * and exclusion pattern, the exclusion pattern takes precedence and the document isn't * included in the index.
*The pattern is applied to the name of the attached file.
* @public */ ExcludeAttachmentFilePatterns?: string[] | undefined; } /** *Provides the configuration information for crawling knowledge articles in the * ServiceNow site.
* @public */ export interface ServiceNowKnowledgeArticleConfiguration { /** *
* TRUE to index attachments to knowledge articles.
A list of regular expression patterns applied to include knowledge article * attachments. Attachments that match the patterns are included in the index. Items that * don't match the patterns are excluded from the index. If an item matches both an * inclusion and exclusion pattern, the exclusion pattern takes precedence and the item * isn't included in the index.
* @public */ IncludeAttachmentFilePatterns?: string[] | undefined; /** *A list of regular expression patterns applied to exclude certain knowledge article * attachments. Attachments that match the patterns are excluded from the index. Items that * don't match the patterns are included in the index. If an item matches both an inclusion * and exclusion pattern, the exclusion pattern takes precedence and the item isn't * included in the index.
* @public */ ExcludeAttachmentFilePatterns?: string[] | undefined; /** *The name of the ServiceNow field that is mapped to the index document contents field * in the Amazon Kendra index.
* @public */ DocumentDataFieldName: string | undefined; /** *The name of the ServiceNow field that is mapped to the index document title * field.
* @public */ DocumentTitleFieldName?: string | undefined; /** *Maps attributes or field names of knoweldge articles to Amazon Kendra index field
* names. To create custom fields, use the UpdateIndex API before you map to
* ServiceNow fields. For more information, see Mapping data source fields. The
* ServiceNow data source field names must exist in your ServiceNow custom metadata.
A query that selects the knowledge articles to index. The query can return articles * from multiple knowledge bases, and the knowledge bases can be public or private.
*The query string must be one generated by the ServiceNow console. For more * information, see Specifying documents to index with a * query.
* @public */ FilterQuery?: string | undefined; } /** *Provides the configuration information for crawling service catalog items in the * ServiceNow site
* @public */ export interface ServiceNowServiceCatalogConfiguration { /** *
* TRUE to index attachments to service catalog items.
A list of regular expression patterns to include certain attachments of catalogs in * your ServiceNow. Item that match the patterns are included in the index. Items that * don't match the patterns are excluded from the index. If an item matches both an * inclusion and exclusion pattern, the exclusion pattern takes precedence and the item * isn't included in the index.
*The regex is applied to the file name of the attachment.
* @public */ IncludeAttachmentFilePatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain attachments of catalogs in * your ServiceNow. Item that match the patterns are excluded from the index. Items that * don't match the patterns are included in the index. If an item matches both an inclusion * and exclusion pattern, the exclusion pattern takes precedence and the item isn't * included in the index.
*The regex is applied to the file name of the attachment.
* @public */ ExcludeAttachmentFilePatterns?: string[] | undefined; /** *The name of the ServiceNow field that is mapped to the index document contents field * in the Amazon Kendra index.
* @public */ DocumentDataFieldName: string | undefined; /** *The name of the ServiceNow field that is mapped to the index document title * field.
* @public */ DocumentTitleFieldName?: string | undefined; /** *Maps attributes or field names of catalogs to Amazon Kendra index field names. To
* create custom fields, use the UpdateIndex API before you map to ServiceNow
* fields. For more information, see Mapping data source fields. The
* ServiceNow data source field names must exist in your ServiceNow custom metadata.
Provides the configuration information to connect to ServiceNow as your data * source.
* @public */ export interface ServiceNowConfiguration { /** *The ServiceNow instance that the data source connects to. The host endpoint should * look like the following: \{instance\}.service-now.com. *
* @public */ HostUrl: string | undefined; /** *The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the * user name and password required to connect to the ServiceNow instance. You can also * provide OAuth authentication credentials of user name, password, client ID, and client * secret. For more information, see Using a ServiceNow data * source.
* @public */ SecretArn: string | undefined; /** *The identifier of the release that the ServiceNow host is running. If the host is not
* running the LONDON release, use OTHERS.
Configuration information for crawling knowledge articles in the ServiceNow * site.
* @public */ KnowledgeArticleConfiguration?: ServiceNowKnowledgeArticleConfiguration | undefined; /** *Configuration information for crawling service catalogs in the ServiceNow site.
* @public */ ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration | undefined; /** *The type of authentication used to connect to the ServiceNow instance. If you choose
* HTTP_BASIC, Amazon Kendra is authenticated using the user name and
* password provided in the Secrets Manager secret in the SecretArn
* field. If you choose OAUTH2, Amazon Kendra is authenticated using the
* credentials of client ID, client secret, user name and password.
When you use OAUTH2 authentication, you must generate a token and a
* client secret using the ServiceNow console. For more information, see Using a
* ServiceNow data source.
Provides the configuration information to connect to Microsoft SharePoint as your data * source.
* @public */ export interface SharePointConfiguration { /** *The version of Microsoft SharePoint that you use.
* @public */ SharePointVersion: SharePointVersion | undefined; /** *The Microsoft SharePoint site URLs for the documents you want to index.
* @public */ Urls: string[] | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the * user name and password required to connect to the SharePoint instance. For more * information, see Microsoft * SharePoint.
* @public */ SecretArn: string | undefined; /** *
* TRUE to index document attachments.
* TRUE to use the SharePoint change log to determine which documents
* require updating in the index. Depending on the change log's size, it may take longer
* for Amazon Kendra to use the change log than to scan all of your documents in
* SharePoint.
A list of regular expression patterns to include certain documents in your SharePoint. * Documents that match the patterns are included in the index. Documents that don't match * the patterns are excluded from the index. If a document matches both an inclusion and * exclusion pattern, the exclusion pattern takes precedence and the document isn't * included in the index.
*The regex applies to the display URL of the SharePoint document.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain documents in your SharePoint. * Documents that match the patterns are excluded from the index. Documents that don't * match the patterns are included in the index. If a document matches both an inclusion * and exclusion pattern, the exclusion pattern takes precedence and the document isn't * included in the index.
*The regex applies to the display URL of the SharePoint document.
* @public */ ExclusionPatterns?: string[] | undefined; /** *Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft * SharePoint. For more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; /** *A list of DataSourceToIndexFieldMapping objects that map SharePoint data
* source attributes or field names to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to SharePoint fields.
* For more information, see Mapping data source fields. The
* SharePoint data source field names must exist in your SharePoint custom metadata.
The Microsoft SharePoint attribute field that contains the title of the * document.
* @public */ DocumentTitleFieldName?: string | undefined; /** *
* TRUE to disable local groups information.
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to * connect to SharePoint Server if you require a secure SSL connection.
*You can generate a self-signed X509 certificate on any computer using OpenSSL. For an * example of using OpenSSL to create an X509 certificate, see Create and sign an X509 * certificate.
* @public */ SslCertificateS3Path?: S3Path | undefined; /** *Whether you want to connect to SharePoint Online using basic authentication of user * name and password, or OAuth authentication of user name, password, client ID, and client * secret, or AD App-only authentication of client secret.
* @public */ AuthenticationType?: SharePointOnlineAuthenticationType | undefined; /** *Configuration information to connect to your Microsoft SharePoint site URLs via * instance via a web proxy. You can use this option for SharePoint Server.
*You must provide the website host name and port number. For example, the host name of * https://a.example.com/page1.html is "a.example.com" and the * port is 443, the standard port for HTTPS.
*Web proxy credentials are optional and you can use them to connect to a web proxy * server that requires basic authentication of user name and password. To store web proxy * credentials, you use a secret in Secrets Manager.
*It is recommended that you follow best security practices when configuring your web * proxy. This includes setting up throttling, setting up logging and monitoring, and * applying security patches on a regular basis. If you use your web proxy with multiple * data sources, sync jobs that occur at the same time could strain the load on your proxy. * It is recommended you prepare your proxy beforehand for any security and load * requirements.
* @public */ ProxyConfiguration?: ProxyConfiguration | undefined; } /** *Provides the configuration information to connect to Slack as your data source.
*Amazon Kendra now supports an upgraded Slack connector.
*You must now use the TemplateConfiguration object instead of the
* SlackConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to * function as configured. However, you won’t be able to edit or update them. If you want * to edit or update your connector configuration, you must create a new connector.
*We recommended migrating your connector workflow to the upgraded version. Support for * connectors configured using the older architecture is scheduled to end by June 2024.
*The identifier of the team in the Slack workspace. For example, * T0123456789.
*You can find your team ID in the URL of the main page of your Slack workspace. When * you log in to Slack via a browser, you are directed to the URL of the main page. For * example, https://app.slack.com/client/T0123456789/....
* @public */ TeamId: string | undefined; /** *The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the * key-value pairs required to connect to your Slack workspace team. The secret must * contain a JSON structure with the following keys:
*slackToken—The user or bot token created in Slack. For more information * on creating a token in Slack, see Authentication for a Slack data source.
*Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For * more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; /** *Specify whether to index public channels, private channels, group messages, and direct * messages. You can specify one or more of these options.
* @public */ SlackEntityList: SlackEntity[] | undefined; /** *
* TRUE to use the Slack change log to determine which documents require
* updating in the index. Depending on the Slack change log's size, it may take longer for
* Amazon Kendra to use the change log than to scan all of your documents in
* Slack.
* TRUE to index bot messages from your Slack workspace team.
* TRUE to exclude archived messages to index from your Slack workspace
* team.
The date to start crawling your data from your Slack workspace team. The date must
* follow this format: yyyy-mm-dd.
The number of hours for change log to look back from when you last synchronized your * data. You can look back up to 7 days or 168 hours.
*Change log updates your index only if new content was added since you last synced your
* data. Updated or deleted content from before you last synced does not get updated in
* your index. To capture updated or deleted content before you last synced, set the
* LookBackPeriod to the number of hours you want change log to look
* back.
The list of private channel names from your Slack workspace team. You use this if you * want to index specific private channels, not all private channels. You can also use * regular expression patterns to filter private channels.
* @public */ PrivateChannelFilter?: string[] | undefined; /** *The list of public channel names to index from your Slack workspace team. You use this * if you want to index specific public channels, not all public channels. You can also use * regular expression patterns to filter public channels.
* @public */ PublicChannelFilter?: string[] | undefined; /** *A list of regular expression patterns to include certain attached files in your Slack * workspace team. Files that match the patterns are included in the index. Files that * don't match the patterns are excluded from the index. If a file matches both an * inclusion and exclusion pattern, the exclusion pattern takes precedence and the file * isn't included in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain attached files in your Slack * workspace team. Files that match the patterns are excluded from the index. Files that * don’t match the patterns are included in the index. If a file matches both an inclusion * and exclusion pattern, the exclusion pattern takes precedence and the file isn't * included in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *A list of DataSourceToIndexFieldMapping objects that map Slack data
* source attributes or field names to Amazon Kendra index field names. To create
* custom fields, use the UpdateIndex API before you map to Slack fields. For
* more information, see Mapping data source fields. The
* Slack data source field names must exist in your Slack custom metadata.
Provides a template for the configuration information to connect to your data * source.
* @public */ export interface TemplateConfiguration { /** *The template schema used for the data source, where templates schemas are * supported.
*See Data source * template schemas.
* @public */ Template?: __DocumentType | undefined; } /** *Provides the configuration information for 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 Amazon Kendra Web Crawler * to index your own web pages, or web pages that you have authorization to * index. *
* @public */ export interface SeedUrlConfiguration { /** *The list of seed or starting point URLs of the websites you want to crawl.
*The list can include a maximum of 100 seed URLs.
* @public */ SeedUrls: string[] | undefined; /** *You can choose one of the following modes:
*
* HOST_ONLY—crawl only the website host names. For
* example, if the seed URL is "abc.example.com", then only URLs with host name
* "abc.example.com" are crawled.
* SUBDOMAINS—crawl the website host names with subdomains.
* For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and
* "b.abc.example.com" are also crawled.
* EVERYTHING—crawl the website host names with subdomains
* and other domains that the web pages link to.
The default mode is set to HOST_ONLY.
Provides the configuration information for 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 Amazon Kendra Web Crawler * to index your own web pages, or web pages that you have authorization to * index. *
* @public */ export interface SiteMapsConfiguration { /** *The list of sitemap URLs of the websites you want to crawl.
*The list can include a maximum of three sitemap URLs.
* @public */ SiteMaps: string[] | undefined; } /** *Provides the configuration information of the URLs to crawl.
*You can only crawl websites that use the secure communication protocol, Hypertext * Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it * could be that the website is blocked from crawling.
** 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 Amazon Kendra Web Crawler * to index your own web pages, or web pages that you have authorization to * index. *
* @public */ export interface Urls { /** *Configuration of the seed or starting point URLs of the websites you want to * crawl.
*You can choose to crawl only the website host names, or the website host names with * subdomains, or the website host names with subdomains and other domains that the * web pages link to.
*You can list up to 100 seed URLs.
* @public */ SeedUrlConfiguration?: SeedUrlConfiguration | undefined; /** *Configuration of the sitemap URLs of the websites you want to crawl.
*Only URLs belonging to the same website host names are crawled. You can list up to * three sitemap URLs.
* @public */ SiteMapsConfiguration?: SiteMapsConfiguration | undefined; } /** *Provides the configuration information required for Amazon Kendra Web * Crawler.
* @public */ export interface WebCrawlerConfiguration { /** *Specifies the seed or starting point URLs of the websites or the sitemap URLs of the * websites you want to crawl.
*You can include website subdomains. You can list up to 100 seed URLs and up to three * sitemap URLs.
*You can only crawl websites that use the secure communication protocol, Hypertext * Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it * could be that the website is blocked from crawling.
** 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 Amazon Kendra Web Crawler * to index your own web pages, or web pages that you have authorization to * index. *
* @public */ Urls: Urls | undefined; /** *The 'depth' or number of levels from the seed level to crawl. For example, the seed * URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.
* @public */ CrawlDepth?: number | undefined; /** *The maximum number of URLs on a web page to include when crawling a website. This * number is per web page.
*As a website’s web pages are crawled, any URLs the web pages link to are also crawled. * URLs on a web page are crawled in order of appearance.
*The default maximum links per page is 100.
* @public */ MaxLinksPerPage?: number | undefined; /** *The maximum size (in MB) of a web page or attachment to crawl.
*Files larger than this size (in MB) are skipped/not crawled.
*The default maximum size of a web page or attachment is set to 50 MB.
* @public */ MaxContentSizePerPageInMegaBytes?: number | undefined; /** *The maximum number of URLs crawled per website host per minute.
*A minimum of one URL is required.
*The default maximum number of URLs crawled per website host per minute is 300.
* @public */ MaxUrlsPerMinuteCrawlRate?: number | undefined; /** *A list of regular expression patterns to include certain URLs to crawl. URLs that * match the patterns are included in the index. URLs that don't match the patterns are * excluded from the index. If a URL matches both an inclusion and exclusion pattern, the * exclusion pattern takes precedence and the URL file isn't included in the index.
* @public */ UrlInclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain URLs to crawl. URLs that * match the patterns are excluded from the index. URLs that don't match the patterns are * included in the index. If a URL matches both an inclusion and exclusion pattern, the * exclusion pattern takes precedence and the URL file isn't included in the index.
* @public */ UrlExclusionPatterns?: string[] | undefined; /** *Configuration information required to connect to your internal websites via a web * proxy.
*You must provide the website host name and port number. For example, the host name of * https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard * port for HTTPS.
*Web proxy credentials are optional and you can use them to connect to a web proxy * server that requires basic authentication. To store web proxy credentials, you use a * secret in Secrets Manager.
* @public */ ProxyConfiguration?: ProxyConfiguration | undefined; /** *Configuration information required to connect to websites using authentication.
*You can connect to websites using basic authentication of user name and password. You * use a secret in Secrets Manager to * store your authentication credentials.
*You must provide the website host name and port number. For example, the host name of * https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard * port for HTTPS.
* @public */ AuthenticationConfiguration?: AuthenticationConfiguration | undefined; } /** *Provides the configuration information to connect to Amazon WorkDocs * as your data source.
*Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland * regions.
* @public */ export interface WorkDocsConfiguration { /** *The identifier of the directory corresponding to your * Amazon WorkDocs site repository.
*You can find the organization ID in the * Directory Service by going to * Active Directory, then * Directories. Your Amazon WorkDocs site directory has an * ID, which is the organization ID. You can also set up a new Amazon WorkDocs * directory in the Directory Service console and enable a Amazon WorkDocs site * for the directory in the Amazon WorkDocs console.
* @public */ OrganizationId: string | undefined; /** *
* TRUE to include comments on documents
* in your index. Including comments in your index means each comment
* is a document that can be searched on.
The default is set to FALSE.
* TRUE to use the Amazon WorkDocs change log to determine
* which documents require updating in the index. Depending on the change log's
* size, it may take longer for Amazon Kendra to use the change log than to
* scan all of your documents in Amazon WorkDocs.
A list of regular expression patterns to include certain files * in your Amazon WorkDocs site repository. Files that match the patterns * are included in the index. Files that don't match the patterns are * excluded from the index. If a file matches both an inclusion and exclusion * pattern, the exclusion pattern takes precedence and the file isn't included * in the index.
* @public */ InclusionPatterns?: string[] | undefined; /** *A list of regular expression patterns to exclude certain files * in your Amazon WorkDocs site repository. Files that match the patterns * are excluded from the index. Files that don’t match the patterns * are included in the index. If a file matches both an inclusion and exclusion * pattern, the exclusion pattern takes precedence and the file isn't included * in the index.
* @public */ ExclusionPatterns?: string[] | undefined; /** *A list of DataSourceToIndexFieldMapping objects that
* map Amazon WorkDocs data source attributes or field names to Amazon Kendra
* index field names. To create custom fields, use the
* UpdateIndex API before you map to Amazon WorkDocs fields.
* For more information, see Mapping
* data source fields. The Amazon WorkDocs data source field names
* must exist in your Amazon WorkDocs custom metadata.
Provides the configuration information for an Amazon Kendra data source.
* @public */ export interface DataSourceConfiguration { /** *Provides the configuration information to connect to an Amazon S3 bucket as your * data source.
*Amazon Kendra now supports an upgraded Amazon S3 connector.
*You must now use the TemplateConfiguration object instead of the
* S3DataSourceConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to * function as configured. However, you won't be able to edit or update them. If you want * to edit or update your connector configuration, you must create a new connector.
*We recommended migrating your connector workflow to the upgraded version. Support for * connectors configured using the older architecture is scheduled to end by June 2024.
*Provides the configuration information to connect to Microsoft SharePoint as your data * source.
* @public */ SharePointConfiguration?: SharePointConfiguration | undefined; /** *Provides the configuration information to connect to a database as your data * source.
* @public */ DatabaseConfiguration?: DatabaseConfiguration | undefined; /** *Provides the configuration information to connect to Salesforce as your data * source.
* @public */ SalesforceConfiguration?: SalesforceConfiguration | undefined; /** *Provides the configuration information to connect to Microsoft OneDrive as your data * source.
* @public */ OneDriveConfiguration?: OneDriveConfiguration | undefined; /** *Provides the configuration information to connect to ServiceNow as your data * source.
* @public */ ServiceNowConfiguration?: ServiceNowConfiguration | undefined; /** *Provides the configuration information to connect to Confluence as your data * source.
* @public */ ConfluenceConfiguration?: ConfluenceConfiguration | undefined; /** *Provides the configuration information to connect to Google Drive as your data * source.
* @public */ GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined; /** *Provides the configuration information required for Amazon Kendra Web * Crawler.
* @public */ WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined; /** *Provides the configuration information to connect to Amazon WorkDocs as your data * source.
* @public */ WorkDocsConfiguration?: WorkDocsConfiguration | undefined; /** *Provides the configuration information to connect to Amazon FSx as your data * source.
*Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
*You must now use the TemplateConfiguration object instead of the
* FsxConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to * function as configured. However, you won't be able to edit or update them. If you want * to edit or update your connector configuration, you must create a new connector.
*We recommended migrating your connector workflow to the upgraded version. Support for * connectors configured using the older architecture is scheduled to end by June 2024.
*Provides the configuration information to connect to Slack as your data source.
*Amazon Kendra now supports an upgraded Slack connector.
*You must now use the TemplateConfiguration object instead of the
* SlackConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to * function as configured. However, you won't be able to edit or update them. If you want * to edit or update your connector configuration, you must create a new connector.
*We recommended migrating your connector workflow to the upgraded version. Support for * connectors configured using the older architecture is scheduled to end by June 2024.
*Provides the configuration information to connect to Box as your data source.
* @public */ BoxConfiguration?: BoxConfiguration | undefined; /** *Provides the configuration information to connect to Quip as your data source.
* @public */ QuipConfiguration?: QuipConfiguration | undefined; /** *Provides the configuration information to connect to Jira as your data source.
* @public */ JiraConfiguration?: JiraConfiguration | undefined; /** *Provides the configuration information to connect to GitHub as your data source.
*Amazon Kendra now supports an upgraded GitHub connector.
*You must now use the TemplateConfiguration object instead of the
* GitHubConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue * to function as configured. However, you won’t be able to edit or update them. If you * want to edit or update your connector configuration, you must create a new * connector.
*We recommended migrating your connector workflow to the upgraded version. Support * for connectors configured using the older architecture is scheduled to end by June * 2024.
*Provides the configuration information to connect to Alfresco as your data source.
*Support for AlfrescoConfiguration ended May 2023.
* We recommend migrating to or using the Alfresco data source template
* schema / TemplateConfiguration
* API.
Provides a template for the configuration information to connect to your data * source.
* @public */ TemplateConfiguration?: TemplateConfiguration | undefined; } /** *A key-value pair that identifies or categorizes an index, FAQ, * data source, or other resource. TA tag key and value can consist of Unicode letters, * digits, white space, and any of the following symbols: _ . : / = + - @.
* @public */ export interface Tag { /** *The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, * data source, or other resource.
* @public */ Key: string | undefined; /** *The value associated with the tag. The value may be an empty string but it can't be * null.
* @public */ Value: string | undefined; } /** * @public */ export interface CreateDataSourceRequest { /** *A name for the data source connector.
* @public */ Name: string | undefined; /** *The identifier of the index you want to use with the data source connector.
* @public */ IndexId: string | undefined; /** *The type of data source repository. For example, SHAREPOINT.
Configuration information to connect to your data source repository.
*You can't specify the Configuration parameter when the Type
* parameter is set to CUSTOM. If you do, you receive a
* ValidationException exception.
The Configuration parameter is required for all other data sources.
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. * For more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; /** *A description for the data source connector.
* @public */ Description?: string | undefined; /** *Sets the frequency for Amazon Kendra to check the documents in your data source
* repository and update the index. If you don't set a schedule Amazon Kendra will not
* periodically update the index. You can call the StartDataSourceSyncJob API to
* update the index.
Specify a cron- format schedule string or an empty string to indicate that
* the index is updated on demand.
You can't specify the Schedule parameter when the Type parameter
* is set to CUSTOM. If you do, you receive a ValidationException
* exception.
The Amazon Resource Name (ARN) of an IAM role with permission to access * the data source and required resources. For more information, see IAM access roles for Amazon Kendra..
*You can't specify the RoleArn parameter when the Type parameter
* is set to CUSTOM. If you do, you receive a ValidationException
* exception.
The RoleArn parameter is required for all other data sources.
A list of key-value pairs that identify or categorize the data source connector. You * can also use tags to help control access to the data source connector. Tag keys and values * can consist of Unicode letters, digits, white space, and any of the following symbols: * _ . : / = + - @.
* @public */ Tags?: Tag[] | undefined; /** *A token that you provide to identify the request to create a data source connector.
* Multiple calls to the CreateDataSource API with the same client token will create
* only one data source connector.
The code for a language. This allows you to support a language for all * documents when creating the data source connector. English is supported * by default. For more information on supported languages, including their codes, * see Adding * documents in languages other than English.
* @public */ LanguageCode?: string | undefined; /** *Configuration information for altering document metadata and content during the * document ingestion process.
*For more information on how to create, modify and delete document metadata, or make * other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
* @public */ CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | undefined; } /** * @public */ export interface CreateDataSourceResponse { /** *The identifier of the data source connector.
* @public */ Id: string | undefined; } /** *Provides the configuration information for your content sources, such as data sources, * FAQs, and content indexed directly via BatchPutDocument.
* @public */ export interface ContentSourceConfiguration { /** *The identifier of the data sources you want to use for your Amazon Kendra experience.
* @public */ DataSourceIds?: string[] | undefined; /** *The identifier of the FAQs that you want to use for your Amazon Kendra experience.
* @public */ FaqIds?: string[] | undefined; /** *
* TRUE to use documents you indexed directly using the
* BatchPutDocument API.
Provides the configuration information for the identifiers of your users.
* @public */ export interface UserIdentityConfiguration { /** *The IAM Identity Center field name that contains the identifiers of your users, * such as their emails. This is used for user context filtering * and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center * with Amazon Kendra. You must include your users and groups in your Access Control List when * you ingest documents into your index. For more information, see * Getting * started with an IAM Identity Center identity source.
* @public */ IdentityAttributeName?: string | undefined; } /** *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.
* @public */ export interface ExperienceConfiguration { /** *The identifiers of your data sources and FAQs. Or, you can specify
* that you want to use documents indexed via the BatchPutDocument
* API. This is the content you want to use for your Amazon Kendra experience.
The IAM Identity Center field name that contains the identifiers of your users, * such as their emails.
* @public */ UserIdentityConfiguration?: UserIdentityConfiguration | undefined; } /** * @public */ export interface CreateExperienceRequest { /** *A name for your Amazon Kendra experience.
* @public */ Name: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission to access
* Query API, GetQuerySuggestions API, and other required APIs.
* The role also must include permission to access IAM Identity Center that stores your
* user and group information. For more information, see IAM access roles for Amazon Kendra.
Configuration information for your Amazon Kendra experience. This includes
* ContentSourceConfiguration, which specifies the data source IDs
* and/or FAQ IDs, and UserIdentityConfiguration, which specifies the
* user or group information to grant access to your Amazon Kendra experience.
A description for your Amazon Kendra experience.
* @public */ Description?: string | undefined; /** *A token that you provide to identify the request to create your Amazon Kendra experience.
* Multiple calls to the CreateExperience API with the same client
* token creates only one Amazon Kendra experience.
The identifier of your Amazon Kendra experience.
* @public */ Id: string | undefined; } /** * @public */ export interface CreateFaqRequest { /** *The identifier of the index for the FAQ.
* @public */ IndexId: string | undefined; /** *A name for the FAQ.
* @public */ Name: string | undefined; /** *A description for the FAQ.
* @public */ Description?: string | undefined; /** *The path to the FAQ file in S3.
* @public */ S3Path: S3Path | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission to access * the S3 bucket that contains the FAQ file. For more information, see IAM access roles for * Amazon Kendra.
* @public */ RoleArn: string | undefined; /** *A list of key-value pairs that identify the FAQ. You can use the tags to identify and * organize your resources and to control access to resources.
* @public */ Tags?: Tag[] | undefined; /** *The format of the FAQ input file. You can choose between a basic CSV format, a CSV * format that includes customs attributes in a header, and a JSON format that includes * custom attributes.
*The default format is CSV.
*The format must match the format of the file stored in the S3 bucket identified in
* the S3Path parameter.
For more information, see Adding questions and * answers.
* @public */ FileFormat?: FaqFileFormat | undefined; /** *A token that you provide to identify the request to create a FAQ. Multiple calls to
* the CreateFaqRequest API with the same client token will create only one
* FAQ.
The code for a language. This allows you to support a language * for the FAQ document. English is supported by default. * For more information on supported languages, including their codes, * see Adding * documents in languages other than English.
* @public */ LanguageCode?: string | undefined; } /** * @public */ export interface CreateFaqResponse { /** *The identifier of the FAQ.
* @public */ Id?: string | undefined; } /** *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.
* @public */ export interface FeaturedDocument { /** *The identifier of the document to feature in the search results. You can * use the Query API to search for * specific documents with their document IDs included in the result items, * or you can use the console.
* @public */ Id?: string | undefined; } /** * @public */ export interface CreateFeaturedResultsSetRequest { /** *The identifier of the index that you want to use for featuring results.
* @public */ IndexId: string | undefined; /** *A name for the set of featured results.
* @public */ FeaturedResultsSetName: string | undefined; /** *A description for the set of featured results.
* @public */ Description?: string | undefined; /** *A token that you provide to identify the request to create a set of
* featured results. Multiple calls to the CreateFeaturedResultsSet
* API with the same client token will create only one featured results set.
The current status of the set of featured results. When the value is
* ACTIVE, featured results are ready for use. You can still
* configure your settings before setting the status to ACTIVE.
* You can set the status to ACTIVE or INACTIVE
* using the UpdateFeaturedResultsSet API. The queries you specify for
* featured results must be unique per featured results set for each index,
* whether the status is ACTIVE or INACTIVE.
A list of queries for featuring results. For more information on the * list of queries, see FeaturedResultsSet.
* @public */ QueryTexts?: string[] | undefined; /** *A list of document IDs for the documents you want to feature at the * top of the search results page. For more information on the list of * documents, see FeaturedResultsSet.
* @public */ FeaturedDocuments?: FeaturedDocument[] | undefined; /** *A list of key-value pairs that identify or categorize the featured results set. You * can also use tags to help control access to the featured results set. Tag keys and * values can consist of Unicode letters, digits, white space, and any of the following * symbols:_ . : / = + - @.
* @public */ Tags?: Tag[] | undefined; } /** *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.
* @public */ export interface FeaturedResultsSet { /** *The identifier of the set of featured results.
* @public */ FeaturedResultsSetId?: string | undefined; /** *The name for the set of featured results.
* @public */ FeaturedResultsSetName?: string | undefined; /** *The description for the set of featured results.
* @public */ Description?: string | undefined; /** *The current status of the set of featured results. When the value is
* ACTIVE, featured results are ready for use. You can still
* configure your settings before setting the status to ACTIVE.
* You can set the status to ACTIVE or INACTIVE
* using the UpdateFeaturedResultsSet API. The queries you specify for
* featured results must be unique per featured results set for each index,
* whether the status is ACTIVE or INACTIVE.
The list of queries for featuring results.
*Specific queries are mapped to specific documents for featuring in * the results. If a query contains an exact match, then one or more * specific documents are featured in the results. The exact match applies * to the full query. For example, if you only specify 'Kendra', queries * such as 'How does kendra semantically rank results?' will not render the * featured results. Featured results are designed for specific queries, * rather than queries that are too broad in scope.
* @public */ QueryTexts?: string[] | undefined; /** *The list of document IDs for the documents you want to feature at the * top of the search results page. You can use the Query API to search for * specific documents with their document IDs included in the result items, * or you can use the console.
*You can add up to four featured documents. You can request to increase this * limit by contacting Support.
*Specific queries are mapped to specific documents for featuring in the * results. If a query contains an exact match, then one or more specific * documents are featured in the results. The exact match applies to the full * query. For example, if you only specify 'Kendra', queries such as 'How does * kendra semantically rank results?' will not render the featured results. * Featured results are designed for specific queries, rather than queries * that are too broad in scope.
* @public */ FeaturedDocuments?: FeaturedDocument[] | undefined; /** *The Unix timestamp when the set of featured results was last updated.
* @public */ LastUpdatedTimestamp?: number | undefined; /** *The Unix timestamp when the set of featured results was created.
* @public */ CreationTimestamp?: number | undefined; } /** * @public */ export interface CreateFeaturedResultsSetResponse { /** *Information on the set of featured results. This includes the identifier of * the featured results set, whether the featured results set is active or inactive, * when the featured results set was created, and more.
* @public */ FeaturedResultsSet?: FeaturedResultsSet | undefined; } /** *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.
* @public */ export interface ConflictingItem { /** *The text of the conflicting query.
* @public */ QueryText?: string | undefined; /** *The name for the set of featured results that the conflicting query * belongs to.
* @public */ SetName?: string | undefined; /** *The identifier of the set of featured results that the conflicting * query belongs to.
* @public */ SetId?: string | undefined; } /** *Provides the identifier of the KMS key used to encrypt data * indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric * keys.
* @public */ export interface ServerSideEncryptionConfiguration { /** *The identifier of the KMS key. Amazon Kendra doesn't support * asymmetric keys.
* @public */ KmsKeyId?: string | undefined; } /** *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.
*To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see Getting started with an IAM Identity Center identity source. You must also grant the required permissions to * use IAM Identity Center with Amazon Kendra. For more information, see IAM roles for IAM Identity Center.
*Amazon Kendra currently does not support using
* UserGroupResolutionConfiguration with an Amazon Web Services organization
* member account for your IAM Identity Center identify source. You must create your index in
* the management account for the organization in order to use
* UserGroupResolutionConfiguration.
If you're using an Amazon Kendra Gen AI Enterprise Edition index,
* UserGroupResolutionConfiguration isn't supported.
The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in * an IAM Identity Center identity source in order to use this mode.
* @public */ UserGroupResolutionMode: UserGroupResolutionMode | undefined; } /** *Provides the configuration information for the JSON token type.
* @public */ export interface JsonTokenTypeConfiguration { /** *The user name attribute field.
* @public */ UserNameAttributeField: string | undefined; /** *The group attribute field.
* @public */ GroupAttributeField: string | undefined; } /** *Provides the configuration information for the JWT token type.
* @public */ export interface JwtTokenTypeConfiguration { /** *The location of the key.
* @public */ KeyLocation: KeyLocation | undefined; /** *The signing key URL.
* @public */ URL?: string | undefined; /** *The Amazon Resource Name (arn) of the secret.
* @public */ SecretManagerArn?: string | undefined; /** *The user name attribute field.
* @public */ UserNameAttributeField?: string | undefined; /** *The group attribute field.
* @public */ GroupAttributeField?: string | undefined; /** *The issuer of the token.
* @public */ Issuer?: string | undefined; /** *The regular expression that identifies the claim.
* @public */ ClaimRegex?: string | undefined; } /** *Provides the configuration information for a token.
*If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
* UserTokenConfigurations to configure user context policy, Amazon Kendra returns
* a ValidationException error.
Information about the JWT token type configuration.
* @public */ JwtTokenTypeConfiguration?: JwtTokenTypeConfiguration | undefined; /** *Information about the JSON token type configuration.
* @public */ JsonTokenTypeConfiguration?: JsonTokenTypeConfiguration | undefined; } /** * @public */ export interface CreateIndexRequest { /** *A name for the index.
* @public */ Name: string | undefined; /** *The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION
* for indexes intended for development, testing, or proof of concept. Use
* ENTERPRISE_EDITION for production. Use GEN_AI_ENTERPRISE_EDITION
* for creating generative AI applications. Once you set the edition for an index, it can't be
* changed.
The Edition parameter is optional. If you don't supply a value, the default
* is ENTERPRISE_EDITION.
For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and * Developer Edition indices, see Quotas.
* @public */ Edition?: IndexEdition | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission to access * your Amazon CloudWatch logs and metrics. For more information, see IAM access roles * for Amazon Kendra.
* @public */ RoleArn: string | undefined; /** *The identifier of the KMS customer managed key (CMK) that's used to encrypt * data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
* @public */ ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined; /** *A description for the index.
* @public */ Description?: string | undefined; /** *A token that you provide to identify the request to create an index. Multiple calls to the
* CreateIndex API with the same client token will create only one index.
A list of key-value pairs that identify or categorize the index. You can also use tags to * help control access to the index. Tag keys and values can consist of Unicode letters, digits, * white space, and any of the following symbols: _ . : / = + - @.
* @public */ Tags?: Tag[] | undefined; /** *The user token configuration.
*If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
* UserTokenConfigurations to configure user context policy, Amazon Kendra returns
* a ValidationException error.
The user context policy.
*If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
* ATTRIBUTE_FILTER to filter search results by user context. If you're
* using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
* USER_TOKEN to configure user context policy, Amazon Kendra returns a
* ValidationException error.
All indexed content is searchable and displayable for all users. If you want to
* filter search results on user context, you can use the attribute filters of
* _user_id and _group_ids or you can provide user and
* group information in UserContext.
Enables token-based user access control to filter search results on user * context. All documents with no access control and all documents accessible to the * user will be searchable and displayable.
*Gets users and groups from IAM Identity Center identity source. To configure this, * see UserGroupResolutionConfiguration. This is useful for user context filtering, * where search results are filtered based on the user or their group access to * documents.
*If you're using an Amazon Kendra Gen AI Enterprise Edition index,
* UserGroupResolutionConfiguration isn't supported.
The identifier of the index. Use this identifier when you query an index, set up a data * source, or index a document.
* @public */ Id?: string | undefined; } /** * @public */ export interface CreateQuerySuggestionsBlockListRequest { /** *The identifier of the index you want to create a query suggestions block list for.
* @public */ IndexId: string | undefined; /** *A name for the block list.
*For example, the name 'offensive-words', which includes all * offensive words that could appear in user queries and need to be * blocked from suggestions.
* @public */ Name: string | undefined; /** *A description for the block list.
*For example, the description "List of all offensive words that can * appear in user queries and need to be blocked from suggestions."
* @public */ Description?: string | undefined; /** *The S3 path to your block list text file in your S3 bucket.
*Each block word or phrase should be on a separate line in a text file.
*For information on the current quota limits for block lists, see * Quotas * for Amazon Kendra.
* @public */ SourceS3Path: S3Path | undefined; /** *A token that you provide to identify the request to create a * query suggestions block list.
* @public */ ClientToken?: string | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission to * access your S3 bucket that contains the block list text file. For more information, * see IAM access roles for * Amazon Kendra.
* @public */ RoleArn: string | undefined; /** *A list of key-value pairs that identify or categorize the block list. * Tag keys and values can consist of Unicode letters, digits, white space, * and any of the following symbols: _ . : / = + - @.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface CreateQuerySuggestionsBlockListResponse { /** *The identifier of the block list.
* @public */ Id?: string | undefined; } /** * @public */ export interface CreateThesaurusRequest { /** *The identifier of the index for the thesaurus.
* @public */ IndexId: string | undefined; /** *A name for the thesaurus.
* @public */ Name: string | undefined; /** *A description for the thesaurus.
* @public */ Description?: string | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission * to access your S3 bucket that contains the thesaurus file. For more information, * see IAM * access roles for Amazon Kendra.
* @public */ RoleArn: string | undefined; /** *A list of key-value pairs that identify or categorize the thesaurus. You can * also use tags to help control access to the thesaurus. Tag keys and values can * consist of Unicode letters, digits, white space, and any of the following * symbols: _ . : / = + - @.
* @public */ Tags?: Tag[] | undefined; /** *The path to the thesaurus file in S3.
* @public */ SourceS3Path: S3Path | undefined; /** *A token that you provide to identify the request to create a
* thesaurus. Multiple calls to the CreateThesaurus API
* with the same client token will create only one thesaurus.
*
The identifier of the thesaurus. *
* @public */ Id?: string | undefined; } /** * @public */ export interface DeleteAccessControlConfigurationRequest { /** *The identifier of the index for an access control configuration.
* @public */ IndexId: string | undefined; /** *The identifier of the access control configuration you want to delete.
* @public */ Id: string | undefined; } /** * @public */ export interface DeleteAccessControlConfigurationResponse { } /** * @public */ export interface DeleteDataSourceRequest { /** *The identifier of the data source connector you want to delete.
* @public */ Id: string | undefined; /** *The identifier of the index used with the data source connector.
* @public */ IndexId: string | undefined; } /** * @public */ export interface DeleteExperienceRequest { /** *The identifier of your Amazon Kendra experience you want to delete.
* @public */ Id: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; } /** * @public */ export interface DeleteExperienceResponse { } /** * @public */ export interface DeleteFaqRequest { /** *The identifier of the FAQ you want to remove.
* @public */ Id: string | undefined; /** *The identifier of the index for the FAQ.
* @public */ IndexId: string | undefined; } /** * @public */ export interface DeleteIndexRequest { /** *The identifier of the index you want to delete.
* @public */ Id: string | undefined; } /** * @public */ export interface DeletePrincipalMappingRequest { /** *The identifier of the index you want to delete a group from.
* @public */ IndexId: string | undefined; /** *The identifier of the data source you want to delete a group from.
*A group can be tied to multiple data sources. You can delete a group from accessing * documents in a certain data source. For example, the groups "Research", "Engineering", * and "Sales and Marketing" are all tied to the company's documents stored in the data * sources Confluence and Salesforce. You want to delete "Research" and "Engineering" * groups from Salesforce, so that these groups cannot access customer-related documents * stored in Salesforce. Only "Sales and Marketing" should access documents in the * Salesforce data source.
* @public */ DataSourceId?: string | undefined; /** *The identifier of the group you want to delete.
* @public */ GroupId: string | undefined; /** *The timestamp identifier you specify to ensure Amazon Kendra does not override
* the latest DELETE action with previous actions. The highest number ID,
* which is the ordering ID, is the latest action you want to process and apply on top of
* other actions with lower number IDs. This prevents previous actions with lower number
* IDs from possibly overriding the latest action.
The ordering ID can be the Unix time of the last update you made to a group members
* list. You would then provide this list when calling PutPrincipalMapping.
* This ensures your DELETE action for that updated group with the latest
* members list doesn't get overwritten by earlier DELETE actions for the same
* group which are yet to be processed.
The default ordering ID is the current Unix time in milliseconds that the action was * received by Amazon Kendra.
* @public */ OrderingId?: number | undefined; } /** * @public */ export interface DeleteQuerySuggestionsBlockListRequest { /** *The identifier of the index for the block list.
* @public */ IndexId: string | undefined; /** *The identifier of the block list you want to delete.
* @public */ Id: string | undefined; } /** * @public */ export interface DeleteThesaurusRequest { /** *The identifier of the thesaurus you want to delete.
* @public */ Id: string | undefined; /** *The identifier of the index for the thesaurus.
* @public */ IndexId: string | undefined; } /** * @public */ export interface DescribeAccessControlConfigurationRequest { /** *The identifier of the index for an access control configuration.
* @public */ IndexId: string | undefined; /** *The identifier of the access control configuration you want to get information * on.
* @public */ Id: string | undefined; } /** * @public */ export interface DescribeAccessControlConfigurationResponse { /** *The name for the access control configuration.
* @public */ Name: string | undefined; /** *The description for the access control configuration.
* @public */ Description?: string | undefined; /** *The error message containing details if there are issues processing the access control * configuration.
* @public */ ErrorMessage?: string | undefined; /** *Information on principals (users and/or groups) and which documents they should have * access to. This is useful for user context filtering, where search results are filtered * based on the user or their group access to documents.
* @public */ AccessControlList?: Principal[] | undefined; /** *The list of principal lists that define the hierarchy for which documents users should * have access to.
* @public */ HierarchicalAccessControlList?: HierarchicalPrincipal[] | undefined; } /** * @public */ export interface DescribeDataSourceRequest { /** *The identifier of the data source connector.
* @public */ Id: string | undefined; /** *The identifier of the index used with the data source connector.
* @public */ IndexId: string | undefined; } /** * @public */ export interface DescribeDataSourceResponse { /** *The identifier of the data source connector.
* @public */ Id?: string | undefined; /** *The identifier of the index used with the data source connector.
* @public */ IndexId?: string | undefined; /** *The name for the data source connector.
* @public */ Name?: string | undefined; /** *The type of the data source. For example, SHAREPOINT.
Configuration details for the data source connector. This shows how the data source is * configured. The configuration options for a data source depend on the data source * provider.
* @public */ Configuration?: DataSourceConfiguration | undefined; /** *Configuration information for an Amazon Virtual Private Cloud to connect to your data source. * For more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; /** *The Unix timestamp when the data source connector was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the data source connector was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *The description for the data source connector.
* @public */ Description?: string | undefined; /** *The current status of the data source connector. When the status is ACTIVE
* the data source is ready to use. When the status is FAILED, the
* ErrorMessage field contains the reason that the data source failed.
The schedule for Amazon Kendra to update the index.
* @public */ Schedule?: string | undefined; /** *The Amazon Resource Name (ARN) of the IAM role with permission to * access the data source and required resources.
* @public */ RoleArn?: string | undefined; /** *When the Status field value is FAILED, the
* ErrorMessage field contains a description of the error that caused the data
* source to fail.
The code for a language. This shows a supported language for all * documents in the data source. English is supported by * default. For more information on supported languages, including their codes, * see Adding * documents in languages other than English.
* @public */ LanguageCode?: string | undefined; /** *Configuration information for altering document metadata and content during the * document ingestion process when you describe a data source.
*For more information on how to create, modify and delete document metadata, or make * other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
* @public */ CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | undefined; } /** * @public */ export interface DescribeExperienceRequest { /** *The identifier of your Amazon Kendra experience you want to get information on.
* @public */ Id: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; } /** *Provides the configuration information for the endpoint for your Amazon Kendra * experience.
* @public */ export interface ExperienceEndpoint { /** *The type of endpoint for your Amazon Kendra experience. The type currently available
* is HOME, which is a unique and fully hosted URL to the home page
* of your Amazon Kendra experience.
The endpoint of your Amazon Kendra experience.
* @public */ Endpoint?: string | undefined; } /** * @public */ export interface DescribeExperienceResponse { /** *Shows the identifier of your Amazon Kendra experience.
* @public */ Id?: string | undefined; /** *Shows the identifier of the index for your Amazon Kendra experience.
* @public */ IndexId?: string | undefined; /** *Shows the name of your Amazon Kendra experience.
* @public */ Name?: string | undefined; /** *Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully * hosted by Amazon Web Services.
* @public */ Endpoints?: ExperienceEndpoint[] | undefined; /** *Shows the configuration information for your Amazon Kendra experience. This includes
* ContentSourceConfiguration, which specifies the data source IDs
* and/or FAQ IDs, and UserIdentityConfiguration, which specifies the
* user or group information to grant access to your Amazon Kendra experience.
The Unix timestamp when your Amazon Kendra experience was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when your Amazon Kendra experience was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *Shows the description for your Amazon Kendra experience.
* @public */ Description?: string | undefined; /** *The current processing status of your Amazon Kendra experience. When the status
* is ACTIVE, your Amazon Kendra experience is ready to use. When the
* status is FAILED, the ErrorMessage field contains
* the reason that this failed.
The Amazon Resource Name (ARN) of the IAM role with permission to access
* the Query API, QuerySuggestions API,
* SubmitFeedback API, and IAM Identity Center that stores
* your users and groups information.
The reason your Amazon Kendra experience could not properly process.
* @public */ ErrorMessage?: string | undefined; } /** * @public */ export interface DescribeFaqRequest { /** *The identifier of the FAQ you want to get information on.
* @public */ Id: string | undefined; /** *The identifier of the index for the FAQ.
* @public */ IndexId: string | undefined; } /** * @public */ export interface DescribeFaqResponse { /** *The identifier of the FAQ.
* @public */ Id?: string | undefined; /** *The identifier of the index for the FAQ.
* @public */ IndexId?: string | undefined; /** *The name that you gave the FAQ when it was created.
* @public */ Name?: string | undefined; /** *The description of the FAQ that you provided when it was created.
* @public */ Description?: string | undefined; /** *The Unix timestamp when the FAQ was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the FAQ was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *Information required to find a specific file in an Amazon S3 bucket.
* @public */ S3Path?: S3Path | undefined; /** *The status of the FAQ. It is ready to use when the status is
* ACTIVE.
The Amazon Resource Name (ARN) of the IAM role that provides access * to the S3 bucket containing the FAQ file.
* @public */ RoleArn?: string | undefined; /** *If the Status field is FAILED, the ErrorMessage
* field contains the reason why the FAQ failed.
The file format used for the FAQ file.
* @public */ FileFormat?: FaqFileFormat | undefined; /** *The code for a language. This shows a supported language * for the FAQ document. English is supported by default. * For more information on supported languages, including their codes, * see Adding * documents in languages other than English.
* @public */ LanguageCode?: string | undefined; } /** * @public */ export interface DescribeFeaturedResultsSetRequest { /** *The identifier of the index used for featuring results.
* @public */ IndexId: string | undefined; /** *The identifier of the set of featured results that you want to get * information on.
* @public */ FeaturedResultsSetId: string | undefined; } /** *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.
* @public */ export interface FeaturedDocumentMissing { /** *The identifier of the document that doesn't exist but you have specified * as a featured document.
* @public */ Id?: string | undefined; } /** *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.
* @public */ export interface FeaturedDocumentWithMetadata { /** *The identifier of the featured document with its metadata. You can use * the Query API to search for * specific documents with their document IDs included in the result items, * or you can use the console.
* @public */ Id?: string | undefined; /** *The main title of the featured document.
* @public */ Title?: string | undefined; /** *The source URI location of the featured document.
* @public */ URI?: string | undefined; } /** * @public */ export interface DescribeFeaturedResultsSetResponse { /** *The identifier of the set of featured results.
* @public */ FeaturedResultsSetId?: string | undefined; /** *The name for the set of featured results.
* @public */ FeaturedResultsSetName?: string | undefined; /** *The description for the set of featured results.
* @public */ Description?: string | undefined; /** *The current status of the set of featured results. When the value is
* ACTIVE, featured results are ready for use. You can still
* configure your settings before setting the status to ACTIVE.
* You can set the status to ACTIVE or INACTIVE
* using the UpdateFeaturedResultsSet API. The queries you specify for
* featured results must be unique per featured results set for each index,
* whether the status is ACTIVE or INACTIVE.
The list of queries for featuring results. For more information on the * list of queries, see FeaturedResultsSet.
* @public */ QueryTexts?: string[] | undefined; /** *The list of document IDs for the documents you want to feature with their * metadata information. For more information on the list of featured documents, * see FeaturedResultsSet.
* @public */ FeaturedDocumentsWithMetadata?: FeaturedDocumentWithMetadata[] | undefined; /** *The list of document IDs that don't exist but you have specified as featured * documents. Amazon Kendra cannot feature these documents if they don'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.
* @public */ FeaturedDocumentsMissing?: FeaturedDocumentMissing[] | undefined; /** *The timestamp when the set of featured results was last updated.
* @public */ LastUpdatedTimestamp?: number | undefined; /** *The Unix timestamp when the set of the featured results was created.
* @public */ CreationTimestamp?: number | undefined; } /** * @public */ export interface DescribeIndexRequest { /** *The identifier of the index you want to get information on.
* @public */ Id: string | undefined; } /** *Specifies additional capacity units configured for your Enterprise Edition index. You can * add and remove capacity units to fit your usage requirements.
* @public */ export interface CapacityUnitsConfiguration { /** *The amount of extra storage capacity for an index. A single capacity unit provides 30 GB * of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra * capacity units.
* @public */ StorageCapacityUnits: number | undefined; /** *The amount of extra query capacity for an index and GetQuerySuggestions * capacity.
*A single extra capacity unit for an index provides 0.1 queries per second or approximately * 8,000 queries per day. You can add up to 100 extra capacity units.
*
* GetQuerySuggestions capacity is five times the provisioned query capacity for
* an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the
* base capacity for an index is 0.1 queries per second, and GetQuerySuggestions
* capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to
* total 0.2 queries per second for an index, the GetQuerySuggestions capacity is
* 2.5 calls per second (higher than five times 0.2 queries per second).
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.
* @public */ export interface Relevance { /** *Indicates that this field determines how "fresh" a document is. For example, if
* document 1 was created on November 5, and document 2 was created on October 31, document
* 1 is "fresher" than document 2. Only applies to DATE fields.
The relative importance of the field in the search. Larger numbers provide more of a * boost than smaller numbers.
* @public */ Importance?: number | undefined; /** *Specifies the time period that the boost applies to. For example, to make the boost * apply to documents with the field value within the last month, you would use "2628000s". * Once the field value is beyond the specified range, the effect of the boost drops off. * The higher the importance, the faster the effect drops off. If you don't specify a * value, the default is 3 months. The value of the field is a numeric string followed by * the character "s", for example "86400s" for one day, or "604800s" for one week.
*Only applies to DATE fields.
Determines how values should be interpreted.
*When the RankOrder field is ASCENDING, higher numbers are
* better. For example, a document with a rating score of 10 is higher ranking than a
* document with a rating score of 1.
When the RankOrder field is DESCENDING, lower numbers are
* better. For example, in a task tracking application, a priority 1 task is more important
* than a priority 5 task.
Only applies to LONG fields.
A list of values that should be given a different boost when they appear in the result * list. For example, if you are boosting a field called "department", query terms that * match the department field are boosted in the result. However, you can add entries from * the department field to boost documents with those values higher.
*For example, you can add entries to the map with names of departments. If you add * "HR",5 and "Legal",3 those departments are given special attention when they appear in * the metadata of a document. When those terms appear they are given the specified * importance instead of the regular importance for the boost.
* @public */ ValueImportanceMap?: RecordProvides information about how a custom index field is used during a search.
* @public */ export interface Search { /** *Indicates that the field can be used to create search facets, a count of results for
* each value in the field. The default is false .
Determines whether the field is used in the search. If the Searchable
* field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for
* string fields and false for number and date fields.
Determines whether the field is returned in the query response. The default is
* true.
Determines whether the field can be used to sort the results of a query. If you
* specify sorting on a field that does not have Sortable set to
* true, Amazon Kendra returns an exception. The default is
* false.
Specifies the properties, such as relevance tuning and searchability, of an index * field.
* @public */ export interface DocumentMetadataConfiguration { /** *The name of the index field.
* @public */ Name: string | undefined; /** *The data type of the index field.
* @public */ Type: DocumentAttributeValueType | undefined; /** *Provides tuning parameters to determine how the field affects the search * results.
* @public */ Relevance?: Relevance | undefined; /** *Provides information about how the field is used during a search.
* @public */ Search?: Search | undefined; } /** *Provides statistical information about the FAQ questions and answers for an * index.
* @public */ export interface FaqStatistics { /** *The total number of FAQ questions and answers for an index.
* @public */ IndexedQuestionAnswersCount: number | undefined; } /** *Provides information about text documents indexed in an index.
* @public */ export interface TextDocumentStatistics { /** *The number of text documents indexed.
* @public */ IndexedTextDocumentsCount: number | undefined; /** *The total size, in bytes, of the indexed documents.
* @public */ IndexedTextBytes: number | undefined; } /** *Provides information about the number of documents and the number of questions and answers * in an index.
* @public */ export interface IndexStatistics { /** *The number of question and answer topics in the index.
* @public */ FaqStatistics: FaqStatistics | undefined; /** *The number of text documents indexed.
* @public */ TextDocumentStatistics: TextDocumentStatistics | undefined; } /** * @public */ export interface DescribeIndexResponse { /** *The name of the index.
* @public */ Name?: string | undefined; /** *The identifier of the index.
* @public */ Id?: string | undefined; /** *The Amazon Kendra edition used for the index. You decide the edition when you create * the index.
* @public */ Edition?: IndexEdition | undefined; /** *The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
* @public */ RoleArn?: string | undefined; /** *The identifier of the KMS customer master key (CMK) that is used to encrypt * your data. Amazon Kendra doesn't support asymmetric CMKs.
* @public */ ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined; /** *The current status of the index. When the value is ACTIVE, the index is ready
* for use. If the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
The description for the index.
* @public */ Description?: string | undefined; /** *The Unix timestamp when the index was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the index was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *Configuration information for document metadata or fields. Document metadata are fields or * attributes associated with your documents. For example, the company department name associated * with each document.
* @public */ DocumentMetadataConfigurations?: DocumentMetadataConfiguration[] | undefined; /** *Provides information about the number of FAQ questions and answers and the number of text * documents indexed.
* @public */ IndexStatistics?: IndexStatistics | undefined; /** *When the Status field value is FAILED, the
* ErrorMessage field contains a message that explains why.
For Enterprise Edition indexes, you can choose to use additional capacity to meet the * needs of your application. This contains the capacity units used for the index. A query or * document storage capacity of zero indicates that the index is using the default capacity. For * more information on the default capacity for an index and adjusting this, see Adjusting * capacity.
* @public */ CapacityUnits?: CapacityUnitsConfiguration | undefined; /** *The user token configuration for the Amazon Kendra index.
* @public */ UserTokenConfigurations?: UserTokenConfiguration[] | undefined; /** *The user context policy for the Amazon Kendra index.
* @public */ UserContextPolicy?: UserContextPolicy | undefined; /** *Whether you have enabled IAM Identity Center identity source for your users and * groups. This is useful for user context filtering, where search results are filtered based * on the user or their group access to documents.
* @public */ UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined; } /** * @public */ export interface DescribePrincipalMappingRequest { /** *The identifier of the index required to check the processing of PUT and
* DELETE actions for mapping users to their groups.
The identifier of the data source to check the processing of PUT and
* DELETE actions for mapping users to their groups.
The identifier of the group required to check the processing of PUT and
* DELETE actions for mapping users to their groups.
Summary information on the processing of PUT and DELETE
* actions for mapping users to their groups.
The current processing status of actions for mapping users to their groups. The status
* can be either PROCESSING, SUCCEEDED, DELETING,
* DELETED, or FAILED.
The Unix timestamp when an action was last updated. An action can be a PUT
* or DELETE action for mapping users to their groups.
The Unix timestamp when an action was received by Amazon Kendra. An action can
* be a PUT or DELETE action for mapping users to their groups.
The order in which actions should complete processing. An action can be a
* PUT or DELETE action for mapping users to their
* groups.
The reason an action could not be processed. An action can be a PUT or
* DELETE action for mapping users to their groups.
Shows the identifier of the index to see information on the processing of
* PUT and DELETE actions for mapping users to their
* groups.
Shows the identifier of the data source to see information on the processing of
* PUT and DELETE actions for mapping users to their
* groups.
Shows the identifier of the group to see information on the processing of
* PUT and DELETE actions for mapping users to their
* groups.
Shows the following information on the processing of PUT and
* DELETE actions for mapping users to their groups:
Status—the status can be either PROCESSING,
* SUCCEEDED, DELETING, DELETED, or
* FAILED.
Last updated—the last date-time an action was updated.
*Received—the last date-time an action was received or * submitted.
*Ordering ID—the latest action that should process and apply after * other actions.
*Failure reason—the reason an action could not be processed.
*The identifier of the index for the block list.
* @public */ IndexId: string | undefined; /** *The identifier of the block list you want to get information on.
* @public */ Id: string | undefined; } /** * @public */ export interface DescribeQuerySuggestionsBlockListResponse { /** *The identifier of the index for the block list.
* @public */ IndexId?: string | undefined; /** *The identifier of the block list.
* @public */ Id?: string | undefined; /** *The name of the block list.
* @public */ Name?: string | undefined; /** *The description for the block list.
* @public */ Description?: string | undefined; /** *The current status of the block list. When the value is
* ACTIVE, the block list is ready for use.
The error message containing details if there are issues processing * the block list.
* @public */ ErrorMessage?: string | undefined; /** *The Unix timestamp when a block list for query suggestions was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when a block list for query suggestions was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *Shows the current S3 path to your block list text file in your S3 bucket.
*Each block word or phrase should be on a separate line in a text file.
*For information on the current quota limits for block lists, see * Quotas * for Amazon Kendra.
* @public */ SourceS3Path?: S3Path | undefined; /** *The current number of valid, non-empty words or phrases in * the block list text file.
* @public */ ItemCount?: number | undefined; /** *The current size of the block list text file in S3.
* @public */ FileSizeBytes?: number | undefined; /** *The IAM (Identity and Access Management) role used by * Amazon Kendra to access the block list text file in S3.
*The role needs S3 read permissions to your file in S3 and needs to * give STS (Security Token Service) assume role permissions to * Amazon Kendra.
* @public */ RoleArn?: string | undefined; } /** * @public */ export interface DescribeQuerySuggestionsConfigRequest { /** *The identifier of the index with query suggestions that you want to get * information on.
* @public */ IndexId: string | undefined; } /** * @public */ export interface DescribeQuerySuggestionsConfigResponse { /** *Whether query suggestions are currently in
* ENABLED mode or LEARN_ONLY mode.
By default, Amazon Kendra enables query suggestions.LEARN_ONLY
* turns off query suggestions for your users. You can change the mode using
* the UpdateQuerySuggestionsConfig
* API.
Whether the status of query suggestions settings is currently
* ACTIVE or UPDATING.
Active means the current settings apply and Updating means your * changed settings are in the process of applying.
* @public */ Status?: QuerySuggestionsStatus | undefined; /** *How recent your queries are in your query log time * window (in days).
* @public */ QueryLogLookBackWindowInDays?: number | undefined; /** *
* TRUE to use all queries, otherwise use only queries that include
* user information to generate the query suggestions.
The minimum number of unique users who must search a query in * order for the query to be eligible to suggest to your users.
* @public */ MinimumNumberOfQueryingUsers?: number | undefined; /** *The minimum number of times a query must be searched in order for * the query to be eligible to suggest to your users.
* @public */ MinimumQueryCount?: number | undefined; /** *The Unix timestamp when query suggestions for an index was last updated.
*Amazon Kendra automatically updates suggestions every 24 hours, after you * change a setting or after you apply a block list.
* @public */ LastSuggestionsBuildTime?: Date | undefined; /** *The Unix timestamp when query suggestions for an index was last cleared.
*After you clear suggestions, Amazon Kendra learns new suggestions based * on new queries added to the query log from the time you cleared suggestions. * Amazon Kendra only considers re-occurences of a query from the time you cleared * suggestions.
* @public */ LastClearTime?: Date | undefined; /** *The current total count of query suggestions for an index.
*This count can change when you update your query suggestions settings, * if you filter out certain queries from suggestions using a block list, * and as the query log accumulates more queries for Amazon Kendra to learn from.
*If the count is much lower than you expected, it could be because Amazon Kendra * needs more queries in the query history to learn from or your current query suggestions * settings are too strict.
* @public */ TotalSuggestionsCount?: number | undefined; /** *Configuration information for the document fields/attributes that you want to base query * suggestions on.
* @public */ AttributeSuggestionsConfig?: AttributeSuggestionsDescribeConfig | undefined; } /** * @public */ export interface DescribeThesaurusRequest { /** *The identifier of the thesaurus you want to get information on.
* @public */ Id: string | undefined; /** *The identifier of the index for the thesaurus.
* @public */ IndexId: string | undefined; } /** * @public */ export interface DescribeThesaurusResponse { /** *The identifier of the thesaurus.
* @public */ Id?: string | undefined; /** *The identifier of the index for the thesaurus.
* @public */ IndexId?: string | undefined; /** *The thesaurus name.
* @public */ Name?: string | undefined; /** *The thesaurus description.
* @public */ Description?: string | undefined; /** *The current status of the thesaurus. When the value is ACTIVE,
* queries are able to use the thesaurus. If the Status field value
* is FAILED, the ErrorMessage field provides
* more information.
*
If the status is ACTIVE_BUT_UPDATE_FAILED, it means
* that Amazon Kendra could not ingest the new thesaurus file. The old
* thesaurus file is still active.
*
When the Status field value is FAILED, the
* ErrorMessage field provides more information.
*
The Unix timestamp when the thesaurus was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the thesaurus was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *An IAM role that gives Amazon Kendra permissions
* to access thesaurus file specified in SourceS3Path.
*
Information required to find a specific file in an Amazon S3 bucket.
* @public */ SourceS3Path?: S3Path | undefined; /** *The size of the thesaurus file in bytes.
* @public */ FileSizeBytes?: number | undefined; /** *The number of unique terms in the thesaurus file. For example, the
* synonyms a,b,c and a=>d, the term
* count would be 4.
*
The number of synonym rules in the thesaurus file.
* @public */ SynonymRuleCount?: number | undefined; } /** * @public */ export interface DisassociateEntitiesFromExperienceRequest { /** *The identifier of your Amazon Kendra experience.
* @public */ Id: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *Lists users or groups in your IAM Identity Center identity source.
* @public */ EntityList: EntityConfiguration[] | undefined; } /** * @public */ export interface DisassociateEntitiesFromExperienceResponse { /** *Lists the users or groups in your IAM Identity Center identity source that * failed to properly remove access to your Amazon Kendra experience.
* @public */ FailedEntityList?: FailedEntity[] | undefined; } /** * @public */ export interface DisassociatePersonasFromEntitiesRequest { /** *The identifier of your Amazon Kendra experience.
* @public */ Id: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *The identifiers of users or groups in your IAM Identity Center identity * source. For example, user IDs could be user emails.
* @public */ EntityIds: string[] | undefined; } /** * @public */ export interface DisassociatePersonasFromEntitiesResponse { /** *Lists the users or groups in your IAM Identity Center identity source that * failed to properly remove access to your Amazon Kendra experience.
* @public */ FailedEntityList?: FailedEntity[] | undefined; } /** *The document ID and its fields/attributes that are used for a query suggestion, if * document fields set to use for query suggestions.
* @public */ export interface SourceDocument { /** *The identifier of the document used for a query suggestion.
* @public */ DocumentId?: string | undefined; /** *The document fields/attributes used for a query suggestion.
* @public */ SuggestionAttributes?: string[] | undefined; /** *The additional fields/attributes to include in the response. You can use additional * fields to provide extra information in the response. Additional fields are not used * to based suggestions on.
* @public */ AdditionalAttributes?: DocumentAttribute[] | undefined; } /** *The text highlights for a single query suggestion.
* @public */ export interface SuggestionHighlight { /** *The zero-based location in the response string where the highlight starts.
* @public */ BeginOffset?: number | undefined; /** *The zero-based location in the response string where the highlight ends.
* @public */ EndOffset?: number | undefined; } /** *Provides text and information about where to highlight the query suggestion text.
* @public */ export interface SuggestionTextWithHighlights { /** *The query suggestion text to display to the user.
* @public */ Text?: string | undefined; /** *The beginning and end of the query suggestion text that should be highlighted.
* @public */ Highlights?: SuggestionHighlight[] | undefined; } /** *The SuggestionTextWithHighlights structure information.
The SuggestionTextWithHighlights structure that contains
* the query suggestion text and highlights.
A single query suggestion.
* @public */ export interface Suggestion { /** *The UUID (universally unique identifier) of a single * query suggestion.
* @public */ Id?: string | undefined; /** *The value for the UUID (universally unique identifier) * of a single query suggestion.
*The value is the text string of a suggestion.
* @public */ Value?: SuggestionValue | undefined; /** *The list of document IDs and their fields/attributes that are used for a * single query suggestion, if document fields set to use for query suggestions.
* @public */ SourceDocuments?: SourceDocument[] | undefined; } /** * @public */ export interface GetQuerySuggestionsResponse { /** *The identifier for a list of query suggestions for an index.
* @public */ QuerySuggestionsId?: string | undefined; /** *A list of query suggestions for an index.
* @public */ Suggestions?: Suggestion[] | undefined; } /** * @public */ export interface GetSnapshotsRequest { /** *The identifier of the index to get search metrics data.
* @public */ IndexId: string | undefined; /** *The time interval or time window to get search metrics data. The time interval uses * the time zone of your index. You can view data in the following time windows:
*
* THIS_WEEK: The current week, starting on the Sunday and ending on
* the day before the current date.
* ONE_WEEK_AGO: The previous week, starting on the Sunday and
* ending on the following Saturday.
* TWO_WEEKS_AGO: The week before the previous week, starting on the
* Sunday and ending on the following Saturday.
* THIS_MONTH: The current month, starting on the first day of the
* month and ending on the day before the current date.
* ONE_MONTH_AGO: The previous month, starting on the first day of
* the month and ending on the last day of the month.
* TWO_MONTHS_AGO: The month before the previous month, starting on
* the first day of the month and ending on last day of the month.
The metric you want to retrieve. You can specify only one metric per call.
*For more information about the metrics you can view, see Gaining insights with search * analytics.
* @public */ MetricType: MetricType | undefined; /** *If the previous response was incomplete (because there is more data to retrieve), * Amazon Kendra returns a pagination token in the response. You can use this * pagination token to retrieve the next set of search metrics data.
* @public */ NextToken?: string | undefined; /** *The maximum number of returned data for the metric.
* @public */ MaxResults?: number | undefined; } /** *Provides a range of time.
* @public */ export interface TimeRange { /** *The Unix timestamp for the beginning of the time range.
* @public */ StartTime?: Date | undefined; /** *The Unix timestamp for the end of the time range.
* @public */ EndTime?: Date | undefined; } /** * @public */ export interface GetSnapshotsResponse { /** *The Unix timestamp for the beginning and end of the time window for the * search metrics data.
* @public */ SnapShotTimeFilter?: TimeRange | undefined; /** *The column headers for the search metrics data.
* @public */ SnapshotsDataHeader?: string[] | undefined; /** *The search metrics data. The data returned depends on the metric type you * requested.
* @public */ SnapshotsData?: string[][] | undefined; /** *If the response is truncated, Amazon Kendra returns this token, which you can use * in a later request to retrieve the next set of search metrics data.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAccessControlConfigurationsRequest { /** *The identifier of the index for the access control configuration.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there's more data to retrieve), * Amazon Kendra returns a pagination token in the response. You can use this * pagination token to retrieve the next set of access control configurations.
* @public */ NextToken?: string | undefined; /** *The maximum number of access control configurations to return.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListAccessControlConfigurationsResponse { /** *If the response is truncated, Amazon Kendra returns this token, which you can use * in the subsequent request to retrieve the next set of access control * configurations.
* @public */ NextToken?: string | undefined; /** *The details of your access control configurations.
* @public */ AccessControlConfigurations: AccessControlConfigurationSummary[] | undefined; } /** * @public */ export interface ListDataSourcesRequest { /** *The identifier of the index used with one or more data source connectors.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to * retrieve the next set of data source connectors.
* @public */ NextToken?: string | undefined; /** *The maximum number of data source connectors to return.
* @public */ MaxResults?: number | undefined; } /** *Summary information for a Amazon Kendra data source.
* @public */ export interface DataSourceSummary { /** *The name of the data source.
* @public */ Name?: string | undefined; /** *The identifier for the data source.
* @public */ Id?: string | undefined; /** *The type of the data source.
* @public */ Type?: DataSourceType | undefined; /** *The Unix timestamp when the data source connector was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the data source connector was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *The status of the data source. When the status is ACTIVE the data source is
* ready to use.
The code for a language. This shows a supported language for all documents * in the data source. English is supported by default. * For more information on supported languages, including their codes, * see Adding * documents in languages other than English.
* @public */ LanguageCode?: string | undefined; } /** * @public */ export interface ListDataSourcesResponse { /** *An array of summary information for one or more data source connector.
* @public */ SummaryItems?: DataSourceSummary[] | undefined; /** *If the response is truncated, Amazon Kendra returns this token that you can use in * the subsequent request to retrieve the next set of data source connectors.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListDataSourceSyncJobsRequest { /** *The identifier of the data source connector.
* @public */ Id: string | undefined; /** *The identifier of the index used with the data source connector.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to * retrieve the next set of jobs.
* @public */ NextToken?: string | undefined; /** *The maximum number of synchronization jobs to return in the response. If there are fewer * results in the list, this response contains only the actual results.
* @public */ MaxResults?: number | undefined; /** *When specified, the synchronization jobs returned in the list are limited to jobs between * the specified dates.
* @public */ StartTimeFilter?: TimeRange | undefined; /** *Only returns synchronization jobs with the Status field equal to the
* specified status.
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.
* @public */ export interface DataSourceSyncJobMetrics { /** *The number of documents added from the data source up to now in the data source * sync.
* @public */ DocumentsAdded?: string | undefined; /** *The number of documents modified in the data source up to now in the data source sync * run.
* @public */ DocumentsModified?: string | undefined; /** *The number of documents deleted from the data source up to now in the data source sync * run.
* @public */ DocumentsDeleted?: string | undefined; /** *The number of documents that failed to sync from the data source up to now in the data * source sync run.
* @public */ DocumentsFailed?: string | undefined; /** *The current number of documents crawled by the current sync job in the data source.
* @public */ DocumentsScanned?: string | undefined; } /** *Provides information about a data source synchronization job.
* @public */ export interface DataSourceSyncJob { /** *A identifier for the synchronization job.
* @public */ ExecutionId?: string | undefined; /** *The Unix timestamp when the synchronization job started.
* @public */ StartTime?: Date | undefined; /** *The Unix timestamp when the synchronization job completed.
* @public */ EndTime?: Date | undefined; /** *The execution status of the synchronization job. When the Status field is set
* to SUCCEEDED, the synchronization job is done. If the status code is set to
* FAILED, the ErrorCode and ErrorMessage fields give
* you the reason for the failure.
If the Status field is set to ERROR, the
* ErrorMessage field contains a description of the error that caused the
* synchronization to fail.
If the Status field is set to FAILED, the ErrorCode
* field indicates the reason the synchronization failed.
If the reason that the synchronization failed is due to an error with the underlying data * source, this field contains a code that identifies the error.
* @public */ DataSourceErrorCode?: string | undefined; /** *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.
* @public */ Metrics?: DataSourceSyncJobMetrics | undefined; } /** * @public */ export interface ListDataSourceSyncJobsResponse { /** *A history of synchronization jobs for the data source connector.
* @public */ History?: DataSourceSyncJob[] | undefined; /** *If the response is truncated, Amazon Kendra returns this token that you can use in * the subsequent request to retrieve the next set of jobs.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListEntityPersonasRequest { /** *The identifier of your Amazon Kendra experience.
* @public */ Id: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there is more data to retrieve), * Amazon Kendra returns a pagination token in the response. You can use this pagination * token to retrieve the next set of users or groups.
* @public */ NextToken?: string | undefined; /** *The maximum number of returned users or groups.
* @public */ MaxResults?: number | undefined; } /** *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.
* @public */ export interface PersonasSummary { /** *The identifier of a user or group in your IAM Identity Center identity source. * For example, a user ID could be an email.
* @public */ EntityId?: string | undefined; /** *The persona that defines the specific permissions of the user or group in
* your IAM Identity Center identity source. The available personas or access
* roles are Owner and Viewer. For more information on
* these personas, see Providing
* access to your search page.
The Unix timestamp when the summary information was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the summary information was last updated.
* @public */ UpdatedAt?: Date | undefined; } /** * @public */ export interface ListEntityPersonasResponse { /** *An array of summary information for one or more users or groups.
* @public */ SummaryItems?: PersonasSummary[] | undefined; /** *If the response is truncated, Amazon Kendra returns this token, which you can use in * a later request to retrieve the next set of users or groups.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListExperienceEntitiesRequest { /** *The identifier of your Amazon Kendra experience.
* @public */ Id: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there is more data to retrieve), * Amazon Kendra returns a pagination token in the response. You can use this pagination * token to retrieve the next set of users or groups.
* @public */ NextToken?: string | undefined; } /** *Information about the user entity.
* @public */ export interface EntityDisplayData { /** *The name of the user.
* @public */ UserName?: string | undefined; /** *The name of the group.
* @public */ GroupName?: string | undefined; /** *The user name of the user.
* @public */ IdentifiedUserName?: string | undefined; /** *The first name of the user.
* @public */ FirstName?: string | undefined; /** *The last name of the user.
* @public */ LastName?: string | undefined; } /** *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.
* @public */ export interface ExperienceEntitiesSummary { /** *The identifier of a user or group in your IAM Identity Center identity source. * For example, a user ID could be an email.
* @public */ EntityId?: string | undefined; /** *Shows the type as User or Group.
Information about the user entity.
* @public */ DisplayData?: EntityDisplayData | undefined; } /** * @public */ export interface ListExperienceEntitiesResponse { /** *An array of summary information for one or more users or groups.
* @public */ SummaryItems?: ExperienceEntitiesSummary[] | undefined; /** *If the response is truncated, Amazon Kendra returns this token, which you can use in * a later request to retrieve the next set of users or groups.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListExperiencesRequest { /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there is more data * to retrieve), Amazon Kendra returns a pagination token in the response. You can use this * pagination token to retrieve the next set of Amazon Kendra experiences.
* @public */ NextToken?: string | undefined; /** *The maximum number of returned Amazon Kendra experiences.
* @public */ MaxResults?: number | undefined; } /** *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.
* @public */ export interface ExperiencesSummary { /** *The name of your Amazon Kendra experience.
* @public */ Name?: string | undefined; /** *The identifier of your Amazon Kendra experience.
* @public */ Id?: string | undefined; /** *The Unix timestamp when your Amazon Kendra experience was created.
* @public */ CreatedAt?: Date | undefined; /** *The processing status of your Amazon Kendra experience.
* @public */ Status?: ExperienceStatus | undefined; /** *The endpoint URLs for your Amazon Kendra experiences. The URLs are unique * and fully hosted by Amazon Web Services.
* @public */ Endpoints?: ExperienceEndpoint[] | undefined; } /** * @public */ export interface ListExperiencesResponse { /** *An array of summary information for one or more Amazon Kendra experiences.
* @public */ SummaryItems?: ExperiencesSummary[] | undefined; /** *If the response is truncated, Amazon Kendra returns this token, which you can use * in a later request to retrieve the next set of Amazon Kendra experiences.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListFaqsRequest { /** *The index for the FAQs.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there is more data to retrieve), * Amazon Kendra returns a pagination token in the response. You can use this * pagination token to retrieve the next set of FAQs.
* @public */ NextToken?: string | undefined; /** *The maximum number of FAQs to return in the response. If there are fewer results in * the list, this response contains only the actual results.
* @public */ MaxResults?: number | undefined; } /** *Summary information for frequently asked questions and answers included in an * index.
* @public */ export interface FaqSummary { /** *The identifier of the FAQ.
* @public */ Id?: string | undefined; /** *The name that you assigned the FAQ when you created or updated the FAQ.
* @public */ Name?: string | undefined; /** *The current status of the FAQ. When the status is ACTIVE the FAQ is ready
* for use.
The Unix timestamp when the FAQ was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the FAQ was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *The file type used to create the FAQ.
* @public */ FileFormat?: FaqFileFormat | undefined; /** *The code for a language. This shows a supported language for the FAQ document * as part of the summary information for FAQs. English is supported by default. * For more information on supported languages, including their codes, * see Adding * documents in languages other than English.
* @public */ LanguageCode?: string | undefined; } /** * @public */ export interface ListFaqsResponse { /** *If the response is truncated, Amazon Kendra returns this token that you can use * in the subsequent request to retrieve the next set of FAQs.
* @public */ NextToken?: string | undefined; /** *Summary information about the FAQs for a specified index.
* @public */ FaqSummaryItems?: FaqSummary[] | undefined; } /** * @public */ export interface ListFeaturedResultsSetsRequest { /** *The identifier of the index used for featuring results.
* @public */ IndexId: string | undefined; /** *If the response is truncated, Amazon Kendra returns a pagination token * in the response. You can use this pagination token to retrieve the next set * of featured results sets.
* @public */ NextToken?: string | undefined; /** *The maximum number of featured results sets to return.
* @public */ MaxResults?: number | undefined; } /** *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.
* @public */ export interface FeaturedResultsSetSummary { /** *The identifier of the set of featured results.
* @public */ FeaturedResultsSetId?: string | undefined; /** *The name for the set of featured results.
* @public */ FeaturedResultsSetName?: string | undefined; /** *The current status of the set of featured results. When the value is
* ACTIVE, featured results are ready for use. You can still
* configure your settings before setting the status to ACTIVE.
* You can set the status to ACTIVE or INACTIVE
* using the UpdateFeaturedResultsSet API. The queries you specify for
* featured results must be unique per featured results set for each index,
* whether the status is ACTIVE or INACTIVE.
The Unix timestamp when the set of featured results was last updated.
* @public */ LastUpdatedTimestamp?: number | undefined; /** *The Unix timestamp when the set of featured results was created.
* @public */ CreationTimestamp?: number | undefined; } /** * @public */ export interface ListFeaturedResultsSetsResponse { /** *An array of summary information for one or more featured results sets.
* @public */ FeaturedResultsSetSummaryItems?: FeaturedResultsSetSummary[] | undefined; /** *If the response is truncated, Amazon Kendra returns a pagination token * in the response.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListGroupsOlderThanOrderingIdRequest { /** *The identifier of the index for getting a list of groups mapped to users before a * given ordering or timestamp identifier.
* @public */ IndexId: string | undefined; /** *The identifier of the data source for getting a list of groups mapped to users before * a given ordering timestamp identifier.
* @public */ DataSourceId?: string | undefined; /** *The timestamp identifier used for the latest PUT or DELETE
* action for mapping users to their groups.
If the previous response was incomplete (because there is more data to retrieve), * Amazon Kendra returns a pagination token in the response. You can use this * pagination token to retrieve the next set of groups that are mapped to users before a * given ordering or timestamp identifier.
* @public */ NextToken?: string | undefined; /** *The maximum number of returned groups that are mapped to users before a given * ordering or timestamp identifier.
* @public */ MaxResults?: number | undefined; } /** *Summary information for groups.
* @public */ export interface GroupSummary { /** *The identifier of the group you want group summary information on.
* @public */ GroupId?: string | undefined; /** *The timestamp identifier used for the latest PUT or DELETE
* action.
Summary information for list of groups that are mapped to users before a given * ordering or timestamp identifier.
* @public */ GroupsSummaries?: GroupSummary[] | undefined; /** *If the response is truncated, Amazon Kendra returns this token that you can use * in the subsequent request to retrieve the next set of groups that are mapped to users * before a given ordering or timestamp identifier.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListIndicesRequest { /** *If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to * retrieve the next set of indexes.
* @public */ NextToken?: string | undefined; /** *The maximum number of indices to return.
* @public */ MaxResults?: number | undefined; } /** *Summary information on the configuration of an index.
* @public */ export interface IndexConfigurationSummary { /** *The name of the index.
* @public */ Name?: string | undefined; /** *A identifier for the index. Use this to identify the index when you are using APIs such as
* Query, DescribeIndex, UpdateIndex, and
* DeleteIndex.
Indicates whether the index is a Enterprise Edition index or a Developer Edition index. *
* @public */ Edition?: IndexEdition | undefined; /** *The Unix timestamp when the index was created.
* @public */ CreatedAt: Date | undefined; /** *The Unix timestamp when the index was last updated.
* @public */ UpdatedAt: Date | undefined; /** *The current status of the index. When the status is ACTIVE, the index is
* ready to search.
An array of summary information on the configuration of one or more indexes.
* @public */ IndexConfigurationSummaryItems?: IndexConfigurationSummary[] | undefined; /** *If the response is truncated, Amazon Kendra returns this token that you can use in * the subsequent request to retrieve the next set of indexes.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListQuerySuggestionsBlockListsRequest { /** *The identifier of the index for a list of all block lists that exist for * that index.
*For information on the current quota limits for block lists, see * Quotas * for Amazon Kendra.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there is more data to retrieve),
* Amazon Kendra returns a pagination token in the response. You can use this pagination
* token to retrieve the next set of block lists (BlockListSummaryItems).
The maximum number of block lists to return.
* @public */ MaxResults?: number | undefined; } /** *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.
* @public */ export interface QuerySuggestionsBlockListSummary { /** *The identifier of a block list.
* @public */ Id?: string | undefined; /** *The name of the block list.
* @public */ Name?: string | undefined; /** *The status of the block list.
* @public */ Status?: QuerySuggestionsBlockListStatus | undefined; /** *The Unix timestamp when the block list was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the block list was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *The number of items in the block list file.
* @public */ ItemCount?: number | undefined; } /** * @public */ export interface ListQuerySuggestionsBlockListsResponse { /** *Summary items for a block list.
*This includes summary items 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.
* @public */ BlockListSummaryItems?: QuerySuggestionsBlockListSummary[] | undefined; /** *If the response is truncated, Amazon Kendra returns this token that you can use * in the subsequent request to retrieve the next set of block lists.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTagsForResourceRequest { /** *The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to * get a list of tags for. For example, the ARN of an index is constructed as follows: * arn:aws:kendra:your-region:your-account-id:index/index-id * For information on how to construct an ARN for all types of Amazon Kendra resources, see * Resource * types.
* @public */ ResourceARN: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *A list of tags associated with the index, FAQ, data source, or other resource.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface ListThesauriRequest { /** *The identifier of the index with one or more thesauri.
* @public */ IndexId: string | undefined; /** *If the previous response was incomplete (because there is more data to retrieve),
* Amazon Kendra returns a pagination token in the response. You can use this pagination token to
* retrieve the next set of thesauri (ThesaurusSummaryItems).
*
The maximum number of thesauri to return.
* @public */ MaxResults?: number | undefined; } /** *An array of summary information for a thesaurus or multiple thesauri.
* @public */ export interface ThesaurusSummary { /** *The identifier of the thesaurus.
* @public */ Id?: string | undefined; /** *The name of the thesaurus.
* @public */ Name?: string | undefined; /** *The status of the thesaurus.
* @public */ Status?: ThesaurusStatus | undefined; /** *The Unix timestamp when the thesaurus was created.
* @public */ CreatedAt?: Date | undefined; /** *The Unix timestamp when the thesaurus was last updated.
* @public */ UpdatedAt?: Date | undefined; } /** * @public */ export interface ListThesauriResponse { /** *If the response is truncated, Amazon Kendra returns this * token that you can use in the subsequent request to * retrieve the next set of thesauri. *
* @public */ NextToken?: string | undefined; /** *An array of summary information for a thesaurus or multiple thesauri.
* @public */ ThesaurusSummaryItems?: ThesaurusSummary[] | undefined; } /** *The sub groups that belong to a group.
* @public */ export interface MemberGroup { /** *The identifier of the sub group you want to map to a group.
* @public */ GroupId: string | undefined; /** *The identifier of the data source for the sub group you want to map to a group.
* @public */ DataSourceId?: string | undefined; } /** *The users that belong to a group.
* @public */ export interface MemberUser { /** *The identifier of the user you want to map to a group.
* @public */ UserId: string | undefined; } /** *A list of users 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.
* @public */ export interface GroupMembers { /** *A list of users that belong to a group. This can also include sub groups. For example, * the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group * "Company A".
* @public */ MemberGroups?: MemberGroup[] | undefined; /** *A list of users that belong to a group. For example, a list of interns all belong to * the "Interns" group.
* @public */ MemberUsers?: MemberUser[] | undefined; /** *If you have more than 1000 users and/or sub groups for a single group, you need to * provide the path to the S3 file that lists your users and sub groups for a group. Your * sub groups can contain more than 1000 users, but the list of sub groups that belong to a * group (and/or users) must be no more than 1000.
*You can download this example
* S3 file that uses the correct format for listing group members. Note,
* dataSourceId is optional. The value of type for a group is
* always GROUP and for a user it is always USER.
The identifier of the index you want to map users to their groups.
* @public */ IndexId: string | undefined; /** *The identifier of the data source you want to map users to their groups.
*This is useful if a group is tied to multiple data sources, but you only want the * group to access documents of a certain data source. For example, the groups "Research", * "Engineering", and "Sales and Marketing" are all tied to the company's documents stored * in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only * needs access to customer-related documents stored in Salesforce.
* @public */ DataSourceId?: string | undefined; /** *The identifier of the group you want to map its users to.
* @public */ GroupId: string | undefined; /** *The list that contains your users that belong the same group. This can include sub groups * that belong to a group.
*For example, the group "Company A" includes the user "CEO" and the sub groups * "Research", "Engineering", and "Sales and Marketing".
*If you have more than 1000 users and/or sub groups for a single group, you need to * provide the path to the S3 file that lists your users and sub groups for a group. Your * sub groups can contain more than 1000 users, but the list of sub groups that belong to a * group (and/or users) must be no more than 1000.
* @public */ GroupMembers: GroupMembers | undefined; /** *The timestamp identifier you specify to ensure Amazon Kendra doesn't override
* the latest PUT action with previous actions. The highest number ID, which
* is the ordering ID, is the latest action you want to process and apply on top of other
* actions with lower number IDs. This prevents previous actions with lower number IDs from
* possibly overriding the latest action.
The ordering ID can be the Unix time of the last update you made to a group members
* list. You would then provide this list when calling PutPrincipalMapping.
* This ensures your PUT action for that updated group with the latest members
* list doesn't get overwritten by earlier PUT actions for the same group
* which are yet to be processed.
The default ordering ID is the current Unix time in milliseconds that the action was * received by Amazon Kendra.
* @public */ OrderingId?: number | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that has access to the * S3 file that contains your list of users that belong to a group.
*For more information, see IAM roles for * Amazon Kendra.
* @public */ RoleArn?: string | undefined; } /** *Specifies the configuration information needed to customize how collapsed search * result groups expand.
* @public */ export interface ExpandConfiguration { /** *The number of collapsed search result groups to expand. If you set this value to 10, * for example, only the first 10 out of 100 result groups will have expand functionality. *
* @public */ MaxResultItemsToExpand?: number | undefined; /** *The number of expanded results to show per collapsed primary document. For instance, * if you set this value to 3, then at most 3 results per collapsed group will be * displayed.
* @public */ MaxExpandedResultsPerItem?: number | undefined; } /** *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.
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
*The name of the document attribute used to sort the response. You can use any field
* that has the Sortable flag set to true.
You can also sort by any of the following built-in attributes:
*_category
*_created_at
*_last_updated_at
*_version
*_view_count
*The order that the results should be returned in. In case of ties, the relevance * assigned to the result by Amazon Kendra is used as the tie-breaker.
* @public */ SortOrder: SortOrder | undefined; } /** *Specifies how to group results by document attribute value, and how to display them * collapsed/expanded under a designated primary document for each group.
* @public */ export interface CollapseConfiguration { /** *The document attribute used to group search results. You can use any attribute that
* has the Sortable flag set to true. You can also sort by any of the
* following built-in attributes:"_category","_created_at", "_last_updated_at", "_version",
* "_view_count".
A prioritized list of document attributes/fields that determine the primary document * among those in a collapsed group.
* @public */ SortingConfigurations?: SortingConfiguration[] | undefined; /** *Specifies the behavior for documents without a value for the collapse * attribute.
*Amazon Kendra offers three customization options:
*Choose to COLLAPSE all documents with null or missing values in
* one group. This is the default configuration.
Choose to IGNORE documents with null or missing values. Ignored
* documents will not appear in query results.
Choose to EXPAND each document with a null or missing value into
* a group of its own.
Specifies whether to expand the collapsed results.
* @public */ Expand?: boolean | undefined; /** *Provides configuration information to customize expansion options for a collapsed * group.
* @public */ ExpandConfiguration?: ExpandConfiguration | undefined; } /** *Overrides the document relevance properties of a custom index field.
* @public */ export interface DocumentRelevanceConfiguration { /** *The name of the index field.
* @public */ Name: string | undefined; /** *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.
* @public */ Relevance: Relevance | undefined; } /** *Provides the configuration information for suggested query spell corrections.
*Suggested spell corrections are based on words that appear in your indexed documents * and how closely a corrected word matches a misspelled word.
*This feature is designed with certain defaults or limits. For information on the * current limits and how to request more support for some limits, see the * Spell * Checker documentation.
* @public */ export interface SpellCorrectionConfiguration { /** *
* TRUE to suggest spell corrections for queries.
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.
* @public */ export interface FeaturedResultsItem { /** *The identifier of the featured result.
* @public */ Id?: string | undefined; /** *The type of document within the featured result response. For example, * a response could include a question-answer type that's relevant to the * query.
* @public */ Type?: QueryResultType | undefined; /** *One or more additional attributes associated with the featured result.
* @public */ AdditionalAttributes?: AdditionalResultAttribute[] | undefined; /** *The identifier of the featured document.
* @public */ DocumentId?: string | undefined; /** *Provides text and information about where to highlight the text.
* @public */ DocumentTitle?: TextWithHighlights | undefined; /** *Provides text and information about where to highlight the text.
* @public */ DocumentExcerpt?: TextWithHighlights | undefined; /** *The source URI location of the featured document.
* @public */ DocumentURI?: string | undefined; /** *An array of document attributes assigned to a featured document in the
* search results. For example, the document author (_author) or
* the source URI (_source_uri) of the document.
A token that identifies a particular featured result from a particular * query. Use this token to provide click-through feedback for the result. * For more information, see Submitting feedback.
* @public */ FeedbackToken?: string | undefined; } /** *A single expanded result in a collapsed group of search results.
*An expanded result item contains information about an expanded result document within * a collapsed group of search results. 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.
* @public */ export interface ExpandedResultItem { /** *The identifier for the expanded result.
* @public */ Id?: string | undefined; /** *The idenitifier of the document.
* @public */ DocumentId?: string | undefined; /** *Provides text and information about where to highlight the text.
* @public */ DocumentTitle?: TextWithHighlights | undefined; /** *Provides text and information about where to highlight the text.
* @public */ DocumentExcerpt?: TextWithHighlights | undefined; /** *The URI of the original location of the document.
* @public */ DocumentURI?: string | undefined; /** *An array of document attributes assigned to a document in the search results. For * example, the document author ("_author") or the source URI ("_source_uri") of the * document.
* @public */ DocumentAttributes?: DocumentAttribute[] | undefined; } /** *Provides details about a collapsed group of search results.
* @public */ export interface CollapsedResultDetail { /** *The value of the document attribute that results are collapsed on.
* @public */ DocumentAttribute: DocumentAttribute | undefined; /** *A list of results in the collapsed group.
* @public */ ExpandedResults?: ExpandedResultItem[] | undefined; } /** *Provides a relative ranking that indicates how confident Amazon Kendra is that the * response is relevant to the query.
* @public */ export interface ScoreAttributes { /** *A relative ranking for how relevant the response is to the query.
* @public */ ScoreConfidence?: ScoreConfidence | undefined; } /** *Provides information about a table cell in a table excerpt.
* @public */ export interface TableCell { /** *The actual value or content within a table cell. A table cell could contain a date * value of a year, or a string value of text, for example.
* @public */ Value?: string | undefined; /** *
* TRUE if the response of the table cell is the top answer. This is the
* cell value or content with the highest confidence score or is the most relevant to the
* query.
* TRUE means that the table cell has a high enough confidence and is
* relevant to the query, so the value or content should be highlighted.
* TRUE means that the table cell should be treated as a header.
Information about a row in a table excerpt.
* @public */ export interface TableRow { /** *A list of table cells in a row.
* @public */ Cells?: TableCell[] | undefined; } /** *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.
* @public */ export interface TableExcerpt { /** *A list of rows in the table excerpt.
* @public */ Rows?: TableRow[] | undefined; /** *A count of the number of rows in the original table within the document.
* @public */ TotalNumberOfRows?: number | undefined; } /** *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.
* @public */ export interface QueryResultItem { /** *The unique identifier for the query result item id (Id) and the query
* result item document id (DocumentId) combined. The value of this field changes
* with every request, even when you have the same documents.
The type of document within the response. For example, a response could include a * question-answer that's relevant to the query.
* @public */ Type?: QueryResultType | undefined; /** *If the Type of document within the response is ANSWER, then it
* is either a TABLE answer or TEXT answer. If it's a table answer,
* a table excerpt is returned in TableExcerpt. If it's a text answer, a text
* excerpt is returned in DocumentExcerpt.
One or more additional fields/attributes associated with the query result.
* @public */ AdditionalAttributes?: AdditionalResultAttribute[] | undefined; /** *The identifier for the document.
* @public */ DocumentId?: string | undefined; /** *The title of the document. Contains the text of the title and information for * highlighting the relevant terms in the title.
* @public */ DocumentTitle?: TextWithHighlights | undefined; /** *An extract of the text in the document. Contains information about highlighting the * relevant terms in the excerpt.
* @public */ DocumentExcerpt?: TextWithHighlights | undefined; /** *The URI of the original location of the document.
* @public */ DocumentURI?: string | undefined; /** *An array of document fields/attributes assigned to a document in the search results. For
* example, the document author (_author) or the source URI
* (_source_uri) of the document.
Indicates the confidence level of Amazon Kendra providing a relevant result for the
* query. Each result is placed into a bin that indicates the confidence,
* VERY_HIGH, HIGH, MEDIUM and LOW. You
* can use the score to determine if a response meets the confidence needed for your
* application.
The field is only set to LOW when the Type field is set to
* DOCUMENT and Amazon Kendra is not confident that the result is
* relevant to the query.
A token that identifies a particular result from a particular query. Use this token to * provide click-through feedback for the result. For more information, see Submitting * feedback.
* @public */ FeedbackToken?: string | undefined; /** *An excerpt from a table within a document.
* @public */ TableExcerpt?: TableExcerpt | undefined; /** *Provides details about a collapsed group of search results.
* @public */ CollapsedResultDetail?: CollapsedResultDetail | undefined; } /** *A corrected misspelled word in a query.
* @public */ export interface Correction { /** *The zero-based location in the response string or text where * the corrected word starts.
* @public */ BeginOffset?: number | undefined; /** *The zero-based location in the response string or text where * the corrected word ends.
* @public */ EndOffset?: number | undefined; /** *The string or text of a misspelled word in a query.
* @public */ Term?: string | undefined; /** *The string or text of a corrected misspelled word in a query.
* @public */ CorrectedTerm?: string | undefined; } /** *A query with suggested spell corrections.
* @public */ export interface SpellCorrectedQuery { /** *The query with the suggested spell corrections.
* @public */ SuggestedQueryText?: string | undefined; /** *The corrected misspelled word or words in a query.
* @public */ Corrections?: Correction[] | undefined; } /** *The warning code and message that explains a problem with a query.
* @public */ export interface Warning { /** *The message that explains the problem with the query.
* @public */ Message?: string | undefined; /** *The code used to show the type of warning for the query.
* @public */ Code?: WarningCode | undefined; } /** *A single retrieved relevant passage result.
* @public */ export interface RetrieveResultItem { /** *The identifier of the relevant passage result.
* @public */ Id?: string | undefined; /** *The identifier of the document.
* @public */ DocumentId?: string | undefined; /** *The title of the document.
* @public */ DocumentTitle?: string | undefined; /** *The contents of the relevant passage.
* @public */ Content?: string | undefined; /** *The URI of the original location of the document.
* @public */ DocumentURI?: string | undefined; /** *An array of document fields/attributes assigned to a document in the search results.
* For example, the document author (_author) or the source URI
* (_source_uri) of the document.
The confidence score bucket for a retrieved passage result. The confidence bucket * provides a relative ranking that indicates how confident Amazon Kendra is that the * response is relevant to the query.
* @public */ ScoreAttributes?: ScoreAttributes | undefined; } /** * @public */ export interface RetrieveResult { /** *The identifier of query used for the search. You also use QueryId to
* identify the search when using the Submitfeedback
* API.
The results of the retrieved relevant passages for the search.
* @public */ ResultItems?: RetrieveResultItem[] | undefined; } /** * @public */ export interface StartDataSourceSyncJobRequest { /** *The identifier of the data source connector to synchronize.
* @public */ Id: string | undefined; /** *The identifier of the index used with the data source connector.
* @public */ IndexId: string | undefined; } /** * @public */ export interface StartDataSourceSyncJobResponse { /** *Identifies a particular synchronization job.
* @public */ ExecutionId?: string | undefined; } /** * @public */ export interface StopDataSourceSyncJobRequest { /** *The identifier of the data source connector for which to stop the synchronization * jobs.
* @public */ Id: string | undefined; /** *The identifier of the index used with the data source connector.
* @public */ IndexId: string | undefined; } /** *Gathers information about when a particular result was clicked by a user. Your
* application uses the SubmitFeedback API to provide click
* information.
The identifier of the search result that was clicked.
* @public */ ResultId: string | undefined; /** *The Unix timestamp when the result was clicked.
* @public */ ClickTime: Date | undefined; } /** *Provides feedback on how relevant a document is to a search. Your application uses the
* SubmitFeedback API to provide relevance information.
The identifier of the search result that the user provided relevance feedback * for.
* @public */ ResultId: string | undefined; /** *Whether the document was relevant or not relevant to the search.
* @public */ RelevanceValue: RelevanceType | undefined; } /** * @public */ export interface SubmitFeedbackRequest { /** *The identifier of the index that was queried.
* @public */ IndexId: string | undefined; /** *The identifier of the specific query for which you are submitting
* feedback. The query ID is returned in the response to the
* Query API.
Tells Amazon Kendra that a particular search result link was chosen * by the user.
* @public */ ClickFeedbackItems?: ClickFeedback[] | undefined; /** *Provides Amazon Kendra with relevant or not relevant feedback for * whether a particular item was relevant to the search.
* @public */ RelevanceFeedbackItems?: RelevanceFeedback[] | undefined; } /** * @public */ export interface TagResourceRequest { /** *The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to add a tag. * For example, the ARN of an index is constructed as follows: * arn:aws:kendra:your-region:your-account-id:index/index-id * For information on how to construct an ARN for all types of Amazon Kendra resources, see * Resource * types.
* @public */ ResourceARN: string | undefined; /** *A list of tag keys to add to the index, FAQ, data source, or other resource. If a tag already * exists, the existing value is replaced with the new value.
* @public */ Tags: Tag[] | undefined; } /** * @public */ export interface TagResourceResponse { } /** * @public */ export interface UntagResourceRequest { /** *The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to remove a tag. * For example, the ARN of an index is constructed as follows: * arn:aws:kendra:your-region:your-account-id:index/index-id * For information on how to construct an ARN for all types of Amazon Kendra resources, see * Resource * types.
* @public */ ResourceARN: string | undefined; /** *A list of tag keys to remove from the index, FAQ, data source, or other resource. If a tag * key doesn't exist for the resource, it is ignored.
* @public */ TagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceResponse { } /** * @public */ export interface UpdateAccessControlConfigurationRequest { /** *The identifier of the index for an access control configuration.
* @public */ IndexId: string | undefined; /** *The identifier of the access control configuration you want to update.
* @public */ Id: string | undefined; /** *A new name for the access control configuration.
* @public */ Name?: string | undefined; /** *A new description for the access control configuration.
* @public */ Description?: string | undefined; /** *Information you want to update on principals (users and/or groups) and which documents * they should have access to. This is useful for user context filtering, where search * results are filtered based on the user or their group access to documents.
* @public */ AccessControlList?: Principal[] | undefined; /** *The updated list of principal lists that define the * hierarchy for which documents users should have access to.
* @public */ HierarchicalAccessControlList?: HierarchicalPrincipal[] | undefined; } /** * @public */ export interface UpdateAccessControlConfigurationResponse { } /** * @public */ export interface UpdateDataSourceRequest { /** *The identifier of the data source connector you want to update.
* @public */ Id: string | undefined; /** *A new name for the data source connector.
* @public */ Name?: string | undefined; /** *The identifier of the index used with the data source connector.
* @public */ IndexId: string | undefined; /** *Configuration information you want to update for the data source connector.
* @public */ Configuration?: DataSourceConfiguration | undefined; /** *Configuration information for an Amazon Virtual Private Cloud to connect to your data source. * For more information, see Configuring a VPC.
* @public */ VpcConfiguration?: DataSourceVpcConfiguration | undefined; /** *A new description for the data source connector.
* @public */ Description?: string | undefined; /** *The sync schedule you want to update for the data source connector.
* @public */ Schedule?: string | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission to access * the data source and required resources. For more information, see IAM roles for Amazon Kendra.
* @public */ RoleArn?: string | undefined; /** *The code for a language you want to update for the data source connector. * This allows you to support a language for all * documents when updating the data source. English is supported * by default. For more information on supported languages, including their codes, * see Adding * documents in languages other than English.
* @public */ LanguageCode?: string | undefined; /** *Configuration information you want to update for altering document metadata and * content during the document ingestion process.
*For more information on how to create, modify and delete document metadata, or make * other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
* @public */ CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | undefined; } /** * @public */ export interface UpdateExperienceRequest { /** *The identifier of your Amazon Kendra experience you want to update.
* @public */ Id: string | undefined; /** *A new name for your Amazon Kendra experience.
* @public */ Name?: string | undefined; /** *The identifier of the index for your Amazon Kendra experience.
* @public */ IndexId: string | undefined; /** *The Amazon Resource Name (ARN) of an IAM role with permission to access
* the Query API, QuerySuggestions API, SubmitFeedback
* API, and IAM Identity Center that stores your users and groups information.
* For more information, see IAM roles for Amazon Kendra.
Configuration information you want to update for your Amazon Kendra experience.
* @public */ Configuration?: ExperienceConfiguration | undefined; /** *A new description for your Amazon Kendra experience.
* @public */ Description?: string | undefined; } /** * @public */ export interface UpdateFeaturedResultsSetRequest { /** *The identifier of the index used for featuring results.
* @public */ IndexId: string | undefined; /** *The identifier of the set of featured results that you want to update.
* @public */ FeaturedResultsSetId: string | undefined; /** *A new name for the set of featured results.
* @public */ FeaturedResultsSetName?: string | undefined; /** *A new description for the set of featured results.
* @public */ Description?: string | undefined; /** *You can set the status to ACTIVE or INACTIVE.
* When the value is ACTIVE, featured results are ready for
* use. You can still configure your settings before setting the status
* to ACTIVE. The queries you specify for featured results
* must be unique per featured results set for each index, whether the
* status is ACTIVE or INACTIVE.
A list of queries for featuring results. For more information on the * list of queries, see FeaturedResultsSet.
* @public */ QueryTexts?: string[] | undefined; /** *A list of document IDs for the documents you want to feature at the * top of the search results page. For more information on the list of * featured documents, see FeaturedResultsSet.
* @public */ FeaturedDocuments?: FeaturedDocument[] | undefined; } /** * @public */ export interface UpdateFeaturedResultsSetResponse { /** *Information on the set of featured results. This includes the identifier * of the featured results set, whether the featured results set is active * or inactive, when the featured results set was last updated, and more.
* @public */ FeaturedResultsSet?: FeaturedResultsSet | undefined; } /** * @public */ export interface UpdateIndexRequest { /** *The identifier of the index you want to update.
* @public */ Id: string | undefined; /** *A new name for the index.
* @public */ Name?: string | undefined; /** *An Identity and Access Management (IAM) role that gives Amazon Kendra * permission to access Amazon CloudWatch logs and metrics.
* @public */ RoleArn?: string | undefined; /** *A new description for the index.
* @public */ Description?: string | undefined; /** *The document metadata configuration you want to update for the index. Document metadata * are fields or attributes associated with your documents. For example, the company department * name associated with each document.
* @public */ DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[] | undefined; /** *Sets the number of additional document storage and query capacity units that should be * used by the index. You can change the capacity of the index up to 5 times per day, or make 5 * API calls.
*If you are using extra storage units, you can't reduce the storage capacity below what is * required to meet the storage needs for your index.
* @public */ CapacityUnits?: CapacityUnitsConfiguration | undefined; /** *The user token configuration.
*If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
* UserTokenConfigurations to configure user context policy, Amazon Kendra returns
* a ValidationException error.
The user context policy.
*If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
* ATTRIBUTE_FILTER to filter search results by user context. If you're
* using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
* USER_TOKEN to configure user context policy, Amazon Kendra returns a
* ValidationException error.
Gets users and groups from IAM Identity Center identity source. To configure this, * see UserGroupResolutionConfiguration. This is useful for user context filtering, * where search results are filtered based on the user or their group access to * documents.
*If you're using an Amazon Kendra Gen AI Enterprise Edition index,
* UserGroupResolutionConfiguration isn't supported.
The identifier of the index for the block list.
* @public */ IndexId: string | undefined; /** *The identifier of the block list you want to update.
* @public */ Id: string | undefined; /** *A new name for the block list.
* @public */ Name?: string | undefined; /** *A new description for the block list.
* @public */ Description?: string | undefined; /** *The S3 path where your block list text file sits in S3.
*If you update your block list and provide the same path to the
* block list text file in S3, then Amazon Kendra reloads the file to refresh
* the block list. Amazon Kendra does not automatically refresh your block list.
* You need to call the UpdateQuerySuggestionsBlockList API
* to refresh you block list.
If you update your block list, then Amazon Kendra asynchronously refreshes * all query suggestions with the latest content in the S3 file. This * means changes might not take effect immediately.
* @public */ SourceS3Path?: S3Path | undefined; /** *The IAM (Identity and Access Management) role used to access the * block list text file in S3.
* @public */ RoleArn?: string | undefined; } /** * @public */ export interface UpdateQuerySuggestionsConfigRequest { /** *The identifier of the index with query suggestions you want to update.
* @public */ IndexId: string | undefined; /** *Set the mode to ENABLED or LEARN_ONLY.
By default, Amazon Kendra enables query suggestions.
* LEARN_ONLY mode allows you to turn off query suggestions.
* You can to update this at any time.
In LEARN_ONLY mode, Amazon Kendra continues to learn from new
* queries to keep suggestions up to date for when you are ready to
* switch to ENABLED mode again.
How recent your queries are in your query log time window.
*The time window is the number of days from current day to past days.
*By default, Amazon Kendra sets this to 180.
* @public */ QueryLogLookBackWindowInDays?: number | undefined; /** *
* TRUE to include queries without user information (i.e. all queries,
* irrespective of the user), otherwise FALSE to only include queries
* with user information.
If you pass user information to Amazon Kendra along with the queries, you can set this
* flag to FALSE and instruct Amazon Kendra to only consider queries with user
* information.
If you set to FALSE, Amazon Kendra only considers queries searched at least
* MinimumQueryCount times across MinimumNumberOfQueryingUsers
* unique users for suggestions.
If you set to TRUE, Amazon Kendra ignores all user information and learns
* from all queries.
The minimum number of unique users who must search a query in order for the query * to be eligible to suggest to your users.
*Increasing this number might decrease the number of suggestions. However, this * ensures a query is searched by many users and is truly popular to suggest to users.
*How you tune this setting depends on your specific needs.
* @public */ MinimumNumberOfQueryingUsers?: number | undefined; /** *The the minimum number of times a query must be searched in order to be * eligible to suggest to your users.
*Decreasing this number increases the number of suggestions. However, this * affects the quality of suggestions as it sets a low bar for a query to be * considered popular to suggest to users.
*How you tune this setting depends on your specific needs.
* @public */ MinimumQueryCount?: number | undefined; /** *Configuration information for the document fields/attributes that you want to base * query suggestions on.
* @public */ AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig | undefined; } /** * @public */ export interface UpdateThesaurusRequest { /** *The identifier of the thesaurus you want to update.
* @public */ Id: string | undefined; /** *A new name for the thesaurus.
* @public */ Name?: string | undefined; /** *The identifier of the index for the thesaurus.
* @public */ IndexId: string | undefined; /** *A new description for the thesaurus.
* @public */ Description?: string | undefined; /** *An IAM role that gives Amazon Kendra permissions to
* access thesaurus file specified in SourceS3Path.
Information required to find a specific file in an Amazon S3 bucket.
* @public */ SourceS3Path?: S3Path | undefined; } /** *Information about a document attribute or field. You can use document attributes as * facets.
*For example, the document attribute or facet "Department" includes the values "HR", * "Engineering", and "Accounting". You can display these values in the search results so that * documents can be searched by department.
*You can display up to 10 facet values per facet for a query. If you want to increase * this limit, contact Support.
* @public */ export interface Facet { /** *The unique key for the document attribute.
* @public */ DocumentAttributeKey?: string | undefined; /** *An array of document attributes that are nested facets within a facet.
*For example, the document attribute or facet "Department" includes a value called * "Engineering". In addition, the document attribute or facet "SubDepartment" includes the * values "Frontend" and "Backend" for documents assigned to "Engineering". You can display * nested facets in the search results so that documents can be searched not only by * department but also by a sub department within a department. This helps your users further * narrow their search.
*You can only have one nested facet within a facet. If you want to increase this limit, * contact Support.
* @public */ Facets?: Facet[] | undefined; /** *Maximum number of facet values per facet. The default is 10. You can use this to limit * the number of facet values to less than 10. If you want to increase the default, contact * Support.
* @public */ MaxResults?: number | undefined; } /** *Provides the count of documents that match a particular document attribute or field when * doing a faceted search.
* @public */ export interface DocumentAttributeValueCountPair { /** *The value of the attribute/field. For example, "HR".
* @public */ DocumentAttributeValue?: DocumentAttributeValue | undefined; /** *The number of documents in the response that have the attribute/field value for the * key.
* @public */ Count?: number | undefined; /** *Contains the results of a document attribute/field that is a nested facet. A
* FacetResult contains the counts for each facet nested within a
* facet.
For example, the document attribute or facet "Department" includes a value called * "Engineering". In addition, the document attribute or facet "SubDepartment" includes the * values "Frontend" and "Backend" for documents assigned to "Engineering". You can display * nested facets in the search results so that documents can be searched not only by * department but also by a sub department within a department. The counts for documents that * belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
* * * @public */ FacetResults?: FacetResult[] | undefined; } /** *The facet values for the documents in the response.
* @public */ export interface FacetResult { /** *The key for the facet values. This is the same as the DocumentAttributeKey
* provided in the query.
The data type of the facet value. This is the same as the type defined for the index * field when it was created.
* @public */ DocumentAttributeValueType?: DocumentAttributeValueType | undefined; /** *An array of key/value pairs, where the key is the value of the attribute and the count * is the number of documents that share the key value.
* @public */ DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[] | undefined; } /** *Filters the search results based on document attributes or fields.
*You can filter results using attributes for your particular documents. The attributes
* must exist in your index. For example, if your documents include the custom attribute
* "Department", you can filter documents that belong to the "HR" department. You would use
* the EqualsTo operation to filter results or documents with "Department" equals
* to "HR".
You can use AndAllFilters and OrAllFilters in combination with
* each other or with other operations such as EqualsTo. For example:
* AndAllFilters
*
* EqualsTo: "Department", "HR"
* OrAllFilters
*
* ContainsAny: "Project Name", ["new hires", "new hiring"]
This example filters results or documents that belong to the HR department
* AND belong to projects that contain "new hires"
* OR "new hiring" in the project name (must use
* ContainAny with StringListValue). This example is filtering
* with a depth of 2.
You cannot filter more than a depth of 2, otherwise you receive a
* ValidationException exception with the message "AttributeFilter cannot have
* a depth of more than 2." Also, if you use more than 10 attribute filters in a given list
* for AndAllFilters or OrAllFilters, you receive a
* ValidationException with the message "AttributeFilter cannot have a length
* of more than 10".
For examples of using AttributeFilter, see Using document attributes to
* filter search results.
Performs a logical AND operation on all filters that you specify.
Performs a logical OR operation on all filters that you specify.
Performs a logical NOT operation on all filters that you specify.
Performs an equals operation on document attributes/fields and their values.
* @public */ EqualsTo?: DocumentAttribute | undefined; /** *Returns true when a document contains all of the specified document attributes/fields. * This filter is only applicable to StringListValue.
* @public */ ContainsAll?: DocumentAttribute | undefined; /** *Returns true when a document contains any of the specified document attributes/fields. * This filter is only applicable to StringListValue.
* @public */ ContainsAny?: DocumentAttribute | undefined; /** *Performs a greater than operation on document attributes/fields and their values. Use
* with the document attribute
* type
* Date or Long.
Performs a greater or equals than operation on document attributes/fields and their
* values. Use with the document attribute
* type
* Date or Long.
Performs a less than operation on document attributes/fields and their values. Use with
* the document attribute
* type
* Date or Long.
Performs a less than or equals operation on document attributes/fields and their values.
* Use with the document attribute
* type
* Date or Long.
The identifier for the search. You also use QueryId to identify the search
* when using the SubmitFeedback
* API.
The results of the search.
* @public */ ResultItems?: QueryResultItem[] | undefined; /** *Contains the facet results. A FacetResult contains the counts for each
* field/attribute key that was specified in the Facets input parameter.
The total number of items found by the search. However, you can only retrieve up to 100 * items. For example, if the search found 192 items, you can only retrieve the first 100 of * the items.
* @public */ TotalNumberOfResults?: number | undefined; /** *A list of warning codes and their messages on problems with your query.
*Amazon Kendra currently only supports one type of warning, which is a warning on * invalid syntax used in the query. For examples of invalid query syntax, see Searching * with advanced query syntax.
* @public */ Warnings?: Warning[] | undefined; /** *A list of information related to suggested spell corrections for a query.
* @public */ SpellCorrectedQueries?: SpellCorrectedQuery[] | undefined; /** *The list of featured result items. Featured results are 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.
* @public */ FeaturedResultsItems?: FeaturedResultsItem[] | undefined; } /** *Provides the configuration information for the document fields/attributes that you want * to base query suggestions on.
* @public */ export interface AttributeSuggestionsGetConfig { /** *The list of document field/attribute keys or field names to use for query suggestions. * If the content within any of the fields match what your user starts typing as their query, * then the field content is returned as a query suggestion.
* @public */ SuggestionAttributes?: string[] | undefined; /** *The list of additional document field/attribute keys or field names to include in the * response. You can use additional fields to provide extra information in the response. * Additional fields are not used to based suggestions on.
* @public */ AdditionalResponseAttributes?: string[] | undefined; /** *Filters the search results based on document fields/attributes.
* @public */ AttributeFilter?: AttributeFilter | undefined; /** *Applies user context filtering so that only users who are given access to certain * documents see these document in their search results.
* @public */ UserContext?: UserContext | undefined; } /** * @public */ export interface RetrieveRequest { /** *The identifier of the index to retrieve relevant passages for the search.
* @public */ IndexId: string | undefined; /** *The input query text to retrieve relevant passages for the search. Amazon Kendra
* truncates queries at 30 token words, which excludes punctuation and stop words.
* Truncation still applies if you use Boolean or more advanced, complex queries. For
* example, Timeoff AND October AND Category:HR is counted as 3 tokens:
* timeoff, october, hr. For more information,
* see Searching with advanced query syntax in the Amazon Kendra Developer Guide.
Filters search results by document fields/attributes. You can only provide one
* attribute filter; however, the AndAllFilters, NotFilter, and
* OrAllFilters parameters contain a list of other filters.
The AttributeFilter parameter means you can create a set of filtering
* rules that a document must satisfy to be included in the query results.
For Amazon Kendra Gen AI Enterprise Edition indices use AttributeFilter to
* enable document filtering for end users using _email_id or include
* public documents (_email_id=null).
A list of document fields/attributes to include in the response. You can limit the * response to include certain document fields. By default, all document fields are * included in the response.
* @public */ RequestedDocumentAttributes?: string[] | undefined; /** *Overrides relevance tuning configurations of fields/attributes set at the index * level.
*If you use this API to override the relevance tuning configured at the index level, * but there is no relevance tuning configured at the index level, then Amazon Kendra * does not apply any relevance tuning.
*If there is relevance tuning configured for fields at the index level, and you use * this API to override only some of these fields, then for the fields you did not * override, the importance is set to 1.
* @public */ DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[] | undefined; /** *Retrieved relevant passages are returned in pages the size of the
* PageSize parameter. By default, Amazon Kendra returns the first
* page of results. Use this parameter to get result pages after the first one.
Sets the number of retrieved relevant passages that are returned in each page of * results. The default page size is 10. The maximum number of results returned is 100. If * you ask for more than 100 results, only 100 are returned.
* @public */ PageSize?: number | undefined; /** *The user context token or user and group information.
* @public */ UserContext?: UserContext | undefined; } /** * @public */ export interface GetQuerySuggestionsRequest { /** *The identifier of the index you want to get query suggestions from.
* @public */ IndexId: string | undefined; /** *The text of a user's query to generate query suggestions.
*A query is suggested if the query prefix matches * what a user starts to type as their query.
*Amazon Kendra does not show any suggestions if a user * types fewer than two characters or more than 60 characters. * A query must also have at least one search result and contain * at least one word of more than four characters.
* @public */ QueryText: string | undefined; /** *The maximum number of query suggestions you want to show * to your users.
* @public */ MaxSuggestionsCount?: number | undefined; /** *The suggestions type to base query suggestions on. The suggestion * types are query history or document fields/attributes. You can set * one type or the other.
*If you set query history as your suggestions type, Amazon Kendra * suggests queries relevant to your users based on popular queries in * the query history.
*If you set document fields/attributes as your suggestions type, * Amazon Kendra suggests queries relevant to your users based on the * contents of document fields.
* @public */ SuggestionTypes?: SuggestionType[] | undefined; /** *Configuration information for the document fields/attributes that you * want to base query suggestions on.
* @public */ AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig | undefined; } /** * @public */ export interface QueryRequest { /** *The identifier of the index for the search.
* @public */ IndexId: string | undefined; /** *The input query text for the search. Amazon Kendra truncates queries at 30 token
* words, which excludes punctuation and stop words. Truncation still applies if you use
* Boolean or more advanced, complex queries. For example, Timeoff AND October AND
* Category:HR is counted as 3 tokens: timeoff, october,
* hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.
Filters search results by document fields/attributes. You can only provide one attribute
* filter; however, the AndAllFilters, NotFilter, and
* OrAllFilters parameters contain a list of other filters.
The AttributeFilter parameter means you can create a set of filtering rules
* that a document must satisfy to be included in the query results.
For Amazon Kendra Gen AI Enterprise Edition indices use AttributeFilter to
* enable document filtering for end users using _email_id or include public
* documents (_email_id=null).
An array of documents fields/attributes for faceted search. Amazon Kendra returns a * count for each field key specified. This helps your users narrow their search.
* @public */ Facets?: Facet[] | undefined; /** *An array of document fields/attributes to include in the response. You can limit the * response to include certain document fields. By default, all document attributes are * included in the response.
* @public */ RequestedDocumentAttributes?: string[] | undefined; /** *Sets the type of query result or response. Only results for the specified type are * returned.
* @public */ QueryResultTypeFilter?: QueryResultType | undefined; /** *Overrides relevance tuning configurations of fields/attributes set at the index * level.
*If you use this API to override the relevance tuning configured at the index level, but * there is no relevance tuning configured at the index level, then Amazon Kendra does * not apply any relevance tuning.
*If there is relevance tuning configured for fields at the index level, and you use this * API to override only some of these fields, then for the fields you did not override, the * importance is set to 1.
* @public */ DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[] | undefined; /** *Query results are returned in pages the size of the PageSize parameter. By
* default, Amazon Kendra returns the first page of results. Use this parameter to get
* result pages after the first one.
Sets the number of results that are returned in each page of results. The default page * size is 10. The maximum number of results returned is 100. If you ask for more than 100 * results, only 100 are returned.
* @public */ PageSize?: number | undefined; /** *Provides information that determines how the results of the query are sorted. You can * set the field that Amazon Kendra should sort the results on, and specify whether the * results should be sorted in ascending or descending order. In the case of ties in sorting * the results, the results are sorted by relevance.
*If you don't provide sorting configuration, the results are sorted by the relevance that * Amazon Kendra determines for the result.
* @public */ SortingConfiguration?: SortingConfiguration | undefined; /** *Provides configuration information to determine how the results of a query are * sorted.
*You can set upto 3 fields that Amazon Kendra should sort the results on, and * specify whether the results should be sorted in ascending or descending order. The sort * field quota can be increased.
*If you don't provide a sorting configuration, the results are sorted by the relevance * that Amazon Kendra determines for the result. In the case of ties in sorting the * results, the results are sorted by relevance.
* @public */ SortingConfigurations?: SortingConfiguration[] | undefined; /** *The user context token or user and group information.
* @public */ UserContext?: UserContext | undefined; /** *Provides an identifier for a specific user. The VisitorId should be a
* unique identifier, such as a GUID. Don't use personally identifiable information, such as
* the user's email address, as the VisitorId.
Enables suggested spell corrections for queries.
* @public */ SpellCorrectionConfiguration?: SpellCorrectionConfiguration | undefined; /** *Provides configuration to determine how to group results by document attribute value, * and how to display them (collapsed or expanded) under a designated primary document for * each group.
* @public */ CollapseConfiguration?: CollapseConfiguration | undefined; }