| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Kendra
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateEntitiesToExperience
- AssociatePersonasToEntities
- BatchDeleteDocument
- BatchGetDocumentStatus
- BatchPutDocument
- ClearQuerySuggestions
- CreateAccessControlConfiguration
- CreateDataSource
- CreateExperience
- CreateFaq
- CreateIndex
- CreateQuerySuggestionsBlockList
- CreateThesaurus
- DeleteAccessControlConfiguration
- DeleteDataSource
- DeleteExperience
- DeleteFaq
- DeleteIndex
- DeletePrincipalMapping
- DeleteQuerySuggestionsBlockList
- DeleteThesaurus
- DescribeAccessControlConfiguration
- DescribeDataSource
- DescribeExperience
- DescribeFaq
- DescribeIndex
- DescribePrincipalMapping
- DescribeQuerySuggestionsBlockList
- DescribeQuerySuggestionsConfig
- DescribeThesaurus
- DisassociateEntitiesFromExperience
- DisassociatePersonasFromEntities
- GetQuerySuggestions
- GetSnapshots
- ListAccessControlConfigurations
- ListDataSourceSyncJobs
- ListDataSources
- ListEntityPersonas
- ListExperienceEntities
- ListExperiences
- ListFaqs
- ListGroupsOlderThanOrderingId
- ListIndices
- ListQuerySuggestionsBlockLists
- ListTagsForResource
- ListThesauri
- PutPrincipalMapping
- Query
- StartDataSourceSyncJob
- StopDataSourceSyncJob
- SubmitFeedback
- TagResource
- UntagResource
- UpdateAccessControlConfiguration
- UpdateDataSource
- UpdateExperience
- UpdateIndex
- UpdateQuerySuggestionsBlockList
- UpdateQuerySuggestionsConfig
- UpdateThesaurus
- Types
- AdditionalResultAttributeValueType
- AlfrescoEntity
- ConditionOperator
- ConfluenceAttachmentFieldName
- ConfluenceAuthenticationType
- ConfluenceBlogFieldName
- ConfluencePageFieldName
- ConfluenceSpaceFieldName
- ConfluenceVersion
- ContentType
- DataSourceStatus
- DataSourceSyncJobStatus
- DataSourceType
- DatabaseEngineType
- DocumentAttributeValueType
- DocumentStatus
- EndpointType
- EntityType
- ErrorCode
- ExperienceStatus
- FaqFileFormat
- FaqStatus
- FsxFileSystemType
- HighlightType
- IndexEdition
- IndexStatus
- Interval
- IssueSubEntity
- KeyLocation
- MetricType
- Mode
- Order
- Persona
- PrincipalMappingStatus
- PrincipalType
- QueryIdentifiersEnclosingOption
- QueryResultFormat
- QueryResultType
- QuerySuggestionsBlockListStatus
- QuerySuggestionsStatus
- ReadAccessType
- RelevanceType
- SalesforceChatterFeedIncludeFilterType
- SalesforceKnowledgeArticleState
- SalesforceStandardObjectName
- ScoreConfidence
- ServiceNowAuthenticationType
- ServiceNowBuildVersionType
- SharePointOnlineAuthenticationType
- SharePointVersion
- SlackEntity
- SortOrder
- ThesaurusStatus
- Type
- UserContextPolicy
- UserGroupResolutionMode
- WarningCode
- WebCrawlerMode
- AccessControlConfigurationSummary
- AccessControlListConfiguration
- AclConfiguration
- AdditionalResultAttribute
- AdditionalResultAttributeValue
- AlfrescoConfiguration
- AttributeFilter
- AuthenticationConfiguration
- BasicAuthenticationConfiguration
- BatchDeleteDocumentResponseFailedDocument
- BatchGetDocumentStatusResponseError
- BatchPutDocumentResponseFailedDocument
- BoxConfiguration
- CapacityUnitsConfiguration
- ClickFeedback
- ColumnConfiguration
- ConfluenceAttachmentConfiguration
- ConfluenceAttachmentToIndexFieldMapping
- ConfluenceBlogConfiguration
- ConfluenceBlogToIndexFieldMapping
- ConfluenceConfiguration
- ConfluencePageConfiguration
- ConfluencePageToIndexFieldMapping
- ConfluenceSpaceConfiguration
- ConfluenceSpaceToIndexFieldMapping
- ConnectionConfiguration
- ContentSourceConfiguration
- Correction
- CustomDocumentEnrichmentConfiguration
- DataSourceConfiguration
- DataSourceGroup
- DataSourceSummary
- DataSourceSyncJob
- DataSourceSyncJobMetricTarget
- DataSourceSyncJobMetrics
- DataSourceToIndexFieldMapping
- DataSourceVpcConfiguration
- DatabaseConfiguration
- Document
- DocumentAttribute
- DocumentAttributeCondition
- DocumentAttributeTarget
- DocumentAttributeValue
- DocumentAttributeValueCountPair
- DocumentInfo
- DocumentMetadataConfiguration
- DocumentRelevanceConfiguration
- DocumentsMetadataConfiguration
- EntityConfiguration
- EntityDisplayData
- EntityPersonaConfiguration
- ExperienceConfiguration
- ExperienceEndpoint
- ExperienceEntitiesSummary
- ExperiencesSummary
- Facet
- FacetResult
- FailedEntity
- FaqStatistics
- FaqSummary
- FsxConfiguration
- GitHubConfiguration
- GitHubDocumentCrawlProperties
- GoogleDriveConfiguration
- GroupMembers
- GroupOrderingIdSummary
- GroupSummary
- HierarchicalPrincipal
- Highlight
- HookConfiguration
- IndexConfigurationSummary
- IndexStatistics
- InlineCustomDocumentEnrichmentConfiguration
- JiraConfiguration
- JsonTokenTypeConfiguration
- JwtTokenTypeConfiguration
- MemberGroup
- MemberUser
- OnPremiseConfiguration
- OneDriveConfiguration
- OneDriveUsers
- PersonasSummary
- Principal
- ProxyConfiguration
- QueryResultItem
- QuerySuggestionsBlockListSummary
- QuipConfiguration
- Relevance
- RelevanceFeedback
- S3DataSourceConfiguration
- S3Path
- SaaSConfiguration
- SalesforceChatterFeedConfiguration
- SalesforceConfiguration
- SalesforceCustomKnowledgeArticleTypeConfiguration
- SalesforceKnowledgeArticleConfiguration
- SalesforceStandardKnowledgeArticleTypeConfiguration
- SalesforceStandardObjectAttachmentConfiguration
- SalesforceStandardObjectConfiguration
- ScoreAttributes
- Search
- SeedUrlConfiguration
- ServerSideEncryptionConfiguration
- ServiceNowConfiguration
- ServiceNowKnowledgeArticleConfiguration
- ServiceNowServiceCatalogConfiguration
- SharePointConfiguration
- SiteMapsConfiguration
- SlackConfiguration
- SortingConfiguration
- SpellCorrectedQuery
- SpellCorrectionConfiguration
- SqlConfiguration
- Status
- Suggestion
- SuggestionHighlight
- SuggestionTextWithHighlights
- SuggestionValue
- TableCell
- TableExcerpt
- TableRow
- Tag
- Template
- TemplateConfiguration
- TextDocumentStatistics
- TextWithHighlights
- ThesaurusSummary
- TimeRange
- Urls
- UserContext
- UserGroupResolutionConfiguration
- UserIdentityConfiguration
- UserTokenConfiguration
- Warning
- WebCrawlerConfiguration
- WorkDocsConfiguration
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
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ResourceUnavailableException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AssociateEntitiesToExperience = AssociateEntitiesToExperience' Text Text (NonEmpty EntityConfiguration)
- newAssociateEntitiesToExperience :: Text -> Text -> NonEmpty EntityConfiguration -> AssociateEntitiesToExperience
- data AssociateEntitiesToExperienceResponse = AssociateEntitiesToExperienceResponse' (Maybe (NonEmpty FailedEntity)) Int
- newAssociateEntitiesToExperienceResponse :: Int -> AssociateEntitiesToExperienceResponse
- data AssociatePersonasToEntities = AssociatePersonasToEntities' Text Text (NonEmpty EntityPersonaConfiguration)
- newAssociatePersonasToEntities :: Text -> Text -> NonEmpty EntityPersonaConfiguration -> AssociatePersonasToEntities
- data AssociatePersonasToEntitiesResponse = AssociatePersonasToEntitiesResponse' (Maybe (NonEmpty FailedEntity)) Int
- newAssociatePersonasToEntitiesResponse :: Int -> AssociatePersonasToEntitiesResponse
- data BatchDeleteDocument = BatchDeleteDocument' (Maybe DataSourceSyncJobMetricTarget) Text (NonEmpty Text)
- newBatchDeleteDocument :: Text -> NonEmpty Text -> BatchDeleteDocument
- data BatchDeleteDocumentResponse = BatchDeleteDocumentResponse' (Maybe [BatchDeleteDocumentResponseFailedDocument]) Int
- newBatchDeleteDocumentResponse :: Int -> BatchDeleteDocumentResponse
- data BatchGetDocumentStatus = BatchGetDocumentStatus' Text (NonEmpty DocumentInfo)
- newBatchGetDocumentStatus :: Text -> NonEmpty DocumentInfo -> BatchGetDocumentStatus
- data BatchGetDocumentStatusResponse = BatchGetDocumentStatusResponse' (Maybe [Status]) (Maybe [BatchGetDocumentStatusResponseError]) Int
- newBatchGetDocumentStatusResponse :: Int -> BatchGetDocumentStatusResponse
- data BatchPutDocument = BatchPutDocument' (Maybe CustomDocumentEnrichmentConfiguration) (Maybe Text) Text (NonEmpty Document)
- newBatchPutDocument :: Text -> NonEmpty Document -> BatchPutDocument
- data BatchPutDocumentResponse = BatchPutDocumentResponse' (Maybe [BatchPutDocumentResponseFailedDocument]) Int
- newBatchPutDocumentResponse :: Int -> BatchPutDocumentResponse
- data ClearQuerySuggestions = ClearQuerySuggestions' Text
- newClearQuerySuggestions :: Text -> ClearQuerySuggestions
- data ClearQuerySuggestionsResponse = ClearQuerySuggestionsResponse' {
- newClearQuerySuggestionsResponse :: ClearQuerySuggestionsResponse
- data CreateAccessControlConfiguration = CreateAccessControlConfiguration' (Maybe [Principal]) (Maybe Text) (Maybe Text) (Maybe (NonEmpty HierarchicalPrincipal)) Text Text
- newCreateAccessControlConfiguration :: Text -> Text -> CreateAccessControlConfiguration
- data CreateAccessControlConfigurationResponse = CreateAccessControlConfigurationResponse' Int Text
- newCreateAccessControlConfigurationResponse :: Int -> Text -> CreateAccessControlConfigurationResponse
- data CreateDataSource = CreateDataSource' (Maybe Text) (Maybe DataSourceConfiguration) (Maybe CustomDocumentEnrichmentConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe DataSourceVpcConfiguration) Text Text DataSourceType
- newCreateDataSource :: Text -> Text -> DataSourceType -> CreateDataSource
- data CreateDataSourceResponse = CreateDataSourceResponse' Int Text
- newCreateDataSourceResponse :: Int -> Text -> CreateDataSourceResponse
- data CreateExperience = CreateExperience' (Maybe Text) (Maybe ExperienceConfiguration) (Maybe Text) (Maybe Text) Text Text
- newCreateExperience :: Text -> Text -> CreateExperience
- data CreateExperienceResponse = CreateExperienceResponse' Int Text
- newCreateExperienceResponse :: Int -> Text -> CreateExperienceResponse
- data CreateFaq = CreateFaq' (Maybe Text) (Maybe Text) (Maybe FaqFileFormat) (Maybe Text) (Maybe [Tag]) Text Text S3Path Text
- newCreateFaq :: Text -> Text -> S3Path -> Text -> CreateFaq
- data CreateFaqResponse = CreateFaqResponse' (Maybe Text) Int
- newCreateFaqResponse :: Int -> CreateFaqResponse
- data CreateIndex = CreateIndex' (Maybe Text) (Maybe Text) (Maybe IndexEdition) (Maybe ServerSideEncryptionConfiguration) (Maybe [Tag]) (Maybe UserContextPolicy) (Maybe UserGroupResolutionConfiguration) (Maybe [UserTokenConfiguration]) Text Text
- newCreateIndex :: Text -> Text -> CreateIndex
- data CreateIndexResponse = CreateIndexResponse' (Maybe Text) Int
- newCreateIndexResponse :: Int -> CreateIndexResponse
- data CreateQuerySuggestionsBlockList = CreateQuerySuggestionsBlockList' (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text S3Path Text
- newCreateQuerySuggestionsBlockList :: Text -> Text -> S3Path -> Text -> CreateQuerySuggestionsBlockList
- data CreateQuerySuggestionsBlockListResponse = CreateQuerySuggestionsBlockListResponse' (Maybe Text) Int
- newCreateQuerySuggestionsBlockListResponse :: Int -> CreateQuerySuggestionsBlockListResponse
- data CreateThesaurus = CreateThesaurus' (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text Text S3Path
- newCreateThesaurus :: Text -> Text -> Text -> S3Path -> CreateThesaurus
- data CreateThesaurusResponse = CreateThesaurusResponse' (Maybe Text) Int
- newCreateThesaurusResponse :: Int -> CreateThesaurusResponse
- data DeleteAccessControlConfiguration = DeleteAccessControlConfiguration' Text Text
- newDeleteAccessControlConfiguration :: Text -> Text -> DeleteAccessControlConfiguration
- data DeleteAccessControlConfigurationResponse = DeleteAccessControlConfigurationResponse' Int
- newDeleteAccessControlConfigurationResponse :: Int -> DeleteAccessControlConfigurationResponse
- data DeleteDataSource = DeleteDataSource' Text Text
- newDeleteDataSource :: Text -> Text -> DeleteDataSource
- data DeleteDataSourceResponse = DeleteDataSourceResponse' {
- newDeleteDataSourceResponse :: DeleteDataSourceResponse
- data DeleteExperience = DeleteExperience' Text Text
- newDeleteExperience :: Text -> Text -> DeleteExperience
- data DeleteExperienceResponse = DeleteExperienceResponse' Int
- newDeleteExperienceResponse :: Int -> DeleteExperienceResponse
- data DeleteFaq = DeleteFaq' Text Text
- newDeleteFaq :: Text -> Text -> DeleteFaq
- data DeleteFaqResponse = DeleteFaqResponse' {
- newDeleteFaqResponse :: DeleteFaqResponse
- data DeleteIndex = DeleteIndex' Text
- newDeleteIndex :: Text -> DeleteIndex
- data DeleteIndexResponse = DeleteIndexResponse' {
- newDeleteIndexResponse :: DeleteIndexResponse
- data DeletePrincipalMapping = DeletePrincipalMapping' (Maybe Text) (Maybe Natural) Text Text
- newDeletePrincipalMapping :: Text -> Text -> DeletePrincipalMapping
- data DeletePrincipalMappingResponse = DeletePrincipalMappingResponse' {
- newDeletePrincipalMappingResponse :: DeletePrincipalMappingResponse
- data DeleteQuerySuggestionsBlockList = DeleteQuerySuggestionsBlockList' Text Text
- newDeleteQuerySuggestionsBlockList :: Text -> Text -> DeleteQuerySuggestionsBlockList
- data DeleteQuerySuggestionsBlockListResponse = DeleteQuerySuggestionsBlockListResponse' {
- newDeleteQuerySuggestionsBlockListResponse :: DeleteQuerySuggestionsBlockListResponse
- data DeleteThesaurus = DeleteThesaurus' Text Text
- newDeleteThesaurus :: Text -> Text -> DeleteThesaurus
- data DeleteThesaurusResponse = DeleteThesaurusResponse' {
- newDeleteThesaurusResponse :: DeleteThesaurusResponse
- data DescribeAccessControlConfiguration = DescribeAccessControlConfiguration' Text Text
- newDescribeAccessControlConfiguration :: Text -> Text -> DescribeAccessControlConfiguration
- data DescribeAccessControlConfigurationResponse = DescribeAccessControlConfigurationResponse' (Maybe [Principal]) (Maybe Text) (Maybe Text) (Maybe (NonEmpty HierarchicalPrincipal)) Int Text
- newDescribeAccessControlConfigurationResponse :: Int -> Text -> DescribeAccessControlConfigurationResponse
- data DescribeDataSource = DescribeDataSource' Text Text
- newDescribeDataSource :: Text -> Text -> DescribeDataSource
- data DescribeDataSourceResponse = DescribeDataSourceResponse' (Maybe DataSourceConfiguration) (Maybe POSIX) (Maybe CustomDocumentEnrichmentConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataSourceStatus) (Maybe DataSourceType) (Maybe POSIX) (Maybe DataSourceVpcConfiguration) Int
- newDescribeDataSourceResponse :: Int -> DescribeDataSourceResponse
- data DescribeExperience = DescribeExperience' Text Text
- newDescribeExperience :: Text -> Text -> DescribeExperience
- data DescribeExperienceResponse = DescribeExperienceResponse' (Maybe ExperienceConfiguration) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty ExperienceEndpoint)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ExperienceStatus) (Maybe POSIX) Int
- newDescribeExperienceResponse :: Int -> DescribeExperienceResponse
- data DescribeFaq = DescribeFaq' Text Text
- newDescribeFaq :: Text -> Text -> DescribeFaq
- data DescribeFaqResponse = DescribeFaqResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe FaqFileFormat) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3Path) (Maybe FaqStatus) (Maybe POSIX) Int
- newDescribeFaqResponse :: Int -> DescribeFaqResponse
- data DescribeIndex = DescribeIndex' Text
- newDescribeIndex :: Text -> DescribeIndex
- data DescribeIndexResponse = DescribeIndexResponse' (Maybe CapacityUnitsConfiguration) (Maybe POSIX) (Maybe Text) (Maybe [DocumentMetadataConfiguration]) (Maybe IndexEdition) (Maybe Text) (Maybe Text) (Maybe IndexStatistics) (Maybe Text) (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe IndexStatus) (Maybe POSIX) (Maybe UserContextPolicy) (Maybe UserGroupResolutionConfiguration) (Maybe [UserTokenConfiguration]) Int
- newDescribeIndexResponse :: Int -> DescribeIndexResponse
- data DescribePrincipalMapping = DescribePrincipalMapping' (Maybe Text) Text Text
- newDescribePrincipalMapping :: Text -> Text -> DescribePrincipalMapping
- data DescribePrincipalMappingResponse = DescribePrincipalMappingResponse' (Maybe Text) (Maybe Text) (Maybe [GroupOrderingIdSummary]) (Maybe Text) Int
- newDescribePrincipalMappingResponse :: Int -> DescribePrincipalMappingResponse
- data DescribeQuerySuggestionsBlockList = DescribeQuerySuggestionsBlockList' Text Text
- newDescribeQuerySuggestionsBlockList :: Text -> Text -> DescribeQuerySuggestionsBlockList
- data DescribeQuerySuggestionsBlockListResponse = DescribeQuerySuggestionsBlockListResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe S3Path) (Maybe QuerySuggestionsBlockListStatus) (Maybe POSIX) Int
- newDescribeQuerySuggestionsBlockListResponse :: Int -> DescribeQuerySuggestionsBlockListResponse
- data DescribeQuerySuggestionsConfig = DescribeQuerySuggestionsConfig' Text
- newDescribeQuerySuggestionsConfig :: Text -> DescribeQuerySuggestionsConfig
- data DescribeQuerySuggestionsConfigResponse = DescribeQuerySuggestionsConfigResponse' (Maybe Bool) (Maybe POSIX) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe Mode) (Maybe Int) (Maybe QuerySuggestionsStatus) (Maybe Int) Int
- newDescribeQuerySuggestionsConfigResponse :: Int -> DescribeQuerySuggestionsConfigResponse
- data DescribeThesaurus = DescribeThesaurus' Text Text
- newDescribeThesaurus :: Text -> Text -> DescribeThesaurus
- data DescribeThesaurusResponse = DescribeThesaurusResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3Path) (Maybe ThesaurusStatus) (Maybe Integer) (Maybe Integer) (Maybe POSIX) Int
- newDescribeThesaurusResponse :: Int -> DescribeThesaurusResponse
- data DisassociateEntitiesFromExperience = DisassociateEntitiesFromExperience' Text Text (NonEmpty EntityConfiguration)
- newDisassociateEntitiesFromExperience :: Text -> Text -> NonEmpty EntityConfiguration -> DisassociateEntitiesFromExperience
- data DisassociateEntitiesFromExperienceResponse = DisassociateEntitiesFromExperienceResponse' (Maybe (NonEmpty FailedEntity)) Int
- newDisassociateEntitiesFromExperienceResponse :: Int -> DisassociateEntitiesFromExperienceResponse
- data DisassociatePersonasFromEntities = DisassociatePersonasFromEntities' Text Text (NonEmpty Text)
- newDisassociatePersonasFromEntities :: Text -> Text -> NonEmpty Text -> DisassociatePersonasFromEntities
- data DisassociatePersonasFromEntitiesResponse = DisassociatePersonasFromEntitiesResponse' (Maybe (NonEmpty FailedEntity)) Int
- newDisassociatePersonasFromEntitiesResponse :: Int -> DisassociatePersonasFromEntitiesResponse
- data GetQuerySuggestions = GetQuerySuggestions' (Maybe Int) Text Text
- newGetQuerySuggestions :: Text -> Text -> GetQuerySuggestions
- data GetQuerySuggestionsResponse = GetQuerySuggestionsResponse' (Maybe Text) (Maybe [Suggestion]) Int
- newGetQuerySuggestionsResponse :: Int -> GetQuerySuggestionsResponse
- data GetSnapshots = GetSnapshots' (Maybe Int) (Maybe Text) Text Interval MetricType
- newGetSnapshots :: Text -> Interval -> MetricType -> GetSnapshots
- data GetSnapshotsResponse = GetSnapshotsResponse' (Maybe Text) (Maybe TimeRange) (Maybe [[Text]]) (Maybe [Text]) Int
- newGetSnapshotsResponse :: Int -> GetSnapshotsResponse
- data ListAccessControlConfigurations = ListAccessControlConfigurations' (Maybe Natural) (Maybe Text) Text
- newListAccessControlConfigurations :: Text -> ListAccessControlConfigurations
- data ListAccessControlConfigurationsResponse = ListAccessControlConfigurationsResponse' (Maybe Text) Int [AccessControlConfigurationSummary]
- newListAccessControlConfigurationsResponse :: Int -> ListAccessControlConfigurationsResponse
- data ListDataSourceSyncJobs = ListDataSourceSyncJobs' (Maybe Natural) (Maybe Text) (Maybe TimeRange) (Maybe DataSourceSyncJobStatus) Text Text
- newListDataSourceSyncJobs :: Text -> Text -> ListDataSourceSyncJobs
- data ListDataSourceSyncJobsResponse = ListDataSourceSyncJobsResponse' (Maybe [DataSourceSyncJob]) (Maybe Text) Int
- newListDataSourceSyncJobsResponse :: Int -> ListDataSourceSyncJobsResponse
- data ListDataSources = ListDataSources' (Maybe Natural) (Maybe Text) Text
- newListDataSources :: Text -> ListDataSources
- data ListDataSourcesResponse = ListDataSourcesResponse' (Maybe Text) (Maybe [DataSourceSummary]) Int
- newListDataSourcesResponse :: Int -> ListDataSourcesResponse
- data ListEntityPersonas = ListEntityPersonas' (Maybe Natural) (Maybe Text) Text Text
- newListEntityPersonas :: Text -> Text -> ListEntityPersonas
- data ListEntityPersonasResponse = ListEntityPersonasResponse' (Maybe Text) (Maybe [PersonasSummary]) Int
- newListEntityPersonasResponse :: Int -> ListEntityPersonasResponse
- data ListExperienceEntities = ListExperienceEntities' (Maybe Text) Text Text
- newListExperienceEntities :: Text -> Text -> ListExperienceEntities
- data ListExperienceEntitiesResponse = ListExperienceEntitiesResponse' (Maybe Text) (Maybe [ExperienceEntitiesSummary]) Int
- newListExperienceEntitiesResponse :: Int -> ListExperienceEntitiesResponse
- data ListExperiences = ListExperiences' (Maybe Natural) (Maybe Text) Text
- newListExperiences :: Text -> ListExperiences
- data ListExperiencesResponse = ListExperiencesResponse' (Maybe Text) (Maybe [ExperiencesSummary]) Int
- newListExperiencesResponse :: Int -> ListExperiencesResponse
- data ListFaqs = ListFaqs' (Maybe Natural) (Maybe Text) Text
- newListFaqs :: Text -> ListFaqs
- data ListFaqsResponse = ListFaqsResponse' (Maybe [FaqSummary]) (Maybe Text) Int
- newListFaqsResponse :: Int -> ListFaqsResponse
- data ListGroupsOlderThanOrderingId = ListGroupsOlderThanOrderingId' (Maybe Text) (Maybe Natural) (Maybe Text) Text Natural
- newListGroupsOlderThanOrderingId :: Text -> Natural -> ListGroupsOlderThanOrderingId
- data ListGroupsOlderThanOrderingIdResponse = ListGroupsOlderThanOrderingIdResponse' (Maybe [GroupSummary]) (Maybe Text) Int
- newListGroupsOlderThanOrderingIdResponse :: Int -> ListGroupsOlderThanOrderingIdResponse
- data ListIndices = ListIndices' (Maybe Natural) (Maybe Text)
- newListIndices :: ListIndices
- data ListIndicesResponse = ListIndicesResponse' (Maybe [IndexConfigurationSummary]) (Maybe Text) Int
- newListIndicesResponse :: Int -> ListIndicesResponse
- data ListQuerySuggestionsBlockLists = ListQuerySuggestionsBlockLists' (Maybe Natural) (Maybe Text) Text
- newListQuerySuggestionsBlockLists :: Text -> ListQuerySuggestionsBlockLists
- data ListQuerySuggestionsBlockListsResponse = ListQuerySuggestionsBlockListsResponse' (Maybe [QuerySuggestionsBlockListSummary]) (Maybe Text) Int
- newListQuerySuggestionsBlockListsResponse :: Int -> ListQuerySuggestionsBlockListsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListThesauri = ListThesauri' (Maybe Natural) (Maybe Text) Text
- newListThesauri :: Text -> ListThesauri
- data ListThesauriResponse = ListThesauriResponse' (Maybe Text) (Maybe [ThesaurusSummary]) Int
- newListThesauriResponse :: Int -> ListThesauriResponse
- data PutPrincipalMapping = PutPrincipalMapping' (Maybe Text) (Maybe Natural) (Maybe Text) Text Text GroupMembers
- newPutPrincipalMapping :: Text -> Text -> GroupMembers -> PutPrincipalMapping
- data PutPrincipalMappingResponse = PutPrincipalMappingResponse' {
- newPutPrincipalMappingResponse :: PutPrincipalMappingResponse
- data Query = Query' (Maybe AttributeFilter) (Maybe [DocumentRelevanceConfiguration]) (Maybe [Facet]) (Maybe Int) (Maybe Int) (Maybe QueryResultType) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe SortingConfiguration) (Maybe SpellCorrectionConfiguration) (Maybe UserContext) (Maybe Text) Text
- newQuery :: Text -> Query
- data QueryResponse = QueryResponse' (Maybe [FacetResult]) (Maybe Text) (Maybe [QueryResultItem]) (Maybe [SpellCorrectedQuery]) (Maybe Int) (Maybe (NonEmpty Warning)) Int
- newQueryResponse :: Int -> QueryResponse
- data StartDataSourceSyncJob = StartDataSourceSyncJob' Text Text
- newStartDataSourceSyncJob :: Text -> Text -> StartDataSourceSyncJob
- data StartDataSourceSyncJobResponse = StartDataSourceSyncJobResponse' (Maybe Text) Int
- newStartDataSourceSyncJobResponse :: Int -> StartDataSourceSyncJobResponse
- data StopDataSourceSyncJob = StopDataSourceSyncJob' Text Text
- newStopDataSourceSyncJob :: Text -> Text -> StopDataSourceSyncJob
- data StopDataSourceSyncJobResponse = StopDataSourceSyncJobResponse' {
- newStopDataSourceSyncJobResponse :: StopDataSourceSyncJobResponse
- data SubmitFeedback = SubmitFeedback' (Maybe [ClickFeedback]) (Maybe [RelevanceFeedback]) Text Text
- newSubmitFeedback :: Text -> Text -> SubmitFeedback
- data SubmitFeedbackResponse = SubmitFeedbackResponse' {
- newSubmitFeedbackResponse :: SubmitFeedbackResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAccessControlConfiguration = UpdateAccessControlConfiguration' (Maybe [Principal]) (Maybe Text) (Maybe (NonEmpty HierarchicalPrincipal)) (Maybe Text) Text Text
- newUpdateAccessControlConfiguration :: Text -> Text -> UpdateAccessControlConfiguration
- data UpdateAccessControlConfigurationResponse = UpdateAccessControlConfigurationResponse' Int
- newUpdateAccessControlConfigurationResponse :: Int -> UpdateAccessControlConfigurationResponse
- data UpdateDataSource = UpdateDataSource' (Maybe DataSourceConfiguration) (Maybe CustomDocumentEnrichmentConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataSourceVpcConfiguration) Text Text
- newUpdateDataSource :: Text -> Text -> UpdateDataSource
- data UpdateDataSourceResponse = UpdateDataSourceResponse' {
- newUpdateDataSourceResponse :: UpdateDataSourceResponse
- data UpdateExperience = UpdateExperience' (Maybe ExperienceConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newUpdateExperience :: Text -> Text -> UpdateExperience
- data UpdateExperienceResponse = UpdateExperienceResponse' {
- newUpdateExperienceResponse :: UpdateExperienceResponse
- data UpdateIndex = UpdateIndex' (Maybe CapacityUnitsConfiguration) (Maybe Text) (Maybe [DocumentMetadataConfiguration]) (Maybe Text) (Maybe Text) (Maybe UserContextPolicy) (Maybe UserGroupResolutionConfiguration) (Maybe [UserTokenConfiguration]) Text
- newUpdateIndex :: Text -> UpdateIndex
- data UpdateIndexResponse = UpdateIndexResponse' {
- newUpdateIndexResponse :: UpdateIndexResponse
- data UpdateQuerySuggestionsBlockList = UpdateQuerySuggestionsBlockList' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3Path) Text Text
- newUpdateQuerySuggestionsBlockList :: Text -> Text -> UpdateQuerySuggestionsBlockList
- data UpdateQuerySuggestionsBlockListResponse = UpdateQuerySuggestionsBlockListResponse' {
- newUpdateQuerySuggestionsBlockListResponse :: UpdateQuerySuggestionsBlockListResponse
- data UpdateQuerySuggestionsConfig = UpdateQuerySuggestionsConfig' (Maybe Bool) (Maybe Natural) (Maybe Natural) (Maybe Mode) (Maybe Int) Text
- newUpdateQuerySuggestionsConfig :: Text -> UpdateQuerySuggestionsConfig
- data UpdateQuerySuggestionsConfigResponse = UpdateQuerySuggestionsConfigResponse' {
- newUpdateQuerySuggestionsConfigResponse :: UpdateQuerySuggestionsConfigResponse
- data UpdateThesaurus = UpdateThesaurus' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3Path) Text Text
- newUpdateThesaurus :: Text -> Text -> UpdateThesaurus
- data UpdateThesaurusResponse = UpdateThesaurusResponse' {
- newUpdateThesaurusResponse :: UpdateThesaurusResponse
- newtype AdditionalResultAttributeValueType where
- newtype AlfrescoEntity where
- AlfrescoEntity' { }
- pattern AlfrescoEntity_Blog :: AlfrescoEntity
- pattern AlfrescoEntity_DocumentLibrary :: AlfrescoEntity
- pattern AlfrescoEntity_Wiki :: AlfrescoEntity
- newtype ConditionOperator where
- ConditionOperator' { }
- pattern ConditionOperator_BeginsWith :: ConditionOperator
- pattern ConditionOperator_Contains :: ConditionOperator
- pattern ConditionOperator_Equals :: ConditionOperator
- pattern ConditionOperator_Exists :: ConditionOperator
- pattern ConditionOperator_GreaterThan :: ConditionOperator
- pattern ConditionOperator_GreaterThanOrEquals :: ConditionOperator
- pattern ConditionOperator_LessThan :: ConditionOperator
- pattern ConditionOperator_LessThanOrEquals :: ConditionOperator
- pattern ConditionOperator_NotContains :: ConditionOperator
- pattern ConditionOperator_NotEquals :: ConditionOperator
- pattern ConditionOperator_NotExists :: ConditionOperator
- newtype ConfluenceAttachmentFieldName where
- ConfluenceAttachmentFieldName' { }
- pattern ConfluenceAttachmentFieldName_AUTHOR :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_CONTENT_TYPE :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_CREATED_DATE :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_DISPLAY_URL :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_FILE_SIZE :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_ITEM_TYPE :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_PARENT_ID :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_SPACE_KEY :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_SPACE_NAME :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_URL :: ConfluenceAttachmentFieldName
- pattern ConfluenceAttachmentFieldName_VERSION :: ConfluenceAttachmentFieldName
- newtype ConfluenceAuthenticationType where
- newtype ConfluenceBlogFieldName where
- ConfluenceBlogFieldName' { }
- pattern ConfluenceBlogFieldName_AUTHOR :: ConfluenceBlogFieldName
- pattern ConfluenceBlogFieldName_DISPLAY_URL :: ConfluenceBlogFieldName
- pattern ConfluenceBlogFieldName_ITEM_TYPE :: ConfluenceBlogFieldName
- pattern ConfluenceBlogFieldName_LABELS :: ConfluenceBlogFieldName
- pattern ConfluenceBlogFieldName_PUBLISH_DATE :: ConfluenceBlogFieldName
- pattern ConfluenceBlogFieldName_SPACE_KEY :: ConfluenceBlogFieldName
- pattern ConfluenceBlogFieldName_SPACE_NAME :: ConfluenceBlogFieldName
- pattern ConfluenceBlogFieldName_URL :: ConfluenceBlogFieldName
- pattern ConfluenceBlogFieldName_VERSION :: ConfluenceBlogFieldName
- newtype ConfluencePageFieldName where
- ConfluencePageFieldName' { }
- pattern ConfluencePageFieldName_AUTHOR :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_CONTENT_STATUS :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_CREATED_DATE :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_DISPLAY_URL :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_ITEM_TYPE :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_LABELS :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_MODIFIED_DATE :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_PARENT_ID :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_SPACE_KEY :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_SPACE_NAME :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_URL :: ConfluencePageFieldName
- pattern ConfluencePageFieldName_VERSION :: ConfluencePageFieldName
- newtype ConfluenceSpaceFieldName where
- ConfluenceSpaceFieldName' { }
- pattern ConfluenceSpaceFieldName_DISPLAY_URL :: ConfluenceSpaceFieldName
- pattern ConfluenceSpaceFieldName_ITEM_TYPE :: ConfluenceSpaceFieldName
- pattern ConfluenceSpaceFieldName_SPACE_KEY :: ConfluenceSpaceFieldName
- pattern ConfluenceSpaceFieldName_URL :: ConfluenceSpaceFieldName
- newtype ConfluenceVersion where
- ConfluenceVersion' { }
- pattern ConfluenceVersion_CLOUD :: ConfluenceVersion
- pattern ConfluenceVersion_SERVER :: ConfluenceVersion
- newtype ContentType where
- ContentType' { }
- pattern ContentType_HTML :: ContentType
- pattern ContentType_MS_WORD :: ContentType
- pattern ContentType_PDF :: ContentType
- pattern ContentType_PLAIN_TEXT :: ContentType
- pattern ContentType_PPT :: ContentType
- newtype DataSourceStatus where
- DataSourceStatus' { }
- pattern DataSourceStatus_ACTIVE :: DataSourceStatus
- pattern DataSourceStatus_CREATING :: DataSourceStatus
- pattern DataSourceStatus_DELETING :: DataSourceStatus
- pattern DataSourceStatus_FAILED :: DataSourceStatus
- pattern DataSourceStatus_UPDATING :: DataSourceStatus
- newtype DataSourceSyncJobStatus where
- DataSourceSyncJobStatus' { }
- pattern DataSourceSyncJobStatus_ABORTED :: DataSourceSyncJobStatus
- pattern DataSourceSyncJobStatus_FAILED :: DataSourceSyncJobStatus
- pattern DataSourceSyncJobStatus_INCOMPLETE :: DataSourceSyncJobStatus
- pattern DataSourceSyncJobStatus_STOPPING :: DataSourceSyncJobStatus
- pattern DataSourceSyncJobStatus_SUCCEEDED :: DataSourceSyncJobStatus
- pattern DataSourceSyncJobStatus_SYNCING :: DataSourceSyncJobStatus
- pattern DataSourceSyncJobStatus_SYNCING_INDEXING :: DataSourceSyncJobStatus
- newtype DataSourceType where
- DataSourceType' { }
- pattern DataSourceType_ALFRESCO :: DataSourceType
- pattern DataSourceType_BOX :: DataSourceType
- pattern DataSourceType_CONFLUENCE :: DataSourceType
- pattern DataSourceType_CUSTOM :: DataSourceType
- pattern DataSourceType_DATABASE :: DataSourceType
- pattern DataSourceType_FSX :: DataSourceType
- pattern DataSourceType_GITHUB :: DataSourceType
- pattern DataSourceType_GOOGLEDRIVE :: DataSourceType
- pattern DataSourceType_JIRA :: DataSourceType
- pattern DataSourceType_ONEDRIVE :: DataSourceType
- pattern DataSourceType_QUIP :: DataSourceType
- pattern DataSourceType_S3 :: DataSourceType
- pattern DataSourceType_SALESFORCE :: DataSourceType
- pattern DataSourceType_SERVICENOW :: DataSourceType
- pattern DataSourceType_SHAREPOINT :: DataSourceType
- pattern DataSourceType_SLACK :: DataSourceType
- pattern DataSourceType_TEMPLATE :: DataSourceType
- pattern DataSourceType_WEBCRAWLER :: DataSourceType
- pattern DataSourceType_WORKDOCS :: DataSourceType
- newtype DatabaseEngineType where
- newtype DocumentAttributeValueType where
- DocumentAttributeValueType' { }
- pattern DocumentAttributeValueType_DATE_VALUE :: DocumentAttributeValueType
- pattern DocumentAttributeValueType_LONG_VALUE :: DocumentAttributeValueType
- pattern DocumentAttributeValueType_STRING_LIST_VALUE :: DocumentAttributeValueType
- pattern DocumentAttributeValueType_STRING_VALUE :: DocumentAttributeValueType
- newtype DocumentStatus where
- DocumentStatus' { }
- pattern DocumentStatus_FAILED :: DocumentStatus
- pattern DocumentStatus_INDEXED :: DocumentStatus
- pattern DocumentStatus_NOT_FOUND :: DocumentStatus
- pattern DocumentStatus_PROCESSING :: DocumentStatus
- pattern DocumentStatus_UPDATED :: DocumentStatus
- pattern DocumentStatus_UPDATE_FAILED :: DocumentStatus
- newtype EndpointType where
- EndpointType' { }
- pattern EndpointType_HOME :: EndpointType
- newtype EntityType where
- EntityType' { }
- pattern EntityType_GROUP :: EntityType
- pattern EntityType_USER :: EntityType
- newtype ErrorCode where
- ErrorCode' { }
- pattern ErrorCode_InternalError :: ErrorCode
- pattern ErrorCode_InvalidRequest :: ErrorCode
- newtype ExperienceStatus where
- ExperienceStatus' { }
- pattern ExperienceStatus_ACTIVE :: ExperienceStatus
- pattern ExperienceStatus_CREATING :: ExperienceStatus
- pattern ExperienceStatus_DELETING :: ExperienceStatus
- pattern ExperienceStatus_FAILED :: ExperienceStatus
- newtype FaqFileFormat where
- FaqFileFormat' { }
- pattern FaqFileFormat_CSV :: FaqFileFormat
- pattern FaqFileFormat_CSV_WITH_HEADER :: FaqFileFormat
- pattern FaqFileFormat_JSON :: FaqFileFormat
- newtype FaqStatus where
- FaqStatus' { }
- pattern FaqStatus_ACTIVE :: FaqStatus
- pattern FaqStatus_CREATING :: FaqStatus
- pattern FaqStatus_DELETING :: FaqStatus
- pattern FaqStatus_FAILED :: FaqStatus
- pattern FaqStatus_UPDATING :: FaqStatus
- newtype FsxFileSystemType where
- newtype HighlightType where
- HighlightType' { }
- pattern HighlightType_STANDARD :: HighlightType
- pattern HighlightType_THESAURUS_SYNONYM :: HighlightType
- newtype IndexEdition where
- IndexEdition' { }
- pattern IndexEdition_DEVELOPER_EDITION :: IndexEdition
- pattern IndexEdition_ENTERPRISE_EDITION :: IndexEdition
- newtype IndexStatus where
- IndexStatus' { }
- pattern IndexStatus_ACTIVE :: IndexStatus
- pattern IndexStatus_CREATING :: IndexStatus
- pattern IndexStatus_DELETING :: IndexStatus
- pattern IndexStatus_FAILED :: IndexStatus
- pattern IndexStatus_SYSTEM_UPDATING :: IndexStatus
- pattern IndexStatus_UPDATING :: IndexStatus
- newtype Interval where
- Interval' {
- fromInterval :: Text
- pattern Interval_ONE_MONTH_AGO :: Interval
- pattern Interval_ONE_WEEK_AGO :: Interval
- pattern Interval_THIS_MONTH :: Interval
- pattern Interval_THIS_WEEK :: Interval
- pattern Interval_TWO_MONTHS_AGO :: Interval
- pattern Interval_TWO_WEEKS_AGO :: Interval
- Interval' {
- newtype IssueSubEntity where
- IssueSubEntity' { }
- pattern IssueSubEntity_ATTACHMENTS :: IssueSubEntity
- pattern IssueSubEntity_COMMENTS :: IssueSubEntity
- pattern IssueSubEntity_WORKLOGS :: IssueSubEntity
- newtype KeyLocation where
- KeyLocation' { }
- pattern KeyLocation_SECRET_MANAGER :: KeyLocation
- pattern KeyLocation_URL :: KeyLocation
- newtype MetricType where
- MetricType' { }
- pattern MetricType_AGG_QUERY_DOC_METRICS :: MetricType
- pattern MetricType_DOCS_BY_CLICK_COUNT :: MetricType
- pattern MetricType_QUERIES_BY_COUNT :: MetricType
- pattern MetricType_QUERIES_BY_ZERO_CLICK_RATE :: MetricType
- pattern MetricType_QUERIES_BY_ZERO_RESULT_RATE :: MetricType
- pattern MetricType_TREND_QUERY_DOC_METRICS :: MetricType
- newtype Mode where
- Mode' { }
- pattern Mode_ENABLED :: Mode
- pattern Mode_LEARN_ONLY :: Mode
- newtype Order where
- Order' { }
- pattern Order_ASCENDING :: Order
- pattern Order_DESCENDING :: Order
- newtype Persona where
- Persona' {
- fromPersona :: Text
- pattern Persona_OWNER :: Persona
- pattern Persona_VIEWER :: Persona
- Persona' {
- newtype PrincipalMappingStatus where
- PrincipalMappingStatus' { }
- pattern PrincipalMappingStatus_DELETED :: PrincipalMappingStatus
- pattern PrincipalMappingStatus_DELETING :: PrincipalMappingStatus
- pattern PrincipalMappingStatus_FAILED :: PrincipalMappingStatus
- pattern PrincipalMappingStatus_PROCESSING :: PrincipalMappingStatus
- pattern PrincipalMappingStatus_SUCCEEDED :: PrincipalMappingStatus
- newtype PrincipalType where
- PrincipalType' { }
- pattern PrincipalType_GROUP :: PrincipalType
- pattern PrincipalType_USER :: PrincipalType
- newtype QueryIdentifiersEnclosingOption where
- newtype QueryResultFormat where
- QueryResultFormat' { }
- pattern QueryResultFormat_TABLE :: QueryResultFormat
- pattern QueryResultFormat_TEXT :: QueryResultFormat
- newtype QueryResultType where
- QueryResultType' { }
- pattern QueryResultType_ANSWER :: QueryResultType
- pattern QueryResultType_DOCUMENT :: QueryResultType
- pattern QueryResultType_QUESTION_ANSWER :: QueryResultType
- newtype QuerySuggestionsBlockListStatus where
- QuerySuggestionsBlockListStatus' { }
- pattern QuerySuggestionsBlockListStatus_ACTIVE :: QuerySuggestionsBlockListStatus
- pattern QuerySuggestionsBlockListStatus_ACTIVE_BUT_UPDATE_FAILED :: QuerySuggestionsBlockListStatus
- pattern QuerySuggestionsBlockListStatus_CREATING :: QuerySuggestionsBlockListStatus
- pattern QuerySuggestionsBlockListStatus_DELETING :: QuerySuggestionsBlockListStatus
- pattern QuerySuggestionsBlockListStatus_FAILED :: QuerySuggestionsBlockListStatus
- pattern QuerySuggestionsBlockListStatus_UPDATING :: QuerySuggestionsBlockListStatus
- newtype QuerySuggestionsStatus where
- newtype ReadAccessType where
- ReadAccessType' { }
- pattern ReadAccessType_ALLOW :: ReadAccessType
- pattern ReadAccessType_DENY :: ReadAccessType
- newtype RelevanceType where
- RelevanceType' { }
- pattern RelevanceType_NOT_RELEVANT :: RelevanceType
- pattern RelevanceType_RELEVANT :: RelevanceType
- newtype SalesforceChatterFeedIncludeFilterType where
- newtype SalesforceKnowledgeArticleState where
- newtype SalesforceStandardObjectName where
- SalesforceStandardObjectName' { }
- pattern SalesforceStandardObjectName_ACCOUNT :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_CAMPAIGN :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_CASE :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_CONTACT :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_CONTRACT :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_DOCUMENT :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_GROUP :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_IDEA :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_LEAD :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_OPPORTUNITY :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_PARTNER :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_PRICEBOOK :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_PRODUCT :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_PROFILE :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_SOLUTION :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_TASK :: SalesforceStandardObjectName
- pattern SalesforceStandardObjectName_USER :: SalesforceStandardObjectName
- newtype ScoreConfidence where
- ScoreConfidence' { }
- pattern ScoreConfidence_HIGH :: ScoreConfidence
- pattern ScoreConfidence_LOW :: ScoreConfidence
- pattern ScoreConfidence_MEDIUM :: ScoreConfidence
- pattern ScoreConfidence_NOT_AVAILABLE :: ScoreConfidence
- pattern ScoreConfidence_VERY_HIGH :: ScoreConfidence
- newtype ServiceNowAuthenticationType where
- newtype ServiceNowBuildVersionType where
- newtype SharePointOnlineAuthenticationType where
- newtype SharePointVersion where
- newtype SlackEntity where
- SlackEntity' { }
- pattern SlackEntity_DIRECT_MESSAGE :: SlackEntity
- pattern SlackEntity_GROUP_MESSAGE :: SlackEntity
- pattern SlackEntity_PRIVATE_CHANNEL :: SlackEntity
- pattern SlackEntity_PUBLIC_CHANNEL :: SlackEntity
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASC :: SortOrder
- pattern SortOrder_DESC :: SortOrder
- newtype ThesaurusStatus where
- ThesaurusStatus' { }
- pattern ThesaurusStatus_ACTIVE :: ThesaurusStatus
- pattern ThesaurusStatus_ACTIVE_BUT_UPDATE_FAILED :: ThesaurusStatus
- pattern ThesaurusStatus_CREATING :: ThesaurusStatus
- pattern ThesaurusStatus_DELETING :: ThesaurusStatus
- pattern ThesaurusStatus_FAILED :: ThesaurusStatus
- pattern ThesaurusStatus_UPDATING :: ThesaurusStatus
- newtype Type where
- newtype UserContextPolicy where
- newtype UserGroupResolutionMode where
- newtype WarningCode where
- WarningCode' { }
- pattern WarningCode_QUERY_LANGUAGE_INVALID_SYNTAX :: WarningCode
- newtype WebCrawlerMode where
- WebCrawlerMode' { }
- pattern WebCrawlerMode_EVERYTHING :: WebCrawlerMode
- pattern WebCrawlerMode_HOST_ONLY :: WebCrawlerMode
- pattern WebCrawlerMode_SUBDOMAINS :: WebCrawlerMode
- data AccessControlConfigurationSummary = AccessControlConfigurationSummary' Text
- newAccessControlConfigurationSummary :: Text -> AccessControlConfigurationSummary
- data AccessControlListConfiguration = AccessControlListConfiguration' (Maybe Text)
- newAccessControlListConfiguration :: AccessControlListConfiguration
- data AclConfiguration = AclConfiguration' Text
- newAclConfiguration :: Text -> AclConfiguration
- data AdditionalResultAttribute = AdditionalResultAttribute' Text AdditionalResultAttributeValueType AdditionalResultAttributeValue
- newAdditionalResultAttribute :: Text -> AdditionalResultAttributeValueType -> AdditionalResultAttributeValue -> AdditionalResultAttribute
- data AdditionalResultAttributeValue = AdditionalResultAttributeValue' (Maybe TextWithHighlights)
- newAdditionalResultAttributeValue :: AdditionalResultAttributeValue
- data AlfrescoConfiguration = AlfrescoConfiguration' (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe Bool) (Maybe Bool) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty AlfrescoEntity)) (Maybe [Text]) (Maybe [Text]) (Maybe DataSourceVpcConfiguration) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Text Text Text S3Path
- newAlfrescoConfiguration :: Text -> Text -> Text -> S3Path -> AlfrescoConfiguration
- data AttributeFilter = AttributeFilter' (Maybe [AttributeFilter]) (Maybe DocumentAttribute) (Maybe DocumentAttribute) (Maybe DocumentAttribute) (Maybe DocumentAttribute) (Maybe DocumentAttribute) (Maybe DocumentAttribute) (Maybe DocumentAttribute) (Maybe AttributeFilter) (Maybe [AttributeFilter])
- newAttributeFilter :: AttributeFilter
- data AuthenticationConfiguration = AuthenticationConfiguration' (Maybe [BasicAuthenticationConfiguration])
- newAuthenticationConfiguration :: AuthenticationConfiguration
- data BasicAuthenticationConfiguration = BasicAuthenticationConfiguration' Text Natural Text
- newBasicAuthenticationConfiguration :: Text -> Natural -> Text -> BasicAuthenticationConfiguration
- data BatchDeleteDocumentResponseFailedDocument = BatchDeleteDocumentResponseFailedDocument' (Maybe ErrorCode) (Maybe Text) (Maybe Text)
- newBatchDeleteDocumentResponseFailedDocument :: BatchDeleteDocumentResponseFailedDocument
- data BatchGetDocumentStatusResponseError = BatchGetDocumentStatusResponseError' (Maybe Text) (Maybe ErrorCode) (Maybe Text)
- newBatchGetDocumentStatusResponseError :: BatchGetDocumentStatusResponseError
- data BatchPutDocumentResponseFailedDocument = BatchPutDocumentResponseFailedDocument' (Maybe ErrorCode) (Maybe Text) (Maybe Text)
- newBatchPutDocumentResponseFailedDocument :: BatchPutDocumentResponseFailedDocument
- data BoxConfiguration = BoxConfiguration' (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe Bool) (Maybe DataSourceVpcConfiguration) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Text Text
- newBoxConfiguration :: Text -> Text -> BoxConfiguration
- data CapacityUnitsConfiguration = CapacityUnitsConfiguration' Natural Natural
- newCapacityUnitsConfiguration :: Natural -> Natural -> CapacityUnitsConfiguration
- data ClickFeedback = ClickFeedback' Text POSIX
- newClickFeedback :: Text -> UTCTime -> ClickFeedback
- data ColumnConfiguration = ColumnConfiguration' (Maybe Text) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Text Text (NonEmpty Text)
- newColumnConfiguration :: Text -> Text -> NonEmpty Text -> ColumnConfiguration
- data ConfluenceAttachmentConfiguration = ConfluenceAttachmentConfiguration' (Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping)) (Maybe Bool)
- newConfluenceAttachmentConfiguration :: ConfluenceAttachmentConfiguration
- data ConfluenceAttachmentToIndexFieldMapping = ConfluenceAttachmentToIndexFieldMapping' (Maybe ConfluenceAttachmentFieldName) (Maybe Text) (Maybe Text)
- newConfluenceAttachmentToIndexFieldMapping :: ConfluenceAttachmentToIndexFieldMapping
- data ConfluenceBlogConfiguration = ConfluenceBlogConfiguration' (Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping))
- newConfluenceBlogConfiguration :: ConfluenceBlogConfiguration
- data ConfluenceBlogToIndexFieldMapping = ConfluenceBlogToIndexFieldMapping' (Maybe ConfluenceBlogFieldName) (Maybe Text) (Maybe Text)
- newConfluenceBlogToIndexFieldMapping :: ConfluenceBlogToIndexFieldMapping
- data ConfluenceConfiguration = ConfluenceConfiguration' (Maybe ConfluenceAttachmentConfiguration) (Maybe ConfluenceAuthenticationType) (Maybe ConfluenceBlogConfiguration) (Maybe [Text]) (Maybe [Text]) (Maybe ConfluencePageConfiguration) (Maybe ProxyConfiguration) (Maybe ConfluenceSpaceConfiguration) (Maybe DataSourceVpcConfiguration) Text Text ConfluenceVersion
- newConfluenceConfiguration :: Text -> Text -> ConfluenceVersion -> ConfluenceConfiguration
- data ConfluencePageConfiguration = ConfluencePageConfiguration' (Maybe (NonEmpty ConfluencePageToIndexFieldMapping))
- newConfluencePageConfiguration :: ConfluencePageConfiguration
- data ConfluencePageToIndexFieldMapping = ConfluencePageToIndexFieldMapping' (Maybe ConfluencePageFieldName) (Maybe Text) (Maybe Text)
- newConfluencePageToIndexFieldMapping :: ConfluencePageToIndexFieldMapping
- data ConfluenceSpaceConfiguration = ConfluenceSpaceConfiguration' (Maybe Bool) (Maybe Bool) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping))
- newConfluenceSpaceConfiguration :: ConfluenceSpaceConfiguration
- data ConfluenceSpaceToIndexFieldMapping = ConfluenceSpaceToIndexFieldMapping' (Maybe ConfluenceSpaceFieldName) (Maybe Text) (Maybe Text)
- newConfluenceSpaceToIndexFieldMapping :: ConfluenceSpaceToIndexFieldMapping
- data ConnectionConfiguration = ConnectionConfiguration' Text Natural Text Text Text
- newConnectionConfiguration :: Text -> Natural -> Text -> Text -> Text -> ConnectionConfiguration
- data ContentSourceConfiguration = ContentSourceConfiguration' (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe (NonEmpty Text))
- newContentSourceConfiguration :: ContentSourceConfiguration
- data Correction = Correction' (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text)
- newCorrection :: Correction
- data CustomDocumentEnrichmentConfiguration = CustomDocumentEnrichmentConfiguration' (Maybe [InlineCustomDocumentEnrichmentConfiguration]) (Maybe HookConfiguration) (Maybe HookConfiguration) (Maybe Text)
- newCustomDocumentEnrichmentConfiguration :: CustomDocumentEnrichmentConfiguration
- data DataSourceConfiguration = DataSourceConfiguration' (Maybe AlfrescoConfiguration) (Maybe BoxConfiguration) (Maybe ConfluenceConfiguration) (Maybe DatabaseConfiguration) (Maybe FsxConfiguration) (Maybe GitHubConfiguration) (Maybe GoogleDriveConfiguration) (Maybe JiraConfiguration) (Maybe OneDriveConfiguration) (Maybe QuipConfiguration) (Maybe S3DataSourceConfiguration) (Maybe SalesforceConfiguration) (Maybe ServiceNowConfiguration) (Maybe SharePointConfiguration) (Maybe SlackConfiguration) (Maybe TemplateConfiguration) (Maybe WebCrawlerConfiguration) (Maybe WorkDocsConfiguration)
- newDataSourceConfiguration :: DataSourceConfiguration
- data DataSourceGroup = DataSourceGroup' Text Text
- newDataSourceGroup :: Text -> Text -> DataSourceGroup
- data DataSourceSummary = DataSourceSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataSourceStatus) (Maybe DataSourceType) (Maybe POSIX)
- newDataSourceSummary :: DataSourceSummary
- data DataSourceSyncJob = DataSourceSyncJob' (Maybe Text) (Maybe POSIX) (Maybe ErrorCode) (Maybe Text) (Maybe Text) (Maybe DataSourceSyncJobMetrics) (Maybe POSIX) (Maybe DataSourceSyncJobStatus)
- newDataSourceSyncJob :: DataSourceSyncJob
- data DataSourceSyncJobMetricTarget = DataSourceSyncJobMetricTarget' (Maybe Text) Text
- newDataSourceSyncJobMetricTarget :: Text -> DataSourceSyncJobMetricTarget
- data DataSourceSyncJobMetrics = DataSourceSyncJobMetrics' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDataSourceSyncJobMetrics :: DataSourceSyncJobMetrics
- data DataSourceToIndexFieldMapping = DataSourceToIndexFieldMapping' (Maybe Text) Text Text
- newDataSourceToIndexFieldMapping :: Text -> Text -> DataSourceToIndexFieldMapping
- data DataSourceVpcConfiguration = DataSourceVpcConfiguration' (NonEmpty Text) (NonEmpty Text)
- newDataSourceVpcConfiguration :: NonEmpty Text -> NonEmpty Text -> DataSourceVpcConfiguration
- data DatabaseConfiguration = DatabaseConfiguration' (Maybe AclConfiguration) (Maybe SqlConfiguration) (Maybe DataSourceVpcConfiguration) DatabaseEngineType ConnectionConfiguration ColumnConfiguration
- newDatabaseConfiguration :: DatabaseEngineType -> ConnectionConfiguration -> ColumnConfiguration -> DatabaseConfiguration
- data Document = Document' (Maybe Text) (Maybe [Principal]) (Maybe [DocumentAttribute]) (Maybe Base64) (Maybe ContentType) (Maybe (NonEmpty HierarchicalPrincipal)) (Maybe S3Path) (Maybe Text) Text
- newDocument :: Text -> Document
- data DocumentAttribute = DocumentAttribute' Text DocumentAttributeValue
- newDocumentAttribute :: Text -> DocumentAttributeValue -> DocumentAttribute
- data DocumentAttributeCondition = DocumentAttributeCondition' (Maybe DocumentAttributeValue) Text ConditionOperator
- newDocumentAttributeCondition :: Text -> ConditionOperator -> DocumentAttributeCondition
- data DocumentAttributeTarget = DocumentAttributeTarget' (Maybe Text) (Maybe DocumentAttributeValue) (Maybe Bool)
- newDocumentAttributeTarget :: DocumentAttributeTarget
- data DocumentAttributeValue = DocumentAttributeValue' (Maybe POSIX) (Maybe Integer) (Maybe [Text]) (Maybe Text)
- newDocumentAttributeValue :: DocumentAttributeValue
- data DocumentAttributeValueCountPair = DocumentAttributeValueCountPair' (Maybe Int) (Maybe DocumentAttributeValue) (Maybe [FacetResult])
- newDocumentAttributeValueCountPair :: DocumentAttributeValueCountPair
- data DocumentInfo = DocumentInfo' (Maybe [DocumentAttribute]) Text
- newDocumentInfo :: Text -> DocumentInfo
- data DocumentMetadataConfiguration = DocumentMetadataConfiguration' (Maybe Relevance) (Maybe Search) Text DocumentAttributeValueType
- newDocumentMetadataConfiguration :: Text -> DocumentAttributeValueType -> DocumentMetadataConfiguration
- data DocumentRelevanceConfiguration = DocumentRelevanceConfiguration' Text Relevance
- newDocumentRelevanceConfiguration :: Text -> Relevance -> DocumentRelevanceConfiguration
- data DocumentsMetadataConfiguration = DocumentsMetadataConfiguration' (Maybe Text)
- newDocumentsMetadataConfiguration :: DocumentsMetadataConfiguration
- data EntityConfiguration = EntityConfiguration' Text EntityType
- newEntityConfiguration :: Text -> EntityType -> EntityConfiguration
- data EntityDisplayData = EntityDisplayData' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newEntityDisplayData :: EntityDisplayData
- data EntityPersonaConfiguration = EntityPersonaConfiguration' Text Persona
- newEntityPersonaConfiguration :: Text -> Persona -> EntityPersonaConfiguration
- data ExperienceConfiguration = ExperienceConfiguration' (Maybe ContentSourceConfiguration) (Maybe UserIdentityConfiguration)
- newExperienceConfiguration :: ExperienceConfiguration
- data ExperienceEndpoint = ExperienceEndpoint' (Maybe Text) (Maybe EndpointType)
- newExperienceEndpoint :: ExperienceEndpoint
- data ExperienceEntitiesSummary = ExperienceEntitiesSummary' (Maybe EntityDisplayData) (Maybe Text) (Maybe EntityType)
- newExperienceEntitiesSummary :: ExperienceEntitiesSummary
- data ExperiencesSummary = ExperiencesSummary' (Maybe POSIX) (Maybe (NonEmpty ExperienceEndpoint)) (Maybe Text) (Maybe Text) (Maybe ExperienceStatus)
- newExperiencesSummary :: ExperiencesSummary
- data Facet = Facet' (Maybe Text) (Maybe [Facet]) (Maybe Natural)
- newFacet :: Facet
- data FacetResult = FacetResult' (Maybe Text) (Maybe [DocumentAttributeValueCountPair]) (Maybe DocumentAttributeValueType)
- newFacetResult :: FacetResult
- data FailedEntity = FailedEntity' (Maybe Text) (Maybe Text)
- newFailedEntity :: FailedEntity
- data FaqStatistics = FaqStatistics' Natural
- newFaqStatistics :: Natural -> FaqStatistics
- data FaqSummary = FaqSummary' (Maybe POSIX) (Maybe FaqFileFormat) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FaqStatus) (Maybe POSIX)
- newFaqSummary :: FaqSummary
- data FsxConfiguration = FsxConfiguration' (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) (Maybe Text) Text FsxFileSystemType DataSourceVpcConfiguration
- newFsxConfiguration :: Text -> FsxFileSystemType -> DataSourceVpcConfiguration -> FsxConfiguration
- data GitHubConfiguration = GitHubConfiguration' (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe GitHubDocumentCrawlProperties) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe OnPremiseConfiguration) (Maybe [Text]) (Maybe SaaSConfiguration) (Maybe Type) (Maybe Bool) (Maybe DataSourceVpcConfiguration) Text
- newGitHubConfiguration :: Text -> GitHubConfiguration
- data GitHubDocumentCrawlProperties = GitHubDocumentCrawlProperties' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newGitHubDocumentCrawlProperties :: GitHubDocumentCrawlProperties
- data GoogleDriveConfiguration = GoogleDriveConfiguration' (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) Text
- newGoogleDriveConfiguration :: Text -> GoogleDriveConfiguration
- data GroupMembers = GroupMembers' (Maybe (NonEmpty MemberGroup)) (Maybe (NonEmpty MemberUser)) (Maybe S3Path)
- newGroupMembers :: GroupMembers
- data GroupOrderingIdSummary = GroupOrderingIdSummary' (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe PrincipalMappingStatus)
- newGroupOrderingIdSummary :: GroupOrderingIdSummary
- data GroupSummary = GroupSummary' (Maybe Text) (Maybe Natural)
- newGroupSummary :: GroupSummary
- data HierarchicalPrincipal = HierarchicalPrincipal' [Principal]
- newHierarchicalPrincipal :: HierarchicalPrincipal
- data Highlight = Highlight' (Maybe Bool) (Maybe HighlightType) Int Int
- newHighlight :: Int -> Int -> Highlight
- data HookConfiguration = HookConfiguration' (Maybe DocumentAttributeCondition) Text Text
- newHookConfiguration :: Text -> Text -> HookConfiguration
- data IndexConfigurationSummary = IndexConfigurationSummary' (Maybe IndexEdition) (Maybe Text) (Maybe Text) POSIX POSIX IndexStatus
- newIndexConfigurationSummary :: UTCTime -> UTCTime -> IndexStatus -> IndexConfigurationSummary
- data IndexStatistics = IndexStatistics' FaqStatistics TextDocumentStatistics
- newIndexStatistics :: FaqStatistics -> TextDocumentStatistics -> IndexStatistics
- data InlineCustomDocumentEnrichmentConfiguration = InlineCustomDocumentEnrichmentConfiguration' (Maybe DocumentAttributeCondition) (Maybe Bool) (Maybe DocumentAttributeTarget)
- newInlineCustomDocumentEnrichmentConfiguration :: InlineCustomDocumentEnrichmentConfiguration
- data JiraConfiguration = JiraConfiguration' (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [IssueSubEntity]) (Maybe [Text]) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) (Maybe Bool) (Maybe DataSourceVpcConfiguration) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Text Text
- newJiraConfiguration :: Text -> Text -> JiraConfiguration
- data JsonTokenTypeConfiguration = JsonTokenTypeConfiguration' Text Text
- newJsonTokenTypeConfiguration :: Text -> Text -> JsonTokenTypeConfiguration
- data JwtTokenTypeConfiguration = JwtTokenTypeConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) KeyLocation
- newJwtTokenTypeConfiguration :: KeyLocation -> JwtTokenTypeConfiguration
- data MemberGroup = MemberGroup' (Maybe Text) Text
- newMemberGroup :: Text -> MemberGroup
- data MemberUser = MemberUser' Text
- newMemberUser :: Text -> MemberUser
- data OnPremiseConfiguration = OnPremiseConfiguration' Text Text S3Path
- newOnPremiseConfiguration :: Text -> Text -> S3Path -> OnPremiseConfiguration
- data OneDriveConfiguration = OneDriveConfiguration' (Maybe Bool) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) Text Text OneDriveUsers
- newOneDriveConfiguration :: Text -> Text -> OneDriveUsers -> OneDriveConfiguration
- data OneDriveUsers = OneDriveUsers' (Maybe (NonEmpty Text)) (Maybe S3Path)
- newOneDriveUsers :: OneDriveUsers
- data PersonasSummary = PersonasSummary' (Maybe POSIX) (Maybe Text) (Maybe Persona) (Maybe POSIX)
- newPersonasSummary :: PersonasSummary
- data Principal = Principal' (Maybe Text) Text PrincipalType ReadAccessType
- newPrincipal :: Text -> PrincipalType -> ReadAccessType -> Principal
- data ProxyConfiguration = ProxyConfiguration' (Maybe Text) Text Natural
- newProxyConfiguration :: Text -> Natural -> ProxyConfiguration
- data QueryResultItem = QueryResultItem' (Maybe [AdditionalResultAttribute]) (Maybe [DocumentAttribute]) (Maybe TextWithHighlights) (Maybe Text) (Maybe TextWithHighlights) (Maybe Text) (Maybe Text) (Maybe QueryResultFormat) (Maybe Text) (Maybe ScoreAttributes) (Maybe TableExcerpt) (Maybe QueryResultType)
- newQueryResultItem :: QueryResultItem
- data QuerySuggestionsBlockListSummary = QuerySuggestionsBlockListSummary' (Maybe POSIX) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe QuerySuggestionsBlockListStatus) (Maybe POSIX)
- newQuerySuggestionsBlockListSummary :: QuerySuggestionsBlockListSummary
- data QuipConfiguration = QuipConfiguration' (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe DataSourceVpcConfiguration) Text Text
- newQuipConfiguration :: Text -> Text -> QuipConfiguration
- data Relevance = Relevance' (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Order) (Maybe (HashMap Text Natural))
- newRelevance :: Relevance
- data RelevanceFeedback = RelevanceFeedback' Text RelevanceType
- newRelevanceFeedback :: Text -> RelevanceType -> RelevanceFeedback
- data S3DataSourceConfiguration = S3DataSourceConfiguration' (Maybe AccessControlListConfiguration) (Maybe DocumentsMetadataConfiguration) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) Text
- newS3DataSourceConfiguration :: Text -> S3DataSourceConfiguration
- data S3Path = S3Path' Text Text
- newS3Path :: Text -> Text -> S3Path
- data SaaSConfiguration = SaaSConfiguration' Text Text
- newSaaSConfiguration :: Text -> Text -> SaaSConfiguration
- data SalesforceChatterFeedConfiguration = SalesforceChatterFeedConfiguration' (Maybe Text) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe (NonEmpty SalesforceChatterFeedIncludeFilterType)) Text
- newSalesforceChatterFeedConfiguration :: Text -> SalesforceChatterFeedConfiguration
- data SalesforceConfiguration = SalesforceConfiguration' (Maybe SalesforceChatterFeedConfiguration) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe SalesforceKnowledgeArticleConfiguration) (Maybe SalesforceStandardObjectAttachmentConfiguration) (Maybe (NonEmpty SalesforceStandardObjectConfiguration)) Text Text
- newSalesforceConfiguration :: Text -> Text -> SalesforceConfiguration
- data SalesforceCustomKnowledgeArticleTypeConfiguration = SalesforceCustomKnowledgeArticleTypeConfiguration' (Maybe Text) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Text Text
- newSalesforceCustomKnowledgeArticleTypeConfiguration :: Text -> Text -> SalesforceCustomKnowledgeArticleTypeConfiguration
- data SalesforceKnowledgeArticleConfiguration = SalesforceKnowledgeArticleConfiguration' (Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)) (Maybe SalesforceStandardKnowledgeArticleTypeConfiguration) (NonEmpty SalesforceKnowledgeArticleState)
- newSalesforceKnowledgeArticleConfiguration :: NonEmpty SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleConfiguration
- data SalesforceStandardKnowledgeArticleTypeConfiguration = SalesforceStandardKnowledgeArticleTypeConfiguration' (Maybe Text) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Text
- newSalesforceStandardKnowledgeArticleTypeConfiguration :: Text -> SalesforceStandardKnowledgeArticleTypeConfiguration
- data SalesforceStandardObjectAttachmentConfiguration = SalesforceStandardObjectAttachmentConfiguration' (Maybe Text) (Maybe (NonEmpty DataSourceToIndexFieldMapping))
- newSalesforceStandardObjectAttachmentConfiguration :: SalesforceStandardObjectAttachmentConfiguration
- data SalesforceStandardObjectConfiguration = SalesforceStandardObjectConfiguration' (Maybe Text) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) SalesforceStandardObjectName Text
- newSalesforceStandardObjectConfiguration :: SalesforceStandardObjectName -> Text -> SalesforceStandardObjectConfiguration
- data ScoreAttributes = ScoreAttributes' (Maybe ScoreConfidence)
- newScoreAttributes :: ScoreAttributes
- data Search = Search' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newSearch :: Search
- data SeedUrlConfiguration = SeedUrlConfiguration' (Maybe WebCrawlerMode) [Text]
- newSeedUrlConfiguration :: SeedUrlConfiguration
- data ServerSideEncryptionConfiguration = ServerSideEncryptionConfiguration' (Maybe (Sensitive Text))
- newServerSideEncryptionConfiguration :: ServerSideEncryptionConfiguration
- data ServiceNowConfiguration = ServiceNowConfiguration' (Maybe ServiceNowAuthenticationType) (Maybe ServiceNowKnowledgeArticleConfiguration) (Maybe ServiceNowServiceCatalogConfiguration) Text Text ServiceNowBuildVersionType
- newServiceNowConfiguration :: Text -> Text -> ServiceNowBuildVersionType -> ServiceNowConfiguration
- data ServiceNowKnowledgeArticleConfiguration = ServiceNowKnowledgeArticleConfiguration' (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe Text) (Maybe [Text]) Text
- newServiceNowKnowledgeArticleConfiguration :: Text -> ServiceNowKnowledgeArticleConfiguration
- data ServiceNowServiceCatalogConfiguration = ServiceNowServiceCatalogConfiguration' (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) Text
- newServiceNowServiceCatalogConfiguration :: Text -> ServiceNowServiceCatalogConfiguration
- data SharePointConfiguration = SharePointConfiguration' (Maybe SharePointOnlineAuthenticationType) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) (Maybe ProxyConfiguration) (Maybe S3Path) (Maybe Bool) (Maybe DataSourceVpcConfiguration) SharePointVersion (NonEmpty Text) Text
- newSharePointConfiguration :: SharePointVersion -> NonEmpty Text -> Text -> SharePointConfiguration
- data SiteMapsConfiguration = SiteMapsConfiguration' [Text]
- newSiteMapsConfiguration :: SiteMapsConfiguration
- data SlackConfiguration = SlackConfiguration' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) (Maybe Natural) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe DataSourceVpcConfiguration) Text Text (NonEmpty SlackEntity) Text
- newSlackConfiguration :: Text -> Text -> NonEmpty SlackEntity -> Text -> SlackConfiguration
- data SortingConfiguration = SortingConfiguration' Text SortOrder
- newSortingConfiguration :: Text -> SortOrder -> SortingConfiguration
- data SpellCorrectedQuery = SpellCorrectedQuery' (Maybe [Correction]) (Maybe Text)
- newSpellCorrectedQuery :: SpellCorrectedQuery
- data SpellCorrectionConfiguration = SpellCorrectionConfiguration' Bool
- newSpellCorrectionConfiguration :: Bool -> SpellCorrectionConfiguration
- data SqlConfiguration = SqlConfiguration' (Maybe QueryIdentifiersEnclosingOption)
- newSqlConfiguration :: SqlConfiguration
- data Status = Status' (Maybe Text) (Maybe DocumentStatus) (Maybe Text) (Maybe Text)
- newStatus :: Status
- data Suggestion = Suggestion' (Maybe Text) (Maybe SuggestionValue)
- newSuggestion :: Suggestion
- data SuggestionHighlight = SuggestionHighlight' (Maybe Int) (Maybe Int)
- newSuggestionHighlight :: SuggestionHighlight
- data SuggestionTextWithHighlights = SuggestionTextWithHighlights' (Maybe [SuggestionHighlight]) (Maybe Text)
- newSuggestionTextWithHighlights :: SuggestionTextWithHighlights
- data SuggestionValue = SuggestionValue' (Maybe SuggestionTextWithHighlights)
- newSuggestionValue :: SuggestionValue
- data TableCell = TableCell' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newTableCell :: TableCell
- data TableExcerpt = TableExcerpt' (Maybe [TableRow]) (Maybe Int)
- newTableExcerpt :: TableExcerpt
- data TableRow = TableRow' (Maybe [TableCell])
- newTableRow :: TableRow
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Template = Template' {
- newTemplate :: Template
- data TemplateConfiguration = TemplateConfiguration' (Maybe Template)
- newTemplateConfiguration :: TemplateConfiguration
- data TextDocumentStatistics = TextDocumentStatistics' Natural Natural
- newTextDocumentStatistics :: Natural -> Natural -> TextDocumentStatistics
- data TextWithHighlights = TextWithHighlights' (Maybe [Highlight]) (Maybe Text)
- newTextWithHighlights :: TextWithHighlights
- data ThesaurusSummary = ThesaurusSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ThesaurusStatus) (Maybe POSIX)
- newThesaurusSummary :: ThesaurusSummary
- data TimeRange = TimeRange' (Maybe POSIX) (Maybe POSIX)
- newTimeRange :: TimeRange
- data Urls = Urls' (Maybe SeedUrlConfiguration) (Maybe SiteMapsConfiguration)
- newUrls :: Urls
- data UserContext = UserContext' (Maybe (NonEmpty DataSourceGroup)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text)
- newUserContext :: UserContext
- data UserGroupResolutionConfiguration = UserGroupResolutionConfiguration' UserGroupResolutionMode
- newUserGroupResolutionConfiguration :: UserGroupResolutionMode -> UserGroupResolutionConfiguration
- data UserIdentityConfiguration = UserIdentityConfiguration' (Maybe Text)
- newUserIdentityConfiguration :: UserIdentityConfiguration
- data UserTokenConfiguration = UserTokenConfiguration' (Maybe JsonTokenTypeConfiguration) (Maybe JwtTokenTypeConfiguration)
- newUserTokenConfiguration :: UserTokenConfiguration
- data Warning = Warning' (Maybe WarningCode) (Maybe Text)
- newWarning :: Warning
- data WebCrawlerConfiguration = WebCrawlerConfiguration' (Maybe AuthenticationConfiguration) (Maybe Natural) (Maybe Double) (Maybe Natural) (Maybe Natural) (Maybe ProxyConfiguration) (Maybe [Text]) (Maybe [Text]) Urls
- newWebCrawlerConfiguration :: Urls -> WebCrawlerConfiguration
- data WorkDocsConfiguration = WorkDocsConfiguration' (Maybe Bool) (Maybe [Text]) (Maybe (NonEmpty DataSourceToIndexFieldMapping)) (Maybe [Text]) (Maybe Bool) Text
- newWorkDocsConfiguration :: Text -> WorkDocsConfiguration
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.
Constructors
| AssociateEntitiesToExperience' Text Text (NonEmpty EntityConfiguration) |
Instances
newAssociateEntitiesToExperience Source #
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty EntityConfiguration | |
| -> AssociateEntitiesToExperience |
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 #
See: newAssociateEntitiesToExperienceResponse smart constructor.
Constructors
| AssociateEntitiesToExperienceResponse' (Maybe (NonEmpty FailedEntity)) Int |
Instances
newAssociateEntitiesToExperienceResponse Source #
Arguments
| :: Int | |
| -> AssociateEntitiesToExperienceResponse |
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.
Constructors
| AssociatePersonasToEntities' Text Text (NonEmpty EntityPersonaConfiguration) |
Instances
newAssociatePersonasToEntities Source #
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty EntityPersonaConfiguration | |
| -> AssociatePersonasToEntities |
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 #
See: newAssociatePersonasToEntitiesResponse smart constructor.
Constructors
| AssociatePersonasToEntitiesResponse' (Maybe (NonEmpty FailedEntity)) Int |
Instances
newAssociatePersonasToEntitiesResponse Source #
Arguments
| :: Int | |
| -> AssociatePersonasToEntitiesResponse |
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.
Constructors
| BatchDeleteDocument' (Maybe DataSourceSyncJobMetricTarget) Text (NonEmpty Text) |
Instances
newBatchDeleteDocument Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> BatchDeleteDocument |
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
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.
Constructors
| BatchGetDocumentStatus' Text (NonEmpty DocumentInfo) |
Instances
newBatchGetDocumentStatus Source #
Arguments
| :: Text | |
| -> NonEmpty DocumentInfo | |
| -> BatchGetDocumentStatus |
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.
Constructors
| BatchGetDocumentStatusResponse' (Maybe [Status]) (Maybe [BatchGetDocumentStatusResponseError]) Int |
Instances
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.
Constructors
| BatchPutDocument' (Maybe CustomDocumentEnrichmentConfiguration) (Maybe Text) Text (NonEmpty Document) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Document | |
| -> BatchPutDocument |
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.
Constructors
| BatchPutDocumentResponse' (Maybe [BatchPutDocumentResponseFailedDocument]) Int |
Instances
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.
Constructors
| ClearQuerySuggestions' Text |
Instances
newClearQuerySuggestions Source #
Arguments
| :: Text | |
| -> ClearQuerySuggestions |
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.
Constructors
| ClearQuerySuggestionsResponse' | |
Instances
| Generic ClearQuerySuggestionsResponse Source # | |
Defined in Amazonka.Kendra.ClearQuerySuggestions Associated Types type Rep ClearQuerySuggestionsResponse :: Type -> Type # | |
| Read ClearQuerySuggestionsResponse Source # | |
| Show ClearQuerySuggestionsResponse Source # | |
Defined in Amazonka.Kendra.ClearQuerySuggestions Methods showsPrec :: Int -> ClearQuerySuggestionsResponse -> ShowS # show :: ClearQuerySuggestionsResponse -> String # showList :: [ClearQuerySuggestionsResponse] -> ShowS # | |
| NFData ClearQuerySuggestionsResponse Source # | |
Defined in Amazonka.Kendra.ClearQuerySuggestions Methods rnf :: ClearQuerySuggestionsResponse -> () # | |
| Eq ClearQuerySuggestionsResponse Source # | |
Defined in Amazonka.Kendra.ClearQuerySuggestions | |
| type Rep ClearQuerySuggestionsResponse Source # | |
Defined in Amazonka.Kendra.ClearQuerySuggestions | |
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.
Constructors
| CreateAccessControlConfiguration' (Maybe [Principal]) (Maybe Text) (Maybe Text) (Maybe (NonEmpty HierarchicalPrincipal)) Text Text |
Instances
newCreateAccessControlConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateAccessControlConfiguration |
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 #
See: newCreateAccessControlConfigurationResponse smart constructor.
Constructors
| CreateAccessControlConfigurationResponse' Int Text |
Instances
newCreateAccessControlConfigurationResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateAccessControlConfigurationResponse |
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.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DataSourceType | |
| -> CreateDataSource |
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.
Constructors
| CreateDataSourceResponse' Int Text |
Instances
newCreateDataSourceResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateDataSourceResponse |
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.
Constructors
| CreateExperience' (Maybe Text) (Maybe ExperienceConfiguration) (Maybe Text) (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateExperience |
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.
Constructors
| CreateExperienceResponse' Int Text |
Instances
newCreateExperienceResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateExperienceResponse |
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
See: newCreateFaq smart constructor.
Constructors
| CreateFaq' (Maybe Text) (Maybe Text) (Maybe FaqFileFormat) (Maybe Text) (Maybe [Tag]) Text Text S3Path Text |
Instances
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.
Constructors
| CreateFaqResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> CreateFaqResponse |
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.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateIndex |
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_idand_group_idsor you can provide user and group information inUserContext. - 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.
Constructors
| CreateIndexResponse' (Maybe Text) Int |
Instances
newCreateIndexResponse Source #
Arguments
| :: Int | |
| -> CreateIndexResponse |
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.
Constructors
| CreateQuerySuggestionsBlockList' (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text S3Path Text |
Instances
newCreateQuerySuggestionsBlockList Source #
Arguments
| :: Text | |
| -> Text | |
| -> S3Path | |
| -> Text | |
| -> CreateQuerySuggestionsBlockList |
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 #
See: newCreateQuerySuggestionsBlockListResponse smart constructor.
Constructors
| CreateQuerySuggestionsBlockListResponse' (Maybe Text) Int |
Instances
newCreateQuerySuggestionsBlockListResponse Source #
Arguments
| :: Int | |
| -> CreateQuerySuggestionsBlockListResponse |
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
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> S3Path | |
| -> CreateThesaurus |
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.
Constructors
| CreateThesaurusResponse' (Maybe Text) Int |
Instances
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.
Constructors
| DeleteAccessControlConfiguration' Text Text |
Instances
newDeleteAccessControlConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteAccessControlConfiguration |
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 #
See: newDeleteAccessControlConfigurationResponse smart constructor.
Constructors
| DeleteAccessControlConfigurationResponse' Int |
Instances
newDeleteAccessControlConfigurationResponse Source #
Arguments
| :: Int | |
| -> DeleteAccessControlConfigurationResponse |
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.
Constructors
| DeleteDataSource' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteDataSource |
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.
Constructors
| DeleteDataSourceResponse' | |
Instances
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.
Constructors
| DeleteExperience' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteExperience |
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.
Constructors
| DeleteExperienceResponse' Int |
Instances
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
See: newDeleteFaq smart constructor.
Constructors
| DeleteFaq' Text Text |
Instances
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
| Generic DeleteFaqResponse Source # | |
Defined in Amazonka.Kendra.DeleteFaq Associated Types type Rep DeleteFaqResponse :: Type -> Type # Methods from :: DeleteFaqResponse -> Rep DeleteFaqResponse x # to :: Rep DeleteFaqResponse x -> DeleteFaqResponse # | |
| Read DeleteFaqResponse Source # | |
Defined in Amazonka.Kendra.DeleteFaq Methods readsPrec :: Int -> ReadS DeleteFaqResponse # readList :: ReadS [DeleteFaqResponse] # | |
| Show DeleteFaqResponse Source # | |
Defined in Amazonka.Kendra.DeleteFaq Methods showsPrec :: Int -> DeleteFaqResponse -> ShowS # show :: DeleteFaqResponse -> String # showList :: [DeleteFaqResponse] -> ShowS # | |
| NFData DeleteFaqResponse Source # | |
Defined in Amazonka.Kendra.DeleteFaq Methods rnf :: DeleteFaqResponse -> () # | |
| Eq DeleteFaqResponse Source # | |
Defined in Amazonka.Kendra.DeleteFaq Methods (==) :: DeleteFaqResponse -> DeleteFaqResponse -> Bool # (/=) :: DeleteFaqResponse -> DeleteFaqResponse -> Bool # | |
| type Rep DeleteFaqResponse Source # | |
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
Arguments
| :: Text | |
| -> DeleteIndex |
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' | |
Instances
| Generic DeleteIndexResponse Source # | |
Defined in Amazonka.Kendra.DeleteIndex Associated Types type Rep DeleteIndexResponse :: Type -> Type # Methods from :: DeleteIndexResponse -> Rep DeleteIndexResponse x # to :: Rep DeleteIndexResponse x -> DeleteIndexResponse # | |
| Read DeleteIndexResponse Source # | |
Defined in Amazonka.Kendra.DeleteIndex Methods readsPrec :: Int -> ReadS DeleteIndexResponse # readList :: ReadS [DeleteIndexResponse] # | |
| Show DeleteIndexResponse Source # | |
Defined in Amazonka.Kendra.DeleteIndex Methods showsPrec :: Int -> DeleteIndexResponse -> ShowS # show :: DeleteIndexResponse -> String # showList :: [DeleteIndexResponse] -> ShowS # | |
| NFData DeleteIndexResponse Source # | |
Defined in Amazonka.Kendra.DeleteIndex Methods rnf :: DeleteIndexResponse -> () # | |
| Eq DeleteIndexResponse Source # | |
Defined in Amazonka.Kendra.DeleteIndex Methods (==) :: DeleteIndexResponse -> DeleteIndexResponse -> Bool # (/=) :: DeleteIndexResponse -> DeleteIndexResponse -> Bool # | |
| type Rep DeleteIndexResponse Source # | |
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
newDeletePrincipalMapping Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeletePrincipalMapping |
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.
Constructors
| DeletePrincipalMappingResponse' | |
Instances
| Generic DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping Associated Types type Rep DeletePrincipalMappingResponse :: Type -> Type # | |
| Read DeletePrincipalMappingResponse Source # | |
| Show DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping Methods showsPrec :: Int -> DeletePrincipalMappingResponse -> ShowS # show :: DeletePrincipalMappingResponse -> String # showList :: [DeletePrincipalMappingResponse] -> ShowS # | |
| NFData DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping Methods rnf :: DeletePrincipalMappingResponse -> () # | |
| Eq DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping | |
| type Rep DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping | |
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.
Constructors
| DeleteQuerySuggestionsBlockList' Text Text |
Instances
newDeleteQuerySuggestionsBlockList Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteQuerySuggestionsBlockList |
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 #
See: newDeleteQuerySuggestionsBlockListResponse smart constructor.
Constructors
| DeleteQuerySuggestionsBlockListResponse' | |
Instances
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
Arguments
| :: Text | |
| -> Text | |
| -> DeleteThesaurus |
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.
Constructors
| DeleteThesaurusResponse' | |
Instances
| Generic DeleteThesaurusResponse Source # | |
Defined in Amazonka.Kendra.DeleteThesaurus Associated Types type Rep DeleteThesaurusResponse :: Type -> Type # Methods from :: DeleteThesaurusResponse -> Rep DeleteThesaurusResponse x # to :: Rep DeleteThesaurusResponse x -> DeleteThesaurusResponse # | |
| Read DeleteThesaurusResponse Source # | |
Defined in Amazonka.Kendra.DeleteThesaurus | |
| Show DeleteThesaurusResponse Source # | |
Defined in Amazonka.Kendra.DeleteThesaurus Methods showsPrec :: Int -> DeleteThesaurusResponse -> ShowS # show :: DeleteThesaurusResponse -> String # showList :: [DeleteThesaurusResponse] -> ShowS # | |
| NFData DeleteThesaurusResponse Source # | |
Defined in Amazonka.Kendra.DeleteThesaurus Methods rnf :: DeleteThesaurusResponse -> () # | |
| Eq DeleteThesaurusResponse Source # | |
Defined in Amazonka.Kendra.DeleteThesaurus Methods (==) :: DeleteThesaurusResponse -> DeleteThesaurusResponse -> Bool # (/=) :: DeleteThesaurusResponse -> DeleteThesaurusResponse -> Bool # | |
| type Rep DeleteThesaurusResponse Source # | |
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 #
See: newDescribeAccessControlConfiguration smart constructor.
Constructors
| DescribeAccessControlConfiguration' Text Text |
Instances
newDescribeAccessControlConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeAccessControlConfiguration |
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 #
See: newDescribeAccessControlConfigurationResponse smart constructor.
Constructors
| DescribeAccessControlConfigurationResponse' (Maybe [Principal]) (Maybe Text) (Maybe Text) (Maybe (NonEmpty HierarchicalPrincipal)) Int Text |
Instances
newDescribeAccessControlConfigurationResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribeAccessControlConfigurationResponse |
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.
Constructors
| DescribeDataSource' Text Text |
Instances
newDescribeDataSource Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeDataSource |
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.
Constructors
Instances
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.
Constructors
| DescribeExperience' Text Text |
Instances
newDescribeExperience Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeExperience |
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.
Constructors
| DescribeExperienceResponse' (Maybe ExperienceConfiguration) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty ExperienceEndpoint)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ExperienceStatus) (Maybe POSIX) Int |
Instances
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
Arguments
| :: Text | |
| -> Text | |
| -> DescribeFaq |
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.
Constructors
| DescribeFaqResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe FaqFileFormat) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3Path) (Maybe FaqStatus) (Maybe POSIX) Int |
Instances
newDescribeFaqResponse Source #
Arguments
| :: Int | |
| -> DescribeFaqResponse |
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
Arguments
| :: Text | |
| -> DescribeIndex |
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.
Constructors
Instances
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.
Constructors
| DescribePrincipalMapping' (Maybe Text) Text Text |
Instances
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.
Constructors
| DescribePrincipalMappingResponse' (Maybe Text) (Maybe Text) (Maybe [GroupOrderingIdSummary]) (Maybe Text) Int |
Instances
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, orFAILED. - 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.
Constructors
| DescribeQuerySuggestionsBlockList' Text Text |
Instances
newDescribeQuerySuggestionsBlockList Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeQuerySuggestionsBlockList |
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 #
See: newDescribeQuerySuggestionsBlockListResponse smart constructor.
Constructors
| DescribeQuerySuggestionsBlockListResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe S3Path) (Maybe QuerySuggestionsBlockListStatus) (Maybe POSIX) Int |
Instances
newDescribeQuerySuggestionsBlockListResponse Source #
Arguments
| :: Int | |
| -> DescribeQuerySuggestionsBlockListResponse |
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.
Constructors
| DescribeQuerySuggestionsConfig' Text |
Instances
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 #
See: newDescribeQuerySuggestionsConfigResponse smart constructor.
Constructors
| DescribeQuerySuggestionsConfigResponse' (Maybe Bool) (Maybe POSIX) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe Mode) (Maybe Int) (Maybe QuerySuggestionsStatus) (Maybe Int) Int |
Instances
newDescribeQuerySuggestionsConfigResponse Source #
Arguments
| :: Int | |
| -> DescribeQuerySuggestionsConfigResponse |
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.
Constructors
| DescribeThesaurus' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeThesaurus |
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.
Constructors
| DescribeThesaurusResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3Path) (Maybe ThesaurusStatus) (Maybe Integer) (Maybe Integer) (Maybe POSIX) Int |
Instances
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 #
See: newDisassociateEntitiesFromExperience smart constructor.
Constructors
| DisassociateEntitiesFromExperience' Text Text (NonEmpty EntityConfiguration) |