amazonka-kendra-2.0: Amazon KendraFrontendService SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kendra

Contents

Description

Derived from API version 2019-02-03 of the AWS service descriptions, licensed under Apache 2.0.

Amazon Kendra is a service for indexing large document sets.

Synopsis

Service Configuration

defaultService :: Service Source #

API version 2019-02-03 of the Amazon KendraFrontendService SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Kendra.

AccessDeniedException

_AccessDeniedException :: AsError a => Fold a ServiceError Source #

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

ConflictException

_ConflictException :: AsError a => Fold a ServiceError Source #

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

InternalServerException

_InternalServerException :: AsError a => Fold a ServiceError Source #

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

InvalidRequestException

_InvalidRequestException :: AsError a => Fold a ServiceError Source #

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

ResourceAlreadyExistException

_ResourceAlreadyExistException :: AsError a => Fold a ServiceError Source #

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

ResourceInUseException

_ResourceInUseException :: AsError a => Fold a ServiceError Source #

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

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

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

ResourceUnavailableException

_ResourceUnavailableException :: AsError a => Fold a ServiceError Source #

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

ServiceQuotaExceededException

_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #

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

ThrottlingException

_ThrottlingException :: AsError a => Fold a ServiceError Source #

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

ValidationException

_ValidationException :: AsError a => Fold a ServiceError Source #

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

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

AssociateEntitiesToExperience

data AssociateEntitiesToExperience Source #

See: newAssociateEntitiesToExperience smart constructor.

Instances

Instances details
ToJSON AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

ToHeaders AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

ToPath AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

ToQuery AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

AWSRequest AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

Generic AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

Associated Types

type Rep AssociateEntitiesToExperience :: Type -> Type #

Read AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

Show AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

NFData AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

Eq AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

Hashable AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

type AWSResponse AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

type Rep AssociateEntitiesToExperience Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

type Rep AssociateEntitiesToExperience = D1 ('MetaData "AssociateEntitiesToExperience" "Amazonka.Kendra.AssociateEntitiesToExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AssociateEntitiesToExperience'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty EntityConfiguration)))))

newAssociateEntitiesToExperience Source #

Create a value of AssociateEntitiesToExperience with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateEntitiesToExperience, associateEntitiesToExperience_id - The identifier of your Amazon Kendra experience.

$sel:indexId:AssociateEntitiesToExperience', associateEntitiesToExperience_indexId - The identifier of the index for your Amazon Kendra experience.

$sel:entityList:AssociateEntitiesToExperience', associateEntitiesToExperience_entityList - Lists users or groups in your IAM Identity Center identity source.

data AssociateEntitiesToExperienceResponse Source #

Instances

Instances details
Generic AssociateEntitiesToExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

Read AssociateEntitiesToExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

Show AssociateEntitiesToExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

NFData AssociateEntitiesToExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

Eq AssociateEntitiesToExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

type Rep AssociateEntitiesToExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociateEntitiesToExperience

type Rep AssociateEntitiesToExperienceResponse = D1 ('MetaData "AssociateEntitiesToExperienceResponse" "Amazonka.Kendra.AssociateEntitiesToExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AssociateEntitiesToExperienceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedEntityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty FailedEntity))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAssociateEntitiesToExperienceResponse Source #

Create a value of AssociateEntitiesToExperienceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failedEntityList:AssociateEntitiesToExperienceResponse', associateEntitiesToExperienceResponse_failedEntityList - Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

$sel:httpStatus:AssociateEntitiesToExperienceResponse', associateEntitiesToExperienceResponse_httpStatus - The response's http status code.

AssociatePersonasToEntities

data AssociatePersonasToEntities Source #

See: newAssociatePersonasToEntities smart constructor.

Instances

Instances details
ToJSON AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

ToHeaders AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

ToPath AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

ToQuery AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

AWSRequest AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

Generic AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

Associated Types

type Rep AssociatePersonasToEntities :: Type -> Type #

Read AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

Show AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

NFData AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

Eq AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

Hashable AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

type AWSResponse AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

type Rep AssociatePersonasToEntities Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

type Rep AssociatePersonasToEntities = D1 ('MetaData "AssociatePersonasToEntities" "Amazonka.Kendra.AssociatePersonasToEntities" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AssociatePersonasToEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "personas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty EntityPersonaConfiguration)))))

newAssociatePersonasToEntities Source #

Create a value of AssociatePersonasToEntities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociatePersonasToEntities, associatePersonasToEntities_id - The identifier of your Amazon Kendra experience.

$sel:indexId:AssociatePersonasToEntities', associatePersonasToEntities_indexId - The identifier of the index for your Amazon Kendra experience.

$sel:personas:AssociatePersonasToEntities', associatePersonasToEntities_personas - 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.

data AssociatePersonasToEntitiesResponse Source #

Instances

Instances details
Generic AssociatePersonasToEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

Read AssociatePersonasToEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

Show AssociatePersonasToEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

NFData AssociatePersonasToEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

Eq AssociatePersonasToEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

type Rep AssociatePersonasToEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.AssociatePersonasToEntities

type Rep AssociatePersonasToEntitiesResponse = D1 ('MetaData "AssociatePersonasToEntitiesResponse" "Amazonka.Kendra.AssociatePersonasToEntities" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AssociatePersonasToEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedEntityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty FailedEntity))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAssociatePersonasToEntitiesResponse Source #

Create a value of AssociatePersonasToEntitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failedEntityList:AssociatePersonasToEntitiesResponse', associatePersonasToEntitiesResponse_failedEntityList - Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

$sel:httpStatus:AssociatePersonasToEntitiesResponse', associatePersonasToEntitiesResponse_httpStatus - The response's http status code.

BatchDeleteDocument

data BatchDeleteDocument Source #

See: newBatchDeleteDocument smart constructor.

Instances

Instances details
ToJSON BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

ToHeaders BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

ToPath BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

ToQuery BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

AWSRequest BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

Associated Types

type AWSResponse BatchDeleteDocument #

Generic BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

Associated Types

type Rep BatchDeleteDocument :: Type -> Type #

Read BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

Show BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

NFData BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

Methods

rnf :: BatchDeleteDocument -> () #

Eq BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

Hashable BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

type AWSResponse BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

type Rep BatchDeleteDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

type Rep BatchDeleteDocument = D1 ('MetaData "BatchDeleteDocument" "Amazonka.Kendra.BatchDeleteDocument" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchDeleteDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceSyncJobMetricTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceSyncJobMetricTarget)) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentIdList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))

newBatchDeleteDocument Source #

Create a value of BatchDeleteDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceSyncJobMetricTarget:BatchDeleteDocument', batchDeleteDocument_dataSourceSyncJobMetricTarget - Undocumented member.

$sel:indexId:BatchDeleteDocument', batchDeleteDocument_indexId - The identifier of the index that contains the documents to delete.

$sel:documentIdList:BatchDeleteDocument', batchDeleteDocument_documentIdList - One or more identifiers for documents to delete from the index.

data BatchDeleteDocumentResponse Source #

See: newBatchDeleteDocumentResponse smart constructor.

Instances

Instances details
Generic BatchDeleteDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

Associated Types

type Rep BatchDeleteDocumentResponse :: Type -> Type #

Read BatchDeleteDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

Show BatchDeleteDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

NFData BatchDeleteDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

Eq BatchDeleteDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

type Rep BatchDeleteDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchDeleteDocument

type Rep BatchDeleteDocumentResponse = D1 ('MetaData "BatchDeleteDocumentResponse" "Amazonka.Kendra.BatchDeleteDocument" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchDeleteDocumentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchDeleteDocumentResponseFailedDocument])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newBatchDeleteDocumentResponse Source #

Create a value of BatchDeleteDocumentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failedDocuments:BatchDeleteDocumentResponse', batchDeleteDocumentResponse_failedDocuments - 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.

$sel:httpStatus:BatchDeleteDocumentResponse', batchDeleteDocumentResponse_httpStatus - The response's http status code.

BatchGetDocumentStatus

data BatchGetDocumentStatus Source #

See: newBatchGetDocumentStatus smart constructor.

Instances

Instances details
ToJSON BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

ToHeaders BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

ToPath BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

ToQuery BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

AWSRequest BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

Associated Types

type AWSResponse BatchGetDocumentStatus #

Generic BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

Associated Types

type Rep BatchGetDocumentStatus :: Type -> Type #

Read BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

Show BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

NFData BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

Methods

rnf :: BatchGetDocumentStatus -> () #

Eq BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

Hashable BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

type AWSResponse BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

type Rep BatchGetDocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

type Rep BatchGetDocumentStatus = D1 ('MetaData "BatchGetDocumentStatus" "Amazonka.Kendra.BatchGetDocumentStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchGetDocumentStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty DocumentInfo))))

newBatchGetDocumentStatus Source #

Create a value of BatchGetDocumentStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexId:BatchGetDocumentStatus', batchGetDocumentStatus_indexId - The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.

$sel:documentInfoList:BatchGetDocumentStatus', batchGetDocumentStatus_documentInfoList - 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.

data BatchGetDocumentStatusResponse Source #

See: newBatchGetDocumentStatusResponse smart constructor.

Instances

Instances details
Generic BatchGetDocumentStatusResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

Associated Types

type Rep BatchGetDocumentStatusResponse :: Type -> Type #

Read BatchGetDocumentStatusResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

Show BatchGetDocumentStatusResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

NFData BatchGetDocumentStatusResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

Eq BatchGetDocumentStatusResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

type Rep BatchGetDocumentStatusResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchGetDocumentStatus

type Rep BatchGetDocumentStatusResponse = D1 ('MetaData "BatchGetDocumentStatusResponse" "Amazonka.Kendra.BatchGetDocumentStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchGetDocumentStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentStatusList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Status])) :*: (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchGetDocumentStatusResponseError])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchGetDocumentStatusResponse Source #

Create a value of BatchGetDocumentStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentStatusList:BatchGetDocumentStatusResponse', batchGetDocumentStatusResponse_documentStatusList - 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.

$sel:errors:BatchGetDocumentStatusResponse', batchGetDocumentStatusResponse_errors - 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.

$sel:httpStatus:BatchGetDocumentStatusResponse', batchGetDocumentStatusResponse_httpStatus - The response's http status code.

BatchPutDocument

data BatchPutDocument Source #

See: newBatchPutDocument smart constructor.

Instances

Instances details
ToJSON BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

ToHeaders BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

ToPath BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

ToQuery BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

AWSRequest BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

Associated Types

type AWSResponse BatchPutDocument #

Generic BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

Associated Types

type Rep BatchPutDocument :: Type -> Type #

Read BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

Show BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

NFData BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

Methods

rnf :: BatchPutDocument -> () #

Eq BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

Hashable BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

type AWSResponse BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

type Rep BatchPutDocument Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

type Rep BatchPutDocument = D1 ('MetaData "BatchPutDocument" "Amazonka.Kendra.BatchPutDocument" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchPutDocument'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customDocumentEnrichmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDocumentEnrichmentConfiguration)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Document)))))

newBatchPutDocument Source #

Create a value of BatchPutDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customDocumentEnrichmentConfiguration:BatchPutDocument', batchPutDocument_customDocumentEnrichmentConfiguration - 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, batchPutDocument_roleArn - 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.

$sel:indexId:BatchPutDocument', batchPutDocument_indexId - The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.

$sel:documents:BatchPutDocument', batchPutDocument_documents - 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.

data BatchPutDocumentResponse Source #

See: newBatchPutDocumentResponse smart constructor.

Instances

Instances details
Generic BatchPutDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

Associated Types

type Rep BatchPutDocumentResponse :: Type -> Type #

Read BatchPutDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

Show BatchPutDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

NFData BatchPutDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

Eq BatchPutDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

type Rep BatchPutDocumentResponse Source # 
Instance details

Defined in Amazonka.Kendra.BatchPutDocument

type Rep BatchPutDocumentResponse = D1 ('MetaData "BatchPutDocumentResponse" "Amazonka.Kendra.BatchPutDocument" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchPutDocumentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchPutDocumentResponseFailedDocument])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newBatchPutDocumentResponse Source #

Create a value of BatchPutDocumentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failedDocuments:BatchPutDocumentResponse', batchPutDocumentResponse_failedDocuments - 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

$sel:httpStatus:BatchPutDocumentResponse', batchPutDocumentResponse_httpStatus - The response's http status code.

ClearQuerySuggestions

data ClearQuerySuggestions Source #

See: newClearQuerySuggestions smart constructor.

Instances

Instances details
ToJSON ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

ToHeaders ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

ToPath ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

ToQuery ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

AWSRequest ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

Associated Types

type AWSResponse ClearQuerySuggestions #

Generic ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

Associated Types

type Rep ClearQuerySuggestions :: Type -> Type #

Read ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

Show ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

NFData ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

Methods

rnf :: ClearQuerySuggestions -> () #

Eq ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

Hashable ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

type AWSResponse ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

type Rep ClearQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

type Rep ClearQuerySuggestions = D1 ('MetaData "ClearQuerySuggestions" "Amazonka.Kendra.ClearQuerySuggestions" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ClearQuerySuggestions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newClearQuerySuggestions Source #

Create a value of ClearQuerySuggestions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexId:ClearQuerySuggestions', clearQuerySuggestions_indexId - The identifier of the index you want to clear query suggestions from.

data ClearQuerySuggestionsResponse Source #

See: newClearQuerySuggestionsResponse smart constructor.

Instances

Instances details
Generic ClearQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

Associated Types

type Rep ClearQuerySuggestionsResponse :: Type -> Type #

Read ClearQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

Show ClearQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

NFData ClearQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

Eq ClearQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

type Rep ClearQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ClearQuerySuggestions

type Rep ClearQuerySuggestionsResponse = D1 ('MetaData "ClearQuerySuggestionsResponse" "Amazonka.Kendra.ClearQuerySuggestions" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ClearQuerySuggestionsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newClearQuerySuggestionsResponse :: ClearQuerySuggestionsResponse Source #

Create a value of ClearQuerySuggestionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

CreateAccessControlConfiguration

data CreateAccessControlConfiguration Source #

See: newCreateAccessControlConfiguration smart constructor.

Instances

Instances details
ToJSON CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

ToHeaders CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

ToPath CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

ToQuery CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

AWSRequest CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

Generic CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

Associated Types

type Rep CreateAccessControlConfiguration :: Type -> Type #

Read CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

Show CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

NFData CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

Eq CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

Hashable CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

type AWSResponse CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

type Rep CreateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

type Rep CreateAccessControlConfiguration = D1 ('MetaData "CreateAccessControlConfiguration" "Amazonka.Kendra.CreateAccessControlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateAccessControlConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Principal])) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hierarchicalAccessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HierarchicalPrincipal))) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAccessControlConfiguration Source #

Create a value of CreateAccessControlConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateAccessControlConfiguration, createAccessControlConfiguration_accessControlList - 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.

$sel:clientToken:CreateAccessControlConfiguration', createAccessControlConfiguration_clientToken - 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.

$sel:description:CreateAccessControlConfiguration', createAccessControlConfiguration_description - A description for the access control configuration.

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

$sel:indexId:CreateAccessControlConfiguration', createAccessControlConfiguration_indexId - The identifier of the index to create an access control configuration for your documents.

CreateAccessControlConfiguration, createAccessControlConfiguration_name - A name for the access control configuration.

data CreateAccessControlConfigurationResponse Source #

Instances

Instances details
Generic CreateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

Read CreateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

Show CreateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

NFData CreateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

Eq CreateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

type Rep CreateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateAccessControlConfiguration

type Rep CreateAccessControlConfigurationResponse = D1 ('MetaData "CreateAccessControlConfigurationResponse" "Amazonka.Kendra.CreateAccessControlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateAccessControlConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateAccessControlConfigurationResponse Source #

Create a value of CreateAccessControlConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateAccessControlConfigurationResponse', createAccessControlConfigurationResponse_httpStatus - The response's http status code.

CreateAccessControlConfigurationResponse, createAccessControlConfigurationResponse_id - The identifier of the access control configuration for your documents in an index.

CreateDataSource

data CreateDataSource Source #

See: newCreateDataSource smart constructor.

Instances

Instances details
ToJSON CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

ToHeaders CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

ToPath CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

ToQuery CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

AWSRequest CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

Associated Types

type AWSResponse CreateDataSource #

Generic CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

Associated Types

type Rep CreateDataSource :: Type -> Type #

Read CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

Show CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

NFData CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

Methods

rnf :: CreateDataSource -> () #

Eq CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

Hashable CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

type AWSResponse CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

type Rep CreateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

type Rep CreateDataSource = D1 ('MetaData "CreateDataSource" "Amazonka.Kendra.CreateDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateDataSource'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceConfiguration)) :*: S1 ('MetaSel ('Just "customDocumentEnrichmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDocumentEnrichmentConfiguration)))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataSourceType))))))

newCreateDataSource Source #

Create a value of CreateDataSource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateDataSource', createDataSource_clientToken - 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.

$sel:configuration:CreateDataSource', createDataSource_configuration - 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.

$sel:customDocumentEnrichmentConfiguration:CreateDataSource', createDataSource_customDocumentEnrichmentConfiguration - 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.

$sel:description:CreateDataSource', createDataSource_description - A description for the data source connector.

CreateDataSource, createDataSource_languageCode - 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, createDataSource_roleArn - 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.

$sel:schedule:CreateDataSource', createDataSource_schedule - 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.

$sel:tags:CreateDataSource', createDataSource_tags - 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, createDataSource_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

CreateDataSource, createDataSource_name - A name for the data source connector.

$sel:indexId:CreateDataSource', createDataSource_indexId - The identifier of the index you want to use with the data source connector.

CreateDataSource, createDataSource_type - The type of data source repository. For example, SHAREPOINT.

data CreateDataSourceResponse Source #

See: newCreateDataSourceResponse smart constructor.

Instances

Instances details
Generic CreateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

Associated Types

type Rep CreateDataSourceResponse :: Type -> Type #

Read CreateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

Show CreateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

NFData CreateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

Eq CreateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

type Rep CreateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateDataSource

type Rep CreateDataSourceResponse = D1 ('MetaData "CreateDataSourceResponse" "Amazonka.Kendra.CreateDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateDataSourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateDataSourceResponse Source #

Create a value of CreateDataSourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateDataSourceResponse', createDataSourceResponse_httpStatus - The response's http status code.

CreateDataSourceResponse, createDataSourceResponse_id - The identifier of the data source connector.

CreateExperience

data CreateExperience Source #

See: newCreateExperience smart constructor.

Instances

Instances details
ToJSON CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

ToHeaders CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

ToPath CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

ToQuery CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

AWSRequest CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

Associated Types

type AWSResponse CreateExperience #

Generic CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

Associated Types

type Rep CreateExperience :: Type -> Type #

Read CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

Show CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

NFData CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

Methods

rnf :: CreateExperience -> () #

Eq CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

Hashable CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

type AWSResponse CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

type Rep CreateExperience Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

newCreateExperience Source #

Create a value of CreateExperience with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateExperience', createExperience_clientToken - 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.

$sel:configuration:CreateExperience', createExperience_configuration - 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.

$sel:description:CreateExperience', createExperience_description - A description for your Amazon Kendra experience.

CreateExperience, createExperience_roleArn - 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, createExperience_name - A name for your Amazon Kendra experience.

$sel:indexId:CreateExperience', createExperience_indexId - The identifier of the index for your Amazon Kendra experience.

data CreateExperienceResponse Source #

See: newCreateExperienceResponse smart constructor.

Instances

Instances details
Generic CreateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

Associated Types

type Rep CreateExperienceResponse :: Type -> Type #

Read CreateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

Show CreateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

NFData CreateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

Eq CreateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

type Rep CreateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateExperience

type Rep CreateExperienceResponse = D1 ('MetaData "CreateExperienceResponse" "Amazonka.Kendra.CreateExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateExperienceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateExperienceResponse Source #

Create a value of CreateExperienceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateExperienceResponse', createExperienceResponse_httpStatus - The response's http status code.

CreateExperienceResponse, createExperienceResponse_id - The identifier for your created Amazon Kendra experience.

CreateFaq

data CreateFaq Source #

See: newCreateFaq smart constructor.

Instances

Instances details
ToJSON CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

ToHeaders CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Methods

toHeaders :: CreateFaq -> [Header] #

ToPath CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

ToQuery CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

AWSRequest CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Associated Types

type AWSResponse CreateFaq #

Generic CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Associated Types

type Rep CreateFaq :: Type -> Type #

Read CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Show CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

NFData CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Methods

rnf :: CreateFaq -> () #

Eq CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Hashable CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

type AWSResponse CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

type Rep CreateFaq Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

newCreateFaq Source #

Create a value of CreateFaq with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateFaq', createFaq_clientToken - 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.

$sel:description:CreateFaq', createFaq_description - A description for the FAQ.

CreateFaq, createFaq_fileFormat - 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, createFaq_languageCode - 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.

$sel:tags:CreateFaq', createFaq_tags - 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.

$sel:indexId:CreateFaq', createFaq_indexId - The identifier of the index for the FAQ.

CreateFaq, createFaq_name - A name for the FAQ.

CreateFaq, createFaq_s3Path - The path to the FAQ file in S3.

CreateFaq, createFaq_roleArn - 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.

data CreateFaqResponse Source #

See: newCreateFaqResponse smart constructor.

Instances

Instances details
Generic CreateFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Associated Types

type Rep CreateFaqResponse :: Type -> Type #

Read CreateFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Show CreateFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

NFData CreateFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

Methods

rnf :: CreateFaqResponse -> () #

Eq CreateFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

type Rep CreateFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateFaq

type Rep CreateFaqResponse = D1 ('MetaData "CreateFaqResponse" "Amazonka.Kendra.CreateFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateFaqResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateFaqResponse Source #

Create a value of CreateFaqResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateFaqResponse, createFaqResponse_id - The identifier of the FAQ.

$sel:httpStatus:CreateFaqResponse', createFaqResponse_httpStatus - The response's http status code.

CreateIndex

data CreateIndex Source #

See: newCreateIndex smart constructor.

Instances

Instances details
ToJSON CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

ToHeaders CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

Methods

toHeaders :: CreateIndex -> [Header] #

ToPath CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

ToQuery CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

AWSRequest CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

Associated Types

type AWSResponse CreateIndex #

Generic CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

Associated Types

type Rep CreateIndex :: Type -> Type #

Show CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

NFData CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

Methods

rnf :: CreateIndex -> () #

Eq CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

Hashable CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

type AWSResponse CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

type Rep CreateIndex Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

newCreateIndex Source #

Create a value of CreateIndex with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateIndex', createIndex_clientToken - 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.

$sel:description:CreateIndex', createIndex_description - A description for the index.

CreateIndex, createIndex_edition - 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.

$sel:serverSideEncryptionConfiguration:CreateIndex', createIndex_serverSideEncryptionConfiguration - 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.

$sel:tags:CreateIndex', createIndex_tags - 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.

$sel:userContextPolicy:CreateIndex', createIndex_userContextPolicy - 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.

$sel:userGroupResolutionConfiguration:CreateIndex', createIndex_userGroupResolutionConfiguration - 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.

$sel:userTokenConfigurations:CreateIndex', createIndex_userTokenConfigurations - The user token configuration.

CreateIndex, createIndex_name - A name for the index.

CreateIndex, createIndex_roleArn - 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.

data CreateIndexResponse Source #

See: newCreateIndexResponse smart constructor.

Instances

Instances details
Generic CreateIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

Associated Types

type Rep CreateIndexResponse :: Type -> Type #

Read CreateIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

Show CreateIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

NFData CreateIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

Methods

rnf :: CreateIndexResponse -> () #

Eq CreateIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

type Rep CreateIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateIndex

type Rep CreateIndexResponse = D1 ('MetaData "CreateIndexResponse" "Amazonka.Kendra.CreateIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateIndexResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateIndexResponse Source #

Create a value of CreateIndexResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:httpStatus:CreateIndexResponse', createIndexResponse_httpStatus - The response's http status code.

CreateQuerySuggestionsBlockList

data CreateQuerySuggestionsBlockList Source #

See: newCreateQuerySuggestionsBlockList smart constructor.

Instances

Instances details
ToJSON CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

ToHeaders CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

ToPath CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

ToQuery CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

AWSRequest CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Generic CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Associated Types

type Rep CreateQuerySuggestionsBlockList :: Type -> Type #

Read CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Show CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

NFData CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Eq CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Hashable CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

type AWSResponse CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

type Rep CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

type Rep CreateQuerySuggestionsBlockList = D1 ('MetaData "CreateQuerySuggestionsBlockList" "Amazonka.Kendra.CreateQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateQuerySuggestionsBlockList'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sourceS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Path) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateQuerySuggestionsBlockList Source #

Create a value of CreateQuerySuggestionsBlockList with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_clientToken - A token that you provide to identify the request to create a query suggestions block list.

$sel:description:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_description - 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."

$sel:tags:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_tags - A tag that you can assign to a block list that categorizes the block list.

$sel:indexId:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_indexId - The identifier of the index you want to create a query suggestions block list for.

CreateQuerySuggestionsBlockList, createQuerySuggestionsBlockList_name - 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.

$sel:sourceS3Path:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_sourceS3Path - 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, createQuerySuggestionsBlockList_roleArn - 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.

data CreateQuerySuggestionsBlockListResponse Source #

Instances

Instances details
Generic CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Read CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Show CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

NFData CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Eq CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

type Rep CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

type Rep CreateQuerySuggestionsBlockListResponse = D1 ('MetaData "CreateQuerySuggestionsBlockListResponse" "Amazonka.Kendra.CreateQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateQuerySuggestionsBlockListResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateQuerySuggestionsBlockListResponse Source #

Create a value of CreateQuerySuggestionsBlockListResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateQuerySuggestionsBlockListResponse, createQuerySuggestionsBlockListResponse_id - The identifier of the created block list.

$sel:httpStatus:CreateQuerySuggestionsBlockListResponse', createQuerySuggestionsBlockListResponse_httpStatus - The response's http status code.

CreateThesaurus

data CreateThesaurus Source #

See: newCreateThesaurus smart constructor.

Instances

Instances details
ToJSON CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

ToHeaders CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

ToPath CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

ToQuery CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

AWSRequest CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

Associated Types

type AWSResponse CreateThesaurus #

Generic CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

Associated Types

type Rep CreateThesaurus :: Type -> Type #

Read CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

Show CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

NFData CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

Methods

rnf :: CreateThesaurus -> () #

Eq CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

Hashable CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

type AWSResponse CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

type Rep CreateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

newCreateThesaurus Source #

Create a value of CreateThesaurus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateThesaurus', createThesaurus_clientToken - 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.

$sel:description:CreateThesaurus', createThesaurus_description - A description for the thesaurus.

$sel:tags:CreateThesaurus', createThesaurus_tags - 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.

$sel:indexId:CreateThesaurus', createThesaurus_indexId - The identifier of the index for the thesaurus.

CreateThesaurus, createThesaurus_name - A name for the thesaurus.

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

$sel:sourceS3Path:CreateThesaurus', createThesaurus_sourceS3Path - The path to the thesaurus file in S3.

data CreateThesaurusResponse Source #

See: newCreateThesaurusResponse smart constructor.

Instances

Instances details
Generic CreateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

Associated Types

type Rep CreateThesaurusResponse :: Type -> Type #

Read CreateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

Show CreateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

NFData CreateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

Methods

rnf :: CreateThesaurusResponse -> () #

Eq CreateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

type Rep CreateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateThesaurus

type Rep CreateThesaurusResponse = D1 ('MetaData "CreateThesaurusResponse" "Amazonka.Kendra.CreateThesaurus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateThesaurusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateThesaurusResponse Source #

Create a value of CreateThesaurusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateThesaurusResponse, createThesaurusResponse_id - The identifier of the thesaurus.

$sel:httpStatus:CreateThesaurusResponse', createThesaurusResponse_httpStatus - The response's http status code.

DeleteAccessControlConfiguration

data DeleteAccessControlConfiguration Source #

See: newDeleteAccessControlConfiguration smart constructor.

Instances

Instances details
ToJSON DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

ToHeaders DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

ToPath DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

ToQuery DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

AWSRequest DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

Generic DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

Associated Types

type Rep DeleteAccessControlConfiguration :: Type -> Type #

Read DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

Show DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

NFData DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

Eq DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

Hashable DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

type AWSResponse DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

type Rep DeleteAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

type Rep DeleteAccessControlConfiguration = D1 ('MetaData "DeleteAccessControlConfiguration" "Amazonka.Kendra.DeleteAccessControlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteAccessControlConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteAccessControlConfiguration Source #

Create a value of DeleteAccessControlConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexId:DeleteAccessControlConfiguration', deleteAccessControlConfiguration_indexId - The identifier of the index for an access control configuration.

DeleteAccessControlConfiguration, deleteAccessControlConfiguration_id - The identifier of the access control configuration you want to delete.

data DeleteAccessControlConfigurationResponse Source #

Instances

Instances details
Generic DeleteAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

Read DeleteAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

Show DeleteAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

NFData DeleteAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

Eq DeleteAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

type Rep DeleteAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteAccessControlConfiguration

type Rep DeleteAccessControlConfigurationResponse = D1 ('MetaData "DeleteAccessControlConfigurationResponse" "Amazonka.Kendra.DeleteAccessControlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteAccessControlConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteAccessControlConfigurationResponse Source #

Create a value of DeleteAccessControlConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteAccessControlConfigurationResponse', deleteAccessControlConfigurationResponse_httpStatus - The response's http status code.

DeleteDataSource

data DeleteDataSource Source #

See: newDeleteDataSource smart constructor.

Instances

Instances details
ToJSON DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

ToHeaders DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

ToPath DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

ToQuery DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

AWSRequest DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

Associated Types

type AWSResponse DeleteDataSource #

Generic DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

Associated Types

type Rep DeleteDataSource :: Type -> Type #

Read DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

Show DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

NFData DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

Methods

rnf :: DeleteDataSource -> () #

Eq DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

Hashable DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

type AWSResponse DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

type Rep DeleteDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

type Rep DeleteDataSource = D1 ('MetaData "DeleteDataSource" "Amazonka.Kendra.DeleteDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteDataSource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDataSource Source #

Create a value of DeleteDataSource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteDataSource, deleteDataSource_id - The identifier of the data source connector you want to delete.

$sel:indexId:DeleteDataSource', deleteDataSource_indexId - The identifier of the index used with the data source connector.

data DeleteDataSourceResponse Source #

See: newDeleteDataSourceResponse smart constructor.

Instances

Instances details
Generic DeleteDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

Associated Types

type Rep DeleteDataSourceResponse :: Type -> Type #

Read DeleteDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

Show DeleteDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

NFData DeleteDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

Eq DeleteDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

type Rep DeleteDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteDataSource

type Rep DeleteDataSourceResponse = D1 ('MetaData "DeleteDataSourceResponse" "Amazonka.Kendra.DeleteDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteDataSourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDataSourceResponse :: DeleteDataSourceResponse Source #

Create a value of DeleteDataSourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteExperience

data DeleteExperience Source #

See: newDeleteExperience smart constructor.

Instances

Instances details
ToJSON DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

ToHeaders DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

ToPath DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

ToQuery DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

AWSRequest DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

Associated Types

type AWSResponse DeleteExperience #

Generic DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

Associated Types

type Rep DeleteExperience :: Type -> Type #

Read DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

Show DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

NFData DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

Methods

rnf :: DeleteExperience -> () #

Eq DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

Hashable DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

type AWSResponse DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

type Rep DeleteExperience Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

type Rep DeleteExperience = D1 ('MetaData "DeleteExperience" "Amazonka.Kendra.DeleteExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteExperience'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteExperience Source #

Create a value of DeleteExperience with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteExperience, deleteExperience_id - The identifier of your Amazon Kendra experience you want to delete.

$sel:indexId:DeleteExperience', deleteExperience_indexId - The identifier of the index for your Amazon Kendra experience.

data DeleteExperienceResponse Source #

See: newDeleteExperienceResponse smart constructor.

Instances

Instances details
Generic DeleteExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

Associated Types

type Rep DeleteExperienceResponse :: Type -> Type #

Read DeleteExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

Show DeleteExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

NFData DeleteExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

Eq DeleteExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

type Rep DeleteExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteExperience

type Rep DeleteExperienceResponse = D1 ('MetaData "DeleteExperienceResponse" "Amazonka.Kendra.DeleteExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteExperienceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteExperienceResponse Source #

Create a value of DeleteExperienceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteExperienceResponse', deleteExperienceResponse_httpStatus - The response's http status code.

DeleteFaq

data DeleteFaq Source #

See: newDeleteFaq smart constructor.

Constructors

DeleteFaq' Text Text 

Instances

Instances details
ToJSON DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

ToHeaders DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Methods

toHeaders :: DeleteFaq -> [Header] #

ToPath DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

ToQuery DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

AWSRequest DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Associated Types

type AWSResponse DeleteFaq #

Generic DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Associated Types

type Rep DeleteFaq :: Type -> Type #

Read DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Show DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

NFData DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Methods

rnf :: DeleteFaq -> () #

Eq DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Hashable DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

type AWSResponse DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

type Rep DeleteFaq Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

type Rep DeleteFaq = D1 ('MetaData "DeleteFaq" "Amazonka.Kendra.DeleteFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteFaq'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteFaq Source #

Create a value of DeleteFaq with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteFaq, deleteFaq_id - The identifier of the FAQ you want to remove.

$sel:indexId:DeleteFaq', deleteFaq_indexId - The identifier of the index for the FAQ.

data DeleteFaqResponse Source #

See: newDeleteFaqResponse smart constructor.

Constructors

DeleteFaqResponse' 

Instances

Instances details
Generic DeleteFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Associated Types

type Rep DeleteFaqResponse :: Type -> Type #

Read DeleteFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Show DeleteFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

NFData DeleteFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

Methods

rnf :: DeleteFaqResponse -> () #

Eq DeleteFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

type Rep DeleteFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteFaq

type Rep DeleteFaqResponse = D1 ('MetaData "DeleteFaqResponse" "Amazonka.Kendra.DeleteFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteFaqResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteFaqResponse :: DeleteFaqResponse Source #

Create a value of DeleteFaqResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteIndex

data DeleteIndex Source #

See: newDeleteIndex smart constructor.

Constructors

DeleteIndex' Text 

Instances

Instances details
ToJSON DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

ToHeaders DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

Methods

toHeaders :: DeleteIndex -> [Header] #

ToPath DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

ToQuery DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

AWSRequest DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

Associated Types

type AWSResponse DeleteIndex #

Generic DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

Associated Types

type Rep DeleteIndex :: Type -> Type #

Read DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

Show DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

NFData DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

Methods

rnf :: DeleteIndex -> () #

Eq DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

Hashable DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

type AWSResponse DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

type Rep DeleteIndex Source # 
Instance details

Defined in Amazonka.Kendra.DeleteIndex

type Rep DeleteIndex = D1 ('MetaData "DeleteIndex" "Amazonka.Kendra.DeleteIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteIndex'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteIndex Source #

Create a value of DeleteIndex with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteIndex, deleteIndex_id - The identifier of the index you want to delete.

data DeleteIndexResponse Source #

See: newDeleteIndexResponse smart constructor.

Constructors

DeleteIndexResponse' 

newDeleteIndexResponse :: DeleteIndexResponse Source #

Create a value of DeleteIndexResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeletePrincipalMapping

data DeletePrincipalMapping Source #

See: newDeletePrincipalMapping smart constructor.

Instances

Instances details
ToJSON DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

ToHeaders DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

ToPath DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

ToQuery DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

AWSRequest DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

Associated Types

type AWSResponse DeletePrincipalMapping #

Generic DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

Associated Types

type Rep DeletePrincipalMapping :: Type -> Type #

Read DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

Show DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

NFData DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

Methods

rnf :: DeletePrincipalMapping -> () #

Eq DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

Hashable DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

type AWSResponse DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

type Rep DeletePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

type Rep DeletePrincipalMapping = D1 ('MetaData "DeletePrincipalMapping" "Amazonka.Kendra.DeletePrincipalMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeletePrincipalMapping'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "orderingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeletePrincipalMapping Source #

Create a value of DeletePrincipalMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeletePrincipalMapping, deletePrincipalMapping_dataSourceId - 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, deletePrincipalMapping_orderingId - 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.

$sel:indexId:DeletePrincipalMapping', deletePrincipalMapping_indexId - The identifier of the index you want to delete a group from.

DeletePrincipalMapping, deletePrincipalMapping_groupId - The identifier of the group you want to delete.

data DeletePrincipalMappingResponse Source #

See: newDeletePrincipalMappingResponse smart constructor.

Instances

Instances details
Generic DeletePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

Associated Types

type Rep DeletePrincipalMappingResponse :: Type -> Type #

Read DeletePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

Show DeletePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

NFData DeletePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

Eq DeletePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

type Rep DeletePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeletePrincipalMapping

type Rep DeletePrincipalMappingResponse = D1 ('MetaData "DeletePrincipalMappingResponse" "Amazonka.Kendra.DeletePrincipalMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeletePrincipalMappingResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeletePrincipalMappingResponse :: DeletePrincipalMappingResponse Source #

Create a value of DeletePrincipalMappingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteQuerySuggestionsBlockList

data DeleteQuerySuggestionsBlockList Source #

See: newDeleteQuerySuggestionsBlockList smart constructor.

Instances

Instances details
ToJSON DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

ToHeaders DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

ToPath DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

ToQuery DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

AWSRequest DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

Generic DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

Associated Types

type Rep DeleteQuerySuggestionsBlockList :: Type -> Type #

Read DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

Show DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

NFData DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

Eq DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

Hashable DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

type AWSResponse DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

type Rep DeleteQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

type Rep DeleteQuerySuggestionsBlockList = D1 ('MetaData "DeleteQuerySuggestionsBlockList" "Amazonka.Kendra.DeleteQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteQuerySuggestionsBlockList'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteQuerySuggestionsBlockList Source #

Create a value of DeleteQuerySuggestionsBlockList with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexId:DeleteQuerySuggestionsBlockList', deleteQuerySuggestionsBlockList_indexId - The identifier of the index for the block list.

DeleteQuerySuggestionsBlockList, deleteQuerySuggestionsBlockList_id - The identifier of the block list you want to delete.

data DeleteQuerySuggestionsBlockListResponse Source #

Instances

Instances details
Generic DeleteQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

Read DeleteQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

Show DeleteQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

NFData DeleteQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

Eq DeleteQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

type Rep DeleteQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteQuerySuggestionsBlockList

type Rep DeleteQuerySuggestionsBlockListResponse = D1 ('MetaData "DeleteQuerySuggestionsBlockListResponse" "Amazonka.Kendra.DeleteQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteQuerySuggestionsBlockListResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteQuerySuggestionsBlockListResponse :: DeleteQuerySuggestionsBlockListResponse Source #

Create a value of DeleteQuerySuggestionsBlockListResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteThesaurus

data DeleteThesaurus Source #

See: newDeleteThesaurus smart constructor.

Constructors

DeleteThesaurus' Text Text 

Instances

Instances details
ToJSON DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

ToHeaders DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

ToPath DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

ToQuery DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

AWSRequest DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

Associated Types

type AWSResponse DeleteThesaurus #

Generic DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

Associated Types

type Rep DeleteThesaurus :: Type -> Type #

Read DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

Show DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

NFData DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

Methods

rnf :: DeleteThesaurus -> () #

Eq DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

Hashable DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

type AWSResponse DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

type Rep DeleteThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

type Rep DeleteThesaurus = D1 ('MetaData "DeleteThesaurus" "Amazonka.Kendra.DeleteThesaurus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteThesaurus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteThesaurus Source #

Create a value of DeleteThesaurus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteThesaurus, deleteThesaurus_id - The identifier of the thesaurus you want to delete.

$sel:indexId:DeleteThesaurus', deleteThesaurus_indexId - The identifier of the index for the thesaurus.

data DeleteThesaurusResponse Source #

See: newDeleteThesaurusResponse smart constructor.

Instances

Instances details
Generic DeleteThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

Associated Types

type Rep DeleteThesaurusResponse :: Type -> Type #

Read DeleteThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

Show DeleteThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

NFData DeleteThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

Methods

rnf :: DeleteThesaurusResponse -> () #

Eq DeleteThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

type Rep DeleteThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DeleteThesaurus

type Rep DeleteThesaurusResponse = D1 ('MetaData "DeleteThesaurusResponse" "Amazonka.Kendra.DeleteThesaurus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteThesaurusResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteThesaurusResponse :: DeleteThesaurusResponse Source #

Create a value of DeleteThesaurusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DescribeAccessControlConfiguration

data DescribeAccessControlConfiguration Source #

Instances

Instances details
ToJSON DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

ToHeaders DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

ToPath DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

ToQuery DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

AWSRequest DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

Generic DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

Associated Types

type Rep DescribeAccessControlConfiguration :: Type -> Type #

Read DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

Show DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

NFData DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

Eq DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

Hashable DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

type AWSResponse DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

type Rep DescribeAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

type Rep DescribeAccessControlConfiguration = D1 ('MetaData "DescribeAccessControlConfiguration" "Amazonka.Kendra.DescribeAccessControlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeAccessControlConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAccessControlConfiguration Source #

Create a value of DescribeAccessControlConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexId:DescribeAccessControlConfiguration', describeAccessControlConfiguration_indexId - The identifier of the index for an access control configuration.

DescribeAccessControlConfiguration, describeAccessControlConfiguration_id - The identifier of the access control configuration you want to get information on.

data DescribeAccessControlConfigurationResponse Source #

Instances

Instances details
Generic DescribeAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

Read DescribeAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

Show DescribeAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

NFData DescribeAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

Eq DescribeAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

type Rep DescribeAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeAccessControlConfiguration

type Rep DescribeAccessControlConfigurationResponse = D1 ('MetaData "DescribeAccessControlConfigurationResponse" "Amazonka.Kendra.DescribeAccessControlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeAccessControlConfigurationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Principal])) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hierarchicalAccessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HierarchicalPrincipal))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeAccessControlConfigurationResponse Source #

Create a value of DescribeAccessControlConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeAccessControlConfigurationResponse, describeAccessControlConfigurationResponse_accessControlList - 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.

$sel:description:DescribeAccessControlConfigurationResponse', describeAccessControlConfigurationResponse_description - The description for the access control configuration.

DescribeAccessControlConfigurationResponse, describeAccessControlConfigurationResponse_errorMessage - The error message containing details if there are issues processing the access control configuration.

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

$sel:httpStatus:DescribeAccessControlConfigurationResponse', describeAccessControlConfigurationResponse_httpStatus - The response's http status code.

DescribeAccessControlConfigurationResponse, describeAccessControlConfigurationResponse_name - The name for the access control configuration.

DescribeDataSource

data DescribeDataSource Source #

See: newDescribeDataSource smart constructor.

Instances

Instances details
ToJSON DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

ToHeaders DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

ToPath DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

ToQuery DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

AWSRequest DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

Associated Types

type AWSResponse DescribeDataSource #

Generic DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

Associated Types

type Rep DescribeDataSource :: Type -> Type #

Read DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

Show DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

NFData DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

Methods

rnf :: DescribeDataSource -> () #

Eq DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

Hashable DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

type AWSResponse DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

type Rep DescribeDataSource Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

type Rep DescribeDataSource = D1 ('MetaData "DescribeDataSource" "Amazonka.Kendra.DescribeDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeDataSource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeDataSource Source #

Create a value of DescribeDataSource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDataSource, describeDataSource_id - The identifier of the data source connector.

DescribeDataSource, describeDataSource_indexId - The identifier of the index used with the data source connector.

data DescribeDataSourceResponse Source #

See: newDescribeDataSourceResponse smart constructor.

Instances

Instances details
Generic DescribeDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

Associated Types

type Rep DescribeDataSourceResponse :: Type -> Type #

Read DescribeDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

Show DescribeDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

NFData DescribeDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

Eq DescribeDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

type Rep DescribeDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeDataSource

type Rep DescribeDataSourceResponse = D1 ('MetaData "DescribeDataSourceResponse" "Amazonka.Kendra.DescribeDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeDataSourceResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceConfiguration)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "customDocumentEnrichmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDocumentEnrichmentConfiguration)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceStatus)))) :*: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceType)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeDataSourceResponse Source #

Create a value of DescribeDataSourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configuration:DescribeDataSourceResponse', describeDataSourceResponse_configuration - 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, describeDataSourceResponse_createdAt - The Unix timestamp of when the data source connector was created.

$sel:customDocumentEnrichmentConfiguration:DescribeDataSourceResponse', describeDataSourceResponse_customDocumentEnrichmentConfiguration - 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.

$sel:description:DescribeDataSourceResponse', describeDataSourceResponse_description - The description for the data source connector.

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

DescribeDataSource, describeDataSourceResponse_id - The identifier of the data source connector.

DescribeDataSource, describeDataSourceResponse_indexId - The identifier of the index used with the data source connector.

DescribeDataSourceResponse, describeDataSourceResponse_languageCode - 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, describeDataSourceResponse_name - The name for the data source connector.

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

$sel:schedule:DescribeDataSourceResponse', describeDataSourceResponse_schedule - The schedule for Amazon Kendra to update the index.

DescribeDataSourceResponse, describeDataSourceResponse_status - 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, describeDataSourceResponse_type - The type of the data source. For example, SHAREPOINT.

DescribeDataSourceResponse, describeDataSourceResponse_updatedAt - The Unix timestamp of when the data source connector was last updated.

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

$sel:httpStatus:DescribeDataSourceResponse', describeDataSourceResponse_httpStatus - The response's http status code.

DescribeExperience

data DescribeExperience Source #

See: newDescribeExperience smart constructor.

Instances

Instances details
ToJSON DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

ToHeaders DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

ToPath DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

ToQuery DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

AWSRequest DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

Associated Types

type AWSResponse DescribeExperience #

Generic DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

Associated Types

type Rep DescribeExperience :: Type -> Type #

Read DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

Show DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

NFData DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

Methods

rnf :: DescribeExperience -> () #

Eq DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

Hashable DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

type AWSResponse DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

type Rep DescribeExperience Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

type Rep DescribeExperience = D1 ('MetaData "DescribeExperience" "Amazonka.Kendra.DescribeExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeExperience'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeExperience Source #

Create a value of DescribeExperience with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeExperience, describeExperience_id - The identifier of your Amazon Kendra experience you want to get information on.

DescribeExperience, describeExperience_indexId - The identifier of the index for your Amazon Kendra experience.

data DescribeExperienceResponse Source #

See: newDescribeExperienceResponse smart constructor.

Instances

Instances details
Generic DescribeExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

Associated Types

type Rep DescribeExperienceResponse :: Type -> Type #

Read DescribeExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

Show DescribeExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

NFData DescribeExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

Eq DescribeExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

type Rep DescribeExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeExperience

type Rep DescribeExperienceResponse = D1 ('MetaData "DescribeExperienceResponse" "Amazonka.Kendra.DescribeExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeExperienceResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperienceConfiguration)) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExperienceEndpoint))) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperienceStatus)) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeExperienceResponse Source #

Create a value of DescribeExperienceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configuration:DescribeExperienceResponse', describeExperienceResponse_configuration - 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, describeExperienceResponse_createdAt - Shows the date-time your Amazon Kendra experience was created.

$sel:description:DescribeExperienceResponse', describeExperienceResponse_description - Shows the description for your Amazon Kendra experience.

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

DescribeExperienceResponse, describeExperienceResponse_errorMessage - The reason your Amazon Kendra experience could not properly process.

DescribeExperience, describeExperienceResponse_id - Shows the identifier of your Amazon Kendra experience.

DescribeExperience, describeExperienceResponse_indexId - Shows the identifier of the index for your Amazon Kendra experience.

DescribeExperienceResponse, describeExperienceResponse_name - Shows the name of your Amazon Kendra experience.

DescribeExperienceResponse, describeExperienceResponse_roleArn - 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, describeExperienceResponse_status - 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, describeExperienceResponse_updatedAt - Shows the date-time your Amazon Kendra experience was last updated.

$sel:httpStatus:DescribeExperienceResponse', describeExperienceResponse_httpStatus - The response's http status code.

DescribeFaq

data DescribeFaq Source #

See: newDescribeFaq smart constructor.

Constructors

DescribeFaq' Text Text 

Instances

Instances details
ToJSON DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

ToHeaders DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Methods

toHeaders :: DescribeFaq -> [Header] #

ToPath DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

ToQuery DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

AWSRequest DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Associated Types

type AWSResponse DescribeFaq #

Generic DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Associated Types

type Rep DescribeFaq :: Type -> Type #

Read DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Show DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

NFData DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Methods

rnf :: DescribeFaq -> () #

Eq DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Hashable DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

type AWSResponse DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

type Rep DescribeFaq Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

type Rep DescribeFaq = D1 ('MetaData "DescribeFaq" "Amazonka.Kendra.DescribeFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeFaq'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeFaq Source #

Create a value of DescribeFaq with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeFaq, describeFaq_id - The identifier of the FAQ you want to get information on.

DescribeFaq, describeFaq_indexId - The identifier of the index for the FAQ.

data DescribeFaqResponse Source #

See: newDescribeFaqResponse smart constructor.

Instances

Instances details
Generic DescribeFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Associated Types

type Rep DescribeFaqResponse :: Type -> Type #

Read DescribeFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Show DescribeFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

NFData DescribeFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

Methods

rnf :: DescribeFaqResponse -> () #

Eq DescribeFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

type Rep DescribeFaqResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeFaq

type Rep DescribeFaqResponse = D1 ('MetaData "DescribeFaqResponse" "Amazonka.Kendra.DescribeFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeFaqResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "fileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqFileFormat)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "s3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqStatus))) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeFaqResponse Source #

Create a value of DescribeFaqResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeFaqResponse, describeFaqResponse_createdAt - The date and time that the FAQ was created.

$sel:description:DescribeFaqResponse', describeFaqResponse_description - The description of the FAQ that you provided when it was created.

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

DescribeFaqResponse, describeFaqResponse_fileFormat - The file format used by the input files for the FAQ.

DescribeFaq, describeFaqResponse_id - The identifier of the FAQ.

DescribeFaq, describeFaqResponse_indexId - The identifier of the index for the FAQ.

DescribeFaqResponse, describeFaqResponse_languageCode - 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, describeFaqResponse_name - The name that you gave the FAQ when it was created.

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

DescribeFaqResponse, describeFaqResponse_s3Path - Undocumented member.

DescribeFaqResponse, describeFaqResponse_status - The status of the FAQ. It is ready to use when the status is ACTIVE.

DescribeFaqResponse, describeFaqResponse_updatedAt - The date and time that the FAQ was last updated.

$sel:httpStatus:DescribeFaqResponse', describeFaqResponse_httpStatus - The response's http status code.

DescribeIndex

data DescribeIndex Source #

See: newDescribeIndex smart constructor.

Constructors

DescribeIndex' Text 

Instances

Instances details
ToJSON DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

ToHeaders DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

ToPath DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

ToQuery DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

AWSRequest DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

Associated Types

type AWSResponse DescribeIndex #

Generic DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

Associated Types

type Rep DescribeIndex :: Type -> Type #

Read DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

Show DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

NFData DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

Methods

rnf :: DescribeIndex -> () #

Eq DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

Hashable DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

type AWSResponse DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

type Rep DescribeIndex Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

type Rep DescribeIndex = D1 ('MetaData "DescribeIndex" "Amazonka.Kendra.DescribeIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeIndex'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeIndex Source #

Create a value of DescribeIndex with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeIndex, describeIndex_id - The identifier of the index you want to get information on.

data DescribeIndexResponse Source #

See: newDescribeIndexResponse smart constructor.

Instances

Instances details
Generic DescribeIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

Associated Types

type Rep DescribeIndexResponse :: Type -> Type #

Show DescribeIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

NFData DescribeIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

Methods

rnf :: DescribeIndexResponse -> () #

Eq DescribeIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

type Rep DescribeIndexResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeIndex

type Rep DescribeIndexResponse = D1 ('MetaData "DescribeIndexResponse" "Amazonka.Kendra.DescribeIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeIndexResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "capacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityUnitsConfiguration)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentMetadataConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentMetadataConfiguration])))) :*: ((S1 ('MetaSel ('Just "edition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexEdition)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexStatistics))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "serverSideEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerSideEncryptionConfiguration)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexStatus)))) :*: ((S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "userContextPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContextPolicy))) :*: (S1 ('MetaSel ('Just "userGroupResolutionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserGroupResolutionConfiguration)) :*: (S1 ('MetaSel ('Just "userTokenConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserTokenConfiguration])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeIndexResponse Source #

Create a value of DescribeIndexResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:capacityUnits:DescribeIndexResponse', describeIndexResponse_capacityUnits - 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, describeIndexResponse_createdAt - The Unix datetime that the index was created.

$sel:description:DescribeIndexResponse', describeIndexResponse_description - The description for the index.

$sel:documentMetadataConfigurations:DescribeIndexResponse', describeIndexResponse_documentMetadataConfigurations - 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, describeIndexResponse_edition - The Amazon Kendra edition used for the index. You decide the edition when you create the index.

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

DescribeIndex, describeIndexResponse_id - The identifier of the index.

$sel:indexStatistics:DescribeIndexResponse', describeIndexResponse_indexStatistics - Provides information about the number of FAQ questions and answers and the number of text documents indexed.

DescribeIndexResponse, describeIndexResponse_name - The name of the index.

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

$sel:serverSideEncryptionConfiguration:DescribeIndexResponse', describeIndexResponse_serverSideEncryptionConfiguration - The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

DescribeIndexResponse, describeIndexResponse_status - 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, describeIndexResponse_updatedAt - The Unix datetime that the index was last updated.

$sel:userContextPolicy:DescribeIndexResponse', describeIndexResponse_userContextPolicy - The user context policy for the Amazon Kendra index.

$sel:userGroupResolutionConfiguration:DescribeIndexResponse', describeIndexResponse_userGroupResolutionConfiguration - 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.

$sel:userTokenConfigurations:DescribeIndexResponse', describeIndexResponse_userTokenConfigurations - The user token configuration for the Amazon Kendra index.

$sel:httpStatus:DescribeIndexResponse', describeIndexResponse_httpStatus - The response's http status code.

DescribePrincipalMapping

data DescribePrincipalMapping Source #

See: newDescribePrincipalMapping smart constructor.

Instances

Instances details
ToJSON DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

ToHeaders DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

ToPath DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

ToQuery DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

AWSRequest DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

Generic DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

Associated Types

type Rep DescribePrincipalMapping :: Type -> Type #

Read DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

Show DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

NFData DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

Eq DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

Hashable DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

type AWSResponse DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

type Rep DescribePrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

type Rep DescribePrincipalMapping = D1 ('MetaData "DescribePrincipalMapping" "Amazonka.Kendra.DescribePrincipalMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribePrincipalMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribePrincipalMapping Source #

Create a value of DescribePrincipalMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

data DescribePrincipalMappingResponse Source #

See: newDescribePrincipalMappingResponse smart constructor.

Instances

Instances details
Generic DescribePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

Associated Types

type Rep DescribePrincipalMappingResponse :: Type -> Type #

Read DescribePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

Show DescribePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

NFData DescribePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

Eq DescribePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

type Rep DescribePrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribePrincipalMapping

type Rep DescribePrincipalMappingResponse = D1 ('MetaData "DescribePrincipalMappingResponse" "Amazonka.Kendra.DescribePrincipalMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribePrincipalMappingResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "groupOrderingIdSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupOrderingIdSummary])) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribePrincipalMappingResponse Source #

Create a value of DescribePrincipalMappingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

$sel:groupOrderingIdSummaries:DescribePrincipalMappingResponse', describePrincipalMappingResponse_groupOrderingIdSummaries - 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.

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

$sel:httpStatus:DescribePrincipalMappingResponse', describePrincipalMappingResponse_httpStatus - The response's http status code.

DescribeQuerySuggestionsBlockList

data DescribeQuerySuggestionsBlockList Source #

See: newDescribeQuerySuggestionsBlockList smart constructor.

Instances

Instances details
ToJSON DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

ToHeaders DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

ToPath DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

ToQuery DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

AWSRequest DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Generic DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Associated Types

type Rep DescribeQuerySuggestionsBlockList :: Type -> Type #

Read DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Show DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

NFData DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Eq DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Hashable DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

type AWSResponse DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

type Rep DescribeQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

type Rep DescribeQuerySuggestionsBlockList = D1 ('MetaData "DescribeQuerySuggestionsBlockList" "Amazonka.Kendra.DescribeQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeQuerySuggestionsBlockList'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeQuerySuggestionsBlockList Source #

Create a value of DescribeQuerySuggestionsBlockList with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeQuerySuggestionsBlockList, describeQuerySuggestionsBlockList_indexId - The identifier of the index for the block list.

DescribeQuerySuggestionsBlockList, describeQuerySuggestionsBlockList_id - The identifier of the block list you want to get information on.

data DescribeQuerySuggestionsBlockListResponse Source #

Instances

Instances details
Generic DescribeQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Read DescribeQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Show DescribeQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

NFData DescribeQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Eq DescribeQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

type Rep DescribeQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList

type Rep DescribeQuerySuggestionsBlockListResponse = D1 ('MetaData "DescribeQuerySuggestionsBlockListResponse" "Amazonka.Kendra.DescribeQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeQuerySuggestionsBlockListResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "fileSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "itemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sourceS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuerySuggestionsBlockListStatus))) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeQuerySuggestionsBlockListResponse Source #

Create a value of DescribeQuerySuggestionsBlockListResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:description:DescribeQuerySuggestionsBlockListResponse', describeQuerySuggestionsBlockListResponse_description - The description for the block list.

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_errorMessage - The error message containing details if there are issues processing the block list.

$sel:fileSizeBytes:DescribeQuerySuggestionsBlockListResponse', describeQuerySuggestionsBlockListResponse_fileSizeBytes - The current size of the block list text file in S3.

DescribeQuerySuggestionsBlockList, describeQuerySuggestionsBlockListResponse_id - The identifier of the block list.

DescribeQuerySuggestionsBlockList, describeQuerySuggestionsBlockListResponse_indexId - The identifier of the index for the block list.

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

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_name - The name of the block list.

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_roleArn - 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.

$sel:sourceS3Path:DescribeQuerySuggestionsBlockListResponse', describeQuerySuggestionsBlockListResponse_sourceS3Path - 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, describeQuerySuggestionsBlockListResponse_status - The current status of the block list. When the value is ACTIVE, the block list is ready for use.

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

$sel:httpStatus:DescribeQuerySuggestionsBlockListResponse', describeQuerySuggestionsBlockListResponse_httpStatus - The response's http status code.

DescribeQuerySuggestionsConfig

data DescribeQuerySuggestionsConfig Source #

See: newDescribeQuerySuggestionsConfig smart constructor.

Instances

Instances details
ToJSON DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

ToHeaders DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

ToPath DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

ToQuery DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

AWSRequest DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

Generic DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

Associated Types

type Rep DescribeQuerySuggestionsConfig :: Type -> Type #

Read DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

Show DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

NFData DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

Eq DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

Hashable DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

type AWSResponse DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

type Rep DescribeQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

type Rep DescribeQuerySuggestionsConfig = D1 ('MetaData "DescribeQuerySuggestionsConfig" "Amazonka.Kendra.DescribeQuerySuggestionsConfig" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeQuerySuggestionsConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeQuerySuggestionsConfig Source #

Create a value of DescribeQuerySuggestionsConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexId:DescribeQuerySuggestionsConfig', describeQuerySuggestionsConfig_indexId - The identifier of the index with query suggestions that you want to get information on.

data DescribeQuerySuggestionsConfigResponse Source #

Instances

Instances details
Generic DescribeQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

Read DescribeQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

Show DescribeQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

NFData DescribeQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

Eq DescribeQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

type Rep DescribeQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig

type Rep DescribeQuerySuggestionsConfigResponse = D1 ('MetaData "DescribeQuerySuggestionsConfigResponse" "Amazonka.Kendra.DescribeQuerySuggestionsConfig" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeQuerySuggestionsConfigResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "includeQueriesWithoutUserInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "lastClearTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "lastSuggestionsBuildTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "minimumNumberOfQueryingUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "minimumQueryCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :*: ((S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Mode)) :*: S1 ('MetaSel ('Just "queryLogLookBackWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuerySuggestionsStatus)) :*: (S1 ('MetaSel ('Just "totalSuggestionsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeQuerySuggestionsConfigResponse Source #

Create a value of DescribeQuerySuggestionsConfigResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:includeQueriesWithoutUserInformation:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_includeQueriesWithoutUserInformation - TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

$sel:lastClearTime:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_lastClearTime - 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.

$sel:lastSuggestionsBuildTime:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_lastSuggestionsBuildTime - The date-time query suggestions for an index was last updated.

$sel:minimumNumberOfQueryingUsers:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_minimumNumberOfQueryingUsers - The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

$sel:minimumQueryCount:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_minimumQueryCount - The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

$sel:mode:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_mode - 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.

$sel:queryLogLookBackWindowInDays:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_queryLogLookBackWindowInDays - How recent your queries are in your query log time window (in days).

DescribeQuerySuggestionsConfigResponse, describeQuerySuggestionsConfigResponse_status - 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.

$sel:totalSuggestionsCount:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_totalSuggestionsCount - 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.

$sel:httpStatus:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_httpStatus - The response's http status code.

DescribeThesaurus

data DescribeThesaurus Source #

See: newDescribeThesaurus smart constructor.

Instances

Instances details
ToJSON DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

ToHeaders DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

ToPath DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

ToQuery DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

AWSRequest DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

Associated Types

type AWSResponse DescribeThesaurus #

Generic DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

Associated Types

type Rep DescribeThesaurus :: Type -> Type #

Read DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

Show DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

NFData DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

Methods

rnf :: DescribeThesaurus -> () #

Eq DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

Hashable DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

type AWSResponse DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

type Rep DescribeThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

type Rep DescribeThesaurus = D1 ('MetaData "DescribeThesaurus" "Amazonka.Kendra.DescribeThesaurus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeThesaurus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeThesaurus Source #

Create a value of DescribeThesaurus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeThesaurus, describeThesaurus_id - The identifier of the thesaurus you want to get information on.

DescribeThesaurus, describeThesaurus_indexId - The identifier of the index for the thesaurus.

data DescribeThesaurusResponse Source #

See: newDescribeThesaurusResponse smart constructor.

Instances

Instances details
Generic DescribeThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

Associated Types

type Rep DescribeThesaurusResponse :: Type -> Type #

Read DescribeThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

Show DescribeThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

NFData DescribeThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

Eq DescribeThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

type Rep DescribeThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.DescribeThesaurus

type Rep DescribeThesaurusResponse = D1 ('MetaData "DescribeThesaurusResponse" "Amazonka.Kendra.DescribeThesaurus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeThesaurusResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "fileSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThesaurusStatus)))) :*: ((S1 ('MetaSel ('Just "synonymRuleCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "termCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeThesaurusResponse Source #

Create a value of DescribeThesaurusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeThesaurusResponse, describeThesaurusResponse_createdAt - The Unix datetime that the thesaurus was created.

$sel:description:DescribeThesaurusResponse', describeThesaurusResponse_description - The thesaurus description.

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

$sel:fileSizeBytes:DescribeThesaurusResponse', describeThesaurusResponse_fileSizeBytes - The size of the thesaurus file in bytes.

DescribeThesaurus, describeThesaurusResponse_id - The identifier of the thesaurus.

DescribeThesaurus, describeThesaurusResponse_indexId - The identifier of the index for the thesaurus.

DescribeThesaurusResponse, describeThesaurusResponse_name - The thesaurus name.

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

$sel:sourceS3Path:DescribeThesaurusResponse', describeThesaurusResponse_sourceS3Path - Undocumented member.

DescribeThesaurusResponse, describeThesaurusResponse_status - 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.

$sel:synonymRuleCount:DescribeThesaurusResponse', describeThesaurusResponse_synonymRuleCount - The number of synonym rules in the thesaurus file.

$sel:termCount:DescribeThesaurusResponse', describeThesaurusResponse_termCount - 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, describeThesaurusResponse_updatedAt - The Unix datetime that the thesaurus was last updated.

$sel:httpStatus:DescribeThesaurusResponse', describeThesaurusResponse_httpStatus - The response's http status code.

DisassociateEntitiesFromExperience

data DisassociateEntitiesFromExperience Source #

Instances

Instances details
ToJSON DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

ToHeaders DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

ToPath DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

ToQuery DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

AWSRequest DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

Generic DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

Associated Types

type Rep DisassociateEntitiesFromExperience :: Type -> Type #

Read DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

Show DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

NFData DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

Eq DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

Hashable DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

type AWSResponse DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

type Rep DisassociateEntitiesFromExperience Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

type Rep DisassociateEntitiesFromExperience = D1 ('MetaData "DisassociateEntitiesFromExperience" "Amazonka.Kendra.DisassociateEntitiesFromExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DisassociateEntitiesFromExperience'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty EntityConfiguration)))))

newDisassociateEntitiesFromExperience Source #

Create a value of DisassociateEntitiesFromExperience with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DisassociateEntitiesFromExperience, disassociateEntitiesFromExperience_id - The identifier of your Amazon Kendra experience.

$sel:indexId:DisassociateEntitiesFromExperience', disassociateEntitiesFromExperience_indexId - The identifier of the index for your Amazon Kendra experience.

$sel:entityList:DisassociateEntitiesFromExperience', disassociateEntitiesFromExperience_entityList - Lists users or groups in your IAM Identity Center identity source.

data DisassociateEntitiesFromExperienceResponse Source #

Instances

Instances details
Generic DisassociateEntitiesFromExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

Read DisassociateEntitiesFromExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

Show DisassociateEntitiesFromExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

NFData DisassociateEntitiesFromExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

Eq DisassociateEntitiesFromExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

type Rep DisassociateEntitiesFromExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociateEntitiesFromExperience

type Rep DisassociateEntitiesFromExperienceResponse = D1 ('MetaData "DisassociateEntitiesFromExperienceResponse" "Amazonka.Kendra.DisassociateEntitiesFromExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DisassociateEntitiesFromExperienceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedEntityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty FailedEntity))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDisassociateEntitiesFromExperienceResponse Source #

Create a value of DisassociateEntitiesFromExperienceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failedEntityList:DisassociateEntitiesFromExperienceResponse', disassociateEntitiesFromExperienceResponse_failedEntityList - Lists the users or groups in your IAM Identity Center identity source that failed to properly remove access to your Amazon Kendra experience.

$sel:httpStatus:DisassociateEntitiesFromExperienceResponse', disassociateEntitiesFromExperienceResponse_httpStatus - The response's http status code.

DisassociatePersonasFromEntities

data DisassociatePersonasFromEntities Source #

See: newDisassociatePersonasFromEntities smart constructor.

Instances

Instances details
ToJSON DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

ToHeaders DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

ToPath DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

ToQuery DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

AWSRequest DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

Generic DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

Associated Types

type Rep DisassociatePersonasFromEntities :: Type -> Type #

Read DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

Show DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

NFData DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

Eq DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

Hashable DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

type AWSResponse DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

type Rep DisassociatePersonasFromEntities Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

type Rep DisassociatePersonasFromEntities = D1 ('MetaData "DisassociatePersonasFromEntities" "Amazonka.Kendra.DisassociatePersonasFromEntities" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DisassociatePersonasFromEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))

newDisassociatePersonasFromEntities Source #

Create a value of DisassociatePersonasFromEntities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DisassociatePersonasFromEntities, disassociatePersonasFromEntities_id - The identifier of your Amazon Kendra experience.

$sel:indexId:DisassociatePersonasFromEntities', disassociatePersonasFromEntities_indexId - The identifier of the index for your Amazon Kendra experience.

$sel:entityIds:DisassociatePersonasFromEntities', disassociatePersonasFromEntities_entityIds - The identifiers of users or groups in your IAM Identity Center identity source. For example, user IDs could be user emails.

data DisassociatePersonasFromEntitiesResponse Source #

Instances

Instances details
Generic DisassociatePersonasFromEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

Read DisassociatePersonasFromEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

Show DisassociatePersonasFromEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

NFData DisassociatePersonasFromEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

Eq DisassociatePersonasFromEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

type Rep DisassociatePersonasFromEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.DisassociatePersonasFromEntities

type Rep DisassociatePersonasFromEntitiesResponse = D1 ('MetaData "DisassociatePersonasFromEntitiesResponse" "Amazonka.Kendra.DisassociatePersonasFromEntities" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DisassociatePersonasFromEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedEntityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty FailedEntity))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDisassociatePersonasFromEntitiesResponse Source #

Create a value of DisassociatePersonasFromEntitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failedEntityList:DisassociatePersonasFromEntitiesResponse', disassociatePersonasFromEntitiesResponse_failedEntityList - Lists the users or groups in your IAM Identity Center identity source that failed to properly remove access to your Amazon Kendra experience.

$sel:httpStatus:DisassociatePersonasFromEntitiesResponse', disassociatePersonasFromEntitiesResponse_httpStatus - The response's http status code.

GetQuerySuggestions

data GetQuerySuggestions Source #

See: newGetQuerySuggestions smart constructor.

Instances

Instances details
ToJSON GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

ToHeaders GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

ToPath GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

ToQuery GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

AWSRequest GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

Associated Types

type AWSResponse GetQuerySuggestions #

Generic GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

Associated Types

type Rep GetQuerySuggestions :: Type -> Type #

Read GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

Show GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

NFData GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

rnf :: GetQuerySuggestions -> () #

Eq GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

Hashable GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

type AWSResponse GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

type Rep GetQuerySuggestions Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

type Rep GetQuerySuggestions = D1 ('MetaData "GetQuerySuggestions" "Amazonka.Kendra.GetQuerySuggestions" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GetQuerySuggestions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxSuggestionsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "queryText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetQuerySuggestions Source #

Create a value of GetQuerySuggestions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maxSuggestionsCount:GetQuerySuggestions', getQuerySuggestions_maxSuggestionsCount - The maximum number of query suggestions you want to show to your users.

$sel:indexId:GetQuerySuggestions', getQuerySuggestions_indexId - The identifier of the index you want to get query suggestions from.

$sel:queryText:GetQuerySuggestions', getQuerySuggestions_queryText - 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.

data GetQuerySuggestionsResponse Source #

See: newGetQuerySuggestionsResponse smart constructor.

Instances

Instances details
Generic GetQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

Associated Types

type Rep GetQuerySuggestionsResponse :: Type -> Type #

Read GetQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

Show GetQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

NFData GetQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

Eq GetQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

type Rep GetQuerySuggestionsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetQuerySuggestions

type Rep GetQuerySuggestionsResponse = D1 ('MetaData "GetQuerySuggestionsResponse" "Amazonka.Kendra.GetQuerySuggestions" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GetQuerySuggestionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "querySuggestionsId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "suggestions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Suggestion])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetQuerySuggestionsResponse Source #

Create a value of GetQuerySuggestionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:querySuggestionsId:GetQuerySuggestionsResponse', getQuerySuggestionsResponse_querySuggestionsId - The identifier for a list of query suggestions for an index.

$sel:suggestions:GetQuerySuggestionsResponse', getQuerySuggestionsResponse_suggestions - A list of query suggestions for an index.

$sel:httpStatus:GetQuerySuggestionsResponse', getQuerySuggestionsResponse_httpStatus - The response's http status code.

GetSnapshots

data GetSnapshots Source #

See: newGetSnapshots smart constructor.

Instances

Instances details
ToJSON GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

ToHeaders GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

ToPath GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

ToQuery GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

AWSRequest GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

Associated Types

type AWSResponse GetSnapshots #

Generic GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

Associated Types

type Rep GetSnapshots :: Type -> Type #

Read GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

Show GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

NFData GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

Methods

rnf :: GetSnapshots -> () #

Eq GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

Hashable GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

type AWSResponse GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

type Rep GetSnapshots Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

type Rep GetSnapshots = D1 ('MetaData "GetSnapshots" "Amazonka.Kendra.GetSnapshots" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GetSnapshots'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Interval) :*: S1 ('MetaSel ('Just "metricType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricType)))))

newGetSnapshots Source #

Create a value of GetSnapshots with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSnapshots, getSnapshots_maxResults - The maximum number of returned data for the metric.

GetSnapshots, getSnapshots_nextToken - 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.

$sel:indexId:GetSnapshots', getSnapshots_indexId - The identifier of the index to get search metrics data.

$sel:interval:GetSnapshots', getSnapshots_interval - 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.

$sel:metricType:GetSnapshots', getSnapshots_metricType - 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.

data GetSnapshotsResponse Source #

See: newGetSnapshotsResponse smart constructor.

Instances

Instances details
Generic GetSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

Associated Types

type Rep GetSnapshotsResponse :: Type -> Type #

Read GetSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

Show GetSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

NFData GetSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

Methods

rnf :: GetSnapshotsResponse -> () #

Eq GetSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

type Rep GetSnapshotsResponse Source # 
Instance details

Defined in Amazonka.Kendra.GetSnapshots

type Rep GetSnapshotsResponse = D1 ('MetaData "GetSnapshotsResponse" "Amazonka.Kendra.GetSnapshots" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GetSnapshotsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snapShotTimeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange))) :*: (S1 ('MetaSel ('Just "snapshotsData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [[Text]])) :*: (S1 ('MetaSel ('Just "snapshotsDataHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetSnapshotsResponse Source #

Create a value of GetSnapshotsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSnapshots, getSnapshotsResponse_nextToken - 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.

$sel:snapShotTimeFilter:GetSnapshotsResponse', getSnapshotsResponse_snapShotTimeFilter - The date-time for the beginning and end of the time window for the search metrics data.

$sel:snapshotsData:GetSnapshotsResponse', getSnapshotsResponse_snapshotsData - The search metrics data. The data returned depends on the metric type you requested.

$sel:snapshotsDataHeader:GetSnapshotsResponse', getSnapshotsResponse_snapshotsDataHeader - The column headers for the search metrics data.

$sel:httpStatus:GetSnapshotsResponse', getSnapshotsResponse_httpStatus - The response's http status code.

ListAccessControlConfigurations

data ListAccessControlConfigurations Source #

See: newListAccessControlConfigurations smart constructor.

Instances

Instances details
ToJSON ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

ToHeaders ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

ToPath ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

ToQuery ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

AWSRequest ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

Generic ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

Associated Types

type Rep ListAccessControlConfigurations :: Type -> Type #

Read ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

Show ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

NFData ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

Eq ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

Hashable ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

type AWSResponse ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

type Rep ListAccessControlConfigurations Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

type Rep ListAccessControlConfigurations = D1 ('MetaData "ListAccessControlConfigurations" "Amazonka.Kendra.ListAccessControlConfigurations" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListAccessControlConfigurations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListAccessControlConfigurations Source #

Create a value of ListAccessControlConfigurations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListAccessControlConfigurations, listAccessControlConfigurations_maxResults - The maximum number of access control configurations to return.

ListAccessControlConfigurations, listAccessControlConfigurations_nextToken - 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.

$sel:indexId:ListAccessControlConfigurations', listAccessControlConfigurations_indexId - The identifier of the index for the access control configuration.

data ListAccessControlConfigurationsResponse Source #

Instances

Instances details
Generic ListAccessControlConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

Read ListAccessControlConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

Show ListAccessControlConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

NFData ListAccessControlConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

Eq ListAccessControlConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

type Rep ListAccessControlConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListAccessControlConfigurations

type Rep ListAccessControlConfigurationsResponse = D1 ('MetaData "ListAccessControlConfigurationsResponse" "Amazonka.Kendra.ListAccessControlConfigurations" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListAccessControlConfigurationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "accessControlConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AccessControlConfigurationSummary]))))

newListAccessControlConfigurationsResponse Source #

Create a value of ListAccessControlConfigurationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListAccessControlConfigurations, listAccessControlConfigurationsResponse_nextToken - 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.

$sel:httpStatus:ListAccessControlConfigurationsResponse', listAccessControlConfigurationsResponse_httpStatus - The response's http status code.

$sel:accessControlConfigurations:ListAccessControlConfigurationsResponse', listAccessControlConfigurationsResponse_accessControlConfigurations - The details of your access control configurations.

ListDataSourceSyncJobs

data ListDataSourceSyncJobs Source #

See: newListDataSourceSyncJobs smart constructor.

Instances

Instances details
ToJSON ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

ToHeaders ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

ToPath ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

ToQuery ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

AWSRequest ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Associated Types

type AWSResponse ListDataSourceSyncJobs #

Generic ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Associated Types

type Rep ListDataSourceSyncJobs :: Type -> Type #

Read ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Show ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

NFData ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

rnf :: ListDataSourceSyncJobs -> () #

Eq ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Hashable ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

type AWSResponse ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

type Rep ListDataSourceSyncJobs Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

type Rep ListDataSourceSyncJobs = D1 ('MetaData "ListDataSourceSyncJobs" "Amazonka.Kendra.ListDataSourceSyncJobs" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListDataSourceSyncJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startTimeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)))) :*: (S1 ('MetaSel ('Just "statusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceSyncJobStatus)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListDataSourceSyncJobs Source #

Create a value of ListDataSourceSyncJobs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListDataSourceSyncJobs, listDataSourceSyncJobs_maxResults - 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, listDataSourceSyncJobs_nextToken - 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.

$sel:startTimeFilter:ListDataSourceSyncJobs', listDataSourceSyncJobs_startTimeFilter - When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

$sel:statusFilter:ListDataSourceSyncJobs', listDataSourceSyncJobs_statusFilter - Only returns synchronization jobs with the Status field equal to the specified status.

ListDataSourceSyncJobs, listDataSourceSyncJobs_id - The identifier of the data source connector.

$sel:indexId:ListDataSourceSyncJobs', listDataSourceSyncJobs_indexId - The identifier of the index used with the data source connector.

data ListDataSourceSyncJobsResponse Source #

See: newListDataSourceSyncJobsResponse smart constructor.

Instances

Instances details
Generic ListDataSourceSyncJobsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Associated Types

type Rep ListDataSourceSyncJobsResponse :: Type -> Type #

Read ListDataSourceSyncJobsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Show ListDataSourceSyncJobsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

NFData ListDataSourceSyncJobsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Eq ListDataSourceSyncJobsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

type Rep ListDataSourceSyncJobsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

type Rep ListDataSourceSyncJobsResponse = D1 ('MetaData "ListDataSourceSyncJobsResponse" "Amazonka.Kendra.ListDataSourceSyncJobs" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListDataSourceSyncJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "history") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSourceSyncJob])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDataSourceSyncJobsResponse Source #

Create a value of ListDataSourceSyncJobsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:history:ListDataSourceSyncJobsResponse', listDataSourceSyncJobsResponse_history - A history of synchronization jobs for the data source connector.

ListDataSourceSyncJobs, listDataSourceSyncJobsResponse_nextToken - 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.

$sel:httpStatus:ListDataSourceSyncJobsResponse', listDataSourceSyncJobsResponse_httpStatus - The response's http status code.

ListDataSources

data ListDataSources Source #

See: newListDataSources smart constructor.

Instances

Instances details
ToJSON ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

ToHeaders ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

ToPath ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

ToQuery ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

AWSRequest ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Associated Types

type AWSResponse ListDataSources #

Generic ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Associated Types

type Rep ListDataSources :: Type -> Type #

Read ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Show ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

NFData ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

rnf :: ListDataSources -> () #

Eq ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Hashable ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

type AWSResponse ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

type Rep ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

type Rep ListDataSources = D1 ('MetaData "ListDataSources" "Amazonka.Kendra.ListDataSources" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListDataSources'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListDataSources Source #

Create a value of ListDataSources with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListDataSources, listDataSources_maxResults - The maximum number of data source connectors to return.

ListDataSources, listDataSources_nextToken - 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.

$sel:indexId:ListDataSources', listDataSources_indexId - The identifier of the index used with one or more data source connectors.

data ListDataSourcesResponse Source #

See: newListDataSourcesResponse smart constructor.

Instances

Instances details
Generic ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Associated Types

type Rep ListDataSourcesResponse :: Type -> Type #

Read ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Show ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

NFData ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

rnf :: ListDataSourcesResponse -> () #

Eq ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

type Rep ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

type Rep ListDataSourcesResponse = D1 ('MetaData "ListDataSourcesResponse" "Amazonka.Kendra.ListDataSources" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListDataSourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSourceSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDataSourcesResponse Source #

Create a value of ListDataSourcesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListDataSources, listDataSourcesResponse_nextToken - 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.

$sel:summaryItems:ListDataSourcesResponse', listDataSourcesResponse_summaryItems - An array of summary information for one or more data source connector.

$sel:httpStatus:ListDataSourcesResponse', listDataSourcesResponse_httpStatus - The response's http status code.

ListEntityPersonas

data ListEntityPersonas Source #

See: newListEntityPersonas smart constructor.

Instances

Instances details
ToJSON ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

ToHeaders ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

ToPath ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

ToQuery ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

AWSRequest ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

Associated Types

type AWSResponse ListEntityPersonas #

Generic ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

Associated Types

type Rep ListEntityPersonas :: Type -> Type #

Read ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

Show ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

NFData ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

Methods

rnf :: ListEntityPersonas -> () #

Eq ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

Hashable ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

type AWSResponse ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

type Rep ListEntityPersonas Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

type Rep ListEntityPersonas = D1 ('MetaData "ListEntityPersonas" "Amazonka.Kendra.ListEntityPersonas" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListEntityPersonas'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListEntityPersonas Source #

Create a value of ListEntityPersonas with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListEntityPersonas, listEntityPersonas_maxResults - The maximum number of returned users or groups.

ListEntityPersonas, listEntityPersonas_nextToken - 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, listEntityPersonas_id - The identifier of your Amazon Kendra experience.

$sel:indexId:ListEntityPersonas', listEntityPersonas_indexId - The identifier of the index for your Amazon Kendra experience.

data ListEntityPersonasResponse Source #

See: newListEntityPersonasResponse smart constructor.

Instances

Instances details
Generic ListEntityPersonasResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

Associated Types

type Rep ListEntityPersonasResponse :: Type -> Type #

Read ListEntityPersonasResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

Show ListEntityPersonasResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

NFData ListEntityPersonasResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

Eq ListEntityPersonasResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

type Rep ListEntityPersonasResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListEntityPersonas

type Rep ListEntityPersonasResponse = D1 ('MetaData "ListEntityPersonasResponse" "Amazonka.Kendra.ListEntityPersonas" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListEntityPersonasResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PersonasSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEntityPersonasResponse Source #

Create a value of ListEntityPersonasResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListEntityPersonas, listEntityPersonasResponse_nextToken - 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.

$sel:summaryItems:ListEntityPersonasResponse', listEntityPersonasResponse_summaryItems - An array of summary information for one or more users or groups.

$sel:httpStatus:ListEntityPersonasResponse', listEntityPersonasResponse_httpStatus - The response's http status code.

ListExperienceEntities

data ListExperienceEntities Source #

See: newListExperienceEntities smart constructor.

Instances

Instances details
ToJSON ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

ToHeaders ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

ToPath ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

ToQuery ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

AWSRequest ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

Associated Types

type AWSResponse ListExperienceEntities #

Generic ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

Associated Types

type Rep ListExperienceEntities :: Type -> Type #

Read ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

Show ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

NFData ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

Methods

rnf :: ListExperienceEntities -> () #

Eq ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

Hashable ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

type AWSResponse ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

type Rep ListExperienceEntities Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

type Rep ListExperienceEntities = D1 ('MetaData "ListExperienceEntities" "Amazonka.Kendra.ListExperienceEntities" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListExperienceEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListExperienceEntities Source #

Create a value of ListExperienceEntities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListExperienceEntities, listExperienceEntities_nextToken - 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, listExperienceEntities_id - The identifier of your Amazon Kendra experience.

$sel:indexId:ListExperienceEntities', listExperienceEntities_indexId - The identifier of the index for your Amazon Kendra experience.

data ListExperienceEntitiesResponse Source #

See: newListExperienceEntitiesResponse smart constructor.

Instances

Instances details
Generic ListExperienceEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

Associated Types

type Rep ListExperienceEntitiesResponse :: Type -> Type #

Show ListExperienceEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

NFData ListExperienceEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

Eq ListExperienceEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

type Rep ListExperienceEntitiesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperienceEntities

type Rep ListExperienceEntitiesResponse = D1 ('MetaData "ListExperienceEntitiesResponse" "Amazonka.Kendra.ListExperienceEntities" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListExperienceEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExperienceEntitiesSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListExperienceEntitiesResponse Source #

Create a value of ListExperienceEntitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListExperienceEntities, listExperienceEntitiesResponse_nextToken - 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.

$sel:summaryItems:ListExperienceEntitiesResponse', listExperienceEntitiesResponse_summaryItems - An array of summary information for one or more users or groups.

$sel:httpStatus:ListExperienceEntitiesResponse', listExperienceEntitiesResponse_httpStatus - The response's http status code.

ListExperiences

data ListExperiences Source #

See: newListExperiences smart constructor.

Instances

Instances details
ToJSON ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

ToHeaders ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

ToPath ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

ToQuery ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

AWSRequest ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

Associated Types

type AWSResponse ListExperiences #

Generic ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

Associated Types

type Rep ListExperiences :: Type -> Type #

Read ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

Show ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

NFData ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

Methods

rnf :: ListExperiences -> () #

Eq ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

Hashable ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

type AWSResponse ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

type Rep ListExperiences Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

type Rep ListExperiences = D1 ('MetaData "ListExperiences" "Amazonka.Kendra.ListExperiences" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListExperiences'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListExperiences Source #

Create a value of ListExperiences with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListExperiences, listExperiences_maxResults - The maximum number of returned Amazon Kendra experiences.

ListExperiences, listExperiences_nextToken - 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.

$sel:indexId:ListExperiences', listExperiences_indexId - The identifier of the index for your Amazon Kendra experience.

data ListExperiencesResponse Source #

See: newListExperiencesResponse smart constructor.

Instances

Instances details
Generic ListExperiencesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

Associated Types

type Rep ListExperiencesResponse :: Type -> Type #

Read ListExperiencesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

Show ListExperiencesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

NFData ListExperiencesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

Methods

rnf :: ListExperiencesResponse -> () #

Eq ListExperiencesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

type Rep ListExperiencesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListExperiences

type Rep ListExperiencesResponse = D1 ('MetaData "ListExperiencesResponse" "Amazonka.Kendra.ListExperiences" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListExperiencesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExperiencesSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListExperiencesResponse Source #

Create a value of ListExperiencesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListExperiences, listExperiencesResponse_nextToken - 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.

$sel:summaryItems:ListExperiencesResponse', listExperiencesResponse_summaryItems - An array of summary information for one or more Amazon Kendra experiences.

$sel:httpStatus:ListExperiencesResponse', listExperiencesResponse_httpStatus - The response's http status code.

ListFaqs

data ListFaqs Source #

See: newListFaqs smart constructor.

Constructors

ListFaqs' (Maybe Natural) (Maybe Text) Text 

Instances

Instances details
ToJSON ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

ToHeaders ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Methods

toHeaders :: ListFaqs -> [Header] #

ToPath ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

ToQuery ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

AWSRequest ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Associated Types

type AWSResponse ListFaqs #

Generic ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Associated Types

type Rep ListFaqs :: Type -> Type #

Methods

from :: ListFaqs -> Rep ListFaqs x #

to :: Rep ListFaqs x -> ListFaqs #

Read ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Show ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

NFData ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Methods

rnf :: ListFaqs -> () #

Eq ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Hashable ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Methods

hashWithSalt :: Int -> ListFaqs -> Int #

hash :: ListFaqs -> Int #

type AWSResponse ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

type Rep ListFaqs Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

type Rep ListFaqs = D1 ('MetaData "ListFaqs" "Amazonka.Kendra.ListFaqs" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListFaqs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListFaqs Source #

Create a value of ListFaqs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListFaqs, listFaqs_maxResults - 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, listFaqs_nextToken - 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.

$sel:indexId:ListFaqs', listFaqs_indexId - The index that contains the FAQ lists.

data ListFaqsResponse Source #

See: newListFaqsResponse smart constructor.

Instances

Instances details
Generic ListFaqsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Associated Types

type Rep ListFaqsResponse :: Type -> Type #

Read ListFaqsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Show ListFaqsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

NFData ListFaqsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

Methods

rnf :: ListFaqsResponse -> () #

Eq ListFaqsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

type Rep ListFaqsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListFaqs

type Rep ListFaqsResponse = D1 ('MetaData "ListFaqsResponse" "Amazonka.Kendra.ListFaqs" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListFaqsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "faqSummaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FaqSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFaqsResponse Source #

Create a value of ListFaqsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:faqSummaryItems:ListFaqsResponse', listFaqsResponse_faqSummaryItems - information about the FAQs associated with the specified index.

ListFaqs, listFaqsResponse_nextToken - 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.

$sel:httpStatus:ListFaqsResponse', listFaqsResponse_httpStatus - The response's http status code.

ListGroupsOlderThanOrderingId

data ListGroupsOlderThanOrderingId Source #

See: newListGroupsOlderThanOrderingId smart constructor.

Instances

Instances details
ToJSON ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

ToHeaders ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

ToPath ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

ToQuery ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

AWSRequest ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

Generic ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

Associated Types

type Rep ListGroupsOlderThanOrderingId :: Type -> Type #

Read ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

Show ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

NFData ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

Eq ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

Hashable ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

type AWSResponse ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

type Rep ListGroupsOlderThanOrderingId Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

type Rep ListGroupsOlderThanOrderingId = D1 ('MetaData "ListGroupsOlderThanOrderingId" "Amazonka.Kendra.ListGroupsOlderThanOrderingId" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListGroupsOlderThanOrderingId'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "orderingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newListGroupsOlderThanOrderingId Source #

Create a value of ListGroupsOlderThanOrderingId with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

ListGroupsOlderThanOrderingId, listGroupsOlderThanOrderingId_nextToken - 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.

$sel:indexId:ListGroupsOlderThanOrderingId', listGroupsOlderThanOrderingId_indexId - The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.

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

data ListGroupsOlderThanOrderingIdResponse Source #

Instances

Instances details
Generic ListGroupsOlderThanOrderingIdResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

Read ListGroupsOlderThanOrderingIdResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

Show ListGroupsOlderThanOrderingIdResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

NFData ListGroupsOlderThanOrderingIdResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

Eq ListGroupsOlderThanOrderingIdResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

type Rep ListGroupsOlderThanOrderingIdResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListGroupsOlderThanOrderingId

type Rep ListGroupsOlderThanOrderingIdResponse = D1 ('MetaData "ListGroupsOlderThanOrderingIdResponse" "Amazonka.Kendra.ListGroupsOlderThanOrderingId" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListGroupsOlderThanOrderingIdResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupsSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGroupsOlderThanOrderingIdResponse Source #

Create a value of ListGroupsOlderThanOrderingIdResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groupsSummaries:ListGroupsOlderThanOrderingIdResponse', listGroupsOlderThanOrderingIdResponse_groupsSummaries - Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.

ListGroupsOlderThanOrderingId, listGroupsOlderThanOrderingIdResponse_nextToken - 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.

$sel:httpStatus:ListGroupsOlderThanOrderingIdResponse', listGroupsOlderThanOrderingIdResponse_httpStatus - The response's http status code.

ListIndices

data ListIndices Source #

See: newListIndices smart constructor.

Constructors

ListIndices' (Maybe Natural) (Maybe Text) 

Instances

Instances details
ToJSON ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

ToHeaders ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Methods

toHeaders :: ListIndices -> [Header] #

ToPath ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

ToQuery ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

AWSRequest ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Associated Types

type AWSResponse ListIndices #

Generic ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Associated Types

type Rep ListIndices :: Type -> Type #

Read ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Show ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

NFData ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Methods

rnf :: ListIndices -> () #

Eq ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Hashable ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

type AWSResponse ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

type Rep ListIndices Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

type Rep ListIndices = D1 ('MetaData "ListIndices" "Amazonka.Kendra.ListIndices" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListIndices'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListIndices :: ListIndices Source #

Create a value of ListIndices with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListIndices, listIndices_maxResults - The maximum number of indices to return.

ListIndices, listIndices_nextToken - 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.

data ListIndicesResponse Source #

See: newListIndicesResponse smart constructor.

Instances

Instances details
Generic ListIndicesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Associated Types

type Rep ListIndicesResponse :: Type -> Type #

Read ListIndicesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Show ListIndicesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

NFData ListIndicesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

Methods

rnf :: ListIndicesResponse -> () #

Eq ListIndicesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

type Rep ListIndicesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListIndices

type Rep ListIndicesResponse = D1 ('MetaData "ListIndicesResponse" "Amazonka.Kendra.ListIndices" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListIndicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexConfigurationSummaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IndexConfigurationSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListIndicesResponse Source #

Create a value of ListIndicesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexConfigurationSummaryItems:ListIndicesResponse', listIndicesResponse_indexConfigurationSummaryItems - An array of summary information on the configuration of one or more indexes.

ListIndices, listIndicesResponse_nextToken - 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.

$sel:httpStatus:ListIndicesResponse', listIndicesResponse_httpStatus - The response's http status code.

ListQuerySuggestionsBlockLists

data ListQuerySuggestionsBlockLists Source #

See: newListQuerySuggestionsBlockLists smart constructor.

Instances

Instances details
ToJSON ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

ToHeaders ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

ToPath ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

ToQuery ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

AWSRequest ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

Generic ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

Associated Types

type Rep ListQuerySuggestionsBlockLists :: Type -> Type #

Read ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

Show ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

NFData ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

Eq ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

Hashable ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

type AWSResponse ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

type Rep ListQuerySuggestionsBlockLists Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

type Rep ListQuerySuggestionsBlockLists = D1 ('MetaData "ListQuerySuggestionsBlockLists" "Amazonka.Kendra.ListQuerySuggestionsBlockLists" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListQuerySuggestionsBlockLists'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListQuerySuggestionsBlockLists Source #

Create a value of ListQuerySuggestionsBlockLists with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListQuerySuggestionsBlockLists, listQuerySuggestionsBlockLists_maxResults - The maximum number of block lists to return.

ListQuerySuggestionsBlockLists, listQuerySuggestionsBlockLists_nextToken - 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).

$sel:indexId:ListQuerySuggestionsBlockLists', listQuerySuggestionsBlockLists_indexId - 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.

data ListQuerySuggestionsBlockListsResponse Source #

Instances

Instances details
Generic ListQuerySuggestionsBlockListsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

Read ListQuerySuggestionsBlockListsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

Show ListQuerySuggestionsBlockListsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

NFData ListQuerySuggestionsBlockListsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

Eq ListQuerySuggestionsBlockListsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

type Rep ListQuerySuggestionsBlockListsResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListQuerySuggestionsBlockLists

type Rep ListQuerySuggestionsBlockListsResponse = D1 ('MetaData "ListQuerySuggestionsBlockListsResponse" "Amazonka.Kendra.ListQuerySuggestionsBlockLists" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListQuerySuggestionsBlockListsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blockListSummaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QuerySuggestionsBlockListSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListQuerySuggestionsBlockListsResponse Source #

Create a value of ListQuerySuggestionsBlockListsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:blockListSummaryItems:ListQuerySuggestionsBlockListsResponse', listQuerySuggestionsBlockListsResponse_blockListSummaryItems - 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.

ListQuerySuggestionsBlockLists, listQuerySuggestionsBlockListsResponse_nextToken - 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.

$sel:httpStatus:ListQuerySuggestionsBlockListsResponse', listQuerySuggestionsBlockListsResponse_httpStatus - The response's http status code.

ListTagsForResource

data ListTagsForResource Source #

See: newListTagsForResource smart constructor.

Instances

Instances details
ToJSON ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

ToHeaders ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

ToPath ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

ToQuery ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

AWSRequest ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

Associated Types

type AWSResponse ListTagsForResource #

Generic ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

Associated Types

type Rep ListTagsForResource :: Type -> Type #

Read ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

Show ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

NFData ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

Methods

rnf :: ListTagsForResource -> () #

Eq ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

Hashable ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

type AWSResponse ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

type Rep ListTagsForResource Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

type Rep ListTagsForResource = D1 ('MetaData "ListTagsForResource" "Amazonka.Kendra.ListTagsForResource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListTagsForResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newListTagsForResource Source #

Create a value of ListTagsForResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceARN:ListTagsForResource', listTagsForResource_resourceARN - The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for.

data ListTagsForResourceResponse Source #

See: newListTagsForResourceResponse smart constructor.

Instances

Instances details
Generic ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

Associated Types

type Rep ListTagsForResourceResponse :: Type -> Type #

Read ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

Show ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

NFData ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

Eq ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

type Rep ListTagsForResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListTagsForResource

type Rep ListTagsForResourceResponse = D1 ('MetaData "ListTagsForResourceResponse" "Amazonka.Kendra.ListTagsForResource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListTagsForResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newListTagsForResourceResponse Source #

Create a value of ListTagsForResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - A list of tags associated with the index, FAQ, or data source.

$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.

ListThesauri

data ListThesauri Source #

See: newListThesauri smart constructor.

Instances

Instances details
ToJSON ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

ToHeaders ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

ToPath ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

ToQuery ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

AWSRequest ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

Associated Types

type AWSResponse ListThesauri #

Generic ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

Associated Types

type Rep ListThesauri :: Type -> Type #

Read ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

Show ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

NFData ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

Methods

rnf :: ListThesauri -> () #

Eq ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

Hashable ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

type AWSResponse ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

type Rep ListThesauri Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

type Rep ListThesauri = D1 ('MetaData "ListThesauri" "Amazonka.Kendra.ListThesauri" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListThesauri'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListThesauri Source #

Create a value of ListThesauri with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListThesauri, listThesauri_maxResults - The maximum number of thesauri to return.

ListThesauri, listThesauri_nextToken - 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).

$sel:indexId:ListThesauri', listThesauri_indexId - The identifier of the index with one or more thesauri.

data ListThesauriResponse Source #

See: newListThesauriResponse smart constructor.

Instances

Instances details
Generic ListThesauriResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

Associated Types

type Rep ListThesauriResponse :: Type -> Type #

Read ListThesauriResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

Show ListThesauriResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

NFData ListThesauriResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

Methods

rnf :: ListThesauriResponse -> () #

Eq ListThesauriResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

type Rep ListThesauriResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListThesauri

type Rep ListThesauriResponse = D1 ('MetaData "ListThesauriResponse" "Amazonka.Kendra.ListThesauri" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListThesauriResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "thesaurusSummaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ThesaurusSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListThesauriResponse Source #

Create a value of ListThesauriResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListThesauri, listThesauriResponse_nextToken - 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.

$sel:thesaurusSummaryItems:ListThesauriResponse', listThesauriResponse_thesaurusSummaryItems - An array of summary information for a thesaurus or multiple thesauri.

$sel:httpStatus:ListThesauriResponse', listThesauriResponse_httpStatus - The response's http status code.

PutPrincipalMapping

data PutPrincipalMapping Source #

See: newPutPrincipalMapping smart constructor.

Instances

Instances details
ToJSON PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

ToHeaders PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

ToPath PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

ToQuery PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

AWSRequest PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

Associated Types

type AWSResponse PutPrincipalMapping #

Generic PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

Associated Types

type Rep PutPrincipalMapping :: Type -> Type #

Read PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

Show PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

NFData PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

Methods

rnf :: PutPrincipalMapping -> () #

Eq PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

Hashable PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

type AWSResponse PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

type Rep PutPrincipalMapping Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

type Rep PutPrincipalMapping = D1 ('MetaData "PutPrincipalMapping" "Amazonka.Kendra.PutPrincipalMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "PutPrincipalMapping'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "orderingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GroupMembers)))))

newPutPrincipalMapping Source #

Create a value of PutPrincipalMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutPrincipalMapping, putPrincipalMapping_dataSourceId - 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, putPrincipalMapping_orderingId - 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, putPrincipalMapping_roleArn - 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.

$sel:indexId:PutPrincipalMapping', putPrincipalMapping_indexId - The identifier of the index you want to map users to their groups.

PutPrincipalMapping, putPrincipalMapping_groupId - The identifier of the group you want to map its users to.

$sel:groupMembers:PutPrincipalMapping', putPrincipalMapping_groupMembers - 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.

data PutPrincipalMappingResponse Source #

See: newPutPrincipalMappingResponse smart constructor.

Instances

Instances details
Generic PutPrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

Associated Types

type Rep PutPrincipalMappingResponse :: Type -> Type #

Read PutPrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

Show PutPrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

NFData PutPrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

Eq PutPrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

type Rep PutPrincipalMappingResponse Source # 
Instance details

Defined in Amazonka.Kendra.PutPrincipalMapping

type Rep PutPrincipalMappingResponse = D1 ('MetaData "PutPrincipalMappingResponse" "Amazonka.Kendra.PutPrincipalMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "PutPrincipalMappingResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutPrincipalMappingResponse :: PutPrincipalMappingResponse Source #

Create a value of PutPrincipalMappingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Query

data Query Source #

See: newQuery smart constructor.

Instances

Instances details
ToJSON Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

ToHeaders Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Methods

toHeaders :: Query -> [Header] #

ToPath Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Methods

toPath :: Query -> ByteString #

ToQuery Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Methods

toQuery :: Query -> QueryString #

AWSRequest Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Associated Types

type AWSResponse Query #

Generic Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Associated Types

type Rep Query :: Type -> Type #

Methods

from :: Query -> Rep Query x #

to :: Rep Query x -> Query #

Read Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Show Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Methods

showsPrec :: Int -> Query -> ShowS #

show :: Query -> String #

showList :: [Query] -> ShowS #

NFData Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Methods

rnf :: Query -> () #

Eq Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Methods

(==) :: Query -> Query -> Bool #

(/=) :: Query -> Query -> Bool #

Hashable Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

Methods

hashWithSalt :: Int -> Query -> Int #

hash :: Query -> Int #

type AWSResponse Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

type Rep Query Source # 
Instance details

Defined in Amazonka.Kendra.Query

type Rep Query = D1 ('MetaData "Query" "Amazonka.Kendra.Query" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Query'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attributeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeFilter)) :*: (S1 ('MetaSel ('Just "documentRelevanceOverrideConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentRelevanceConfiguration])) :*: S1 ('MetaSel ('Just "facets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Facet])))) :*: (S1 ('MetaSel ('Just "pageNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "queryResultTypeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryResultType))))) :*: ((S1 ('MetaSel ('Just "queryText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "requestedDocumentAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "sortingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortingConfiguration)))) :*: ((S1 ('MetaSel ('Just "spellCorrectionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpellCorrectionConfiguration)) :*: S1 ('MetaSel ('Just "userContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext))) :*: (S1 ('MetaSel ('Just "visitorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newQuery Source #

Create a value of Query with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributeFilter:Query', query_attributeFilter - 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.

$sel:documentRelevanceOverrideConfigurations:Query', query_documentRelevanceOverrideConfigurations - 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, query_facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.

$sel:pageNumber:Query', query_pageNumber - 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.

$sel:pageSize:Query', query_pageSize - 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.

$sel:queryResultTypeFilter:Query', query_queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.

$sel:queryText:Query', query_queryText - 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.

$sel:requestedDocumentAttributes:Query', query_requestedDocumentAttributes - 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.

$sel:sortingConfiguration:Query', query_sortingConfiguration - 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.

$sel:spellCorrectionConfiguration:Query', query_spellCorrectionConfiguration - Enables suggested spell corrections for queries.

$sel:userContext:Query', query_userContext - The user context token or user and group information.

$sel:visitorId:Query', query_visitorId - 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.

$sel:indexId:Query', query_indexId - The identifier of the index to search. The identifier is returned in the response from the CreateIndex API.

data QueryResponse Source #

See: newQueryResponse smart constructor.

Instances

Instances details
Generic QueryResponse Source # 
Instance details

Defined in Amazonka.Kendra.Query

Associated Types

type Rep QueryResponse :: Type -> Type #

Read QueryResponse Source # 
Instance details

Defined in Amazonka.Kendra.Query

Show QueryResponse Source # 
Instance details

Defined in Amazonka.Kendra.Query

NFData QueryResponse Source # 
Instance details

Defined in Amazonka.Kendra.Query

Methods

rnf :: QueryResponse -> () #

Eq QueryResponse Source # 
Instance details

Defined in Amazonka.Kendra.Query

type Rep QueryResponse Source # 
Instance details

Defined in Amazonka.Kendra.Query

newQueryResponse Source #

Create a value of QueryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:queryId:QueryResponse', queryResponse_queryId - The identifier for the search. You use QueryId to identify the search when using the feedback API.

$sel:resultItems:QueryResponse', queryResponse_resultItems - The results of the search.

$sel:spellCorrectedQueries:QueryResponse', queryResponse_spellCorrectedQueries - A list of information related to suggested spell corrections for a query.

$sel:totalNumberOfResults:QueryResponse', queryResponse_totalNumberOfResults - 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.

$sel:warnings:QueryResponse', queryResponse_warnings - 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.

$sel:httpStatus:QueryResponse', queryResponse_httpStatus - The response's http status code.

StartDataSourceSyncJob

data StartDataSourceSyncJob Source #

See: newStartDataSourceSyncJob smart constructor.

Instances

Instances details
ToJSON StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

ToHeaders StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

ToPath StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

ToQuery StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

AWSRequest StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

Associated Types

type AWSResponse StartDataSourceSyncJob #

Generic StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

Associated Types

type Rep StartDataSourceSyncJob :: Type -> Type #

Read StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

Show StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

NFData StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

Methods

rnf :: StartDataSourceSyncJob -> () #

Eq StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

Hashable StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

type AWSResponse StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

type Rep StartDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

type Rep StartDataSourceSyncJob = D1 ('MetaData "StartDataSourceSyncJob" "Amazonka.Kendra.StartDataSourceSyncJob" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "StartDataSourceSyncJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartDataSourceSyncJob Source #

Create a value of StartDataSourceSyncJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartDataSourceSyncJob, startDataSourceSyncJob_id - The identifier of the data source connector to synchronize.

$sel:indexId:StartDataSourceSyncJob', startDataSourceSyncJob_indexId - The identifier of the index used with the data source connector.

data StartDataSourceSyncJobResponse Source #

See: newStartDataSourceSyncJobResponse smart constructor.

Instances

Instances details
Generic StartDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

Associated Types

type Rep StartDataSourceSyncJobResponse :: Type -> Type #

Read StartDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

Show StartDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

NFData StartDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

Eq StartDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

type Rep StartDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StartDataSourceSyncJob

type Rep StartDataSourceSyncJobResponse = D1 ('MetaData "StartDataSourceSyncJobResponse" "Amazonka.Kendra.StartDataSourceSyncJob" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "StartDataSourceSyncJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartDataSourceSyncJobResponse Source #

Create a value of StartDataSourceSyncJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartDataSourceSyncJobResponse, startDataSourceSyncJobResponse_executionId - Identifies a particular synchronization job.

$sel:httpStatus:StartDataSourceSyncJobResponse', startDataSourceSyncJobResponse_httpStatus - The response's http status code.

StopDataSourceSyncJob

data StopDataSourceSyncJob Source #

See: newStopDataSourceSyncJob smart constructor.

Instances

Instances details
ToJSON StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

ToHeaders StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

ToPath StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

ToQuery StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

AWSRequest StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

Associated Types

type AWSResponse StopDataSourceSyncJob #

Generic StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

Associated Types

type Rep StopDataSourceSyncJob :: Type -> Type #

Read StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

Show StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

NFData StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

Methods

rnf :: StopDataSourceSyncJob -> () #

Eq StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

Hashable StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

type AWSResponse StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

type Rep StopDataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

type Rep StopDataSourceSyncJob = D1 ('MetaData "StopDataSourceSyncJob" "Amazonka.Kendra.StopDataSourceSyncJob" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "StopDataSourceSyncJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopDataSourceSyncJob Source #

Create a value of StopDataSourceSyncJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StopDataSourceSyncJob, stopDataSourceSyncJob_id - The identifier of the data source connector for which to stop the synchronization jobs.

$sel:indexId:StopDataSourceSyncJob', stopDataSourceSyncJob_indexId - The identifier of the index used with the data source connector.

data StopDataSourceSyncJobResponse Source #

See: newStopDataSourceSyncJobResponse smart constructor.

Instances

Instances details
Generic StopDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

Associated Types

type Rep StopDataSourceSyncJobResponse :: Type -> Type #

Read StopDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

Show StopDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

NFData StopDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

Eq StopDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

type Rep StopDataSourceSyncJobResponse Source # 
Instance details

Defined in Amazonka.Kendra.StopDataSourceSyncJob

type Rep StopDataSourceSyncJobResponse = D1 ('MetaData "StopDataSourceSyncJobResponse" "Amazonka.Kendra.StopDataSourceSyncJob" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "StopDataSourceSyncJobResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStopDataSourceSyncJobResponse :: StopDataSourceSyncJobResponse Source #

Create a value of StopDataSourceSyncJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

SubmitFeedback

data SubmitFeedback Source #

See: newSubmitFeedback smart constructor.

Instances

Instances details
ToJSON SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

ToHeaders SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

ToPath SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

ToQuery SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

AWSRequest SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

Associated Types

type AWSResponse SubmitFeedback #

Generic SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

Associated Types

type Rep SubmitFeedback :: Type -> Type #

Read SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

Show SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

NFData SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

Methods

rnf :: SubmitFeedback -> () #

Eq SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

Hashable SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

type AWSResponse SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

type Rep SubmitFeedback Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

type Rep SubmitFeedback = D1 ('MetaData "SubmitFeedback" "Amazonka.Kendra.SubmitFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SubmitFeedback'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clickFeedbackItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClickFeedback])) :*: S1 ('MetaSel ('Just "relevanceFeedbackItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RelevanceFeedback]))) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSubmitFeedback Source #

Create a value of SubmitFeedback with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clickFeedbackItems:SubmitFeedback', submitFeedback_clickFeedbackItems - Tells Amazon Kendra that a particular search result link was chosen by the user.

$sel:relevanceFeedbackItems:SubmitFeedback', submitFeedback_relevanceFeedbackItems - Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

$sel:indexId:SubmitFeedback', submitFeedback_indexId - The identifier of the index that was queried.

$sel:queryId:SubmitFeedback', submitFeedback_queryId - The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

data SubmitFeedbackResponse Source #

See: newSubmitFeedbackResponse smart constructor.

Instances

Instances details
Generic SubmitFeedbackResponse Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

Associated Types

type Rep SubmitFeedbackResponse :: Type -> Type #

Read SubmitFeedbackResponse Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

Show SubmitFeedbackResponse Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

NFData SubmitFeedbackResponse Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

Methods

rnf :: SubmitFeedbackResponse -> () #

Eq SubmitFeedbackResponse Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

type Rep SubmitFeedbackResponse Source # 
Instance details

Defined in Amazonka.Kendra.SubmitFeedback

type Rep SubmitFeedbackResponse = D1 ('MetaData "SubmitFeedbackResponse" "Amazonka.Kendra.SubmitFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SubmitFeedbackResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSubmitFeedbackResponse :: SubmitFeedbackResponse Source #

Create a value of SubmitFeedbackResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

TagResource

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource' Text [Tag] 

Instances

Instances details
ToJSON TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

ToHeaders TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Methods

toHeaders :: TagResource -> [Header] #

ToPath TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

ToQuery TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

AWSRequest TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Associated Types

type AWSResponse TagResource #

Generic TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Associated Types

type Rep TagResource :: Type -> Type #

Read TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Show TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

NFData TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Methods

rnf :: TagResource -> () #

Eq TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Hashable TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

type AWSResponse TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

type Rep TagResource Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Kendra.TagResource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))

newTagResource Source #

Create a value of TagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceARN:TagResource', tagResource_resourceARN - The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.

$sel:tags:TagResource', tagResource_tags - 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.

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Instances

Instances details
Generic TagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type #

Read TagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Show TagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

NFData TagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

Methods

rnf :: TagResourceResponse -> () #

Eq TagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

type Rep TagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.Kendra.TagResource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.

UntagResource

data UntagResource Source #

See: newUntagResource smart constructor.

Constructors

UntagResource' Text [Text] 

Instances

Instances details
ToJSON UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

ToHeaders UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

ToPath UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

ToQuery UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

AWSRequest UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

Associated Types

type AWSResponse UntagResource #

Generic UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

Associated Types

type Rep UntagResource :: Type -> Type #

Read UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

Show UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

NFData UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

Methods

rnf :: UntagResource -> () #

Eq UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

Hashable UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

type AWSResponse UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

type Rep UntagResource Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.Kendra.UntagResource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newUntagResource Source #

Create a value of UntagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceARN:UntagResource', untagResource_resourceARN - The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from.

$sel:tagKeys:UntagResource', untagResource_tagKeys - 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.

data UntagResourceResponse Source #

See: newUntagResourceResponse smart constructor.

Instances

Instances details
Generic UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

Associated Types

type Rep UntagResourceResponse :: Type -> Type #

Read UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

Show UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

NFData UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

Methods

rnf :: UntagResourceResponse -> () #

Eq UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

type Rep UntagResourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UntagResource

type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.Kendra.UntagResource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUntagResourceResponse Source #

Create a value of UntagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.

UpdateAccessControlConfiguration

data UpdateAccessControlConfiguration Source #

See: newUpdateAccessControlConfiguration smart constructor.

Instances

Instances details
ToJSON UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

ToHeaders UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

ToPath UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

ToQuery UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

AWSRequest UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

Generic UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

Associated Types

type Rep UpdateAccessControlConfiguration :: Type -> Type #

Read UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

Show UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

NFData UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

Eq UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

Hashable UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

type AWSResponse UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

type Rep UpdateAccessControlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

type Rep UpdateAccessControlConfiguration = D1 ('MetaData "UpdateAccessControlConfiguration" "Amazonka.Kendra.UpdateAccessControlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateAccessControlConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Principal])) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hierarchicalAccessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HierarchicalPrincipal))))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateAccessControlConfiguration Source #

Create a value of UpdateAccessControlConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateAccessControlConfiguration, updateAccessControlConfiguration_accessControlList - 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.

$sel:description:UpdateAccessControlConfiguration', updateAccessControlConfiguration_description - A new description for the access control configuration.

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

UpdateAccessControlConfiguration, updateAccessControlConfiguration_name - A new name for the access control configuration.

$sel:indexId:UpdateAccessControlConfiguration', updateAccessControlConfiguration_indexId - The identifier of the index for an access control configuration.

UpdateAccessControlConfiguration, updateAccessControlConfiguration_id - The identifier of the access control configuration you want to update.

data UpdateAccessControlConfigurationResponse Source #

Instances

Instances details
Generic UpdateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

Read UpdateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

Show UpdateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

NFData UpdateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

Eq UpdateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

type Rep UpdateAccessControlConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateAccessControlConfiguration

type Rep UpdateAccessControlConfigurationResponse = D1 ('MetaData "UpdateAccessControlConfigurationResponse" "Amazonka.Kendra.UpdateAccessControlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateAccessControlConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateAccessControlConfigurationResponse Source #

Create a value of UpdateAccessControlConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateAccessControlConfigurationResponse', updateAccessControlConfigurationResponse_httpStatus - The response's http status code.

UpdateDataSource

data UpdateDataSource Source #

See: newUpdateDataSource smart constructor.

Instances

Instances details
ToJSON UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

ToHeaders UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

ToPath UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

ToQuery UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

AWSRequest UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

Associated Types

type AWSResponse UpdateDataSource #

Generic UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

Associated Types

type Rep UpdateDataSource :: Type -> Type #

Read UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

Show UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

NFData UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

Methods

rnf :: UpdateDataSource -> () #

Eq UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

Hashable UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

type AWSResponse UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

type Rep UpdateDataSource Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

newUpdateDataSource Source #

Create a value of UpdateDataSource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configuration:UpdateDataSource', updateDataSource_configuration - Configuration information you want to update for the data source connector.

$sel:customDocumentEnrichmentConfiguration:UpdateDataSource', updateDataSource_customDocumentEnrichmentConfiguration - 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.

$sel:description:UpdateDataSource', updateDataSource_description - A new description for the data source connector.

UpdateDataSource, updateDataSource_languageCode - 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, updateDataSource_name - A new name for the data source connector.

UpdateDataSource, updateDataSource_roleArn - 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.

$sel:schedule:UpdateDataSource', updateDataSource_schedule - The sync schedule you want to update for the data source connector.

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

UpdateDataSource, updateDataSource_id - The identifier of the data source connector you want to update.

$sel:indexId:UpdateDataSource', updateDataSource_indexId - The identifier of the index used with the data source connector.

data UpdateDataSourceResponse Source #

See: newUpdateDataSourceResponse smart constructor.

Instances

Instances details
Generic UpdateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

Associated Types

type Rep UpdateDataSourceResponse :: Type -> Type #

Read UpdateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

Show UpdateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

NFData UpdateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

Eq UpdateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

type Rep UpdateDataSourceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateDataSource

type Rep UpdateDataSourceResponse = D1 ('MetaData "UpdateDataSourceResponse" "Amazonka.Kendra.UpdateDataSource" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateDataSourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateDataSourceResponse :: UpdateDataSourceResponse Source #

Create a value of UpdateDataSourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateExperience

data UpdateExperience Source #

See: newUpdateExperience smart constructor.

Instances

Instances details
ToJSON UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

ToHeaders UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

ToPath UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

ToQuery UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

AWSRequest UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

Associated Types

type AWSResponse UpdateExperience #

Generic UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

Associated Types

type Rep UpdateExperience :: Type -> Type #

Read UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

Show UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

NFData UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

Methods

rnf :: UpdateExperience -> () #

Eq UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

Hashable UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

type AWSResponse UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

type Rep UpdateExperience Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

newUpdateExperience Source #

Create a value of UpdateExperience with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configuration:UpdateExperience', updateExperience_configuration - Configuration information you want to update for your Amazon Kendra experience.

$sel:description:UpdateExperience', updateExperience_description - A new description for your Amazon Kendra experience.

UpdateExperience, updateExperience_name - A new name for your Amazon Kendra experience.

UpdateExperience, updateExperience_roleArn - 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, updateExperience_id - The identifier of your Amazon Kendra experience you want to update.

$sel:indexId:UpdateExperience', updateExperience_indexId - The identifier of the index for your Amazon Kendra experience.

data UpdateExperienceResponse Source #

See: newUpdateExperienceResponse smart constructor.

Instances

Instances details
Generic UpdateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

Associated Types

type Rep UpdateExperienceResponse :: Type -> Type #

Read UpdateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

Show UpdateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

NFData UpdateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

Eq UpdateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

type Rep UpdateExperienceResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateExperience

type Rep UpdateExperienceResponse = D1 ('MetaData "UpdateExperienceResponse" "Amazonka.Kendra.UpdateExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateExperienceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateExperienceResponse :: UpdateExperienceResponse Source #

Create a value of UpdateExperienceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateIndex

data UpdateIndex Source #

See: newUpdateIndex smart constructor.

Instances

Instances details
ToJSON UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

ToHeaders UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

Methods

toHeaders :: UpdateIndex -> [Header] #

ToPath UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

ToQuery UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

AWSRequest UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

Associated Types

type AWSResponse UpdateIndex #

Generic UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

Associated Types

type Rep UpdateIndex :: Type -> Type #

Read UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

Show UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

NFData UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

Methods

rnf :: UpdateIndex -> () #

Eq UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

Hashable UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

type AWSResponse UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

type Rep UpdateIndex Source # 
Instance details

Defined in Amazonka.Kendra.UpdateIndex

newUpdateIndex Source #

Create a value of UpdateIndex with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:capacityUnits:UpdateIndex', updateIndex_capacityUnits - 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.

$sel:description:UpdateIndex', updateIndex_description - A new description for the index.

$sel:documentMetadataConfigurationUpdates:UpdateIndex', updateIndex_documentMetadataConfigurationUpdates - 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, updateIndex_name - The name of the index you want to update.

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

$sel:userContextPolicy:UpdateIndex', updateIndex_userContextPolicy - The user context policy.

$sel:userGroupResolutionConfiguration:UpdateIndex', updateIndex_userGroupResolutionConfiguration - 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.

$sel:userTokenConfigurations:UpdateIndex', updateIndex_userTokenConfigurations - The user token configuration.

UpdateIndex, updateIndex_id - The identifier of the index you want to update.

data UpdateIndexResponse Source #

See: newUpdateIndexResponse smart constructor.

Constructors

UpdateIndexResponse' 

newUpdateIndexResponse :: UpdateIndexResponse Source #

Create a value of UpdateIndexResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateQuerySuggestionsBlockList

data UpdateQuerySuggestionsBlockList Source #

See: newUpdateQuerySuggestionsBlockList smart constructor.

Instances

Instances details
ToJSON UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

ToHeaders UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

ToPath UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

ToQuery UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

AWSRequest UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

Generic UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

Associated Types

type Rep UpdateQuerySuggestionsBlockList :: Type -> Type #

Read UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

Show UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

NFData UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

Eq UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

Hashable UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

type AWSResponse UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

type Rep UpdateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

type Rep UpdateQuerySuggestionsBlockList = D1 ('MetaData "UpdateQuerySuggestionsBlockList" "Amazonka.Kendra.UpdateQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateQuerySuggestionsBlockList'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "sourceS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateQuerySuggestionsBlockList Source #

Create a value of UpdateQuerySuggestionsBlockList with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:UpdateQuerySuggestionsBlockList', updateQuerySuggestionsBlockList_description - A new description for the block list.

UpdateQuerySuggestionsBlockList, updateQuerySuggestionsBlockList_name - A new name for the block list.

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

$sel:sourceS3Path:UpdateQuerySuggestionsBlockList', updateQuerySuggestionsBlockList_sourceS3Path - 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.

$sel:indexId:UpdateQuerySuggestionsBlockList', updateQuerySuggestionsBlockList_indexId - The identifier of the index for the block list.

UpdateQuerySuggestionsBlockList, updateQuerySuggestionsBlockList_id - The identifier of the block list you want to update.

data UpdateQuerySuggestionsBlockListResponse Source #

Instances

Instances details
Generic UpdateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

Read UpdateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

Show UpdateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

NFData UpdateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

Eq UpdateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

type Rep UpdateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList

type Rep UpdateQuerySuggestionsBlockListResponse = D1 ('MetaData "UpdateQuerySuggestionsBlockListResponse" "Amazonka.Kendra.UpdateQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateQuerySuggestionsBlockListResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateQuerySuggestionsBlockListResponse :: UpdateQuerySuggestionsBlockListResponse Source #

Create a value of UpdateQuerySuggestionsBlockListResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateQuerySuggestionsConfig

data UpdateQuerySuggestionsConfig Source #

See: newUpdateQuerySuggestionsConfig smart constructor.

Instances

Instances details
ToJSON UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

ToHeaders UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

ToPath UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

ToQuery UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

AWSRequest UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

Generic UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

Associated Types

type Rep UpdateQuerySuggestionsConfig :: Type -> Type #

Read UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

Show UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

NFData UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

Eq UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

Hashable UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

type AWSResponse UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

type Rep UpdateQuerySuggestionsConfig Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

type Rep UpdateQuerySuggestionsConfig = D1 ('MetaData "UpdateQuerySuggestionsConfig" "Amazonka.Kendra.UpdateQuerySuggestionsConfig" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateQuerySuggestionsConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "includeQueriesWithoutUserInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "minimumNumberOfQueryingUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "minimumQueryCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Mode)) :*: (S1 ('MetaSel ('Just "queryLogLookBackWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateQuerySuggestionsConfig Source #

Create a value of UpdateQuerySuggestionsConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:includeQueriesWithoutUserInformation:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_includeQueriesWithoutUserInformation - 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.

$sel:minimumNumberOfQueryingUsers:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_minimumNumberOfQueryingUsers - 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.

$sel:minimumQueryCount:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_minimumQueryCount - 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.

$sel:mode:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_mode - 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.

$sel:queryLogLookBackWindowInDays:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_queryLogLookBackWindowInDays - 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.

$sel:indexId:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_indexId - The identifier of the index with query suggestions you want to update.

data UpdateQuerySuggestionsConfigResponse Source #

Instances

Instances details
Generic UpdateQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

Read UpdateQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

Show UpdateQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

NFData UpdateQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

Eq UpdateQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

type Rep UpdateQuerySuggestionsConfigResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig

type Rep UpdateQuerySuggestionsConfigResponse = D1 ('MetaData "UpdateQuerySuggestionsConfigResponse" "Amazonka.Kendra.UpdateQuerySuggestionsConfig" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateQuerySuggestionsConfigResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateQuerySuggestionsConfigResponse :: UpdateQuerySuggestionsConfigResponse Source #

Create a value of UpdateQuerySuggestionsConfigResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateThesaurus

data UpdateThesaurus Source #

See: newUpdateThesaurus smart constructor.

Instances

Instances details
ToJSON UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

ToHeaders UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

ToPath UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

ToQuery UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

AWSRequest UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

Associated Types

type AWSResponse UpdateThesaurus #

Generic UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

Associated Types

type Rep UpdateThesaurus :: Type -> Type #

Read UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

Show UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

NFData UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

Methods

rnf :: UpdateThesaurus -> () #

Eq UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

Hashable UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

type AWSResponse UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

type Rep UpdateThesaurus Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

newUpdateThesaurus Source #

Create a value of UpdateThesaurus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:UpdateThesaurus', updateThesaurus_description - A new description for the thesaurus.

UpdateThesaurus, updateThesaurus_name - A new name for the thesaurus.

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

$sel:sourceS3Path:UpdateThesaurus', updateThesaurus_sourceS3Path - Undocumented member.

UpdateThesaurus, updateThesaurus_id - The identifier of the thesaurus you want to update.

$sel:indexId:UpdateThesaurus', updateThesaurus_indexId - The identifier of the index for the thesaurus.

data UpdateThesaurusResponse Source #

See: newUpdateThesaurusResponse smart constructor.

Instances

Instances details
Generic UpdateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

Associated Types

type Rep UpdateThesaurusResponse :: Type -> Type #

Read UpdateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

Show UpdateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

NFData UpdateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

Methods

rnf :: UpdateThesaurusResponse -> () #

Eq UpdateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

type Rep UpdateThesaurusResponse Source # 
Instance details

Defined in Amazonka.Kendra.UpdateThesaurus

type Rep UpdateThesaurusResponse = D1 ('MetaData "UpdateThesaurusResponse" "Amazonka.Kendra.UpdateThesaurus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateThesaurusResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateThesaurusResponse :: UpdateThesaurusResponse Source #

Create a value of UpdateThesaurusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Types

AdditionalResultAttributeValueType

newtype AdditionalResultAttributeValueType Source #

Instances

Instances details
FromJSON AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

FromJSONKey AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

ToJSON AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

ToJSONKey AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

ToByteString AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

ToHeader AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

ToLog AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

ToQuery AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

FromText AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

ToText AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

FromXML AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

ToXML AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

Generic AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

Associated Types

type Rep AdditionalResultAttributeValueType :: Type -> Type #

Read AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

Show AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

NFData AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

Eq AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

Ord AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

Hashable AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

type Rep AdditionalResultAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType

type Rep AdditionalResultAttributeValueType = D1 ('MetaData "AdditionalResultAttributeValueType" "Amazonka.Kendra.Types.AdditionalResultAttributeValueType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "AdditionalResultAttributeValueType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAdditionalResultAttributeValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AlfrescoEntity

newtype AlfrescoEntity Source #

Constructors

AlfrescoEntity' 

Instances

Instances details
FromJSON AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

FromJSONKey AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

ToJSON AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

ToJSONKey AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

ToByteString AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

ToHeader AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

ToLog AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

ToQuery AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

FromText AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

ToText AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

FromXML AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

ToXML AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

Methods

toXML :: AlfrescoEntity -> XML #

Generic AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

Associated Types

type Rep AlfrescoEntity :: Type -> Type #

Read AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

Show AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

NFData AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

Methods

rnf :: AlfrescoEntity -> () #

Eq AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

Ord AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

Hashable AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

type Rep AlfrescoEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoEntity

type Rep AlfrescoEntity = D1 ('MetaData "AlfrescoEntity" "Amazonka.Kendra.Types.AlfrescoEntity" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "AlfrescoEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAlfrescoEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConditionOperator

newtype ConditionOperator Source #

Instances

Instances details
FromJSON ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

FromJSONKey ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

ToJSON ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

ToJSONKey ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

ToByteString ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

ToHeader ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

ToLog ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

ToQuery ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

FromText ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

ToText ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

FromXML ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

ToXML ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

Generic ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

Associated Types

type Rep ConditionOperator :: Type -> Type #

Read ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

Show ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

NFData ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

Methods

rnf :: ConditionOperator -> () #

Eq ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

Ord ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

Hashable ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

type Rep ConditionOperator Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConditionOperator

type Rep ConditionOperator = D1 ('MetaData "ConditionOperator" "Amazonka.Kendra.Types.ConditionOperator" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConditionOperator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConditionOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceAttachmentFieldName

newtype ConfluenceAttachmentFieldName Source #

Instances

Instances details
FromJSON ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

FromJSONKey ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

ToJSON ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

ToJSONKey ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

ToByteString ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

ToHeader ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

ToLog ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

ToQuery ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

FromText ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

ToText ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

FromXML ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

ToXML ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

Generic ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

Associated Types

type Rep ConfluenceAttachmentFieldName :: Type -> Type #

Read ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

Show ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

NFData ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

Eq ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

Ord ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

Hashable ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

type Rep ConfluenceAttachmentFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName

type Rep ConfluenceAttachmentFieldName = D1 ('MetaData "ConfluenceAttachmentFieldName" "Amazonka.Kendra.Types.ConfluenceAttachmentFieldName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceAttachmentFieldName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceAttachmentFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceAuthenticationType

newtype ConfluenceAuthenticationType Source #

Instances

Instances details
FromJSON ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

FromJSONKey ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

ToJSON ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

ToJSONKey ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

ToByteString ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

ToHeader ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

ToLog ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

ToQuery ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

FromText ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

ToText ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

FromXML ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

ToXML ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

Generic ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

Associated Types

type Rep ConfluenceAuthenticationType :: Type -> Type #

Read ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

Show ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

NFData ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

Eq ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

Ord ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

Hashable ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

type Rep ConfluenceAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType

type Rep ConfluenceAuthenticationType = D1 ('MetaData "ConfluenceAuthenticationType" "Amazonka.Kendra.Types.ConfluenceAuthenticationType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceAuthenticationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceAuthenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceBlogFieldName

newtype ConfluenceBlogFieldName Source #

Instances

Instances details
FromJSON ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

FromJSONKey ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

ToJSON ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

ToJSONKey ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

ToByteString ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

ToHeader ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

ToLog ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

ToQuery ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

FromText ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

ToText ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

FromXML ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

ToXML ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

Generic ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

Associated Types

type Rep ConfluenceBlogFieldName :: Type -> Type #

Read ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

Show ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

NFData ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

Methods

rnf :: ConfluenceBlogFieldName -> () #

Eq ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

Ord ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

Hashable ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

type Rep ConfluenceBlogFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName

type Rep ConfluenceBlogFieldName = D1 ('MetaData "ConfluenceBlogFieldName" "Amazonka.Kendra.Types.ConfluenceBlogFieldName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceBlogFieldName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceBlogFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluencePageFieldName

newtype ConfluencePageFieldName Source #

Instances

Instances details
FromJSON ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

FromJSONKey ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

ToJSON ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

ToJSONKey ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

ToByteString ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

ToHeader ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

ToLog ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

ToQuery ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

FromText ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

ToText ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

FromXML ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

ToXML ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

Generic ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

Associated Types

type Rep ConfluencePageFieldName :: Type -> Type #

Read ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

Show ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

NFData ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

Methods

rnf :: ConfluencePageFieldName -> () #

Eq ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

Ord ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

Hashable ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

type Rep ConfluencePageFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageFieldName

type Rep ConfluencePageFieldName = D1 ('MetaData "ConfluencePageFieldName" "Amazonka.Kendra.Types.ConfluencePageFieldName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluencePageFieldName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluencePageFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceSpaceFieldName

newtype ConfluenceSpaceFieldName Source #

Instances

Instances details
FromJSON ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

FromJSONKey ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

ToJSON ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

ToJSONKey ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

ToByteString ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

ToHeader ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

ToLog ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

ToQuery ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

FromText ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

ToText ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

FromXML ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

ToXML ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

Generic ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

Associated Types

type Rep ConfluenceSpaceFieldName :: Type -> Type #

Read ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

Show ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

NFData ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

Eq ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

Ord ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

Hashable ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

type Rep ConfluenceSpaceFieldName Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName

type Rep ConfluenceSpaceFieldName = D1 ('MetaData "ConfluenceSpaceFieldName" "Amazonka.Kendra.Types.ConfluenceSpaceFieldName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceSpaceFieldName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceSpaceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceVersion

newtype ConfluenceVersion Source #

Instances

Instances details
FromJSON ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

FromJSONKey ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

ToJSON ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

ToJSONKey ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

ToByteString ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

ToHeader ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

ToLog ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

ToQuery ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

FromText ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

ToText ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

FromXML ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

ToXML ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

Generic ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

Associated Types

type Rep ConfluenceVersion :: Type -> Type #

Read ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

Show ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

NFData ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

Methods

rnf :: ConfluenceVersion -> () #

Eq ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

Ord ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

Hashable ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

type Rep ConfluenceVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceVersion

type Rep ConfluenceVersion = D1 ('MetaData "ConfluenceVersion" "Amazonka.Kendra.Types.ConfluenceVersion" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ContentType

newtype ContentType Source #

Constructors

ContentType' 

Instances

Instances details
FromJSON ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

FromJSONKey ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

ToJSON ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

ToJSONKey ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

ToByteString ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

ToHeader ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

ToLog ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

ToQuery ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

FromText ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

ToText ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

Methods

toText :: ContentType -> Text #

FromXML ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

ToXML ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

Methods

toXML :: ContentType -> XML #

Generic ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

Associated Types

type Rep ContentType :: Type -> Type #

Read ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

Show ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

NFData ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

Methods

rnf :: ContentType -> () #

Eq ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

Ord ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

Hashable ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

type Rep ContentType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentType

type Rep ContentType = D1 ('MetaData "ContentType" "Amazonka.Kendra.Types.ContentType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ContentType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataSourceStatus

newtype DataSourceStatus Source #

Instances

Instances details
FromJSON DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

FromJSONKey DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

ToJSON DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

ToJSONKey DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

ToByteString DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

ToHeader DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

ToLog DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

ToQuery DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

FromText DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

ToText DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

FromXML DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

ToXML DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

Generic DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

Associated Types

type Rep DataSourceStatus :: Type -> Type #

Read DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

Show DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

NFData DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

Methods

rnf :: DataSourceStatus -> () #

Eq DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

Ord DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

Hashable DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

type Rep DataSourceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceStatus

type Rep DataSourceStatus = D1 ('MetaData "DataSourceStatus" "Amazonka.Kendra.Types.DataSourceStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DataSourceStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataSourceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataSourceSyncJobStatus

newtype DataSourceSyncJobStatus Source #

Instances

Instances details
FromJSON DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

FromJSONKey DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

ToJSON DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

ToJSONKey DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

ToByteString DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

ToHeader DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

ToLog DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

ToQuery DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

FromText DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

ToText DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

FromXML DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

ToXML DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

Generic DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

Associated Types

type Rep DataSourceSyncJobStatus :: Type -> Type #

Read DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

Show DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

NFData DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

Methods

rnf :: DataSourceSyncJobStatus -> () #

Eq DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

Ord DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

Hashable DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

type Rep DataSourceSyncJobStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus

type Rep DataSourceSyncJobStatus = D1 ('MetaData "DataSourceSyncJobStatus" "Amazonka.Kendra.Types.DataSourceSyncJobStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DataSourceSyncJobStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataSourceSyncJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataSourceType

newtype DataSourceType Source #

Constructors

DataSourceType' 

Instances

Instances details
FromJSON DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

FromJSONKey DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

ToJSON DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

ToJSONKey DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

ToByteString DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

ToHeader DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

ToLog DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

ToQuery DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

FromText DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

ToText DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

FromXML DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

ToXML DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

Methods

toXML :: DataSourceType -> XML #

Generic DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

Associated Types

type Rep DataSourceType :: Type -> Type #

Read DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

Show DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

NFData DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

Methods

rnf :: DataSourceType -> () #

Eq DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

Ord DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

Hashable DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

type Rep DataSourceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceType

type Rep DataSourceType = D1 ('MetaData "DataSourceType" "Amazonka.Kendra.Types.DataSourceType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DataSourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataSourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DatabaseEngineType

newtype DatabaseEngineType Source #

Instances

Instances details
FromJSON DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

FromJSONKey DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

ToJSON DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

ToJSONKey DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

ToByteString DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

ToHeader DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

ToLog DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

ToQuery DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

FromText DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

ToText DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

FromXML DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

ToXML DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

Generic DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

Associated Types

type Rep DatabaseEngineType :: Type -> Type #

Read DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

Show DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

NFData DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

Methods

rnf :: DatabaseEngineType -> () #

Eq DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

Ord DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

Hashable DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

type Rep DatabaseEngineType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseEngineType

type Rep DatabaseEngineType = D1 ('MetaData "DatabaseEngineType" "Amazonka.Kendra.Types.DatabaseEngineType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DatabaseEngineType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDatabaseEngineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentAttributeValueType

newtype DocumentAttributeValueType Source #

Instances

Instances details
FromJSON DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

FromJSONKey DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

ToJSON DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

ToJSONKey DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

ToByteString DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

ToHeader DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

ToLog DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

ToQuery DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

FromText DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

ToText DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

FromXML DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

ToXML DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

Generic DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

Associated Types

type Rep DocumentAttributeValueType :: Type -> Type #

Read DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

Show DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

NFData DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

Eq DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

Ord DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

Hashable DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

type Rep DocumentAttributeValueType Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueType

type Rep DocumentAttributeValueType = D1 ('MetaData "DocumentAttributeValueType" "Amazonka.Kendra.Types.DocumentAttributeValueType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DocumentAttributeValueType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentAttributeValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentStatus

newtype DocumentStatus Source #

Constructors

DocumentStatus' 

Instances

Instances details
FromJSON DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

FromJSONKey DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

ToJSON DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

ToJSONKey DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

ToByteString DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

ToHeader DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

ToLog DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

ToQuery DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

FromText DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

ToText DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

FromXML DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

ToXML DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

Methods

toXML :: DocumentStatus -> XML #

Generic DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

Associated Types

type Rep DocumentStatus :: Type -> Type #

Read DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

Show DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

NFData DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

Methods

rnf :: DocumentStatus -> () #

Eq DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

Ord DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

Hashable DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

type Rep DocumentStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentStatus

type Rep DocumentStatus = D1 ('MetaData "DocumentStatus" "Amazonka.Kendra.Types.DocumentStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DocumentStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EndpointType

newtype EndpointType Source #

Constructors

EndpointType' 

Bundled Patterns

pattern EndpointType_HOME :: EndpointType 

Instances

Instances details
FromJSON EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

FromJSONKey EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

ToJSON EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

ToJSONKey EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

ToByteString EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

ToHeader EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

ToLog EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

ToQuery EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

FromText EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

ToText EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

Methods

toText :: EndpointType -> Text #

FromXML EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

ToXML EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

Methods

toXML :: EndpointType -> XML #

Generic EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

Associated Types

type Rep EndpointType :: Type -> Type #

Read EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

Show EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

NFData EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

Methods

rnf :: EndpointType -> () #

Eq EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

Ord EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

Hashable EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

type Rep EndpointType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EndpointType

type Rep EndpointType = D1 ('MetaData "EndpointType" "Amazonka.Kendra.Types.EndpointType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "EndpointType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EntityType

newtype EntityType Source #

Constructors

EntityType' 

Fields

Bundled Patterns

pattern EntityType_GROUP :: EntityType 
pattern EntityType_USER :: EntityType 

Instances

Instances details
FromJSON EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

FromJSONKey EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

ToJSON EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

ToJSONKey EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

ToByteString EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

ToHeader EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

ToLog EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

ToQuery EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

FromText EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

ToText EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

Methods

toText :: EntityType -> Text #

FromXML EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

ToXML EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

Methods

toXML :: EntityType -> XML #

Generic EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

Associated Types

type Rep EntityType :: Type -> Type #

Read EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

Show EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

NFData EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

Methods

rnf :: EntityType -> () #

Eq EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

Ord EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

Hashable EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

type Rep EntityType Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityType

type Rep EntityType = D1 ('MetaData "EntityType" "Amazonka.Kendra.Types.EntityType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "EntityType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEntityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ErrorCode

newtype ErrorCode Source #

Constructors

ErrorCode' 

Fields

Bundled Patterns

pattern ErrorCode_InternalError :: ErrorCode 
pattern ErrorCode_InvalidRequest :: ErrorCode 

Instances

Instances details
FromJSON ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

FromJSONKey ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

ToJSON ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

ToJSONKey ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

ToByteString ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

Methods

toBS :: ErrorCode -> ByteString #

ToHeader ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

ToLog ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

ToQuery ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

FromText ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

ToText ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

Methods

toText :: ErrorCode -> Text #

FromXML ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

ToXML ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

Methods

toXML :: ErrorCode -> XML #

Generic ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

Associated Types

type Rep ErrorCode :: Type -> Type #

Read ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

Show ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

NFData ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

Methods

rnf :: ErrorCode -> () #

Eq ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

Ord ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

Hashable ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

type Rep ErrorCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.ErrorCode

type Rep ErrorCode = D1 ('MetaData "ErrorCode" "Amazonka.Kendra.Types.ErrorCode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ErrorCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromErrorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExperienceStatus

newtype ExperienceStatus Source #

Instances

Instances details
FromJSON ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

FromJSONKey ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

ToJSON ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

ToJSONKey ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

ToByteString ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

ToHeader ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

ToLog ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

ToQuery ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

FromText ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

ToText ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

FromXML ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

ToXML ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

Generic ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

Associated Types

type Rep ExperienceStatus :: Type -> Type #

Read ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

Show ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

NFData ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

Methods

rnf :: ExperienceStatus -> () #

Eq ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

Ord ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

Hashable ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

type Rep ExperienceStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceStatus

type Rep ExperienceStatus = D1 ('MetaData "ExperienceStatus" "Amazonka.Kendra.Types.ExperienceStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ExperienceStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExperienceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FaqFileFormat

newtype FaqFileFormat Source #

Constructors

FaqFileFormat' 

Instances

Instances details
FromJSON FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

FromJSONKey FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

ToJSON FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

ToJSONKey FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

ToByteString FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

ToHeader FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

ToLog FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

ToQuery FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

FromText FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

ToText FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

Methods

toText :: FaqFileFormat -> Text #

FromXML FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

ToXML FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

Methods

toXML :: FaqFileFormat -> XML #

Generic FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

Associated Types

type Rep FaqFileFormat :: Type -> Type #

Read FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

Show FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

NFData FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

Methods

rnf :: FaqFileFormat -> () #

Eq FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

Ord FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

Hashable FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

type Rep FaqFileFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqFileFormat

type Rep FaqFileFormat = D1 ('MetaData "FaqFileFormat" "Amazonka.Kendra.Types.FaqFileFormat" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "FaqFileFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFaqFileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FaqStatus

newtype FaqStatus Source #

Constructors

FaqStatus' 

Fields

Instances

Instances details
FromJSON FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

FromJSONKey FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

ToJSON FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

ToJSONKey FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

ToByteString FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

Methods

toBS :: FaqStatus -> ByteString #

ToHeader FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

ToLog FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

ToQuery FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

FromText FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

ToText FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

Methods

toText :: FaqStatus -> Text #

FromXML FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

ToXML FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

Methods

toXML :: FaqStatus -> XML #

Generic FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

Associated Types

type Rep FaqStatus :: Type -> Type #

Read FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

Show FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

NFData FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

Methods

rnf :: FaqStatus -> () #

Eq FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

Ord FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

Hashable FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

type Rep FaqStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatus

type Rep FaqStatus = D1 ('MetaData "FaqStatus" "Amazonka.Kendra.Types.FaqStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "FaqStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFaqStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FsxFileSystemType

newtype FsxFileSystemType Source #

Bundled Patterns

pattern FsxFileSystemType_WINDOWS :: FsxFileSystemType 

Instances

Instances details
FromJSON FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

FromJSONKey FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

ToJSON FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

ToJSONKey FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

ToByteString FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

ToHeader FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

ToLog FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

ToQuery FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

FromText FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

ToText FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

FromXML FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

ToXML FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

Generic FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

Associated Types

type Rep FsxFileSystemType :: Type -> Type #

Read FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

Show FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

NFData FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

Methods

rnf :: FsxFileSystemType -> () #

Eq FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

Ord FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

Hashable FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

type Rep FsxFileSystemType Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxFileSystemType

type Rep FsxFileSystemType = D1 ('MetaData "FsxFileSystemType" "Amazonka.Kendra.Types.FsxFileSystemType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "FsxFileSystemType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFsxFileSystemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

HighlightType

newtype HighlightType Source #

Constructors

HighlightType' 

Instances

Instances details
FromJSON HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

FromJSONKey HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

ToJSON HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

ToJSONKey HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

ToByteString HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

ToHeader HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

ToLog HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

ToQuery HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

FromText HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

ToText HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

Methods

toText :: HighlightType -> Text #

FromXML HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

ToXML HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

Methods

toXML :: HighlightType -> XML #

Generic HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

Associated Types

type Rep HighlightType :: Type -> Type #

Read HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

Show HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

NFData HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

Methods

rnf :: HighlightType -> () #

Eq HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

Ord HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

Hashable HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

type Rep HighlightType Source # 
Instance details

Defined in Amazonka.Kendra.Types.HighlightType

type Rep HighlightType = D1 ('MetaData "HighlightType" "Amazonka.Kendra.Types.HighlightType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "HighlightType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromHighlightType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IndexEdition

newtype IndexEdition Source #

Constructors

IndexEdition' 

Instances

Instances details
FromJSON IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

FromJSONKey IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

ToJSON IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

ToJSONKey IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

ToByteString IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

ToHeader IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

ToLog IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

ToQuery IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

FromText IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

ToText IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

Methods

toText :: IndexEdition -> Text #

FromXML IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

ToXML IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

Methods

toXML :: IndexEdition -> XML #

Generic IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

Associated Types

type Rep IndexEdition :: Type -> Type #

Read IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

Show IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

NFData IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

Methods

rnf :: IndexEdition -> () #

Eq IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

Ord IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

Hashable IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

type Rep IndexEdition Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexEdition

type Rep IndexEdition = D1 ('MetaData "IndexEdition" "Amazonka.Kendra.Types.IndexEdition" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "IndexEdition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIndexEdition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IndexStatus

newtype IndexStatus Source #

Constructors

IndexStatus' 

Instances

Instances details
FromJSON IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

FromJSONKey IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

ToJSON IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

ToJSONKey IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

ToByteString IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

ToHeader IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

ToLog IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

ToQuery IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

FromText IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

ToText IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

Methods

toText :: IndexStatus -> Text #

FromXML IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

ToXML IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

Methods

toXML :: IndexStatus -> XML #

Generic IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

Associated Types

type Rep IndexStatus :: Type -> Type #

Read IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

Show IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

NFData IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

Methods

rnf :: IndexStatus -> () #

Eq IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

Ord IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

Hashable IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

type Rep IndexStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatus

type Rep IndexStatus = D1 ('MetaData "IndexStatus" "Amazonka.Kendra.Types.IndexStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "IndexStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIndexStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Interval

newtype Interval Source #

Constructors

Interval' 

Fields

Instances

Instances details
FromJSON Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

FromJSONKey Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

ToJSON Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

ToJSONKey Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

ToByteString Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Methods

toBS :: Interval -> ByteString #

ToHeader Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Methods

toHeader :: HeaderName -> Interval -> [Header] #

ToLog Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

ToQuery Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

FromText Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

ToText Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Methods

toText :: Interval -> Text #

FromXML Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

ToXML Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Methods

toXML :: Interval -> XML #

Generic Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Associated Types

type Rep Interval :: Type -> Type #

Methods

from :: Interval -> Rep Interval x #

to :: Rep Interval x -> Interval #

Read Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Show Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

NFData Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Methods

rnf :: Interval -> () #

Eq Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Ord Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Hashable Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

Methods

hashWithSalt :: Int -> Interval -> Int #

hash :: Interval -> Int #

type Rep Interval Source # 
Instance details

Defined in Amazonka.Kendra.Types.Interval

type Rep Interval = D1 ('MetaData "Interval" "Amazonka.Kendra.Types.Interval" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Interval'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IssueSubEntity

newtype IssueSubEntity Source #

Constructors

IssueSubEntity' 

Instances

Instances details
FromJSON IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

FromJSONKey IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

ToJSON IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

ToJSONKey IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

ToByteString IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

ToHeader IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

ToLog IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

ToQuery IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

FromText IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

ToText IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

FromXML IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

ToXML IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

Methods

toXML :: IssueSubEntity -> XML #

Generic IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

Associated Types

type Rep IssueSubEntity :: Type -> Type #

Read IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

Show IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

NFData IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

Methods

rnf :: IssueSubEntity -> () #

Eq IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

Ord IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

Hashable IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

type Rep IssueSubEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.IssueSubEntity

type Rep IssueSubEntity = D1 ('MetaData "IssueSubEntity" "Amazonka.Kendra.Types.IssueSubEntity" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "IssueSubEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIssueSubEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

KeyLocation

newtype KeyLocation Source #

Constructors

KeyLocation' 

Bundled Patterns

pattern KeyLocation_SECRET_MANAGER :: KeyLocation 
pattern KeyLocation_URL :: KeyLocation 

Instances

Instances details
FromJSON KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

FromJSONKey KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

ToJSON KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

ToJSONKey KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

ToByteString KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

ToHeader KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

ToLog KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

ToQuery KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

FromText KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

ToText KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

Methods

toText :: KeyLocation -> Text #

FromXML KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

ToXML KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

Methods

toXML :: KeyLocation -> XML #

Generic KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

Associated Types

type Rep KeyLocation :: Type -> Type #

Read KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

Show KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

NFData KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

Methods

rnf :: KeyLocation -> () #

Eq KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

Ord KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

Hashable KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

type Rep KeyLocation Source # 
Instance details

Defined in Amazonka.Kendra.Types.KeyLocation

type Rep KeyLocation = D1 ('MetaData "KeyLocation" "Amazonka.Kendra.Types.KeyLocation" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "KeyLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromKeyLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MetricType

newtype MetricType Source #

Constructors

MetricType' 

Fields

Instances

Instances details
FromJSON MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

FromJSONKey MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

ToJSON MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

ToJSONKey MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

ToByteString MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

ToHeader MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

ToLog MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

ToQuery MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

FromText MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

ToText MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

Methods

toText :: MetricType -> Text #

FromXML MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

ToXML MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

Methods

toXML :: MetricType -> XML #

Generic MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

Associated Types

type Rep MetricType :: Type -> Type #

Read MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

Show MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

NFData MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

Methods

rnf :: MetricType -> () #

Eq MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

Ord MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

Hashable MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

type Rep MetricType Source # 
Instance details

Defined in Amazonka.Kendra.Types.MetricType

type Rep MetricType = D1 ('MetaData "MetricType" "Amazonka.Kendra.Types.MetricType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "MetricType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMetricType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Mode

newtype Mode Source #

Constructors

Mode' 

Fields

Bundled Patterns

pattern Mode_ENABLED :: Mode 
pattern Mode_LEARN_ONLY :: Mode 

Instances

Instances details
FromJSON Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

FromJSONKey Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

ToJSON Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

ToJSONKey Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

ToByteString Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

toBS :: Mode -> ByteString #

ToHeader Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

toHeader :: HeaderName -> Mode -> [Header] #

ToLog Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

ToQuery Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

toQuery :: Mode -> QueryString #

FromText Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

ToText Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

toText :: Mode -> Text #

FromXML Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

parseXML :: [Node] -> Either String Mode #

ToXML Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

toXML :: Mode -> XML #

Generic Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Associated Types

type Rep Mode :: Type -> Type #

Methods

from :: Mode -> Rep Mode x #

to :: Rep Mode x -> Mode #

Read Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Show Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

showsPrec :: Int -> Mode -> ShowS #

show :: Mode -> String #

showList :: [Mode] -> ShowS #

NFData Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

rnf :: Mode -> () #

Eq Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

(==) :: Mode -> Mode -> Bool #

(/=) :: Mode -> Mode -> Bool #

Ord Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

compare :: Mode -> Mode -> Ordering #

(<) :: Mode -> Mode -> Bool #

(<=) :: Mode -> Mode -> Bool #

(>) :: Mode -> Mode -> Bool #

(>=) :: Mode -> Mode -> Bool #

max :: Mode -> Mode -> Mode #

min :: Mode -> Mode -> Mode #

Hashable Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

Methods

hashWithSalt :: Int -> Mode -> Int #

hash :: Mode -> Int #

type Rep Mode Source # 
Instance details

Defined in Amazonka.Kendra.Types.Mode

type Rep Mode = D1 ('MetaData "Mode" "Amazonka.Kendra.Types.Mode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Mode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Order

newtype Order Source #

Constructors

Order' 

Fields

Bundled Patterns

pattern Order_ASCENDING :: Order 
pattern Order_DESCENDING :: Order 

Instances

Instances details
FromJSON Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

FromJSONKey Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

ToJSON Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

ToJSONKey Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

ToByteString Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

toBS :: Order -> ByteString #

ToHeader Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

toHeader :: HeaderName -> Order -> [Header] #

ToLog Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

ToQuery Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

toQuery :: Order -> QueryString #

FromText Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

ToText Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

toText :: Order -> Text #

FromXML Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

parseXML :: [Node] -> Either String Order #

ToXML Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

toXML :: Order -> XML #

Generic Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Associated Types

type Rep Order :: Type -> Type #

Methods

from :: Order -> Rep Order x #

to :: Rep Order x -> Order #

Read Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Show Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

showsPrec :: Int -> Order -> ShowS #

show :: Order -> String #

showList :: [Order] -> ShowS #

NFData Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

rnf :: Order -> () #

Eq Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

(==) :: Order -> Order -> Bool #

(/=) :: Order -> Order -> Bool #

Ord Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

compare :: Order -> Order -> Ordering #

(<) :: Order -> Order -> Bool #

(<=) :: Order -> Order -> Bool #

(>) :: Order -> Order -> Bool #

(>=) :: Order -> Order -> Bool #

max :: Order -> Order -> Order #

min :: Order -> Order -> Order #

Hashable Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

Methods

hashWithSalt :: Int -> Order -> Int #

hash :: Order -> Int #

type Rep Order Source # 
Instance details

Defined in Amazonka.Kendra.Types.Order

type Rep Order = D1 ('MetaData "Order" "Amazonka.Kendra.Types.Order" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Order'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Persona

newtype Persona Source #

Constructors

Persona' 

Fields

Bundled Patterns

pattern Persona_OWNER :: Persona 
pattern Persona_VIEWER :: Persona 

Instances

Instances details
FromJSON Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

FromJSONKey Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

ToJSON Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

ToJSONKey Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

ToByteString Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Methods

toBS :: Persona -> ByteString #

ToHeader Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Methods

toHeader :: HeaderName -> Persona -> [Header] #

ToLog Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

ToQuery Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

FromText Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

ToText Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Methods

toText :: Persona -> Text #

FromXML Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

ToXML Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Methods

toXML :: Persona -> XML #

Generic Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Associated Types

type Rep Persona :: Type -> Type #

Methods

from :: Persona -> Rep Persona x #

to :: Rep Persona x -> Persona #

Read Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Show Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

NFData Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Methods

rnf :: Persona -> () #

Eq Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Methods

(==) :: Persona -> Persona -> Bool #

(/=) :: Persona -> Persona -> Bool #

Ord Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Hashable Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

Methods

hashWithSalt :: Int -> Persona -> Int #

hash :: Persona -> Int #

type Rep Persona Source # 
Instance details

Defined in Amazonka.Kendra.Types.Persona

type Rep Persona = D1 ('MetaData "Persona" "Amazonka.Kendra.Types.Persona" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Persona'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPersona") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PrincipalMappingStatus

newtype PrincipalMappingStatus Source #

Instances

Instances details
FromJSON PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

FromJSONKey PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

ToJSON PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

ToJSONKey PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

ToByteString PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

ToHeader PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

ToLog PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

ToQuery PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

FromText PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

ToText PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

FromXML PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

ToXML PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

Generic PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

Associated Types

type Rep PrincipalMappingStatus :: Type -> Type #

Read PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

Show PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

NFData PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

Methods

rnf :: PrincipalMappingStatus -> () #

Eq PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

Ord PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

Hashable PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

type Rep PrincipalMappingStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalMappingStatus

type Rep PrincipalMappingStatus = D1 ('MetaData "PrincipalMappingStatus" "Amazonka.Kendra.Types.PrincipalMappingStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "PrincipalMappingStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPrincipalMappingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PrincipalType

newtype PrincipalType Source #

Constructors

PrincipalType' 

Bundled Patterns

pattern PrincipalType_GROUP :: PrincipalType 
pattern PrincipalType_USER :: PrincipalType 

Instances

Instances details
FromJSON PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

FromJSONKey PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

ToJSON PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

ToJSONKey PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

ToByteString PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

ToHeader PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

ToLog PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

ToQuery PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

FromText PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

ToText PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

Methods

toText :: PrincipalType -> Text #

FromXML PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

ToXML PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

Methods

toXML :: PrincipalType -> XML #

Generic PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

Associated Types

type Rep PrincipalType :: Type -> Type #

Read PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

Show PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

NFData PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

Methods

rnf :: PrincipalType -> () #

Eq PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

Ord PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

Hashable PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

type Rep PrincipalType Source # 
Instance details

Defined in Amazonka.Kendra.Types.PrincipalType

type Rep PrincipalType = D1 ('MetaData "PrincipalType" "Amazonka.Kendra.Types.PrincipalType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "PrincipalType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPrincipalType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryIdentifiersEnclosingOption

newtype QueryIdentifiersEnclosingOption Source #

Instances

Instances details
FromJSON QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

FromJSONKey QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

ToJSON QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

ToJSONKey QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

ToByteString QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

ToHeader QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

ToLog QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

ToQuery QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

FromText QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

ToText QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

FromXML QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

ToXML QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

Generic QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

Associated Types

type Rep QueryIdentifiersEnclosingOption :: Type -> Type #

Read QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

Show QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

NFData QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

Eq QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

Ord QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

Hashable QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

type Rep QueryIdentifiersEnclosingOption Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption

type Rep QueryIdentifiersEnclosingOption = D1 ('MetaData "QueryIdentifiersEnclosingOption" "Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QueryIdentifiersEnclosingOption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueryIdentifiersEnclosingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryResultFormat

newtype QueryResultFormat Source #

Instances

Instances details
FromJSON QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

FromJSONKey QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

ToJSON QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

ToJSONKey QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

ToByteString QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

ToHeader QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

ToLog QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

ToQuery QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

FromText QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

ToText QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

FromXML QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

ToXML QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

Generic QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

Associated Types

type Rep QueryResultFormat :: Type -> Type #

Read QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

Show QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

NFData QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

Methods

rnf :: QueryResultFormat -> () #

Eq QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

Ord QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

Hashable QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

type Rep QueryResultFormat Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultFormat

type Rep QueryResultFormat = D1 ('MetaData "QueryResultFormat" "Amazonka.Kendra.Types.QueryResultFormat" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QueryResultFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueryResultFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryResultType

newtype QueryResultType Source #

Constructors

QueryResultType' 

Instances

Instances details
FromJSON QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

FromJSONKey QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

ToJSON QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

ToJSONKey QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

ToByteString QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

ToHeader QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

ToLog QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

ToQuery QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

FromText QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

ToText QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

FromXML QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

ToXML QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

Methods

toXML :: QueryResultType -> XML #

Generic QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

Associated Types

type Rep QueryResultType :: Type -> Type #

Read QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

Show QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

NFData QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

Methods

rnf :: QueryResultType -> () #

Eq QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

Ord QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

Hashable QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

type Rep QueryResultType Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultType

type Rep QueryResultType = D1 ('MetaData "QueryResultType" "Amazonka.Kendra.Types.QueryResultType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QueryResultType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueryResultType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QuerySuggestionsBlockListStatus

newtype QuerySuggestionsBlockListStatus Source #

Instances

Instances details
FromJSON QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

FromJSONKey QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

ToJSON QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

ToJSONKey QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

ToByteString QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

ToHeader QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

ToLog QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

ToQuery QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

FromText QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

ToText QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

FromXML QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

ToXML QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

Generic QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

Associated Types

type Rep QuerySuggestionsBlockListStatus :: Type -> Type #

Read QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

Show QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

NFData QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

Eq QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

Ord QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

Hashable QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

type Rep QuerySuggestionsBlockListStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus

type Rep QuerySuggestionsBlockListStatus = D1 ('MetaData "QuerySuggestionsBlockListStatus" "Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QuerySuggestionsBlockListStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQuerySuggestionsBlockListStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QuerySuggestionsStatus

newtype QuerySuggestionsStatus Source #

Instances

Instances details
FromJSON QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

FromJSONKey QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

ToJSON QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

ToJSONKey QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

ToByteString QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

ToHeader QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

ToLog QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

ToQuery QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

FromText QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

ToText QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

FromXML QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

ToXML QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

Generic QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

Associated Types

type Rep QuerySuggestionsStatus :: Type -> Type #

Read QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

Show QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

NFData QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

Methods

rnf :: QuerySuggestionsStatus -> () #

Eq QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

Ord QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

Hashable QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

type Rep QuerySuggestionsStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus

type Rep QuerySuggestionsStatus = D1 ('MetaData "QuerySuggestionsStatus" "Amazonka.Kendra.Types.QuerySuggestionsStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QuerySuggestionsStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQuerySuggestionsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ReadAccessType

newtype ReadAccessType Source #

Constructors

ReadAccessType' 

Instances

Instances details
FromJSON ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

FromJSONKey ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

ToJSON ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

ToJSONKey ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

ToByteString ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

ToHeader ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

ToLog ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

ToQuery ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

FromText ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

ToText ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

FromXML ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

ToXML ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

Methods

toXML :: ReadAccessType -> XML #

Generic ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

Associated Types

type Rep ReadAccessType :: Type -> Type #

Read ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

Show ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

NFData ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

Methods

rnf :: ReadAccessType -> () #

Eq ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

Ord ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

Hashable ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

type Rep ReadAccessType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ReadAccessType

type Rep ReadAccessType = D1 ('MetaData "ReadAccessType" "Amazonka.Kendra.Types.ReadAccessType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ReadAccessType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromReadAccessType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

RelevanceType

newtype RelevanceType Source #

Constructors

RelevanceType' 

Instances

Instances details
FromJSON RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

FromJSONKey RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

ToJSON RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

ToJSONKey RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

ToByteString RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

ToHeader RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

ToLog RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

ToQuery RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

FromText RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

ToText RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

Methods

toText :: RelevanceType -> Text #

FromXML RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

ToXML RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

Methods

toXML :: RelevanceType -> XML #

Generic RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

Associated Types

type Rep RelevanceType :: Type -> Type #

Read RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

Show RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

NFData RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

Methods

rnf :: RelevanceType -> () #

Eq RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

Ord RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

Hashable RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

type Rep RelevanceType Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceType

type Rep RelevanceType = D1 ('MetaData "RelevanceType" "Amazonka.Kendra.Types.RelevanceType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "RelevanceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRelevanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SalesforceChatterFeedIncludeFilterType

newtype SalesforceChatterFeedIncludeFilterType Source #

Instances

Instances details
FromJSON SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

FromJSONKey SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

ToJSON SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

ToJSONKey SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

ToByteString SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

ToHeader SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

ToLog SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

ToQuery SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

FromText SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

ToText SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

FromXML SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

ToXML SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

Generic SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

Read SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

Show SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

NFData SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

Eq SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

Ord SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

Hashable SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

type Rep SalesforceChatterFeedIncludeFilterType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType

type Rep SalesforceChatterFeedIncludeFilterType = D1 ('MetaData "SalesforceChatterFeedIncludeFilterType" "Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SalesforceChatterFeedIncludeFilterType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSalesforceChatterFeedIncludeFilterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SalesforceKnowledgeArticleState

newtype SalesforceKnowledgeArticleState Source #

Instances

Instances details
FromJSON SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

FromJSONKey SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

ToJSON SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

ToJSONKey SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

ToByteString SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

ToHeader SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

ToLog SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

ToQuery SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

FromText SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

ToText SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

FromXML SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

ToXML SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

Generic SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

Associated Types

type Rep SalesforceKnowledgeArticleState :: Type -> Type #

Read SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

Show SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

NFData SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

Eq SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

Ord SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

Hashable SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

type Rep SalesforceKnowledgeArticleState Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState

type Rep SalesforceKnowledgeArticleState = D1 ('MetaData "SalesforceKnowledgeArticleState" "Amazonka.Kendra.Types.SalesforceKnowledgeArticleState" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SalesforceKnowledgeArticleState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSalesforceKnowledgeArticleState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SalesforceStandardObjectName

newtype SalesforceStandardObjectName Source #

Instances

Instances details
FromJSON SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

FromJSONKey SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

ToJSON SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

ToJSONKey SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

ToByteString SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

ToHeader SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

ToLog SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

ToQuery SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

FromText SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

ToText SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

FromXML SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

ToXML SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

Generic SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

Associated Types

type Rep SalesforceStandardObjectName :: Type -> Type #

Read SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

Show SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

NFData SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

Eq SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

Ord SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

Hashable SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

type Rep SalesforceStandardObjectName Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName

type Rep SalesforceStandardObjectName = D1 ('MetaData "SalesforceStandardObjectName" "Amazonka.Kendra.Types.SalesforceStandardObjectName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SalesforceStandardObjectName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSalesforceStandardObjectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ScoreConfidence

newtype ScoreConfidence Source #

Enumeration for query score confidence.

Constructors

ScoreConfidence' 

Instances

Instances details
FromJSON ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

FromJSONKey ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

ToJSON ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

ToJSONKey ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

ToByteString ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

ToHeader ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

ToLog ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

ToQuery ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

FromText ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

ToText ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

FromXML ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

ToXML ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

Methods

toXML :: ScoreConfidence -> XML #

Generic ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

Associated Types

type Rep ScoreConfidence :: Type -> Type #

Read ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

Show ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

NFData ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

Methods

rnf :: ScoreConfidence -> () #

Eq ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

Ord ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

Hashable ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

type Rep ScoreConfidence Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreConfidence

type Rep ScoreConfidence = D1 ('MetaData "ScoreConfidence" "Amazonka.Kendra.Types.ScoreConfidence" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ScoreConfidence'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromScoreConfidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ServiceNowAuthenticationType

newtype ServiceNowAuthenticationType Source #

Instances

Instances details
FromJSON ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

FromJSONKey ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

ToJSON ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

ToJSONKey ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

ToByteString ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

ToHeader ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

ToLog ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

ToQuery ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

FromText ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

ToText ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

FromXML ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

ToXML ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

Generic ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

Associated Types

type Rep ServiceNowAuthenticationType :: Type -> Type #

Read ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

Show ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

NFData ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

Eq ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

Ord ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

Hashable ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

type Rep ServiceNowAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType

type Rep ServiceNowAuthenticationType = D1 ('MetaData "ServiceNowAuthenticationType" "Amazonka.Kendra.Types.ServiceNowAuthenticationType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ServiceNowAuthenticationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromServiceNowAuthenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ServiceNowBuildVersionType

newtype ServiceNowBuildVersionType Source #

Instances

Instances details
FromJSON ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

FromJSONKey ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

ToJSON ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

ToJSONKey ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

ToByteString ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

ToHeader ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

ToLog ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

ToQuery ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

FromText ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

ToText ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

FromXML ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

ToXML ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

Generic ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

Associated Types

type Rep ServiceNowBuildVersionType :: Type -> Type #

Read ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

Show ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

NFData ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

Eq ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

Ord ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

Hashable ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

type Rep ServiceNowBuildVersionType Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType

type Rep ServiceNowBuildVersionType = D1 ('MetaData "ServiceNowBuildVersionType" "Amazonka.Kendra.Types.ServiceNowBuildVersionType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ServiceNowBuildVersionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromServiceNowBuildVersionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SharePointOnlineAuthenticationType

newtype SharePointOnlineAuthenticationType Source #

Instances

Instances details
FromJSON SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

FromJSONKey SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

ToJSON SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

ToJSONKey SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

ToByteString SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

ToHeader SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

ToLog SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

ToQuery SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

FromText SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

ToText SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

FromXML SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

ToXML SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

Generic SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

Associated Types

type Rep SharePointOnlineAuthenticationType :: Type -> Type #

Read SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

Show SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

NFData SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

Eq SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

Ord SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

Hashable SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

type Rep SharePointOnlineAuthenticationType Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType

type Rep SharePointOnlineAuthenticationType = D1 ('MetaData "SharePointOnlineAuthenticationType" "Amazonka.Kendra.Types.SharePointOnlineAuthenticationType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SharePointOnlineAuthenticationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSharePointOnlineAuthenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SharePointVersion

newtype SharePointVersion Source #

Instances

Instances details
FromJSON SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

FromJSONKey SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

ToJSON SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

ToJSONKey SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

ToByteString SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

ToHeader SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

ToLog SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

ToQuery SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

FromText SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

ToText SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

FromXML SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

ToXML SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

Generic SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

Associated Types

type Rep SharePointVersion :: Type -> Type #

Read SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

Show SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

NFData SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

Methods

rnf :: SharePointVersion -> () #

Eq SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

Ord SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

Hashable SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

type Rep SharePointVersion Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointVersion

type Rep SharePointVersion = D1 ('MetaData "SharePointVersion" "Amazonka.Kendra.Types.SharePointVersion" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SharePointVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSharePointVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SlackEntity

newtype SlackEntity Source #

Constructors

SlackEntity' 

Instances

Instances details
FromJSON SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

FromJSONKey SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

ToJSON SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

ToJSONKey SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

ToByteString SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

ToHeader SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

ToLog SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

ToQuery SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

FromText SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

ToText SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

Methods

toText :: SlackEntity -> Text #

FromXML SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

ToXML SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

Methods

toXML :: SlackEntity -> XML #

Generic SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

Associated Types

type Rep SlackEntity :: Type -> Type #

Read SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

Show SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

NFData SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

Methods

rnf :: SlackEntity -> () #

Eq SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

Ord SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

Hashable SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

type Rep SlackEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackEntity

type Rep SlackEntity = D1 ('MetaData "SlackEntity" "Amazonka.Kendra.Types.SlackEntity" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SlackEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSlackEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SortOrder

newtype SortOrder Source #

Constructors

SortOrder' 

Fields

Bundled Patterns

pattern SortOrder_ASC :: SortOrder 
pattern SortOrder_DESC :: SortOrder 

Instances

Instances details
FromJSON SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

FromJSONKey SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

ToJSON SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

ToJSONKey SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

ToByteString SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

Methods

toBS :: SortOrder -> ByteString #

ToHeader SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

ToLog SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

ToQuery SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

FromText SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

ToText SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

Methods

toText :: SortOrder -> Text #

FromXML SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

ToXML SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

Methods

toXML :: SortOrder -> XML #

Generic SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

Associated Types

type Rep SortOrder :: Type -> Type #

Read SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

Show SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

NFData SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

Methods

rnf :: SortOrder -> () #

Eq SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

Ord SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

Hashable SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

type Rep SortOrder Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortOrder

type Rep SortOrder = D1 ('MetaData "SortOrder" "Amazonka.Kendra.Types.SortOrder" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SortOrder'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ThesaurusStatus

newtype ThesaurusStatus Source #

Constructors

ThesaurusStatus' 

Instances

Instances details
FromJSON ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

FromJSONKey ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

ToJSON ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

ToJSONKey ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

ToByteString ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

ToHeader ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

ToLog ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

ToQuery ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

FromText ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

ToText ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

FromXML ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

ToXML ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

Methods

toXML :: ThesaurusStatus -> XML #

Generic ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

Associated Types

type Rep ThesaurusStatus :: Type -> Type #

Read ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

Show ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

NFData ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

Methods

rnf :: ThesaurusStatus -> () #

Eq ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

Ord ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

Hashable ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

type Rep ThesaurusStatus Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusStatus

type Rep ThesaurusStatus = D1 ('MetaData "ThesaurusStatus" "Amazonka.Kendra.Types.ThesaurusStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ThesaurusStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromThesaurusStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Type

newtype Type Source #

Constructors

Type' 

Fields

Bundled Patterns

pattern Type_ON_PREMISE :: Type 
pattern Type_SAAS :: Type 

Instances

Instances details
FromJSON Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

FromJSONKey Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

ToJSON Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

ToJSONKey Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

ToByteString Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

toBS :: Type -> ByteString #

ToHeader Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

toHeader :: HeaderName -> Type -> [Header] #

ToLog Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

ToQuery Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

toQuery :: Type -> QueryString #

FromText Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

ToText Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

toText :: Type -> Text #

FromXML Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

parseXML :: [Node] -> Either String Type #

ToXML Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

toXML :: Type -> XML #

Generic Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Associated Types

type Rep Type :: Type -> Type #

Methods

from :: Type -> Rep Type x #

to :: Rep Type x -> Type #

Read Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Show Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

showsPrec :: Int -> Type -> ShowS #

show :: Type -> String #

showList :: [Type] -> ShowS #

NFData Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

rnf :: Type -> () #

Eq Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

(==) :: Type -> Type -> Bool #

(/=) :: Type -> Type -> Bool #

Ord Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

compare :: Type -> Type -> Ordering #

(<) :: Type -> Type -> Bool #

(<=) :: Type -> Type -> Bool #

(>) :: Type -> Type -> Bool #

(>=) :: Type -> Type -> Bool #

max :: Type -> Type -> Type #

min :: Type -> Type -> Type #

Hashable Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

Methods

hashWithSalt :: Int -> Type -> Int #

hash :: Type -> Int #

type Rep Type Source # 
Instance details

Defined in Amazonka.Kendra.Types.Type

type Rep Type = D1 ('MetaData "Type" "Amazonka.Kendra.Types.Type" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Type'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

UserContextPolicy

newtype UserContextPolicy Source #

Instances

Instances details
FromJSON UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

FromJSONKey UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

ToJSON UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

ToJSONKey UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

ToByteString UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

ToHeader UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

ToLog UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

ToQuery UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

FromText UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

ToText UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

FromXML UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

ToXML UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

Generic UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

Associated Types

type Rep UserContextPolicy :: Type -> Type #

Read UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

Show UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

NFData UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

Methods

rnf :: UserContextPolicy -> () #

Eq UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

Ord UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

Hashable UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

type Rep UserContextPolicy Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContextPolicy

type Rep UserContextPolicy = D1 ('MetaData "UserContextPolicy" "Amazonka.Kendra.Types.UserContextPolicy" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "UserContextPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUserContextPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

UserGroupResolutionMode

newtype UserGroupResolutionMode Source #

Instances

Instances details
FromJSON UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

FromJSONKey UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

ToJSON UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

ToJSONKey UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

ToByteString UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

ToHeader UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

ToLog UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

ToQuery UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

FromText UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

ToText UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

FromXML UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

ToXML UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

Generic UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

Associated Types

type Rep UserGroupResolutionMode :: Type -> Type #

Read UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

Show UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

NFData UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

Methods

rnf :: UserGroupResolutionMode -> () #

Eq UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

Ord UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

Hashable UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

type Rep UserGroupResolutionMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionMode

type Rep UserGroupResolutionMode = D1 ('MetaData "UserGroupResolutionMode" "Amazonka.Kendra.Types.UserGroupResolutionMode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "UserGroupResolutionMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUserGroupResolutionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WarningCode

newtype WarningCode Source #

Constructors

WarningCode' 

Instances

Instances details
FromJSON WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

FromJSONKey WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

ToJSON WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

ToJSONKey WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

ToByteString WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

ToHeader WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

ToLog WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

ToQuery WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

FromText WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

ToText WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

Methods

toText :: WarningCode -> Text #

FromXML WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

ToXML WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

Methods

toXML :: WarningCode -> XML #

Generic WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

Associated Types

type Rep WarningCode :: Type -> Type #

Read WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

Show WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

NFData WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

Methods

rnf :: WarningCode -> () #

Eq WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

Ord WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

Hashable WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

type Rep WarningCode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WarningCode

type Rep WarningCode = D1 ('MetaData "WarningCode" "Amazonka.Kendra.Types.WarningCode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "WarningCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWarningCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WebCrawlerMode

newtype WebCrawlerMode Source #

Constructors

WebCrawlerMode' 

Instances

Instances details
FromJSON WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

FromJSONKey WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

ToJSON WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

ToJSONKey WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

ToByteString WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

ToHeader WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

ToLog WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

ToQuery WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

FromText WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

ToText WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

FromXML WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

ToXML WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

Methods

toXML :: WebCrawlerMode -> XML #

Generic WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

Associated Types

type Rep WebCrawlerMode :: Type -> Type #

Read WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

Show WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

NFData WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

Methods

rnf :: WebCrawlerMode -> () #

Eq WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

Ord WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

Hashable WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

type Rep WebCrawlerMode Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerMode

type Rep WebCrawlerMode = D1 ('MetaData "WebCrawlerMode" "Amazonka.Kendra.Types.WebCrawlerMode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "WebCrawlerMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWebCrawlerMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AccessControlConfigurationSummary

data AccessControlConfigurationSummary Source #

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

See: newAccessControlConfigurationSummary smart constructor.

Instances

Instances details
FromJSON AccessControlConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary

Generic AccessControlConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary

Associated Types

type Rep AccessControlConfigurationSummary :: Type -> Type #

Read AccessControlConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary

Show AccessControlConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary

NFData AccessControlConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary

Eq AccessControlConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary

Hashable AccessControlConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary

type Rep AccessControlConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary

type Rep AccessControlConfigurationSummary = D1 ('MetaData "AccessControlConfigurationSummary" "Amazonka.Kendra.Types.AccessControlConfigurationSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AccessControlConfigurationSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAccessControlConfigurationSummary Source #

Create a value of AccessControlConfigurationSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:AccessControlConfigurationSummary', accessControlConfigurationSummary_id - The identifier of the access control configuration.

AccessControlListConfiguration

data AccessControlListConfiguration Source #

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

See: newAccessControlListConfiguration smart constructor.

Instances

Instances details
FromJSON AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

ToJSON AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

Generic AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

Associated Types

type Rep AccessControlListConfiguration :: Type -> Type #

Read AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

Show AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

NFData AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

Eq AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

Hashable AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

type Rep AccessControlListConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AccessControlListConfiguration

type Rep AccessControlListConfiguration = D1 ('MetaData "AccessControlListConfiguration" "Amazonka.Kendra.Types.AccessControlListConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AccessControlListConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAccessControlListConfiguration :: AccessControlListConfiguration Source #

Create a value of AccessControlListConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyPath:AccessControlListConfiguration', accessControlListConfiguration_keyPath - Path to the Amazon S3 bucket that contains the ACL files.

AclConfiguration

data AclConfiguration Source #

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

See: newAclConfiguration smart constructor.

Constructors

AclConfiguration' Text 

Instances

Instances details
FromJSON AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

ToJSON AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

Generic AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

Associated Types

type Rep AclConfiguration :: Type -> Type #

Read AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

Show AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

NFData AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

Methods

rnf :: AclConfiguration -> () #

Eq AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

Hashable AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

type Rep AclConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AclConfiguration

type Rep AclConfiguration = D1 ('MetaData "AclConfiguration" "Amazonka.Kendra.Types.AclConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AclConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowedGroupsColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAclConfiguration Source #

Create a value of AclConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allowedGroupsColumnName:AclConfiguration', aclConfiguration_allowedGroupsColumnName - 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

data AdditionalResultAttribute Source #

An attribute returned from an index query.

See: newAdditionalResultAttribute smart constructor.

Instances

Instances details
FromJSON AdditionalResultAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttribute

Generic AdditionalResultAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttribute

Associated Types

type Rep AdditionalResultAttribute :: Type -> Type #

Read AdditionalResultAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttribute

Show AdditionalResultAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttribute

NFData AdditionalResultAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttribute

Eq AdditionalResultAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttribute

Hashable AdditionalResultAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttribute

type Rep AdditionalResultAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttribute

type Rep AdditionalResultAttribute = D1 ('MetaData "AdditionalResultAttribute" "Amazonka.Kendra.Types.AdditionalResultAttribute" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AdditionalResultAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "valueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AdditionalResultAttributeValueType) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AdditionalResultAttributeValue))))

newAdditionalResultAttribute Source #

Create a value of AdditionalResultAttribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:AdditionalResultAttribute', additionalResultAttribute_key - The key that identifies the attribute.

$sel:valueType:AdditionalResultAttribute', additionalResultAttribute_valueType - The data type of the Value property.

$sel:value:AdditionalResultAttribute', additionalResultAttribute_value - An object that contains the attribute value.

AdditionalResultAttributeValue

data AdditionalResultAttributeValue Source #

An attribute returned with a document from a search.

See: newAdditionalResultAttributeValue smart constructor.

Instances

Instances details
FromJSON AdditionalResultAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue

Generic AdditionalResultAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue

Associated Types

type Rep AdditionalResultAttributeValue :: Type -> Type #

Read AdditionalResultAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue

Show AdditionalResultAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue

NFData AdditionalResultAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue

Eq AdditionalResultAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue

Hashable AdditionalResultAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue

type Rep AdditionalResultAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue

type Rep AdditionalResultAttributeValue = D1 ('MetaData "AdditionalResultAttributeValue" "Amazonka.Kendra.Types.AdditionalResultAttributeValue" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AdditionalResultAttributeValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "textWithHighlightsValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextWithHighlights))))

newAdditionalResultAttributeValue :: AdditionalResultAttributeValue Source #

Create a value of AdditionalResultAttributeValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:textWithHighlightsValue:AdditionalResultAttributeValue', additionalResultAttributeValue_textWithHighlightsValue - The text associated with the attribute and information about the highlight to apply to the text.

AlfrescoConfiguration

data AlfrescoConfiguration Source #

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

Alfresco data source connector is currently in preview mode. Basic authentication is currently supported. If you would like to use Alfresco connector in production, contact Support.

See: newAlfrescoConfiguration smart constructor.

Instances

Instances details
FromJSON AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

ToJSON AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

Generic AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

Associated Types

type Rep AlfrescoConfiguration :: Type -> Type #

Read AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

Show AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

NFData AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

Methods

rnf :: AlfrescoConfiguration -> () #

Eq AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

Hashable AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

type Rep AlfrescoConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AlfrescoConfiguration

type Rep AlfrescoConfiguration = D1 ('MetaData "AlfrescoConfiguration" "Amazonka.Kendra.Types.AlfrescoConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AlfrescoConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blogFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "crawlComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlSystemFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "documentLibraryFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "entityFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AlfrescoEntity))) :*: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "wikiFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :*: ((S1 ('MetaSel ('Just "siteUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "siteId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sslCertificateS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Path))))))

newAlfrescoConfiguration Source #

Create a value of AlfrescoConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:blogFieldMappings:AlfrescoConfiguration', alfrescoConfiguration_blogFieldMappings - 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.

$sel:crawlComments:AlfrescoConfiguration', alfrescoConfiguration_crawlComments - TRUE to index comments of blogs and other content.

$sel:crawlSystemFolders:AlfrescoConfiguration', alfrescoConfiguration_crawlSystemFolders - TRUE to index shared files.

$sel:documentLibraryFieldMappings:AlfrescoConfiguration', alfrescoConfiguration_documentLibraryFieldMappings - 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.

$sel:entityFilter:AlfrescoConfiguration', alfrescoConfiguration_entityFilter - Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.

$sel:exclusionPatterns:AlfrescoConfiguration', alfrescoConfiguration_exclusionPatterns - 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.

$sel:inclusionPatterns:AlfrescoConfiguration', alfrescoConfiguration_inclusionPatterns - 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.

$sel:vpcConfiguration:AlfrescoConfiguration', alfrescoConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.

$sel:wikiFieldMappings:AlfrescoConfiguration', alfrescoConfiguration_wikiFieldMappings - 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.

$sel:siteUrl:AlfrescoConfiguration', alfrescoConfiguration_siteUrl - The URL of the Alfresco site. For example, https://hostname:8080.

$sel:siteId:AlfrescoConfiguration', alfrescoConfiguration_siteId - The identifier of the Alfresco site. For example, my-site.

$sel:secretArn:AlfrescoConfiguration', alfrescoConfiguration_secretArn - 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.

$sel:sslCertificateS3Path:AlfrescoConfiguration', alfrescoConfiguration_sslCertificateS3Path - 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

data AttributeFilter Source #

Provides filtering the query results based on document attributes or metadata fields.

When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:

<AndAllFilters>
  1.  <OrAllFilters>
  2.  <EqualsTo>

If you use more than 2 layers, you receive a ValidationException exception with the message "AttributeFilter cannot have a depth of more than 2."

If you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message "AttributeFilter cannot have a length of more than 10".

See: newAttributeFilter smart constructor.

Instances

Instances details
ToJSON AttributeFilter Source # 
Instance details

Defined in Amazonka.Kendra.Types.AttributeFilter

Generic AttributeFilter Source # 
Instance details

Defined in Amazonka.Kendra.Types.AttributeFilter

Associated Types

type Rep AttributeFilter :: Type -> Type #

Read AttributeFilter Source # 
Instance details

Defined in Amazonka.Kendra.Types.AttributeFilter

Show AttributeFilter Source # 
Instance details

Defined in Amazonka.Kendra.Types.AttributeFilter

NFData AttributeFilter Source # 
Instance details

Defined in Amazonka.Kendra.Types.AttributeFilter

Methods

rnf :: AttributeFilter -> () #

Eq AttributeFilter Source # 
Instance details

Defined in Amazonka.Kendra.Types.AttributeFilter

Hashable AttributeFilter Source # 
Instance details

Defined in Amazonka.Kendra.Types.AttributeFilter

type Rep AttributeFilter Source # 
Instance details

Defined in Amazonka.Kendra.Types.AttributeFilter

type Rep AttributeFilter = D1 ('MetaData "AttributeFilter" "Amazonka.Kendra.Types.AttributeFilter" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AttributeFilter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "andAllFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeFilter])) :*: S1 ('MetaSel ('Just "containsAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute))) :*: (S1 ('MetaSel ('Just "containsAny") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute)) :*: (S1 ('MetaSel ('Just "equalsTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute)) :*: S1 ('MetaSel ('Just "greaterThan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute))))) :*: ((S1 ('MetaSel ('Just "greaterThanOrEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute)) :*: S1 ('MetaSel ('Just "lessThan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute))) :*: (S1 ('MetaSel ('Just "lessThanOrEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute)) :*: (S1 ('MetaSel ('Just "notFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeFilter)) :*: S1 ('MetaSel ('Just "orAllFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeFilter])))))))

newAttributeFilter :: AttributeFilter Source #

Create a value of AttributeFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:andAllFilters:AttributeFilter', attributeFilter_andAllFilters - Performs a logical AND operation on all supplied filters.

$sel:containsAll:AttributeFilter', attributeFilter_containsAll - Returns true when a document contains all of the specified document attributes or metadata fields. This filter is only applicable to StringListValue metadata.

$sel:containsAny:AttributeFilter', attributeFilter_containsAny - Returns true when a document contains any of the specified document attributes or metadata fields. This filter is only applicable to StringListValue metadata.

$sel:equalsTo:AttributeFilter', attributeFilter_equalsTo - Performs an equals operation on two document attributes or metadata fields.

$sel:greaterThan:AttributeFilter', attributeFilter_greaterThan - Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

$sel:greaterThanOrEquals:AttributeFilter', attributeFilter_greaterThanOrEquals - Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

$sel:lessThan:AttributeFilter', attributeFilter_lessThan - Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

$sel:lessThanOrEquals:AttributeFilter', attributeFilter_lessThanOrEquals - Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

$sel:notFilter:AttributeFilter', attributeFilter_notFilter - Performs a logical NOT operation on all supplied filters.

$sel:orAllFilters:AttributeFilter', attributeFilter_orAllFilters - Performs a logical OR operation on all supplied filters.

AuthenticationConfiguration

data AuthenticationConfiguration Source #

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

See: newAuthenticationConfiguration smart constructor.

Instances

Instances details
FromJSON AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

ToJSON AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

Generic AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

Associated Types

type Rep AuthenticationConfiguration :: Type -> Type #

Read AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

Show AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

NFData AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

Eq AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

Hashable AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

type Rep AuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.AuthenticationConfiguration

type Rep AuthenticationConfiguration = D1 ('MetaData "AuthenticationConfiguration" "Amazonka.Kendra.Types.AuthenticationConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AuthenticationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "basicAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BasicAuthenticationConfiguration]))))

newAuthenticationConfiguration :: AuthenticationConfiguration Source #

Create a value of AuthenticationConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:basicAuthentication:AuthenticationConfiguration', authenticationConfiguration_basicAuthentication - 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

data BasicAuthenticationConfiguration Source #

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

See: newBasicAuthenticationConfiguration smart constructor.

Instances

Instances details
FromJSON BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

ToJSON BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

Generic BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

Associated Types

type Rep BasicAuthenticationConfiguration :: Type -> Type #

Read BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

Show BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

NFData BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

Eq BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

Hashable BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

type Rep BasicAuthenticationConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration

type Rep BasicAuthenticationConfiguration = D1 ('MetaData "BasicAuthenticationConfiguration" "Amazonka.Kendra.Types.BasicAuthenticationConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BasicAuthenticationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newBasicAuthenticationConfiguration Source #

Create a value of BasicAuthenticationConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:host:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_host - 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".

$sel:port:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_port - 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.

$sel:credentials:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_credentials - 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

data BatchDeleteDocumentResponseFailedDocument Source #

Provides information about documents that could not be removed from an index by the BatchDeleteDocument API.

See: newBatchDeleteDocumentResponseFailedDocument smart constructor.

Instances

Instances details
FromJSON BatchDeleteDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument

Generic BatchDeleteDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument

Read BatchDeleteDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument

Show BatchDeleteDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument

NFData BatchDeleteDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument

Eq BatchDeleteDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument

Hashable BatchDeleteDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument

type Rep BatchDeleteDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument

type Rep BatchDeleteDocumentResponseFailedDocument = D1 ('MetaData "BatchDeleteDocumentResponseFailedDocument" "Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchDeleteDocumentResponseFailedDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBatchDeleteDocumentResponseFailedDocument :: BatchDeleteDocumentResponseFailedDocument Source #

Create a value of BatchDeleteDocumentResponseFailedDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:errorCode:BatchDeleteDocumentResponseFailedDocument', batchDeleteDocumentResponseFailedDocument_errorCode - The error code for why the document couldn't be removed from the index.

$sel:errorMessage:BatchDeleteDocumentResponseFailedDocument', batchDeleteDocumentResponseFailedDocument_errorMessage - An explanation for why the document couldn't be removed from the index.

$sel:id:BatchDeleteDocumentResponseFailedDocument', batchDeleteDocumentResponseFailedDocument_id - The identifier of the document that couldn't be removed from the index.

BatchGetDocumentStatusResponseError

data BatchGetDocumentStatusResponseError Source #

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

See: newBatchGetDocumentStatusResponseError smart constructor.

Instances

Instances details
FromJSON BatchGetDocumentStatusResponseError Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError

Generic BatchGetDocumentStatusResponseError Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError

Read BatchGetDocumentStatusResponseError Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError

Show BatchGetDocumentStatusResponseError Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError

NFData BatchGetDocumentStatusResponseError Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError

Eq BatchGetDocumentStatusResponseError Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError

Hashable BatchGetDocumentStatusResponseError Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError

type Rep BatchGetDocumentStatusResponseError Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError

type Rep BatchGetDocumentStatusResponseError = D1 ('MetaData "BatchGetDocumentStatusResponseError" "Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchGetDocumentStatusResponseError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBatchGetDocumentStatusResponseError :: BatchGetDocumentStatusResponseError Source #

Create a value of BatchGetDocumentStatusResponseError with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentId:BatchGetDocumentStatusResponseError', batchGetDocumentStatusResponseError_documentId - The identifier of the document whose status could not be retrieved.

$sel:errorCode:BatchGetDocumentStatusResponseError', batchGetDocumentStatusResponseError_errorCode - Indicates the source of the error.

$sel:errorMessage:BatchGetDocumentStatusResponseError', batchGetDocumentStatusResponseError_errorMessage - 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

data BatchPutDocumentResponseFailedDocument Source #

Provides information about a document that could not be indexed.

See: newBatchPutDocumentResponseFailedDocument smart constructor.

Instances

Instances details
FromJSON BatchPutDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument

Generic BatchPutDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument

Read BatchPutDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument

Show BatchPutDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument

NFData BatchPutDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument

Eq BatchPutDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument

Hashable BatchPutDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument

type Rep BatchPutDocumentResponseFailedDocument Source # 
Instance details

Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument

type Rep BatchPutDocumentResponseFailedDocument = D1 ('MetaData "BatchPutDocumentResponseFailedDocument" "Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchPutDocumentResponseFailedDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBatchPutDocumentResponseFailedDocument :: BatchPutDocumentResponseFailedDocument Source #

Create a value of BatchPutDocumentResponseFailedDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:errorCode:BatchPutDocumentResponseFailedDocument', batchPutDocumentResponseFailedDocument_errorCode - The type of error that caused the document to fail to be indexed.

$sel:errorMessage:BatchPutDocumentResponseFailedDocument', batchPutDocumentResponseFailedDocument_errorMessage - A description of the reason why the document could not be indexed.

$sel:id:BatchPutDocumentResponseFailedDocument', batchPutDocumentResponseFailedDocument_id - The identifier of the document.

BoxConfiguration

data BoxConfiguration Source #

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

See: newBoxConfiguration smart constructor.

Instances

Instances details
FromJSON BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

ToJSON BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

Generic BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

Associated Types

type Rep BoxConfiguration :: Type -> Type #

Read BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

Show BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

NFData BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

Methods

rnf :: BoxConfiguration -> () #

Eq BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

Hashable BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

type Rep BoxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.BoxConfiguration

type Rep BoxConfiguration = D1 ('MetaData "BoxConfiguration" "Amazonka.Kendra.Types.BoxConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BoxConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "commentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "crawlComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "crawlWebLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "fileFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))))) :*: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "taskFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "webLinkFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "enterpriseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newBoxConfiguration Source #

Create a value of BoxConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:commentFieldMappings:BoxConfiguration', boxConfiguration_commentFieldMappings - 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.

$sel:crawlComments:BoxConfiguration', boxConfiguration_crawlComments - TRUE to index comments.

$sel:crawlTasks:BoxConfiguration', boxConfiguration_crawlTasks - TRUE to index the contents of tasks.

$sel:crawlWebLinks:BoxConfiguration', boxConfiguration_crawlWebLinks - TRUE to index web links.

$sel:exclusionPatterns:BoxConfiguration', boxConfiguration_exclusionPatterns - 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.

$sel:fileFieldMappings:BoxConfiguration', boxConfiguration_fileFieldMappings - 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.

$sel:inclusionPatterns:BoxConfiguration', boxConfiguration_inclusionPatterns - 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.

$sel:taskFieldMappings:BoxConfiguration', boxConfiguration_taskFieldMappings - 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.

$sel:useChangeLog:BoxConfiguration', boxConfiguration_useChangeLog - 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.

$sel:vpcConfiguration:BoxConfiguration', boxConfiguration_vpcConfiguration - Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.

$sel:webLinkFieldMappings:BoxConfiguration', boxConfiguration_webLinkFieldMappings - 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.

$sel:enterpriseId:BoxConfiguration', boxConfiguration_enterpriseId - 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.

$sel:secretArn:BoxConfiguration', boxConfiguration_secretArn - 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

data CapacityUnitsConfiguration Source #

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

See: newCapacityUnitsConfiguration smart constructor.

Instances

Instances details
FromJSON CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

ToJSON CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

Generic CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

Associated Types

type Rep CapacityUnitsConfiguration :: Type -> Type #

Read CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

Show CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

NFData CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

Eq CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

Hashable CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

type Rep CapacityUnitsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration

type Rep CapacityUnitsConfiguration = D1 ('MetaData "CapacityUnitsConfiguration" "Amazonka.Kendra.Types.CapacityUnitsConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CapacityUnitsConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "storageCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "queryCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newCapacityUnitsConfiguration Source #

Create a value of CapacityUnitsConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:storageCapacityUnits:CapacityUnitsConfiguration', capacityUnitsConfiguration_storageCapacityUnits - 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.

$sel:queryCapacityUnits:CapacityUnitsConfiguration', capacityUnitsConfiguration_queryCapacityUnits - 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

data ClickFeedback Source #

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

See: newClickFeedback smart constructor.

Constructors

ClickFeedback' Text POSIX 

Instances

Instances details
ToJSON ClickFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.ClickFeedback

Generic ClickFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.ClickFeedback

Associated Types

type Rep ClickFeedback :: Type -> Type #

Read ClickFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.ClickFeedback

Show ClickFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.ClickFeedback

NFData ClickFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.ClickFeedback

Methods

rnf :: ClickFeedback -> () #

Eq ClickFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.ClickFeedback

Hashable ClickFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.ClickFeedback

type Rep ClickFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.ClickFeedback

type Rep ClickFeedback = D1 ('MetaData "ClickFeedback" "Amazonka.Kendra.Types.ClickFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ClickFeedback'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clickTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))

newClickFeedback Source #

Create a value of ClickFeedback with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resultId:ClickFeedback', clickFeedback_resultId - The identifier of the search result that was clicked.

$sel:clickTime:ClickFeedback', clickFeedback_clickTime - The Unix timestamp of the date and time that the result was clicked.

ColumnConfiguration

data ColumnConfiguration Source #

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

See: newColumnConfiguration smart constructor.

Instances

Instances details
FromJSON ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

ToJSON ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Generic ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Associated Types

type Rep ColumnConfiguration :: Type -> Type #

Read ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Show ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

NFData ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Methods

rnf :: ColumnConfiguration -> () #

Eq ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Hashable ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

type Rep ColumnConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ColumnConfiguration

type Rep ColumnConfiguration = D1 ('MetaData "ColumnConfiguration" "Amazonka.Kendra.Types.ColumnConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ColumnConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "documentIdColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "documentDataColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeDetectingColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))

newColumnConfiguration Source #

Create a value of ColumnConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentTitleColumnName:ColumnConfiguration', columnConfiguration_documentTitleColumnName - The column that contains the title of the document.

$sel:fieldMappings:ColumnConfiguration', columnConfiguration_fieldMappings - 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.

$sel:documentIdColumnName:ColumnConfiguration', columnConfiguration_documentIdColumnName - The column that provides the document's identifier.

$sel:documentDataColumnName:ColumnConfiguration', columnConfiguration_documentDataColumnName - The column that contains the contents of the document.

$sel:changeDetectingColumns:ColumnConfiguration', columnConfiguration_changeDetectingColumns - One to five columns that indicate when a document in the database has changed.

ConfluenceAttachmentConfiguration

data ConfluenceAttachmentConfiguration Source #

Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

See: newConfluenceAttachmentConfiguration smart constructor.

Instances

Instances details
FromJSON ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

ToJSON ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

Generic ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

Associated Types

type Rep ConfluenceAttachmentConfiguration :: Type -> Type #

Read ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

Show ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

NFData ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

Eq ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

Hashable ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

type Rep ConfluenceAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

type Rep ConfluenceAttachmentConfiguration = D1 ('MetaData "ConfluenceAttachmentConfiguration" "Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceAttachmentConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newConfluenceAttachmentConfiguration :: ConfluenceAttachmentConfiguration Source #

Create a value of ConfluenceAttachmentConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentFieldMappings:ConfluenceAttachmentConfiguration', confluenceAttachmentConfiguration_attachmentFieldMappings - 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.

$sel:crawlAttachments:ConfluenceAttachmentConfiguration', confluenceAttachmentConfiguration_crawlAttachments - TRUE to index attachments of pages and blogs in Confluence.

ConfluenceAttachmentToIndexFieldMapping

data 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 Confuence data source field names must exist in your Confluence custom metadata.

See: newConfluenceAttachmentToIndexFieldMapping smart constructor.

Instances

Instances details
FromJSON ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

ToJSON ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

Generic ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

Read ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

Show ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

NFData ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

Eq ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

Hashable ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

type Rep ConfluenceAttachmentToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping

type Rep ConfluenceAttachmentToIndexFieldMapping = D1 ('MetaData "ConfluenceAttachmentToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceAttachmentToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAttachmentFieldName)) :*: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluenceAttachmentToIndexFieldMapping :: ConfluenceAttachmentToIndexFieldMapping Source #

Create a value of ConfluenceAttachmentToIndexFieldMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceFieldName:ConfluenceAttachmentToIndexFieldMapping', confluenceAttachmentToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

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

$sel:dateFieldFormat:ConfluenceAttachmentToIndexFieldMapping', confluenceAttachmentToIndexFieldMapping_dateFieldFormat - 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.

$sel:indexFieldName:ConfluenceAttachmentToIndexFieldMapping', confluenceAttachmentToIndexFieldMapping_indexFieldName - 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

data ConfluenceBlogConfiguration Source #

Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.

See: newConfluenceBlogConfiguration smart constructor.

Instances

Instances details
FromJSON ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

ToJSON ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Generic ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Associated Types

type Rep ConfluenceBlogConfiguration :: Type -> Type #

Read ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Show ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

NFData ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Eq ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Hashable ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

type Rep ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

type Rep ConfluenceBlogConfiguration = D1 ('MetaData "ConfluenceBlogConfiguration" "Amazonka.Kendra.Types.ConfluenceBlogConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceBlogConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blogFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)))))

newConfluenceBlogConfiguration :: ConfluenceBlogConfiguration Source #

Create a value of ConfluenceBlogConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:blogFieldMappings:ConfluenceBlogConfiguration', confluenceBlogConfiguration_blogFieldMappings - 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

data ConfluenceBlogToIndexFieldMapping Source #

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

See: newConfluenceBlogToIndexFieldMapping smart constructor.

Instances

Instances details
FromJSON ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

ToJSON ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

Generic ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

Associated Types

type Rep ConfluenceBlogToIndexFieldMapping :: Type -> Type #

Read ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

Show ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

NFData ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

Eq ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

Hashable ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

type Rep ConfluenceBlogToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping

type Rep ConfluenceBlogToIndexFieldMapping = D1 ('MetaData "ConfluenceBlogToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceBlogToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceBlogFieldName)) :*: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluenceBlogToIndexFieldMapping :: ConfluenceBlogToIndexFieldMapping Source #

Create a value of ConfluenceBlogToIndexFieldMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceFieldName:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

$sel:dateFieldFormat:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_dateFieldFormat - 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.

$sel:indexFieldName:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_indexFieldName - 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

data ConfluenceConfiguration Source #

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

See: newConfluenceConfiguration smart constructor.

Instances

Instances details
FromJSON ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

ToJSON ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Generic ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Associated Types

type Rep ConfluenceConfiguration :: Type -> Type #

Read ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Show ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

NFData ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Methods

rnf :: ConfluenceConfiguration -> () #

Eq ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Hashable ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

type Rep ConfluenceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

type Rep ConfluenceConfiguration = D1 ('MetaData "ConfluenceConfiguration" "Amazonka.Kendra.Types.ConfluenceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAttachmentConfiguration)) :*: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAuthenticationType)) :*: S1 ('MetaSel ('Just "blogConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceBlogConfiguration)))) :*: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "pageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluencePageConfiguration))))) :*: ((S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration)) :*: (S1 ('MetaSel ('Just "spaceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceSpaceConfiguration)) :*: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :*: (S1 ('MetaSel ('Just "serverUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfluenceVersion))))))

newConfluenceConfiguration Source #

Create a value of ConfluenceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentConfiguration:ConfluenceConfiguration', confluenceConfiguration_attachmentConfiguration - Configuration information for indexing attachments to Confluence blogs and pages.

$sel:authenticationType:ConfluenceConfiguration', confluenceConfiguration_authenticationType - 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.

$sel:blogConfiguration:ConfluenceConfiguration', confluenceConfiguration_blogConfiguration - Configuration information for indexing Confluence blogs.

$sel:exclusionPatterns:ConfluenceConfiguration', confluenceConfiguration_exclusionPatterns - 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.

$sel:inclusionPatterns:ConfluenceConfiguration', confluenceConfiguration_inclusionPatterns - 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.

$sel:pageConfiguration:ConfluenceConfiguration', confluenceConfiguration_pageConfiguration - Configuration information for indexing Confluence pages.

$sel:proxyConfiguration:ConfluenceConfiguration', confluenceConfiguration_proxyConfiguration - 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.

$sel:spaceConfiguration:ConfluenceConfiguration', confluenceConfiguration_spaceConfiguration - Configuration information for indexing Confluence spaces.

$sel:vpcConfiguration:ConfluenceConfiguration', confluenceConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

$sel:serverUrl:ConfluenceConfiguration', confluenceConfiguration_serverUrl - 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/.

$sel:secretArn:ConfluenceConfiguration', confluenceConfiguration_secretArn - 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.

$sel:version:ConfluenceConfiguration', confluenceConfiguration_version - The version or the type of Confluence installation to connect to.

ConfluencePageConfiguration

data ConfluencePageConfiguration Source #

Configuration of the page settings for the Confluence data source.

See: newConfluencePageConfiguration smart constructor.

Instances

Instances details
FromJSON ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

ToJSON ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

Generic ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

Associated Types

type Rep ConfluencePageConfiguration :: Type -> Type #

Read ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

Show ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

NFData ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

Eq ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

Hashable ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

type Rep ConfluencePageConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration

type Rep ConfluencePageConfiguration = D1 ('MetaData "ConfluencePageConfiguration" "Amazonka.Kendra.Types.ConfluencePageConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluencePageConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluencePageToIndexFieldMapping)))))

newConfluencePageConfiguration :: ConfluencePageConfiguration Source #

Create a value of ConfluencePageConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pageFieldMappings:ConfluencePageConfiguration', confluencePageConfiguration_pageFieldMappings - 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

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

See: newConfluencePageToIndexFieldMapping smart constructor.

Instances

Instances details
FromJSON ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

ToJSON ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

Generic ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

Associated Types

type Rep ConfluencePageToIndexFieldMapping :: Type -> Type #

Read ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

Show ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

NFData ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

Eq ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

Hashable ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

type Rep ConfluencePageToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping

type Rep ConfluencePageToIndexFieldMapping = D1 ('MetaData "ConfluencePageToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluencePageToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluencePageFieldName)) :*: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluencePageToIndexFieldMapping :: ConfluencePageToIndexFieldMapping Source #

Create a value of ConfluencePageToIndexFieldMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceFieldName:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

$sel:dateFieldFormat:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_dateFieldFormat - 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.

$sel:indexFieldName:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_indexFieldName - 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

data ConfluenceSpaceConfiguration Source #

Configuration information for indexing Confluence spaces.

See: newConfluenceSpaceConfiguration smart constructor.

Instances

Instances details
FromJSON ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

ToJSON ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Generic ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Associated Types

type Rep ConfluenceSpaceConfiguration :: Type -> Type #

Read ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Show ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

NFData ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Eq ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Hashable ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

type Rep ConfluenceSpaceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

type Rep ConfluenceSpaceConfiguration = D1 ('MetaData "ConfluenceSpaceConfiguration" "Amazonka.Kendra.Types.ConfluenceSpaceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceSpaceConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlArchivedSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlPersonalSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "excludeSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "includeSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "spaceFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping)))))))

newConfluenceSpaceConfiguration :: ConfluenceSpaceConfiguration Source #

Create a value of ConfluenceSpaceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crawlArchivedSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_crawlArchivedSpaces - TRUE to index archived spaces.

$sel:crawlPersonalSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_crawlPersonalSpaces - 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.

$sel:excludeSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_excludeSpaces - 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.

$sel:includeSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_includeSpaces - 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.

$sel:spaceFieldMappings:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_spaceFieldMappings - 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

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

See: newConfluenceSpaceToIndexFieldMapping smart constructor.

Instances

Instances details
FromJSON ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

ToJSON ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

Generic ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

Associated Types

type Rep ConfluenceSpaceToIndexFieldMapping :: Type -> Type #

Read ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

Show ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

NFData ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

Eq ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

Hashable ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

type Rep ConfluenceSpaceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping

type Rep ConfluenceSpaceToIndexFieldMapping = D1 ('MetaData "ConfluenceSpaceToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceSpaceToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceSpaceFieldName)) :*: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluenceSpaceToIndexFieldMapping :: ConfluenceSpaceToIndexFieldMapping Source #

Create a value of ConfluenceSpaceToIndexFieldMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceFieldName:ConfluenceSpaceToIndexFieldMapping', confluenceSpaceToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

$sel:dateFieldFormat:ConfluenceSpaceToIndexFieldMapping', confluenceSpaceToIndexFieldMapping_dateFieldFormat - 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.

$sel:indexFieldName:ConfluenceSpaceToIndexFieldMapping', confluenceSpaceToIndexFieldMapping_indexFieldName - 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

data ConnectionConfiguration Source #

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

See: newConnectionConfiguration smart constructor.

Instances

Instances details
FromJSON ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

ToJSON ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Generic ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Associated Types

type Rep ConnectionConfiguration :: Type -> Type #

Read ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Show ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

NFData ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Methods

rnf :: ConnectionConfiguration -> () #

Eq ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

Hashable ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

type Rep ConnectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConnectionConfiguration

type Rep ConnectionConfiguration = D1 ('MetaData "ConnectionConfiguration" "Amazonka.Kendra.Types.ConnectionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConnectionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "databaseHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "databasePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newConnectionConfiguration Source #

Create a value of ConnectionConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:databaseHost:ConnectionConfiguration', connectionConfiguration_databaseHost - The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

$sel:databasePort:ConnectionConfiguration', connectionConfiguration_databasePort - The port that the database uses for connections.

$sel:databaseName:ConnectionConfiguration', connectionConfiguration_databaseName - The name of the database containing the document data.

$sel:tableName:ConnectionConfiguration', connectionConfiguration_tableName - The name of the table that contains the document data.

$sel:secretArn:ConnectionConfiguration', connectionConfiguration_secretArn - 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

data ContentSourceConfiguration Source #

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

See: newContentSourceConfiguration smart constructor.

Instances

Instances details
FromJSON ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

ToJSON ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

Generic ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

Associated Types

type Rep ContentSourceConfiguration :: Type -> Type #

Read ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

Show ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

NFData ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

Eq ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

Hashable ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

type Rep ContentSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ContentSourceConfiguration

type Rep ContentSourceConfiguration = D1 ('MetaData "ContentSourceConfiguration" "Amazonka.Kendra.Types.ContentSourceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ContentSourceConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "directPutContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "faqIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))))

newContentSourceConfiguration :: ContentSourceConfiguration Source #

Create a value of ContentSourceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceIds:ContentSourceConfiguration', contentSourceConfiguration_dataSourceIds - The identifier of the data sources you want to use for your Amazon Kendra experience.

$sel:directPutContent:ContentSourceConfiguration', contentSourceConfiguration_directPutContent - TRUE to use documents you indexed directly using the BatchPutDocument API.

$sel:faqIds:ContentSourceConfiguration', contentSourceConfiguration_faqIds - The identifier of the FAQs that you want to use for your Amazon Kendra experience.

Correction

data Correction Source #

A corrected misspelled word in a query.

See: newCorrection smart constructor.

Constructors

Correction' (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) 

Instances

Instances details
FromJSON Correction Source # 
Instance details

Defined in Amazonka.Kendra.Types.Correction

Generic Correction Source # 
Instance details

Defined in Amazonka.Kendra.Types.Correction

Associated Types

type Rep Correction :: Type -> Type #

Read Correction Source # 
Instance details

Defined in Amazonka.Kendra.Types.Correction

Show Correction Source # 
Instance details

Defined in Amazonka.Kendra.Types.Correction

NFData Correction Source # 
Instance details

Defined in Amazonka.Kendra.Types.Correction

Methods

rnf :: Correction -> () #

Eq Correction Source # 
Instance details

Defined in Amazonka.Kendra.Types.Correction

Hashable Correction Source # 
Instance details

Defined in Amazonka.Kendra.Types.Correction

type Rep Correction Source # 
Instance details

Defined in Amazonka.Kendra.Types.Correction

type Rep Correction = D1 ('MetaData "Correction" "Amazonka.Kendra.Types.Correction" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Correction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "correctedTerm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "term") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCorrection :: Correction Source #

Create a value of Correction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:beginOffset:Correction', correction_beginOffset - The zero-based location in the response string or text where the corrected word starts.

$sel:correctedTerm:Correction', correction_correctedTerm - The string or text of a corrected misspelled word in a query.

$sel:endOffset:Correction', correction_endOffset - The zero-based location in the response string or text where the corrected word ends.

$sel:term:Correction', correction_term - The string or text of a misspelled word in a query.

CustomDocumentEnrichmentConfiguration

data CustomDocumentEnrichmentConfiguration Source #

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

For more information, see Customizing document metadata during the ingestion process.

See: newCustomDocumentEnrichmentConfiguration smart constructor.

Instances

Instances details
FromJSON CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

ToJSON CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

Generic CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

Read CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

Show CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

NFData CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

Eq CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

Hashable CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

type Rep CustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

type Rep CustomDocumentEnrichmentConfiguration = D1 ('MetaData "CustomDocumentEnrichmentConfiguration" "Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CustomDocumentEnrichmentConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "inlineConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InlineCustomDocumentEnrichmentConfiguration])) :*: S1 ('MetaSel ('Just "postExtractionHookConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookConfiguration))) :*: (S1 ('MetaSel ('Just "preExtractionHookConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookConfiguration)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCustomDocumentEnrichmentConfiguration :: CustomDocumentEnrichmentConfiguration Source #

Create a value of CustomDocumentEnrichmentConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:inlineConfigurations:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_inlineConfigurations - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

$sel:postExtractionHookConfiguration:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_postExtractionHookConfiguration - 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.

$sel:preExtractionHookConfiguration:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_preExtractionHookConfiguration - 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.

$sel:roleArn:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_roleArn - 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

data DataSourceConfiguration Source #

Provides the configuration information for an Amazon Kendra data source.

See: newDataSourceConfiguration smart constructor.

Instances

Instances details
FromJSON DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

ToJSON DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

Generic DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

Associated Types

type Rep DataSourceConfiguration :: Type -> Type #

Read DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

Show DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

NFData DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

Methods

rnf :: DataSourceConfiguration -> () #

Eq DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

Hashable DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

type Rep DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceConfiguration

type Rep DataSourceConfiguration = D1 ('MetaData "DataSourceConfiguration" "Amazonka.Kendra.Types.DataSourceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceConfiguration'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alfrescoConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlfrescoConfiguration)) :*: S1 ('MetaSel ('Just "boxConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BoxConfiguration))) :*: (S1 ('MetaSel ('Just "confluenceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceConfiguration)) :*: S1 ('MetaSel ('Just "databaseConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatabaseConfiguration)))) :*: ((S1 ('MetaSel ('Just "fsxConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FsxConfiguration)) :*: S1 ('MetaSel ('Just "gitHubConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GitHubConfiguration))) :*: (S1 ('MetaSel ('Just "googleDriveConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GoogleDriveConfiguration)) :*: (S1 ('MetaSel ('Just "jiraConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JiraConfiguration)) :*: S1 ('MetaSel ('Just "oneDriveConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OneDriveConfiguration)))))) :*: (((S1 ('MetaSel ('Just "quipConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuipConfiguration)) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DataSourceConfiguration))) :*: (S1 ('MetaSel ('Just "salesforceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceConfiguration)) :*: S1 ('MetaSel ('Just "serviceNowConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowConfiguration)))) :*: ((S1 ('MetaSel ('Just "sharePointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SharePointConfiguration)) :*: S1 ('MetaSel ('Just "slackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlackConfiguration))) :*: (S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)) :*: (S1 ('MetaSel ('Just "webCrawlerConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebCrawlerConfiguration)) :*: S1 ('MetaSel ('Just "workDocsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkDocsConfiguration))))))))

newDataSourceConfiguration :: DataSourceConfiguration Source #

Create a value of DataSourceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alfrescoConfiguration:DataSourceConfiguration', dataSourceConfiguration_alfrescoConfiguration - Provides the configuration information to connect to Alfresco as your data source.

$sel:boxConfiguration:DataSourceConfiguration', dataSourceConfiguration_boxConfiguration - Provides the configuration information to connect to Box as your data source.

$sel:confluenceConfiguration:DataSourceConfiguration', dataSourceConfiguration_confluenceConfiguration - Provides the configuration information to connect to Confluence as your data source.

$sel:databaseConfiguration:DataSourceConfiguration', dataSourceConfiguration_databaseConfiguration - Provides the configuration information to connect to a database as your data source.

$sel:fsxConfiguration:DataSourceConfiguration', dataSourceConfiguration_fsxConfiguration - Provides the configuration information to connect to Amazon FSx as your data source.

$sel:gitHubConfiguration:DataSourceConfiguration', dataSourceConfiguration_gitHubConfiguration - Provides the configuration information to connect to GitHub as your data source.

$sel:googleDriveConfiguration:DataSourceConfiguration', dataSourceConfiguration_googleDriveConfiguration - Provides the configuration information to connect to Google Drive as your data source.

$sel:jiraConfiguration:DataSourceConfiguration', dataSourceConfiguration_jiraConfiguration - Provides the configuration information to connect to Jira as your data source.

$sel:oneDriveConfiguration:DataSourceConfiguration', dataSourceConfiguration_oneDriveConfiguration - Provides the configuration information to connect to Microsoft OneDrive as your data source.

$sel:quipConfiguration:DataSourceConfiguration', dataSourceConfiguration_quipConfiguration - Provides the configuration information to connect to Quip as your data source.

$sel:s3Configuration:DataSourceConfiguration', dataSourceConfiguration_s3Configuration - Provides the configuration information to connect to an Amazon S3 bucket as your data source.

$sel:salesforceConfiguration:DataSourceConfiguration', dataSourceConfiguration_salesforceConfiguration - Provides the configuration information to connect to Salesforce as your data source.

$sel:serviceNowConfiguration:DataSourceConfiguration', dataSourceConfiguration_serviceNowConfiguration - Provides the configuration information to connect to ServiceNow as your data source.

$sel:sharePointConfiguration:DataSourceConfiguration', dataSourceConfiguration_sharePointConfiguration - Provides the configuration information to connect to Microsoft SharePoint as your data source.

$sel:slackConfiguration:DataSourceConfiguration', dataSourceConfiguration_slackConfiguration - Provides the configuration information to connect to Slack as your data source.

$sel:templateConfiguration:DataSourceConfiguration', dataSourceConfiguration_templateConfiguration - Provides a template for the configuration information to connect to your data source.

$sel:webCrawlerConfiguration:DataSourceConfiguration', dataSourceConfiguration_webCrawlerConfiguration - Undocumented member.

$sel:workDocsConfiguration:DataSourceConfiguration', dataSourceConfiguration_workDocsConfiguration - Provides the configuration information to connect to Amazon WorkDocs as your data source.

DataSourceGroup

data DataSourceGroup Source #

Data source information for user context filtering.

See: newDataSourceGroup smart constructor.

Constructors

DataSourceGroup' Text Text 

Instances

Instances details
ToJSON DataSourceGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceGroup

Generic DataSourceGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceGroup

Associated Types

type Rep DataSourceGroup :: Type -> Type #

Read DataSourceGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceGroup

Show DataSourceGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceGroup

NFData DataSourceGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceGroup

Methods

rnf :: DataSourceGroup -> () #

Eq DataSourceGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceGroup

Hashable DataSourceGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceGroup

type Rep DataSourceGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceGroup

type Rep DataSourceGroup = D1 ('MetaData "DataSourceGroup" "Amazonka.Kendra.Types.DataSourceGroup" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDataSourceGroup Source #

Create a value of DataSourceGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groupId:DataSourceGroup', dataSourceGroup_groupId - 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.

$sel:dataSourceId:DataSourceGroup', dataSourceGroup_dataSourceId - 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

data DataSourceSummary Source #

Summary information for a Amazon Kendra data source.

See: newDataSourceSummary smart constructor.

Instances

Instances details
FromJSON DataSourceSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSummary

Generic DataSourceSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSummary

Associated Types

type Rep DataSourceSummary :: Type -> Type #

Read DataSourceSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSummary

Show DataSourceSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSummary

NFData DataSourceSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSummary

Methods

rnf :: DataSourceSummary -> () #

Eq DataSourceSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSummary

Hashable DataSourceSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSummary

type Rep DataSourceSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSummary

newDataSourceSummary :: DataSourceSummary Source #

Create a value of DataSourceSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:DataSourceSummary', dataSourceSummary_createdAt - The UNIX datetime that the data source was created.

$sel:id:DataSourceSummary', dataSourceSummary_id - The identifier for the data source.

$sel:languageCode:DataSourceSummary', dataSourceSummary_languageCode - 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.

$sel:name:DataSourceSummary', dataSourceSummary_name - The name of the data source.

$sel:status:DataSourceSummary', dataSourceSummary_status - The status of the data source. When the status is ACTIVE the data source is ready to use.

$sel:type':DataSourceSummary', dataSourceSummary_type - The type of the data source.

$sel:updatedAt:DataSourceSummary', dataSourceSummary_updatedAt - The UNIX datetime that the data source was lasted updated.

DataSourceSyncJob

data DataSourceSyncJob Source #

Provides information about a data source synchronization job.

See: newDataSourceSyncJob smart constructor.

Instances

Instances details
FromJSON DataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Generic DataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Associated Types

type Rep DataSourceSyncJob :: Type -> Type #

Read DataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Show DataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

NFData DataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Methods

rnf :: DataSourceSyncJob -> () #

Eq DataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

Hashable DataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

type Rep DataSourceSyncJob Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJob

newDataSourceSyncJob :: DataSourceSyncJob Source #

Create a value of DataSourceSyncJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceErrorCode:DataSourceSyncJob', dataSourceSyncJob_dataSourceErrorCode - 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.

$sel:endTime:DataSourceSyncJob', dataSourceSyncJob_endTime - The UNIX datetime that the synchronization job completed.

$sel:errorCode:DataSourceSyncJob', dataSourceSyncJob_errorCode - If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

$sel:errorMessage:DataSourceSyncJob', dataSourceSyncJob_errorMessage - If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

$sel:executionId:DataSourceSyncJob', dataSourceSyncJob_executionId - A identifier for the synchronization job.

$sel:metrics:DataSourceSyncJob', dataSourceSyncJob_metrics - 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.

$sel:startTime:DataSourceSyncJob', dataSourceSyncJob_startTime - The UNIX datetime that the synchronization job started.

$sel:status:DataSourceSyncJob', dataSourceSyncJob_status - 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

data DataSourceSyncJobMetricTarget Source #

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

See: newDataSourceSyncJobMetricTarget smart constructor.

Instances

Instances details
ToJSON DataSourceSyncJobMetricTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget

Generic DataSourceSyncJobMetricTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget

Associated Types

type Rep DataSourceSyncJobMetricTarget :: Type -> Type #

Read DataSourceSyncJobMetricTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget

Show DataSourceSyncJobMetricTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget

NFData DataSourceSyncJobMetricTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget

Eq DataSourceSyncJobMetricTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget

Hashable DataSourceSyncJobMetricTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget

type Rep DataSourceSyncJobMetricTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget

type Rep DataSourceSyncJobMetricTarget = D1 ('MetaData "DataSourceSyncJobMetricTarget" "Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceSyncJobMetricTarget'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceSyncJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDataSourceSyncJobMetricTarget Source #

Create a value of DataSourceSyncJobMetricTarget with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceSyncJobId:DataSourceSyncJobMetricTarget', dataSourceSyncJobMetricTarget_dataSourceSyncJobId - 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.

$sel:dataSourceId:DataSourceSyncJobMetricTarget', dataSourceSyncJobMetricTarget_dataSourceId - The ID of the data source that is running the sync job.

DataSourceSyncJobMetrics

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

See: newDataSourceSyncJobMetrics smart constructor.

Instances

Instances details
FromJSON DataSourceSyncJobMetrics Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics

Generic DataSourceSyncJobMetrics Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics

Associated Types

type Rep DataSourceSyncJobMetrics :: Type -> Type #

Read DataSourceSyncJobMetrics Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics

Show DataSourceSyncJobMetrics Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics

NFData DataSourceSyncJobMetrics Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics

Eq DataSourceSyncJobMetrics Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics

Hashable DataSourceSyncJobMetrics Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics

type Rep DataSourceSyncJobMetrics Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics

type Rep DataSourceSyncJobMetrics = D1 ('MetaData "DataSourceSyncJobMetrics" "Amazonka.Kendra.Types.DataSourceSyncJobMetrics" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceSyncJobMetrics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentsAdded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentsDeleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "documentsFailed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "documentsModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentsScanned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDataSourceSyncJobMetrics :: DataSourceSyncJobMetrics Source #

Create a value of DataSourceSyncJobMetrics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentsAdded:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsAdded - The number of documents added from the data source up to now in the data source sync.

$sel:documentsDeleted:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsDeleted - The number of documents deleted from the data source up to now in the data source sync run.

$sel:documentsFailed:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsFailed - The number of documents that failed to sync from the data source up to now in the data source sync run.

$sel:documentsModified:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsModified - The number of documents modified in the data source up to now in the data source sync run.

$sel:documentsScanned:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsScanned - The current number of documents crawled by the current sync job in the data source.

DataSourceToIndexFieldMapping

data DataSourceToIndexFieldMapping Source #

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex API.

See: newDataSourceToIndexFieldMapping smart constructor.

Instances

Instances details
FromJSON DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

ToJSON DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

Generic DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

Associated Types

type Rep DataSourceToIndexFieldMapping :: Type -> Type #

Read DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

Show DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

NFData DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

Eq DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

Hashable DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

type Rep DataSourceToIndexFieldMapping Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping

type Rep DataSourceToIndexFieldMapping = D1 ('MetaData "DataSourceToIndexFieldMapping" "Amazonka.Kendra.Types.DataSourceToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDataSourceToIndexFieldMapping Source #

Create a value of DataSourceToIndexFieldMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dateFieldFormat:DataSourceToIndexFieldMapping', dataSourceToIndexFieldMapping_dateFieldFormat - The type of data stored in the column or attribute.

$sel:dataSourceFieldName:DataSourceToIndexFieldMapping', dataSourceToIndexFieldMapping_dataSourceFieldName - The name of the column or attribute in the data source.

$sel:indexFieldName:DataSourceToIndexFieldMapping', dataSourceToIndexFieldMapping_indexFieldName - The name of the field in the index.

DataSourceVpcConfiguration

data DataSourceVpcConfiguration Source #

Provides the configuration information to connect to an Amazon VPC.

See: newDataSourceVpcConfiguration smart constructor.

Instances

Instances details
FromJSON DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

ToJSON DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

Generic DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

Associated Types

type Rep DataSourceVpcConfiguration :: Type -> Type #

Read DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

Show DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

NFData DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

Eq DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

Hashable DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

type Rep DataSourceVpcConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration

type Rep DataSourceVpcConfiguration = D1 ('MetaData "DataSourceVpcConfiguration" "Amazonka.Kendra.Types.DataSourceVpcConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceVpcConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newDataSourceVpcConfiguration Source #

Create a value of DataSourceVpcConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:subnetIds:DataSourceVpcConfiguration', dataSourceVpcConfiguration_subnetIds - 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.

$sel:securityGroupIds:DataSourceVpcConfiguration', dataSourceVpcConfiguration_securityGroupIds - 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

data DatabaseConfiguration Source #

Provides the configuration information to connect to a index.

See: newDatabaseConfiguration smart constructor.

Instances

Instances details
FromJSON DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

ToJSON DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Generic DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Associated Types

type Rep DatabaseConfiguration :: Type -> Type #

Read DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Show DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

NFData DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Methods

rnf :: DatabaseConfiguration -> () #

Eq DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

Hashable DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

type Rep DatabaseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DatabaseConfiguration

type Rep DatabaseConfiguration = D1 ('MetaData "DatabaseConfiguration" "Amazonka.Kendra.Types.DatabaseConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DatabaseConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aclConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AclConfiguration)) :*: (S1 ('MetaSel ('Just "sqlConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SqlConfiguration)) :*: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :*: (S1 ('MetaSel ('Just "databaseEngineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DatabaseEngineType) :*: (S1 ('MetaSel ('Just "connectionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConnectionConfiguration) :*: S1 ('MetaSel ('Just "columnConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ColumnConfiguration)))))

newDatabaseConfiguration Source #

Create a value of DatabaseConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aclConfiguration:DatabaseConfiguration', databaseConfiguration_aclConfiguration - Information about the database column that provides information for user context filtering.

$sel:sqlConfiguration:DatabaseConfiguration', databaseConfiguration_sqlConfiguration - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

$sel:vpcConfiguration:DatabaseConfiguration', databaseConfiguration_vpcConfiguration - Undocumented member.

$sel:databaseEngineType:DatabaseConfiguration', databaseConfiguration_databaseEngineType - The type of database engine that runs the database.

$sel:connectionConfiguration:DatabaseConfiguration', databaseConfiguration_connectionConfiguration - Configuration information that's required to connect to a database.

$sel:columnConfiguration:DatabaseConfiguration', databaseConfiguration_columnConfiguration - Information about where the index should get the document information from the database.

Document

data Document Source #

A document in an index.

See: newDocument smart constructor.

Instances

Instances details
ToJSON Document Source # 
Instance details

Defined in Amazonka.Kendra.Types.Document

Generic Document Source # 
Instance details

Defined in Amazonka.Kendra.Types.Document

Associated Types

type Rep Document :: Type -> Type #

Methods

from :: Document -> Rep Document x #

to :: Rep Document x -> Document #

Read Document Source # 
Instance details

Defined in Amazonka.Kendra.Types.Document

Show Document Source # 
Instance details

Defined in Amazonka.Kendra.Types.Document

NFData Document Source # 
Instance details

Defined in Amazonka.Kendra.Types.Document

Methods

rnf :: Document -> () #

Eq Document Source # 
Instance details

Defined in Amazonka.Kendra.Types.Document

Hashable Document Source # 
Instance details

Defined in Amazonka.Kendra.Types.Document

Methods

hashWithSalt :: Int -> Document -> Int #

hash :: Document -> Int #

type Rep Document Source # 
Instance details

Defined in Amazonka.Kendra.Types.Document

newDocument Source #

Create a value of Document with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessControlConfigurationId:Document', document_accessControlConfigurationId - The identifier of the access control configuration that you want to apply to the document.

$sel:accessControlList:Document', document_accessControlList - 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.

$sel:attributes:Document', document_attributes - 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.

$sel:blob:Document', document_blob - 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.

$sel:contentType:Document', document_contentType - The file type of the document in the Blob field.

$sel:hierarchicalAccessControlList:Document', document_hierarchicalAccessControlList - The list of principal lists that define the hierarchy for which documents users should have access to.

$sel:s3Path:Document', document_s3Path - Undocumented member.

$sel:title:Document', document_title - The title of the document.

$sel:id:Document', document_id - 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

data DocumentAttribute Source #

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

See: newDocumentAttribute smart constructor.

Instances

Instances details
FromJSON DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

ToJSON DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

Generic DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

Associated Types

type Rep DocumentAttribute :: Type -> Type #

Read DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

Show DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

NFData DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

Methods

rnf :: DocumentAttribute -> () #

Eq DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

Hashable DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

type Rep DocumentAttribute Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttribute

type Rep DocumentAttribute = D1 ('MetaData "DocumentAttribute" "Amazonka.Kendra.Types.DocumentAttribute" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentAttributeValue)))

newDocumentAttribute Source #

Create a value of DocumentAttribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:DocumentAttribute', documentAttribute_key - The identifier for the attribute.

$sel:value:DocumentAttribute', documentAttribute_value - The value of the attribute.

DocumentAttributeCondition

data DocumentAttributeCondition Source #

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

See: newDocumentAttributeCondition smart constructor.

Instances

Instances details
FromJSON DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

ToJSON DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

Generic DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

Associated Types

type Rep DocumentAttributeCondition :: Type -> Type #

Read DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

Show DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

NFData DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

Eq DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

Hashable DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

type Rep DocumentAttributeCondition Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeCondition

type Rep DocumentAttributeCondition = D1 ('MetaData "DocumentAttributeCondition" "Amazonka.Kendra.Types.DocumentAttributeCondition" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "conditionOnValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValue)) :*: (S1 ('MetaSel ('Just "conditionDocumentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConditionOperator))))

newDocumentAttributeCondition Source #

Create a value of DocumentAttributeCondition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:conditionOnValue:DocumentAttributeCondition', documentAttributeCondition_conditionOnValue - 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.

$sel:conditionDocumentAttributeKey:DocumentAttributeCondition', documentAttributeCondition_conditionDocumentAttributeKey - 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.

$sel:operator:DocumentAttributeCondition', documentAttributeCondition_operator - The condition operator.

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

DocumentAttributeTarget

data DocumentAttributeTarget Source #

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

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

You can also use this with DocumentAttributeCondition.

See: newDocumentAttributeTarget smart constructor.

Instances

Instances details
FromJSON DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

ToJSON DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

Generic DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

Associated Types

type Rep DocumentAttributeTarget :: Type -> Type #

Read DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

Show DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

NFData DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

Methods

rnf :: DocumentAttributeTarget -> () #

Eq DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

Hashable DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

type Rep DocumentAttributeTarget Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeTarget

type Rep DocumentAttributeTarget = D1 ('MetaData "DocumentAttributeTarget" "Amazonka.Kendra.Types.DocumentAttributeTarget" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeTarget'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetDocumentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "targetDocumentAttributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValue)) :*: S1 ('MetaSel ('Just "targetDocumentAttributeValueDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newDocumentAttributeTarget :: DocumentAttributeTarget Source #

Create a value of DocumentAttributeTarget with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:targetDocumentAttributeKey:DocumentAttributeTarget', documentAttributeTarget_targetDocumentAttributeKey - 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.

$sel:targetDocumentAttributeValue:DocumentAttributeTarget', documentAttributeTarget_targetDocumentAttributeValue - 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'.

$sel:targetDocumentAttributeValueDeletion:DocumentAttributeTarget', documentAttributeTarget_targetDocumentAttributeValueDeletion - 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

data DocumentAttributeValue Source #

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

See: newDocumentAttributeValue smart constructor.

Instances

Instances details
FromJSON DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

ToJSON DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Generic DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Associated Types

type Rep DocumentAttributeValue :: Type -> Type #

Read DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Show DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

NFData DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

rnf :: DocumentAttributeValue -> () #

Eq DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Hashable DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

type Rep DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

type Rep DocumentAttributeValue = D1 ('MetaData "DocumentAttributeValue" "Amazonka.Kendra.Types.DocumentAttributeValue" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dateValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "longValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "stringListValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "stringValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentAttributeValue :: DocumentAttributeValue Source #

Create a value of DocumentAttributeValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dateValue:DocumentAttributeValue', documentAttributeValue_dateValue - 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.

$sel:longValue:DocumentAttributeValue', documentAttributeValue_longValue - A long integer value.

$sel:stringListValue:DocumentAttributeValue', documentAttributeValue_stringListValue - A list of strings. The default maximum length or number of strings is 10.

$sel:stringValue:DocumentAttributeValue', documentAttributeValue_stringValue - A string, such as "department".

DocumentAttributeValueCountPair

data DocumentAttributeValueCountPair Source #

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

See: newDocumentAttributeValueCountPair smart constructor.

Instances

Instances details
FromJSON DocumentAttributeValueCountPair Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair

Generic DocumentAttributeValueCountPair Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair

Associated Types

type Rep DocumentAttributeValueCountPair :: Type -> Type #

Read DocumentAttributeValueCountPair Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair

Show DocumentAttributeValueCountPair Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair

NFData DocumentAttributeValueCountPair Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair

Eq DocumentAttributeValueCountPair Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair

Hashable DocumentAttributeValueCountPair Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair

type Rep DocumentAttributeValueCountPair Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair

type Rep DocumentAttributeValueCountPair = D1 ('MetaData "DocumentAttributeValueCountPair" "Amazonka.Kendra.Types.DocumentAttributeValueCountPair" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeValueCountPair'" 'PrefixI 'True) (S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "documentAttributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValue)) :*: S1 ('MetaSel ('Just "facetResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FacetResult])))))

newDocumentAttributeValueCountPair :: DocumentAttributeValueCountPair Source #

Create a value of DocumentAttributeValueCountPair with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:count:DocumentAttributeValueCountPair', documentAttributeValueCountPair_count - The number of documents in the response that have the attribute value for the key.

$sel:documentAttributeValue:DocumentAttributeValueCountPair', documentAttributeValueCountPair_documentAttributeValue - The value of the attribute. For example, "HR".

$sel:facetResults:DocumentAttributeValueCountPair', documentAttributeValueCountPair_facetResults - 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

data DocumentInfo Source #

Identifies a document for which to retrieve status information

See: newDocumentInfo smart constructor.

Instances

Instances details
ToJSON DocumentInfo Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentInfo

Generic DocumentInfo Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentInfo

Associated Types

type Rep DocumentInfo :: Type -> Type #

Read DocumentInfo Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentInfo

Show DocumentInfo Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentInfo

NFData DocumentInfo Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentInfo

Methods

rnf :: DocumentInfo -> () #

Eq DocumentInfo Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentInfo

Hashable DocumentInfo Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentInfo

type Rep DocumentInfo Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentInfo

type Rep DocumentInfo = D1 ('MetaData "DocumentInfo" "Amazonka.Kendra.Types.DocumentInfo" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttribute])) :*: S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDocumentInfo Source #

Create a value of DocumentInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributes:DocumentInfo', documentInfo_attributes - 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".

$sel:documentId:DocumentInfo', documentInfo_documentId - The identifier of the document.

DocumentMetadataConfiguration

data DocumentMetadataConfiguration Source #

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

See: newDocumentMetadataConfiguration smart constructor.

Instances

Instances details
FromJSON DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

ToJSON DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

Generic DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

Associated Types

type Rep DocumentMetadataConfiguration :: Type -> Type #

Read DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

Show DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

NFData DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

Eq DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

Hashable DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

type Rep DocumentMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration

type Rep DocumentMetadataConfiguration = D1 ('MetaData "DocumentMetadataConfiguration" "Amazonka.Kendra.Types.DocumentMetadataConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentMetadataConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "relevance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Relevance)) :*: S1 ('MetaSel ('Just "search") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Search))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentAttributeValueType))))

newDocumentMetadataConfiguration Source #

Create a value of DocumentMetadataConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:relevance:DocumentMetadataConfiguration', documentMetadataConfiguration_relevance - Provides tuning parameters to determine how the field affects the search results.

$sel:search:DocumentMetadataConfiguration', documentMetadataConfiguration_search - Provides information about how the field is used during a search.

$sel:name:DocumentMetadataConfiguration', documentMetadataConfiguration_name - The name of the index field.

$sel:type':DocumentMetadataConfiguration', documentMetadataConfiguration_type - The data type of the index field.

DocumentRelevanceConfiguration

data DocumentRelevanceConfiguration Source #

Overrides the document relevance properties of a custom index field.

See: newDocumentRelevanceConfiguration smart constructor.

Instances

Instances details
ToJSON DocumentRelevanceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration

Generic DocumentRelevanceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration

Associated Types

type Rep DocumentRelevanceConfiguration :: Type -> Type #

Read DocumentRelevanceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration

Show DocumentRelevanceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration

NFData DocumentRelevanceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration

Eq DocumentRelevanceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration

Hashable DocumentRelevanceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration

type Rep DocumentRelevanceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration

type Rep DocumentRelevanceConfiguration = D1 ('MetaData "DocumentRelevanceConfiguration" "Amazonka.Kendra.Types.DocumentRelevanceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentRelevanceConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "relevance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Relevance)))

newDocumentRelevanceConfiguration Source #

Create a value of DocumentRelevanceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:DocumentRelevanceConfiguration', documentRelevanceConfiguration_name - The name of the index field.

$sel:relevance:DocumentRelevanceConfiguration', documentRelevanceConfiguration_relevance - Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

DocumentsMetadataConfiguration

data DocumentsMetadataConfiguration Source #

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

See: newDocumentsMetadataConfiguration smart constructor.

Instances

Instances details
FromJSON DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

ToJSON DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

Generic DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

Associated Types

type Rep DocumentsMetadataConfiguration :: Type -> Type #

Read DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

Show DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

NFData DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

Eq DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

Hashable DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

type Rep DocumentsMetadataConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration

type Rep DocumentsMetadataConfiguration = D1 ('MetaData "DocumentsMetadataConfiguration" "Amazonka.Kendra.Types.DocumentsMetadataConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentsMetadataConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDocumentsMetadataConfiguration :: DocumentsMetadataConfiguration Source #

Create a value of DocumentsMetadataConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Prefix:DocumentsMetadataConfiguration', documentsMetadataConfiguration_s3Prefix - 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

data EntityConfiguration Source #

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

See: newEntityConfiguration smart constructor.

Instances

Instances details
ToJSON EntityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityConfiguration

Generic EntityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityConfiguration

Associated Types

type Rep EntityConfiguration :: Type -> Type #

Read EntityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityConfiguration

Show EntityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityConfiguration

NFData EntityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityConfiguration

Methods

rnf :: EntityConfiguration -> () #

Eq EntityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityConfiguration

Hashable EntityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityConfiguration

type Rep EntityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityConfiguration

type Rep EntityConfiguration = D1 ('MetaData "EntityConfiguration" "Amazonka.Kendra.Types.EntityConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "EntityConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EntityType)))

newEntityConfiguration Source #

Create a value of EntityConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityId:EntityConfiguration', entityConfiguration_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:entityType:EntityConfiguration', entityConfiguration_entityType - Specifies whether you are configuring a User or a Group.

EntityDisplayData

data EntityDisplayData Source #

Information about the user entity.

See: newEntityDisplayData smart constructor.

Instances

Instances details
FromJSON EntityDisplayData Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityDisplayData

Generic EntityDisplayData Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityDisplayData

Associated Types

type Rep EntityDisplayData :: Type -> Type #

Show EntityDisplayData Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityDisplayData

NFData EntityDisplayData Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityDisplayData

Methods

rnf :: EntityDisplayData -> () #

Eq EntityDisplayData Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityDisplayData

Hashable EntityDisplayData Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityDisplayData

type Rep EntityDisplayData Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityDisplayData

type Rep EntityDisplayData = D1 ('MetaData "EntityDisplayData" "Amazonka.Kendra.Types.EntityDisplayData" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "EntityDisplayData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "firstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "identifiedUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))))

newEntityDisplayData :: EntityDisplayData Source #

Create a value of EntityDisplayData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:firstName:EntityDisplayData', entityDisplayData_firstName - The first name of the user.

$sel:groupName:EntityDisplayData', entityDisplayData_groupName - The name of the group.

$sel:identifiedUserName:EntityDisplayData', entityDisplayData_identifiedUserName - The user name of the user.

$sel:lastName:EntityDisplayData', entityDisplayData_lastName - The last name of the user.

$sel:userName:EntityDisplayData', entityDisplayData_userName - The name of the user.

EntityPersonaConfiguration

data EntityPersonaConfiguration Source #

Provides the configuration information for users or groups in your IAM Identity Center identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.

See: newEntityPersonaConfiguration smart constructor.

Instances

Instances details
ToJSON EntityPersonaConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration

Generic EntityPersonaConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration

Associated Types

type Rep EntityPersonaConfiguration :: Type -> Type #

Read EntityPersonaConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration

Show EntityPersonaConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration

NFData EntityPersonaConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration

Eq EntityPersonaConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration

Hashable EntityPersonaConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration

type Rep EntityPersonaConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration

type Rep EntityPersonaConfiguration = D1 ('MetaData "EntityPersonaConfiguration" "Amazonka.Kendra.Types.EntityPersonaConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "EntityPersonaConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "persona") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Persona)))

newEntityPersonaConfiguration Source #

Create a value of EntityPersonaConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityId:EntityPersonaConfiguration', entityPersonaConfiguration_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:persona:EntityPersonaConfiguration', entityPersonaConfiguration_persona - 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

data ExperienceConfiguration Source #

Provides the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.

See: newExperienceConfiguration smart constructor.

Instances

Instances details
FromJSON ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

ToJSON ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

Generic ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

Associated Types

type Rep ExperienceConfiguration :: Type -> Type #

Read ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

Show ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

NFData ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

Methods

rnf :: ExperienceConfiguration -> () #

Eq ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

Hashable ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

type Rep ExperienceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceConfiguration

type Rep ExperienceConfiguration = D1 ('MetaData "ExperienceConfiguration" "Amazonka.Kendra.Types.ExperienceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ExperienceConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contentSourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentSourceConfiguration)) :*: S1 ('MetaSel ('Just "userIdentityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserIdentityConfiguration))))

newExperienceConfiguration :: ExperienceConfiguration Source #

Create a value of ExperienceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentSourceConfiguration:ExperienceConfiguration', experienceConfiguration_contentSourceConfiguration - 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.

$sel:userIdentityConfiguration:ExperienceConfiguration', experienceConfiguration_userIdentityConfiguration - The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

ExperienceEndpoint

data ExperienceEndpoint Source #

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

See: newExperienceEndpoint smart constructor.

Instances

Instances details
FromJSON ExperienceEndpoint Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEndpoint

Generic ExperienceEndpoint Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEndpoint

Associated Types

type Rep ExperienceEndpoint :: Type -> Type #

Read ExperienceEndpoint Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEndpoint

Show ExperienceEndpoint Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEndpoint

NFData ExperienceEndpoint Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEndpoint

Methods

rnf :: ExperienceEndpoint -> () #

Eq ExperienceEndpoint Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEndpoint

Hashable ExperienceEndpoint Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEndpoint

type Rep ExperienceEndpoint Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEndpoint

type Rep ExperienceEndpoint = D1 ('MetaData "ExperienceEndpoint" "Amazonka.Kendra.Types.ExperienceEndpoint" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ExperienceEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType))))

newExperienceEndpoint :: ExperienceEndpoint Source #

Create a value of ExperienceEndpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endpoint:ExperienceEndpoint', experienceEndpoint_endpoint - The endpoint of your Amazon Kendra experience.

$sel:endpointType:ExperienceEndpoint', experienceEndpoint_endpointType - 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

data ExperienceEntitiesSummary Source #

Summary information for users or groups in your IAM Identity Center identity source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

See: newExperienceEntitiesSummary smart constructor.

Instances

Instances details
FromJSON ExperienceEntitiesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary

Generic ExperienceEntitiesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary

Associated Types

type Rep ExperienceEntitiesSummary :: Type -> Type #

Show ExperienceEntitiesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary

NFData ExperienceEntitiesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary

Eq ExperienceEntitiesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary

Hashable ExperienceEntitiesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary

type Rep ExperienceEntitiesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary

type Rep ExperienceEntitiesSummary = D1 ('MetaData "ExperienceEntitiesSummary" "Amazonka.Kendra.Types.ExperienceEntitiesSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ExperienceEntitiesSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityDisplayData)) :*: (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityType)))))

newExperienceEntitiesSummary :: ExperienceEntitiesSummary Source #

Create a value of ExperienceEntitiesSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:displayData:ExperienceEntitiesSummary', experienceEntitiesSummary_displayData - Information about the user entity.

$sel:entityId:ExperienceEntitiesSummary', experienceEntitiesSummary_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:entityType:ExperienceEntitiesSummary', experienceEntitiesSummary_entityType - Shows the type as User or Group.

ExperiencesSummary

data ExperiencesSummary Source #

Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

See: newExperiencesSummary smart constructor.

Instances

Instances details
FromJSON ExperiencesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperiencesSummary

Generic ExperiencesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperiencesSummary

Associated Types

type Rep ExperiencesSummary :: Type -> Type #

Read ExperiencesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperiencesSummary

Show ExperiencesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperiencesSummary

NFData ExperiencesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperiencesSummary

Methods

rnf :: ExperiencesSummary -> () #

Eq ExperiencesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperiencesSummary

Hashable ExperiencesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperiencesSummary

type Rep ExperiencesSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ExperiencesSummary

type Rep ExperiencesSummary = D1 ('MetaData "ExperiencesSummary" "Amazonka.Kendra.Types.ExperiencesSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ExperiencesSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExperienceEndpoint)))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperienceStatus))))))

newExperiencesSummary :: ExperiencesSummary Source #

Create a value of ExperiencesSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:ExperiencesSummary', experiencesSummary_createdAt - The date-time your Amazon Kendra experience was created.

$sel:endpoints:ExperiencesSummary', experiencesSummary_endpoints - The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

$sel:id:ExperiencesSummary', experiencesSummary_id - The identifier of your Amazon Kendra experience.

$sel:name:ExperiencesSummary', experiencesSummary_name - The name of your Amazon Kendra experience.

$sel:status:ExperiencesSummary', experiencesSummary_status - The processing status of your Amazon Kendra experience.

Facet

data Facet Source #

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

For example, the document attribute or facet "Department" includes the values "HR", "Engineering", and "Accounting". You can display these values in the search results so that documents can be searched by department.

You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support.

See: newFacet smart constructor.

Constructors

Facet' (Maybe Text) (Maybe [Facet]) (Maybe Natural) 

Instances

Instances details
ToJSON Facet Source # 
Instance details

Defined in Amazonka.Kendra.Types.Facet

Generic Facet Source # 
Instance details

Defined in Amazonka.Kendra.Types.Facet

Associated Types

type Rep Facet :: Type -> Type #

Methods

from :: Facet -> Rep Facet x #

to :: Rep Facet x -> Facet #

Read Facet Source # 
Instance details

Defined in Amazonka.Kendra.Types.Facet

Show Facet Source # 
Instance details

Defined in Amazonka.Kendra.Types.Facet

Methods

showsPrec :: Int -> Facet -> ShowS #

show :: Facet -> String #

showList :: [Facet] -> ShowS #

NFData Facet Source # 
Instance details

Defined in Amazonka.Kendra.Types.Facet

Methods

rnf :: Facet -> () #

Eq Facet Source # 
Instance details

Defined in Amazonka.Kendra.Types.Facet

Methods

(==) :: Facet -> Facet -> Bool #

(/=) :: Facet -> Facet -> Bool #

Hashable Facet Source # 
Instance details

Defined in Amazonka.Kendra.Types.Facet

Methods

hashWithSalt :: Int -> Facet -> Int #

hash :: Facet -> Int #

type Rep Facet Source # 
Instance details

Defined in Amazonka.Kendra.Types.Facet

type Rep Facet = D1 ('MetaData "Facet" "Amazonka.Kendra.Types.Facet" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Facet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "facets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Facet])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newFacet :: Facet Source #

Create a value of Facet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentAttributeKey:Facet', facet_documentAttributeKey - The unique key for the document attribute.

$sel:facets:Facet', facet_facets - 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.

$sel:maxResults:Facet', facet_maxResults - 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

data FacetResult Source #

The facet values for the documents in the response.

See: newFacetResult smart constructor.

Instances

Instances details
FromJSON FacetResult Source # 
Instance details

Defined in Amazonka.Kendra.Types.FacetResult

Generic FacetResult Source # 
Instance details

Defined in Amazonka.Kendra.Types.FacetResult

Associated Types

type Rep FacetResult :: Type -> Type #

Read FacetResult Source # 
Instance details

Defined in Amazonka.Kendra.Types.FacetResult

Show FacetResult Source # 
Instance details

Defined in Amazonka.Kendra.Types.FacetResult

NFData FacetResult Source # 
Instance details

Defined in Amazonka.Kendra.Types.FacetResult

Methods

rnf :: FacetResult -> () #

Eq FacetResult Source # 
Instance details

Defined in Amazonka.Kendra.Types.FacetResult

Hashable FacetResult Source # 
Instance details

Defined in Amazonka.Kendra.Types.FacetResult

type Rep FacetResult Source # 
Instance details

Defined in Amazonka.Kendra.Types.FacetResult

type Rep FacetResult = D1 ('MetaData "FacetResult" "Amazonka.Kendra.Types.FacetResult" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FacetResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "documentAttributeValueCountPairs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttributeValueCountPair])) :*: S1 ('MetaSel ('Just "documentAttributeValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValueType)))))

newFacetResult :: FacetResult Source #

Create a value of FacetResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentAttributeKey:FacetResult', facetResult_documentAttributeKey - The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

$sel:documentAttributeValueCountPairs:FacetResult', facetResult_documentAttributeValueCountPairs - 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.

$sel:documentAttributeValueType:FacetResult', facetResult_documentAttributeValueType - The data type of the facet value. This is the same as the type defined for the index field when it was created.

FailedEntity

data FailedEntity Source #

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

See: newFailedEntity smart constructor.

Constructors

FailedEntity' (Maybe Text) (Maybe Text) 

Instances

Instances details
FromJSON FailedEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.FailedEntity

Generic FailedEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.FailedEntity

Associated Types

type Rep FailedEntity :: Type -> Type #

Read FailedEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.FailedEntity

Show FailedEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.FailedEntity

NFData FailedEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.FailedEntity

Methods

rnf :: FailedEntity -> () #

Eq FailedEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.FailedEntity

Hashable FailedEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.FailedEntity

type Rep FailedEntity Source # 
Instance details

Defined in Amazonka.Kendra.Types.FailedEntity

type Rep FailedEntity = D1 ('MetaData "FailedEntity" "Amazonka.Kendra.Types.FailedEntity" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FailedEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newFailedEntity :: FailedEntity Source #

Create a value of FailedEntity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entityId:FailedEntity', failedEntity_entityId - The identifier of the user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:errorMessage:FailedEntity', failedEntity_errorMessage - The reason the user or group in your IAM Identity Center identity source failed to properly configure with your Amazon Kendra experience.

FaqStatistics

data FaqStatistics Source #

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

See: newFaqStatistics smart constructor.

Constructors

FaqStatistics' Natural 

Instances

Instances details
FromJSON FaqStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatistics

Generic FaqStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatistics

Associated Types

type Rep FaqStatistics :: Type -> Type #

Read FaqStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatistics

Show FaqStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatistics

NFData FaqStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatistics

Methods

rnf :: FaqStatistics -> () #

Eq FaqStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatistics

Hashable FaqStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatistics

type Rep FaqStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqStatistics

type Rep FaqStatistics = D1 ('MetaData "FaqStatistics" "Amazonka.Kendra.Types.FaqStatistics" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FaqStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexedQuestionAnswersCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newFaqStatistics Source #

Create a value of FaqStatistics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexedQuestionAnswersCount:FaqStatistics', faqStatistics_indexedQuestionAnswersCount - The total number of FAQ questions and answers contained in the index.

FaqSummary

data FaqSummary Source #

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

See: newFaqSummary smart constructor.

Instances

Instances details
FromJSON FaqSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqSummary

Generic FaqSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqSummary

Associated Types

type Rep FaqSummary :: Type -> Type #

Read FaqSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqSummary

Show FaqSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqSummary

NFData FaqSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqSummary

Methods

rnf :: FaqSummary -> () #

Eq FaqSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqSummary

Hashable FaqSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqSummary

type Rep FaqSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.FaqSummary

newFaqSummary :: FaqSummary Source #

Create a value of FaqSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:FaqSummary', faqSummary_createdAt - The UNIX datetime that the FAQ was added to the index.

$sel:fileFormat:FaqSummary', faqSummary_fileFormat - The file type used to create the FAQ.

$sel:id:FaqSummary', faqSummary_id - The identifier of the FAQ.

$sel:languageCode:FaqSummary', faqSummary_languageCode - 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.

$sel:name:FaqSummary', faqSummary_name - The name that you assigned the FAQ when you created or updated the FAQ.

$sel:status:FaqSummary', faqSummary_status - The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

$sel:updatedAt:FaqSummary', faqSummary_updatedAt - The UNIX datetime that the FAQ was last updated.

FsxConfiguration

data FsxConfiguration Source #

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

See: newFsxConfiguration smart constructor.

Instances

Instances details
FromJSON FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

ToJSON FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

Generic FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

Associated Types

type Rep FsxConfiguration :: Type -> Type #

Read FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

Show FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

NFData FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

Methods

rnf :: FsxConfiguration -> () #

Eq FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

Hashable FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

type Rep FsxConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.FsxConfiguration

newFsxConfiguration Source #

Create a value of FsxConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exclusionPatterns:FsxConfiguration', fsxConfiguration_exclusionPatterns - 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.

$sel:fieldMappings:FsxConfiguration', fsxConfiguration_fieldMappings - 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.

$sel:inclusionPatterns:FsxConfiguration', fsxConfiguration_inclusionPatterns - 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.

$sel:secretArn:FsxConfiguration', fsxConfiguration_secretArn - 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.

$sel:fileSystemId:FsxConfiguration', fsxConfiguration_fileSystemId - 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.

$sel:fileSystemType:FsxConfiguration', fsxConfiguration_fileSystemType - The Amazon FSx file system type. Windows is currently the only supported type.

$sel:vpcConfiguration:FsxConfiguration', fsxConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

GitHubConfiguration

data GitHubConfiguration Source #

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

See: newGitHubConfiguration smart constructor.

Instances

Instances details
FromJSON GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

ToJSON GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Generic GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Associated Types

type Rep GitHubConfiguration :: Type -> Type #

Read GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Show GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

NFData GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Methods

rnf :: GitHubConfiguration -> () #

Eq GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Hashable GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

type Rep GitHubConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubConfiguration

type Rep GitHubConfiguration = D1 ('MetaData "GitHubConfiguration" "Amazonka.Kendra.Types.GitHubConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GitHubConfiguration'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "exclusionFileNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "exclusionFileTypePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "exclusionFolderNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "gitHubCommitConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "gitHubDocumentCrawlProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GitHubDocumentCrawlProperties))))) :*: ((S1 ('MetaSel ('Just "gitHubIssueAttachmentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "gitHubIssueCommentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "gitHubIssueDocumentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :*: (S1 ('MetaSel ('Just "gitHubPullRequestCommentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "gitHubPullRequestDocumentAttachmentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "gitHubPullRequestDocumentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))))) :*: (((S1 ('MetaSel ('Just "gitHubRepositoryConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "inclusionFileNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "inclusionFileTypePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "inclusionFolderNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "onPremiseConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnPremiseConfiguration))))) :*: ((S1 ('MetaSel ('Just "repositoryFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "saaSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SaaSConfiguration)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Type)))) :*: (S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newGitHubConfiguration Source #

Create a value of GitHubConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exclusionFileNamePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFileNamePatterns - 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.

$sel:exclusionFileTypePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFileTypePatterns - 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.

$sel:exclusionFolderNamePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFolderNamePatterns - 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.

$sel:gitHubCommitConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubCommitConfigurationFieldMappings - 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.

$sel:gitHubDocumentCrawlProperties:GitHubConfiguration', gitHubConfiguration_gitHubDocumentCrawlProperties - 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.

$sel:gitHubIssueAttachmentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueAttachmentConfigurationFieldMappings - 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.

$sel:gitHubIssueCommentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueCommentConfigurationFieldMappings - 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.

$sel:gitHubIssueDocumentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueDocumentConfigurationFieldMappings - 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.

$sel:gitHubPullRequestCommentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestCommentConfigurationFieldMappings - 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.

$sel:gitHubPullRequestDocumentAttachmentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestDocumentAttachmentConfigurationFieldMappings - 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.

$sel:gitHubPullRequestDocumentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestDocumentConfigurationFieldMappings - 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.

$sel:gitHubRepositoryConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubRepositoryConfigurationFieldMappings - 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.

$sel:inclusionFileNamePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFileNamePatterns - 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.

$sel:inclusionFileTypePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFileTypePatterns - 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.

$sel:inclusionFolderNamePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFolderNamePatterns - 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.

$sel:onPremiseConfiguration:GitHubConfiguration', gitHubConfiguration_onPremiseConfiguration - Configuration information to connect to GitHub Enterprise Server (on premises).

$sel:repositoryFilter:GitHubConfiguration', gitHubConfiguration_repositoryFilter - A list of names of the specific repositories you want to index.

$sel:saaSConfiguration:GitHubConfiguration', gitHubConfiguration_saaSConfiguration - Configuration information to connect to GitHub Enterprise Cloud (SaaS).

$sel:type':GitHubConfiguration', gitHubConfiguration_type - The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).

$sel:useChangeLog:GitHubConfiguration', gitHubConfiguration_useChangeLog - 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.

$sel:vpcConfiguration:GitHubConfiguration', gitHubConfiguration_vpcConfiguration - Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC.

$sel:secretArn:GitHubConfiguration', gitHubConfiguration_secretArn - 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

data GitHubDocumentCrawlProperties Source #

Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

See: newGitHubDocumentCrawlProperties smart constructor.

Instances

Instances details
FromJSON GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

ToJSON GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Generic GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Associated Types

type Rep GitHubDocumentCrawlProperties :: Type -> Type #

Read GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Show GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

NFData GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Eq GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Hashable GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

type Rep GitHubDocumentCrawlProperties Source # 
Instance details

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

type Rep GitHubDocumentCrawlProperties = D1 ('MetaData "GitHubDocumentCrawlProperties" "Amazonka.Kendra.Types.GitHubDocumentCrawlProperties" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GitHubDocumentCrawlProperties'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlIssue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "crawlIssueComment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlIssueCommentAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "crawlPullRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlPullRequestComment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "crawlPullRequestCommentAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlRepositoryDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

GoogleDriveConfiguration

data GoogleDriveConfiguration Source #

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

See: newGoogleDriveConfiguration smart constructor.

Instances

Instances details
FromJSON GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

ToJSON GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Generic GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Associated Types

type Rep GoogleDriveConfiguration :: Type -> Type #

Read GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Show GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

NFData GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Eq GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Hashable GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

type Rep GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

type Rep GoogleDriveConfiguration = D1 ('MetaData "GoogleDriveConfiguration" "Amazonka.Kendra.Types.GoogleDriveConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GoogleDriveConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "excludeMimeTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "excludeSharedDrives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "excludeUserAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGoogleDriveConfiguration Source #

Create a value of GoogleDriveConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:excludeMimeTypes:GoogleDriveConfiguration', googleDriveConfiguration_excludeMimeTypes - 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.

$sel:excludeSharedDrives:GoogleDriveConfiguration', googleDriveConfiguration_excludeSharedDrives - A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

$sel:excludeUserAccounts:GoogleDriveConfiguration', googleDriveConfiguration_excludeUserAccounts - 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.

$sel:exclusionPatterns:GoogleDriveConfiguration', googleDriveConfiguration_exclusionPatterns - 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.

$sel:fieldMappings:GoogleDriveConfiguration', googleDriveConfiguration_fieldMappings - 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.

$sel:inclusionPatterns:GoogleDriveConfiguration', googleDriveConfiguration_inclusionPatterns - 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.

$sel:secretArn:GoogleDriveConfiguration', googleDriveConfiguration_secretArn - 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

data GroupMembers Source #

A list of users or sub groups that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

See: newGroupMembers smart constructor.

Instances

Instances details
ToJSON GroupMembers Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupMembers

Generic GroupMembers Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupMembers

Associated Types

type Rep GroupMembers :: Type -> Type #

Read GroupMembers Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupMembers

Show GroupMembers Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupMembers

NFData GroupMembers Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupMembers

Methods

rnf :: GroupMembers -> () #

Eq GroupMembers Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupMembers

Hashable GroupMembers Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupMembers

type Rep GroupMembers Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupMembers

type Rep GroupMembers = D1 ('MetaData "GroupMembers" "Amazonka.Kendra.Types.GroupMembers" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GroupMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "memberGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty MemberGroup))) :*: (S1 ('MetaSel ('Just "memberUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty MemberUser))) :*: S1 ('MetaSel ('Just "s3PathforGroupMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)))))

newGroupMembers :: GroupMembers Source #

Create a value of GroupMembers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:memberGroups:GroupMembers', groupMembers_memberGroups - 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".

$sel:memberUsers:GroupMembers', groupMembers_memberUsers - A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

$sel:s3PathforGroupMembers:GroupMembers', groupMembers_s3PathforGroupMembers - 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

data GroupOrderingIdSummary Source #

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

See: newGroupOrderingIdSummary smart constructor.

Instances

Instances details
FromJSON GroupOrderingIdSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary

Generic GroupOrderingIdSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary

Associated Types

type Rep GroupOrderingIdSummary :: Type -> Type #

Read GroupOrderingIdSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary

Show GroupOrderingIdSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary

NFData GroupOrderingIdSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary

Methods

rnf :: GroupOrderingIdSummary -> () #

Eq GroupOrderingIdSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary

Hashable GroupOrderingIdSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary

type Rep GroupOrderingIdSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary

type Rep GroupOrderingIdSummary = D1 ('MetaData "GroupOrderingIdSummary" "Amazonka.Kendra.Types.GroupOrderingIdSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GroupOrderingIdSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "orderingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "receivedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrincipalMappingStatus))))))

newGroupOrderingIdSummary :: GroupOrderingIdSummary Source #

Create a value of GroupOrderingIdSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failureReason:GroupOrderingIdSummary', groupOrderingIdSummary_failureReason - The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.

$sel:lastUpdatedAt:GroupOrderingIdSummary', groupOrderingIdSummary_lastUpdatedAt - The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.

$sel:orderingId:GroupOrderingIdSummary', groupOrderingIdSummary_orderingId - The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.

$sel:receivedAt:GroupOrderingIdSummary', groupOrderingIdSummary_receivedAt - 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.

$sel:status:GroupOrderingIdSummary', groupOrderingIdSummary_status - The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

GroupSummary

data GroupSummary Source #

Summary information for groups.

See: newGroupSummary smart constructor.

Instances

Instances details
FromJSON GroupSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupSummary

Generic GroupSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupSummary

Associated Types

type Rep GroupSummary :: Type -> Type #

Read GroupSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupSummary

Show GroupSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupSummary

NFData GroupSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupSummary

Methods

rnf :: GroupSummary -> () #

Eq GroupSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupSummary

Hashable GroupSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupSummary

type Rep GroupSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.GroupSummary

type Rep GroupSummary = D1 ('MetaData "GroupSummary" "Amazonka.Kendra.Types.GroupSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GroupSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "orderingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newGroupSummary :: GroupSummary Source #

Create a value of GroupSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groupId:GroupSummary', groupSummary_groupId - The identifier of the group you want group summary information on.

$sel:orderingId:GroupSummary', groupSummary_orderingId - The timestamp identifier used for the latest PUT or DELETE action.

HierarchicalPrincipal

data HierarchicalPrincipal Source #

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

See: newHierarchicalPrincipal smart constructor.

Instances

Instances details
FromJSON HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

ToJSON HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

Generic HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

Associated Types

type Rep HierarchicalPrincipal :: Type -> Type #

Read HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

Show HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

NFData HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

Methods

rnf :: HierarchicalPrincipal -> () #

Eq HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

Hashable HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

type Rep HierarchicalPrincipal Source # 
Instance details

Defined in Amazonka.Kendra.Types.HierarchicalPrincipal

type Rep HierarchicalPrincipal = D1 ('MetaData "HierarchicalPrincipal" "Amazonka.Kendra.Types.HierarchicalPrincipal" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "HierarchicalPrincipal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "principalList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Principal])))

newHierarchicalPrincipal :: HierarchicalPrincipal Source #

Create a value of HierarchicalPrincipal with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:principalList:HierarchicalPrincipal', hierarchicalPrincipal_principalList - 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

data Highlight Source #

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

See: newHighlight smart constructor.

Instances

Instances details
FromJSON Highlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.Highlight

Generic Highlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.Highlight

Associated Types

type Rep Highlight :: Type -> Type #

Read Highlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.Highlight

Show Highlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.Highlight

NFData Highlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.Highlight

Methods

rnf :: Highlight -> () #

Eq Highlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.Highlight

Hashable Highlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.Highlight

type Rep Highlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.Highlight

type Rep Highlight = D1 ('MetaData "Highlight" "Amazonka.Kendra.Types.Highlight" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Highlight'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "topAnswer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HighlightType))) :*: (S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newHighlight Source #

Create a value of Highlight with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:topAnswer:Highlight', highlight_topAnswer - Indicates whether the response is the best response. True if this is the best response; otherwise, false.

$sel:type':Highlight', highlight_type - The highlight type.

$sel:beginOffset:Highlight', highlight_beginOffset - The zero-based location in the response string where the highlight starts.

$sel:endOffset:Highlight', highlight_endOffset - The zero-based location in the response string where the highlight ends.

HookConfiguration

data HookConfiguration Source #

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using PostExtractionHookConfiguration. You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Customizing document metadata during the ingestion process.

See: newHookConfiguration smart constructor.

Instances

Instances details
FromJSON HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

ToJSON HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Generic HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Associated Types

type Rep HookConfiguration :: Type -> Type #

Read HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Show HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

NFData HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Methods

rnf :: HookConfiguration -> () #

Eq HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Hashable HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

type Rep HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

type Rep HookConfiguration = D1 ('MetaData "HookConfiguration" "Amazonka.Kendra.Types.HookConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "HookConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "invocationCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeCondition)) :*: (S1 ('MetaSel ('Just "lambdaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newHookConfiguration Source #

Create a value of HookConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:invocationCondition:HookConfiguration', hookConfiguration_invocationCondition - 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.

$sel:lambdaArn:HookConfiguration', hookConfiguration_lambdaArn - 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.

$sel:s3Bucket:HookConfiguration', hookConfiguration_s3Bucket - 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

data IndexConfigurationSummary Source #

Summary information on the configuration of an index.

See: newIndexConfigurationSummary smart constructor.

Instances

Instances details
FromJSON IndexConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexConfigurationSummary

Generic IndexConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexConfigurationSummary

Associated Types

type Rep IndexConfigurationSummary :: Type -> Type #

Read IndexConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexConfigurationSummary

Show IndexConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexConfigurationSummary

NFData IndexConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexConfigurationSummary

Eq IndexConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexConfigurationSummary

Hashable IndexConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexConfigurationSummary

type Rep IndexConfigurationSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexConfigurationSummary

type Rep IndexConfigurationSummary = D1 ('MetaData "IndexConfigurationSummary" "Amazonka.Kendra.Types.IndexConfigurationSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "IndexConfigurationSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "edition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexEdition)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IndexStatus)))))

newIndexConfigurationSummary Source #

Create a value of IndexConfigurationSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:edition:IndexConfigurationSummary', indexConfigurationSummary_edition - Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

$sel:id:IndexConfigurationSummary', indexConfigurationSummary_id - A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

$sel:name:IndexConfigurationSummary', indexConfigurationSummary_name - The name of the index.

$sel:createdAt:IndexConfigurationSummary', indexConfigurationSummary_createdAt - The Unix timestamp when the index was created.

$sel:updatedAt:IndexConfigurationSummary', indexConfigurationSummary_updatedAt - The Unix timestamp when the index was last updated by the UpdateIndex API.

$sel:status:IndexConfigurationSummary', indexConfigurationSummary_status - The current status of the index. When the status is ACTIVE, the index is ready to search.

IndexStatistics

data IndexStatistics Source #

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

See: newIndexStatistics smart constructor.

Instances

Instances details
FromJSON IndexStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatistics

Generic IndexStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatistics

Associated Types

type Rep IndexStatistics :: Type -> Type #

Read IndexStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatistics

Show IndexStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatistics

NFData IndexStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatistics

Methods

rnf :: IndexStatistics -> () #

Eq IndexStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatistics

Hashable IndexStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatistics

type Rep IndexStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.IndexStatistics

type Rep IndexStatistics = D1 ('MetaData "IndexStatistics" "Amazonka.Kendra.Types.IndexStatistics" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "IndexStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "faqStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FaqStatistics) :*: S1 ('MetaSel ('Just "textDocumentStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextDocumentStatistics)))

newIndexStatistics Source #

Create a value of IndexStatistics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:faqStatistics:IndexStatistics', indexStatistics_faqStatistics - The number of question and answer topics in the index.

$sel:textDocumentStatistics:IndexStatistics', indexStatistics_textDocumentStatistics - The number of text documents indexed.

InlineCustomDocumentEnrichmentConfiguration

data InlineCustomDocumentEnrichmentConfiguration Source #

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration.

For more information, see Customizing document metadata during the ingestion process.

See: newInlineCustomDocumentEnrichmentConfiguration smart constructor.

Instances

Instances details
FromJSON InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

ToJSON InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

Generic InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

Read InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

Show InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

NFData InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

Eq InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

Hashable InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

type Rep InlineCustomDocumentEnrichmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration

type Rep InlineCustomDocumentEnrichmentConfiguration = D1 ('MetaData "InlineCustomDocumentEnrichmentConfiguration" "Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "InlineCustomDocumentEnrichmentConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeCondition)) :*: (S1 ('MetaSel ('Just "documentContentDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeTarget)))))

newInlineCustomDocumentEnrichmentConfiguration :: InlineCustomDocumentEnrichmentConfiguration Source #

Create a value of InlineCustomDocumentEnrichmentConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:condition:InlineCustomDocumentEnrichmentConfiguration', inlineCustomDocumentEnrichmentConfiguration_condition - Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.

$sel:documentContentDeletion:InlineCustomDocumentEnrichmentConfiguration', inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion - TRUE to delete content if the condition used for the target attribute is met.

$sel:target:InlineCustomDocumentEnrichmentConfiguration', inlineCustomDocumentEnrichmentConfiguration_target - Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.

JiraConfiguration

data JiraConfiguration Source #

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

See: newJiraConfiguration smart constructor.

Instances

Instances details
FromJSON JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

ToJSON JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

Generic JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

Associated Types

type Rep JiraConfiguration :: Type -> Type #

Read JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

Show JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

NFData JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

Methods

rnf :: JiraConfiguration -> () #

Eq JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

Hashable JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

type Rep JiraConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JiraConfiguration

type Rep JiraConfiguration = D1 ('MetaData "JiraConfiguration" "Amazonka.Kendra.Types.JiraConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "JiraConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "commentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "issueFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "issueSubEntityFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IssueSubEntity])) :*: S1 ('MetaSel ('Just "issueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: (((S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "projectFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "workLogFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "jiraAccountUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJiraConfiguration Source #

Create a value of JiraConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentFieldMappings:JiraConfiguration', jiraConfiguration_attachmentFieldMappings - 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.

$sel:commentFieldMappings:JiraConfiguration', jiraConfiguration_commentFieldMappings - 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.

$sel:exclusionPatterns:JiraConfiguration', jiraConfiguration_exclusionPatterns - 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.

$sel:inclusionPatterns:JiraConfiguration', jiraConfiguration_inclusionPatterns - 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.

$sel:issueFieldMappings:JiraConfiguration', jiraConfiguration_issueFieldMappings - 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.

$sel:issueSubEntityFilter:JiraConfiguration', jiraConfiguration_issueSubEntityFilter - Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

$sel:issueType:JiraConfiguration', jiraConfiguration_issueType - Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

$sel:project:JiraConfiguration', jiraConfiguration_project - Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

$sel:projectFieldMappings:JiraConfiguration', jiraConfiguration_projectFieldMappings - 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.

$sel:status:JiraConfiguration', jiraConfiguration_status - Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

$sel:useChangeLog:JiraConfiguration', jiraConfiguration_useChangeLog - 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.

$sel:vpcConfiguration:JiraConfiguration', jiraConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.

$sel:workLogFieldMappings:JiraConfiguration', jiraConfiguration_workLogFieldMappings - 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.

$sel:jiraAccountUrl:JiraConfiguration', jiraConfiguration_jiraAccountUrl - 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.

$sel:secretArn:JiraConfiguration', jiraConfiguration_secretArn - 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

data JsonTokenTypeConfiguration Source #

Provides the configuration information for the JSON token type.

See: newJsonTokenTypeConfiguration smart constructor.

Instances

Instances details
FromJSON JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

ToJSON JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

Generic JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

Associated Types

type Rep JsonTokenTypeConfiguration :: Type -> Type #

Read JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

Show JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

NFData JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

Eq JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

Hashable JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

type Rep JsonTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration

type Rep JsonTokenTypeConfiguration = D1 ('MetaData "JsonTokenTypeConfiguration" "Amazonka.Kendra.Types.JsonTokenTypeConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "JsonTokenTypeConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userNameAttributeField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupAttributeField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newJsonTokenTypeConfiguration Source #

Create a value of JsonTokenTypeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userNameAttributeField:JsonTokenTypeConfiguration', jsonTokenTypeConfiguration_userNameAttributeField - The user name attribute field.

$sel:groupAttributeField:JsonTokenTypeConfiguration', jsonTokenTypeConfiguration_groupAttributeField - The group attribute field.

JwtTokenTypeConfiguration

data JwtTokenTypeConfiguration Source #

Provides the configuration information for the JWT token type.

See: newJwtTokenTypeConfiguration smart constructor.

Instances

Instances details
FromJSON JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

ToJSON JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

Generic JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

Associated Types

type Rep JwtTokenTypeConfiguration :: Type -> Type #

Read JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

Show JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

NFData JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

Eq JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

Hashable JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

type Rep JwtTokenTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration

type Rep JwtTokenTypeConfiguration = D1 ('MetaData "JwtTokenTypeConfiguration" "Amazonka.Kendra.Types.JwtTokenTypeConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "JwtTokenTypeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "claimRegex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "groupAttributeField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "issuer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "secretManagerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "userNameAttributeField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KeyLocation)))))

MemberGroup

data MemberGroup Source #

The sub groups that belong to a group.

See: newMemberGroup smart constructor.

Constructors

MemberGroup' (Maybe Text) Text 

Instances

Instances details
ToJSON MemberGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberGroup

Generic MemberGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberGroup

Associated Types

type Rep MemberGroup :: Type -> Type #

Read MemberGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberGroup

Show MemberGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberGroup

NFData MemberGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberGroup

Methods

rnf :: MemberGroup -> () #

Eq MemberGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberGroup

Hashable MemberGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberGroup

type Rep MemberGroup Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberGroup

type Rep MemberGroup = D1 ('MetaData "MemberGroup" "Amazonka.Kendra.Types.MemberGroup" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "MemberGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newMemberGroup Source #

Create a value of MemberGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceId:MemberGroup', memberGroup_dataSourceId - The identifier of the data source for the sub group you want to map to a group.

$sel:groupId:MemberGroup', memberGroup_groupId - The identifier of the sub group you want to map to a group.

MemberUser

data MemberUser Source #

The users that belong to a group.

See: newMemberUser smart constructor.

Constructors

MemberUser' Text 

Instances

Instances details
ToJSON MemberUser Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberUser

Generic MemberUser Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberUser

Associated Types

type Rep MemberUser :: Type -> Type #

Read MemberUser Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberUser

Show MemberUser Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberUser

NFData MemberUser Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberUser

Methods

rnf :: MemberUser -> () #

Eq MemberUser Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberUser

Hashable MemberUser Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberUser

type Rep MemberUser Source # 
Instance details

Defined in Amazonka.Kendra.Types.MemberUser

type Rep MemberUser = D1 ('MetaData "MemberUser" "Amazonka.Kendra.Types.MemberUser" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "MemberUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newMemberUser Source #

Create a value of MemberUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userId:MemberUser', memberUser_userId - The identifier of the user you want to map to a group.

OnPremiseConfiguration

data OnPremiseConfiguration Source #

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

See: newOnPremiseConfiguration smart constructor.

Instances

Instances details
FromJSON OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

ToJSON OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Generic OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Associated Types

type Rep OnPremiseConfiguration :: Type -> Type #

Read OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Show OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

NFData OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Methods

rnf :: OnPremiseConfiguration -> () #

Eq OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

Hashable OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

type Rep OnPremiseConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OnPremiseConfiguration

type Rep OnPremiseConfiguration = D1 ('MetaData "OnPremiseConfiguration" "Amazonka.Kendra.Types.OnPremiseConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "OnPremiseConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "organizationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sslCertificateS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Path))))

newOnPremiseConfiguration Source #

Create a value of OnPremiseConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hostUrl:OnPremiseConfiguration', onPremiseConfiguration_hostUrl - The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/

$sel:organizationName:OnPremiseConfiguration', onPremiseConfiguration_organizationName - 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.

$sel:sslCertificateS3Path:OnPremiseConfiguration', onPremiseConfiguration_sslCertificateS3Path - 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

data OneDriveConfiguration Source #

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

See: newOneDriveConfiguration smart constructor.

Instances

Instances details
FromJSON OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

ToJSON OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

Generic OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

Associated Types

type Rep OneDriveConfiguration :: Type -> Type #

Read OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

Show OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

NFData OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

Methods

rnf :: OneDriveConfiguration -> () #

Eq OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

Hashable OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

type Rep OneDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveConfiguration

type Rep OneDriveConfiguration = D1 ('MetaData "OneDriveConfiguration" "Amazonka.Kendra.Types.OneDriveConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "OneDriveConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disableLocalGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :*: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tenantDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "oneDriveUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OneDriveUsers)))))

newOneDriveConfiguration Source #

Create a value of OneDriveConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:disableLocalGroups:OneDriveConfiguration', oneDriveConfiguration_disableLocalGroups - TRUE to disable local groups information.

$sel:exclusionPatterns:OneDriveConfiguration', oneDriveConfiguration_exclusionPatterns - 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.

$sel:fieldMappings:OneDriveConfiguration', oneDriveConfiguration_fieldMappings - 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.

$sel:inclusionPatterns:OneDriveConfiguration', oneDriveConfiguration_inclusionPatterns - 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.

$sel:tenantDomain:OneDriveConfiguration', oneDriveConfiguration_tenantDomain - The Azure Active Directory domain of the organization.

$sel:secretArn:OneDriveConfiguration', oneDriveConfiguration_secretArn - 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.

$sel:oneDriveUsers:OneDriveConfiguration', oneDriveConfiguration_oneDriveUsers - A list of user accounts whose documents should be indexed.

OneDriveUsers

data OneDriveUsers Source #

User accounts whose documents should be indexed.

See: newOneDriveUsers smart constructor.

Instances

Instances details
FromJSON OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

ToJSON OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

Generic OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

Associated Types

type Rep OneDriveUsers :: Type -> Type #

Read OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

Show OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

NFData OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

Methods

rnf :: OneDriveUsers -> () #

Eq OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

Hashable OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

type Rep OneDriveUsers Source # 
Instance details

Defined in Amazonka.Kendra.Types.OneDriveUsers

type Rep OneDriveUsers = D1 ('MetaData "OneDriveUsers" "Amazonka.Kendra.Types.OneDriveUsers" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "OneDriveUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "oneDriveUserList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "oneDriveUserS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path))))

newOneDriveUsers :: OneDriveUsers Source #

Create a value of OneDriveUsers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:oneDriveUserList:OneDriveUsers', oneDriveUsers_oneDriveUserList - 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.

$sel:oneDriveUserS3Path:OneDriveUsers', oneDriveUsers_oneDriveUserS3Path - The S3 bucket location of a file containing a list of users whose documents should be indexed.

PersonasSummary

data PersonasSummary Source #

Summary information for users or groups in your IAM Identity Center identity source. This applies to users and groups with specific permissions that define their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

See: newPersonasSummary smart constructor.

Instances

Instances details
FromJSON PersonasSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.PersonasSummary

Generic PersonasSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.PersonasSummary

Associated Types

type Rep PersonasSummary :: Type -> Type #

Read PersonasSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.PersonasSummary

Show PersonasSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.PersonasSummary

NFData PersonasSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.PersonasSummary

Methods

rnf :: PersonasSummary -> () #

Eq PersonasSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.PersonasSummary

Hashable PersonasSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.PersonasSummary

type Rep PersonasSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.PersonasSummary

type Rep PersonasSummary = D1 ('MetaData "PersonasSummary" "Amazonka.Kendra.Types.PersonasSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "PersonasSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "persona") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Persona)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newPersonasSummary :: PersonasSummary Source #

Create a value of PersonasSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:PersonasSummary', personasSummary_createdAt - The date-time the summary information was created.

$sel:entityId:PersonasSummary', personasSummary_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:persona:PersonasSummary', personasSummary_persona - 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.

$sel:updatedAt:PersonasSummary', personasSummary_updatedAt - The date-time the summary information was last updated.

Principal

data Principal Source #

Provides user and group information for user context filtering.

See: newPrincipal smart constructor.

Instances

Instances details
FromJSON Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

ToJSON Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

Generic Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

Associated Types

type Rep Principal :: Type -> Type #

Read Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

Show Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

NFData Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

Methods

rnf :: Principal -> () #

Eq Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

Hashable Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

type Rep Principal Source # 
Instance details

Defined in Amazonka.Kendra.Types.Principal

type Rep Principal = D1 ('MetaData "Principal" "Amazonka.Kendra.Types.Principal" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Principal'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PrincipalType) :*: S1 ('MetaSel ('Just "access") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReadAccessType))))

newPrincipal Source #

Create a value of Principal with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceId:Principal', principal_dataSourceId - The identifier of the data source the principal should access documents from.

$sel:name:Principal', principal_name - The name of the user or group.

$sel:type':Principal', principal_type - The type of principal.

$sel:access:Principal', principal_access - Whether to allow or deny document access to the principal.

ProxyConfiguration

data ProxyConfiguration Source #

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

See: newProxyConfiguration smart constructor.

Instances

Instances details
FromJSON ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

ToJSON ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Generic ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Associated Types

type Rep ProxyConfiguration :: Type -> Type #

Read ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Show ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

NFData ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Methods

rnf :: ProxyConfiguration -> () #

Eq ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

Hashable ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

type Rep ProxyConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ProxyConfiguration

type Rep ProxyConfiguration = D1 ('MetaData "ProxyConfiguration" "Amazonka.Kendra.Types.ProxyConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ProxyConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newProxyConfiguration Source #

Create a value of ProxyConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:credentials:ProxyConfiguration', proxyConfiguration_credentials - 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.

$sel:host:ProxyConfiguration', proxyConfiguration_host - 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".

$sel:port:ProxyConfiguration', proxyConfiguration_port - 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

data QueryResultItem Source #

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

See: newQueryResultItem smart constructor.

Instances

Instances details
FromJSON QueryResultItem Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultItem

Generic QueryResultItem Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultItem

Associated Types

type Rep QueryResultItem :: Type -> Type #

Read QueryResultItem Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultItem

Show QueryResultItem Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultItem

NFData QueryResultItem Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultItem

Methods

rnf :: QueryResultItem -> () #

Eq QueryResultItem Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultItem

Hashable QueryResultItem Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultItem

type Rep QueryResultItem Source # 
Instance details

Defined in Amazonka.Kendra.Types.QueryResultItem

type Rep QueryResultItem = D1 ('MetaData "QueryResultItem" "Amazonka.Kendra.Types.QueryResultItem" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "QueryResultItem'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdditionalResultAttribute])) :*: (S1 ('MetaSel ('Just "documentAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttribute])) :*: S1 ('MetaSel ('Just "documentExcerpt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextWithHighlights)))) :*: (S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "documentTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextWithHighlights)) :*: S1 ('MetaSel ('Just "documentURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "feedbackToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryResultFormat)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "scoreAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScoreAttributes)) :*: (S1 ('MetaSel ('Just "tableExcerpt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TableExcerpt)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryResultType)))))))

newQueryResultItem :: QueryResultItem Source #

Create a value of QueryResultItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalAttributes:QueryResultItem', queryResultItem_additionalAttributes - One or more additional attributes associated with the query result.

$sel:documentAttributes:QueryResultItem', queryResultItem_documentAttributes - 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.

$sel:documentExcerpt:QueryResultItem', queryResultItem_documentExcerpt - An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

$sel:documentId:QueryResultItem', queryResultItem_documentId - The identifier for the document.

$sel:documentTitle:QueryResultItem', queryResultItem_documentTitle - The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

$sel:documentURI:QueryResultItem', queryResultItem_documentURI - The URI of the original location of the document.

$sel:feedbackToken:QueryResultItem', queryResultItem_feedbackToken - 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 .

$sel:format:QueryResultItem', queryResultItem_format - 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.

$sel:id:QueryResultItem', queryResultItem_id - The identifier for the query result.

$sel:scoreAttributes:QueryResultItem', queryResultItem_scoreAttributes - 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.

$sel:tableExcerpt:QueryResultItem', queryResultItem_tableExcerpt - An excerpt from a table within a document.

$sel:type':QueryResultItem', queryResultItem_type - The type of document within the response. For example, a response could include a question-answer that's relevant to the query.

QuerySuggestionsBlockListSummary

data QuerySuggestionsBlockListSummary Source #

Summary information on a query suggestions block list.

This includes information on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

See: newQuerySuggestionsBlockListSummary smart constructor.

Instances

Instances details
FromJSON QuerySuggestionsBlockListSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary

Generic QuerySuggestionsBlockListSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary

Associated Types

type Rep QuerySuggestionsBlockListSummary :: Type -> Type #

Read QuerySuggestionsBlockListSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary

Show QuerySuggestionsBlockListSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary

NFData QuerySuggestionsBlockListSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary

Eq QuerySuggestionsBlockListSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary

Hashable QuerySuggestionsBlockListSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary

type Rep QuerySuggestionsBlockListSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary

type Rep QuerySuggestionsBlockListSummary = D1 ('MetaData "QuerySuggestionsBlockListSummary" "Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "QuerySuggestionsBlockListSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "itemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuerySuggestionsBlockListStatus)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newQuerySuggestionsBlockListSummary :: QuerySuggestionsBlockListSummary Source #

Create a value of QuerySuggestionsBlockListSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_createdAt - The date-time summary information for a query suggestions block list was last created.

$sel:id:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_id - The identifier of a block list.

$sel:itemCount:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_itemCount - The number of items in the block list file.

$sel:name:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_name - The name of the block list.

$sel:status:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_status - The status of the block list.

$sel:updatedAt:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_updatedAt - The date-time the block list was last updated.

QuipConfiguration

data QuipConfiguration Source #

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

See: newQuipConfiguration smart constructor.

Instances

Instances details
FromJSON QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

ToJSON QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

Generic QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

Associated Types

type Rep QuipConfiguration :: Type -> Type #

Read QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

Show QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

NFData QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

Methods

rnf :: QuipConfiguration -> () #

Eq QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

Hashable QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

type Rep QuipConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.QuipConfiguration

type Rep QuipConfiguration = D1 ('MetaData "QuipConfiguration" "Amazonka.Kendra.Types.QuipConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "QuipConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlChatRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "crawlFileComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "folderIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "messageFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "threadFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :*: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newQuipConfiguration Source #

Create a value of QuipConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentFieldMappings:QuipConfiguration', quipConfiguration_attachmentFieldMappings - 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.

$sel:crawlAttachments:QuipConfiguration', quipConfiguration_crawlAttachments - TRUE to index attachments.

$sel:crawlChatRooms:QuipConfiguration', quipConfiguration_crawlChatRooms - TRUE to index the contents of chat rooms.

$sel:crawlFileComments:QuipConfiguration', quipConfiguration_crawlFileComments - TRUE to index file comments.

$sel:exclusionPatterns:QuipConfiguration', quipConfiguration_exclusionPatterns - 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.

$sel:folderIds:QuipConfiguration', quipConfiguration_folderIds - 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".

$sel:inclusionPatterns:QuipConfiguration', quipConfiguration_inclusionPatterns - 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.

$sel:messageFieldMappings:QuipConfiguration', quipConfiguration_messageFieldMappings - 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.

$sel:threadFieldMappings:QuipConfiguration', quipConfiguration_threadFieldMappings - 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.

$sel:vpcConfiguration:QuipConfiguration', quipConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

$sel:domain:QuipConfiguration', quipConfiguration_domain - The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".

$sel:secretArn:QuipConfiguration', quipConfiguration_secretArn - 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:

Relevance

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

See: newRelevance smart constructor.

Instances

Instances details
FromJSON Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

ToJSON Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

Generic Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

Associated Types

type Rep Relevance :: Type -> Type #

Read Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

Show Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

NFData Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

Methods

rnf :: Relevance -> () #

Eq Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

Hashable Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

type Rep Relevance Source # 
Instance details

Defined in Amazonka.Kendra.Types.Relevance

type Rep Relevance = D1 ('MetaData "Relevance" "Amazonka.Kendra.Types.Relevance" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Relevance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "freshness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "importance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "rankOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Order)) :*: S1 ('MetaSel ('Just "valueImportanceMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Natural)))))))

newRelevance :: Relevance Source #

Create a value of Relevance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:duration:Relevance', relevance_duration - 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.

$sel:freshness:Relevance', relevance_freshness - 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.

$sel:importance:Relevance', relevance_importance - The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

$sel:rankOrder:Relevance', relevance_rankOrder - 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.

$sel:valueImportanceMap:Relevance', relevance_valueImportanceMap - 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

data RelevanceFeedback Source #

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

See: newRelevanceFeedback smart constructor.

Instances

Instances details
ToJSON RelevanceFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Generic RelevanceFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Associated Types

type Rep RelevanceFeedback :: Type -> Type #

Read RelevanceFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Show RelevanceFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceFeedback

NFData RelevanceFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Methods

rnf :: RelevanceFeedback -> () #

Eq RelevanceFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Hashable RelevanceFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceFeedback

type Rep RelevanceFeedback Source # 
Instance details

Defined in Amazonka.Kendra.Types.RelevanceFeedback

type Rep RelevanceFeedback = D1 ('MetaData "RelevanceFeedback" "Amazonka.Kendra.Types.RelevanceFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "RelevanceFeedback'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "relevanceValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelevanceType)))

newRelevanceFeedback Source #

Create a value of RelevanceFeedback with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resultId:RelevanceFeedback', relevanceFeedback_resultId - The identifier of the search result that the user provided relevance feedback for.

$sel:relevanceValue:RelevanceFeedback', relevanceFeedback_relevanceValue - Whether to document was relevant or not relevant to the search.

S3DataSourceConfiguration

data S3DataSourceConfiguration Source #

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

See: newS3DataSourceConfiguration smart constructor.

Instances

Instances details
FromJSON S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

ToJSON S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

Generic S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

Associated Types

type Rep S3DataSourceConfiguration :: Type -> Type #

Read S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

Show S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

NFData S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

Eq S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

Hashable S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

type Rep S3DataSourceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration

type Rep S3DataSourceConfiguration = D1 ('MetaData "S3DataSourceConfiguration" "Amazonka.Kendra.Types.S3DataSourceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "S3DataSourceConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessControlListConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessControlListConfiguration)) :*: (S1 ('MetaSel ('Just "documentsMetadataConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentsMetadataConfiguration)) :*: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "inclusionPrefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newS3DataSourceConfiguration Source #

Create a value of S3DataSourceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessControlListConfiguration:S3DataSourceConfiguration', s3DataSourceConfiguration_accessControlListConfiguration - 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.

$sel:documentsMetadataConfiguration:S3DataSourceConfiguration', s3DataSourceConfiguration_documentsMetadataConfiguration - Undocumented member.

$sel:exclusionPatterns:S3DataSourceConfiguration', s3DataSourceConfiguration_exclusionPatterns - 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.

$sel:inclusionPatterns:S3DataSourceConfiguration', s3DataSourceConfiguration_inclusionPatterns - 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'.

$sel:inclusionPrefixes:S3DataSourceConfiguration', s3DataSourceConfiguration_inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.

$sel:bucketName:S3DataSourceConfiguration', s3DataSourceConfiguration_bucketName - The name of the bucket that contains the documents.

S3Path

data S3Path Source #

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

See: newS3Path smart constructor.

Constructors

S3Path' Text Text 

Instances

Instances details
FromJSON S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

ToJSON S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

Generic S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

Associated Types

type Rep S3Path :: Type -> Type #

Methods

from :: S3Path -> Rep S3Path x #

to :: Rep S3Path x -> S3Path #

Read S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

Show S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

NFData S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

Methods

rnf :: S3Path -> () #

Eq S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

Methods

(==) :: S3Path -> S3Path -> Bool #

(/=) :: S3Path -> S3Path -> Bool #

Hashable S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

Methods

hashWithSalt :: Int -> S3Path -> Int #

hash :: S3Path -> Int #

type Rep S3Path Source # 
Instance details

Defined in Amazonka.Kendra.Types.S3Path

type Rep S3Path = D1 ('MetaData "S3Path" "Amazonka.Kendra.Types.S3Path" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "S3Path'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newS3Path Source #

Create a value of S3Path with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bucket:S3Path', s3Path_bucket - The name of the S3 bucket that contains the file.

$sel:key:S3Path', s3Path_key - The name of the file.

SaaSConfiguration

data SaaSConfiguration Source #

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

See: newSaaSConfiguration smart constructor.

Instances

Instances details
FromJSON SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

ToJSON SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

Generic SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

Associated Types

type Rep SaaSConfiguration :: Type -> Type #

Read SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

Show SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

NFData SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

Methods

rnf :: SaaSConfiguration -> () #

Eq SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

Hashable SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

type Rep SaaSConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SaaSConfiguration

type Rep SaaSConfiguration = D1 ('MetaData "SaaSConfiguration" "Amazonka.Kendra.Types.SaaSConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SaaSConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSaaSConfiguration Source #

Create a value of SaaSConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:organizationName:SaaSConfiguration', saaSConfiguration_organizationName - 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.

$sel:hostUrl:SaaSConfiguration', saaSConfiguration_hostUrl - The GitHub host URL or API endpoint URL. For example, https://api.github.com.

SalesforceChatterFeedConfiguration

data SalesforceChatterFeedConfiguration Source #

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

See: newSalesforceChatterFeedConfiguration smart constructor.

Instances

Instances details
FromJSON SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

ToJSON SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

Generic SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

Associated Types

type Rep SalesforceChatterFeedConfiguration :: Type -> Type #

Read SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

Show SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

NFData SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

Eq SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

Hashable SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

type Rep SalesforceChatterFeedConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration

type Rep SalesforceChatterFeedConfiguration = D1 ('MetaData "SalesforceChatterFeedConfiguration" "Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceChatterFeedConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "includeFilterTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SalesforceChatterFeedIncludeFilterType))) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSalesforceChatterFeedConfiguration Source #

Create a value of SalesforceChatterFeedConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentTitleFieldName:SalesforceChatterFeedConfiguration', salesforceChatterFeedConfiguration_documentTitleFieldName - The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.

$sel:fieldMappings:SalesforceChatterFeedConfiguration', salesforceChatterFeedConfiguration_fieldMappings - Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

$sel:includeFilterTypes:SalesforceChatterFeedConfiguration', salesforceChatterFeedConfiguration_includeFilterTypes - 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.

$sel:documentDataFieldName:SalesforceChatterFeedConfiguration', salesforceChatterFeedConfiguration_documentDataFieldName - The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

SalesforceConfiguration

data SalesforceConfiguration Source #

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

See: newSalesforceConfiguration smart constructor.

Instances

Instances details
FromJSON SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

ToJSON SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

Generic SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

Associated Types

type Rep SalesforceConfiguration :: Type -> Type #

Read SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

Show SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

NFData SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

Methods

rnf :: SalesforceConfiguration -> () #

Eq SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

Hashable SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

type Rep SalesforceConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceConfiguration

type Rep SalesforceConfiguration = D1 ('MetaData "SalesforceConfiguration" "Amazonka.Kendra.Types.SalesforceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "chatterFeedConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceChatterFeedConfiguration)) :*: S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "excludeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "includeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "knowledgeArticleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceKnowledgeArticleConfiguration)) :*: S1 ('MetaSel ('Just "standardObjectAttachmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceStandardObjectAttachmentConfiguration))) :*: (S1 ('MetaSel ('Just "standardObjectConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SalesforceStandardObjectConfiguration))) :*: (S1 ('MetaSel ('Just "serverUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSalesforceConfiguration Source #

Create a value of SalesforceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:chatterFeedConfiguration:SalesforceConfiguration', salesforceConfiguration_chatterFeedConfiguration - Configuration information for Salesforce chatter feeds.

$sel:crawlAttachments:SalesforceConfiguration', salesforceConfiguration_crawlAttachments - Indicates whether Amazon Kendra should index attachments to Salesforce objects.

$sel:excludeAttachmentFilePatterns:SalesforceConfiguration', salesforceConfiguration_excludeAttachmentFilePatterns - 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.

$sel:includeAttachmentFilePatterns:SalesforceConfiguration', salesforceConfiguration_includeAttachmentFilePatterns - 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.

$sel:knowledgeArticleConfiguration:SalesforceConfiguration', salesforceConfiguration_knowledgeArticleConfiguration - 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.

$sel:standardObjectAttachmentConfiguration:SalesforceConfiguration', salesforceConfiguration_standardObjectAttachmentConfiguration - Configuration information for processing attachments to Salesforce standard objects.

$sel:standardObjectConfigurations:SalesforceConfiguration', salesforceConfiguration_standardObjectConfigurations - Configuration of the Salesforce standard objects that Amazon Kendra indexes.

$sel:serverUrl:SalesforceConfiguration', salesforceConfiguration_serverUrl - The instance URL for the Salesforce site that you want to index.

$sel:secretArn:SalesforceConfiguration', salesforceConfiguration_secretArn - 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

data SalesforceCustomKnowledgeArticleTypeConfiguration Source #

Provides the configuration information for indexing Salesforce custom articles.

See: newSalesforceCustomKnowledgeArticleTypeConfiguration smart constructor.

Instances

Instances details
FromJSON SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

ToJSON SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

Generic SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

Read SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

Show SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

NFData SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

Eq SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

Hashable SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

type Rep SalesforceCustomKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration

type Rep SalesforceCustomKnowledgeArticleTypeConfiguration = D1 ('MetaData "SalesforceCustomKnowledgeArticleTypeConfiguration" "Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceCustomKnowledgeArticleTypeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSalesforceCustomKnowledgeArticleTypeConfiguration Source #

Create a value of SalesforceCustomKnowledgeArticleTypeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentTitleFieldName:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_documentTitleFieldName - The name of the field in the custom knowledge article that contains the document title.

$sel:fieldMappings:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_fieldMappings - 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.

$sel:name:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_name - The name of the configuration.

$sel:documentDataFieldName:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_documentDataFieldName - The name of the field in the custom knowledge article that contains the document data to index.

SalesforceKnowledgeArticleConfiguration

data SalesforceKnowledgeArticleConfiguration Source #

Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

See: newSalesforceKnowledgeArticleConfiguration smart constructor.

Instances

Instances details
FromJSON SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

ToJSON SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

Generic SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

Read SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

Show SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

NFData SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

Eq SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

Hashable SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

type Rep SalesforceKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration

type Rep SalesforceKnowledgeArticleConfiguration = D1 ('MetaData "SalesforceKnowledgeArticleConfiguration" "Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceKnowledgeArticleConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKnowledgeArticleTypeConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration))) :*: (S1 ('MetaSel ('Just "standardKnowledgeArticleTypeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceStandardKnowledgeArticleTypeConfiguration)) :*: S1 ('MetaSel ('Just "includedStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SalesforceKnowledgeArticleState)))))

newSalesforceKnowledgeArticleConfiguration Source #

Create a value of SalesforceKnowledgeArticleConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations - Configuration information for custom Salesforce knowledge articles.

$sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration - Configuration information for standard Salesforce knowledge articles.

$sel:includedStates:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_includedStates - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

SalesforceStandardKnowledgeArticleTypeConfiguration

data SalesforceStandardKnowledgeArticleTypeConfiguration Source #

Provides the configuration information for standard Salesforce knowledge articles.

See: newSalesforceStandardKnowledgeArticleTypeConfiguration smart constructor.

Instances

Instances details
FromJSON SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

ToJSON SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

Generic SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

Read SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

Show SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

NFData SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

Eq SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

Hashable SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

type Rep SalesforceStandardKnowledgeArticleTypeConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration

type Rep SalesforceStandardKnowledgeArticleTypeConfiguration = D1 ('MetaData "SalesforceStandardKnowledgeArticleTypeConfiguration" "Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceStandardKnowledgeArticleTypeConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSalesforceStandardKnowledgeArticleTypeConfiguration Source #

Create a value of SalesforceStandardKnowledgeArticleTypeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentTitleFieldName:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_documentTitleFieldName - The name of the field that contains the document title.

$sel:fieldMappings:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_fieldMappings - 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.

$sel:documentDataFieldName:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_documentDataFieldName - The name of the field that contains the document data to index.

SalesforceStandardObjectAttachmentConfiguration

data SalesforceStandardObjectAttachmentConfiguration Source #

Provides the configuration information for processing attachments to Salesforce standard objects.

See: newSalesforceStandardObjectAttachmentConfiguration smart constructor.

Instances

Instances details
FromJSON SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

ToJSON SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

Generic SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

Read SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

Show SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

NFData SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

Eq SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

Hashable SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

type Rep SalesforceStandardObjectAttachmentConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration

type Rep SalesforceStandardObjectAttachmentConfiguration = D1 ('MetaData "SalesforceStandardObjectAttachmentConfiguration" "Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceStandardObjectAttachmentConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))))

newSalesforceStandardObjectAttachmentConfiguration :: SalesforceStandardObjectAttachmentConfiguration Source #

Create a value of SalesforceStandardObjectAttachmentConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentTitleFieldName:SalesforceStandardObjectAttachmentConfiguration', salesforceStandardObjectAttachmentConfiguration_documentTitleFieldName - The name of the field used for the document title.

$sel:fieldMappings:SalesforceStandardObjectAttachmentConfiguration', salesforceStandardObjectAttachmentConfiguration_fieldMappings - One or more objects that map fields in attachments to Amazon Kendra index fields.

SalesforceStandardObjectConfiguration

data SalesforceStandardObjectConfiguration Source #

Provides the configuration information for indexing a single standard object.

See: newSalesforceStandardObjectConfiguration smart constructor.

Instances

Instances details
FromJSON SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

ToJSON SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

Generic SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

Read SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

Show SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

NFData SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

Eq SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

Hashable SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

type Rep SalesforceStandardObjectConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration

type Rep SalesforceStandardObjectConfiguration = D1 ('MetaData "SalesforceStandardObjectConfiguration" "Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceStandardObjectConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SalesforceStandardObjectName) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSalesforceStandardObjectConfiguration Source #

Create a value of SalesforceStandardObjectConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentTitleFieldName:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_documentTitleFieldName - The name of the field in the standard object table that contains the document title.

$sel:fieldMappings:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_fieldMappings - 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.

$sel:name:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_name - The name of the standard object.

$sel:documentDataFieldName:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_documentDataFieldName - The name of the field in the standard object table that contains the document contents.

ScoreAttributes

data ScoreAttributes Source #

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

See: newScoreAttributes smart constructor.

Instances

Instances details
FromJSON ScoreAttributes Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreAttributes

Generic ScoreAttributes Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreAttributes

Associated Types

type Rep ScoreAttributes :: Type -> Type #

Read ScoreAttributes Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreAttributes

Show ScoreAttributes Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreAttributes

NFData ScoreAttributes Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreAttributes

Methods

rnf :: ScoreAttributes -> () #

Eq ScoreAttributes Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreAttributes

Hashable ScoreAttributes Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreAttributes

type Rep ScoreAttributes Source # 
Instance details

Defined in Amazonka.Kendra.Types.ScoreAttributes

type Rep ScoreAttributes = D1 ('MetaData "ScoreAttributes" "Amazonka.Kendra.Types.ScoreAttributes" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ScoreAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scoreConfidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScoreConfidence))))

newScoreAttributes :: ScoreAttributes Source #

Create a value of ScoreAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:scoreConfidence:ScoreAttributes', scoreAttributes_scoreConfidence - A relative ranking for how well the response matches the query.

Search

data Search Source #

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

See: newSearch smart constructor.

Constructors

Search' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) 

Instances

Instances details
FromJSON Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

ToJSON Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

Generic Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

Associated Types

type Rep Search :: Type -> Type #

Methods

from :: Search -> Rep Search x #

to :: Rep Search x -> Search #

Read Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

Show Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

NFData Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

Methods

rnf :: Search -> () #

Eq Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

Methods

(==) :: Search -> Search -> Bool #

(/=) :: Search -> Search -> Bool #

Hashable Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

Methods

hashWithSalt :: Int -> Search -> Int #

hash :: Search -> Int #

type Rep Search Source # 
Instance details

Defined in Amazonka.Kendra.Types.Search

type Rep Search = D1 ('MetaData "Search" "Amazonka.Kendra.Types.Search" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Search'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "displayable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "facetable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "searchable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sortable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newSearch :: Search Source #

Create a value of Search with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:displayable:Search', search_displayable - Determines whether the field is returned in the query response. The default is true.

$sel:facetable:Search', search_facetable - 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 .

$sel:searchable:Search', search_searchable - 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.

$sel:sortable:Search', search_sortable - 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

data SeedUrlConfiguration Source #

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

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

See: newSeedUrlConfiguration smart constructor.

Instances

Instances details
FromJSON SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

ToJSON SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

Generic SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

Associated Types

type Rep SeedUrlConfiguration :: Type -> Type #

Read SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

Show SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

NFData SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

Methods

rnf :: SeedUrlConfiguration -> () #

Eq SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

Hashable SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

type Rep SeedUrlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SeedUrlConfiguration

type Rep SeedUrlConfiguration = D1 ('MetaData "SeedUrlConfiguration" "Amazonka.Kendra.Types.SeedUrlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SeedUrlConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "webCrawlerMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebCrawlerMode)) :*: S1 ('MetaSel ('Just "seedUrls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newSeedUrlConfiguration :: SeedUrlConfiguration Source #

Create a value of SeedUrlConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:webCrawlerMode:SeedUrlConfiguration', seedUrlConfiguration_webCrawlerMode - 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.

$sel:seedUrls:SeedUrlConfiguration', seedUrlConfiguration_seedUrls - 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

data ServerSideEncryptionConfiguration Source #

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

See: newServerSideEncryptionConfiguration smart constructor.

Instances

Instances details
FromJSON ServerSideEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration

ToJSON ServerSideEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration

Generic ServerSideEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration

Associated Types

type Rep ServerSideEncryptionConfiguration :: Type -> Type #

Show ServerSideEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration

NFData ServerSideEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration

Eq ServerSideEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration

Hashable ServerSideEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration

type Rep ServerSideEncryptionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration

type Rep ServerSideEncryptionConfiguration = D1 ('MetaData "ServerSideEncryptionConfiguration" "Amazonka.Kendra.Types.ServerSideEncryptionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServerSideEncryptionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))

newServerSideEncryptionConfiguration :: ServerSideEncryptionConfiguration Source #

Create a value of ServerSideEncryptionConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:ServerSideEncryptionConfiguration', serverSideEncryptionConfiguration_kmsKeyId - The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.

ServiceNowConfiguration

data ServiceNowConfiguration Source #

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

See: newServiceNowConfiguration smart constructor.

Instances

Instances details
FromJSON ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

ToJSON ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

Generic ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

Associated Types

type Rep ServiceNowConfiguration :: Type -> Type #

Read ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

Show ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

NFData ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

Methods

rnf :: ServiceNowConfiguration -> () #

Eq ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

Hashable ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

type Rep ServiceNowConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowConfiguration

type Rep ServiceNowConfiguration = D1 ('MetaData "ServiceNowConfiguration" "Amazonka.Kendra.Types.ServiceNowConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServiceNowConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowAuthenticationType)) :*: (S1 ('MetaSel ('Just "knowledgeArticleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowKnowledgeArticleConfiguration)) :*: S1 ('MetaSel ('Just "serviceCatalogConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowServiceCatalogConfiguration)))) :*: (S1 ('MetaSel ('Just "hostUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceNowBuildVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceNowBuildVersionType)))))

newServiceNowConfiguration Source #

Create a value of ServiceNowConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticationType:ServiceNowConfiguration', serviceNowConfiguration_authenticationType - 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.

$sel:knowledgeArticleConfiguration:ServiceNowConfiguration', serviceNowConfiguration_knowledgeArticleConfiguration - Configuration information for crawling knowledge articles in the ServiceNow site.

$sel:serviceCatalogConfiguration:ServiceNowConfiguration', serviceNowConfiguration_serviceCatalogConfiguration - Configuration information for crawling service catalogs in the ServiceNow site.

$sel:hostUrl:ServiceNowConfiguration', serviceNowConfiguration_hostUrl - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

$sel:secretArn:ServiceNowConfiguration', serviceNowConfiguration_secretArn - 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.

$sel:serviceNowBuildVersion:ServiceNowConfiguration', serviceNowConfiguration_serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

ServiceNowKnowledgeArticleConfiguration

data ServiceNowKnowledgeArticleConfiguration Source #

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

See: newServiceNowKnowledgeArticleConfiguration smart constructor.

Instances

Instances details
FromJSON ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

ToJSON ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Generic ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Read ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Show ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

NFData ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Eq ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Hashable ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

type Rep ServiceNowKnowledgeArticleConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

type Rep ServiceNowKnowledgeArticleConfiguration = D1 ('MetaData "ServiceNowKnowledgeArticleConfiguration" "Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServiceNowKnowledgeArticleConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "excludeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "filterQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "includeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newServiceNowKnowledgeArticleConfiguration Source #

Create a value of ServiceNowKnowledgeArticleConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crawlAttachments:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_crawlAttachments - TRUE to index attachments to knowledge articles.

$sel:documentTitleFieldName:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.

$sel:excludeAttachmentFilePatterns:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_excludeAttachmentFilePatterns - 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.

$sel:fieldMappings:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_fieldMappings - 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.

$sel:filterQuery:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_filterQuery - 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.

$sel:includeAttachmentFilePatterns:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_includeAttachmentFilePatterns - 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.

$sel:documentDataFieldName:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

ServiceNowServiceCatalogConfiguration

data ServiceNowServiceCatalogConfiguration Source #

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

See: newServiceNowServiceCatalogConfiguration smart constructor.

Instances

Instances details
FromJSON ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

ToJSON ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

Generic ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

Read ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

Show ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

NFData ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

Eq ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

Hashable ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

type Rep ServiceNowServiceCatalogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration

type Rep ServiceNowServiceCatalogConfiguration = D1 ('MetaData "ServiceNowServiceCatalogConfiguration" "Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServiceNowServiceCatalogConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "excludeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "includeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newServiceNowServiceCatalogConfiguration Source #

Create a value of ServiceNowServiceCatalogConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crawlAttachments:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_crawlAttachments - TRUE to index attachments to service catalog items.

$sel:documentTitleFieldName:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.

$sel:excludeAttachmentFilePatterns:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_excludeAttachmentFilePatterns - 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.

$sel:fieldMappings:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_fieldMappings - 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.

$sel:includeAttachmentFilePatterns:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_includeAttachmentFilePatterns - 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.

$sel:documentDataFieldName:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

SharePointConfiguration

data SharePointConfiguration Source #

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

See: newSharePointConfiguration smart constructor.

Instances

Instances details
FromJSON SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

ToJSON SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

Generic SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

Associated Types

type Rep SharePointConfiguration :: Type -> Type #

Read SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

Show SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

NFData SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

Methods

rnf :: SharePointConfiguration -> () #

Eq SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

Hashable SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

type Rep SharePointConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SharePointConfiguration

type Rep SharePointConfiguration = D1 ('MetaData "SharePointConfiguration" "Amazonka.Kendra.Types.SharePointConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SharePointConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SharePointOnlineAuthenticationType)) :*: (S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "disableLocalGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration)) :*: (S1 ('MetaSel ('Just "sslCertificateS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :*: S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "sharePointVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SharePointVersion)) :*: (S1 ('MetaSel ('Just "urls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSharePointConfiguration Source #

Create a value of SharePointConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticationType:SharePointConfiguration', sharePointConfiguration_authenticationType - 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.

$sel:crawlAttachments:SharePointConfiguration', sharePointConfiguration_crawlAttachments - TRUE to index document attachments.

$sel:disableLocalGroups:SharePointConfiguration', sharePointConfiguration_disableLocalGroups - TRUE to disable local groups information.

$sel:documentTitleFieldName:SharePointConfiguration', sharePointConfiguration_documentTitleFieldName - The Microsoft SharePoint attribute field that contains the title of the document.

$sel:exclusionPatterns:SharePointConfiguration', sharePointConfiguration_exclusionPatterns - 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.

$sel:fieldMappings:SharePointConfiguration', sharePointConfiguration_fieldMappings - 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.

$sel:inclusionPatterns:SharePointConfiguration', sharePointConfiguration_inclusionPatterns - 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.

$sel:proxyConfiguration:SharePointConfiguration', sharePointConfiguration_proxyConfiguration - 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.

$sel:sslCertificateS3Path:SharePointConfiguration', sharePointConfiguration_sslCertificateS3Path - 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.

$sel:useChangeLog:SharePointConfiguration', sharePointConfiguration_useChangeLog - 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.

$sel:vpcConfiguration:SharePointConfiguration', sharePointConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

$sel:sharePointVersion:SharePointConfiguration', sharePointConfiguration_sharePointVersion - The version of Microsoft SharePoint that you use.

$sel:urls:SharePointConfiguration', sharePointConfiguration_urls - The Microsoft SharePoint site URLs for the documents you want to index.

$sel:secretArn:SharePointConfiguration', sharePointConfiguration_secretArn - 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

data SiteMapsConfiguration Source #

Provides the configuration information for the sitemap URLs to crawl.

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

See: newSiteMapsConfiguration smart constructor.

Instances

Instances details
FromJSON SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

ToJSON SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

Generic SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

Associated Types

type Rep SiteMapsConfiguration :: Type -> Type #

Read SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

Show SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

NFData SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

Methods

rnf :: SiteMapsConfiguration -> () #

Eq SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

Hashable SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

type Rep SiteMapsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SiteMapsConfiguration

type Rep SiteMapsConfiguration = D1 ('MetaData "SiteMapsConfiguration" "Amazonka.Kendra.Types.SiteMapsConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SiteMapsConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "siteMaps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newSiteMapsConfiguration :: SiteMapsConfiguration Source #

Create a value of SiteMapsConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:siteMaps:SiteMapsConfiguration', siteMapsConfiguration_siteMaps - The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

SlackConfiguration

data SlackConfiguration Source #

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

See: newSlackConfiguration smart constructor.

Instances

Instances details
FromJSON SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

ToJSON SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

Generic SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

Associated Types

type Rep SlackConfiguration :: Type -> Type #

Read SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

Show SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

NFData SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

Methods

rnf :: SlackConfiguration -> () #

Eq SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

Hashable SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

type Rep SlackConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SlackConfiguration

type Rep SlackConfiguration = D1 ('MetaData "SlackConfiguration" "Amazonka.Kendra.Types.SlackConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SlackConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "crawlBotMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "excludeArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "lookBackPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "privateChannelFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "publicChannelFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :*: ((S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "slackEntityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SlackEntity)) :*: S1 ('MetaSel ('Just "sinceCrawlDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSlackConfiguration Source #

Create a value of SlackConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crawlBotMessage:SlackConfiguration', slackConfiguration_crawlBotMessage - TRUE to index bot messages from your Slack workspace team.

$sel:excludeArchived:SlackConfiguration', slackConfiguration_excludeArchived - TRUE to exclude archived messages to index from your Slack workspace team.

$sel:exclusionPatterns:SlackConfiguration', slackConfiguration_exclusionPatterns - 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.

$sel:fieldMappings:SlackConfiguration', slackConfiguration_fieldMappings - 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.

$sel:inclusionPatterns:SlackConfiguration', slackConfiguration_inclusionPatterns - 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.

$sel:lookBackPeriod:SlackConfiguration', slackConfiguration_lookBackPeriod - 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.

$sel:privateChannelFilter:SlackConfiguration', slackConfiguration_privateChannelFilter - 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.

$sel:publicChannelFilter:SlackConfiguration', slackConfiguration_publicChannelFilter - 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.

$sel:useChangeLog:SlackConfiguration', slackConfiguration_useChangeLog - 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.

$sel:vpcConfiguration:SlackConfiguration', slackConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.

$sel:teamId:SlackConfiguration', slackConfiguration_teamId - 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/....

$sel:secretArn:SlackConfiguration', slackConfiguration_secretArn - 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:

$sel:slackEntityList:SlackConfiguration', slackConfiguration_slackEntityList - Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

$sel:sinceCrawlDate:SlackConfiguration', slackConfiguration_sinceCrawlDate - The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.

SortingConfiguration

data SortingConfiguration Source #

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.

You can sort attributes of the following types.

  • Date value
  • Long value
  • String value

You can't sort attributes of the following type.

  • String list value

See: newSortingConfiguration smart constructor.

Instances

Instances details
ToJSON SortingConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortingConfiguration

Generic SortingConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortingConfiguration

Associated Types

type Rep SortingConfiguration :: Type -> Type #

Read SortingConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortingConfiguration

Show SortingConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortingConfiguration

NFData SortingConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortingConfiguration

Methods

rnf :: SortingConfiguration -> () #

Eq SortingConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortingConfiguration

Hashable SortingConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortingConfiguration

type Rep SortingConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SortingConfiguration

type Rep SortingConfiguration = D1 ('MetaData "SortingConfiguration" "Amazonka.Kendra.Types.SortingConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SortingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SortOrder)))

newSortingConfiguration Source #

Create a value of SortingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentAttributeKey:SortingConfiguration', sortingConfiguration_documentAttributeKey - 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

$sel:sortOrder:SortingConfiguration', sortingConfiguration_sortOrder - 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

data SpellCorrectedQuery Source #

A query with suggested spell corrections.

See: newSpellCorrectedQuery smart constructor.

Instances

Instances details
FromJSON SpellCorrectedQuery Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectedQuery

Generic SpellCorrectedQuery Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectedQuery

Associated Types

type Rep SpellCorrectedQuery :: Type -> Type #

Read SpellCorrectedQuery Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectedQuery

Show SpellCorrectedQuery Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectedQuery

NFData SpellCorrectedQuery Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectedQuery

Methods

rnf :: SpellCorrectedQuery -> () #

Eq SpellCorrectedQuery Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectedQuery

Hashable SpellCorrectedQuery Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectedQuery

type Rep SpellCorrectedQuery Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectedQuery

type Rep SpellCorrectedQuery = D1 ('MetaData "SpellCorrectedQuery" "Amazonka.Kendra.Types.SpellCorrectedQuery" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SpellCorrectedQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "corrections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Correction])) :*: S1 ('MetaSel ('Just "suggestedQueryText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSpellCorrectedQuery :: SpellCorrectedQuery Source #

Create a value of SpellCorrectedQuery with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:corrections:SpellCorrectedQuery', spellCorrectedQuery_corrections - The corrected misspelled word or words in a query.

$sel:suggestedQueryText:SpellCorrectedQuery', spellCorrectedQuery_suggestedQueryText - The query with the suggested spell corrections.

SpellCorrectionConfiguration

data SpellCorrectionConfiguration Source #

Provides the configuration information for suggested query spell corrections.

Suggested spell corrections are based on words that appear in your indexed documents and how closely a corrected word matches a misspelled word.

This feature is designed with certain defaults or limits. For information on the current limits and how to request more support for some limits, see the Spell Checker documentation.

See: newSpellCorrectionConfiguration smart constructor.

Instances

Instances details
ToJSON SpellCorrectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Generic SpellCorrectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Associated Types

type Rep SpellCorrectionConfiguration :: Type -> Type #

Read SpellCorrectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Show SpellCorrectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

NFData SpellCorrectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Eq SpellCorrectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

Hashable SpellCorrectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

type Rep SpellCorrectionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration

type Rep SpellCorrectionConfiguration = D1 ('MetaData "SpellCorrectionConfiguration" "Amazonka.Kendra.Types.SpellCorrectionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SpellCorrectionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeQuerySpellCheckSuggestions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

newSpellCorrectionConfiguration Source #

Create a value of SpellCorrectionConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:includeQuerySpellCheckSuggestions:SpellCorrectionConfiguration', spellCorrectionConfiguration_includeQuerySpellCheckSuggestions - TRUE to suggest spell corrections for queries.

SqlConfiguration

data SqlConfiguration Source #

Provides the configuration information to use a SQL database.

See: newSqlConfiguration smart constructor.

Instances

Instances details
FromJSON SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

ToJSON SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

Generic SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

Associated Types

type Rep SqlConfiguration :: Type -> Type #

Read SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

Show SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

NFData SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

Methods

rnf :: SqlConfiguration -> () #

Eq SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

Hashable SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

type Rep SqlConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.SqlConfiguration

type Rep SqlConfiguration = D1 ('MetaData "SqlConfiguration" "Amazonka.Kendra.Types.SqlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SqlConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryIdentifiersEnclosingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryIdentifiersEnclosingOption))))

newSqlConfiguration :: SqlConfiguration Source #

Create a value of SqlConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queryIdentifiersEnclosingOption:SqlConfiguration', sqlConfiguration_queryIdentifiersEnclosingOption - 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

data Status Source #

Provides information about the status of documents submitted for indexing.

See: newStatus smart constructor.

Instances

Instances details
FromJSON Status Source # 
Instance details

Defined in Amazonka.Kendra.Types.Status

Generic Status Source # 
Instance details

Defined in Amazonka.Kendra.Types.Status

Associated Types

type Rep Status :: Type -> Type #

Methods

from :: Status -> Rep Status x #

to :: Rep Status x -> Status #

Read Status Source # 
Instance details

Defined in Amazonka.Kendra.Types.Status

Show Status Source # 
Instance details

Defined in Amazonka.Kendra.Types.Status

NFData Status Source # 
Instance details

Defined in Amazonka.Kendra.Types.Status

Methods

rnf :: Status -> () #

Eq Status Source # 
Instance details

Defined in Amazonka.Kendra.Types.Status

Methods

(==) :: Status -> Status -> Bool #

(/=) :: Status -> Status -> Bool #

Hashable Status Source # 
Instance details

Defined in Amazonka.Kendra.Types.Status

Methods

hashWithSalt :: Int -> Status -> Int #

hash :: Status -> Int #

type Rep Status Source # 
Instance details

Defined in Amazonka.Kendra.Types.Status

type Rep Status = D1 ('MetaData "Status" "Amazonka.Kendra.Types.Status" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Status'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentStatus))) :*: (S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newStatus :: Status Source #

Create a value of Status with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentId:Status', status_documentId - The identifier of the document.

$sel:documentStatus:Status', status_documentStatus - The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

$sel:failureCode:Status', status_failureCode - Indicates the source of the error.

$sel:failureReason:Status', status_failureReason - 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

data Suggestion Source #

A single query suggestion.

See: newSuggestion smart constructor.

Instances

Instances details
FromJSON Suggestion Source # 
Instance details

Defined in Amazonka.Kendra.Types.Suggestion

Generic Suggestion Source # 
Instance details

Defined in Amazonka.Kendra.Types.Suggestion

Associated Types

type Rep Suggestion :: Type -> Type #

Read Suggestion Source # 
Instance details

Defined in Amazonka.Kendra.Types.Suggestion

Show Suggestion Source # 
Instance details

Defined in Amazonka.Kendra.Types.Suggestion

NFData Suggestion Source # 
Instance details

Defined in Amazonka.Kendra.Types.Suggestion

Methods

rnf :: Suggestion -> () #

Eq Suggestion Source # 
Instance details

Defined in Amazonka.Kendra.Types.Suggestion

Hashable Suggestion Source # 
Instance details

Defined in Amazonka.Kendra.Types.Suggestion

type Rep Suggestion Source # 
Instance details

Defined in Amazonka.Kendra.Types.Suggestion

type Rep Suggestion = D1 ('MetaData "Suggestion" "Amazonka.Kendra.Types.Suggestion" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Suggestion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestionValue))))

newSuggestion :: Suggestion Source #

Create a value of Suggestion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:Suggestion', suggestion_id - The UUID (universally unique identifier) of a single query suggestion.

$sel:value:Suggestion', suggestion_value - The value for the UUID (universally unique identifier) of a single query suggestion.

The value is the text string of a suggestion.

SuggestionHighlight

data SuggestionHighlight Source #

The text highlights for a single query suggestion.

See: newSuggestionHighlight smart constructor.

Instances

Instances details
FromJSON SuggestionHighlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionHighlight

Generic SuggestionHighlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionHighlight

Associated Types

type Rep SuggestionHighlight :: Type -> Type #

Read SuggestionHighlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionHighlight

Show SuggestionHighlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionHighlight

NFData SuggestionHighlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionHighlight

Methods

rnf :: SuggestionHighlight -> () #

Eq SuggestionHighlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionHighlight

Hashable SuggestionHighlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionHighlight

type Rep SuggestionHighlight Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionHighlight

type Rep SuggestionHighlight = D1 ('MetaData "SuggestionHighlight" "Amazonka.Kendra.Types.SuggestionHighlight" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SuggestionHighlight'" 'PrefixI 'True) (S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newSuggestionHighlight :: SuggestionHighlight Source #

Create a value of SuggestionHighlight with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:beginOffset:SuggestionHighlight', suggestionHighlight_beginOffset - The zero-based location in the response string where the highlight starts.

$sel:endOffset:SuggestionHighlight', suggestionHighlight_endOffset - The zero-based location in the response string where the highlight ends.

SuggestionTextWithHighlights

data SuggestionTextWithHighlights Source #

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

See: newSuggestionTextWithHighlights smart constructor.

Instances

Instances details
FromJSON SuggestionTextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Generic SuggestionTextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Associated Types

type Rep SuggestionTextWithHighlights :: Type -> Type #

Read SuggestionTextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Show SuggestionTextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

NFData SuggestionTextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Eq SuggestionTextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

Hashable SuggestionTextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

type Rep SuggestionTextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights

type Rep SuggestionTextWithHighlights = D1 ('MetaData "SuggestionTextWithHighlights" "Amazonka.Kendra.Types.SuggestionTextWithHighlights" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SuggestionTextWithHighlights'" 'PrefixI 'True) (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SuggestionHighlight])) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSuggestionTextWithHighlights :: SuggestionTextWithHighlights Source #

Create a value of SuggestionTextWithHighlights with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:highlights:SuggestionTextWithHighlights', suggestionTextWithHighlights_highlights - The beginning and end of the query suggestion text that should be highlighted.

$sel:text:SuggestionTextWithHighlights', suggestionTextWithHighlights_text - The query suggestion text to display to the user.

SuggestionValue

data SuggestionValue Source #

The SuggestionTextWithHighlights structure information.

See: newSuggestionValue smart constructor.

Instances

Instances details
FromJSON SuggestionValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionValue

Generic SuggestionValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionValue

Associated Types

type Rep SuggestionValue :: Type -> Type #

Read SuggestionValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionValue

Show SuggestionValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionValue

NFData SuggestionValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionValue

Methods

rnf :: SuggestionValue -> () #

Eq SuggestionValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionValue

Hashable SuggestionValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionValue

type Rep SuggestionValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.SuggestionValue

type Rep SuggestionValue = D1 ('MetaData "SuggestionValue" "Amazonka.Kendra.Types.SuggestionValue" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SuggestionValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestionTextWithHighlights))))

newSuggestionValue :: SuggestionValue Source #

Create a value of SuggestionValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SuggestionValue, suggestionValue_text - The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.

TableCell

data TableCell Source #

Provides information about a table cell in a table excerpt.

See: newTableCell smart constructor.

Instances

Instances details
FromJSON TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Generic TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Associated Types

type Rep TableCell :: Type -> Type #

Read TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Show TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

NFData TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Methods

rnf :: TableCell -> () #

Eq TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Hashable TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

type Rep TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

type Rep TableCell = D1 ('MetaData "TableCell" "Amazonka.Kendra.Types.TableCell" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TableCell'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "highlighted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "topAnswer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newTableCell :: TableCell Source #

Create a value of TableCell with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:header:TableCell', tableCell_header - TRUE means that the table cell should be treated as a header.

$sel:highlighted:TableCell', tableCell_highlighted - 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.

$sel:topAnswer:TableCell', tableCell_topAnswer - 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.

$sel:value:TableCell', tableCell_value - 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

data TableExcerpt Source #

An excerpt from a table within a document. The table excerpt displays up to five columns and three rows, depending on how many table cells are relevant to the query and how many columns are available in the original table. The top most relevant cell is displayed in the table excerpt, along with the next most relevant cells.

See: newTableExcerpt smart constructor.

Constructors

TableExcerpt' (Maybe [TableRow]) (Maybe Int) 

Instances

Instances details
FromJSON TableExcerpt Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableExcerpt

Generic TableExcerpt Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableExcerpt

Associated Types

type Rep TableExcerpt :: Type -> Type #

Read TableExcerpt Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableExcerpt

Show TableExcerpt Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableExcerpt

NFData TableExcerpt Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableExcerpt

Methods

rnf :: TableExcerpt -> () #

Eq TableExcerpt Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableExcerpt

Hashable TableExcerpt Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableExcerpt

type Rep TableExcerpt Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableExcerpt

type Rep TableExcerpt = D1 ('MetaData "TableExcerpt" "Amazonka.Kendra.Types.TableExcerpt" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TableExcerpt'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TableRow])) :*: S1 ('MetaSel ('Just "totalNumberOfRows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newTableExcerpt :: TableExcerpt Source #

Create a value of TableExcerpt with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rows:TableExcerpt', tableExcerpt_rows - A list of rows in the table excerpt.

$sel:totalNumberOfRows:TableExcerpt', tableExcerpt_totalNumberOfRows - A count of the number of rows in the original table within the document.

TableRow

data TableRow Source #

Information about a row in a table excerpt.

See: newTableRow smart constructor.

Constructors

TableRow' (Maybe [TableCell]) 

Instances

Instances details
FromJSON TableRow Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableRow

Generic TableRow Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableRow

Associated Types

type Rep TableRow :: Type -> Type #

Methods

from :: TableRow -> Rep TableRow x #

to :: Rep TableRow x -> TableRow #

Read TableRow Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableRow

Show TableRow Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableRow

NFData TableRow Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableRow

Methods

rnf :: TableRow -> () #

Eq TableRow Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableRow

Hashable TableRow Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableRow

Methods

hashWithSalt :: Int -> TableRow -> Int #

hash :: TableRow -> Int #

type Rep TableRow Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableRow

type Rep TableRow = D1 ('MetaData "TableRow" "Amazonka.Kendra.Types.TableRow" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TableRow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TableCell]))))

newTableRow :: TableRow Source #

Create a value of TableRow with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cells:TableRow', tableRow_cells - A list of table cells in a row.

Tag

data Tag Source #

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

See: newTag smart constructor.

Constructors

Tag' Text Text 

Instances

Instances details
FromJSON Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

ToJSON Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

Generic Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Read Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

NFData Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

Methods

rnf :: Tag -> () #

Eq Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Hashable Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

type Rep Tag Source # 
Instance details

Defined in Amazonka.Kendra.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Kendra.Types.Tag" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:Tag', tag_key - The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

$sel:value:Tag', tag_value - The value associated with the tag. The value may be an empty string but it can't be null.

Template

data Template Source #

The template schema used for the data source, where templates schemas are supported.

See Data source template schemas.

See: newTemplate smart constructor.

Constructors

Template' 

Instances

Instances details
FromJSON Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

ToJSON Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

Generic Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

Associated Types

type Rep Template :: Type -> Type #

Methods

from :: Template -> Rep Template x #

to :: Rep Template x -> Template #

Read Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

Show Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

NFData Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

Methods

rnf :: Template -> () #

Eq Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

Hashable Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

Methods

hashWithSalt :: Int -> Template -> Int #

hash :: Template -> Int #

type Rep Template Source # 
Instance details

Defined in Amazonka.Kendra.Types.Template

type Rep Template = D1 ('MetaData "Template" "Amazonka.Kendra.Types.Template" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Template'" 'PrefixI 'False) (U1 :: Type -> Type))

newTemplate :: Template Source #

Create a value of Template with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

TemplateConfiguration

data TemplateConfiguration Source #

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

See: newTemplateConfiguration smart constructor.

Instances

Instances details
FromJSON TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

ToJSON TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

Generic TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

Associated Types

type Rep TemplateConfiguration :: Type -> Type #

Read TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

Show TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

NFData TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

Methods

rnf :: TemplateConfiguration -> () #

Eq TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

Hashable TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

type Rep TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.TemplateConfiguration

type Rep TemplateConfiguration = D1 ('MetaData "TemplateConfiguration" "Amazonka.Kendra.Types.TemplateConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TemplateConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Template))))

newTemplateConfiguration :: TemplateConfiguration Source #

Create a value of TemplateConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:template:TemplateConfiguration', templateConfiguration_template - The template schema used for the data source, where templates schemas are supported.

See Data source template schemas.

TextDocumentStatistics

data TextDocumentStatistics Source #

Provides information about text documents indexed in an index.

See: newTextDocumentStatistics smart constructor.

Instances

Instances details
FromJSON TextDocumentStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextDocumentStatistics

Generic TextDocumentStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextDocumentStatistics

Associated Types

type Rep TextDocumentStatistics :: Type -> Type #

Read TextDocumentStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextDocumentStatistics

Show TextDocumentStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextDocumentStatistics

NFData TextDocumentStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextDocumentStatistics

Methods

rnf :: TextDocumentStatistics -> () #

Eq TextDocumentStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextDocumentStatistics

Hashable TextDocumentStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextDocumentStatistics

type Rep TextDocumentStatistics Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextDocumentStatistics

type Rep TextDocumentStatistics = D1 ('MetaData "TextDocumentStatistics" "Amazonka.Kendra.Types.TextDocumentStatistics" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TextDocumentStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexedTextDocumentsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "indexedTextBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newTextDocumentStatistics Source #

Create a value of TextDocumentStatistics with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexedTextDocumentsCount:TextDocumentStatistics', textDocumentStatistics_indexedTextDocumentsCount - The number of text documents indexed.

$sel:indexedTextBytes:TextDocumentStatistics', textDocumentStatistics_indexedTextBytes - The total size, in bytes, of the indexed documents.

TextWithHighlights

data TextWithHighlights Source #

Provides text and information about where to highlight the text.

See: newTextWithHighlights smart constructor.

Instances

Instances details
FromJSON TextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextWithHighlights

Generic TextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextWithHighlights

Associated Types

type Rep TextWithHighlights :: Type -> Type #

Read TextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextWithHighlights

Show TextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextWithHighlights

NFData TextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextWithHighlights

Methods

rnf :: TextWithHighlights -> () #

Eq TextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextWithHighlights

Hashable TextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextWithHighlights

type Rep TextWithHighlights Source # 
Instance details

Defined in Amazonka.Kendra.Types.TextWithHighlights

type Rep TextWithHighlights = D1 ('MetaData "TextWithHighlights" "Amazonka.Kendra.Types.TextWithHighlights" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TextWithHighlights'" 'PrefixI 'True) (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Highlight])) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTextWithHighlights :: TextWithHighlights Source #

Create a value of TextWithHighlights with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:highlights:TextWithHighlights', textWithHighlights_highlights - The beginning and end of the text that should be highlighted.

$sel:text:TextWithHighlights', textWithHighlights_text - The text to display to the user.

ThesaurusSummary

data ThesaurusSummary Source #

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

See: newThesaurusSummary smart constructor.

Instances

Instances details
FromJSON ThesaurusSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusSummary

Generic ThesaurusSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusSummary

Associated Types

type Rep ThesaurusSummary :: Type -> Type #

Read ThesaurusSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusSummary

Show ThesaurusSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusSummary

NFData ThesaurusSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusSummary

Methods

rnf :: ThesaurusSummary -> () #

Eq ThesaurusSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusSummary

Hashable ThesaurusSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusSummary

type Rep ThesaurusSummary Source # 
Instance details

Defined in Amazonka.Kendra.Types.ThesaurusSummary

type Rep ThesaurusSummary = D1 ('MetaData "ThesaurusSummary" "Amazonka.Kendra.Types.ThesaurusSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ThesaurusSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThesaurusStatus)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newThesaurusSummary :: ThesaurusSummary Source #

Create a value of ThesaurusSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:ThesaurusSummary', thesaurusSummary_createdAt - The Unix datetime that the thesaurus was created.

$sel:id:ThesaurusSummary', thesaurusSummary_id - The identifier of the thesaurus.

$sel:name:ThesaurusSummary', thesaurusSummary_name - The name of the thesaurus.

$sel:status:ThesaurusSummary', thesaurusSummary_status - The status of the thesaurus.

$sel:updatedAt:ThesaurusSummary', thesaurusSummary_updatedAt - The Unix datetime that the thesaurus was last updated.

TimeRange

data TimeRange Source #

Provides a range of time.

See: newTimeRange smart constructor.

Constructors

TimeRange' (Maybe POSIX) (Maybe POSIX) 

Instances

Instances details
FromJSON TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

ToJSON TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

Generic TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

Associated Types

type Rep TimeRange :: Type -> Type #

Read TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

Show TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

NFData TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

Methods

rnf :: TimeRange -> () #

Eq TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

Hashable TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

type Rep TimeRange Source # 
Instance details

Defined in Amazonka.Kendra.Types.TimeRange

type Rep TimeRange = D1 ('MetaData "TimeRange" "Amazonka.Kendra.Types.TimeRange" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TimeRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))

newTimeRange :: TimeRange Source #

Create a value of TimeRange with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endTime:TimeRange', timeRange_endTime - The UNIX datetime of the end of the time range.

$sel:startTime:TimeRange', timeRange_startTime - The UNIX datetime of the beginning of the time range.

Urls

data Urls Source #

Provides the configuration information of the URLs to crawl.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

See: newUrls smart constructor.

Instances

Instances details
FromJSON Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

ToJSON Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

Generic Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

Associated Types

type Rep Urls :: Type -> Type #

Methods

from :: Urls -> Rep Urls x #

to :: Rep Urls x -> Urls #

Read Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

Show Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

Methods

showsPrec :: Int -> Urls -> ShowS #

show :: Urls -> String #

showList :: [Urls] -> ShowS #

NFData Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

Methods

rnf :: Urls -> () #

Eq Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

Methods

(==) :: Urls -> Urls -> Bool #

(/=) :: Urls -> Urls -> Bool #

Hashable Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

Methods

hashWithSalt :: Int -> Urls -> Int #

hash :: Urls -> Int #

type Rep Urls Source # 
Instance details

Defined in Amazonka.Kendra.Types.Urls

type Rep Urls = D1 ('MetaData "Urls" "Amazonka.Kendra.Types.Urls" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Urls'" 'PrefixI 'True) (S1 ('MetaSel ('Just "seedUrlConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SeedUrlConfiguration)) :*: S1 ('MetaSel ('Just "siteMapsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SiteMapsConfiguration))))

newUrls :: Urls Source #

Create a value of Urls with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:seedUrlConfiguration:Urls', urls_seedUrlConfiguration - 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.

$sel:siteMapsConfiguration:Urls', urls_siteMapsConfiguration - 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

data UserContext Source #

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

User context filtering is a kind of personalized search with the benefit of controlling access to documents. For example, not all teams that search the company portal for information should access top-secret company documents, nor are these documents relevant to all users. Only specific users or groups of teams given access to top-secret documents should see these documents in their search results.

You provide one of the following:

  • User token
  • User ID, the groups the user belongs to, and any data sources the groups can access.

If you provide both, an exception is thrown.

See: newUserContext smart constructor.

Instances

Instances details
ToJSON UserContext Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContext

Generic UserContext Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContext

Associated Types

type Rep UserContext :: Type -> Type #

Read UserContext Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContext

Show UserContext Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContext

NFData UserContext Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContext

Methods

rnf :: UserContext -> () #

Eq UserContext Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContext

Hashable UserContext Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContext

type Rep UserContext Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserContext

type Rep UserContext = D1 ('MetaData "UserContext" "Amazonka.Kendra.Types.UserContext" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserContext'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceGroup))) :*: S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newUserContext :: UserContext Source #

Create a value of UserContext with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceGroups:UserContext', userContext_dataSourceGroups - The list of data source groups you want to filter search results based on groups' access to documents in that data source.

$sel:groups:UserContext', userContext_groups - The list of groups you want to filter search results based on the groups' access to documents.

$sel:token:UserContext', userContext_token - The user context token for filtering search results for a user. It must be a JWT or a JSON token.

$sel:userId:UserContext', userContext_userId - The identifier of the user you want to filter search results based on their access to documents.

UserGroupResolutionConfiguration

data UserGroupResolutionConfiguration Source #

Provides the configuration information to fetch access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the PutPrincipalMapping API to map users to their groups so that you only need to provide the user ID when you issue the query.

To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see Getting started with an IAM Identity Center identity source. You must also grant the required permissions to use IAM Identity Center with Amazon Kendra. For more information, see IAM roles for IAM Identity Center.

Amazon Kendra currently does not support using UserGroupResolutionConfiguration with an Amazon Web Services organization member account for your IAM Identity Center identify source. You must create your index in the management account for the organization in order to use UserGroupResolutionConfiguration.

See: newUserGroupResolutionConfiguration smart constructor.

Instances

Instances details
FromJSON UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

ToJSON UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

Generic UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

Associated Types

type Rep UserGroupResolutionConfiguration :: Type -> Type #

Read UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

Show UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

NFData UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

Eq UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

Hashable UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

type Rep UserGroupResolutionConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration

type Rep UserGroupResolutionConfiguration = D1 ('MetaData "UserGroupResolutionConfiguration" "Amazonka.Kendra.Types.UserGroupResolutionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserGroupResolutionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userGroupResolutionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserGroupResolutionMode)))

newUserGroupResolutionConfiguration Source #

Create a value of UserGroupResolutionConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userGroupResolutionMode:UserGroupResolutionConfiguration', userGroupResolutionConfiguration_userGroupResolutionMode - 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

data UserIdentityConfiguration Source #

Provides the configuration information for the identifiers of your users.

See: newUserIdentityConfiguration smart constructor.

Instances

Instances details
FromJSON UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

ToJSON UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

Generic UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

Associated Types

type Rep UserIdentityConfiguration :: Type -> Type #

Read UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

Show UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

NFData UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

Eq UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

Hashable UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

type Rep UserIdentityConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserIdentityConfiguration

type Rep UserIdentityConfiguration = D1 ('MetaData "UserIdentityConfiguration" "Amazonka.Kendra.Types.UserIdentityConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserIdentityConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityAttributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newUserIdentityConfiguration :: UserIdentityConfiguration Source #

Create a value of UserIdentityConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:identityAttributeName:UserIdentityConfiguration', userIdentityConfiguration_identityAttributeName - 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

data UserTokenConfiguration Source #

Provides the configuration information for a token.

See: newUserTokenConfiguration smart constructor.

Instances

Instances details
FromJSON UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

ToJSON UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

Generic UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

Associated Types

type Rep UserTokenConfiguration :: Type -> Type #

Read UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

Show UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

NFData UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

Methods

rnf :: UserTokenConfiguration -> () #

Eq UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

Hashable UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

type Rep UserTokenConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.UserTokenConfiguration

type Rep UserTokenConfiguration = D1 ('MetaData "UserTokenConfiguration" "Amazonka.Kendra.Types.UserTokenConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserTokenConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jsonTokenTypeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JsonTokenTypeConfiguration)) :*: S1 ('MetaSel ('Just "jwtTokenTypeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JwtTokenTypeConfiguration))))

newUserTokenConfiguration :: UserTokenConfiguration Source #

Create a value of UserTokenConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jsonTokenTypeConfiguration:UserTokenConfiguration', userTokenConfiguration_jsonTokenTypeConfiguration - Information about the JSON token type configuration.

$sel:jwtTokenTypeConfiguration:UserTokenConfiguration', userTokenConfiguration_jwtTokenTypeConfiguration - Information about the JWT token type configuration.

Warning

data Warning Source #

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

See: newWarning smart constructor.

Constructors

Warning' (Maybe WarningCode) (Maybe Text) 

Instances

Instances details
FromJSON Warning Source # 
Instance details

Defined in Amazonka.Kendra.Types.Warning

Generic Warning Source # 
Instance details

Defined in Amazonka.Kendra.Types.Warning

Associated Types

type Rep Warning :: Type -> Type #

Methods

from :: Warning -> Rep Warning x #

to :: Rep Warning x -> Warning #

Read Warning Source # 
Instance details

Defined in Amazonka.Kendra.Types.Warning

Show Warning Source # 
Instance details

Defined in Amazonka.Kendra.Types.Warning

NFData Warning Source # 
Instance details

Defined in Amazonka.Kendra.Types.Warning

Methods

rnf :: Warning -> () #

Eq Warning Source # 
Instance details

Defined in Amazonka.Kendra.Types.Warning

Methods

(==) :: Warning -> Warning -> Bool #

(/=) :: Warning -> Warning -> Bool #

Hashable Warning Source # 
Instance details

Defined in Amazonka.Kendra.Types.Warning

Methods

hashWithSalt :: Int -> Warning -> Int #

hash :: Warning -> Int #

type Rep Warning Source # 
Instance details

Defined in Amazonka.Kendra.Types.Warning

type Rep Warning = D1 ('MetaData "Warning" "Amazonka.Kendra.Types.Warning" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Warning'" 'PrefixI 'True) (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WarningCode)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newWarning :: Warning Source #

Create a value of Warning with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:code:Warning', warning_code - The code used to show the type of warning for the query.

$sel:message:Warning', warning_message - The message that explains the problem with the query.

WebCrawlerConfiguration

data WebCrawlerConfiguration Source #

Provides the configuration information required for Amazon Kendra Web Crawler.

See: newWebCrawlerConfiguration smart constructor.

Instances

Instances details
FromJSON WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

ToJSON WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Generic WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Associated Types

type Rep WebCrawlerConfiguration :: Type -> Type #

Read WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Show WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

NFData WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Methods

rnf :: WebCrawlerConfiguration -> () #

Eq WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

Hashable WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

type Rep WebCrawlerConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration

type Rep WebCrawlerConfiguration = D1 ('MetaData "WebCrawlerConfiguration" "Amazonka.Kendra.Types.WebCrawlerConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "WebCrawlerConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationConfiguration)) :*: S1 ('MetaSel ('Just "crawlDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "maxContentSizePerPageInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "maxLinksPerPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "maxUrlsPerMinuteCrawlRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration))) :*: (S1 ('MetaSel ('Just "urlExclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "urlInclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "urls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Urls))))))

newWebCrawlerConfiguration Source #

Create a value of WebCrawlerConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticationConfiguration:WebCrawlerConfiguration', webCrawlerConfiguration_authenticationConfiguration - 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.

$sel:crawlDepth:WebCrawlerConfiguration', webCrawlerConfiguration_crawlDepth - 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.

$sel:maxContentSizePerPageInMegaBytes:WebCrawlerConfiguration', webCrawlerConfiguration_maxContentSizePerPageInMegaBytes - 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.

$sel:maxLinksPerPage:WebCrawlerConfiguration', webCrawlerConfiguration_maxLinksPerPage - 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.

$sel:maxUrlsPerMinuteCrawlRate:WebCrawlerConfiguration', webCrawlerConfiguration_maxUrlsPerMinuteCrawlRate - 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.

$sel:proxyConfiguration:WebCrawlerConfiguration', webCrawlerConfiguration_proxyConfiguration - 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.

$sel:urlExclusionPatterns:WebCrawlerConfiguration', webCrawlerConfiguration_urlExclusionPatterns - 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.

$sel:urlInclusionPatterns:WebCrawlerConfiguration', webCrawlerConfiguration_urlInclusionPatterns - 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.

$sel:urls:WebCrawlerConfiguration', webCrawlerConfiguration_urls - 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

data WorkDocsConfiguration Source #

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

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

See: newWorkDocsConfiguration smart constructor.

Instances

Instances details
FromJSON WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

ToJSON WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

Generic WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

Associated Types

type Rep WorkDocsConfiguration :: Type -> Type #

Read WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

Show WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

NFData WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

Methods

rnf :: WorkDocsConfiguration -> () #

Eq WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

Hashable WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

type Rep WorkDocsConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.WorkDocsConfiguration

type Rep WorkDocsConfiguration = D1 ('MetaData "WorkDocsConfiguration" "Amazonka.Kendra.Types.WorkDocsConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "WorkDocsConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :*: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newWorkDocsConfiguration Source #

Create a value of WorkDocsConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crawlComments:WorkDocsConfiguration', workDocsConfiguration_crawlComments - 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.

$sel:exclusionPatterns:WorkDocsConfiguration', workDocsConfiguration_exclusionPatterns - 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.

$sel:fieldMappings:WorkDocsConfiguration', workDocsConfiguration_fieldMappings - 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.

$sel:inclusionPatterns:WorkDocsConfiguration', workDocsConfiguration_inclusionPatterns - 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.

$sel:useChangeLog:WorkDocsConfiguration', workDocsConfiguration_useChangeLog - 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.

$sel:organizationId:WorkDocsConfiguration', workDocsConfiguration_organizationId - 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.