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