Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AssociateEntitiesToExperience

associateEntitiesToExperience_id :: Lens' AssociateEntitiesToExperience Text Source #

The identifier of your Amazon Kendra experience.

associateEntitiesToExperience_indexId :: Lens' AssociateEntitiesToExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

associateEntitiesToExperience_entityList :: Lens' AssociateEntitiesToExperience (NonEmpty EntityConfiguration) Source #

Lists users or groups in your IAM Identity Center identity source.

associateEntitiesToExperienceResponse_failedEntityList :: Lens' AssociateEntitiesToExperienceResponse (Maybe (NonEmpty FailedEntity)) Source #

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

associateEntitiesToExperienceResponse_httpStatus :: Lens' AssociateEntitiesToExperienceResponse Int Source #

The response's http status code.

AssociatePersonasToEntities

associatePersonasToEntities_id :: Lens' AssociatePersonasToEntities Text Source #

The identifier of your Amazon Kendra experience.

associatePersonasToEntities_indexId :: Lens' AssociatePersonasToEntities Text Source #

The identifier of the index for your Amazon Kendra experience.

associatePersonasToEntities_personas :: Lens' AssociatePersonasToEntities (NonEmpty EntityPersonaConfiguration) Source #

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.

associatePersonasToEntitiesResponse_failedEntityList :: Lens' AssociatePersonasToEntitiesResponse (Maybe (NonEmpty FailedEntity)) Source #

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

associatePersonasToEntitiesResponse_httpStatus :: Lens' AssociatePersonasToEntitiesResponse Int Source #

The response's http status code.

BatchDeleteDocument

batchDeleteDocument_dataSourceSyncJobMetricTarget :: Lens' BatchDeleteDocument (Maybe DataSourceSyncJobMetricTarget) Source #

Undocumented member.

batchDeleteDocument_indexId :: Lens' BatchDeleteDocument Text Source #

The identifier of the index that contains the documents to delete.

batchDeleteDocument_documentIdList :: Lens' BatchDeleteDocument (NonEmpty Text) Source #

One or more identifiers for documents to delete from the index.

batchDeleteDocumentResponse_failedDocuments :: Lens' BatchDeleteDocumentResponse (Maybe [BatchDeleteDocumentResponseFailedDocument]) Source #

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.

batchDeleteDocumentResponse_httpStatus :: Lens' BatchDeleteDocumentResponse Int Source #

The response's http status code.

BatchGetDocumentStatus

batchGetDocumentStatus_indexId :: Lens' BatchGetDocumentStatus Text Source #

The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.

batchGetDocumentStatus_documentInfoList :: Lens' BatchGetDocumentStatus (NonEmpty DocumentInfo) Source #

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.

batchGetDocumentStatusResponse_documentStatusList :: Lens' BatchGetDocumentStatusResponse (Maybe [Status]) Source #

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.

batchGetDocumentStatusResponse_errors :: Lens' BatchGetDocumentStatusResponse (Maybe [BatchGetDocumentStatusResponseError]) Source #

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.

batchGetDocumentStatusResponse_httpStatus :: Lens' BatchGetDocumentStatusResponse Int Source #

The response's http status code.

BatchPutDocument

batchPutDocument_customDocumentEnrichmentConfiguration :: Lens' BatchPutDocument (Maybe CustomDocumentEnrichmentConfiguration) Source #

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.

batchPutDocument_roleArn :: Lens' BatchPutDocument (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument API. For more information, see IAM Roles for Amazon Kendra.

batchPutDocument_indexId :: Lens' BatchPutDocument Text Source #

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.

batchPutDocument_documents :: Lens' BatchPutDocument (NonEmpty Document) Source #

One or more documents to add to the index.

Documents have the following file size limits.

5 MB total size for inline documents
50 MB total size for files from an S3 bucket
5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

batchPutDocumentResponse_failedDocuments :: Lens' BatchPutDocumentResponse (Maybe [BatchPutDocumentResponseFailedDocument]) Source #

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

batchPutDocumentResponse_httpStatus :: Lens' BatchPutDocumentResponse Int Source #

The response's http status code.

ClearQuerySuggestions

clearQuerySuggestions_indexId :: Lens' ClearQuerySuggestions Text Source #

The identifier of the index you want to clear query suggestions from.

CreateAccessControlConfiguration

createAccessControlConfiguration_accessControlList :: Lens' CreateAccessControlConfiguration (Maybe [Principal]) Source #

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.

createAccessControlConfiguration_clientToken :: Lens' CreateAccessControlConfiguration (Maybe Text) Source #

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.

createAccessControlConfiguration_description :: Lens' CreateAccessControlConfiguration (Maybe Text) Source #

A description for the access control configuration.

createAccessControlConfiguration_hierarchicalAccessControlList :: Lens' CreateAccessControlConfiguration (Maybe (NonEmpty HierarchicalPrincipal)) Source #

The list of principal lists that define the hierarchy for which documents users should have access to.

createAccessControlConfiguration_indexId :: Lens' CreateAccessControlConfiguration Text Source #

The identifier of the index to create an access control configuration for your documents.

createAccessControlConfiguration_name :: Lens' CreateAccessControlConfiguration Text Source #

A name for the access control configuration.

createAccessControlConfigurationResponse_httpStatus :: Lens' CreateAccessControlConfigurationResponse Int Source #

The response's http status code.

createAccessControlConfigurationResponse_id :: Lens' CreateAccessControlConfigurationResponse Text Source #

The identifier of the access control configuration for your documents in an index.

CreateDataSource

createDataSource_clientToken :: Lens' CreateDataSource (Maybe Text) Source #

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.

createDataSource_configuration :: Lens' CreateDataSource (Maybe DataSourceConfiguration) Source #

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.

createDataSource_customDocumentEnrichmentConfiguration :: Lens' CreateDataSource (Maybe CustomDocumentEnrichmentConfiguration) Source #

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.

createDataSource_description :: Lens' CreateDataSource (Maybe Text) Source #

A description for the data source connector.

createDataSource_languageCode :: Lens' CreateDataSource (Maybe Text) Source #

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.

createDataSource_roleArn :: Lens' CreateDataSource (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM 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.

createDataSource_schedule :: Lens' CreateDataSource (Maybe Text) Source #

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.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

createDataSource_tags :: Lens' CreateDataSource (Maybe [Tag]) Source #

A list of key-value pairs that identify the data source connector. You can use the tags to identify and organize your resources and to control access to resources.

createDataSource_vpcConfiguration :: Lens' CreateDataSource (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

createDataSource_name :: Lens' CreateDataSource Text Source #

A name for the data source connector.

createDataSource_indexId :: Lens' CreateDataSource Text Source #

The identifier of the index you want to use with the data source connector.

createDataSource_type :: Lens' CreateDataSource DataSourceType Source #

The type of data source repository. For example, SHAREPOINT.

createDataSourceResponse_httpStatus :: Lens' CreateDataSourceResponse Int Source #

The response's http status code.

createDataSourceResponse_id :: Lens' CreateDataSourceResponse Text Source #

The identifier of the data source connector.

CreateExperience

createExperience_clientToken :: Lens' CreateExperience (Maybe Text) Source #

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.

createExperience_configuration :: Lens' CreateExperience (Maybe ExperienceConfiguration) Source #

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.

createExperience_description :: Lens' CreateExperience (Maybe Text) Source #

A description for your Amazon Kendra experience.

createExperience_roleArn :: Lens' CreateExperience (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

createExperience_name :: Lens' CreateExperience Text Source #

A name for your Amazon Kendra experience.

createExperience_indexId :: Lens' CreateExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

createExperienceResponse_httpStatus :: Lens' CreateExperienceResponse Int Source #

The response's http status code.

createExperienceResponse_id :: Lens' CreateExperienceResponse Text Source #

The identifier for your created Amazon Kendra experience.

CreateFaq

createFaq_clientToken :: Lens' CreateFaq (Maybe Text) Source #

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.

createFaq_description :: Lens' CreateFaq (Maybe Text) Source #

A description for the FAQ.

createFaq_fileFormat :: Lens' CreateFaq (Maybe FaqFileFormat) Source #

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

createFaq_languageCode :: Lens' CreateFaq (Maybe Text) Source #

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.

createFaq_tags :: Lens' CreateFaq (Maybe [Tag]) Source #

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.

createFaq_indexId :: Lens' CreateFaq Text Source #

The identifier of the index for the FAQ.

createFaq_name :: Lens' CreateFaq Text Source #

A name for the FAQ.

createFaq_s3Path :: Lens' CreateFaq S3Path Source #

The path to the FAQ file in S3.

createFaq_roleArn :: Lens' CreateFaq Text Source #

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

createFaqResponse_id :: Lens' CreateFaqResponse (Maybe Text) Source #

The identifier of the FAQ.

createFaqResponse_httpStatus :: Lens' CreateFaqResponse Int Source #

The response's http status code.

CreateIndex

createIndex_clientToken :: Lens' CreateIndex (Maybe Text) Source #

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.

createIndex_description :: Lens' CreateIndex (Maybe Text) Source #

A description for the index.

createIndex_edition :: Lens' CreateIndex (Maybe IndexEdition) Source #

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 your production databases. 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 enterprise and developer editions, see Quotas.

createIndex_serverSideEncryptionConfiguration :: Lens' CreateIndex (Maybe ServerSideEncryptionConfiguration) Source #

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.

createIndex_tags :: Lens' CreateIndex (Maybe [Tag]) Source #

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

createIndex_userContextPolicy :: Lens' CreateIndex (Maybe UserContextPolicy) Source #

The user context policy.

ATTRIBUTE_FILTER: 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.
USER_TOKEN: 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.

createIndex_userGroupResolutionConfiguration :: Lens' CreateIndex (Maybe UserGroupResolutionConfiguration) Source #

Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

createIndex_userTokenConfigurations :: Lens' CreateIndex (Maybe [UserTokenConfiguration]) Source #

The user token configuration.

createIndex_name :: Lens' CreateIndex Text Source #

A name for the index.

createIndex_roleArn :: Lens' CreateIndex Text Source #

An Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.

createIndexResponse_id :: Lens' CreateIndexResponse (Maybe Text) Source #

The identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.

createIndexResponse_httpStatus :: Lens' CreateIndexResponse Int Source #

The response's http status code.

CreateQuerySuggestionsBlockList

createQuerySuggestionsBlockList_clientToken :: Lens' CreateQuerySuggestionsBlockList (Maybe Text) Source #

A token that you provide to identify the request to create a query suggestions block list.

createQuerySuggestionsBlockList_description :: Lens' CreateQuerySuggestionsBlockList (Maybe Text) Source #

A user-friendly 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."

createQuerySuggestionsBlockList_tags :: Lens' CreateQuerySuggestionsBlockList (Maybe [Tag]) Source #

A tag that you can assign to a block list that categorizes the block list.

createQuerySuggestionsBlockList_indexId :: Lens' CreateQuerySuggestionsBlockList Text Source #

The identifier of the index you want to create a query suggestions block list for.

createQuerySuggestionsBlockList_name :: Lens' CreateQuerySuggestionsBlockList Text Source #

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

createQuerySuggestionsBlockList_sourceS3Path :: Lens' CreateQuerySuggestionsBlockList S3Path Source #

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.

createQuerySuggestionsBlockList_roleArn :: Lens' CreateQuerySuggestionsBlockList Text Source #

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). 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.

createQuerySuggestionsBlockListResponse_id :: Lens' CreateQuerySuggestionsBlockListResponse (Maybe Text) Source #

The identifier of the created block list.

createQuerySuggestionsBlockListResponse_httpStatus :: Lens' CreateQuerySuggestionsBlockListResponse Int Source #

The response's http status code.

CreateThesaurus

createThesaurus_clientToken :: Lens' CreateThesaurus (Maybe Text) Source #

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.

createThesaurus_description :: Lens' CreateThesaurus (Maybe Text) Source #

A description for the thesaurus.

createThesaurus_tags :: Lens' CreateThesaurus (Maybe [Tag]) Source #

A list of key-value pairs that identify the thesaurus. You can use the tags to identify and organize your resources and to control access to resources.

createThesaurus_indexId :: Lens' CreateThesaurus Text Source #

The identifier of the index for the thesaurus.

createThesaurus_name :: Lens' CreateThesaurus Text Source #

A name for the thesaurus.

createThesaurus_roleArn :: Lens' CreateThesaurus Text Source #

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

createThesaurus_sourceS3Path :: Lens' CreateThesaurus S3Path Source #

The path to the thesaurus file in S3.

createThesaurusResponse_id :: Lens' CreateThesaurusResponse (Maybe Text) Source #

The identifier of the thesaurus.

createThesaurusResponse_httpStatus :: Lens' CreateThesaurusResponse Int Source #

The response's http status code.

DeleteAccessControlConfiguration

deleteAccessControlConfiguration_indexId :: Lens' DeleteAccessControlConfiguration Text Source #

The identifier of the index for an access control configuration.

deleteAccessControlConfiguration_id :: Lens' DeleteAccessControlConfiguration Text Source #

The identifier of the access control configuration you want to delete.

deleteAccessControlConfigurationResponse_httpStatus :: Lens' DeleteAccessControlConfigurationResponse Int Source #

The response's http status code.

DeleteDataSource

deleteDataSource_id :: Lens' DeleteDataSource Text Source #

The identifier of the data source connector you want to delete.

deleteDataSource_indexId :: Lens' DeleteDataSource Text Source #

The identifier of the index used with the data source connector.

DeleteExperience

deleteExperience_id :: Lens' DeleteExperience Text Source #

The identifier of your Amazon Kendra experience you want to delete.

deleteExperience_indexId :: Lens' DeleteExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

deleteExperienceResponse_httpStatus :: Lens' DeleteExperienceResponse Int Source #

The response's http status code.

DeleteFaq

deleteFaq_id :: Lens' DeleteFaq Text Source #

The identifier of the FAQ you want to remove.

deleteFaq_indexId :: Lens' DeleteFaq Text Source #

The identifier of the index for the FAQ.

DeleteIndex

deleteIndex_id :: Lens' DeleteIndex Text Source #

The identifier of the index you want to delete.

DeletePrincipalMapping

deletePrincipalMapping_dataSourceId :: Lens' DeletePrincipalMapping (Maybe Text) Source #

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.

deletePrincipalMapping_orderingId :: Lens' DeletePrincipalMapping (Maybe Natural) Source #

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.

deletePrincipalMapping_indexId :: Lens' DeletePrincipalMapping Text Source #

The identifier of the index you want to delete a group from.

deletePrincipalMapping_groupId :: Lens' DeletePrincipalMapping Text Source #

The identifier of the group you want to delete.

DeleteQuerySuggestionsBlockList

deleteQuerySuggestionsBlockList_indexId :: Lens' DeleteQuerySuggestionsBlockList Text Source #

The identifier of the index for the block list.

deleteQuerySuggestionsBlockList_id :: Lens' DeleteQuerySuggestionsBlockList Text Source #

The identifier of the block list you want to delete.

DeleteThesaurus

deleteThesaurus_id :: Lens' DeleteThesaurus Text Source #

The identifier of the thesaurus you want to delete.

deleteThesaurus_indexId :: Lens' DeleteThesaurus Text Source #

The identifier of the index for the thesaurus.

DescribeAccessControlConfiguration

describeAccessControlConfiguration_indexId :: Lens' DescribeAccessControlConfiguration Text Source #

The identifier of the index for an access control configuration.

describeAccessControlConfiguration_id :: Lens' DescribeAccessControlConfiguration Text Source #

The identifier of the access control configuration you want to get information on.

describeAccessControlConfigurationResponse_accessControlList :: Lens' DescribeAccessControlConfigurationResponse (Maybe [Principal]) Source #

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.

describeAccessControlConfigurationResponse_description :: Lens' DescribeAccessControlConfigurationResponse (Maybe Text) Source #

The description for the access control configuration.

describeAccessControlConfigurationResponse_errorMessage :: Lens' DescribeAccessControlConfigurationResponse (Maybe Text) Source #

The error message containing details if there are issues processing the access control configuration.

describeAccessControlConfigurationResponse_hierarchicalAccessControlList :: Lens' DescribeAccessControlConfigurationResponse (Maybe (NonEmpty HierarchicalPrincipal)) Source #

The list of principal lists that define the hierarchy for which documents users should have access to.

describeAccessControlConfigurationResponse_httpStatus :: Lens' DescribeAccessControlConfigurationResponse Int Source #

The response's http status code.

describeAccessControlConfigurationResponse_name :: Lens' DescribeAccessControlConfigurationResponse Text Source #

The name for the access control configuration.

DescribeDataSource

describeDataSource_id :: Lens' DescribeDataSource Text Source #

The identifier of the data source connector.

describeDataSource_indexId :: Lens' DescribeDataSource Text Source #

The identifier of the index used with the data source connector.

describeDataSourceResponse_configuration :: Lens' DescribeDataSourceResponse (Maybe DataSourceConfiguration) Source #

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.

describeDataSourceResponse_createdAt :: Lens' DescribeDataSourceResponse (Maybe UTCTime) Source #

The Unix timestamp of when the data source connector was created.

describeDataSourceResponse_customDocumentEnrichmentConfiguration :: Lens' DescribeDataSourceResponse (Maybe CustomDocumentEnrichmentConfiguration) Source #

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.

describeDataSourceResponse_description :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The description for the data source connector.

describeDataSourceResponse_errorMessage :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.

describeDataSourceResponse_id :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The identifier of the data source connector.

describeDataSourceResponse_indexId :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The identifier of the index used with the data source connector.

describeDataSourceResponse_languageCode :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

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.

describeDataSourceResponse_name :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The name for the data source connector.

describeDataSourceResponse_roleArn :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

describeDataSourceResponse_schedule :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The schedule for Amazon Kendra to update the index.

describeDataSourceResponse_status :: Lens' DescribeDataSourceResponse (Maybe DataSourceStatus) Source #

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.

describeDataSourceResponse_type :: Lens' DescribeDataSourceResponse (Maybe DataSourceType) Source #

The type of the data source. For example, SHAREPOINT.

describeDataSourceResponse_updatedAt :: Lens' DescribeDataSourceResponse (Maybe UTCTime) Source #

The Unix timestamp of when the data source connector was last updated.

describeDataSourceResponse_vpcConfiguration :: Lens' DescribeDataSourceResponse (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

describeDataSourceResponse_httpStatus :: Lens' DescribeDataSourceResponse Int Source #

The response's http status code.

DescribeExperience

describeExperience_id :: Lens' DescribeExperience Text Source #

The identifier of your Amazon Kendra experience you want to get information on.

describeExperience_indexId :: Lens' DescribeExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

describeExperienceResponse_configuration :: Lens' DescribeExperienceResponse (Maybe ExperienceConfiguration) Source #

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.

describeExperienceResponse_createdAt :: Lens' DescribeExperienceResponse (Maybe UTCTime) Source #

Shows the date-time your Amazon Kendra experience was created.

describeExperienceResponse_description :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the description for your Amazon Kendra experience.

describeExperienceResponse_endpoints :: Lens' DescribeExperienceResponse (Maybe (NonEmpty ExperienceEndpoint)) Source #

Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

describeExperienceResponse_errorMessage :: Lens' DescribeExperienceResponse (Maybe Text) Source #

The reason your Amazon Kendra experience could not properly process.

describeExperienceResponse_id :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the identifier of your Amazon Kendra experience.

describeExperienceResponse_indexId :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the identifier of the index for your Amazon Kendra experience.

describeExperienceResponse_name :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the name of your Amazon Kendra experience.

describeExperienceResponse_roleArn :: Lens' DescribeExperienceResponse (Maybe Text) Source #

Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

describeExperienceResponse_status :: Lens' DescribeExperienceResponse (Maybe ExperienceStatus) Source #

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.

describeExperienceResponse_updatedAt :: Lens' DescribeExperienceResponse (Maybe UTCTime) Source #

Shows the date-time your Amazon Kendra experience was last updated.

describeExperienceResponse_httpStatus :: Lens' DescribeExperienceResponse Int Source #

The response's http status code.

DescribeFaq

describeFaq_id :: Lens' DescribeFaq Text Source #

The identifier of the FAQ you want to get information on.

describeFaq_indexId :: Lens' DescribeFaq Text Source #

The identifier of the index for the FAQ.

describeFaqResponse_createdAt :: Lens' DescribeFaqResponse (Maybe UTCTime) Source #

The date and time that the FAQ was created.

describeFaqResponse_description :: Lens' DescribeFaqResponse (Maybe Text) Source #

The description of the FAQ that you provided when it was created.

describeFaqResponse_errorMessage :: Lens' DescribeFaqResponse (Maybe Text) Source #

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

describeFaqResponse_fileFormat :: Lens' DescribeFaqResponse (Maybe FaqFileFormat) Source #

The file format used by the input files for the FAQ.

describeFaqResponse_id :: Lens' DescribeFaqResponse (Maybe Text) Source #

The identifier of the FAQ.

describeFaqResponse_indexId :: Lens' DescribeFaqResponse (Maybe Text) Source #

The identifier of the index for the FAQ.

describeFaqResponse_languageCode :: Lens' DescribeFaqResponse (Maybe Text) Source #

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.

describeFaqResponse_name :: Lens' DescribeFaqResponse (Maybe Text) Source #

The name that you gave the FAQ when it was created.

describeFaqResponse_roleArn :: Lens' DescribeFaqResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

describeFaqResponse_s3Path :: Lens' DescribeFaqResponse (Maybe S3Path) Source #

Undocumented member.

describeFaqResponse_status :: Lens' DescribeFaqResponse (Maybe FaqStatus) Source #

The status of the FAQ. It is ready to use when the status is ACTIVE.

describeFaqResponse_updatedAt :: Lens' DescribeFaqResponse (Maybe UTCTime) Source #

The date and time that the FAQ was last updated.

describeFaqResponse_httpStatus :: Lens' DescribeFaqResponse Int Source #

The response's http status code.

DescribeIndex

describeIndex_id :: Lens' DescribeIndex Text Source #

The identifier of the index you want to get information on.

describeIndexResponse_capacityUnits :: Lens' DescribeIndexResponse (Maybe CapacityUnitsConfiguration) Source #

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.

describeIndexResponse_createdAt :: Lens' DescribeIndexResponse (Maybe UTCTime) Source #

The Unix datetime that the index was created.

describeIndexResponse_description :: Lens' DescribeIndexResponse (Maybe Text) Source #

The description for the index.

describeIndexResponse_documentMetadataConfigurations :: Lens' DescribeIndexResponse (Maybe [DocumentMetadataConfiguration]) Source #

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.

describeIndexResponse_edition :: Lens' DescribeIndexResponse (Maybe IndexEdition) Source #

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

describeIndexResponse_errorMessage :: Lens' DescribeIndexResponse (Maybe Text) Source #

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

describeIndexResponse_id :: Lens' DescribeIndexResponse (Maybe Text) Source #

The identifier of the index.

describeIndexResponse_indexStatistics :: Lens' DescribeIndexResponse (Maybe IndexStatistics) Source #

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

describeIndexResponse_name :: Lens' DescribeIndexResponse (Maybe Text) Source #

The name of the index.

describeIndexResponse_roleArn :: Lens' DescribeIndexResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

describeIndexResponse_serverSideEncryptionConfiguration :: Lens' DescribeIndexResponse (Maybe ServerSideEncryptionConfiguration) Source #

The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

describeIndexResponse_status :: Lens' DescribeIndexResponse (Maybe IndexStatus) Source #

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.

describeIndexResponse_updatedAt :: Lens' DescribeIndexResponse (Maybe UTCTime) Source #

The Unix datetime that the index was last updated.

describeIndexResponse_userContextPolicy :: Lens' DescribeIndexResponse (Maybe UserContextPolicy) Source #

The user context policy for the Amazon Kendra index.

describeIndexResponse_userGroupResolutionConfiguration :: Lens' DescribeIndexResponse (Maybe UserGroupResolutionConfiguration) Source #

Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source.

describeIndexResponse_userTokenConfigurations :: Lens' DescribeIndexResponse (Maybe [UserTokenConfiguration]) Source #

The user token configuration for the Amazon Kendra index.

describeIndexResponse_httpStatus :: Lens' DescribeIndexResponse Int Source #

The response's http status code.

DescribePrincipalMapping

describePrincipalMapping_dataSourceId :: Lens' DescribePrincipalMapping (Maybe Text) Source #

The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMapping_indexId :: Lens' DescribePrincipalMapping Text Source #

The identifier of the index required to check the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMapping_groupId :: Lens' DescribePrincipalMapping Text Source #

The identifier of the group required to check the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMappingResponse_dataSourceId :: Lens' DescribePrincipalMappingResponse (Maybe Text) Source #

Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMappingResponse_groupId :: Lens' DescribePrincipalMappingResponse (Maybe Text) Source #

Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMappingResponse_groupOrderingIdSummaries :: Lens' DescribePrincipalMappingResponse (Maybe [GroupOrderingIdSummary]) Source #

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.

describePrincipalMappingResponse_indexId :: Lens' DescribePrincipalMappingResponse (Maybe Text) Source #

Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.

describePrincipalMappingResponse_httpStatus :: Lens' DescribePrincipalMappingResponse Int Source #

The response's http status code.

DescribeQuerySuggestionsBlockList

describeQuerySuggestionsBlockList_indexId :: Lens' DescribeQuerySuggestionsBlockList Text Source #

The identifier of the index for the block list.

describeQuerySuggestionsBlockList_id :: Lens' DescribeQuerySuggestionsBlockList Text Source #

The identifier of the block list you want to get information on.

describeQuerySuggestionsBlockListResponse_createdAt :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe UTCTime) Source #

The date-time a block list for query suggestions was created.

describeQuerySuggestionsBlockListResponse_description :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The description for the block list.

describeQuerySuggestionsBlockListResponse_errorMessage :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The error message containing details if there are issues processing the block list.

describeQuerySuggestionsBlockListResponse_fileSizeBytes :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Integer) Source #

The current size of the block list text file in S3.

describeQuerySuggestionsBlockListResponse_id :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The identifier of the block list.

describeQuerySuggestionsBlockListResponse_indexId :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The identifier of the index for the block list.

describeQuerySuggestionsBlockListResponse_itemCount :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Int) Source #

The current number of valid, non-empty words or phrases in the block list text file.

describeQuerySuggestionsBlockListResponse_name :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The name of the block list.

describeQuerySuggestionsBlockListResponse_roleArn :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

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.

describeQuerySuggestionsBlockListResponse_sourceS3Path :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe S3Path) Source #

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.

describeQuerySuggestionsBlockListResponse_status :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe QuerySuggestionsBlockListStatus) Source #

The current status of the block list. When the value is ACTIVE, the block list is ready for use.

describeQuerySuggestionsBlockListResponse_updatedAt :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe UTCTime) Source #

The date-time a block list for query suggestions was last updated.

describeQuerySuggestionsBlockListResponse_httpStatus :: Lens' DescribeQuerySuggestionsBlockListResponse Int Source #

The response's http status code.

DescribeQuerySuggestionsConfig

describeQuerySuggestionsConfig_indexId :: Lens' DescribeQuerySuggestionsConfig Text Source #

The identifier of the index with query suggestions that you want to get information on.

describeQuerySuggestionsConfigResponse_includeQueriesWithoutUserInformation :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Bool) Source #

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

describeQuerySuggestionsConfigResponse_lastClearTime :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe UTCTime) Source #

The date-time 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.

describeQuerySuggestionsConfigResponse_lastSuggestionsBuildTime :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe UTCTime) Source #

The date-time query suggestions for an index was last updated.

describeQuerySuggestionsConfigResponse_minimumNumberOfQueryingUsers :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Natural) Source #

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

describeQuerySuggestionsConfigResponse_minimumQueryCount :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Natural) Source #

The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

describeQuerySuggestionsConfigResponse_mode :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Mode) Source #

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.

describeQuerySuggestionsConfigResponse_queryLogLookBackWindowInDays :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Int) Source #

How recent your queries are in your query log time window (in days).

describeQuerySuggestionsConfigResponse_status :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe QuerySuggestionsStatus) Source #

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.

describeQuerySuggestionsConfigResponse_totalSuggestionsCount :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Int) Source #

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.

describeQuerySuggestionsConfigResponse_httpStatus :: Lens' DescribeQuerySuggestionsConfigResponse Int Source #

The response's http status code.

DescribeThesaurus

describeThesaurus_id :: Lens' DescribeThesaurus Text Source #

The identifier of the thesaurus you want to get information on.

describeThesaurus_indexId :: Lens' DescribeThesaurus Text Source #

The identifier of the index for the thesaurus.

describeThesaurusResponse_createdAt :: Lens' DescribeThesaurusResponse (Maybe UTCTime) Source #

The Unix datetime that the thesaurus was created.

describeThesaurusResponse_description :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

The thesaurus description.

describeThesaurusResponse_errorMessage :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

When the Status field value is FAILED, the ErrorMessage field provides more information.

describeThesaurusResponse_fileSizeBytes :: Lens' DescribeThesaurusResponse (Maybe Integer) Source #

The size of the thesaurus file in bytes.

describeThesaurusResponse_id :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

The identifier of the thesaurus.

describeThesaurusResponse_indexId :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

The identifier of the index for the thesaurus.

describeThesaurusResponse_name :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

The thesaurus name.

describeThesaurusResponse_roleArn :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

describeThesaurusResponse_sourceS3Path :: Lens' DescribeThesaurusResponse (Maybe S3Path) Source #

Undocumented member.

describeThesaurusResponse_status :: Lens' DescribeThesaurusResponse (Maybe ThesaurusStatus) Source #

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.

describeThesaurusResponse_synonymRuleCount :: Lens' DescribeThesaurusResponse (Maybe Integer) Source #

The number of synonym rules in the thesaurus file.

describeThesaurusResponse_termCount :: Lens' DescribeThesaurusResponse (Maybe Integer) Source #

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.

describeThesaurusResponse_updatedAt :: Lens' DescribeThesaurusResponse (Maybe UTCTime) Source #

The Unix datetime that the thesaurus was last updated.

describeThesaurusResponse_httpStatus :: Lens' DescribeThesaurusResponse Int Source #

The response's http status code.

DisassociateEntitiesFromExperience

disassociateEntitiesFromExperience_id :: Lens' DisassociateEntitiesFromExperience Text Source #

The identifier of your Amazon Kendra experience.

disassociateEntitiesFromExperience_indexId :: Lens' DisassociateEntitiesFromExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

disassociateEntitiesFromExperience_entityList :: Lens' DisassociateEntitiesFromExperience (NonEmpty EntityConfiguration) Source #

Lists users or groups in your IAM Identity Center identity source.

disassociateEntitiesFromExperienceResponse_failedEntityList :: Lens' DisassociateEntitiesFromExperienceResponse (Maybe (NonEmpty FailedEntity)) Source #

Lists the users or groups in your IAM Identity Center identity source that failed to properly remove access to your Amazon Kendra experience.

disassociateEntitiesFromExperienceResponse_httpStatus :: Lens' DisassociateEntitiesFromExperienceResponse Int Source #

The response's http status code.

DisassociatePersonasFromEntities

disassociatePersonasFromEntities_id :: Lens' DisassociatePersonasFromEntities Text Source #

The identifier of your Amazon Kendra experience.

disassociatePersonasFromEntities_indexId :: Lens' DisassociatePersonasFromEntities Text Source #

The identifier of the index for your Amazon Kendra experience.

disassociatePersonasFromEntities_entityIds :: Lens' DisassociatePersonasFromEntities (NonEmpty Text) Source #

The identifiers of users or groups in your IAM Identity Center identity source. For example, user IDs could be user emails.

disassociatePersonasFromEntitiesResponse_failedEntityList :: Lens' DisassociatePersonasFromEntitiesResponse (Maybe (NonEmpty FailedEntity)) Source #

Lists the users or groups in your IAM Identity Center identity source that failed to properly remove access to your Amazon Kendra experience.

disassociatePersonasFromEntitiesResponse_httpStatus :: Lens' DisassociatePersonasFromEntitiesResponse Int Source #

The response's http status code.

GetQuerySuggestions

getQuerySuggestions_maxSuggestionsCount :: Lens' GetQuerySuggestions (Maybe Int) Source #

The maximum number of query suggestions you want to show to your users.

getQuerySuggestions_indexId :: Lens' GetQuerySuggestions Text Source #

The identifier of the index you want to get query suggestions from.

getQuerySuggestions_queryText :: Lens' GetQuerySuggestions Text Source #

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.

getQuerySuggestionsResponse_querySuggestionsId :: Lens' GetQuerySuggestionsResponse (Maybe Text) Source #

The identifier for a list of query suggestions for an index.

getQuerySuggestionsResponse_suggestions :: Lens' GetQuerySuggestionsResponse (Maybe [Suggestion]) Source #

A list of query suggestions for an index.

getQuerySuggestionsResponse_httpStatus :: Lens' GetQuerySuggestionsResponse Int Source #

The response's http status code.

GetSnapshots

getSnapshots_maxResults :: Lens' GetSnapshots (Maybe Int) Source #

The maximum number of returned data for the metric.

getSnapshots_nextToken :: Lens' GetSnapshots (Maybe Text) Source #

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.

getSnapshots_indexId :: Lens' GetSnapshots Text Source #

The identifier of the index to get search metrics data.

getSnapshots_interval :: Lens' GetSnapshots Interval Source #

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.

getSnapshots_metricType :: Lens' GetSnapshots MetricType Source #

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.

getSnapshotsResponse_nextToken :: Lens' GetSnapshotsResponse (Maybe Text) Source #

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.

getSnapshotsResponse_snapShotTimeFilter :: Lens' GetSnapshotsResponse (Maybe TimeRange) Source #

The date-time for the beginning and end of the time window for the search metrics data.

getSnapshotsResponse_snapshotsData :: Lens' GetSnapshotsResponse (Maybe [[Text]]) Source #

The search metrics data. The data returned depends on the metric type you requested.

getSnapshotsResponse_snapshotsDataHeader :: Lens' GetSnapshotsResponse (Maybe [Text]) Source #

The column headers for the search metrics data.

getSnapshotsResponse_httpStatus :: Lens' GetSnapshotsResponse Int Source #

The response's http status code.

ListAccessControlConfigurations

listAccessControlConfigurations_maxResults :: Lens' ListAccessControlConfigurations (Maybe Natural) Source #

The maximum number of access control configurations to return.

listAccessControlConfigurations_nextToken :: Lens' ListAccessControlConfigurations (Maybe Text) Source #

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.

listAccessControlConfigurations_indexId :: Lens' ListAccessControlConfigurations Text Source #

The identifier of the index for the access control configuration.

listAccessControlConfigurationsResponse_nextToken :: Lens' ListAccessControlConfigurationsResponse (Maybe Text) Source #

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.

listAccessControlConfigurationsResponse_httpStatus :: Lens' ListAccessControlConfigurationsResponse Int Source #

The response's http status code.

listAccessControlConfigurationsResponse_accessControlConfigurations :: Lens' ListAccessControlConfigurationsResponse [AccessControlConfigurationSummary] Source #

The details of your access control configurations.

ListDataSourceSyncJobs

listDataSourceSyncJobs_maxResults :: Lens' ListDataSourceSyncJobs (Maybe Natural) Source #

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.

listDataSourceSyncJobs_nextToken :: Lens' ListDataSourceSyncJobs (Maybe Text) Source #

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.

listDataSourceSyncJobs_startTimeFilter :: Lens' ListDataSourceSyncJobs (Maybe TimeRange) Source #

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

listDataSourceSyncJobs_statusFilter :: Lens' ListDataSourceSyncJobs (Maybe DataSourceSyncJobStatus) Source #

Only returns synchronization jobs with the Status field equal to the specified status.

listDataSourceSyncJobs_id :: Lens' ListDataSourceSyncJobs Text Source #

The identifier of the data source connector.

listDataSourceSyncJobs_indexId :: Lens' ListDataSourceSyncJobs Text Source #

The identifier of the index used with the data source connector.

listDataSourceSyncJobsResponse_history :: Lens' ListDataSourceSyncJobsResponse (Maybe [DataSourceSyncJob]) Source #

A history of synchronization jobs for the data source connector.

listDataSourceSyncJobsResponse_nextToken :: Lens' ListDataSourceSyncJobsResponse (Maybe Text) Source #

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.

listDataSourceSyncJobsResponse_httpStatus :: Lens' ListDataSourceSyncJobsResponse Int Source #

The response's http status code.

ListDataSources

listDataSources_maxResults :: Lens' ListDataSources (Maybe Natural) Source #

The maximum number of data source connectors to return.

listDataSources_nextToken :: Lens' ListDataSources (Maybe Text) Source #

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.

listDataSources_indexId :: Lens' ListDataSources Text Source #

The identifier of the index used with one or more data source connectors.

listDataSourcesResponse_nextToken :: Lens' ListDataSourcesResponse (Maybe Text) Source #

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.

listDataSourcesResponse_summaryItems :: Lens' ListDataSourcesResponse (Maybe [DataSourceSummary]) Source #

An array of summary information for one or more data source connector.

listDataSourcesResponse_httpStatus :: Lens' ListDataSourcesResponse Int Source #

The response's http status code.

ListEntityPersonas

listEntityPersonas_maxResults :: Lens' ListEntityPersonas (Maybe Natural) Source #

The maximum number of returned users or groups.

listEntityPersonas_nextToken :: Lens' ListEntityPersonas (Maybe Text) Source #

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.

listEntityPersonas_id :: Lens' ListEntityPersonas Text Source #

The identifier of your Amazon Kendra experience.

listEntityPersonas_indexId :: Lens' ListEntityPersonas Text Source #

The identifier of the index for your Amazon Kendra experience.

listEntityPersonasResponse_nextToken :: Lens' ListEntityPersonasResponse (Maybe Text) Source #

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.

listEntityPersonasResponse_summaryItems :: Lens' ListEntityPersonasResponse (Maybe [PersonasSummary]) Source #

An array of summary information for one or more users or groups.

listEntityPersonasResponse_httpStatus :: Lens' ListEntityPersonasResponse Int Source #

The response's http status code.

ListExperienceEntities

listExperienceEntities_nextToken :: Lens' ListExperienceEntities (Maybe Text) Source #

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.

listExperienceEntities_id :: Lens' ListExperienceEntities Text Source #

The identifier of your Amazon Kendra experience.

listExperienceEntities_indexId :: Lens' ListExperienceEntities Text Source #

The identifier of the index for your Amazon Kendra experience.

listExperienceEntitiesResponse_nextToken :: Lens' ListExperienceEntitiesResponse (Maybe Text) Source #

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.

listExperienceEntitiesResponse_summaryItems :: Lens' ListExperienceEntitiesResponse (Maybe [ExperienceEntitiesSummary]) Source #

An array of summary information for one or more users or groups.

listExperienceEntitiesResponse_httpStatus :: Lens' ListExperienceEntitiesResponse Int Source #

The response's http status code.

ListExperiences

listExperiences_maxResults :: Lens' ListExperiences (Maybe Natural) Source #

The maximum number of returned Amazon Kendra experiences.

listExperiences_nextToken :: Lens' ListExperiences (Maybe Text) Source #

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.

listExperiences_indexId :: Lens' ListExperiences Text Source #

The identifier of the index for your Amazon Kendra experience.

listExperiencesResponse_nextToken :: Lens' ListExperiencesResponse (Maybe Text) Source #

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.

listExperiencesResponse_summaryItems :: Lens' ListExperiencesResponse (Maybe [ExperiencesSummary]) Source #

An array of summary information for one or more Amazon Kendra experiences.

listExperiencesResponse_httpStatus :: Lens' ListExperiencesResponse Int Source #

The response's http status code.

ListFaqs

listFaqs_maxResults :: Lens' ListFaqs (Maybe Natural) Source #

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.

listFaqs_nextToken :: Lens' ListFaqs (Maybe Text) Source #

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.

listFaqs_indexId :: Lens' ListFaqs Text Source #

The index that contains the FAQ lists.

listFaqsResponse_faqSummaryItems :: Lens' ListFaqsResponse (Maybe [FaqSummary]) Source #

information about the FAQs associated with the specified index.

listFaqsResponse_nextToken :: Lens' ListFaqsResponse (Maybe Text) Source #

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.

listFaqsResponse_httpStatus :: Lens' ListFaqsResponse Int Source #

The response's http status code.

ListGroupsOlderThanOrderingId

listGroupsOlderThanOrderingId_dataSourceId :: Lens' ListGroupsOlderThanOrderingId (Maybe Text) Source #

The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.

listGroupsOlderThanOrderingId_maxResults :: Lens' ListGroupsOlderThanOrderingId (Maybe Natural) Source #

The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.

listGroupsOlderThanOrderingId_nextToken :: Lens' ListGroupsOlderThanOrderingId (Maybe Text) Source #

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.

listGroupsOlderThanOrderingId_indexId :: Lens' ListGroupsOlderThanOrderingId Text Source #

The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.

listGroupsOlderThanOrderingId_orderingId :: Lens' ListGroupsOlderThanOrderingId Natural Source #

The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

listGroupsOlderThanOrderingIdResponse_groupsSummaries :: Lens' ListGroupsOlderThanOrderingIdResponse (Maybe [GroupSummary]) Source #

Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.

listGroupsOlderThanOrderingIdResponse_nextToken :: Lens' ListGroupsOlderThanOrderingIdResponse (Maybe Text) Source #

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.

listGroupsOlderThanOrderingIdResponse_httpStatus :: Lens' ListGroupsOlderThanOrderingIdResponse Int Source #

The response's http status code.

ListIndices

listIndices_maxResults :: Lens' ListIndices (Maybe Natural) Source #

The maximum number of indices to return.

listIndices_nextToken :: Lens' ListIndices (Maybe Text) Source #

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.

listIndicesResponse_indexConfigurationSummaryItems :: Lens' ListIndicesResponse (Maybe [IndexConfigurationSummary]) Source #

An array of summary information on the configuration of one or more indexes.

listIndicesResponse_nextToken :: Lens' ListIndicesResponse (Maybe Text) Source #

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.

listIndicesResponse_httpStatus :: Lens' ListIndicesResponse Int Source #

The response's http status code.

ListQuerySuggestionsBlockLists

listQuerySuggestionsBlockLists_maxResults :: Lens' ListQuerySuggestionsBlockLists (Maybe Natural) Source #

The maximum number of block lists to return.

listQuerySuggestionsBlockLists_nextToken :: Lens' ListQuerySuggestionsBlockLists (Maybe Text) Source #

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).

listQuerySuggestionsBlockLists_indexId :: Lens' ListQuerySuggestionsBlockLists Text Source #

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.

listQuerySuggestionsBlockListsResponse_blockListSummaryItems :: Lens' ListQuerySuggestionsBlockListsResponse (Maybe [QuerySuggestionsBlockListSummary]) Source #

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.

listQuerySuggestionsBlockListsResponse_nextToken :: Lens' ListQuerySuggestionsBlockListsResponse (Maybe Text) Source #

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.

listQuerySuggestionsBlockListsResponse_httpStatus :: Lens' ListQuerySuggestionsBlockListsResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

A list of tags associated with the index, FAQ, or data source.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListThesauri

listThesauri_maxResults :: Lens' ListThesauri (Maybe Natural) Source #

The maximum number of thesauri to return.

listThesauri_nextToken :: Lens' ListThesauri (Maybe Text) Source #

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).

listThesauri_indexId :: Lens' ListThesauri Text Source #

The identifier of the index with one or more thesauri.

listThesauriResponse_nextToken :: Lens' ListThesauriResponse (Maybe Text) Source #

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.

listThesauriResponse_thesaurusSummaryItems :: Lens' ListThesauriResponse (Maybe [ThesaurusSummary]) Source #

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

listThesauriResponse_httpStatus :: Lens' ListThesauriResponse Int Source #

The response's http status code.

PutPrincipalMapping

putPrincipalMapping_dataSourceId :: Lens' PutPrincipalMapping (Maybe Text) Source #

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.

putPrincipalMapping_orderingId :: Lens' PutPrincipalMapping (Maybe Natural) Source #

The timestamp identifier you specify to ensure Amazon Kendra does not 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.

putPrincipalMapping_roleArn :: Lens' PutPrincipalMapping (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.

For more information, see IAM roles for Amazon Kendra.

putPrincipalMapping_indexId :: Lens' PutPrincipalMapping Text Source #

The identifier of the index you want to map users to their groups.

putPrincipalMapping_groupId :: Lens' PutPrincipalMapping Text Source #

The identifier of the group you want to map its users to.

putPrincipalMapping_groupMembers :: Lens' PutPrincipalMapping GroupMembers Source #

The list that contains your users or sub groups that belong the same group.

For example, the group "Company" 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.

Query

query_attributeFilter :: Lens' Query (Maybe AttributeFilter) Source #

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

query_documentRelevanceOverrideConfigurations :: Lens' Query (Maybe [DocumentRelevanceConfiguration]) Source #

Overrides relevance tuning configurations of fields or 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 at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but 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.

query_facets :: Lens' Query (Maybe [Facet]) Source #

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.

query_pageNumber :: Lens' Query (Maybe Int) Source #

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.

query_pageSize :: Lens' Query (Maybe Int) Source #

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.

query_queryResultTypeFilter :: Lens' Query (Maybe QueryResultType) Source #

Sets the type of query. Only results for the specified query type are returned.

query_queryText :: Lens' Query (Maybe Text) Source #

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.

query_requestedDocumentAttributes :: Lens' Query (Maybe (NonEmpty Text)) Source #

An array of document attributes to include in the response. You can limit the response to include certain document attributes. By default all document attributes are included in the response.

query_sortingConfiguration :: Lens' Query (Maybe SortingConfiguration) Source #

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.

query_spellCorrectionConfiguration :: Lens' Query (Maybe SpellCorrectionConfiguration) Source #

Enables suggested spell corrections for queries.

query_userContext :: Lens' Query (Maybe UserContext) Source #

The user context token or user and group information.

query_visitorId :: Lens' Query (Maybe Text) Source #

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.

query_indexId :: Lens' Query Text Source #

The identifier of the index to search. The identifier is returned in the response from the CreateIndex API.

queryResponse_facetResults :: Lens' QueryResponse (Maybe [FacetResult]) Source #

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

queryResponse_queryId :: Lens' QueryResponse (Maybe Text) Source #

The identifier for the search. You use QueryId to identify the search when using the feedback API.

queryResponse_resultItems :: Lens' QueryResponse (Maybe [QueryResultItem]) Source #

The results of the search.

queryResponse_spellCorrectedQueries :: Lens' QueryResponse (Maybe [SpellCorrectedQuery]) Source #

A list of information related to suggested spell corrections for a query.

queryResponse_totalNumberOfResults :: Lens' QueryResponse (Maybe Int) Source #

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.

queryResponse_warnings :: Lens' QueryResponse (Maybe (NonEmpty Warning)) Source #

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.

queryResponse_httpStatus :: Lens' QueryResponse Int Source #

The response's http status code.

StartDataSourceSyncJob

startDataSourceSyncJob_id :: Lens' StartDataSourceSyncJob Text Source #

The identifier of the data source connector to synchronize.

startDataSourceSyncJob_indexId :: Lens' StartDataSourceSyncJob Text Source #

The identifier of the index used with the data source connector.

startDataSourceSyncJobResponse_executionId :: Lens' StartDataSourceSyncJobResponse (Maybe Text) Source #

Identifies a particular synchronization job.

startDataSourceSyncJobResponse_httpStatus :: Lens' StartDataSourceSyncJobResponse Int Source #

The response's http status code.

StopDataSourceSyncJob

stopDataSourceSyncJob_id :: Lens' StopDataSourceSyncJob Text Source #

The identifier of the data source connector for which to stop the synchronization jobs.

stopDataSourceSyncJob_indexId :: Lens' StopDataSourceSyncJob Text Source #

The identifier of the index used with the data source connector.

SubmitFeedback

submitFeedback_clickFeedbackItems :: Lens' SubmitFeedback (Maybe [ClickFeedback]) Source #

Tells Amazon Kendra that a particular search result link was chosen by the user.

submitFeedback_relevanceFeedbackItems :: Lens' SubmitFeedback (Maybe [RelevanceFeedback]) Source #

Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

submitFeedback_indexId :: Lens' SubmitFeedback Text Source #

The identifier of the index that was queried.

submitFeedback_queryId :: Lens' SubmitFeedback Text Source #

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of tag keys to add to the index, FAQ, or data source. If a tag already exists, the existing value is replaced with the new value.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of tag keys to remove from the index, FAQ, or data source. If a tag key does not exist on the resource, it is ignored.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateAccessControlConfiguration

updateAccessControlConfiguration_accessControlList :: Lens' UpdateAccessControlConfiguration (Maybe [Principal]) Source #

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.

updateAccessControlConfiguration_description :: Lens' UpdateAccessControlConfiguration (Maybe Text) Source #

A new description for the access control configuration.

updateAccessControlConfiguration_hierarchicalAccessControlList :: Lens' UpdateAccessControlConfiguration (Maybe (NonEmpty HierarchicalPrincipal)) Source #

The updated list of principal lists that define the hierarchy for which documents users should have access to.

updateAccessControlConfiguration_name :: Lens' UpdateAccessControlConfiguration (Maybe Text) Source #

A new name for the access control configuration.

updateAccessControlConfiguration_indexId :: Lens' UpdateAccessControlConfiguration Text Source #

The identifier of the index for an access control configuration.

updateAccessControlConfiguration_id :: Lens' UpdateAccessControlConfiguration Text Source #

The identifier of the access control configuration you want to update.

updateAccessControlConfigurationResponse_httpStatus :: Lens' UpdateAccessControlConfigurationResponse Int Source #

The response's http status code.

UpdateDataSource

updateDataSource_configuration :: Lens' UpdateDataSource (Maybe DataSourceConfiguration) Source #

Configuration information you want to update for the data source connector.

updateDataSource_customDocumentEnrichmentConfiguration :: Lens' UpdateDataSource (Maybe CustomDocumentEnrichmentConfiguration) Source #

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.

updateDataSource_description :: Lens' UpdateDataSource (Maybe Text) Source #

A new description for the data source connector.

updateDataSource_languageCode :: Lens' UpdateDataSource (Maybe Text) Source #

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.

updateDataSource_name :: Lens' UpdateDataSource (Maybe Text) Source #

A new name for the data source connector.

updateDataSource_roleArn :: Lens' UpdateDataSource (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.

updateDataSource_schedule :: Lens' UpdateDataSource (Maybe Text) Source #

The sync schedule you want to update for the data source connector.

updateDataSource_vpcConfiguration :: Lens' UpdateDataSource (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

updateDataSource_id :: Lens' UpdateDataSource Text Source #

The identifier of the data source connector you want to update.

updateDataSource_indexId :: Lens' UpdateDataSource Text Source #

The identifier of the index used with the data source connector.

UpdateExperience

updateExperience_configuration :: Lens' UpdateExperience (Maybe ExperienceConfiguration) Source #

Configuration information you want to update for your Amazon Kendra experience.

updateExperience_description :: Lens' UpdateExperience (Maybe Text) Source #

A new description for your Amazon Kendra experience.

updateExperience_name :: Lens' UpdateExperience (Maybe Text) Source #

A new name for your Amazon Kendra experience.

updateExperience_roleArn :: Lens' UpdateExperience (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

updateExperience_id :: Lens' UpdateExperience Text Source #

The identifier of your Amazon Kendra experience you want to update.

updateExperience_indexId :: Lens' UpdateExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

UpdateIndex

updateIndex_capacityUnits :: Lens' UpdateIndex (Maybe CapacityUnitsConfiguration) Source #

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.

updateIndex_description :: Lens' UpdateIndex (Maybe Text) Source #

A new description for the index.

updateIndex_documentMetadataConfigurationUpdates :: Lens' UpdateIndex (Maybe [DocumentMetadataConfiguration]) Source #

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.

updateIndex_name :: Lens' UpdateIndex (Maybe Text) Source #

The name of the index you want to update.

updateIndex_roleArn :: Lens' UpdateIndex (Maybe Text) Source #

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

updateIndex_userContextPolicy :: Lens' UpdateIndex (Maybe UserContextPolicy) Source #

The user context policy.

updateIndex_userGroupResolutionConfiguration :: Lens' UpdateIndex (Maybe UserGroupResolutionConfiguration) Source #

Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

updateIndex_userTokenConfigurations :: Lens' UpdateIndex (Maybe [UserTokenConfiguration]) Source #

The user token configuration.

updateIndex_id :: Lens' UpdateIndex Text Source #

The identifier of the index you want to update.

UpdateQuerySuggestionsBlockList

updateQuerySuggestionsBlockList_description :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text) Source #

A new description for the block list.

updateQuerySuggestionsBlockList_name :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text) Source #

A new name for the block list.

updateQuerySuggestionsBlockList_roleArn :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text) Source #

The IAM (Identity and Access Management) role used to access the block list text file in S3.

updateQuerySuggestionsBlockList_sourceS3Path :: Lens' UpdateQuerySuggestionsBlockList (Maybe S3Path) Source #

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.

updateQuerySuggestionsBlockList_indexId :: Lens' UpdateQuerySuggestionsBlockList Text Source #

The identifier of the index for the block list.

updateQuerySuggestionsBlockList_id :: Lens' UpdateQuerySuggestionsBlockList Text Source #

The identifier of the block list you want to update.

UpdateQuerySuggestionsConfig

updateQuerySuggestionsConfig_includeQueriesWithoutUserInformation :: Lens' UpdateQuerySuggestionsConfig (Maybe Bool) Source #

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.

updateQuerySuggestionsConfig_minimumNumberOfQueryingUsers :: Lens' UpdateQuerySuggestionsConfig (Maybe Natural) Source #

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.

updateQuerySuggestionsConfig_minimumQueryCount :: Lens' UpdateQuerySuggestionsConfig (Maybe Natural) Source #

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.

updateQuerySuggestionsConfig_mode :: Lens' UpdateQuerySuggestionsConfig (Maybe Mode) Source #

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.

updateQuerySuggestionsConfig_queryLogLookBackWindowInDays :: Lens' UpdateQuerySuggestionsConfig (Maybe Int) Source #

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.

updateQuerySuggestionsConfig_indexId :: Lens' UpdateQuerySuggestionsConfig Text Source #

The identifier of the index with query suggestions you want to update.

UpdateThesaurus

updateThesaurus_description :: Lens' UpdateThesaurus (Maybe Text) Source #

A new description for the thesaurus.

updateThesaurus_name :: Lens' UpdateThesaurus (Maybe Text) Source #

A new name for the thesaurus.

updateThesaurus_roleArn :: Lens' UpdateThesaurus (Maybe Text) Source #

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

updateThesaurus_sourceS3Path :: Lens' UpdateThesaurus (Maybe S3Path) Source #

Undocumented member.

updateThesaurus_id :: Lens' UpdateThesaurus Text Source #

The identifier of the thesaurus you want to update.

updateThesaurus_indexId :: Lens' UpdateThesaurus Text Source #

The identifier of the index for the thesaurus.

Types

AccessControlConfigurationSummary

accessControlConfigurationSummary_id :: Lens' AccessControlConfigurationSummary Text Source #

The identifier of the access control configuration.

AccessControlListConfiguration

accessControlListConfiguration_keyPath :: Lens' AccessControlListConfiguration (Maybe Text) Source #

Path to the Amazon S3 bucket that contains the ACL files.

AclConfiguration

aclConfiguration_allowedGroupsColumnName :: Lens' AclConfiguration Text Source #

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.

AdditionalResultAttribute

additionalResultAttribute_key :: Lens' AdditionalResultAttribute Text Source #

The key that identifies the attribute.

additionalResultAttribute_valueType :: Lens' AdditionalResultAttribute AdditionalResultAttributeValueType Source #

The data type of the Value property.

additionalResultAttribute_value :: Lens' AdditionalResultAttribute AdditionalResultAttributeValue Source #

An object that contains the attribute value.

AdditionalResultAttributeValue

additionalResultAttributeValue_textWithHighlightsValue :: Lens' AdditionalResultAttributeValue (Maybe TextWithHighlights) Source #

The text associated with the attribute and information about the highlight to apply to the text.

AlfrescoConfiguration

alfrescoConfiguration_blogFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

alfrescoConfiguration_crawlComments :: Lens' AlfrescoConfiguration (Maybe Bool) Source #

TRUE to index comments of blogs and other content.

alfrescoConfiguration_crawlSystemFolders :: Lens' AlfrescoConfiguration (Maybe Bool) Source #

TRUE to index shared files.

alfrescoConfiguration_documentLibraryFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

alfrescoConfiguration_entityFilter :: Lens' AlfrescoConfiguration (Maybe (NonEmpty AlfrescoEntity)) Source #

Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.

alfrescoConfiguration_exclusionPatterns :: Lens' AlfrescoConfiguration (Maybe [Text]) Source #

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.

alfrescoConfiguration_inclusionPatterns :: Lens' AlfrescoConfiguration (Maybe [Text]) Source #

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.

alfrescoConfiguration_vpcConfiguration :: Lens' AlfrescoConfiguration (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.

alfrescoConfiguration_wikiFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

alfrescoConfiguration_siteUrl :: Lens' AlfrescoConfiguration Text Source #

The URL of the Alfresco site. For example, https://hostname:8080.

alfrescoConfiguration_siteId :: Lens' AlfrescoConfiguration Text Source #

The identifier of the Alfresco site. For example, my-site.

alfrescoConfiguration_secretArn :: Lens' AlfrescoConfiguration Text Source #

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.

alfrescoConfiguration_sslCertificateS3Path :: Lens' AlfrescoConfiguration S3Path Source #

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.

AttributeFilter

attributeFilter_andAllFilters :: Lens' AttributeFilter (Maybe [AttributeFilter]) Source #

Performs a logical AND operation on all supplied filters.

attributeFilter_containsAll :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #

Returns true when a document contains all of the specified document attributes or metadata fields. This filter is only applicable to StringListValue metadata.

attributeFilter_containsAny :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #

Returns true when a document contains any of the specified document attributes or metadata fields. This filter is only applicable to StringListValue metadata.

attributeFilter_equalsTo :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #

Performs an equals operation on two document attributes or metadata fields.

attributeFilter_greaterThan :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #

Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

attributeFilter_greaterThanOrEquals :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #

Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

attributeFilter_lessThan :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #

Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

attributeFilter_lessThanOrEquals :: Lens' AttributeFilter (Maybe DocumentAttribute) Source #

Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

attributeFilter_notFilter :: Lens' AttributeFilter (Maybe AttributeFilter) Source #

Performs a logical NOT operation on all supplied filters.

attributeFilter_orAllFilters :: Lens' AttributeFilter (Maybe [AttributeFilter]) Source #

Performs a logical OR operation on all supplied filters.

AuthenticationConfiguration

authenticationConfiguration_basicAuthentication :: Lens' AuthenticationConfiguration (Maybe [BasicAuthenticationConfiguration]) Source #

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.

BasicAuthenticationConfiguration

basicAuthenticationConfiguration_host :: Lens' BasicAuthenticationConfiguration Text Source #

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".

basicAuthenticationConfiguration_port :: Lens' BasicAuthenticationConfiguration Natural Source #

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.

basicAuthenticationConfiguration_credentials :: Lens' BasicAuthenticationConfiguration Text Source #

Your secret ARN, which you can create 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.

BatchDeleteDocumentResponseFailedDocument

batchDeleteDocumentResponseFailedDocument_errorCode :: Lens' BatchDeleteDocumentResponseFailedDocument (Maybe ErrorCode) Source #

The error code for why the document couldn't be removed from the index.

batchDeleteDocumentResponseFailedDocument_errorMessage :: Lens' BatchDeleteDocumentResponseFailedDocument (Maybe Text) Source #

An explanation for why the document couldn't be removed from the index.

batchDeleteDocumentResponseFailedDocument_id :: Lens' BatchDeleteDocumentResponseFailedDocument (Maybe Text) Source #

The identifier of the document that couldn't be removed from the index.

BatchGetDocumentStatusResponseError

batchGetDocumentStatusResponseError_documentId :: Lens' BatchGetDocumentStatusResponseError (Maybe Text) Source #

The identifier of the document whose status could not be retrieved.

batchGetDocumentStatusResponseError_errorCode :: Lens' BatchGetDocumentStatusResponseError (Maybe ErrorCode) Source #

Indicates the source of the error.

batchGetDocumentStatusResponseError_errorMessage :: Lens' BatchGetDocumentStatusResponseError (Maybe Text) Source #

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.

BatchPutDocumentResponseFailedDocument

batchPutDocumentResponseFailedDocument_errorCode :: Lens' BatchPutDocumentResponseFailedDocument (Maybe ErrorCode) Source #

The type of error that caused the document to fail to be indexed.

batchPutDocumentResponseFailedDocument_errorMessage :: Lens' BatchPutDocumentResponseFailedDocument (Maybe Text) Source #

A description of the reason why the document could not be indexed.

batchPutDocumentResponseFailedDocument_id :: Lens' BatchPutDocumentResponseFailedDocument (Maybe Text) Source #

The identifier of the document.

BoxConfiguration

boxConfiguration_commentFieldMappings :: Lens' BoxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

boxConfiguration_crawlComments :: Lens' BoxConfiguration (Maybe Bool) Source #

TRUE to index comments.

boxConfiguration_crawlTasks :: Lens' BoxConfiguration (Maybe Bool) Source #

TRUE to index the contents of tasks.

boxConfiguration_crawlWebLinks :: Lens' BoxConfiguration (Maybe Bool) Source #

TRUE to index web links.

boxConfiguration_exclusionPatterns :: Lens' BoxConfiguration (Maybe [Text]) Source #

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.

boxConfiguration_fileFieldMappings :: Lens' BoxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

boxConfiguration_inclusionPatterns :: Lens' BoxConfiguration (Maybe [Text]) Source #

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.

boxConfiguration_taskFieldMappings :: Lens' BoxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

boxConfiguration_useChangeLog :: Lens' BoxConfiguration (Maybe Bool) Source #

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.

boxConfiguration_vpcConfiguration :: Lens' BoxConfiguration (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.

boxConfiguration_webLinkFieldMappings :: Lens' BoxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

boxConfiguration_enterpriseId :: Lens' BoxConfiguration Text Source #

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.

boxConfiguration_secretArn :: Lens' BoxConfiguration Text Source #

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.

CapacityUnitsConfiguration

capacityUnitsConfiguration_storageCapacityUnits :: Lens' CapacityUnitsConfiguration Natural Source #

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.

capacityUnitsConfiguration_queryCapacityUnits :: Lens' CapacityUnitsConfiguration Natural Source #

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).

ClickFeedback

clickFeedback_resultId :: Lens' ClickFeedback Text Source #

The identifier of the search result that was clicked.

clickFeedback_clickTime :: Lens' ClickFeedback UTCTime Source #

The Unix timestamp of the date and time that the result was clicked.

ColumnConfiguration

columnConfiguration_documentTitleColumnName :: Lens' ColumnConfiguration (Maybe Text) Source #

The column that contains the title of the document.

columnConfiguration_fieldMappings :: Lens' ColumnConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

columnConfiguration_documentIdColumnName :: Lens' ColumnConfiguration Text Source #

The column that provides the document's identifier.

columnConfiguration_documentDataColumnName :: Lens' ColumnConfiguration Text Source #

The column that contains the contents of the document.

columnConfiguration_changeDetectingColumns :: Lens' ColumnConfiguration (NonEmpty Text) Source #

One to five columns that indicate when a document in the database has changed.

ConfluenceAttachmentConfiguration

confluenceAttachmentConfiguration_attachmentFieldMappings :: Lens' ConfluenceAttachmentConfiguration (Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping)) Source #

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.

confluenceAttachmentConfiguration_crawlAttachments :: Lens' ConfluenceAttachmentConfiguration (Maybe Bool) Source #

TRUE to index attachments of pages and blogs in Confluence.

ConfluenceAttachmentToIndexFieldMapping

confluenceAttachmentToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceAttachmentToIndexFieldMapping (Maybe ConfluenceAttachmentFieldName) Source #

The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

confluenceAttachmentToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceAttachmentToIndexFieldMapping (Maybe Text) Source #

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.

confluenceAttachmentToIndexFieldMapping_indexFieldName :: Lens' ConfluenceAttachmentToIndexFieldMapping (Maybe Text) Source #

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

ConfluenceBlogConfiguration

confluenceBlogConfiguration_blogFieldMappings :: Lens' ConfluenceBlogConfiguration (Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)) Source #

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.

ConfluenceBlogToIndexFieldMapping

confluenceBlogToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe ConfluenceBlogFieldName) Source #

The name of the field in the data source.

confluenceBlogToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe Text) Source #

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.

confluenceBlogToIndexFieldMapping_indexFieldName :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe Text) Source #

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

ConfluenceConfiguration

confluenceConfiguration_attachmentConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceAttachmentConfiguration) Source #

Configuration information for indexing attachments to Confluence blogs and pages.

confluenceConfiguration_authenticationType :: Lens' ConfluenceConfiguration (Maybe ConfluenceAuthenticationType) Source #

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.

confluenceConfiguration_blogConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceBlogConfiguration) Source #

Configuration information for indexing Confluence blogs.

confluenceConfiguration_exclusionPatterns :: Lens' ConfluenceConfiguration (Maybe [Text]) Source #

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.

confluenceConfiguration_inclusionPatterns :: Lens' ConfluenceConfiguration (Maybe [Text]) Source #

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.

confluenceConfiguration_pageConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluencePageConfiguration) Source #

Configuration information for indexing Confluence pages.

confluenceConfiguration_proxyConfiguration :: Lens' ConfluenceConfiguration (Maybe ProxyConfiguration) Source #

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.

confluenceConfiguration_spaceConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceSpaceConfiguration) Source #

Configuration information for indexing Confluence spaces.

confluenceConfiguration_vpcConfiguration :: Lens' ConfluenceConfiguration (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

confluenceConfiguration_serverUrl :: Lens' ConfluenceConfiguration Text Source #

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/.

confluenceConfiguration_secretArn :: Lens' ConfluenceConfiguration Text Source #

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.

confluenceConfiguration_version :: Lens' ConfluenceConfiguration ConfluenceVersion Source #

The version or the type of Confluence installation to connect to.

ConfluencePageConfiguration

confluencePageConfiguration_pageFieldMappings :: Lens' ConfluencePageConfiguration (Maybe (NonEmpty ConfluencePageToIndexFieldMapping)) Source #

Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

ConfluencePageToIndexFieldMapping

confluencePageToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluencePageToIndexFieldMapping (Maybe ConfluencePageFieldName) Source #

The name of the field in the data source.

confluencePageToIndexFieldMapping_dateFieldFormat :: Lens' ConfluencePageToIndexFieldMapping (Maybe Text) Source #

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.

confluencePageToIndexFieldMapping_indexFieldName :: Lens' ConfluencePageToIndexFieldMapping (Maybe Text) Source #

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

ConfluenceSpaceConfiguration

confluenceSpaceConfiguration_crawlArchivedSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe Bool) Source #

TRUE to index archived spaces.

confluenceSpaceConfiguration_crawlPersonalSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe Bool) Source #

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.

confluenceSpaceConfiguration_excludeSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty Text)) Source #

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.

confluenceSpaceConfiguration_includeSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty Text)) Source #

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.

confluenceSpaceConfiguration_spaceFieldMappings :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping)) Source #

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.

ConfluenceSpaceToIndexFieldMapping

confluenceSpaceToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceSpaceToIndexFieldMapping (Maybe ConfluenceSpaceFieldName) Source #

The name of the field in the data source.

confluenceSpaceToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceSpaceToIndexFieldMapping (Maybe Text) Source #

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.

confluenceSpaceToIndexFieldMapping_indexFieldName :: Lens' ConfluenceSpaceToIndexFieldMapping (Maybe Text) Source #

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

ConnectionConfiguration

connectionConfiguration_databaseHost :: Lens' ConnectionConfiguration Text Source #

The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

connectionConfiguration_databasePort :: Lens' ConnectionConfiguration Natural Source #

The port that the database uses for connections.

connectionConfiguration_databaseName :: Lens' ConnectionConfiguration Text Source #

The name of the database containing the document data.

connectionConfiguration_tableName :: Lens' ConnectionConfiguration Text Source #

The name of the table that contains the document data.

connectionConfiguration_secretArn :: Lens' ConnectionConfiguration Text Source #

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. 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.

ContentSourceConfiguration

contentSourceConfiguration_dataSourceIds :: Lens' ContentSourceConfiguration (Maybe (NonEmpty Text)) Source #

The identifier of the data sources you want to use for your Amazon Kendra experience.

contentSourceConfiguration_directPutContent :: Lens' ContentSourceConfiguration (Maybe Bool) Source #

TRUE to use documents you indexed directly using the BatchPutDocument API.

contentSourceConfiguration_faqIds :: Lens' ContentSourceConfiguration (Maybe (NonEmpty Text)) Source #

The identifier of the FAQs that you want to use for your Amazon Kendra experience.

Correction

correction_beginOffset :: Lens' Correction (Maybe Int) Source #

The zero-based location in the response string or text where the corrected word starts.

correction_correctedTerm :: Lens' Correction (Maybe Text) Source #

The string or text of a corrected misspelled word in a query.

correction_endOffset :: Lens' Correction (Maybe Int) Source #

The zero-based location in the response string or text where the corrected word ends.

correction_term :: Lens' Correction (Maybe Text) Source #

The string or text of a misspelled word in a query.

CustomDocumentEnrichmentConfiguration

customDocumentEnrichmentConfiguration_inlineConfigurations :: Lens' CustomDocumentEnrichmentConfiguration (Maybe [InlineCustomDocumentEnrichmentConfiguration]) Source #

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

customDocumentEnrichmentConfiguration_postExtractionHookConfiguration :: Lens' CustomDocumentEnrichmentConfiguration (Maybe HookConfiguration) Source #

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.

customDocumentEnrichmentConfiguration_preExtractionHookConfiguration :: Lens' CustomDocumentEnrichmentConfiguration (Maybe HookConfiguration) Source #

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.

customDocumentEnrichmentConfiguration_roleArn :: Lens' CustomDocumentEnrichmentConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see IAM roles for Amazon Kendra.

DataSourceConfiguration

dataSourceConfiguration_alfrescoConfiguration :: Lens' DataSourceConfiguration (Maybe AlfrescoConfiguration) Source #

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

dataSourceConfiguration_boxConfiguration :: Lens' DataSourceConfiguration (Maybe BoxConfiguration) Source #

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

dataSourceConfiguration_confluenceConfiguration :: Lens' DataSourceConfiguration (Maybe ConfluenceConfiguration) Source #

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

dataSourceConfiguration_databaseConfiguration :: Lens' DataSourceConfiguration (Maybe DatabaseConfiguration) Source #

Provides the configuration information to connect to a database as your data source.

dataSourceConfiguration_fsxConfiguration :: Lens' DataSourceConfiguration (Maybe FsxConfiguration) Source #

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

dataSourceConfiguration_gitHubConfiguration :: Lens' DataSourceConfiguration (Maybe GitHubConfiguration) Source #

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

dataSourceConfiguration_googleDriveConfiguration :: Lens' DataSourceConfiguration (Maybe GoogleDriveConfiguration) Source #

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

dataSourceConfiguration_jiraConfiguration :: Lens' DataSourceConfiguration (Maybe JiraConfiguration) Source #

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

dataSourceConfiguration_oneDriveConfiguration :: Lens' DataSourceConfiguration (Maybe OneDriveConfiguration) Source #

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

dataSourceConfiguration_quipConfiguration :: Lens' DataSourceConfiguration (Maybe QuipConfiguration) Source #

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

dataSourceConfiguration_s3Configuration :: Lens' DataSourceConfiguration (Maybe S3DataSourceConfiguration) Source #

Provides the configuration information to connect to an Amazon S3 bucket as your data source.

dataSourceConfiguration_salesforceConfiguration :: Lens' DataSourceConfiguration (Maybe SalesforceConfiguration) Source #

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

dataSourceConfiguration_serviceNowConfiguration :: Lens' DataSourceConfiguration (Maybe ServiceNowConfiguration) Source #

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

dataSourceConfiguration_sharePointConfiguration :: Lens' DataSourceConfiguration (Maybe SharePointConfiguration) Source #

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

dataSourceConfiguration_slackConfiguration :: Lens' DataSourceConfiguration (Maybe SlackConfiguration) Source #

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

dataSourceConfiguration_templateConfiguration :: Lens' DataSourceConfiguration (Maybe TemplateConfiguration) Source #

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

dataSourceConfiguration_webCrawlerConfiguration :: Lens' DataSourceConfiguration (Maybe WebCrawlerConfiguration) Source #

Undocumented member.

dataSourceConfiguration_workDocsConfiguration :: Lens' DataSourceConfiguration (Maybe WorkDocsConfiguration) Source #

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

DataSourceGroup

dataSourceGroup_groupId :: Lens' DataSourceGroup Text Source #

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.

dataSourceGroup_dataSourceId :: Lens' DataSourceGroup Text Source #

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.

DataSourceSummary

dataSourceSummary_createdAt :: Lens' DataSourceSummary (Maybe UTCTime) Source #

The UNIX datetime that the data source was created.

dataSourceSummary_id :: Lens' DataSourceSummary (Maybe Text) Source #

The identifier for the data source.

dataSourceSummary_languageCode :: Lens' DataSourceSummary (Maybe Text) Source #

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.

dataSourceSummary_name :: Lens' DataSourceSummary (Maybe Text) Source #

The name of the data source.

dataSourceSummary_status :: Lens' DataSourceSummary (Maybe DataSourceStatus) Source #

The status of the data source. When the status is ACTIVE the data source is ready to use.

dataSourceSummary_type :: Lens' DataSourceSummary (Maybe DataSourceType) Source #

The type of the data source.

dataSourceSummary_updatedAt :: Lens' DataSourceSummary (Maybe UTCTime) Source #

The UNIX datetime that the data source was lasted updated.

DataSourceSyncJob

dataSourceSyncJob_dataSourceErrorCode :: Lens' DataSourceSyncJob (Maybe Text) Source #

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.

dataSourceSyncJob_endTime :: Lens' DataSourceSyncJob (Maybe UTCTime) Source #

The UNIX datetime that the synchronization job completed.

dataSourceSyncJob_errorCode :: Lens' DataSourceSyncJob (Maybe ErrorCode) Source #

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

dataSourceSyncJob_errorMessage :: Lens' DataSourceSyncJob (Maybe Text) Source #

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

dataSourceSyncJob_executionId :: Lens' DataSourceSyncJob (Maybe Text) Source #

A identifier for the synchronization job.

dataSourceSyncJob_metrics :: Lens' DataSourceSyncJob (Maybe DataSourceSyncJobMetrics) Source #

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.

dataSourceSyncJob_startTime :: Lens' DataSourceSyncJob (Maybe UTCTime) Source #

The UNIX datetime that the synchronization job started.

dataSourceSyncJob_status :: Lens' DataSourceSyncJob (Maybe DataSourceSyncJobStatus) Source #

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.

DataSourceSyncJobMetricTarget

dataSourceSyncJobMetricTarget_dataSourceSyncJobId :: Lens' DataSourceSyncJobMetricTarget (Maybe Text) Source #

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.

dataSourceSyncJobMetricTarget_dataSourceId :: Lens' DataSourceSyncJobMetricTarget Text Source #

The ID of the data source that is running the sync job.

DataSourceSyncJobMetrics

dataSourceSyncJobMetrics_documentsAdded :: Lens' DataSourceSyncJobMetrics (Maybe Text) Source #

The number of documents added from the data source up to now in the data source sync.

dataSourceSyncJobMetrics_documentsDeleted :: Lens' DataSourceSyncJobMetrics (Maybe Text) Source #

The number of documents deleted from the data source up to now in the data source sync run.

dataSourceSyncJobMetrics_documentsFailed :: Lens' DataSourceSyncJobMetrics (Maybe Text) Source #

The number of documents that failed to sync from the data source up to now in the data source sync run.

dataSourceSyncJobMetrics_documentsModified :: Lens' DataSourceSyncJobMetrics (Maybe Text) Source #

The number of documents modified in the data source up to now in the data source sync run.

dataSourceSyncJobMetrics_documentsScanned :: Lens' DataSourceSyncJobMetrics (Maybe Text) Source #

The current number of documents crawled by the current sync job in the data source.

DataSourceToIndexFieldMapping

dataSourceToIndexFieldMapping_dateFieldFormat :: Lens' DataSourceToIndexFieldMapping (Maybe Text) Source #

The type of data stored in the column or attribute.

dataSourceToIndexFieldMapping_dataSourceFieldName :: Lens' DataSourceToIndexFieldMapping Text Source #

The name of the column or attribute in the data source.

dataSourceToIndexFieldMapping_indexFieldName :: Lens' DataSourceToIndexFieldMapping Text Source #

The name of the field in the index.

DataSourceVpcConfiguration

dataSourceVpcConfiguration_subnetIds :: Lens' DataSourceVpcConfiguration (NonEmpty Text) Source #

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.

dataSourceVpcConfiguration_securityGroupIds :: Lens' DataSourceVpcConfiguration (NonEmpty Text) Source #

A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

DatabaseConfiguration

databaseConfiguration_aclConfiguration :: Lens' DatabaseConfiguration (Maybe AclConfiguration) Source #

Information about the database column that provides information for user context filtering.

databaseConfiguration_sqlConfiguration :: Lens' DatabaseConfiguration (Maybe SqlConfiguration) Source #

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

databaseConfiguration_vpcConfiguration :: Lens' DatabaseConfiguration (Maybe DataSourceVpcConfiguration) Source #

Undocumented member.

databaseConfiguration_databaseEngineType :: Lens' DatabaseConfiguration DatabaseEngineType Source #

The type of database engine that runs the database.

databaseConfiguration_connectionConfiguration :: Lens' DatabaseConfiguration ConnectionConfiguration Source #

Configuration information that's required to connect to a database.

databaseConfiguration_columnConfiguration :: Lens' DatabaseConfiguration ColumnConfiguration Source #

Information about where the index should get the document information from the database.

Document

document_accessControlConfigurationId :: Lens' Document (Maybe Text) Source #

The identifier of the access control configuration that you want to apply to the document.

document_accessControlList :: Lens' Document (Maybe [Principal]) Source #

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.

document_attributes :: Lens' Document (Maybe [DocumentAttribute]) Source #

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.

document_blob :: Lens' Document (Maybe ByteString) Source #

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.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

document_contentType :: Lens' Document (Maybe ContentType) Source #

The file type of the document in the Blob field.

document_hierarchicalAccessControlList :: Lens' Document (Maybe (NonEmpty HierarchicalPrincipal)) Source #

The list of principal lists that define the hierarchy for which documents users should have access to.

document_s3Path :: Lens' Document (Maybe S3Path) Source #

Undocumented member.

document_title :: Lens' Document (Maybe Text) Source #

The title of the document.

document_id :: Lens' Document Text Source #

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.

DocumentAttribute

documentAttribute_key :: Lens' DocumentAttribute Text Source #

The identifier for the attribute.

documentAttribute_value :: Lens' DocumentAttribute DocumentAttributeValue Source #

The value of the attribute.

DocumentAttributeCondition

documentAttributeCondition_conditionOnValue :: Lens' DocumentAttributeCondition (Maybe DocumentAttributeValue) Source #

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.

documentAttributeCondition_conditionDocumentAttributeKey :: Lens' DocumentAttributeCondition Text Source #

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.

documentAttributeCondition_operator :: Lens' DocumentAttributeCondition ConditionOperator Source #

The condition operator.

For example, you can use 'Contains' to partially match a string.

DocumentAttributeTarget

documentAttributeTarget_targetDocumentAttributeKey :: Lens' DocumentAttributeTarget (Maybe Text) Source #

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.

documentAttributeTarget_targetDocumentAttributeValue :: Lens' DocumentAttributeTarget (Maybe DocumentAttributeValue) Source #

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'.

documentAttributeTarget_targetDocumentAttributeValueDeletion :: Lens' DocumentAttributeTarget (Maybe Bool) Source #

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.

DocumentAttributeValue

documentAttributeValue_dateValue :: Lens' DocumentAttributeValue (Maybe UTCTime) Source #

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.

documentAttributeValue_longValue :: Lens' DocumentAttributeValue (Maybe Integer) Source #

A long integer value.

documentAttributeValue_stringListValue :: Lens' DocumentAttributeValue (Maybe [Text]) Source #

A list of strings. The default maximum length or number of strings is 10.

documentAttributeValue_stringValue :: Lens' DocumentAttributeValue (Maybe Text) Source #

A string, such as "department".

DocumentAttributeValueCountPair

documentAttributeValueCountPair_count :: Lens' DocumentAttributeValueCountPair (Maybe Int) Source #

The number of documents in the response that have the attribute value for the key.

documentAttributeValueCountPair_documentAttributeValue :: Lens' DocumentAttributeValueCountPair (Maybe DocumentAttributeValue) Source #

The value of the attribute. For example, "HR".

documentAttributeValueCountPair_facetResults :: Lens' DocumentAttributeValueCountPair (Maybe [FacetResult]) Source #

Contains the results of a document attribute 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.

DocumentInfo

documentInfo_attributes :: Lens' DocumentInfo (Maybe [DocumentAttribute]) Source #

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".

documentInfo_documentId :: Lens' DocumentInfo Text Source #

The identifier of the document.

DocumentMetadataConfiguration

documentMetadataConfiguration_relevance :: Lens' DocumentMetadataConfiguration (Maybe Relevance) Source #

Provides tuning parameters to determine how the field affects the search results.

documentMetadataConfiguration_search :: Lens' DocumentMetadataConfiguration (Maybe Search) Source #

Provides information about how the field is used during a search.

documentMetadataConfiguration_name :: Lens' DocumentMetadataConfiguration Text Source #

The name of the index field.

documentMetadataConfiguration_type :: Lens' DocumentMetadataConfiguration DocumentAttributeValueType Source #

The data type of the index field.

DocumentRelevanceConfiguration

documentRelevanceConfiguration_name :: Lens' DocumentRelevanceConfiguration Text Source #

The name of the index field.

documentRelevanceConfiguration_relevance :: Lens' DocumentRelevanceConfiguration Relevance Source #

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.

DocumentsMetadataConfiguration

documentsMetadataConfiguration_s3Prefix :: Lens' DocumentsMetadataConfiguration (Maybe Text) Source #

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.

EntityConfiguration

entityConfiguration_entityId :: Lens' EntityConfiguration Text Source #

The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

entityConfiguration_entityType :: Lens' EntityConfiguration EntityType Source #

Specifies whether you are configuring a User or a Group.

EntityDisplayData

entityDisplayData_firstName :: Lens' EntityDisplayData (Maybe Text) Source #

The first name of the user.

entityDisplayData_groupName :: Lens' EntityDisplayData (Maybe Text) Source #

The name of the group.

entityDisplayData_identifiedUserName :: Lens' EntityDisplayData (Maybe Text) Source #

The user name of the user.

entityDisplayData_lastName :: Lens' EntityDisplayData (Maybe Text) Source #

The last name of the user.

entityDisplayData_userName :: Lens' EntityDisplayData (Maybe Text) Source #

The name of the user.

EntityPersonaConfiguration

entityPersonaConfiguration_entityId :: Lens' EntityPersonaConfiguration Text Source #

The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

entityPersonaConfiguration_persona :: Lens' EntityPersonaConfiguration Persona Source #

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.

ExperienceConfiguration

experienceConfiguration_contentSourceConfiguration :: Lens' ExperienceConfiguration (Maybe ContentSourceConfiguration) Source #

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.

experienceConfiguration_userIdentityConfiguration :: Lens' ExperienceConfiguration (Maybe UserIdentityConfiguration) Source #

The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

ExperienceEndpoint

experienceEndpoint_endpoint :: Lens' ExperienceEndpoint (Maybe Text) Source #

The endpoint of your Amazon Kendra experience.

experienceEndpoint_endpointType :: Lens' ExperienceEndpoint (Maybe EndpointType) Source #

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.

ExperienceEntitiesSummary

experienceEntitiesSummary_displayData :: Lens' ExperienceEntitiesSummary (Maybe EntityDisplayData) Source #

Information about the user entity.

experienceEntitiesSummary_entityId :: Lens' ExperienceEntitiesSummary (Maybe Text) Source #

The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

experienceEntitiesSummary_entityType :: Lens' ExperienceEntitiesSummary (Maybe EntityType) Source #

Shows the type as User or Group.

ExperiencesSummary

experiencesSummary_createdAt :: Lens' ExperiencesSummary (Maybe UTCTime) Source #

The date-time your Amazon Kendra experience was created.

experiencesSummary_endpoints :: Lens' ExperiencesSummary (Maybe (NonEmpty ExperienceEndpoint)) Source #

The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

experiencesSummary_id :: Lens' ExperiencesSummary (Maybe Text) Source #

The identifier of your Amazon Kendra experience.

experiencesSummary_name :: Lens' ExperiencesSummary (Maybe Text) Source #

The name of your Amazon Kendra experience.

experiencesSummary_status :: Lens' ExperiencesSummary (Maybe ExperienceStatus) Source #

The processing status of your Amazon Kendra experience.

Facet

facet_documentAttributeKey :: Lens' Facet (Maybe Text) Source #

The unique key for the document attribute.

facet_facets :: Lens' Facet (Maybe [Facet]) Source #

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.

facet_maxResults :: Lens' Facet (Maybe Natural) Source #

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.

FacetResult

facetResult_documentAttributeKey :: Lens' FacetResult (Maybe Text) Source #

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

facetResult_documentAttributeValueCountPairs :: Lens' FacetResult (Maybe [DocumentAttributeValueCountPair]) Source #

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.

facetResult_documentAttributeValueType :: Lens' FacetResult (Maybe DocumentAttributeValueType) Source #

The data type of the facet value. This is the same as the type defined for the index field when it was created.

FailedEntity

failedEntity_entityId :: Lens' FailedEntity (Maybe Text) Source #

The identifier of the user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

failedEntity_errorMessage :: Lens' FailedEntity (Maybe Text) Source #

The reason the user or group in your IAM Identity Center identity source failed to properly configure with your Amazon Kendra experience.

FaqStatistics

faqStatistics_indexedQuestionAnswersCount :: Lens' FaqStatistics Natural Source #

The total number of FAQ questions and answers contained in the index.

FaqSummary

faqSummary_createdAt :: Lens' FaqSummary (Maybe UTCTime) Source #

The UNIX datetime that the FAQ was added to the index.

faqSummary_fileFormat :: Lens' FaqSummary (Maybe FaqFileFormat) Source #

The file type used to create the FAQ.

faqSummary_id :: Lens' FaqSummary (Maybe Text) Source #

The identifier of the FAQ.

faqSummary_languageCode :: Lens' FaqSummary (Maybe Text) Source #

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.

faqSummary_name :: Lens' FaqSummary (Maybe Text) Source #

The name that you assigned the FAQ when you created or updated the FAQ.

faqSummary_status :: Lens' FaqSummary (Maybe FaqStatus) Source #

The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

faqSummary_updatedAt :: Lens' FaqSummary (Maybe UTCTime) Source #

The UNIX datetime that the FAQ was last updated.

FsxConfiguration

fsxConfiguration_exclusionPatterns :: Lens' FsxConfiguration (Maybe [Text]) Source #

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.

fsxConfiguration_fieldMappings :: Lens' FsxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

fsxConfiguration_inclusionPatterns :: Lens' FsxConfiguration (Maybe [Text]) Source #

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.

fsxConfiguration_secretArn :: Lens' FsxConfiguration (Maybe Text) Source #

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.

fsxConfiguration_fileSystemId :: Lens' FsxConfiguration Text Source #

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.

fsxConfiguration_fileSystemType :: Lens' FsxConfiguration FsxFileSystemType Source #

The Amazon FSx file system type. Windows is currently the only supported type.

fsxConfiguration_vpcConfiguration :: Lens' FsxConfiguration DataSourceVpcConfiguration Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

GitHubConfiguration

gitHubConfiguration_exclusionFileNamePatterns :: Lens' GitHubConfiguration (Maybe [Text]) Source #

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.

gitHubConfiguration_exclusionFileTypePatterns :: Lens' GitHubConfiguration (Maybe [Text]) Source #

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.

gitHubConfiguration_exclusionFolderNamePatterns :: Lens' GitHubConfiguration (Maybe [Text]) Source #

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.

gitHubConfiguration_gitHubCommitConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

gitHubConfiguration_gitHubDocumentCrawlProperties :: Lens' GitHubConfiguration (Maybe GitHubDocumentCrawlProperties) Source #

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.

gitHubConfiguration_gitHubIssueAttachmentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

gitHubConfiguration_gitHubIssueCommentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

gitHubConfiguration_gitHubIssueDocumentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

gitHubConfiguration_gitHubPullRequestCommentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

gitHubConfiguration_gitHubPullRequestDocumentAttachmentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

gitHubConfiguration_gitHubPullRequestDocumentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

gitHubConfiguration_gitHubRepositoryConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

gitHubConfiguration_inclusionFileNamePatterns :: Lens' GitHubConfiguration (Maybe [Text]) Source #

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.

gitHubConfiguration_inclusionFileTypePatterns :: Lens' GitHubConfiguration (Maybe [Text]) Source #

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.

gitHubConfiguration_inclusionFolderNamePatterns :: Lens' GitHubConfiguration (Maybe [Text]) Source #

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.

gitHubConfiguration_onPremiseConfiguration :: Lens' GitHubConfiguration (Maybe OnPremiseConfiguration) Source #

Configuration information to connect to GitHub Enterprise Server (on premises).

gitHubConfiguration_repositoryFilter :: Lens' GitHubConfiguration (Maybe [Text]) Source #

A list of names of the specific repositories you want to index.

gitHubConfiguration_saaSConfiguration :: Lens' GitHubConfiguration (Maybe SaaSConfiguration) Source #

Configuration information to connect to GitHub Enterprise Cloud (SaaS).

gitHubConfiguration_type :: Lens' GitHubConfiguration (Maybe Type) Source #

The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).

gitHubConfiguration_useChangeLog :: Lens' GitHubConfiguration (Maybe Bool) 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.

gitHubConfiguration_vpcConfiguration :: Lens' GitHubConfiguration (Maybe DataSourceVpcConfiguration) Source #

Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC.

gitHubConfiguration_secretArn :: Lens' GitHubConfiguration Text Source #

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.

GitHubDocumentCrawlProperties

gitHubDocumentCrawlProperties_crawlIssue :: Lens' GitHubDocumentCrawlProperties (Maybe Bool) Source #

TRUE to index all issues within a repository.

gitHubDocumentCrawlProperties_crawlIssueComment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool) Source #

TRUE to index all comments on issues.

gitHubDocumentCrawlProperties_crawlIssueCommentAttachment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool) Source #

TRUE to include all comment attachments for issues.

gitHubDocumentCrawlProperties_crawlPullRequest :: Lens' GitHubDocumentCrawlProperties (Maybe Bool) Source #

TRUE to index all pull requests within a repository.

gitHubDocumentCrawlProperties_crawlPullRequestComment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool) Source #

TRUE to index all comments on pull requests.

gitHubDocumentCrawlProperties_crawlPullRequestCommentAttachment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool) Source #

TRUE to include all comment attachments for pull requests.

gitHubDocumentCrawlProperties_crawlRepositoryDocuments :: Lens' GitHubDocumentCrawlProperties (Maybe Bool) Source #

TRUE to index all files with a repository.

GoogleDriveConfiguration

googleDriveConfiguration_excludeMimeTypes :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

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.

googleDriveConfiguration_excludeSharedDrives :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

googleDriveConfiguration_excludeUserAccounts :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

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.

googleDriveConfiguration_exclusionPatterns :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

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.

googleDriveConfiguration_fieldMappings :: Lens' GoogleDriveConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

googleDriveConfiguration_inclusionPatterns :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

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.

googleDriveConfiguration_secretArn :: Lens' GoogleDriveConfiguration Text Source #

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.

GroupMembers

groupMembers_memberGroups :: Lens' GroupMembers (Maybe (NonEmpty MemberGroup)) Source #

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

groupMembers_memberUsers :: Lens' GroupMembers (Maybe (NonEmpty MemberUser)) Source #

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

groupMembers_s3PathforGroupMembers :: Lens' GroupMembers (Maybe S3Path) Source #

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.

GroupOrderingIdSummary

groupOrderingIdSummary_failureReason :: Lens' GroupOrderingIdSummary (Maybe Text) Source #

The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.

groupOrderingIdSummary_lastUpdatedAt :: Lens' GroupOrderingIdSummary (Maybe UTCTime) Source #

The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.

groupOrderingIdSummary_orderingId :: Lens' GroupOrderingIdSummary (Maybe Natural) Source #

The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.

groupOrderingIdSummary_receivedAt :: Lens' GroupOrderingIdSummary (Maybe UTCTime) Source #

The date-time an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

groupOrderingIdSummary_status :: Lens' GroupOrderingIdSummary (Maybe PrincipalMappingStatus) Source #

The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

GroupSummary

groupSummary_groupId :: Lens' GroupSummary (Maybe Text) Source #

The identifier of the group you want group summary information on.

groupSummary_orderingId :: Lens' GroupSummary (Maybe Natural) Source #

The timestamp identifier used for the latest PUT or DELETE action.

HierarchicalPrincipal

hierarchicalPrincipal_principalList :: Lens' HierarchicalPrincipal [Principal] Source #

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.

Highlight

highlight_topAnswer :: Lens' Highlight (Maybe Bool) Source #

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

highlight_type :: Lens' Highlight (Maybe HighlightType) Source #

The highlight type.

highlight_beginOffset :: Lens' Highlight Int Source #

The zero-based location in the response string where the highlight starts.

highlight_endOffset :: Lens' Highlight Int Source #

The zero-based location in the response string where the highlight ends.

HookConfiguration

hookConfiguration_invocationCondition :: Lens' HookConfiguration (Maybe DocumentAttributeCondition) Source #

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.

hookConfiguration_lambdaArn :: Lens' HookConfiguration Text Source #

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Amazon Kendra.

hookConfiguration_s3Bucket :: Lens' HookConfiguration Text Source #

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

IndexConfigurationSummary

indexConfigurationSummary_edition :: Lens' IndexConfigurationSummary (Maybe IndexEdition) Source #

Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

indexConfigurationSummary_id :: Lens' IndexConfigurationSummary (Maybe Text) Source #

A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

indexConfigurationSummary_name :: Lens' IndexConfigurationSummary (Maybe Text) Source #

The name of the index.

indexConfigurationSummary_createdAt :: Lens' IndexConfigurationSummary UTCTime Source #

The Unix timestamp when the index was created.

indexConfigurationSummary_updatedAt :: Lens' IndexConfigurationSummary UTCTime Source #

The Unix timestamp when the index was last updated by the UpdateIndex API.

indexConfigurationSummary_status :: Lens' IndexConfigurationSummary IndexStatus Source #

The current status of the index. When the status is ACTIVE, the index is ready to search.

IndexStatistics

indexStatistics_faqStatistics :: Lens' IndexStatistics FaqStatistics Source #

The number of question and answer topics in the index.

indexStatistics_textDocumentStatistics :: Lens' IndexStatistics TextDocumentStatistics Source #

The number of text documents indexed.

InlineCustomDocumentEnrichmentConfiguration

inlineCustomDocumentEnrichmentConfiguration_condition :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe DocumentAttributeCondition) Source #

Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.

inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe Bool) Source #

TRUE to delete content if the condition used for the target attribute is met.

inlineCustomDocumentEnrichmentConfiguration_target :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe DocumentAttributeTarget) Source #

Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.

JiraConfiguration

jiraConfiguration_attachmentFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_commentFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_exclusionPatterns :: Lens' JiraConfiguration (Maybe [Text]) Source #

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.

jiraConfiguration_inclusionPatterns :: Lens' JiraConfiguration (Maybe [Text]) Source #

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.

jiraConfiguration_issueFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_issueSubEntityFilter :: Lens' JiraConfiguration (Maybe [IssueSubEntity]) Source #

Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

jiraConfiguration_issueType :: Lens' JiraConfiguration (Maybe [Text]) Source #

Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

jiraConfiguration_project :: Lens' JiraConfiguration (Maybe [Text]) Source #

Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

jiraConfiguration_projectFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_status :: Lens' JiraConfiguration (Maybe [Text]) Source #

Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

jiraConfiguration_useChangeLog :: Lens' JiraConfiguration (Maybe Bool) 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.

jiraConfiguration_vpcConfiguration :: Lens' JiraConfiguration (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.

jiraConfiguration_workLogFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_jiraAccountUrl :: Lens' JiraConfiguration Text Source #

The URL of the Jira account. For example, company.atlassian.net or https://jira.company.com. You can find your Jira account URL in the URL of your profile page for Jira desktop.

jiraConfiguration_secretArn :: Lens' JiraConfiguration Text Source #

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 username.
jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Using a Jira data source.

JsonTokenTypeConfiguration

jsonTokenTypeConfiguration_userNameAttributeField :: Lens' JsonTokenTypeConfiguration Text Source #

The user name attribute field.

jsonTokenTypeConfiguration_groupAttributeField :: Lens' JsonTokenTypeConfiguration Text Source #

The group attribute field.

JwtTokenTypeConfiguration

jwtTokenTypeConfiguration_claimRegex :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The regular expression that identifies the claim.

jwtTokenTypeConfiguration_groupAttributeField :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The group attribute field.

jwtTokenTypeConfiguration_issuer :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The issuer of the token.

jwtTokenTypeConfiguration_secretManagerArn :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The Amazon Resource Name (arn) of the secret.

jwtTokenTypeConfiguration_url :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The signing key URL.

jwtTokenTypeConfiguration_userNameAttributeField :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The user name attribute field.

jwtTokenTypeConfiguration_keyLocation :: Lens' JwtTokenTypeConfiguration KeyLocation Source #

The location of the key.

MemberGroup

memberGroup_dataSourceId :: Lens' MemberGroup (Maybe Text) Source #

The identifier of the data source for the sub group you want to map to a group.

memberGroup_groupId :: Lens' MemberGroup Text Source #

The identifier of the sub group you want to map to a group.

MemberUser

memberUser_userId :: Lens' MemberUser Text Source #

The identifier of the user you want to map to a group.

OnPremiseConfiguration

onPremiseConfiguration_hostUrl :: Lens' OnPremiseConfiguration Text Source #

The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/

onPremiseConfiguration_organizationName :: Lens' OnPremiseConfiguration Text Source #

The name of the organization of the GitHub Enterprise Server (in-premise) 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.

onPremiseConfiguration_sslCertificateS3Path :: Lens' OnPremiseConfiguration S3Path Source #

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.

OneDriveConfiguration

oneDriveConfiguration_disableLocalGroups :: Lens' OneDriveConfiguration (Maybe Bool) Source #

TRUE to disable local groups information.

oneDriveConfiguration_exclusionPatterns :: Lens' OneDriveConfiguration (Maybe [Text]) Source #

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.

oneDriveConfiguration_fieldMappings :: Lens' OneDriveConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

oneDriveConfiguration_inclusionPatterns :: Lens' OneDriveConfiguration (Maybe [Text]) Source #

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.

oneDriveConfiguration_tenantDomain :: Lens' OneDriveConfiguration Text Source #

The Azure Active Directory domain of the organization.

oneDriveConfiguration_secretArn :: Lens' OneDriveConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

oneDriveConfiguration_oneDriveUsers :: Lens' OneDriveConfiguration OneDriveUsers Source #

A list of user accounts whose documents should be indexed.

OneDriveUsers

oneDriveUsers_oneDriveUserList :: Lens' OneDriveUsers (Maybe (NonEmpty Text)) Source #

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 100 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.

oneDriveUsers_oneDriveUserS3Path :: Lens' OneDriveUsers (Maybe S3Path) Source #

The S3 bucket location of a file containing a list of users whose documents should be indexed.

PersonasSummary

personasSummary_createdAt :: Lens' PersonasSummary (Maybe UTCTime) Source #

The date-time the summary information was created.

personasSummary_entityId :: Lens' PersonasSummary (Maybe Text) Source #

The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

personasSummary_persona :: Lens' PersonasSummary (Maybe Persona) Source #

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.

personasSummary_updatedAt :: Lens' PersonasSummary (Maybe UTCTime) Source #

The date-time the summary information was last updated.

Principal

principal_dataSourceId :: Lens' Principal (Maybe Text) Source #

The identifier of the data source the principal should access documents from.

principal_name :: Lens' Principal Text Source #

The name of the user or group.

principal_type :: Lens' Principal PrincipalType Source #

The type of principal.

principal_access :: Lens' Principal ReadAccessType Source #

Whether to allow or deny document access to the principal.

ProxyConfiguration

proxyConfiguration_credentials :: Lens' ProxyConfiguration (Maybe Text) Source #

Your secret ARN, which you can create 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.

proxyConfiguration_host :: Lens' ProxyConfiguration Text Source #

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".

proxyConfiguration_port :: Lens' ProxyConfiguration Natural Source #

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.

QueryResultItem

queryResultItem_additionalAttributes :: Lens' QueryResultItem (Maybe [AdditionalResultAttribute]) Source #

One or more additional attributes associated with the query result.

queryResultItem_documentAttributes :: Lens' QueryResultItem (Maybe [DocumentAttribute]) Source #

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.

queryResultItem_documentExcerpt :: Lens' QueryResultItem (Maybe TextWithHighlights) Source #

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

queryResultItem_documentId :: Lens' QueryResultItem (Maybe Text) Source #

The identifier for the document.

queryResultItem_documentTitle :: Lens' QueryResultItem (Maybe TextWithHighlights) Source #

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

queryResultItem_documentURI :: Lens' QueryResultItem (Maybe Text) Source #

The URI of the original location of the document.

queryResultItem_feedbackToken :: Lens' QueryResultItem (Maybe Text) Source #

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 .

queryResultItem_format :: Lens' QueryResultItem (Maybe QueryResultFormat) Source #

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.

queryResultItem_id :: Lens' QueryResultItem (Maybe Text) Source #

The identifier for the query result.

queryResultItem_scoreAttributes :: Lens' QueryResultItem (Maybe ScoreAttributes) Source #

Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. 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 matches the query.

queryResultItem_tableExcerpt :: Lens' QueryResultItem (Maybe TableExcerpt) Source #

An excerpt from a table within a document.

queryResultItem_type :: Lens' QueryResultItem (Maybe QueryResultType) Source #

The type of document within the response. For example, a response could include a question-answer that's relevant to the query.

QuerySuggestionsBlockListSummary

querySuggestionsBlockListSummary_createdAt :: Lens' QuerySuggestionsBlockListSummary (Maybe UTCTime) Source #

The date-time summary information for a query suggestions block list was last created.

querySuggestionsBlockListSummary_id :: Lens' QuerySuggestionsBlockListSummary (Maybe Text) Source #

The identifier of a block list.

querySuggestionsBlockListSummary_itemCount :: Lens' QuerySuggestionsBlockListSummary (Maybe Int) Source #

The number of items in the block list file.

querySuggestionsBlockListSummary_name :: Lens' QuerySuggestionsBlockListSummary (Maybe Text) Source #

The name of the block list.

querySuggestionsBlockListSummary_status :: Lens' QuerySuggestionsBlockListSummary (Maybe QuerySuggestionsBlockListStatus) Source #

The status of the block list.

querySuggestionsBlockListSummary_updatedAt :: Lens' QuerySuggestionsBlockListSummary (Maybe UTCTime) Source #

The date-time the block list was last updated.

QuipConfiguration

quipConfiguration_attachmentFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

quipConfiguration_crawlAttachments :: Lens' QuipConfiguration (Maybe Bool) Source #

TRUE to index attachments.

quipConfiguration_crawlChatRooms :: Lens' QuipConfiguration (Maybe Bool) Source #

TRUE to index the contents of chat rooms.

quipConfiguration_crawlFileComments :: Lens' QuipConfiguration (Maybe Bool) Source #

TRUE to index file comments.

quipConfiguration_exclusionPatterns :: Lens' QuipConfiguration (Maybe [Text]) Source #

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.

quipConfiguration_folderIds :: Lens' QuipConfiguration (Maybe [Text]) Source #

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".

quipConfiguration_inclusionPatterns :: Lens' QuipConfiguration (Maybe [Text]) Source #

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.

quipConfiguration_messageFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

quipConfiguration_threadFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

quipConfiguration_vpcConfiguration :: Lens' QuipConfiguration (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

quipConfiguration_domain :: Lens' QuipConfiguration Text Source #

The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".

quipConfiguration_secretArn :: Lens' QuipConfiguration Text Source #

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.

Relevance

relevance_duration :: Lens' Relevance (Maybe Text) Source #

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.

relevance_freshness :: Lens' Relevance (Maybe Bool) Source #

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. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

relevance_importance :: Lens' Relevance (Maybe Natural) Source #

The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

relevance_rankOrder :: Lens' Relevance (Maybe Order) Source #

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 and DOUBLE fields.

relevance_valueImportanceMap :: Lens' Relevance (Maybe (HashMap Text Natural)) Source #

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.

RelevanceFeedback

relevanceFeedback_resultId :: Lens' RelevanceFeedback Text Source #

The identifier of the search result that the user provided relevance feedback for.

relevanceFeedback_relevanceValue :: Lens' RelevanceFeedback RelevanceType Source #

Whether to document was relevant or not relevant to the search.

S3DataSourceConfiguration

s3DataSourceConfiguration_accessControlListConfiguration :: Lens' S3DataSourceConfiguration (Maybe AccessControlListConfiguration) Source #

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.

s3DataSourceConfiguration_documentsMetadataConfiguration :: Lens' S3DataSourceConfiguration (Maybe DocumentsMetadataConfiguration) Source #

Undocumented member.

s3DataSourceConfiguration_exclusionPatterns :: Lens' S3DataSourceConfiguration (Maybe [Text]) Source #

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples are:

*.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/*internal* will exclude all internal-related files in a directory and its subdirectories.

s3DataSourceConfiguration_inclusionPatterns :: Lens' S3DataSourceConfiguration (Maybe [Text]) Source #

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples are:

*.txt will include all text files in a directory (files with the extension .txt).
**/*.txt will include all text files in a directory and its subdirectories.
*tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

s3DataSourceConfiguration_inclusionPrefixes :: Lens' S3DataSourceConfiguration (Maybe [Text]) Source #

A list of S3 prefixes for the documents that should be included in the index.

s3DataSourceConfiguration_bucketName :: Lens' S3DataSourceConfiguration Text Source #

The name of the bucket that contains the documents.

S3Path

s3Path_bucket :: Lens' S3Path Text Source #

The name of the S3 bucket that contains the file.

s3Path_key :: Lens' S3Path Text Source #

The name of the file.

SaaSConfiguration

saaSConfiguration_organizationName :: Lens' SaaSConfiguration Text Source #

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.

saaSConfiguration_hostUrl :: Lens' SaaSConfiguration Text Source #

The GitHub host URL or API endpoint URL. For example, https://api.github.com.

SalesforceChatterFeedConfiguration

salesforceChatterFeedConfiguration_documentTitleFieldName :: Lens' SalesforceChatterFeedConfiguration (Maybe Text) Source #

The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.

salesforceChatterFeedConfiguration_fieldMappings :: Lens' SalesforceChatterFeedConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

salesforceChatterFeedConfiguration_includeFilterTypes :: Lens' SalesforceChatterFeedConfiguration (Maybe (NonEmpty SalesforceChatterFeedIncludeFilterType)) Source #

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.

salesforceChatterFeedConfiguration_documentDataFieldName :: Lens' SalesforceChatterFeedConfiguration Text Source #

The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

SalesforceConfiguration

salesforceConfiguration_chatterFeedConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceChatterFeedConfiguration) Source #

Configuration information for Salesforce chatter feeds.

salesforceConfiguration_crawlAttachments :: Lens' SalesforceConfiguration (Maybe Bool) Source #

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

salesforceConfiguration_excludeAttachmentFilePatterns :: Lens' SalesforceConfiguration (Maybe [Text]) Source #

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.

salesforceConfiguration_includeAttachmentFilePatterns :: Lens' SalesforceConfiguration (Maybe [Text]) Source #

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.

salesforceConfiguration_knowledgeArticleConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceKnowledgeArticleConfiguration) Source #

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.

salesforceConfiguration_standardObjectAttachmentConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceStandardObjectAttachmentConfiguration) Source #

Configuration information for processing attachments to Salesforce standard objects.

salesforceConfiguration_standardObjectConfigurations :: Lens' SalesforceConfiguration (Maybe (NonEmpty SalesforceStandardObjectConfiguration)) Source #

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

salesforceConfiguration_serverUrl :: Lens' SalesforceConfiguration Text Source #

The instance URL for the Salesforce site that you want to index.

salesforceConfiguration_secretArn :: Lens' SalesforceConfiguration Text Source #

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 account logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

SalesforceCustomKnowledgeArticleTypeConfiguration

salesforceCustomKnowledgeArticleTypeConfiguration_documentTitleFieldName :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration (Maybe Text) Source #

The name of the field in the custom knowledge article that contains the document title.

salesforceCustomKnowledgeArticleTypeConfiguration_fieldMappings :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

salesforceCustomKnowledgeArticleTypeConfiguration_name :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration Text Source #

The name of the configuration.

salesforceCustomKnowledgeArticleTypeConfiguration_documentDataFieldName :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration Text Source #

The name of the field in the custom knowledge article that contains the document data to index.

SalesforceKnowledgeArticleConfiguration

salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations :: Lens' SalesforceKnowledgeArticleConfiguration (Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)) Source #

Configuration information for custom Salesforce knowledge articles.

salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration :: Lens' SalesforceKnowledgeArticleConfiguration (Maybe SalesforceStandardKnowledgeArticleTypeConfiguration) Source #

Configuration information for standard Salesforce knowledge articles.

salesforceKnowledgeArticleConfiguration_includedStates :: Lens' SalesforceKnowledgeArticleConfiguration (NonEmpty SalesforceKnowledgeArticleState) Source #

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

SalesforceStandardKnowledgeArticleTypeConfiguration

salesforceStandardKnowledgeArticleTypeConfiguration_documentTitleFieldName :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration (Maybe Text) Source #

The name of the field that contains the document title.

salesforceStandardKnowledgeArticleTypeConfiguration_fieldMappings :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

salesforceStandardKnowledgeArticleTypeConfiguration_documentDataFieldName :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration Text Source #

The name of the field that contains the document data to index.

SalesforceStandardObjectAttachmentConfiguration

salesforceStandardObjectAttachmentConfiguration_documentTitleFieldName :: Lens' SalesforceStandardObjectAttachmentConfiguration (Maybe Text) Source #

The name of the field used for the document title.

salesforceStandardObjectAttachmentConfiguration_fieldMappings :: Lens' SalesforceStandardObjectAttachmentConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

One or more objects that map fields in attachments to Amazon Kendra index fields.

SalesforceStandardObjectConfiguration

salesforceStandardObjectConfiguration_documentTitleFieldName :: Lens' SalesforceStandardObjectConfiguration (Maybe Text) Source #

The name of the field in the standard object table that contains the document title.

salesforceStandardObjectConfiguration_fieldMappings :: Lens' SalesforceStandardObjectConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

salesforceStandardObjectConfiguration_name :: Lens' SalesforceStandardObjectConfiguration SalesforceStandardObjectName Source #

The name of the standard object.

salesforceStandardObjectConfiguration_documentDataFieldName :: Lens' SalesforceStandardObjectConfiguration Text Source #

The name of the field in the standard object table that contains the document contents.

ScoreAttributes

scoreAttributes_scoreConfidence :: Lens' ScoreAttributes (Maybe ScoreConfidence) Source #

A relative ranking for how well the response matches the query.

Search

search_displayable :: Lens' Search (Maybe Bool) Source #

Determines whether the field is returned in the query response. The default is true.

search_facetable :: Lens' Search (Maybe Bool) Source #

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 .

search_searchable :: Lens' Search (Maybe Bool) Source #

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.

search_sortable :: Lens' Search (Maybe Bool) Source #

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.

SeedUrlConfiguration

seedUrlConfiguration_webCrawlerMode :: Lens' SeedUrlConfiguration (Maybe WebCrawlerMode) Source #

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 webpages link to.

The default mode is set to HOST_ONLY.

seedUrlConfiguration_seedUrls :: Lens' SeedUrlConfiguration [Text] Source #

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.

ServerSideEncryptionConfiguration

serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration (Maybe Text) Source #

The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.

ServiceNowConfiguration

serviceNowConfiguration_authenticationType :: Lens' ServiceNowConfiguration (Maybe ServiceNowAuthenticationType) Source #

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.

serviceNowConfiguration_knowledgeArticleConfiguration :: Lens' ServiceNowConfiguration (Maybe ServiceNowKnowledgeArticleConfiguration) Source #

Configuration information for crawling knowledge articles in the ServiceNow site.

serviceNowConfiguration_serviceCatalogConfiguration :: Lens' ServiceNowConfiguration (Maybe ServiceNowServiceCatalogConfiguration) Source #

Configuration information for crawling service catalogs in the ServiceNow site.

serviceNowConfiguration_hostUrl :: Lens' ServiceNowConfiguration Text Source #

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

serviceNowConfiguration_secretArn :: Lens' ServiceNowConfiguration Text Source #

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.

serviceNowConfiguration_serviceNowBuildVersion :: Lens' ServiceNowConfiguration ServiceNowBuildVersionType Source #

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

ServiceNowKnowledgeArticleConfiguration

serviceNowKnowledgeArticleConfiguration_crawlAttachments :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Bool) Source #

TRUE to index attachments to knowledge articles.

serviceNowKnowledgeArticleConfiguration_documentTitleFieldName :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Text) Source #

The name of the ServiceNow field that is mapped to the index document title field.

serviceNowKnowledgeArticleConfiguration_excludeAttachmentFilePatterns :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain attachments of knowledge articles 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 field specified in the PatternTargetField.

serviceNowKnowledgeArticleConfiguration_fieldMappings :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

serviceNowKnowledgeArticleConfiguration_filterQuery :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Text) Source #

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.

serviceNowKnowledgeArticleConfiguration_includeAttachmentFilePatterns :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain attachments of knowledge articles 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 field specified in the PatternTargetField.

serviceNowKnowledgeArticleConfiguration_documentDataFieldName :: Lens' ServiceNowKnowledgeArticleConfiguration Text Source #

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

ServiceNowServiceCatalogConfiguration

serviceNowServiceCatalogConfiguration_crawlAttachments :: Lens' ServiceNowServiceCatalogConfiguration (Maybe Bool) Source #

TRUE to index attachments to service catalog items.

serviceNowServiceCatalogConfiguration_documentTitleFieldName :: Lens' ServiceNowServiceCatalogConfiguration (Maybe Text) Source #

The name of the ServiceNow field that is mapped to the index document title field.

serviceNowServiceCatalogConfiguration_excludeAttachmentFilePatterns :: Lens' ServiceNowServiceCatalogConfiguration (Maybe [Text]) Source #

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.

serviceNowServiceCatalogConfiguration_fieldMappings :: Lens' ServiceNowServiceCatalogConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

serviceNowServiceCatalogConfiguration_includeAttachmentFilePatterns :: Lens' ServiceNowServiceCatalogConfiguration (Maybe [Text]) Source #

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.

serviceNowServiceCatalogConfiguration_documentDataFieldName :: Lens' ServiceNowServiceCatalogConfiguration Text Source #

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

SharePointConfiguration

sharePointConfiguration_authenticationType :: Lens' SharePointConfiguration (Maybe SharePointOnlineAuthenticationType) Source #

Whether you want to connect to SharePoint using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret. You can use OAuth authentication for SharePoint Online.

sharePointConfiguration_crawlAttachments :: Lens' SharePointConfiguration (Maybe Bool) Source #

TRUE to index document attachments.

sharePointConfiguration_disableLocalGroups :: Lens' SharePointConfiguration (Maybe Bool) Source #

TRUE to disable local groups information.

sharePointConfiguration_documentTitleFieldName :: Lens' SharePointConfiguration (Maybe Text) Source #

The Microsoft SharePoint attribute field that contains the title of the document.

sharePointConfiguration_exclusionPatterns :: Lens' SharePointConfiguration (Maybe [Text]) Source #

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.

sharePointConfiguration_fieldMappings :: Lens' SharePointConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

sharePointConfiguration_inclusionPatterns :: Lens' SharePointConfiguration (Maybe [Text]) Source #

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.

sharePointConfiguration_proxyConfiguration :: Lens' SharePointConfiguration (Maybe ProxyConfiguration) Source #

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.

sharePointConfiguration_sslCertificateS3Path :: Lens' SharePointConfiguration (Maybe S3Path) Source #

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

sharePointConfiguration_useChangeLog :: Lens' SharePointConfiguration (Maybe Bool) Source #

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.

sharePointConfiguration_vpcConfiguration :: Lens' SharePointConfiguration (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

sharePointConfiguration_sharePointVersion :: Lens' SharePointConfiguration SharePointVersion Source #

The version of Microsoft SharePoint that you use.

sharePointConfiguration_urls :: Lens' SharePointConfiguration (NonEmpty Text) Source #

The Microsoft SharePoint site URLs for the documents you want to index.

sharePointConfiguration_secretArn :: Lens' SharePointConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source.

You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a SharePoint data source.

SiteMapsConfiguration

siteMapsConfiguration_siteMaps :: Lens' SiteMapsConfiguration [Text] Source #

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

SlackConfiguration

slackConfiguration_crawlBotMessage :: Lens' SlackConfiguration (Maybe Bool) Source #

TRUE to index bot messages from your Slack workspace team.

slackConfiguration_excludeArchived :: Lens' SlackConfiguration (Maybe Bool) Source #

TRUE to exclude archived messages to index from your Slack workspace team.

slackConfiguration_exclusionPatterns :: Lens' SlackConfiguration (Maybe [Text]) Source #

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.

slackConfiguration_fieldMappings :: Lens' SlackConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

slackConfiguration_inclusionPatterns :: Lens' SlackConfiguration (Maybe [Text]) Source #

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.

slackConfiguration_lookBackPeriod :: Lens' SlackConfiguration (Maybe Natural) Source #

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.

slackConfiguration_privateChannelFilter :: Lens' SlackConfiguration (Maybe [Text]) Source #

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.

slackConfiguration_publicChannelFilter :: Lens' SlackConfiguration (Maybe [Text]) Source #

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.

slackConfiguration_useChangeLog :: Lens' SlackConfiguration (Maybe Bool) Source #

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.

slackConfiguration_vpcConfiguration :: Lens' SlackConfiguration (Maybe DataSourceVpcConfiguration) Source #

Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.

slackConfiguration_teamId :: Lens' SlackConfiguration Text Source #

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/....

slackConfiguration_secretArn :: Lens' SlackConfiguration Text Source #

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.

slackConfiguration_slackEntityList :: Lens' SlackConfiguration (NonEmpty SlackEntity) Source #

Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

slackConfiguration_sinceCrawlDate :: Lens' SlackConfiguration Text Source #

The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.

SortingConfiguration

sortingConfiguration_documentAttributeKey :: Lens' SortingConfiguration Text Source #

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

sortingConfiguration_sortOrder :: Lens' SortingConfiguration SortOrder Source #

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.

SpellCorrectedQuery

spellCorrectedQuery_corrections :: Lens' SpellCorrectedQuery (Maybe [Correction]) Source #

The corrected misspelled word or words in a query.

spellCorrectedQuery_suggestedQueryText :: Lens' SpellCorrectedQuery (Maybe Text) Source #

The query with the suggested spell corrections.

SpellCorrectionConfiguration

spellCorrectionConfiguration_includeQuerySpellCheckSuggestions :: Lens' SpellCorrectionConfiguration Bool Source #

TRUE to suggest spell corrections for queries.

SqlConfiguration

sqlConfiguration_queryIdentifiersEnclosingOption :: Lens' SqlConfiguration (Maybe QueryIdentifiersEnclosingOption) Source #

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.

Status

status_documentId :: Lens' Status (Maybe Text) Source #

The identifier of the document.

status_documentStatus :: Lens' Status (Maybe DocumentStatus) Source #

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

status_failureCode :: Lens' Status (Maybe Text) Source #

Indicates the source of the error.

status_failureReason :: Lens' Status (Maybe Text) Source #

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.

Suggestion

suggestion_id :: Lens' Suggestion (Maybe Text) Source #

The UUID (universally unique identifier) of a single query suggestion.

suggestion_value :: Lens' Suggestion (Maybe SuggestionValue) Source #

The value for the UUID (universally unique identifier) of a single query suggestion.

The value is the text string of a suggestion.

SuggestionHighlight

suggestionHighlight_beginOffset :: Lens' SuggestionHighlight (Maybe Int) Source #

The zero-based location in the response string where the highlight starts.

suggestionHighlight_endOffset :: Lens' SuggestionHighlight (Maybe Int) Source #

The zero-based location in the response string where the highlight ends.

SuggestionTextWithHighlights

suggestionTextWithHighlights_highlights :: Lens' SuggestionTextWithHighlights (Maybe [SuggestionHighlight]) Source #

The beginning and end of the query suggestion text that should be highlighted.

suggestionTextWithHighlights_text :: Lens' SuggestionTextWithHighlights (Maybe Text) Source #

The query suggestion text to display to the user.

SuggestionValue

suggestionValue_text :: Lens' SuggestionValue (Maybe SuggestionTextWithHighlights) Source #

The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.

TableCell

tableCell_header :: Lens' TableCell (Maybe Bool) Source #

TRUE means that the table cell should be treated as a header.

tableCell_highlighted :: Lens' TableCell (Maybe Bool) Source #

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.

tableCell_topAnswer :: Lens' TableCell (Maybe Bool) Source #

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.

tableCell_value :: Lens' TableCell (Maybe Text) Source #

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.

TableExcerpt

tableExcerpt_rows :: Lens' TableExcerpt (Maybe [TableRow]) Source #

A list of rows in the table excerpt.

tableExcerpt_totalNumberOfRows :: Lens' TableExcerpt (Maybe Int) Source #

A count of the number of rows in the original table within the document.

TableRow

tableRow_cells :: Lens' TableRow (Maybe [TableCell]) Source #

A list of table cells in a row.

Tag

tag_key :: Lens' Tag Text Source #

The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

tag_value :: Lens' Tag Text Source #

The value associated with the tag. The value may be an empty string but it can't be null.

Template

TemplateConfiguration

templateConfiguration_template :: Lens' TemplateConfiguration (Maybe Template) Source #

The template schema used for the data source, where templates schemas are supported.

See Data source template schemas.

TextDocumentStatistics

textDocumentStatistics_indexedTextDocumentsCount :: Lens' TextDocumentStatistics Natural Source #

The number of text documents indexed.

textDocumentStatistics_indexedTextBytes :: Lens' TextDocumentStatistics Natural Source #

The total size, in bytes, of the indexed documents.

TextWithHighlights

textWithHighlights_highlights :: Lens' TextWithHighlights (Maybe [Highlight]) Source #

The beginning and end of the text that should be highlighted.

textWithHighlights_text :: Lens' TextWithHighlights (Maybe Text) Source #

The text to display to the user.

ThesaurusSummary

thesaurusSummary_createdAt :: Lens' ThesaurusSummary (Maybe UTCTime) Source #

The Unix datetime that the thesaurus was created.

thesaurusSummary_id :: Lens' ThesaurusSummary (Maybe Text) Source #

The identifier of the thesaurus.

thesaurusSummary_name :: Lens' ThesaurusSummary (Maybe Text) Source #

The name of the thesaurus.

thesaurusSummary_status :: Lens' ThesaurusSummary (Maybe ThesaurusStatus) Source #

The status of the thesaurus.

thesaurusSummary_updatedAt :: Lens' ThesaurusSummary (Maybe UTCTime) Source #

The Unix datetime that the thesaurus was last updated.

TimeRange

timeRange_endTime :: Lens' TimeRange (Maybe UTCTime) Source #

The UNIX datetime of the end of the time range.

timeRange_startTime :: Lens' TimeRange (Maybe UTCTime) Source #

The UNIX datetime of the beginning of the time range.

Urls

urls_seedUrlConfiguration :: Lens' Urls (Maybe SeedUrlConfiguration) Source #

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 webpages link to.

You can list up to 100 seed URLs.

urls_siteMapsConfiguration :: Lens' Urls (Maybe SiteMapsConfiguration) Source #

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.

UserContext

userContext_dataSourceGroups :: Lens' UserContext (Maybe (NonEmpty DataSourceGroup)) Source #

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

userContext_groups :: Lens' UserContext (Maybe (NonEmpty Text)) Source #

The list of groups you want to filter search results based on the groups' access to documents.

userContext_token :: Lens' UserContext (Maybe Text) Source #

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

userContext_userId :: Lens' UserContext (Maybe Text) Source #

The identifier of the user you want to filter search results based on their access to documents.

UserGroupResolutionConfiguration

userGroupResolutionConfiguration_userGroupResolutionMode :: Lens' UserGroupResolutionConfiguration UserGroupResolutionMode Source #

The identity store provider (mode) you want to use to fetch access levels of groups and users. IAM Identity Center (successor to Single Sign-On) 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.

UserIdentityConfiguration

userIdentityConfiguration_identityAttributeName :: Lens' UserIdentityConfiguration (Maybe Text) Source #

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.

UserTokenConfiguration

userTokenConfiguration_jsonTokenTypeConfiguration :: Lens' UserTokenConfiguration (Maybe JsonTokenTypeConfiguration) Source #

Information about the JSON token type configuration.

userTokenConfiguration_jwtTokenTypeConfiguration :: Lens' UserTokenConfiguration (Maybe JwtTokenTypeConfiguration) Source #

Information about the JWT token type configuration.

Warning

warning_code :: Lens' Warning (Maybe WarningCode) Source #

The code used to show the type of warning for the query.

warning_message :: Lens' Warning (Maybe Text) Source #

The message that explains the problem with the query.

WebCrawlerConfiguration

webCrawlerConfiguration_authenticationConfiguration :: Lens' WebCrawlerConfiguration (Maybe AuthenticationConfiguration) Source #

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.

webCrawlerConfiguration_crawlDepth :: Lens' WebCrawlerConfiguration (Maybe Natural) Source #

Specifies the number of levels in a website that you want to crawl.

The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

The default crawl depth is set to 2.

webCrawlerConfiguration_maxContentSizePerPageInMegaBytes :: Lens' WebCrawlerConfiguration (Maybe Double) Source #

The maximum size (in MB) of a webpage or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a webpage or attachment is set to 50 MB.

webCrawlerConfiguration_maxLinksPerPage :: Lens' WebCrawlerConfiguration (Maybe Natural) Source #

The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

The default maximum links per page is 100.

webCrawlerConfiguration_maxUrlsPerMinuteCrawlRate :: Lens' WebCrawlerConfiguration (Maybe Natural) Source #

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.

webCrawlerConfiguration_proxyConfiguration :: Lens' WebCrawlerConfiguration (Maybe ProxyConfiguration) Source #

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.

webCrawlerConfiguration_urlExclusionPatterns :: Lens' WebCrawlerConfiguration (Maybe [Text]) Source #

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.

webCrawlerConfiguration_urlInclusionPatterns :: Lens' WebCrawlerConfiguration (Maybe [Text]) Source #

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.

webCrawlerConfiguration_urls :: Lens' WebCrawlerConfiguration Urls Source #

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 webpages, or webpages that you have authorization to index./

WorkDocsConfiguration

workDocsConfiguration_crawlComments :: Lens' WorkDocsConfiguration (Maybe Bool) Source #

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.

workDocsConfiguration_exclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text]) Source #

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.

workDocsConfiguration_fieldMappings :: Lens' WorkDocsConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

workDocsConfiguration_inclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text]) Source #

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.

workDocsConfiguration_useChangeLog :: Lens' WorkDocsConfiguration (Maybe Bool) Source #

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.

workDocsConfiguration_organizationId :: Lens' WorkDocsConfiguration Text Source #

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.