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

Contents

Service Configuration
Errors
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

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
newtype AdditionalResultAttributeValueType where
- AdditionalResultAttributeValueType' {
  - fromAdditionalResultAttributeValueType :: Text
  }
- pattern AdditionalResultAttributeValueType_TEXT_WITH_HIGHLIGHTS_VALUE :: AdditionalResultAttributeValueType
newtype AlfrescoEntity where
- AlfrescoEntity' {
  - fromAlfrescoEntity :: Text
  }
- pattern AlfrescoEntity_Blog :: AlfrescoEntity
- pattern AlfrescoEntity_DocumentLibrary :: AlfrescoEntity
- pattern AlfrescoEntity_Wiki :: AlfrescoEntity
newtype ConditionOperator where
- ConditionOperator' {
  - fromConditionOperator :: Text
  }
- 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' {
  - fromConfluenceAttachmentFieldName :: Text
  }
- 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
- ConfluenceAuthenticationType' {
  - fromConfluenceAuthenticationType :: Text
  }
- pattern ConfluenceAuthenticationType_HTTP_BASIC :: ConfluenceAuthenticationType
- pattern ConfluenceAuthenticationType_PAT :: ConfluenceAuthenticationType
newtype ConfluenceBlogFieldName where
- ConfluenceBlogFieldName' {
  - fromConfluenceBlogFieldName :: Text
  }
- 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' {
  - fromConfluencePageFieldName :: Text
  }
- 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' {
  - fromConfluenceSpaceFieldName :: Text
  }
- pattern ConfluenceSpaceFieldName_DISPLAY_URL :: ConfluenceSpaceFieldName
- pattern ConfluenceSpaceFieldName_ITEM_TYPE :: ConfluenceSpaceFieldName
- pattern ConfluenceSpaceFieldName_SPACE_KEY :: ConfluenceSpaceFieldName
- pattern ConfluenceSpaceFieldName_URL :: ConfluenceSpaceFieldName
newtype ConfluenceVersion where
- ConfluenceVersion' {
  - fromConfluenceVersion :: Text
  }
- pattern ConfluenceVersion_CLOUD :: ConfluenceVersion
- pattern ConfluenceVersion_SERVER :: ConfluenceVersion
newtype ContentType where
- ContentType' {
  - fromContentType :: Text
  }
- 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' {
  - fromDataSourceStatus :: Text
  }
- pattern DataSourceStatus_ACTIVE :: DataSourceStatus
- pattern DataSourceStatus_CREATING :: DataSourceStatus
- pattern DataSourceStatus_DELETING :: DataSourceStatus
- pattern DataSourceStatus_FAILED :: DataSourceStatus
- pattern DataSourceStatus_UPDATING :: DataSourceStatus
newtype DataSourceSyncJobStatus where
- DataSourceSyncJobStatus' {
  - fromDataSourceSyncJobStatus :: Text
  }
- 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' {
  - fromDataSourceType :: Text
  }
- 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
- DatabaseEngineType' {
  - fromDatabaseEngineType :: Text
  }
- pattern DatabaseEngineType_RDS_AURORA_MYSQL :: DatabaseEngineType
- pattern DatabaseEngineType_RDS_AURORA_POSTGRESQL :: DatabaseEngineType
- pattern DatabaseEngineType_RDS_MYSQL :: DatabaseEngineType
- pattern DatabaseEngineType_RDS_POSTGRESQL :: DatabaseEngineType
newtype DocumentAttributeValueType where
- DocumentAttributeValueType' {
  - fromDocumentAttributeValueType :: Text
  }
- 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' {
  - fromDocumentStatus :: Text
  }
- 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' {
  - fromEndpointType :: Text
  }
- pattern EndpointType_HOME :: EndpointType
newtype EntityType where
- EntityType' {
  - fromEntityType :: Text
  }
- pattern EntityType_GROUP :: EntityType
- pattern EntityType_USER :: EntityType
newtype ErrorCode where
- ErrorCode' {
  - fromErrorCode :: Text
  }
- pattern ErrorCode_InternalError :: ErrorCode
- pattern ErrorCode_InvalidRequest :: ErrorCode
newtype ExperienceStatus where
- ExperienceStatus' {
  - fromExperienceStatus :: Text
  }
- pattern ExperienceStatus_ACTIVE :: ExperienceStatus
- pattern ExperienceStatus_CREATING :: ExperienceStatus
- pattern ExperienceStatus_DELETING :: ExperienceStatus
- pattern ExperienceStatus_FAILED :: ExperienceStatus
newtype FaqFileFormat where
- FaqFileFormat' {
  - fromFaqFileFormat :: Text
  }
- pattern FaqFileFormat_CSV :: FaqFileFormat
- pattern FaqFileFormat_CSV_WITH_HEADER :: FaqFileFormat
- pattern FaqFileFormat_JSON :: FaqFileFormat
newtype FaqStatus where
- FaqStatus' {
  - fromFaqStatus :: Text
  }
- pattern FaqStatus_ACTIVE :: FaqStatus
- pattern FaqStatus_CREATING :: FaqStatus
- pattern FaqStatus_DELETING :: FaqStatus
- pattern FaqStatus_FAILED :: FaqStatus
- pattern FaqStatus_UPDATING :: FaqStatus
newtype FsxFileSystemType where
- FsxFileSystemType' {
  - fromFsxFileSystemType :: Text
  }
- pattern FsxFileSystemType_WINDOWS :: FsxFileSystemType
newtype HighlightType where
- HighlightType' {
  - fromHighlightType :: Text
  }
- pattern HighlightType_STANDARD :: HighlightType
- pattern HighlightType_THESAURUS_SYNONYM :: HighlightType
newtype IndexEdition where
- IndexEdition' {
  - fromIndexEdition :: Text
  }
- pattern IndexEdition_DEVELOPER_EDITION :: IndexEdition
- pattern IndexEdition_ENTERPRISE_EDITION :: IndexEdition
newtype IndexStatus where
- IndexStatus' {
  - fromIndexStatus :: Text
  }
- 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
newtype IssueSubEntity where
- IssueSubEntity' {
  - fromIssueSubEntity :: Text
  }
- pattern IssueSubEntity_ATTACHMENTS :: IssueSubEntity
- pattern IssueSubEntity_COMMENTS :: IssueSubEntity
- pattern IssueSubEntity_WORKLOGS :: IssueSubEntity
newtype KeyLocation where
- KeyLocation' {
  - fromKeyLocation :: Text
  }
- pattern KeyLocation_SECRET_MANAGER :: KeyLocation
- pattern KeyLocation_URL :: KeyLocation
newtype MetricType where
- MetricType' {
  - fromMetricType :: Text
  }
- 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' {
  - fromMode :: Text
  }
- pattern Mode_ENABLED :: Mode
- pattern Mode_LEARN_ONLY :: Mode
newtype Order where
- Order' {
  - fromOrder :: Text
  }
- pattern Order_ASCENDING :: Order
- pattern Order_DESCENDING :: Order
newtype Persona where
- Persona' {
  - fromPersona :: Text
  }
- pattern Persona_OWNER :: Persona
- pattern Persona_VIEWER :: Persona
newtype PrincipalMappingStatus where
- PrincipalMappingStatus' {
  - fromPrincipalMappingStatus :: Text
  }
- pattern PrincipalMappingStatus_DELETED :: PrincipalMappingStatus
- pattern PrincipalMappingStatus_DELETING :: PrincipalMappingStatus
- pattern PrincipalMappingStatus_FAILED :: PrincipalMappingStatus
- pattern PrincipalMappingStatus_PROCESSING :: PrincipalMappingStatus
- pattern PrincipalMappingStatus_SUCCEEDED :: PrincipalMappingStatus
newtype PrincipalType where
- PrincipalType' {
  - fromPrincipalType :: Text
  }
- pattern PrincipalType_GROUP :: PrincipalType
- pattern PrincipalType_USER :: PrincipalType
newtype QueryIdentifiersEnclosingOption where
- QueryIdentifiersEnclosingOption' {
  - fromQueryIdentifiersEnclosingOption :: Text
  }
- pattern QueryIdentifiersEnclosingOption_DOUBLE_QUOTES :: QueryIdentifiersEnclosingOption
- pattern QueryIdentifiersEnclosingOption_NONE :: QueryIdentifiersEnclosingOption
newtype QueryResultFormat where
- QueryResultFormat' {
  - fromQueryResultFormat :: Text
  }
- pattern QueryResultFormat_TABLE :: QueryResultFormat
- pattern QueryResultFormat_TEXT :: QueryResultFormat
newtype QueryResultType where
- QueryResultType' {
  - fromQueryResultType :: Text
  }
- pattern QueryResultType_ANSWER :: QueryResultType
- pattern QueryResultType_DOCUMENT :: QueryResultType
- pattern QueryResultType_QUESTION_ANSWER :: QueryResultType
newtype QuerySuggestionsBlockListStatus where
- QuerySuggestionsBlockListStatus' {
  - fromQuerySuggestionsBlockListStatus :: Text
  }
- 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
- QuerySuggestionsStatus' {
  - fromQuerySuggestionsStatus :: Text
  }
- pattern QuerySuggestionsStatus_ACTIVE :: QuerySuggestionsStatus
- pattern QuerySuggestionsStatus_UPDATING :: QuerySuggestionsStatus
newtype ReadAccessType where
- ReadAccessType' {
  - fromReadAccessType :: Text
  }
- pattern ReadAccessType_ALLOW :: ReadAccessType
- pattern ReadAccessType_DENY :: ReadAccessType
newtype RelevanceType where
- RelevanceType' {
  - fromRelevanceType :: Text
  }
- pattern RelevanceType_NOT_RELEVANT :: RelevanceType
- pattern RelevanceType_RELEVANT :: RelevanceType
newtype SalesforceChatterFeedIncludeFilterType where
- SalesforceChatterFeedIncludeFilterType' {
  - fromSalesforceChatterFeedIncludeFilterType :: Text
  }
- pattern SalesforceChatterFeedIncludeFilterType_ACTIVE_USER :: SalesforceChatterFeedIncludeFilterType
- pattern SalesforceChatterFeedIncludeFilterType_STANDARD_USER :: SalesforceChatterFeedIncludeFilterType
newtype SalesforceKnowledgeArticleState where
- SalesforceKnowledgeArticleState' {
  - fromSalesforceKnowledgeArticleState :: Text
  }
- pattern SalesforceKnowledgeArticleState_ARCHIVED :: SalesforceKnowledgeArticleState
- pattern SalesforceKnowledgeArticleState_DRAFT :: SalesforceKnowledgeArticleState
- pattern SalesforceKnowledgeArticleState_PUBLISHED :: SalesforceKnowledgeArticleState
newtype SalesforceStandardObjectName where
- SalesforceStandardObjectName' {
  - fromSalesforceStandardObjectName :: Text
  }
- 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' {
  - fromScoreConfidence :: Text
  }
- 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
- ServiceNowAuthenticationType' {
  - fromServiceNowAuthenticationType :: Text
  }
- pattern ServiceNowAuthenticationType_HTTP_BASIC :: ServiceNowAuthenticationType
- pattern ServiceNowAuthenticationType_OAUTH2 :: ServiceNowAuthenticationType
newtype ServiceNowBuildVersionType where
- ServiceNowBuildVersionType' {
  - fromServiceNowBuildVersionType :: Text
  }
- pattern ServiceNowBuildVersionType_LONDON :: ServiceNowBuildVersionType
- pattern ServiceNowBuildVersionType_OTHERS :: ServiceNowBuildVersionType
newtype SharePointOnlineAuthenticationType where
- SharePointOnlineAuthenticationType' {
  - fromSharePointOnlineAuthenticationType :: Text
  }
- pattern SharePointOnlineAuthenticationType_HTTP_BASIC :: SharePointOnlineAuthenticationType
- pattern SharePointOnlineAuthenticationType_OAUTH2 :: SharePointOnlineAuthenticationType
newtype SharePointVersion where
- SharePointVersion' {
  - fromSharePointVersion :: Text
  }
- pattern SharePointVersion_SHAREPOINT_2013 :: SharePointVersion
- pattern SharePointVersion_SHAREPOINT_2016 :: SharePointVersion
- pattern SharePointVersion_SHAREPOINT_2019 :: SharePointVersion
- pattern SharePointVersion_SHAREPOINT_ONLINE :: SharePointVersion
newtype SlackEntity where
- SlackEntity' {
  - fromSlackEntity :: Text
  }
- pattern SlackEntity_DIRECT_MESSAGE :: SlackEntity
- pattern SlackEntity_GROUP_MESSAGE :: SlackEntity
- pattern SlackEntity_PRIVATE_CHANNEL :: SlackEntity
- pattern SlackEntity_PUBLIC_CHANNEL :: SlackEntity
newtype SortOrder where
- SortOrder' {
  - fromSortOrder :: Text
  }
- pattern SortOrder_ASC :: SortOrder
- pattern SortOrder_DESC :: SortOrder
newtype ThesaurusStatus where
- ThesaurusStatus' {
  - fromThesaurusStatus :: Text
  }
- 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
- Type' {
  - fromType :: Text
  }
- pattern Type_ON_PREMISE :: Type
- pattern Type_SAAS :: Type
newtype UserContextPolicy where
- UserContextPolicy' {
  - fromUserContextPolicy :: Text
  }
- pattern UserContextPolicy_ATTRIBUTE_FILTER :: UserContextPolicy
- pattern UserContextPolicy_USER_TOKEN :: UserContextPolicy
newtype UserGroupResolutionMode where
- UserGroupResolutionMode' {
  - fromUserGroupResolutionMode :: Text
  }
- pattern UserGroupResolutionMode_AWS_SSO :: UserGroupResolutionMode
- pattern UserGroupResolutionMode_NONE :: UserGroupResolutionMode
newtype WarningCode where
- WarningCode' {
  - fromWarningCode :: Text
  }
- pattern WarningCode_QUERY_LANGUAGE_INVALID_SYNTAX :: WarningCode
newtype WebCrawlerMode where
- WebCrawlerMode' {
  - fromWebCrawlerMode :: Text
  }
- pattern WebCrawlerMode_EVERYTHING :: WebCrawlerMode
- pattern WebCrawlerMode_HOST_ONLY :: WebCrawlerMode
- pattern WebCrawlerMode_SUBDOMAINS :: WebCrawlerMode
data AccessControlConfigurationSummary = AccessControlConfigurationSummary' {
- id :: Text
}
newAccessControlConfigurationSummary :: Text -> AccessControlConfigurationSummary
accessControlConfigurationSummary_id :: Lens' AccessControlConfigurationSummary Text
data AccessControlListConfiguration = AccessControlListConfiguration' {
- keyPath :: Maybe Text
}
newAccessControlListConfiguration :: AccessControlListConfiguration
accessControlListConfiguration_keyPath :: Lens' AccessControlListConfiguration (Maybe Text)
data AclConfiguration = AclConfiguration' {
- allowedGroupsColumnName :: Text
}
newAclConfiguration :: Text -> AclConfiguration
aclConfiguration_allowedGroupsColumnName :: Lens' AclConfiguration Text
data AdditionalResultAttribute = AdditionalResultAttribute' {
- key :: Text
- valueType :: AdditionalResultAttributeValueType
- value :: AdditionalResultAttributeValue
}
newAdditionalResultAttribute :: Text -> AdditionalResultAttributeValueType -> AdditionalResultAttributeValue -> AdditionalResultAttribute
additionalResultAttribute_key :: Lens' AdditionalResultAttribute Text
additionalResultAttribute_valueType :: Lens' AdditionalResultAttribute AdditionalResultAttributeValueType
additionalResultAttribute_value :: Lens' AdditionalResultAttribute AdditionalResultAttributeValue
data AdditionalResultAttributeValue = AdditionalResultAttributeValue' {
- textWithHighlightsValue :: Maybe TextWithHighlights
}
newAdditionalResultAttributeValue :: AdditionalResultAttributeValue
additionalResultAttributeValue_textWithHighlightsValue :: Lens' AdditionalResultAttributeValue (Maybe TextWithHighlights)
data AlfrescoConfiguration = AlfrescoConfiguration' {
- blogFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- crawlComments :: Maybe Bool
- crawlSystemFolders :: Maybe Bool
- documentLibraryFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- entityFilter :: Maybe (NonEmpty AlfrescoEntity)
- exclusionPatterns :: Maybe [Text]
- inclusionPatterns :: Maybe [Text]
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- wikiFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- siteUrl :: Text
- siteId :: Text
- secretArn :: Text
- sslCertificateS3Path :: S3Path
}
newAlfrescoConfiguration :: Text -> Text -> Text -> S3Path -> AlfrescoConfiguration
alfrescoConfiguration_blogFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
alfrescoConfiguration_crawlComments :: Lens' AlfrescoConfiguration (Maybe Bool)
alfrescoConfiguration_crawlSystemFolders :: Lens' AlfrescoConfiguration (Maybe Bool)
alfrescoConfiguration_documentLibraryFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
alfrescoConfiguration_entityFilter :: Lens' AlfrescoConfiguration (Maybe (NonEmpty AlfrescoEntity))
alfrescoConfiguration_exclusionPatterns :: Lens' AlfrescoConfiguration (Maybe [Text])
alfrescoConfiguration_inclusionPatterns :: Lens' AlfrescoConfiguration (Maybe [Text])
alfrescoConfiguration_vpcConfiguration :: Lens' AlfrescoConfiguration (Maybe DataSourceVpcConfiguration)
alfrescoConfiguration_wikiFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
alfrescoConfiguration_siteUrl :: Lens' AlfrescoConfiguration Text
alfrescoConfiguration_siteId :: Lens' AlfrescoConfiguration Text
alfrescoConfiguration_secretArn :: Lens' AlfrescoConfiguration Text
alfrescoConfiguration_sslCertificateS3Path :: Lens' AlfrescoConfiguration S3Path
data AttributeFilter = AttributeFilter' {
- andAllFilters :: Maybe [AttributeFilter]
- containsAll :: Maybe DocumentAttribute
- containsAny :: Maybe DocumentAttribute
- equalsTo :: Maybe DocumentAttribute
- greaterThan :: Maybe DocumentAttribute
- greaterThanOrEquals :: Maybe DocumentAttribute
- lessThan :: Maybe DocumentAttribute
- lessThanOrEquals :: Maybe DocumentAttribute
- notFilter :: Maybe AttributeFilter
- orAllFilters :: Maybe [AttributeFilter]
}
newAttributeFilter :: AttributeFilter
attributeFilter_andAllFilters :: Lens' AttributeFilter (Maybe [AttributeFilter])
attributeFilter_containsAll :: Lens' AttributeFilter (Maybe DocumentAttribute)
attributeFilter_containsAny :: Lens' AttributeFilter (Maybe DocumentAttribute)
attributeFilter_equalsTo :: Lens' AttributeFilter (Maybe DocumentAttribute)
attributeFilter_greaterThan :: Lens' AttributeFilter (Maybe DocumentAttribute)
attributeFilter_greaterThanOrEquals :: Lens' AttributeFilter (Maybe DocumentAttribute)
attributeFilter_lessThan :: Lens' AttributeFilter (Maybe DocumentAttribute)
attributeFilter_lessThanOrEquals :: Lens' AttributeFilter (Maybe DocumentAttribute)
attributeFilter_notFilter :: Lens' AttributeFilter (Maybe AttributeFilter)
attributeFilter_orAllFilters :: Lens' AttributeFilter (Maybe [AttributeFilter])
data AuthenticationConfiguration = AuthenticationConfiguration' {
- basicAuthentication :: Maybe [BasicAuthenticationConfiguration]
}
newAuthenticationConfiguration :: AuthenticationConfiguration
authenticationConfiguration_basicAuthentication :: Lens' AuthenticationConfiguration (Maybe [BasicAuthenticationConfiguration])
data BasicAuthenticationConfiguration = BasicAuthenticationConfiguration' {
- host :: Text
- port :: Natural
- credentials :: Text
}
newBasicAuthenticationConfiguration :: Text -> Natural -> Text -> BasicAuthenticationConfiguration
basicAuthenticationConfiguration_host :: Lens' BasicAuthenticationConfiguration Text
basicAuthenticationConfiguration_port :: Lens' BasicAuthenticationConfiguration Natural
basicAuthenticationConfiguration_credentials :: Lens' BasicAuthenticationConfiguration Text
data BatchDeleteDocumentResponseFailedDocument = BatchDeleteDocumentResponseFailedDocument' {
- errorCode :: Maybe ErrorCode
- errorMessage :: Maybe Text
- id :: Maybe Text
}
newBatchDeleteDocumentResponseFailedDocument :: BatchDeleteDocumentResponseFailedDocument
batchDeleteDocumentResponseFailedDocument_errorCode :: Lens' BatchDeleteDocumentResponseFailedDocument (Maybe ErrorCode)
batchDeleteDocumentResponseFailedDocument_errorMessage :: Lens' BatchDeleteDocumentResponseFailedDocument (Maybe Text)
batchDeleteDocumentResponseFailedDocument_id :: Lens' BatchDeleteDocumentResponseFailedDocument (Maybe Text)
data BatchGetDocumentStatusResponseError = BatchGetDocumentStatusResponseError' {
- documentId :: Maybe Text
- errorCode :: Maybe ErrorCode
- errorMessage :: Maybe Text
}
newBatchGetDocumentStatusResponseError :: BatchGetDocumentStatusResponseError
batchGetDocumentStatusResponseError_documentId :: Lens' BatchGetDocumentStatusResponseError (Maybe Text)
batchGetDocumentStatusResponseError_errorCode :: Lens' BatchGetDocumentStatusResponseError (Maybe ErrorCode)
batchGetDocumentStatusResponseError_errorMessage :: Lens' BatchGetDocumentStatusResponseError (Maybe Text)
data BatchPutDocumentResponseFailedDocument = BatchPutDocumentResponseFailedDocument' {
- errorCode :: Maybe ErrorCode
- errorMessage :: Maybe Text
- id :: Maybe Text
}
newBatchPutDocumentResponseFailedDocument :: BatchPutDocumentResponseFailedDocument
batchPutDocumentResponseFailedDocument_errorCode :: Lens' BatchPutDocumentResponseFailedDocument (Maybe ErrorCode)
batchPutDocumentResponseFailedDocument_errorMessage :: Lens' BatchPutDocumentResponseFailedDocument (Maybe Text)
batchPutDocumentResponseFailedDocument_id :: Lens' BatchPutDocumentResponseFailedDocument (Maybe Text)
data BoxConfiguration = BoxConfiguration' {
- commentFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- crawlComments :: Maybe Bool
- crawlTasks :: Maybe Bool
- crawlWebLinks :: Maybe Bool
- exclusionPatterns :: Maybe [Text]
- fileFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionPatterns :: Maybe [Text]
- taskFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- useChangeLog :: Maybe Bool
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- webLinkFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- enterpriseId :: Text
- secretArn :: Text
}
newBoxConfiguration :: Text -> Text -> BoxConfiguration
boxConfiguration_commentFieldMappings :: Lens' BoxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
boxConfiguration_crawlComments :: Lens' BoxConfiguration (Maybe Bool)
boxConfiguration_crawlTasks :: Lens' BoxConfiguration (Maybe Bool)
boxConfiguration_crawlWebLinks :: Lens' BoxConfiguration (Maybe Bool)
boxConfiguration_exclusionPatterns :: Lens' BoxConfiguration (Maybe [Text])
boxConfiguration_fileFieldMappings :: Lens' BoxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
boxConfiguration_inclusionPatterns :: Lens' BoxConfiguration (Maybe [Text])
boxConfiguration_taskFieldMappings :: Lens' BoxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
boxConfiguration_useChangeLog :: Lens' BoxConfiguration (Maybe Bool)
boxConfiguration_vpcConfiguration :: Lens' BoxConfiguration (Maybe DataSourceVpcConfiguration)
boxConfiguration_webLinkFieldMappings :: Lens' BoxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
boxConfiguration_enterpriseId :: Lens' BoxConfiguration Text
boxConfiguration_secretArn :: Lens' BoxConfiguration Text
data CapacityUnitsConfiguration = CapacityUnitsConfiguration' {
- storageCapacityUnits :: Natural
- queryCapacityUnits :: Natural
}
newCapacityUnitsConfiguration :: Natural -> Natural -> CapacityUnitsConfiguration
capacityUnitsConfiguration_storageCapacityUnits :: Lens' CapacityUnitsConfiguration Natural
capacityUnitsConfiguration_queryCapacityUnits :: Lens' CapacityUnitsConfiguration Natural
data ClickFeedback = ClickFeedback' {
- resultId :: Text
- clickTime :: POSIX
}
newClickFeedback :: Text -> UTCTime -> ClickFeedback
clickFeedback_resultId :: Lens' ClickFeedback Text
clickFeedback_clickTime :: Lens' ClickFeedback UTCTime
data ColumnConfiguration = ColumnConfiguration' {
- documentTitleColumnName :: Maybe Text
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- documentIdColumnName :: Text
- documentDataColumnName :: Text
- changeDetectingColumns :: NonEmpty Text
}
newColumnConfiguration :: Text -> Text -> NonEmpty Text -> ColumnConfiguration
columnConfiguration_documentTitleColumnName :: Lens' ColumnConfiguration (Maybe Text)
columnConfiguration_fieldMappings :: Lens' ColumnConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
columnConfiguration_documentIdColumnName :: Lens' ColumnConfiguration Text
columnConfiguration_documentDataColumnName :: Lens' ColumnConfiguration Text
columnConfiguration_changeDetectingColumns :: Lens' ColumnConfiguration (NonEmpty Text)
data ConfluenceAttachmentConfiguration = ConfluenceAttachmentConfiguration' {
- attachmentFieldMappings :: Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping)
- crawlAttachments :: Maybe Bool
}
newConfluenceAttachmentConfiguration :: ConfluenceAttachmentConfiguration
confluenceAttachmentConfiguration_attachmentFieldMappings :: Lens' ConfluenceAttachmentConfiguration (Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping))
confluenceAttachmentConfiguration_crawlAttachments :: Lens' ConfluenceAttachmentConfiguration (Maybe Bool)
data ConfluenceAttachmentToIndexFieldMapping = ConfluenceAttachmentToIndexFieldMapping' {
- dataSourceFieldName :: Maybe ConfluenceAttachmentFieldName
- dateFieldFormat :: Maybe Text
- indexFieldName :: Maybe Text
}
newConfluenceAttachmentToIndexFieldMapping :: ConfluenceAttachmentToIndexFieldMapping
confluenceAttachmentToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceAttachmentToIndexFieldMapping (Maybe ConfluenceAttachmentFieldName)
confluenceAttachmentToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceAttachmentToIndexFieldMapping (Maybe Text)
confluenceAttachmentToIndexFieldMapping_indexFieldName :: Lens' ConfluenceAttachmentToIndexFieldMapping (Maybe Text)
data ConfluenceBlogConfiguration = ConfluenceBlogConfiguration' {
- blogFieldMappings :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
}
newConfluenceBlogConfiguration :: ConfluenceBlogConfiguration
confluenceBlogConfiguration_blogFieldMappings :: Lens' ConfluenceBlogConfiguration (Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping))
data ConfluenceBlogToIndexFieldMapping = ConfluenceBlogToIndexFieldMapping' {
- dataSourceFieldName :: Maybe ConfluenceBlogFieldName
- dateFieldFormat :: Maybe Text
- indexFieldName :: Maybe Text
}
newConfluenceBlogToIndexFieldMapping :: ConfluenceBlogToIndexFieldMapping
confluenceBlogToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe ConfluenceBlogFieldName)
confluenceBlogToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe Text)
confluenceBlogToIndexFieldMapping_indexFieldName :: Lens' ConfluenceBlogToIndexFieldMapping (Maybe Text)
data ConfluenceConfiguration = ConfluenceConfiguration' {
- attachmentConfiguration :: Maybe ConfluenceAttachmentConfiguration
- authenticationType :: Maybe ConfluenceAuthenticationType
- blogConfiguration :: Maybe ConfluenceBlogConfiguration
- exclusionPatterns :: Maybe [Text]
- inclusionPatterns :: Maybe [Text]
- pageConfiguration :: Maybe ConfluencePageConfiguration
- proxyConfiguration :: Maybe ProxyConfiguration
- spaceConfiguration :: Maybe ConfluenceSpaceConfiguration
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- serverUrl :: Text
- secretArn :: Text
- version :: ConfluenceVersion
}
newConfluenceConfiguration :: Text -> Text -> ConfluenceVersion -> ConfluenceConfiguration
confluenceConfiguration_attachmentConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceAttachmentConfiguration)
confluenceConfiguration_authenticationType :: Lens' ConfluenceConfiguration (Maybe ConfluenceAuthenticationType)
confluenceConfiguration_blogConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceBlogConfiguration)
confluenceConfiguration_exclusionPatterns :: Lens' ConfluenceConfiguration (Maybe [Text])
confluenceConfiguration_inclusionPatterns :: Lens' ConfluenceConfiguration (Maybe [Text])
confluenceConfiguration_pageConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluencePageConfiguration)
confluenceConfiguration_proxyConfiguration :: Lens' ConfluenceConfiguration (Maybe ProxyConfiguration)
confluenceConfiguration_spaceConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceSpaceConfiguration)
confluenceConfiguration_vpcConfiguration :: Lens' ConfluenceConfiguration (Maybe DataSourceVpcConfiguration)
confluenceConfiguration_serverUrl :: Lens' ConfluenceConfiguration Text
confluenceConfiguration_secretArn :: Lens' ConfluenceConfiguration Text
confluenceConfiguration_version :: Lens' ConfluenceConfiguration ConfluenceVersion
data ConfluencePageConfiguration = ConfluencePageConfiguration' {
- pageFieldMappings :: Maybe (NonEmpty ConfluencePageToIndexFieldMapping)
}
newConfluencePageConfiguration :: ConfluencePageConfiguration
confluencePageConfiguration_pageFieldMappings :: Lens' ConfluencePageConfiguration (Maybe (NonEmpty ConfluencePageToIndexFieldMapping))
data ConfluencePageToIndexFieldMapping = ConfluencePageToIndexFieldMapping' {
- dataSourceFieldName :: Maybe ConfluencePageFieldName
- dateFieldFormat :: Maybe Text
- indexFieldName :: Maybe Text
}
newConfluencePageToIndexFieldMapping :: ConfluencePageToIndexFieldMapping
confluencePageToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluencePageToIndexFieldMapping (Maybe ConfluencePageFieldName)
confluencePageToIndexFieldMapping_dateFieldFormat :: Lens' ConfluencePageToIndexFieldMapping (Maybe Text)
confluencePageToIndexFieldMapping_indexFieldName :: Lens' ConfluencePageToIndexFieldMapping (Maybe Text)
data ConfluenceSpaceConfiguration = ConfluenceSpaceConfiguration' {
- crawlArchivedSpaces :: Maybe Bool
- crawlPersonalSpaces :: Maybe Bool
- excludeSpaces :: Maybe (NonEmpty Text)
- includeSpaces :: Maybe (NonEmpty Text)
- spaceFieldMappings :: Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping)
}
newConfluenceSpaceConfiguration :: ConfluenceSpaceConfiguration
confluenceSpaceConfiguration_crawlArchivedSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe Bool)
confluenceSpaceConfiguration_crawlPersonalSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe Bool)
confluenceSpaceConfiguration_excludeSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty Text))
confluenceSpaceConfiguration_includeSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty Text))
confluenceSpaceConfiguration_spaceFieldMappings :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping))
data ConfluenceSpaceToIndexFieldMapping = ConfluenceSpaceToIndexFieldMapping' {
- dataSourceFieldName :: Maybe ConfluenceSpaceFieldName
- dateFieldFormat :: Maybe Text
- indexFieldName :: Maybe Text
}
newConfluenceSpaceToIndexFieldMapping :: ConfluenceSpaceToIndexFieldMapping
confluenceSpaceToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceSpaceToIndexFieldMapping (Maybe ConfluenceSpaceFieldName)
confluenceSpaceToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceSpaceToIndexFieldMapping (Maybe Text)
confluenceSpaceToIndexFieldMapping_indexFieldName :: Lens' ConfluenceSpaceToIndexFieldMapping (Maybe Text)
data ConnectionConfiguration = ConnectionConfiguration' {
- databaseHost :: Text
- databasePort :: Natural
- databaseName :: Text
- tableName :: Text
- secretArn :: Text
}
newConnectionConfiguration :: Text -> Natural -> Text -> Text -> Text -> ConnectionConfiguration
connectionConfiguration_databaseHost :: Lens' ConnectionConfiguration Text
connectionConfiguration_databasePort :: Lens' ConnectionConfiguration Natural
connectionConfiguration_databaseName :: Lens' ConnectionConfiguration Text
connectionConfiguration_tableName :: Lens' ConnectionConfiguration Text
connectionConfiguration_secretArn :: Lens' ConnectionConfiguration Text
data ContentSourceConfiguration = ContentSourceConfiguration' {
- dataSourceIds :: Maybe (NonEmpty Text)
- directPutContent :: Maybe Bool
- faqIds :: Maybe (NonEmpty Text)
}
newContentSourceConfiguration :: ContentSourceConfiguration
contentSourceConfiguration_dataSourceIds :: Lens' ContentSourceConfiguration (Maybe (NonEmpty Text))
contentSourceConfiguration_directPutContent :: Lens' ContentSourceConfiguration (Maybe Bool)
contentSourceConfiguration_faqIds :: Lens' ContentSourceConfiguration (Maybe (NonEmpty Text))
data Correction = Correction' {
- beginOffset :: Maybe Int
- correctedTerm :: Maybe Text
- endOffset :: Maybe Int
- term :: Maybe Text
}
newCorrection :: Correction
correction_beginOffset :: Lens' Correction (Maybe Int)
correction_correctedTerm :: Lens' Correction (Maybe Text)
correction_endOffset :: Lens' Correction (Maybe Int)
correction_term :: Lens' Correction (Maybe Text)
data CustomDocumentEnrichmentConfiguration = CustomDocumentEnrichmentConfiguration' {
- inlineConfigurations :: Maybe [InlineCustomDocumentEnrichmentConfiguration]
- postExtractionHookConfiguration :: Maybe HookConfiguration
- preExtractionHookConfiguration :: Maybe HookConfiguration
- roleArn :: Maybe Text
}
newCustomDocumentEnrichmentConfiguration :: CustomDocumentEnrichmentConfiguration
customDocumentEnrichmentConfiguration_inlineConfigurations :: Lens' CustomDocumentEnrichmentConfiguration (Maybe [InlineCustomDocumentEnrichmentConfiguration])
customDocumentEnrichmentConfiguration_postExtractionHookConfiguration :: Lens' CustomDocumentEnrichmentConfiguration (Maybe HookConfiguration)
customDocumentEnrichmentConfiguration_preExtractionHookConfiguration :: Lens' CustomDocumentEnrichmentConfiguration (Maybe HookConfiguration)
customDocumentEnrichmentConfiguration_roleArn :: Lens' CustomDocumentEnrichmentConfiguration (Maybe Text)
data DataSourceConfiguration = DataSourceConfiguration' {
- alfrescoConfiguration :: Maybe AlfrescoConfiguration
- boxConfiguration :: Maybe BoxConfiguration
- confluenceConfiguration :: Maybe ConfluenceConfiguration
- databaseConfiguration :: Maybe DatabaseConfiguration
- fsxConfiguration :: Maybe FsxConfiguration
- gitHubConfiguration :: Maybe GitHubConfiguration
- googleDriveConfiguration :: Maybe GoogleDriveConfiguration
- jiraConfiguration :: Maybe JiraConfiguration
- oneDriveConfiguration :: Maybe OneDriveConfiguration
- quipConfiguration :: Maybe QuipConfiguration
- s3Configuration :: Maybe S3DataSourceConfiguration
- salesforceConfiguration :: Maybe SalesforceConfiguration
- serviceNowConfiguration :: Maybe ServiceNowConfiguration
- sharePointConfiguration :: Maybe SharePointConfiguration
- slackConfiguration :: Maybe SlackConfiguration
- templateConfiguration :: Maybe TemplateConfiguration
- webCrawlerConfiguration :: Maybe WebCrawlerConfiguration
- workDocsConfiguration :: Maybe WorkDocsConfiguration
}
newDataSourceConfiguration :: DataSourceConfiguration
dataSourceConfiguration_alfrescoConfiguration :: Lens' DataSourceConfiguration (Maybe AlfrescoConfiguration)
dataSourceConfiguration_boxConfiguration :: Lens' DataSourceConfiguration (Maybe BoxConfiguration)
dataSourceConfiguration_confluenceConfiguration :: Lens' DataSourceConfiguration (Maybe ConfluenceConfiguration)
dataSourceConfiguration_databaseConfiguration :: Lens' DataSourceConfiguration (Maybe DatabaseConfiguration)
dataSourceConfiguration_fsxConfiguration :: Lens' DataSourceConfiguration (Maybe FsxConfiguration)
dataSourceConfiguration_gitHubConfiguration :: Lens' DataSourceConfiguration (Maybe GitHubConfiguration)
dataSourceConfiguration_googleDriveConfiguration :: Lens' DataSourceConfiguration (Maybe GoogleDriveConfiguration)
dataSourceConfiguration_jiraConfiguration :: Lens' DataSourceConfiguration (Maybe JiraConfiguration)
dataSourceConfiguration_oneDriveConfiguration :: Lens' DataSourceConfiguration (Maybe OneDriveConfiguration)
dataSourceConfiguration_quipConfiguration :: Lens' DataSourceConfiguration (Maybe QuipConfiguration)
dataSourceConfiguration_s3Configuration :: Lens' DataSourceConfiguration (Maybe S3DataSourceConfiguration)
dataSourceConfiguration_salesforceConfiguration :: Lens' DataSourceConfiguration (Maybe SalesforceConfiguration)
dataSourceConfiguration_serviceNowConfiguration :: Lens' DataSourceConfiguration (Maybe ServiceNowConfiguration)
dataSourceConfiguration_sharePointConfiguration :: Lens' DataSourceConfiguration (Maybe SharePointConfiguration)
dataSourceConfiguration_slackConfiguration :: Lens' DataSourceConfiguration (Maybe SlackConfiguration)
dataSourceConfiguration_templateConfiguration :: Lens' DataSourceConfiguration (Maybe TemplateConfiguration)
dataSourceConfiguration_webCrawlerConfiguration :: Lens' DataSourceConfiguration (Maybe WebCrawlerConfiguration)
dataSourceConfiguration_workDocsConfiguration :: Lens' DataSourceConfiguration (Maybe WorkDocsConfiguration)
data DataSourceGroup = DataSourceGroup' {
- groupId :: Text
- dataSourceId :: Text
}
newDataSourceGroup :: Text -> Text -> DataSourceGroup
dataSourceGroup_groupId :: Lens' DataSourceGroup Text
dataSourceGroup_dataSourceId :: Lens' DataSourceGroup Text
data DataSourceSummary = DataSourceSummary' {
- createdAt :: Maybe POSIX
- id :: Maybe Text
- languageCode :: Maybe Text
- name :: Maybe Text
- status :: Maybe DataSourceStatus
- type' :: Maybe DataSourceType
- updatedAt :: Maybe POSIX
}
newDataSourceSummary :: DataSourceSummary
dataSourceSummary_createdAt :: Lens' DataSourceSummary (Maybe UTCTime)
dataSourceSummary_id :: Lens' DataSourceSummary (Maybe Text)
dataSourceSummary_languageCode :: Lens' DataSourceSummary (Maybe Text)
dataSourceSummary_name :: Lens' DataSourceSummary (Maybe Text)
dataSourceSummary_status :: Lens' DataSourceSummary (Maybe DataSourceStatus)
dataSourceSummary_type :: Lens' DataSourceSummary (Maybe DataSourceType)
dataSourceSummary_updatedAt :: Lens' DataSourceSummary (Maybe UTCTime)
data DataSourceSyncJob = DataSourceSyncJob' {
- dataSourceErrorCode :: Maybe Text
- endTime :: Maybe POSIX
- errorCode :: Maybe ErrorCode
- errorMessage :: Maybe Text
- executionId :: Maybe Text
- metrics :: Maybe DataSourceSyncJobMetrics
- startTime :: Maybe POSIX
- status :: Maybe DataSourceSyncJobStatus
}
newDataSourceSyncJob :: DataSourceSyncJob
dataSourceSyncJob_dataSourceErrorCode :: Lens' DataSourceSyncJob (Maybe Text)
dataSourceSyncJob_endTime :: Lens' DataSourceSyncJob (Maybe UTCTime)
dataSourceSyncJob_errorCode :: Lens' DataSourceSyncJob (Maybe ErrorCode)
dataSourceSyncJob_errorMessage :: Lens' DataSourceSyncJob (Maybe Text)
dataSourceSyncJob_executionId :: Lens' DataSourceSyncJob (Maybe Text)
dataSourceSyncJob_metrics :: Lens' DataSourceSyncJob (Maybe DataSourceSyncJobMetrics)
dataSourceSyncJob_startTime :: Lens' DataSourceSyncJob (Maybe UTCTime)
dataSourceSyncJob_status :: Lens' DataSourceSyncJob (Maybe DataSourceSyncJobStatus)
data DataSourceSyncJobMetricTarget = DataSourceSyncJobMetricTarget' {
- dataSourceSyncJobId :: Maybe Text
- dataSourceId :: Text
}
newDataSourceSyncJobMetricTarget :: Text -> DataSourceSyncJobMetricTarget
dataSourceSyncJobMetricTarget_dataSourceSyncJobId :: Lens' DataSourceSyncJobMetricTarget (Maybe Text)
dataSourceSyncJobMetricTarget_dataSourceId :: Lens' DataSourceSyncJobMetricTarget Text
data DataSourceSyncJobMetrics = DataSourceSyncJobMetrics' {
- documentsAdded :: Maybe Text
- documentsDeleted :: Maybe Text
- documentsFailed :: Maybe Text
- documentsModified :: Maybe Text
- documentsScanned :: Maybe Text
}
newDataSourceSyncJobMetrics :: DataSourceSyncJobMetrics
dataSourceSyncJobMetrics_documentsAdded :: Lens' DataSourceSyncJobMetrics (Maybe Text)
dataSourceSyncJobMetrics_documentsDeleted :: Lens' DataSourceSyncJobMetrics (Maybe Text)
dataSourceSyncJobMetrics_documentsFailed :: Lens' DataSourceSyncJobMetrics (Maybe Text)
dataSourceSyncJobMetrics_documentsModified :: Lens' DataSourceSyncJobMetrics (Maybe Text)
dataSourceSyncJobMetrics_documentsScanned :: Lens' DataSourceSyncJobMetrics (Maybe Text)
data DataSourceToIndexFieldMapping = DataSourceToIndexFieldMapping' {
- dateFieldFormat :: Maybe Text
- dataSourceFieldName :: Text
- indexFieldName :: Text
}
newDataSourceToIndexFieldMapping :: Text -> Text -> DataSourceToIndexFieldMapping
dataSourceToIndexFieldMapping_dateFieldFormat :: Lens' DataSourceToIndexFieldMapping (Maybe Text)
dataSourceToIndexFieldMapping_dataSourceFieldName :: Lens' DataSourceToIndexFieldMapping Text
dataSourceToIndexFieldMapping_indexFieldName :: Lens' DataSourceToIndexFieldMapping Text
data DataSourceVpcConfiguration = DataSourceVpcConfiguration' {
- subnetIds :: NonEmpty Text
- securityGroupIds :: NonEmpty Text
}
newDataSourceVpcConfiguration :: NonEmpty Text -> NonEmpty Text -> DataSourceVpcConfiguration
dataSourceVpcConfiguration_subnetIds :: Lens' DataSourceVpcConfiguration (NonEmpty Text)
dataSourceVpcConfiguration_securityGroupIds :: Lens' DataSourceVpcConfiguration (NonEmpty Text)
data DatabaseConfiguration = DatabaseConfiguration' {
- aclConfiguration :: Maybe AclConfiguration
- sqlConfiguration :: Maybe SqlConfiguration
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- databaseEngineType :: DatabaseEngineType
- connectionConfiguration :: ConnectionConfiguration
- columnConfiguration :: ColumnConfiguration
}
newDatabaseConfiguration :: DatabaseEngineType -> ConnectionConfiguration -> ColumnConfiguration -> DatabaseConfiguration
databaseConfiguration_aclConfiguration :: Lens' DatabaseConfiguration (Maybe AclConfiguration)
databaseConfiguration_sqlConfiguration :: Lens' DatabaseConfiguration (Maybe SqlConfiguration)
databaseConfiguration_vpcConfiguration :: Lens' DatabaseConfiguration (Maybe DataSourceVpcConfiguration)
databaseConfiguration_databaseEngineType :: Lens' DatabaseConfiguration DatabaseEngineType
databaseConfiguration_connectionConfiguration :: Lens' DatabaseConfiguration ConnectionConfiguration
databaseConfiguration_columnConfiguration :: Lens' DatabaseConfiguration ColumnConfiguration
data Document = Document' {
- accessControlConfigurationId :: Maybe Text
- accessControlList :: Maybe [Principal]
- attributes :: Maybe [DocumentAttribute]
- blob :: Maybe Base64
- contentType :: Maybe ContentType
- hierarchicalAccessControlList :: Maybe (NonEmpty HierarchicalPrincipal)
- s3Path :: Maybe S3Path
- title :: Maybe Text
- id :: Text
}
newDocument :: Text -> Document
document_accessControlConfigurationId :: Lens' Document (Maybe Text)
document_accessControlList :: Lens' Document (Maybe [Principal])
document_attributes :: Lens' Document (Maybe [DocumentAttribute])
document_blob :: Lens' Document (Maybe ByteString)
document_contentType :: Lens' Document (Maybe ContentType)
document_hierarchicalAccessControlList :: Lens' Document (Maybe (NonEmpty HierarchicalPrincipal))
document_s3Path :: Lens' Document (Maybe S3Path)
document_title :: Lens' Document (Maybe Text)
document_id :: Lens' Document Text
data DocumentAttribute = DocumentAttribute' {
- key :: Text
- value :: DocumentAttributeValue
}
newDocumentAttribute :: Text -> DocumentAttributeValue -> DocumentAttribute
documentAttribute_key :: Lens' DocumentAttribute Text
documentAttribute_value :: Lens' DocumentAttribute DocumentAttributeValue
data DocumentAttributeCondition = DocumentAttributeCondition' {
- conditionOnValue :: Maybe DocumentAttributeValue
- conditionDocumentAttributeKey :: Text
- operator :: ConditionOperator
}
newDocumentAttributeCondition :: Text -> ConditionOperator -> DocumentAttributeCondition
documentAttributeCondition_conditionOnValue :: Lens' DocumentAttributeCondition (Maybe DocumentAttributeValue)
documentAttributeCondition_conditionDocumentAttributeKey :: Lens' DocumentAttributeCondition Text
documentAttributeCondition_operator :: Lens' DocumentAttributeCondition ConditionOperator
data DocumentAttributeTarget = DocumentAttributeTarget' {
- targetDocumentAttributeKey :: Maybe Text
- targetDocumentAttributeValue :: Maybe DocumentAttributeValue
- targetDocumentAttributeValueDeletion :: Maybe Bool
}
newDocumentAttributeTarget :: DocumentAttributeTarget
documentAttributeTarget_targetDocumentAttributeKey :: Lens' DocumentAttributeTarget (Maybe Text)
documentAttributeTarget_targetDocumentAttributeValue :: Lens' DocumentAttributeTarget (Maybe DocumentAttributeValue)
documentAttributeTarget_targetDocumentAttributeValueDeletion :: Lens' DocumentAttributeTarget (Maybe Bool)
data DocumentAttributeValue = DocumentAttributeValue' {
- dateValue :: Maybe POSIX
- longValue :: Maybe Integer
- stringListValue :: Maybe [Text]
- stringValue :: Maybe Text
}
newDocumentAttributeValue :: DocumentAttributeValue
documentAttributeValue_dateValue :: Lens' DocumentAttributeValue (Maybe UTCTime)
documentAttributeValue_longValue :: Lens' DocumentAttributeValue (Maybe Integer)
documentAttributeValue_stringListValue :: Lens' DocumentAttributeValue (Maybe [Text])
documentAttributeValue_stringValue :: Lens' DocumentAttributeValue (Maybe Text)
data DocumentAttributeValueCountPair = DocumentAttributeValueCountPair' {
- count :: Maybe Int
- documentAttributeValue :: Maybe DocumentAttributeValue
- facetResults :: Maybe [FacetResult]
}
newDocumentAttributeValueCountPair :: DocumentAttributeValueCountPair
documentAttributeValueCountPair_count :: Lens' DocumentAttributeValueCountPair (Maybe Int)
documentAttributeValueCountPair_documentAttributeValue :: Lens' DocumentAttributeValueCountPair (Maybe DocumentAttributeValue)
documentAttributeValueCountPair_facetResults :: Lens' DocumentAttributeValueCountPair (Maybe [FacetResult])
data DocumentInfo = DocumentInfo' {
- attributes :: Maybe [DocumentAttribute]
- documentId :: Text
}
newDocumentInfo :: Text -> DocumentInfo
documentInfo_attributes :: Lens' DocumentInfo (Maybe [DocumentAttribute])
documentInfo_documentId :: Lens' DocumentInfo Text
data DocumentMetadataConfiguration = DocumentMetadataConfiguration' {
- relevance :: Maybe Relevance
- search :: Maybe Search
- name :: Text
- type' :: DocumentAttributeValueType
}
newDocumentMetadataConfiguration :: Text -> DocumentAttributeValueType -> DocumentMetadataConfiguration
documentMetadataConfiguration_relevance :: Lens' DocumentMetadataConfiguration (Maybe Relevance)
documentMetadataConfiguration_search :: Lens' DocumentMetadataConfiguration (Maybe Search)
documentMetadataConfiguration_name :: Lens' DocumentMetadataConfiguration Text
documentMetadataConfiguration_type :: Lens' DocumentMetadataConfiguration DocumentAttributeValueType
data DocumentRelevanceConfiguration = DocumentRelevanceConfiguration' {
- name :: Text
- relevance :: Relevance
}
newDocumentRelevanceConfiguration :: Text -> Relevance -> DocumentRelevanceConfiguration
documentRelevanceConfiguration_name :: Lens' DocumentRelevanceConfiguration Text
documentRelevanceConfiguration_relevance :: Lens' DocumentRelevanceConfiguration Relevance
data DocumentsMetadataConfiguration = DocumentsMetadataConfiguration' {
- s3Prefix :: Maybe Text
}
newDocumentsMetadataConfiguration :: DocumentsMetadataConfiguration
documentsMetadataConfiguration_s3Prefix :: Lens' DocumentsMetadataConfiguration (Maybe Text)
data EntityConfiguration = EntityConfiguration' {
- entityId :: Text
- entityType :: EntityType
}
newEntityConfiguration :: Text -> EntityType -> EntityConfiguration
entityConfiguration_entityId :: Lens' EntityConfiguration Text
entityConfiguration_entityType :: Lens' EntityConfiguration EntityType
data EntityDisplayData = EntityDisplayData' {
- firstName :: Maybe (Sensitive Text)
- groupName :: Maybe (Sensitive Text)
- identifiedUserName :: Maybe (Sensitive Text)
- lastName :: Maybe (Sensitive Text)
- userName :: Maybe (Sensitive Text)
}
newEntityDisplayData :: EntityDisplayData
entityDisplayData_firstName :: Lens' EntityDisplayData (Maybe Text)
entityDisplayData_groupName :: Lens' EntityDisplayData (Maybe Text)
entityDisplayData_identifiedUserName :: Lens' EntityDisplayData (Maybe Text)
entityDisplayData_lastName :: Lens' EntityDisplayData (Maybe Text)
entityDisplayData_userName :: Lens' EntityDisplayData (Maybe Text)
data EntityPersonaConfiguration = EntityPersonaConfiguration' {
- entityId :: Text
- persona :: Persona
}
newEntityPersonaConfiguration :: Text -> Persona -> EntityPersonaConfiguration
entityPersonaConfiguration_entityId :: Lens' EntityPersonaConfiguration Text
entityPersonaConfiguration_persona :: Lens' EntityPersonaConfiguration Persona
data ExperienceConfiguration = ExperienceConfiguration' {
- contentSourceConfiguration :: Maybe ContentSourceConfiguration
- userIdentityConfiguration :: Maybe UserIdentityConfiguration
}
newExperienceConfiguration :: ExperienceConfiguration
experienceConfiguration_contentSourceConfiguration :: Lens' ExperienceConfiguration (Maybe ContentSourceConfiguration)
experienceConfiguration_userIdentityConfiguration :: Lens' ExperienceConfiguration (Maybe UserIdentityConfiguration)
data ExperienceEndpoint = ExperienceEndpoint' {
- endpoint :: Maybe Text
- endpointType :: Maybe EndpointType
}
newExperienceEndpoint :: ExperienceEndpoint
experienceEndpoint_endpoint :: Lens' ExperienceEndpoint (Maybe Text)
experienceEndpoint_endpointType :: Lens' ExperienceEndpoint (Maybe EndpointType)
data ExperienceEntitiesSummary = ExperienceEntitiesSummary' {
- displayData :: Maybe EntityDisplayData
- entityId :: Maybe Text
- entityType :: Maybe EntityType
}
newExperienceEntitiesSummary :: ExperienceEntitiesSummary
experienceEntitiesSummary_displayData :: Lens' ExperienceEntitiesSummary (Maybe EntityDisplayData)
experienceEntitiesSummary_entityId :: Lens' ExperienceEntitiesSummary (Maybe Text)
experienceEntitiesSummary_entityType :: Lens' ExperienceEntitiesSummary (Maybe EntityType)
data ExperiencesSummary = ExperiencesSummary' {
- createdAt :: Maybe POSIX
- endpoints :: Maybe (NonEmpty ExperienceEndpoint)
- id :: Maybe Text
- name :: Maybe Text
- status :: Maybe ExperienceStatus
}
newExperiencesSummary :: ExperiencesSummary
experiencesSummary_createdAt :: Lens' ExperiencesSummary (Maybe UTCTime)
experiencesSummary_endpoints :: Lens' ExperiencesSummary (Maybe (NonEmpty ExperienceEndpoint))
experiencesSummary_id :: Lens' ExperiencesSummary (Maybe Text)
experiencesSummary_name :: Lens' ExperiencesSummary (Maybe Text)
experiencesSummary_status :: Lens' ExperiencesSummary (Maybe ExperienceStatus)
data Facet = Facet' {
- documentAttributeKey :: Maybe Text
- facets :: Maybe [Facet]
- maxResults :: Maybe Natural
}
newFacet :: Facet
facet_documentAttributeKey :: Lens' Facet (Maybe Text)
facet_facets :: Lens' Facet (Maybe [Facet])
facet_maxResults :: Lens' Facet (Maybe Natural)
data FacetResult = FacetResult' {
- documentAttributeKey :: Maybe Text
- documentAttributeValueCountPairs :: Maybe [DocumentAttributeValueCountPair]
- documentAttributeValueType :: Maybe DocumentAttributeValueType
}
newFacetResult :: FacetResult
facetResult_documentAttributeKey :: Lens' FacetResult (Maybe Text)
facetResult_documentAttributeValueCountPairs :: Lens' FacetResult (Maybe [DocumentAttributeValueCountPair])
facetResult_documentAttributeValueType :: Lens' FacetResult (Maybe DocumentAttributeValueType)
data FailedEntity = FailedEntity' {
- entityId :: Maybe Text
- errorMessage :: Maybe Text
}
newFailedEntity :: FailedEntity
failedEntity_entityId :: Lens' FailedEntity (Maybe Text)
failedEntity_errorMessage :: Lens' FailedEntity (Maybe Text)
data FaqStatistics = FaqStatistics' {
- indexedQuestionAnswersCount :: Natural
}
newFaqStatistics :: Natural -> FaqStatistics
faqStatistics_indexedQuestionAnswersCount :: Lens' FaqStatistics Natural
data FaqSummary = FaqSummary' {
- createdAt :: Maybe POSIX
- fileFormat :: Maybe FaqFileFormat
- id :: Maybe Text
- languageCode :: Maybe Text
- name :: Maybe Text
- status :: Maybe FaqStatus
- updatedAt :: Maybe POSIX
}
newFaqSummary :: FaqSummary
faqSummary_createdAt :: Lens' FaqSummary (Maybe UTCTime)
faqSummary_fileFormat :: Lens' FaqSummary (Maybe FaqFileFormat)
faqSummary_id :: Lens' FaqSummary (Maybe Text)
faqSummary_languageCode :: Lens' FaqSummary (Maybe Text)
faqSummary_name :: Lens' FaqSummary (Maybe Text)
faqSummary_status :: Lens' FaqSummary (Maybe FaqStatus)
faqSummary_updatedAt :: Lens' FaqSummary (Maybe UTCTime)
data FsxConfiguration = FsxConfiguration' {
- exclusionPatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionPatterns :: Maybe [Text]
- secretArn :: Maybe Text
- fileSystemId :: Text
- fileSystemType :: FsxFileSystemType
- vpcConfiguration :: DataSourceVpcConfiguration
}
newFsxConfiguration :: Text -> FsxFileSystemType -> DataSourceVpcConfiguration -> FsxConfiguration
fsxConfiguration_exclusionPatterns :: Lens' FsxConfiguration (Maybe [Text])
fsxConfiguration_fieldMappings :: Lens' FsxConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
fsxConfiguration_inclusionPatterns :: Lens' FsxConfiguration (Maybe [Text])
fsxConfiguration_secretArn :: Lens' FsxConfiguration (Maybe Text)
fsxConfiguration_fileSystemId :: Lens' FsxConfiguration Text
fsxConfiguration_fileSystemType :: Lens' FsxConfiguration FsxFileSystemType
fsxConfiguration_vpcConfiguration :: Lens' FsxConfiguration DataSourceVpcConfiguration
data GitHubConfiguration = GitHubConfiguration' {
- exclusionFileNamePatterns :: Maybe [Text]
- exclusionFileTypePatterns :: Maybe [Text]
- exclusionFolderNamePatterns :: Maybe [Text]
- gitHubCommitConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- gitHubDocumentCrawlProperties :: Maybe GitHubDocumentCrawlProperties
- gitHubIssueAttachmentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- gitHubIssueCommentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- gitHubIssueDocumentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- gitHubPullRequestCommentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- gitHubPullRequestDocumentAttachmentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- gitHubPullRequestDocumentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- gitHubRepositoryConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionFileNamePatterns :: Maybe [Text]
- inclusionFileTypePatterns :: Maybe [Text]
- inclusionFolderNamePatterns :: Maybe [Text]
- onPremiseConfiguration :: Maybe OnPremiseConfiguration
- repositoryFilter :: Maybe [Text]
- saaSConfiguration :: Maybe SaaSConfiguration
- type' :: Maybe Type
- useChangeLog :: Maybe Bool
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- secretArn :: Text
}
newGitHubConfiguration :: Text -> GitHubConfiguration
gitHubConfiguration_exclusionFileNamePatterns :: Lens' GitHubConfiguration (Maybe [Text])
gitHubConfiguration_exclusionFileTypePatterns :: Lens' GitHubConfiguration (Maybe [Text])
gitHubConfiguration_exclusionFolderNamePatterns :: Lens' GitHubConfiguration (Maybe [Text])
gitHubConfiguration_gitHubCommitConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
gitHubConfiguration_gitHubDocumentCrawlProperties :: Lens' GitHubConfiguration (Maybe GitHubDocumentCrawlProperties)
gitHubConfiguration_gitHubIssueAttachmentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
gitHubConfiguration_gitHubIssueCommentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
gitHubConfiguration_gitHubIssueDocumentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
gitHubConfiguration_gitHubPullRequestCommentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
gitHubConfiguration_gitHubPullRequestDocumentAttachmentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
gitHubConfiguration_gitHubPullRequestDocumentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
gitHubConfiguration_gitHubRepositoryConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
gitHubConfiguration_inclusionFileNamePatterns :: Lens' GitHubConfiguration (Maybe [Text])
gitHubConfiguration_inclusionFileTypePatterns :: Lens' GitHubConfiguration (Maybe [Text])
gitHubConfiguration_inclusionFolderNamePatterns :: Lens' GitHubConfiguration (Maybe [Text])
gitHubConfiguration_onPremiseConfiguration :: Lens' GitHubConfiguration (Maybe OnPremiseConfiguration)
gitHubConfiguration_repositoryFilter :: Lens' GitHubConfiguration (Maybe [Text])
gitHubConfiguration_saaSConfiguration :: Lens' GitHubConfiguration (Maybe SaaSConfiguration)
gitHubConfiguration_type :: Lens' GitHubConfiguration (Maybe Type)
gitHubConfiguration_useChangeLog :: Lens' GitHubConfiguration (Maybe Bool)
gitHubConfiguration_vpcConfiguration :: Lens' GitHubConfiguration (Maybe DataSourceVpcConfiguration)
gitHubConfiguration_secretArn :: Lens' GitHubConfiguration Text
data GitHubDocumentCrawlProperties = GitHubDocumentCrawlProperties' {
- crawlIssue :: Maybe Bool
- crawlIssueComment :: Maybe Bool
- crawlIssueCommentAttachment :: Maybe Bool
- crawlPullRequest :: Maybe Bool
- crawlPullRequestComment :: Maybe Bool
- crawlPullRequestCommentAttachment :: Maybe Bool
- crawlRepositoryDocuments :: Maybe Bool
}
newGitHubDocumentCrawlProperties :: GitHubDocumentCrawlProperties
gitHubDocumentCrawlProperties_crawlIssue :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)
gitHubDocumentCrawlProperties_crawlIssueComment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)
gitHubDocumentCrawlProperties_crawlIssueCommentAttachment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)
gitHubDocumentCrawlProperties_crawlPullRequest :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)
gitHubDocumentCrawlProperties_crawlPullRequestComment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)
gitHubDocumentCrawlProperties_crawlPullRequestCommentAttachment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)
gitHubDocumentCrawlProperties_crawlRepositoryDocuments :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)
data GoogleDriveConfiguration = GoogleDriveConfiguration' {
- excludeMimeTypes :: Maybe [Text]
- excludeSharedDrives :: Maybe [Text]
- excludeUserAccounts :: Maybe [Text]
- exclusionPatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionPatterns :: Maybe [Text]
- secretArn :: Text
}
newGoogleDriveConfiguration :: Text -> GoogleDriveConfiguration
googleDriveConfiguration_excludeMimeTypes :: Lens' GoogleDriveConfiguration (Maybe [Text])
googleDriveConfiguration_excludeSharedDrives :: Lens' GoogleDriveConfiguration (Maybe [Text])
googleDriveConfiguration_excludeUserAccounts :: Lens' GoogleDriveConfiguration (Maybe [Text])
googleDriveConfiguration_exclusionPatterns :: Lens' GoogleDriveConfiguration (Maybe [Text])
googleDriveConfiguration_fieldMappings :: Lens' GoogleDriveConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
googleDriveConfiguration_inclusionPatterns :: Lens' GoogleDriveConfiguration (Maybe [Text])
googleDriveConfiguration_secretArn :: Lens' GoogleDriveConfiguration Text
data GroupMembers = GroupMembers' {
- memberGroups :: Maybe (NonEmpty MemberGroup)
- memberUsers :: Maybe (NonEmpty MemberUser)
- s3PathforGroupMembers :: Maybe S3Path
}
newGroupMembers :: GroupMembers
groupMembers_memberGroups :: Lens' GroupMembers (Maybe (NonEmpty MemberGroup))
groupMembers_memberUsers :: Lens' GroupMembers (Maybe (NonEmpty MemberUser))
groupMembers_s3PathforGroupMembers :: Lens' GroupMembers (Maybe S3Path)
data GroupOrderingIdSummary = GroupOrderingIdSummary' {
- failureReason :: Maybe Text
- lastUpdatedAt :: Maybe POSIX
- orderingId :: Maybe Natural
- receivedAt :: Maybe POSIX
- status :: Maybe PrincipalMappingStatus
}
newGroupOrderingIdSummary :: GroupOrderingIdSummary
groupOrderingIdSummary_failureReason :: Lens' GroupOrderingIdSummary (Maybe Text)
groupOrderingIdSummary_lastUpdatedAt :: Lens' GroupOrderingIdSummary (Maybe UTCTime)
groupOrderingIdSummary_orderingId :: Lens' GroupOrderingIdSummary (Maybe Natural)
groupOrderingIdSummary_receivedAt :: Lens' GroupOrderingIdSummary (Maybe UTCTime)
groupOrderingIdSummary_status :: Lens' GroupOrderingIdSummary (Maybe PrincipalMappingStatus)
data GroupSummary = GroupSummary' {
- groupId :: Maybe Text
- orderingId :: Maybe Natural
}
newGroupSummary :: GroupSummary
groupSummary_groupId :: Lens' GroupSummary (Maybe Text)
groupSummary_orderingId :: Lens' GroupSummary (Maybe Natural)
data HierarchicalPrincipal = HierarchicalPrincipal' {
- principalList :: [Principal]
}
newHierarchicalPrincipal :: HierarchicalPrincipal
hierarchicalPrincipal_principalList :: Lens' HierarchicalPrincipal [Principal]
data Highlight = Highlight' {
- topAnswer :: Maybe Bool
- type' :: Maybe HighlightType
- beginOffset :: Int
- endOffset :: Int
}
newHighlight :: Int -> Int -> Highlight
highlight_topAnswer :: Lens' Highlight (Maybe Bool)
highlight_type :: Lens' Highlight (Maybe HighlightType)
highlight_beginOffset :: Lens' Highlight Int
highlight_endOffset :: Lens' Highlight Int
data HookConfiguration = HookConfiguration' {
- invocationCondition :: Maybe DocumentAttributeCondition
- lambdaArn :: Text
- s3Bucket :: Text
}
newHookConfiguration :: Text -> Text -> HookConfiguration
hookConfiguration_invocationCondition :: Lens' HookConfiguration (Maybe DocumentAttributeCondition)
hookConfiguration_lambdaArn :: Lens' HookConfiguration Text
hookConfiguration_s3Bucket :: Lens' HookConfiguration Text
data IndexConfigurationSummary = IndexConfigurationSummary' {
- edition :: Maybe IndexEdition
- id :: Maybe Text
- name :: Maybe Text
- createdAt :: POSIX
- updatedAt :: POSIX
- status :: IndexStatus
}
newIndexConfigurationSummary :: UTCTime -> UTCTime -> IndexStatus -> IndexConfigurationSummary
indexConfigurationSummary_edition :: Lens' IndexConfigurationSummary (Maybe IndexEdition)
indexConfigurationSummary_id :: Lens' IndexConfigurationSummary (Maybe Text)
indexConfigurationSummary_name :: Lens' IndexConfigurationSummary (Maybe Text)
indexConfigurationSummary_createdAt :: Lens' IndexConfigurationSummary UTCTime
indexConfigurationSummary_updatedAt :: Lens' IndexConfigurationSummary UTCTime
indexConfigurationSummary_status :: Lens' IndexConfigurationSummary IndexStatus
data IndexStatistics = IndexStatistics' {
- faqStatistics :: FaqStatistics
- textDocumentStatistics :: TextDocumentStatistics
}
newIndexStatistics :: FaqStatistics -> TextDocumentStatistics -> IndexStatistics
indexStatistics_faqStatistics :: Lens' IndexStatistics FaqStatistics
indexStatistics_textDocumentStatistics :: Lens' IndexStatistics TextDocumentStatistics
data InlineCustomDocumentEnrichmentConfiguration = InlineCustomDocumentEnrichmentConfiguration' {
- condition :: Maybe DocumentAttributeCondition
- documentContentDeletion :: Maybe Bool
- target :: Maybe DocumentAttributeTarget
}
newInlineCustomDocumentEnrichmentConfiguration :: InlineCustomDocumentEnrichmentConfiguration
inlineCustomDocumentEnrichmentConfiguration_condition :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe DocumentAttributeCondition)
inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe Bool)
inlineCustomDocumentEnrichmentConfiguration_target :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe DocumentAttributeTarget)
data JiraConfiguration = JiraConfiguration' {
- attachmentFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- commentFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- exclusionPatterns :: Maybe [Text]
- inclusionPatterns :: Maybe [Text]
- issueFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- issueSubEntityFilter :: Maybe [IssueSubEntity]
- issueType :: Maybe [Text]
- project :: Maybe [Text]
- projectFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- status :: Maybe [Text]
- useChangeLog :: Maybe Bool
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- workLogFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- jiraAccountUrl :: Text
- secretArn :: Text
}
newJiraConfiguration :: Text -> Text -> JiraConfiguration
jiraConfiguration_attachmentFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
jiraConfiguration_commentFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
jiraConfiguration_exclusionPatterns :: Lens' JiraConfiguration (Maybe [Text])
jiraConfiguration_inclusionPatterns :: Lens' JiraConfiguration (Maybe [Text])
jiraConfiguration_issueFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
jiraConfiguration_issueSubEntityFilter :: Lens' JiraConfiguration (Maybe [IssueSubEntity])
jiraConfiguration_issueType :: Lens' JiraConfiguration (Maybe [Text])
jiraConfiguration_project :: Lens' JiraConfiguration (Maybe [Text])
jiraConfiguration_projectFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
jiraConfiguration_status :: Lens' JiraConfiguration (Maybe [Text])
jiraConfiguration_useChangeLog :: Lens' JiraConfiguration (Maybe Bool)
jiraConfiguration_vpcConfiguration :: Lens' JiraConfiguration (Maybe DataSourceVpcConfiguration)
jiraConfiguration_workLogFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
jiraConfiguration_jiraAccountUrl :: Lens' JiraConfiguration Text
jiraConfiguration_secretArn :: Lens' JiraConfiguration Text
data JsonTokenTypeConfiguration = JsonTokenTypeConfiguration' {
- userNameAttributeField :: Text
- groupAttributeField :: Text
}
newJsonTokenTypeConfiguration :: Text -> Text -> JsonTokenTypeConfiguration
jsonTokenTypeConfiguration_userNameAttributeField :: Lens' JsonTokenTypeConfiguration Text
jsonTokenTypeConfiguration_groupAttributeField :: Lens' JsonTokenTypeConfiguration Text
data JwtTokenTypeConfiguration = JwtTokenTypeConfiguration' {
- claimRegex :: Maybe Text
- groupAttributeField :: Maybe Text
- issuer :: Maybe Text
- secretManagerArn :: Maybe Text
- url :: Maybe Text
- userNameAttributeField :: Maybe Text
- keyLocation :: KeyLocation
}
newJwtTokenTypeConfiguration :: KeyLocation -> JwtTokenTypeConfiguration
jwtTokenTypeConfiguration_claimRegex :: Lens' JwtTokenTypeConfiguration (Maybe Text)
jwtTokenTypeConfiguration_groupAttributeField :: Lens' JwtTokenTypeConfiguration (Maybe Text)
jwtTokenTypeConfiguration_issuer :: Lens' JwtTokenTypeConfiguration (Maybe Text)
jwtTokenTypeConfiguration_secretManagerArn :: Lens' JwtTokenTypeConfiguration (Maybe Text)
jwtTokenTypeConfiguration_url :: Lens' JwtTokenTypeConfiguration (Maybe Text)
jwtTokenTypeConfiguration_userNameAttributeField :: Lens' JwtTokenTypeConfiguration (Maybe Text)
jwtTokenTypeConfiguration_keyLocation :: Lens' JwtTokenTypeConfiguration KeyLocation
data MemberGroup = MemberGroup' {
- dataSourceId :: Maybe Text
- groupId :: Text
}
newMemberGroup :: Text -> MemberGroup
memberGroup_dataSourceId :: Lens' MemberGroup (Maybe Text)
memberGroup_groupId :: Lens' MemberGroup Text
data MemberUser = MemberUser' {
- userId :: Text
}
newMemberUser :: Text -> MemberUser
memberUser_userId :: Lens' MemberUser Text
data OnPremiseConfiguration = OnPremiseConfiguration' {
- hostUrl :: Text
- organizationName :: Text
- sslCertificateS3Path :: S3Path
}
newOnPremiseConfiguration :: Text -> Text -> S3Path -> OnPremiseConfiguration
onPremiseConfiguration_hostUrl :: Lens' OnPremiseConfiguration Text
onPremiseConfiguration_organizationName :: Lens' OnPremiseConfiguration Text
onPremiseConfiguration_sslCertificateS3Path :: Lens' OnPremiseConfiguration S3Path
data OneDriveConfiguration = OneDriveConfiguration' {
- disableLocalGroups :: Maybe Bool
- exclusionPatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionPatterns :: Maybe [Text]
- tenantDomain :: Text
- secretArn :: Text
- oneDriveUsers :: OneDriveUsers
}
newOneDriveConfiguration :: Text -> Text -> OneDriveUsers -> OneDriveConfiguration
oneDriveConfiguration_disableLocalGroups :: Lens' OneDriveConfiguration (Maybe Bool)
oneDriveConfiguration_exclusionPatterns :: Lens' OneDriveConfiguration (Maybe [Text])
oneDriveConfiguration_fieldMappings :: Lens' OneDriveConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
oneDriveConfiguration_inclusionPatterns :: Lens' OneDriveConfiguration (Maybe [Text])
oneDriveConfiguration_tenantDomain :: Lens' OneDriveConfiguration Text
oneDriveConfiguration_secretArn :: Lens' OneDriveConfiguration Text
oneDriveConfiguration_oneDriveUsers :: Lens' OneDriveConfiguration OneDriveUsers
data OneDriveUsers = OneDriveUsers' {
- oneDriveUserList :: Maybe (NonEmpty Text)
- oneDriveUserS3Path :: Maybe S3Path
}
newOneDriveUsers :: OneDriveUsers
oneDriveUsers_oneDriveUserList :: Lens' OneDriveUsers (Maybe (NonEmpty Text))
oneDriveUsers_oneDriveUserS3Path :: Lens' OneDriveUsers (Maybe S3Path)
data PersonasSummary = PersonasSummary' {
- createdAt :: Maybe POSIX
- entityId :: Maybe Text
- persona :: Maybe Persona
- updatedAt :: Maybe POSIX
}
newPersonasSummary :: PersonasSummary
personasSummary_createdAt :: Lens' PersonasSummary (Maybe UTCTime)
personasSummary_entityId :: Lens' PersonasSummary (Maybe Text)
personasSummary_persona :: Lens' PersonasSummary (Maybe Persona)
personasSummary_updatedAt :: Lens' PersonasSummary (Maybe UTCTime)
data Principal = Principal' {
- dataSourceId :: Maybe Text
- name :: Text
- type' :: PrincipalType
- access :: ReadAccessType
}
newPrincipal :: Text -> PrincipalType -> ReadAccessType -> Principal
principal_dataSourceId :: Lens' Principal (Maybe Text)
principal_name :: Lens' Principal Text
principal_type :: Lens' Principal PrincipalType
principal_access :: Lens' Principal ReadAccessType
data ProxyConfiguration = ProxyConfiguration' {
- credentials :: Maybe Text
- host :: Text
- port :: Natural
}
newProxyConfiguration :: Text -> Natural -> ProxyConfiguration
proxyConfiguration_credentials :: Lens' ProxyConfiguration (Maybe Text)
proxyConfiguration_host :: Lens' ProxyConfiguration Text
proxyConfiguration_port :: Lens' ProxyConfiguration Natural
data QueryResultItem = QueryResultItem' {
- additionalAttributes :: Maybe [AdditionalResultAttribute]
- documentAttributes :: Maybe [DocumentAttribute]
- documentExcerpt :: Maybe TextWithHighlights
- documentId :: Maybe Text
- documentTitle :: Maybe TextWithHighlights
- documentURI :: Maybe Text
- feedbackToken :: Maybe Text
- format :: Maybe QueryResultFormat
- id :: Maybe Text
- scoreAttributes :: Maybe ScoreAttributes
- tableExcerpt :: Maybe TableExcerpt
- type' :: Maybe QueryResultType
}
newQueryResultItem :: QueryResultItem
queryResultItem_additionalAttributes :: Lens' QueryResultItem (Maybe [AdditionalResultAttribute])
queryResultItem_documentAttributes :: Lens' QueryResultItem (Maybe [DocumentAttribute])
queryResultItem_documentExcerpt :: Lens' QueryResultItem (Maybe TextWithHighlights)
queryResultItem_documentId :: Lens' QueryResultItem (Maybe Text)
queryResultItem_documentTitle :: Lens' QueryResultItem (Maybe TextWithHighlights)
queryResultItem_documentURI :: Lens' QueryResultItem (Maybe Text)
queryResultItem_feedbackToken :: Lens' QueryResultItem (Maybe Text)
queryResultItem_format :: Lens' QueryResultItem (Maybe QueryResultFormat)
queryResultItem_id :: Lens' QueryResultItem (Maybe Text)
queryResultItem_scoreAttributes :: Lens' QueryResultItem (Maybe ScoreAttributes)
queryResultItem_tableExcerpt :: Lens' QueryResultItem (Maybe TableExcerpt)
queryResultItem_type :: Lens' QueryResultItem (Maybe QueryResultType)
data QuerySuggestionsBlockListSummary = QuerySuggestionsBlockListSummary' {
- createdAt :: Maybe POSIX
- id :: Maybe Text
- itemCount :: Maybe Int
- name :: Maybe Text
- status :: Maybe QuerySuggestionsBlockListStatus
- updatedAt :: Maybe POSIX
}
newQuerySuggestionsBlockListSummary :: QuerySuggestionsBlockListSummary
querySuggestionsBlockListSummary_createdAt :: Lens' QuerySuggestionsBlockListSummary (Maybe UTCTime)
querySuggestionsBlockListSummary_id :: Lens' QuerySuggestionsBlockListSummary (Maybe Text)
querySuggestionsBlockListSummary_itemCount :: Lens' QuerySuggestionsBlockListSummary (Maybe Int)
querySuggestionsBlockListSummary_name :: Lens' QuerySuggestionsBlockListSummary (Maybe Text)
querySuggestionsBlockListSummary_status :: Lens' QuerySuggestionsBlockListSummary (Maybe QuerySuggestionsBlockListStatus)
querySuggestionsBlockListSummary_updatedAt :: Lens' QuerySuggestionsBlockListSummary (Maybe UTCTime)
data QuipConfiguration = QuipConfiguration' {
- attachmentFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- crawlAttachments :: Maybe Bool
- crawlChatRooms :: Maybe Bool
- crawlFileComments :: Maybe Bool
- exclusionPatterns :: Maybe [Text]
- folderIds :: Maybe [Text]
- inclusionPatterns :: Maybe [Text]
- messageFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- threadFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- domain :: Text
- secretArn :: Text
}
newQuipConfiguration :: Text -> Text -> QuipConfiguration
quipConfiguration_attachmentFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
quipConfiguration_crawlAttachments :: Lens' QuipConfiguration (Maybe Bool)
quipConfiguration_crawlChatRooms :: Lens' QuipConfiguration (Maybe Bool)
quipConfiguration_crawlFileComments :: Lens' QuipConfiguration (Maybe Bool)
quipConfiguration_exclusionPatterns :: Lens' QuipConfiguration (Maybe [Text])
quipConfiguration_folderIds :: Lens' QuipConfiguration (Maybe [Text])
quipConfiguration_inclusionPatterns :: Lens' QuipConfiguration (Maybe [Text])
quipConfiguration_messageFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
quipConfiguration_threadFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
quipConfiguration_vpcConfiguration :: Lens' QuipConfiguration (Maybe DataSourceVpcConfiguration)
quipConfiguration_domain :: Lens' QuipConfiguration Text
quipConfiguration_secretArn :: Lens' QuipConfiguration Text
data Relevance = Relevance' {
- duration :: Maybe Text
- freshness :: Maybe Bool
- importance :: Maybe Natural
- rankOrder :: Maybe Order
- valueImportanceMap :: Maybe (HashMap Text Natural)
}
newRelevance :: Relevance
relevance_duration :: Lens' Relevance (Maybe Text)
relevance_freshness :: Lens' Relevance (Maybe Bool)
relevance_importance :: Lens' Relevance (Maybe Natural)
relevance_rankOrder :: Lens' Relevance (Maybe Order)
relevance_valueImportanceMap :: Lens' Relevance (Maybe (HashMap Text Natural))
data RelevanceFeedback = RelevanceFeedback' {
- resultId :: Text
- relevanceValue :: RelevanceType
}
newRelevanceFeedback :: Text -> RelevanceType -> RelevanceFeedback
relevanceFeedback_resultId :: Lens' RelevanceFeedback Text
relevanceFeedback_relevanceValue :: Lens' RelevanceFeedback RelevanceType
data S3DataSourceConfiguration = S3DataSourceConfiguration' {
- accessControlListConfiguration :: Maybe AccessControlListConfiguration
- documentsMetadataConfiguration :: Maybe DocumentsMetadataConfiguration
- exclusionPatterns :: Maybe [Text]
- inclusionPatterns :: Maybe [Text]
- inclusionPrefixes :: Maybe [Text]
- bucketName :: Text
}
newS3DataSourceConfiguration :: Text -> S3DataSourceConfiguration
s3DataSourceConfiguration_accessControlListConfiguration :: Lens' S3DataSourceConfiguration (Maybe AccessControlListConfiguration)
s3DataSourceConfiguration_documentsMetadataConfiguration :: Lens' S3DataSourceConfiguration (Maybe DocumentsMetadataConfiguration)
s3DataSourceConfiguration_exclusionPatterns :: Lens' S3DataSourceConfiguration (Maybe [Text])
s3DataSourceConfiguration_inclusionPatterns :: Lens' S3DataSourceConfiguration (Maybe [Text])
s3DataSourceConfiguration_inclusionPrefixes :: Lens' S3DataSourceConfiguration (Maybe [Text])
s3DataSourceConfiguration_bucketName :: Lens' S3DataSourceConfiguration Text
data S3Path = S3Path' {
- bucket :: Text
- key :: Text
}
newS3Path :: Text -> Text -> S3Path
s3Path_bucket :: Lens' S3Path Text
s3Path_key :: Lens' S3Path Text
data SaaSConfiguration = SaaSConfiguration' {
- organizationName :: Text
- hostUrl :: Text
}
newSaaSConfiguration :: Text -> Text -> SaaSConfiguration
saaSConfiguration_organizationName :: Lens' SaaSConfiguration Text
saaSConfiguration_hostUrl :: Lens' SaaSConfiguration Text
data SalesforceChatterFeedConfiguration = SalesforceChatterFeedConfiguration' {
- documentTitleFieldName :: Maybe Text
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- includeFilterTypes :: Maybe (NonEmpty SalesforceChatterFeedIncludeFilterType)
- documentDataFieldName :: Text
}
newSalesforceChatterFeedConfiguration :: Text -> SalesforceChatterFeedConfiguration
salesforceChatterFeedConfiguration_documentTitleFieldName :: Lens' SalesforceChatterFeedConfiguration (Maybe Text)
salesforceChatterFeedConfiguration_fieldMappings :: Lens' SalesforceChatterFeedConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
salesforceChatterFeedConfiguration_includeFilterTypes :: Lens' SalesforceChatterFeedConfiguration (Maybe (NonEmpty SalesforceChatterFeedIncludeFilterType))
salesforceChatterFeedConfiguration_documentDataFieldName :: Lens' SalesforceChatterFeedConfiguration Text
data SalesforceConfiguration = SalesforceConfiguration' {
- chatterFeedConfiguration :: Maybe SalesforceChatterFeedConfiguration
- crawlAttachments :: Maybe Bool
- excludeAttachmentFilePatterns :: Maybe [Text]
- includeAttachmentFilePatterns :: Maybe [Text]
- knowledgeArticleConfiguration :: Maybe SalesforceKnowledgeArticleConfiguration
- standardObjectAttachmentConfiguration :: Maybe SalesforceStandardObjectAttachmentConfiguration
- standardObjectConfigurations :: Maybe (NonEmpty SalesforceStandardObjectConfiguration)
- serverUrl :: Text
- secretArn :: Text
}
newSalesforceConfiguration :: Text -> Text -> SalesforceConfiguration
salesforceConfiguration_chatterFeedConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceChatterFeedConfiguration)
salesforceConfiguration_crawlAttachments :: Lens' SalesforceConfiguration (Maybe Bool)
salesforceConfiguration_excludeAttachmentFilePatterns :: Lens' SalesforceConfiguration (Maybe [Text])
salesforceConfiguration_includeAttachmentFilePatterns :: Lens' SalesforceConfiguration (Maybe [Text])
salesforceConfiguration_knowledgeArticleConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceKnowledgeArticleConfiguration)
salesforceConfiguration_standardObjectAttachmentConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceStandardObjectAttachmentConfiguration)
salesforceConfiguration_standardObjectConfigurations :: Lens' SalesforceConfiguration (Maybe (NonEmpty SalesforceStandardObjectConfiguration))
salesforceConfiguration_serverUrl :: Lens' SalesforceConfiguration Text
salesforceConfiguration_secretArn :: Lens' SalesforceConfiguration Text
data SalesforceCustomKnowledgeArticleTypeConfiguration = SalesforceCustomKnowledgeArticleTypeConfiguration' {
- documentTitleFieldName :: Maybe Text
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- name :: Text
- documentDataFieldName :: Text
}
newSalesforceCustomKnowledgeArticleTypeConfiguration :: Text -> Text -> SalesforceCustomKnowledgeArticleTypeConfiguration
salesforceCustomKnowledgeArticleTypeConfiguration_documentTitleFieldName :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration (Maybe Text)
salesforceCustomKnowledgeArticleTypeConfiguration_fieldMappings :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
salesforceCustomKnowledgeArticleTypeConfiguration_name :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration Text
salesforceCustomKnowledgeArticleTypeConfiguration_documentDataFieldName :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration Text
data SalesforceKnowledgeArticleConfiguration = SalesforceKnowledgeArticleConfiguration' {
- customKnowledgeArticleTypeConfigurations :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
- standardKnowledgeArticleTypeConfiguration :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
- includedStates :: NonEmpty SalesforceKnowledgeArticleState
}
newSalesforceKnowledgeArticleConfiguration :: NonEmpty SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleConfiguration
salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations :: Lens' SalesforceKnowledgeArticleConfiguration (Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration))
salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration :: Lens' SalesforceKnowledgeArticleConfiguration (Maybe SalesforceStandardKnowledgeArticleTypeConfiguration)
salesforceKnowledgeArticleConfiguration_includedStates :: Lens' SalesforceKnowledgeArticleConfiguration (NonEmpty SalesforceKnowledgeArticleState)
data SalesforceStandardKnowledgeArticleTypeConfiguration = SalesforceStandardKnowledgeArticleTypeConfiguration' {
- documentTitleFieldName :: Maybe Text
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- documentDataFieldName :: Text
}
newSalesforceStandardKnowledgeArticleTypeConfiguration :: Text -> SalesforceStandardKnowledgeArticleTypeConfiguration
salesforceStandardKnowledgeArticleTypeConfiguration_documentTitleFieldName :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration (Maybe Text)
salesforceStandardKnowledgeArticleTypeConfiguration_fieldMappings :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
salesforceStandardKnowledgeArticleTypeConfiguration_documentDataFieldName :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration Text
data SalesforceStandardObjectAttachmentConfiguration = SalesforceStandardObjectAttachmentConfiguration' {
- documentTitleFieldName :: Maybe Text
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
}
newSalesforceStandardObjectAttachmentConfiguration :: SalesforceStandardObjectAttachmentConfiguration
salesforceStandardObjectAttachmentConfiguration_documentTitleFieldName :: Lens' SalesforceStandardObjectAttachmentConfiguration (Maybe Text)
salesforceStandardObjectAttachmentConfiguration_fieldMappings :: Lens' SalesforceStandardObjectAttachmentConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
data SalesforceStandardObjectConfiguration = SalesforceStandardObjectConfiguration' {
- documentTitleFieldName :: Maybe Text
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- name :: SalesforceStandardObjectName
- documentDataFieldName :: Text
}
newSalesforceStandardObjectConfiguration :: SalesforceStandardObjectName -> Text -> SalesforceStandardObjectConfiguration
salesforceStandardObjectConfiguration_documentTitleFieldName :: Lens' SalesforceStandardObjectConfiguration (Maybe Text)
salesforceStandardObjectConfiguration_fieldMappings :: Lens' SalesforceStandardObjectConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
salesforceStandardObjectConfiguration_name :: Lens' SalesforceStandardObjectConfiguration SalesforceStandardObjectName
salesforceStandardObjectConfiguration_documentDataFieldName :: Lens' SalesforceStandardObjectConfiguration Text
data ScoreAttributes = ScoreAttributes' {
- scoreConfidence :: Maybe ScoreConfidence
}
newScoreAttributes :: ScoreAttributes
scoreAttributes_scoreConfidence :: Lens' ScoreAttributes (Maybe ScoreConfidence)
data Search = Search' {
- displayable :: Maybe Bool
- facetable :: Maybe Bool
- searchable :: Maybe Bool
- sortable :: Maybe Bool
}
newSearch :: Search
search_displayable :: Lens' Search (Maybe Bool)
search_facetable :: Lens' Search (Maybe Bool)
search_searchable :: Lens' Search (Maybe Bool)
search_sortable :: Lens' Search (Maybe Bool)
data SeedUrlConfiguration = SeedUrlConfiguration' {
- webCrawlerMode :: Maybe WebCrawlerMode
- seedUrls :: [Text]
}
newSeedUrlConfiguration :: SeedUrlConfiguration
seedUrlConfiguration_webCrawlerMode :: Lens' SeedUrlConfiguration (Maybe WebCrawlerMode)
seedUrlConfiguration_seedUrls :: Lens' SeedUrlConfiguration [Text]
data ServerSideEncryptionConfiguration = ServerSideEncryptionConfiguration' {
- kmsKeyId :: Maybe (Sensitive Text)
}
newServerSideEncryptionConfiguration :: ServerSideEncryptionConfiguration
serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration (Maybe Text)
data ServiceNowConfiguration = ServiceNowConfiguration' {
- authenticationType :: Maybe ServiceNowAuthenticationType
- knowledgeArticleConfiguration :: Maybe ServiceNowKnowledgeArticleConfiguration
- serviceCatalogConfiguration :: Maybe ServiceNowServiceCatalogConfiguration
- hostUrl :: Text
- secretArn :: Text
- serviceNowBuildVersion :: ServiceNowBuildVersionType
}
newServiceNowConfiguration :: Text -> Text -> ServiceNowBuildVersionType -> ServiceNowConfiguration
serviceNowConfiguration_authenticationType :: Lens' ServiceNowConfiguration (Maybe ServiceNowAuthenticationType)
serviceNowConfiguration_knowledgeArticleConfiguration :: Lens' ServiceNowConfiguration (Maybe ServiceNowKnowledgeArticleConfiguration)
serviceNowConfiguration_serviceCatalogConfiguration :: Lens' ServiceNowConfiguration (Maybe ServiceNowServiceCatalogConfiguration)
serviceNowConfiguration_hostUrl :: Lens' ServiceNowConfiguration Text
serviceNowConfiguration_secretArn :: Lens' ServiceNowConfiguration Text
serviceNowConfiguration_serviceNowBuildVersion :: Lens' ServiceNowConfiguration ServiceNowBuildVersionType
data ServiceNowKnowledgeArticleConfiguration = ServiceNowKnowledgeArticleConfiguration' {
- crawlAttachments :: Maybe Bool
- documentTitleFieldName :: Maybe Text
- excludeAttachmentFilePatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- filterQuery :: Maybe Text
- includeAttachmentFilePatterns :: Maybe [Text]
- documentDataFieldName :: Text
}
newServiceNowKnowledgeArticleConfiguration :: Text -> ServiceNowKnowledgeArticleConfiguration
serviceNowKnowledgeArticleConfiguration_crawlAttachments :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Bool)
serviceNowKnowledgeArticleConfiguration_documentTitleFieldName :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Text)
serviceNowKnowledgeArticleConfiguration_excludeAttachmentFilePatterns :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe [Text])
serviceNowKnowledgeArticleConfiguration_fieldMappings :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
serviceNowKnowledgeArticleConfiguration_filterQuery :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Text)
serviceNowKnowledgeArticleConfiguration_includeAttachmentFilePatterns :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe [Text])
serviceNowKnowledgeArticleConfiguration_documentDataFieldName :: Lens' ServiceNowKnowledgeArticleConfiguration Text
data ServiceNowServiceCatalogConfiguration = ServiceNowServiceCatalogConfiguration' {
- crawlAttachments :: Maybe Bool
- documentTitleFieldName :: Maybe Text
- excludeAttachmentFilePatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- includeAttachmentFilePatterns :: Maybe [Text]
- documentDataFieldName :: Text
}
newServiceNowServiceCatalogConfiguration :: Text -> ServiceNowServiceCatalogConfiguration
serviceNowServiceCatalogConfiguration_crawlAttachments :: Lens' ServiceNowServiceCatalogConfiguration (Maybe Bool)
serviceNowServiceCatalogConfiguration_documentTitleFieldName :: Lens' ServiceNowServiceCatalogConfiguration (Maybe Text)
serviceNowServiceCatalogConfiguration_excludeAttachmentFilePatterns :: Lens' ServiceNowServiceCatalogConfiguration (Maybe [Text])
serviceNowServiceCatalogConfiguration_fieldMappings :: Lens' ServiceNowServiceCatalogConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
serviceNowServiceCatalogConfiguration_includeAttachmentFilePatterns :: Lens' ServiceNowServiceCatalogConfiguration (Maybe [Text])
serviceNowServiceCatalogConfiguration_documentDataFieldName :: Lens' ServiceNowServiceCatalogConfiguration Text
data SharePointConfiguration = SharePointConfiguration' {
- authenticationType :: Maybe SharePointOnlineAuthenticationType
- crawlAttachments :: Maybe Bool
- disableLocalGroups :: Maybe Bool
- documentTitleFieldName :: Maybe Text
- exclusionPatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionPatterns :: Maybe [Text]
- proxyConfiguration :: Maybe ProxyConfiguration
- sslCertificateS3Path :: Maybe S3Path
- useChangeLog :: Maybe Bool
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- sharePointVersion :: SharePointVersion
- urls :: NonEmpty Text
- secretArn :: Text
}
newSharePointConfiguration :: SharePointVersion -> NonEmpty Text -> Text -> SharePointConfiguration
sharePointConfiguration_authenticationType :: Lens' SharePointConfiguration (Maybe SharePointOnlineAuthenticationType)
sharePointConfiguration_crawlAttachments :: Lens' SharePointConfiguration (Maybe Bool)
sharePointConfiguration_disableLocalGroups :: Lens' SharePointConfiguration (Maybe Bool)
sharePointConfiguration_documentTitleFieldName :: Lens' SharePointConfiguration (Maybe Text)
sharePointConfiguration_exclusionPatterns :: Lens' SharePointConfiguration (Maybe [Text])
sharePointConfiguration_fieldMappings :: Lens' SharePointConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
sharePointConfiguration_inclusionPatterns :: Lens' SharePointConfiguration (Maybe [Text])
sharePointConfiguration_proxyConfiguration :: Lens' SharePointConfiguration (Maybe ProxyConfiguration)
sharePointConfiguration_sslCertificateS3Path :: Lens' SharePointConfiguration (Maybe S3Path)
sharePointConfiguration_useChangeLog :: Lens' SharePointConfiguration (Maybe Bool)
sharePointConfiguration_vpcConfiguration :: Lens' SharePointConfiguration (Maybe DataSourceVpcConfiguration)
sharePointConfiguration_sharePointVersion :: Lens' SharePointConfiguration SharePointVersion
sharePointConfiguration_urls :: Lens' SharePointConfiguration (NonEmpty Text)
sharePointConfiguration_secretArn :: Lens' SharePointConfiguration Text
data SiteMapsConfiguration = SiteMapsConfiguration' {
- siteMaps :: [Text]
}
newSiteMapsConfiguration :: SiteMapsConfiguration
siteMapsConfiguration_siteMaps :: Lens' SiteMapsConfiguration [Text]
data SlackConfiguration = SlackConfiguration' {
- crawlBotMessage :: Maybe Bool
- excludeArchived :: Maybe Bool
- exclusionPatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionPatterns :: Maybe [Text]
- lookBackPeriod :: Maybe Natural
- privateChannelFilter :: Maybe [Text]
- publicChannelFilter :: Maybe [Text]
- useChangeLog :: Maybe Bool
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- teamId :: Text
- secretArn :: Text
- slackEntityList :: NonEmpty SlackEntity
- sinceCrawlDate :: Text
}
newSlackConfiguration :: Text -> Text -> NonEmpty SlackEntity -> Text -> SlackConfiguration
slackConfiguration_crawlBotMessage :: Lens' SlackConfiguration (Maybe Bool)
slackConfiguration_excludeArchived :: Lens' SlackConfiguration (Maybe Bool)
slackConfiguration_exclusionPatterns :: Lens' SlackConfiguration (Maybe [Text])
slackConfiguration_fieldMappings :: Lens' SlackConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
slackConfiguration_inclusionPatterns :: Lens' SlackConfiguration (Maybe [Text])
slackConfiguration_lookBackPeriod :: Lens' SlackConfiguration (Maybe Natural)
slackConfiguration_privateChannelFilter :: Lens' SlackConfiguration (Maybe [Text])
slackConfiguration_publicChannelFilter :: Lens' SlackConfiguration (Maybe [Text])
slackConfiguration_useChangeLog :: Lens' SlackConfiguration (Maybe Bool)
slackConfiguration_vpcConfiguration :: Lens' SlackConfiguration (Maybe DataSourceVpcConfiguration)
slackConfiguration_teamId :: Lens' SlackConfiguration Text
slackConfiguration_secretArn :: Lens' SlackConfiguration Text
slackConfiguration_slackEntityList :: Lens' SlackConfiguration (NonEmpty SlackEntity)
slackConfiguration_sinceCrawlDate :: Lens' SlackConfiguration Text
data SortingConfiguration = SortingConfiguration' {
- documentAttributeKey :: Text
- sortOrder :: SortOrder
}
newSortingConfiguration :: Text -> SortOrder -> SortingConfiguration
sortingConfiguration_documentAttributeKey :: Lens' SortingConfiguration Text
sortingConfiguration_sortOrder :: Lens' SortingConfiguration SortOrder
data SpellCorrectedQuery = SpellCorrectedQuery' {
- corrections :: Maybe [Correction]
- suggestedQueryText :: Maybe Text
}
newSpellCorrectedQuery :: SpellCorrectedQuery
spellCorrectedQuery_corrections :: Lens' SpellCorrectedQuery (Maybe [Correction])
spellCorrectedQuery_suggestedQueryText :: Lens' SpellCorrectedQuery (Maybe Text)
data SpellCorrectionConfiguration = SpellCorrectionConfiguration' {
- includeQuerySpellCheckSuggestions :: Bool
}
newSpellCorrectionConfiguration :: Bool -> SpellCorrectionConfiguration
spellCorrectionConfiguration_includeQuerySpellCheckSuggestions :: Lens' SpellCorrectionConfiguration Bool
data SqlConfiguration = SqlConfiguration' {
- queryIdentifiersEnclosingOption :: Maybe QueryIdentifiersEnclosingOption
}
newSqlConfiguration :: SqlConfiguration
sqlConfiguration_queryIdentifiersEnclosingOption :: Lens' SqlConfiguration (Maybe QueryIdentifiersEnclosingOption)
data Status = Status' {
- documentId :: Maybe Text
- documentStatus :: Maybe DocumentStatus
- failureCode :: Maybe Text
- failureReason :: Maybe Text
}
newStatus :: Status
status_documentId :: Lens' Status (Maybe Text)
status_documentStatus :: Lens' Status (Maybe DocumentStatus)
status_failureCode :: Lens' Status (Maybe Text)
status_failureReason :: Lens' Status (Maybe Text)
data Suggestion = Suggestion' {
- id :: Maybe Text
- value :: Maybe SuggestionValue
}
newSuggestion :: Suggestion
suggestion_id :: Lens' Suggestion (Maybe Text)
suggestion_value :: Lens' Suggestion (Maybe SuggestionValue)
data SuggestionHighlight = SuggestionHighlight' {
- beginOffset :: Maybe Int
- endOffset :: Maybe Int
}
newSuggestionHighlight :: SuggestionHighlight
suggestionHighlight_beginOffset :: Lens' SuggestionHighlight (Maybe Int)
suggestionHighlight_endOffset :: Lens' SuggestionHighlight (Maybe Int)
data SuggestionTextWithHighlights = SuggestionTextWithHighlights' {
- highlights :: Maybe [SuggestionHighlight]
- text :: Maybe Text
}
newSuggestionTextWithHighlights :: SuggestionTextWithHighlights
suggestionTextWithHighlights_highlights :: Lens' SuggestionTextWithHighlights (Maybe [SuggestionHighlight])
suggestionTextWithHighlights_text :: Lens' SuggestionTextWithHighlights (Maybe Text)
data SuggestionValue = SuggestionValue' {
- text :: Maybe SuggestionTextWithHighlights
}
newSuggestionValue :: SuggestionValue
suggestionValue_text :: Lens' SuggestionValue (Maybe SuggestionTextWithHighlights)
data TableCell = TableCell' {
- header :: Maybe Bool
- highlighted :: Maybe Bool
- topAnswer :: Maybe Bool
- value :: Maybe Text
}
newTableCell :: TableCell
tableCell_header :: Lens' TableCell (Maybe Bool)
tableCell_highlighted :: Lens' TableCell (Maybe Bool)
tableCell_topAnswer :: Lens' TableCell (Maybe Bool)
tableCell_value :: Lens' TableCell (Maybe Text)
data TableExcerpt = TableExcerpt' {
- rows :: Maybe [TableRow]
- totalNumberOfRows :: Maybe Int
}
newTableExcerpt :: TableExcerpt
tableExcerpt_rows :: Lens' TableExcerpt (Maybe [TableRow])
tableExcerpt_totalNumberOfRows :: Lens' TableExcerpt (Maybe Int)
data TableRow = TableRow' {
- cells :: Maybe [TableCell]
}
newTableRow :: TableRow
tableRow_cells :: Lens' TableRow (Maybe [TableCell])
data Tag = Tag' {
- key :: Text
- value :: Text
}
newTag :: Text -> Text -> Tag
tag_key :: Lens' Tag Text
tag_value :: Lens' Tag Text
data Template = Template' {
}
newTemplate :: Template
data TemplateConfiguration = TemplateConfiguration' {
- template :: Maybe Template
}
newTemplateConfiguration :: TemplateConfiguration
templateConfiguration_template :: Lens' TemplateConfiguration (Maybe Template)
data TextDocumentStatistics = TextDocumentStatistics' {
- indexedTextDocumentsCount :: Natural
- indexedTextBytes :: Natural
}
newTextDocumentStatistics :: Natural -> Natural -> TextDocumentStatistics
textDocumentStatistics_indexedTextDocumentsCount :: Lens' TextDocumentStatistics Natural
textDocumentStatistics_indexedTextBytes :: Lens' TextDocumentStatistics Natural
data TextWithHighlights = TextWithHighlights' {
- highlights :: Maybe [Highlight]
- text :: Maybe Text
}
newTextWithHighlights :: TextWithHighlights
textWithHighlights_highlights :: Lens' TextWithHighlights (Maybe [Highlight])
textWithHighlights_text :: Lens' TextWithHighlights (Maybe Text)
data ThesaurusSummary = ThesaurusSummary' {
- createdAt :: Maybe POSIX
- id :: Maybe Text
- name :: Maybe Text
- status :: Maybe ThesaurusStatus
- updatedAt :: Maybe POSIX
}
newThesaurusSummary :: ThesaurusSummary
thesaurusSummary_createdAt :: Lens' ThesaurusSummary (Maybe UTCTime)
thesaurusSummary_id :: Lens' ThesaurusSummary (Maybe Text)
thesaurusSummary_name :: Lens' ThesaurusSummary (Maybe Text)
thesaurusSummary_status :: Lens' ThesaurusSummary (Maybe ThesaurusStatus)
thesaurusSummary_updatedAt :: Lens' ThesaurusSummary (Maybe UTCTime)
data TimeRange = TimeRange' {
- endTime :: Maybe POSIX
- startTime :: Maybe POSIX
}
newTimeRange :: TimeRange
timeRange_endTime :: Lens' TimeRange (Maybe UTCTime)
timeRange_startTime :: Lens' TimeRange (Maybe UTCTime)
data Urls = Urls' {
- seedUrlConfiguration :: Maybe SeedUrlConfiguration
- siteMapsConfiguration :: Maybe SiteMapsConfiguration
}
newUrls :: Urls
urls_seedUrlConfiguration :: Lens' Urls (Maybe SeedUrlConfiguration)
urls_siteMapsConfiguration :: Lens' Urls (Maybe SiteMapsConfiguration)
data UserContext = UserContext' {
- dataSourceGroups :: Maybe (NonEmpty DataSourceGroup)
- groups :: Maybe (NonEmpty Text)
- token :: Maybe Text
- userId :: Maybe Text
}
newUserContext :: UserContext
userContext_dataSourceGroups :: Lens' UserContext (Maybe (NonEmpty DataSourceGroup))
userContext_groups :: Lens' UserContext (Maybe (NonEmpty Text))
userContext_token :: Lens' UserContext (Maybe Text)
userContext_userId :: Lens' UserContext (Maybe Text)
data UserGroupResolutionConfiguration = UserGroupResolutionConfiguration' {
- userGroupResolutionMode :: UserGroupResolutionMode
}
newUserGroupResolutionConfiguration :: UserGroupResolutionMode -> UserGroupResolutionConfiguration
userGroupResolutionConfiguration_userGroupResolutionMode :: Lens' UserGroupResolutionConfiguration UserGroupResolutionMode
data UserIdentityConfiguration = UserIdentityConfiguration' {
- identityAttributeName :: Maybe Text
}
newUserIdentityConfiguration :: UserIdentityConfiguration
userIdentityConfiguration_identityAttributeName :: Lens' UserIdentityConfiguration (Maybe Text)
data UserTokenConfiguration = UserTokenConfiguration' {
- jsonTokenTypeConfiguration :: Maybe JsonTokenTypeConfiguration
- jwtTokenTypeConfiguration :: Maybe JwtTokenTypeConfiguration
}
newUserTokenConfiguration :: UserTokenConfiguration
userTokenConfiguration_jsonTokenTypeConfiguration :: Lens' UserTokenConfiguration (Maybe JsonTokenTypeConfiguration)
userTokenConfiguration_jwtTokenTypeConfiguration :: Lens' UserTokenConfiguration (Maybe JwtTokenTypeConfiguration)
data Warning = Warning' {
- code :: Maybe WarningCode
- message :: Maybe Text
}
newWarning :: Warning
warning_code :: Lens' Warning (Maybe WarningCode)
warning_message :: Lens' Warning (Maybe Text)
data WebCrawlerConfiguration = WebCrawlerConfiguration' {
- authenticationConfiguration :: Maybe AuthenticationConfiguration
- crawlDepth :: Maybe Natural
- maxContentSizePerPageInMegaBytes :: Maybe Double
- maxLinksPerPage :: Maybe Natural
- maxUrlsPerMinuteCrawlRate :: Maybe Natural
- proxyConfiguration :: Maybe ProxyConfiguration
- urlExclusionPatterns :: Maybe [Text]
- urlInclusionPatterns :: Maybe [Text]
- urls :: Urls
}
newWebCrawlerConfiguration :: Urls -> WebCrawlerConfiguration
webCrawlerConfiguration_authenticationConfiguration :: Lens' WebCrawlerConfiguration (Maybe AuthenticationConfiguration)
webCrawlerConfiguration_crawlDepth :: Lens' WebCrawlerConfiguration (Maybe Natural)
webCrawlerConfiguration_maxContentSizePerPageInMegaBytes :: Lens' WebCrawlerConfiguration (Maybe Double)
webCrawlerConfiguration_maxLinksPerPage :: Lens' WebCrawlerConfiguration (Maybe Natural)
webCrawlerConfiguration_maxUrlsPerMinuteCrawlRate :: Lens' WebCrawlerConfiguration (Maybe Natural)
webCrawlerConfiguration_proxyConfiguration :: Lens' WebCrawlerConfiguration (Maybe ProxyConfiguration)
webCrawlerConfiguration_urlExclusionPatterns :: Lens' WebCrawlerConfiguration (Maybe [Text])
webCrawlerConfiguration_urlInclusionPatterns :: Lens' WebCrawlerConfiguration (Maybe [Text])
webCrawlerConfiguration_urls :: Lens' WebCrawlerConfiguration Urls
data WorkDocsConfiguration = WorkDocsConfiguration' {
- crawlComments :: Maybe Bool
- exclusionPatterns :: Maybe [Text]
- fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- inclusionPatterns :: Maybe [Text]
- useChangeLog :: Maybe Bool
- organizationId :: Text
}
newWorkDocsConfiguration :: Text -> WorkDocsConfiguration
workDocsConfiguration_crawlComments :: Lens' WorkDocsConfiguration (Maybe Bool)
workDocsConfiguration_exclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text])
workDocsConfiguration_fieldMappings :: Lens' WorkDocsConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
workDocsConfiguration_inclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text])
workDocsConfiguration_useChangeLog :: Lens' WorkDocsConfiguration (Maybe Bool)
workDocsConfiguration_organizationId :: Lens' WorkDocsConfiguration Text

Service Configuration

defaultService :: Service Source #

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

Errors

_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 :: AsError a => Fold a ServiceError Source #

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

_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 :: AsError a => Fold a ServiceError Source #

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

_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 :: 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 :: 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 :: 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 :: 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 :: AsError a => Fold a ServiceError Source #

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

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

AdditionalResultAttributeValueType

newtype AdditionalResultAttributeValueType Source #

Constructors

AdditionalResultAttributeValueType'
Fields fromAdditionalResultAttributeValueType :: Text

Bundled Patterns

pattern AdditionalResultAttributeValueType_TEXT_WITH_HIGHLIGHTS_VALUE :: AdditionalResultAttributeValueType

Instances

Instances details

FromJSON AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods parseJSON :: Value -> Parser AdditionalResultAttributeValueType # parseJSONList :: Value -> Parser [AdditionalResultAttributeValueType] #
FromJSONKey AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods fromJSONKey :: FromJSONKeyFunction AdditionalResultAttributeValueType # fromJSONKeyList :: FromJSONKeyFunction [AdditionalResultAttributeValueType] #
ToJSON AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods toJSON :: AdditionalResultAttributeValueType -> Value # toEncoding :: AdditionalResultAttributeValueType -> Encoding # toJSONList :: [AdditionalResultAttributeValueType] -> Value # toEncodingList :: [AdditionalResultAttributeValueType] -> Encoding #
ToJSONKey AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods toJSONKey :: ToJSONKeyFunction AdditionalResultAttributeValueType # toJSONKeyList :: ToJSONKeyFunction [AdditionalResultAttributeValueType] #
ToByteString AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods toBS :: AdditionalResultAttributeValueType -> ByteString #
ToHeader AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods toHeader :: HeaderName -> AdditionalResultAttributeValueType -> [Header] #
ToLog AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods build :: AdditionalResultAttributeValueType -> ByteStringBuilder #
ToQuery AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods toQuery :: AdditionalResultAttributeValueType -> QueryString #
FromText AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods fromText :: Text -> Either String AdditionalResultAttributeValueType #
ToText AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods toText :: AdditionalResultAttributeValueType -> Text #
FromXML AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods parseXML :: [Node] -> Either String AdditionalResultAttributeValueType #
ToXML AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods toXML :: AdditionalResultAttributeValueType -> XML #
Generic AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Associated Types type Rep AdditionalResultAttributeValueType :: Type -> Type # Methods from :: AdditionalResultAttributeValueType -> Rep AdditionalResultAttributeValueType x # to :: Rep AdditionalResultAttributeValueType x -> AdditionalResultAttributeValueType #
Read AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods readsPrec :: Int -> ReadS AdditionalResultAttributeValueType # readList :: ReadS [AdditionalResultAttributeValueType] # readPrec :: ReadPrec AdditionalResultAttributeValueType # readListPrec :: ReadPrec [AdditionalResultAttributeValueType] #
Show AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods showsPrec :: Int -> AdditionalResultAttributeValueType -> ShowS # show :: AdditionalResultAttributeValueType -> String # showList :: [AdditionalResultAttributeValueType] -> ShowS #
NFData AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods rnf :: AdditionalResultAttributeValueType -> () #
Eq AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods (==) :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> Bool # (/=) :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> Bool #
Ord AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods compare :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> Ordering # (<) :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> Bool # (<=) :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> Bool # (>) :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> Bool # (>=) :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> Bool # max :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType # min :: AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType -> AdditionalResultAttributeValueType #
Hashable AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType Methods hashWithSalt :: Int -> AdditionalResultAttributeValueType -> Int # hash :: AdditionalResultAttributeValueType -> Int #
type Rep AdditionalResultAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValueType type Rep AdditionalResultAttributeValueType = D1 ('MetaData "AdditionalResultAttributeValueType" "Amazonka.Kendra.Types.AdditionalResultAttributeValueType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "AdditionalResultAttributeValueType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAdditionalResultAttributeValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AlfrescoEntity

newtype AlfrescoEntity Source #

Constructors

AlfrescoEntity'
Fields fromAlfrescoEntity :: Text

Bundled Patterns

pattern AlfrescoEntity_Blog :: AlfrescoEntity
pattern AlfrescoEntity_DocumentLibrary :: AlfrescoEntity
pattern AlfrescoEntity_Wiki :: AlfrescoEntity

Instances

Instances details

FromJSON AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods parseJSON :: Value -> Parser AlfrescoEntity # parseJSONList :: Value -> Parser [AlfrescoEntity] #
FromJSONKey AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods fromJSONKey :: FromJSONKeyFunction AlfrescoEntity # fromJSONKeyList :: FromJSONKeyFunction [AlfrescoEntity] #
ToJSON AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods toJSON :: AlfrescoEntity -> Value # toEncoding :: AlfrescoEntity -> Encoding # toJSONList :: [AlfrescoEntity] -> Value # toEncodingList :: [AlfrescoEntity] -> Encoding #
ToJSONKey AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods toJSONKey :: ToJSONKeyFunction AlfrescoEntity # toJSONKeyList :: ToJSONKeyFunction [AlfrescoEntity] #
ToByteString AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods toBS :: AlfrescoEntity -> ByteString #
ToHeader AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods toHeader :: HeaderName -> AlfrescoEntity -> [Header] #
ToLog AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods build :: AlfrescoEntity -> ByteStringBuilder #
ToQuery AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods toQuery :: AlfrescoEntity -> QueryString #
FromText AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods fromText :: Text -> Either String AlfrescoEntity #
ToText AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods toText :: AlfrescoEntity -> Text #
FromXML AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods parseXML :: [Node] -> Either String AlfrescoEntity #
ToXML AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods toXML :: AlfrescoEntity -> XML #
Generic AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Associated Types type Rep AlfrescoEntity :: Type -> Type # Methods from :: AlfrescoEntity -> Rep AlfrescoEntity x # to :: Rep AlfrescoEntity x -> AlfrescoEntity #
Read AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods readsPrec :: Int -> ReadS AlfrescoEntity # readList :: ReadS [AlfrescoEntity] # readPrec :: ReadPrec AlfrescoEntity # readListPrec :: ReadPrec [AlfrescoEntity] #
Show AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods showsPrec :: Int -> AlfrescoEntity -> ShowS # show :: AlfrescoEntity -> String # showList :: [AlfrescoEntity] -> ShowS #
NFData AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods rnf :: AlfrescoEntity -> () #
Eq AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods (==) :: AlfrescoEntity -> AlfrescoEntity -> Bool # (/=) :: AlfrescoEntity -> AlfrescoEntity -> Bool #
Ord AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods compare :: AlfrescoEntity -> AlfrescoEntity -> Ordering # (<) :: AlfrescoEntity -> AlfrescoEntity -> Bool # (<=) :: AlfrescoEntity -> AlfrescoEntity -> Bool # (>) :: AlfrescoEntity -> AlfrescoEntity -> Bool # (>=) :: AlfrescoEntity -> AlfrescoEntity -> Bool # max :: AlfrescoEntity -> AlfrescoEntity -> AlfrescoEntity # min :: AlfrescoEntity -> AlfrescoEntity -> AlfrescoEntity #
Hashable AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity Methods hashWithSalt :: Int -> AlfrescoEntity -> Int # hash :: AlfrescoEntity -> Int #
type Rep AlfrescoEntity Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoEntity type Rep AlfrescoEntity = D1 ('MetaData "AlfrescoEntity" "Amazonka.Kendra.Types.AlfrescoEntity" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "AlfrescoEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAlfrescoEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConditionOperator

newtype ConditionOperator Source #

Constructors

ConditionOperator'
Fields fromConditionOperator :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods parseJSON :: Value -> Parser ConditionOperator # parseJSONList :: Value -> Parser [ConditionOperator] #
FromJSONKey ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods fromJSONKey :: FromJSONKeyFunction ConditionOperator # fromJSONKeyList :: FromJSONKeyFunction [ConditionOperator] #
ToJSON ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods toJSON :: ConditionOperator -> Value # toEncoding :: ConditionOperator -> Encoding # toJSONList :: [ConditionOperator] -> Value # toEncodingList :: [ConditionOperator] -> Encoding #
ToJSONKey ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods toJSONKey :: ToJSONKeyFunction ConditionOperator # toJSONKeyList :: ToJSONKeyFunction [ConditionOperator] #
ToByteString ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods toBS :: ConditionOperator -> ByteString #
ToHeader ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods toHeader :: HeaderName -> ConditionOperator -> [Header] #
ToLog ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods build :: ConditionOperator -> ByteStringBuilder #
ToQuery ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods toQuery :: ConditionOperator -> QueryString #
FromText ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods fromText :: Text -> Either String ConditionOperator #
ToText ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods toText :: ConditionOperator -> Text #
FromXML ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods parseXML :: [Node] -> Either String ConditionOperator #
ToXML ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods toXML :: ConditionOperator -> XML #
Generic ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Associated Types type Rep ConditionOperator :: Type -> Type # Methods from :: ConditionOperator -> Rep ConditionOperator x # to :: Rep ConditionOperator x -> ConditionOperator #
Read ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods readsPrec :: Int -> ReadS ConditionOperator # readList :: ReadS [ConditionOperator] # readPrec :: ReadPrec ConditionOperator # readListPrec :: ReadPrec [ConditionOperator] #
Show ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods showsPrec :: Int -> ConditionOperator -> ShowS # show :: ConditionOperator -> String # showList :: [ConditionOperator] -> ShowS #
NFData ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods rnf :: ConditionOperator -> () #
Eq ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods (==) :: ConditionOperator -> ConditionOperator -> Bool # (/=) :: ConditionOperator -> ConditionOperator -> Bool #
Ord ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods compare :: ConditionOperator -> ConditionOperator -> Ordering # (<) :: ConditionOperator -> ConditionOperator -> Bool # (<=) :: ConditionOperator -> ConditionOperator -> Bool # (>) :: ConditionOperator -> ConditionOperator -> Bool # (>=) :: ConditionOperator -> ConditionOperator -> Bool # max :: ConditionOperator -> ConditionOperator -> ConditionOperator # min :: ConditionOperator -> ConditionOperator -> ConditionOperator #
Hashable ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator Methods hashWithSalt :: Int -> ConditionOperator -> Int # hash :: ConditionOperator -> Int #
type Rep ConditionOperator Source #
Instance details Defined in Amazonka.Kendra.Types.ConditionOperator type Rep ConditionOperator = D1 ('MetaData "ConditionOperator" "Amazonka.Kendra.Types.ConditionOperator" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConditionOperator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConditionOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceAttachmentFieldName

newtype ConfluenceAttachmentFieldName Source #

Constructors

ConfluenceAttachmentFieldName'
Fields fromConfluenceAttachmentFieldName :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods parseJSON :: Value -> Parser ConfluenceAttachmentFieldName # parseJSONList :: Value -> Parser [ConfluenceAttachmentFieldName] #
FromJSONKey ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods fromJSONKey :: FromJSONKeyFunction ConfluenceAttachmentFieldName # fromJSONKeyList :: FromJSONKeyFunction [ConfluenceAttachmentFieldName] #
ToJSON ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods toJSON :: ConfluenceAttachmentFieldName -> Value # toEncoding :: ConfluenceAttachmentFieldName -> Encoding # toJSONList :: [ConfluenceAttachmentFieldName] -> Value # toEncodingList :: [ConfluenceAttachmentFieldName] -> Encoding #
ToJSONKey ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods toJSONKey :: ToJSONKeyFunction ConfluenceAttachmentFieldName # toJSONKeyList :: ToJSONKeyFunction [ConfluenceAttachmentFieldName] #
ToByteString ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods toBS :: ConfluenceAttachmentFieldName -> ByteString #
ToHeader ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods toHeader :: HeaderName -> ConfluenceAttachmentFieldName -> [Header] #
ToLog ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods build :: ConfluenceAttachmentFieldName -> ByteStringBuilder #
ToQuery ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods toQuery :: ConfluenceAttachmentFieldName -> QueryString #
FromText ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods fromText :: Text -> Either String ConfluenceAttachmentFieldName #
ToText ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods toText :: ConfluenceAttachmentFieldName -> Text #
FromXML ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods parseXML :: [Node] -> Either String ConfluenceAttachmentFieldName #
ToXML ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods toXML :: ConfluenceAttachmentFieldName -> XML #
Generic ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Associated Types type Rep ConfluenceAttachmentFieldName :: Type -> Type # Methods from :: ConfluenceAttachmentFieldName -> Rep ConfluenceAttachmentFieldName x # to :: Rep ConfluenceAttachmentFieldName x -> ConfluenceAttachmentFieldName #
Read ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods readsPrec :: Int -> ReadS ConfluenceAttachmentFieldName # readList :: ReadS [ConfluenceAttachmentFieldName] # readPrec :: ReadPrec ConfluenceAttachmentFieldName # readListPrec :: ReadPrec [ConfluenceAttachmentFieldName] #
Show ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods showsPrec :: Int -> ConfluenceAttachmentFieldName -> ShowS # show :: ConfluenceAttachmentFieldName -> String # showList :: [ConfluenceAttachmentFieldName] -> ShowS #
NFData ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods rnf :: ConfluenceAttachmentFieldName -> () #
Eq ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods (==) :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> Bool # (/=) :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> Bool #
Ord ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods compare :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> Ordering # (<) :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> Bool # (<=) :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> Bool # (>) :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> Bool # (>=) :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> Bool # max :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName # min :: ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName -> ConfluenceAttachmentFieldName #
Hashable ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName Methods hashWithSalt :: Int -> ConfluenceAttachmentFieldName -> Int # hash :: ConfluenceAttachmentFieldName -> Int #
type Rep ConfluenceAttachmentFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentFieldName type Rep ConfluenceAttachmentFieldName = D1 ('MetaData "ConfluenceAttachmentFieldName" "Amazonka.Kendra.Types.ConfluenceAttachmentFieldName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceAttachmentFieldName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceAttachmentFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceAuthenticationType

newtype ConfluenceAuthenticationType Source #

Constructors

ConfluenceAuthenticationType'
Fields fromConfluenceAuthenticationType :: Text

Bundled Patterns

pattern ConfluenceAuthenticationType_HTTP_BASIC :: ConfluenceAuthenticationType
pattern ConfluenceAuthenticationType_PAT :: ConfluenceAuthenticationType

Instances

Instances details

FromJSON ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods parseJSON :: Value -> Parser ConfluenceAuthenticationType # parseJSONList :: Value -> Parser [ConfluenceAuthenticationType] #
FromJSONKey ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods fromJSONKey :: FromJSONKeyFunction ConfluenceAuthenticationType # fromJSONKeyList :: FromJSONKeyFunction [ConfluenceAuthenticationType] #
ToJSON ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods toJSON :: ConfluenceAuthenticationType -> Value # toEncoding :: ConfluenceAuthenticationType -> Encoding # toJSONList :: [ConfluenceAuthenticationType] -> Value # toEncodingList :: [ConfluenceAuthenticationType] -> Encoding #
ToJSONKey ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods toJSONKey :: ToJSONKeyFunction ConfluenceAuthenticationType # toJSONKeyList :: ToJSONKeyFunction [ConfluenceAuthenticationType] #
ToByteString ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods toBS :: ConfluenceAuthenticationType -> ByteString #
ToHeader ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods toHeader :: HeaderName -> ConfluenceAuthenticationType -> [Header] #
ToLog ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods build :: ConfluenceAuthenticationType -> ByteStringBuilder #
ToQuery ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods toQuery :: ConfluenceAuthenticationType -> QueryString #
FromText ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods fromText :: Text -> Either String ConfluenceAuthenticationType #
ToText ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods toText :: ConfluenceAuthenticationType -> Text #
FromXML ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods parseXML :: [Node] -> Either String ConfluenceAuthenticationType #
ToXML ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods toXML :: ConfluenceAuthenticationType -> XML #
Generic ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Associated Types type Rep ConfluenceAuthenticationType :: Type -> Type # Methods from :: ConfluenceAuthenticationType -> Rep ConfluenceAuthenticationType x # to :: Rep ConfluenceAuthenticationType x -> ConfluenceAuthenticationType #
Read ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods readsPrec :: Int -> ReadS ConfluenceAuthenticationType # readList :: ReadS [ConfluenceAuthenticationType] # readPrec :: ReadPrec ConfluenceAuthenticationType # readListPrec :: ReadPrec [ConfluenceAuthenticationType] #
Show ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods showsPrec :: Int -> ConfluenceAuthenticationType -> ShowS # show :: ConfluenceAuthenticationType -> String # showList :: [ConfluenceAuthenticationType] -> ShowS #
NFData ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods rnf :: ConfluenceAuthenticationType -> () #
Eq ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods (==) :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> Bool # (/=) :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> Bool #
Ord ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods compare :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> Ordering # (<) :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> Bool # (<=) :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> Bool # (>) :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> Bool # (>=) :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> Bool # max :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> ConfluenceAuthenticationType # min :: ConfluenceAuthenticationType -> ConfluenceAuthenticationType -> ConfluenceAuthenticationType #
Hashable ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType Methods hashWithSalt :: Int -> ConfluenceAuthenticationType -> Int # hash :: ConfluenceAuthenticationType -> Int #
type Rep ConfluenceAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAuthenticationType type Rep ConfluenceAuthenticationType = D1 ('MetaData "ConfluenceAuthenticationType" "Amazonka.Kendra.Types.ConfluenceAuthenticationType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceAuthenticationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceAuthenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceBlogFieldName

newtype ConfluenceBlogFieldName Source #

Constructors

ConfluenceBlogFieldName'
Fields fromConfluenceBlogFieldName :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods parseJSON :: Value -> Parser ConfluenceBlogFieldName # parseJSONList :: Value -> Parser [ConfluenceBlogFieldName] #
FromJSONKey ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods fromJSONKey :: FromJSONKeyFunction ConfluenceBlogFieldName # fromJSONKeyList :: FromJSONKeyFunction [ConfluenceBlogFieldName] #
ToJSON ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods toJSON :: ConfluenceBlogFieldName -> Value # toEncoding :: ConfluenceBlogFieldName -> Encoding # toJSONList :: [ConfluenceBlogFieldName] -> Value # toEncodingList :: [ConfluenceBlogFieldName] -> Encoding #
ToJSONKey ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods toJSONKey :: ToJSONKeyFunction ConfluenceBlogFieldName # toJSONKeyList :: ToJSONKeyFunction [ConfluenceBlogFieldName] #
ToByteString ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods toBS :: ConfluenceBlogFieldName -> ByteString #
ToHeader ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods toHeader :: HeaderName -> ConfluenceBlogFieldName -> [Header] #
ToLog ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods build :: ConfluenceBlogFieldName -> ByteStringBuilder #
ToQuery ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods toQuery :: ConfluenceBlogFieldName -> QueryString #
FromText ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods fromText :: Text -> Either String ConfluenceBlogFieldName #
ToText ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods toText :: ConfluenceBlogFieldName -> Text #
FromXML ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods parseXML :: [Node] -> Either String ConfluenceBlogFieldName #
ToXML ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods toXML :: ConfluenceBlogFieldName -> XML #
Generic ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Associated Types type Rep ConfluenceBlogFieldName :: Type -> Type # Methods from :: ConfluenceBlogFieldName -> Rep ConfluenceBlogFieldName x # to :: Rep ConfluenceBlogFieldName x -> ConfluenceBlogFieldName #
Read ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods readsPrec :: Int -> ReadS ConfluenceBlogFieldName # readList :: ReadS [ConfluenceBlogFieldName] # readPrec :: ReadPrec ConfluenceBlogFieldName # readListPrec :: ReadPrec [ConfluenceBlogFieldName] #
Show ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods showsPrec :: Int -> ConfluenceBlogFieldName -> ShowS # show :: ConfluenceBlogFieldName -> String # showList :: [ConfluenceBlogFieldName] -> ShowS #
NFData ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods rnf :: ConfluenceBlogFieldName -> () #
Eq ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods (==) :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> Bool # (/=) :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> Bool #
Ord ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods compare :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> Ordering # (<) :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> Bool # (<=) :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> Bool # (>) :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> Bool # (>=) :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> Bool # max :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> ConfluenceBlogFieldName # min :: ConfluenceBlogFieldName -> ConfluenceBlogFieldName -> ConfluenceBlogFieldName #
Hashable ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName Methods hashWithSalt :: Int -> ConfluenceBlogFieldName -> Int # hash :: ConfluenceBlogFieldName -> Int #
type Rep ConfluenceBlogFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogFieldName type Rep ConfluenceBlogFieldName = D1 ('MetaData "ConfluenceBlogFieldName" "Amazonka.Kendra.Types.ConfluenceBlogFieldName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceBlogFieldName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceBlogFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluencePageFieldName

newtype ConfluencePageFieldName Source #

Constructors

ConfluencePageFieldName'
Fields fromConfluencePageFieldName :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods parseJSON :: Value -> Parser ConfluencePageFieldName # parseJSONList :: Value -> Parser [ConfluencePageFieldName] #
FromJSONKey ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods fromJSONKey :: FromJSONKeyFunction ConfluencePageFieldName # fromJSONKeyList :: FromJSONKeyFunction [ConfluencePageFieldName] #
ToJSON ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods toJSON :: ConfluencePageFieldName -> Value # toEncoding :: ConfluencePageFieldName -> Encoding # toJSONList :: [ConfluencePageFieldName] -> Value # toEncodingList :: [ConfluencePageFieldName] -> Encoding #
ToJSONKey ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods toJSONKey :: ToJSONKeyFunction ConfluencePageFieldName # toJSONKeyList :: ToJSONKeyFunction [ConfluencePageFieldName] #
ToByteString ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods toBS :: ConfluencePageFieldName -> ByteString #
ToHeader ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods toHeader :: HeaderName -> ConfluencePageFieldName -> [Header] #
ToLog ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods build :: ConfluencePageFieldName -> ByteStringBuilder #
ToQuery ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods toQuery :: ConfluencePageFieldName -> QueryString #
FromText ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods fromText :: Text -> Either String ConfluencePageFieldName #
ToText ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods toText :: ConfluencePageFieldName -> Text #
FromXML ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods parseXML :: [Node] -> Either String ConfluencePageFieldName #
ToXML ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods toXML :: ConfluencePageFieldName -> XML #
Generic ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Associated Types type Rep ConfluencePageFieldName :: Type -> Type # Methods from :: ConfluencePageFieldName -> Rep ConfluencePageFieldName x # to :: Rep ConfluencePageFieldName x -> ConfluencePageFieldName #
Read ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods readsPrec :: Int -> ReadS ConfluencePageFieldName # readList :: ReadS [ConfluencePageFieldName] # readPrec :: ReadPrec ConfluencePageFieldName # readListPrec :: ReadPrec [ConfluencePageFieldName] #
Show ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods showsPrec :: Int -> ConfluencePageFieldName -> ShowS # show :: ConfluencePageFieldName -> String # showList :: [ConfluencePageFieldName] -> ShowS #
NFData ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods rnf :: ConfluencePageFieldName -> () #
Eq ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods (==) :: ConfluencePageFieldName -> ConfluencePageFieldName -> Bool # (/=) :: ConfluencePageFieldName -> ConfluencePageFieldName -> Bool #
Ord ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods compare :: ConfluencePageFieldName -> ConfluencePageFieldName -> Ordering # (<) :: ConfluencePageFieldName -> ConfluencePageFieldName -> Bool # (<=) :: ConfluencePageFieldName -> ConfluencePageFieldName -> Bool # (>) :: ConfluencePageFieldName -> ConfluencePageFieldName -> Bool # (>=) :: ConfluencePageFieldName -> ConfluencePageFieldName -> Bool # max :: ConfluencePageFieldName -> ConfluencePageFieldName -> ConfluencePageFieldName # min :: ConfluencePageFieldName -> ConfluencePageFieldName -> ConfluencePageFieldName #
Hashable ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName Methods hashWithSalt :: Int -> ConfluencePageFieldName -> Int # hash :: ConfluencePageFieldName -> Int #
type Rep ConfluencePageFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageFieldName type Rep ConfluencePageFieldName = D1 ('MetaData "ConfluencePageFieldName" "Amazonka.Kendra.Types.ConfluencePageFieldName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluencePageFieldName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluencePageFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceSpaceFieldName

newtype ConfluenceSpaceFieldName Source #

Constructors

ConfluenceSpaceFieldName'
Fields fromConfluenceSpaceFieldName :: Text

Bundled Patterns

pattern ConfluenceSpaceFieldName_DISPLAY_URL :: ConfluenceSpaceFieldName
pattern ConfluenceSpaceFieldName_ITEM_TYPE :: ConfluenceSpaceFieldName
pattern ConfluenceSpaceFieldName_SPACE_KEY :: ConfluenceSpaceFieldName
pattern ConfluenceSpaceFieldName_URL :: ConfluenceSpaceFieldName

Instances

Instances details

FromJSON ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods parseJSON :: Value -> Parser ConfluenceSpaceFieldName # parseJSONList :: Value -> Parser [ConfluenceSpaceFieldName] #
FromJSONKey ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods fromJSONKey :: FromJSONKeyFunction ConfluenceSpaceFieldName # fromJSONKeyList :: FromJSONKeyFunction [ConfluenceSpaceFieldName] #
ToJSON ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods toJSON :: ConfluenceSpaceFieldName -> Value # toEncoding :: ConfluenceSpaceFieldName -> Encoding # toJSONList :: [ConfluenceSpaceFieldName] -> Value # toEncodingList :: [ConfluenceSpaceFieldName] -> Encoding #
ToJSONKey ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods toJSONKey :: ToJSONKeyFunction ConfluenceSpaceFieldName # toJSONKeyList :: ToJSONKeyFunction [ConfluenceSpaceFieldName] #
ToByteString ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods toBS :: ConfluenceSpaceFieldName -> ByteString #
ToHeader ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods toHeader :: HeaderName -> ConfluenceSpaceFieldName -> [Header] #
ToLog ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods build :: ConfluenceSpaceFieldName -> ByteStringBuilder #
ToQuery ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods toQuery :: ConfluenceSpaceFieldName -> QueryString #
FromText ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods fromText :: Text -> Either String ConfluenceSpaceFieldName #
ToText ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods toText :: ConfluenceSpaceFieldName -> Text #
FromXML ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods parseXML :: [Node] -> Either String ConfluenceSpaceFieldName #
ToXML ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods toXML :: ConfluenceSpaceFieldName -> XML #
Generic ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Associated Types type Rep ConfluenceSpaceFieldName :: Type -> Type # Methods from :: ConfluenceSpaceFieldName -> Rep ConfluenceSpaceFieldName x # to :: Rep ConfluenceSpaceFieldName x -> ConfluenceSpaceFieldName #
Read ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods readsPrec :: Int -> ReadS ConfluenceSpaceFieldName # readList :: ReadS [ConfluenceSpaceFieldName] # readPrec :: ReadPrec ConfluenceSpaceFieldName # readListPrec :: ReadPrec [ConfluenceSpaceFieldName] #
Show ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods showsPrec :: Int -> ConfluenceSpaceFieldName -> ShowS # show :: ConfluenceSpaceFieldName -> String # showList :: [ConfluenceSpaceFieldName] -> ShowS #
NFData ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods rnf :: ConfluenceSpaceFieldName -> () #
Eq ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods (==) :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> Bool # (/=) :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> Bool #
Ord ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods compare :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> Ordering # (<) :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> Bool # (<=) :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> Bool # (>) :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> Bool # (>=) :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> Bool # max :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName # min :: ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName -> ConfluenceSpaceFieldName #
Hashable ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName Methods hashWithSalt :: Int -> ConfluenceSpaceFieldName -> Int # hash :: ConfluenceSpaceFieldName -> Int #
type Rep ConfluenceSpaceFieldName Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceFieldName type Rep ConfluenceSpaceFieldName = D1 ('MetaData "ConfluenceSpaceFieldName" "Amazonka.Kendra.Types.ConfluenceSpaceFieldName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceSpaceFieldName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceSpaceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConfluenceVersion

newtype ConfluenceVersion Source #

Constructors

ConfluenceVersion'
Fields fromConfluenceVersion :: Text

Bundled Patterns

pattern ConfluenceVersion_CLOUD :: ConfluenceVersion
pattern ConfluenceVersion_SERVER :: ConfluenceVersion

Instances

Instances details

FromJSON ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods parseJSON :: Value -> Parser ConfluenceVersion # parseJSONList :: Value -> Parser [ConfluenceVersion] #
FromJSONKey ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods fromJSONKey :: FromJSONKeyFunction ConfluenceVersion # fromJSONKeyList :: FromJSONKeyFunction [ConfluenceVersion] #
ToJSON ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods toJSON :: ConfluenceVersion -> Value # toEncoding :: ConfluenceVersion -> Encoding # toJSONList :: [ConfluenceVersion] -> Value # toEncodingList :: [ConfluenceVersion] -> Encoding #
ToJSONKey ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods toJSONKey :: ToJSONKeyFunction ConfluenceVersion # toJSONKeyList :: ToJSONKeyFunction [ConfluenceVersion] #
ToByteString ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods toBS :: ConfluenceVersion -> ByteString #
ToHeader ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods toHeader :: HeaderName -> ConfluenceVersion -> [Header] #
ToLog ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods build :: ConfluenceVersion -> ByteStringBuilder #
ToQuery ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods toQuery :: ConfluenceVersion -> QueryString #
FromText ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods fromText :: Text -> Either String ConfluenceVersion #
ToText ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods toText :: ConfluenceVersion -> Text #
FromXML ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods parseXML :: [Node] -> Either String ConfluenceVersion #
ToXML ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods toXML :: ConfluenceVersion -> XML #
Generic ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Associated Types type Rep ConfluenceVersion :: Type -> Type # Methods from :: ConfluenceVersion -> Rep ConfluenceVersion x # to :: Rep ConfluenceVersion x -> ConfluenceVersion #
Read ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods readsPrec :: Int -> ReadS ConfluenceVersion # readList :: ReadS [ConfluenceVersion] # readPrec :: ReadPrec ConfluenceVersion # readListPrec :: ReadPrec [ConfluenceVersion] #
Show ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods showsPrec :: Int -> ConfluenceVersion -> ShowS # show :: ConfluenceVersion -> String # showList :: [ConfluenceVersion] -> ShowS #
NFData ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods rnf :: ConfluenceVersion -> () #
Eq ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods (==) :: ConfluenceVersion -> ConfluenceVersion -> Bool # (/=) :: ConfluenceVersion -> ConfluenceVersion -> Bool #
Ord ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods compare :: ConfluenceVersion -> ConfluenceVersion -> Ordering # (<) :: ConfluenceVersion -> ConfluenceVersion -> Bool # (<=) :: ConfluenceVersion -> ConfluenceVersion -> Bool # (>) :: ConfluenceVersion -> ConfluenceVersion -> Bool # (>=) :: ConfluenceVersion -> ConfluenceVersion -> Bool # max :: ConfluenceVersion -> ConfluenceVersion -> ConfluenceVersion # min :: ConfluenceVersion -> ConfluenceVersion -> ConfluenceVersion #
Hashable ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion Methods hashWithSalt :: Int -> ConfluenceVersion -> Int # hash :: ConfluenceVersion -> Int #
type Rep ConfluenceVersion Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceVersion type Rep ConfluenceVersion = D1 ('MetaData "ConfluenceVersion" "Amazonka.Kendra.Types.ConfluenceVersion" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ConfluenceVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConfluenceVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ContentType

newtype ContentType Source #

Constructors

ContentType'
Fields fromContentType :: Text

Bundled Patterns

pattern ContentType_HTML :: ContentType
pattern ContentType_MS_WORD :: ContentType
pattern ContentType_PDF :: ContentType
pattern ContentType_PLAIN_TEXT :: ContentType
pattern ContentType_PPT :: ContentType

Instances

Instances details

FromJSON ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods parseJSON :: Value -> Parser ContentType # parseJSONList :: Value -> Parser [ContentType] #
FromJSONKey ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods fromJSONKey :: FromJSONKeyFunction ContentType # fromJSONKeyList :: FromJSONKeyFunction [ContentType] #
ToJSON ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods toJSON :: ContentType -> Value # toEncoding :: ContentType -> Encoding # toJSONList :: [ContentType] -> Value # toEncodingList :: [ContentType] -> Encoding #
ToJSONKey ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods toJSONKey :: ToJSONKeyFunction ContentType # toJSONKeyList :: ToJSONKeyFunction [ContentType] #
ToByteString ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods toBS :: ContentType -> ByteString #
ToHeader ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods toHeader :: HeaderName -> ContentType -> [Header] #
ToLog ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods build :: ContentType -> ByteStringBuilder #
ToQuery ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods toQuery :: ContentType -> QueryString #
FromText ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods fromText :: Text -> Either String ContentType #
ToText ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods toText :: ContentType -> Text #
FromXML ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods parseXML :: [Node] -> Either String ContentType #
ToXML ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods toXML :: ContentType -> XML #
Generic ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Associated Types type Rep ContentType :: Type -> Type # Methods from :: ContentType -> Rep ContentType x # to :: Rep ContentType x -> ContentType #
Read ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods readsPrec :: Int -> ReadS ContentType # readList :: ReadS [ContentType] # readPrec :: ReadPrec ContentType # readListPrec :: ReadPrec [ContentType] #
Show ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods showsPrec :: Int -> ContentType -> ShowS # show :: ContentType -> String # showList :: [ContentType] -> ShowS #
NFData ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods rnf :: ContentType -> () #
Eq ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods (==) :: ContentType -> ContentType -> Bool # (/=) :: ContentType -> ContentType -> Bool #
Ord ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods compare :: ContentType -> ContentType -> Ordering # (<) :: ContentType -> ContentType -> Bool # (<=) :: ContentType -> ContentType -> Bool # (>) :: ContentType -> ContentType -> Bool # (>=) :: ContentType -> ContentType -> Bool # max :: ContentType -> ContentType -> ContentType # min :: ContentType -> ContentType -> ContentType #
Hashable ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType Methods hashWithSalt :: Int -> ContentType -> Int # hash :: ContentType -> Int #
type Rep ContentType Source #
Instance details Defined in Amazonka.Kendra.Types.ContentType type Rep ContentType = D1 ('MetaData "ContentType" "Amazonka.Kendra.Types.ContentType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ContentType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataSourceStatus

newtype DataSourceStatus Source #

Constructors

DataSourceStatus'
Fields fromDataSourceStatus :: Text

Bundled Patterns

pattern DataSourceStatus_ACTIVE :: DataSourceStatus
pattern DataSourceStatus_CREATING :: DataSourceStatus
pattern DataSourceStatus_DELETING :: DataSourceStatus
pattern DataSourceStatus_FAILED :: DataSourceStatus
pattern DataSourceStatus_UPDATING :: DataSourceStatus

Instances

Instances details

FromJSON DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods parseJSON :: Value -> Parser DataSourceStatus # parseJSONList :: Value -> Parser [DataSourceStatus] #
FromJSONKey DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods fromJSONKey :: FromJSONKeyFunction DataSourceStatus # fromJSONKeyList :: FromJSONKeyFunction [DataSourceStatus] #
ToJSON DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods toJSON :: DataSourceStatus -> Value # toEncoding :: DataSourceStatus -> Encoding # toJSONList :: [DataSourceStatus] -> Value # toEncodingList :: [DataSourceStatus] -> Encoding #
ToJSONKey DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods toJSONKey :: ToJSONKeyFunction DataSourceStatus # toJSONKeyList :: ToJSONKeyFunction [DataSourceStatus] #
ToByteString DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods toBS :: DataSourceStatus -> ByteString #
ToHeader DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods toHeader :: HeaderName -> DataSourceStatus -> [Header] #
ToLog DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods build :: DataSourceStatus -> ByteStringBuilder #
ToQuery DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods toQuery :: DataSourceStatus -> QueryString #
FromText DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods fromText :: Text -> Either String DataSourceStatus #
ToText DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods toText :: DataSourceStatus -> Text #
FromXML DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods parseXML :: [Node] -> Either String DataSourceStatus #
ToXML DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods toXML :: DataSourceStatus -> XML #
Generic DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Associated Types type Rep DataSourceStatus :: Type -> Type # Methods from :: DataSourceStatus -> Rep DataSourceStatus x # to :: Rep DataSourceStatus x -> DataSourceStatus #
Read DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods readsPrec :: Int -> ReadS DataSourceStatus # readList :: ReadS [DataSourceStatus] # readPrec :: ReadPrec DataSourceStatus # readListPrec :: ReadPrec [DataSourceStatus] #
Show DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods showsPrec :: Int -> DataSourceStatus -> ShowS # show :: DataSourceStatus -> String # showList :: [DataSourceStatus] -> ShowS #
NFData DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods rnf :: DataSourceStatus -> () #
Eq DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods (==) :: DataSourceStatus -> DataSourceStatus -> Bool # (/=) :: DataSourceStatus -> DataSourceStatus -> Bool #
Ord DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods compare :: DataSourceStatus -> DataSourceStatus -> Ordering # (<) :: DataSourceStatus -> DataSourceStatus -> Bool # (<=) :: DataSourceStatus -> DataSourceStatus -> Bool # (>) :: DataSourceStatus -> DataSourceStatus -> Bool # (>=) :: DataSourceStatus -> DataSourceStatus -> Bool # max :: DataSourceStatus -> DataSourceStatus -> DataSourceStatus # min :: DataSourceStatus -> DataSourceStatus -> DataSourceStatus #
Hashable DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus Methods hashWithSalt :: Int -> DataSourceStatus -> Int # hash :: DataSourceStatus -> Int #
type Rep DataSourceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceStatus type Rep DataSourceStatus = D1 ('MetaData "DataSourceStatus" "Amazonka.Kendra.Types.DataSourceStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DataSourceStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataSourceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataSourceSyncJobStatus

newtype DataSourceSyncJobStatus Source #

Constructors

DataSourceSyncJobStatus'
Fields fromDataSourceSyncJobStatus :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods parseJSON :: Value -> Parser DataSourceSyncJobStatus # parseJSONList :: Value -> Parser [DataSourceSyncJobStatus] #
FromJSONKey DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods fromJSONKey :: FromJSONKeyFunction DataSourceSyncJobStatus # fromJSONKeyList :: FromJSONKeyFunction [DataSourceSyncJobStatus] #
ToJSON DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods toJSON :: DataSourceSyncJobStatus -> Value # toEncoding :: DataSourceSyncJobStatus -> Encoding # toJSONList :: [DataSourceSyncJobStatus] -> Value # toEncodingList :: [DataSourceSyncJobStatus] -> Encoding #
ToJSONKey DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods toJSONKey :: ToJSONKeyFunction DataSourceSyncJobStatus # toJSONKeyList :: ToJSONKeyFunction [DataSourceSyncJobStatus] #
ToByteString DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods toBS :: DataSourceSyncJobStatus -> ByteString #
ToHeader DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods toHeader :: HeaderName -> DataSourceSyncJobStatus -> [Header] #
ToLog DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods build :: DataSourceSyncJobStatus -> ByteStringBuilder #
ToQuery DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods toQuery :: DataSourceSyncJobStatus -> QueryString #
FromText DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods fromText :: Text -> Either String DataSourceSyncJobStatus #
ToText DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods toText :: DataSourceSyncJobStatus -> Text #
FromXML DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods parseXML :: [Node] -> Either String DataSourceSyncJobStatus #
ToXML DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods toXML :: DataSourceSyncJobStatus -> XML #
Generic DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Associated Types type Rep DataSourceSyncJobStatus :: Type -> Type # Methods from :: DataSourceSyncJobStatus -> Rep DataSourceSyncJobStatus x # to :: Rep DataSourceSyncJobStatus x -> DataSourceSyncJobStatus #
Read DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods readsPrec :: Int -> ReadS DataSourceSyncJobStatus # readList :: ReadS [DataSourceSyncJobStatus] # readPrec :: ReadPrec DataSourceSyncJobStatus # readListPrec :: ReadPrec [DataSourceSyncJobStatus] #
Show DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods showsPrec :: Int -> DataSourceSyncJobStatus -> ShowS # show :: DataSourceSyncJobStatus -> String # showList :: [DataSourceSyncJobStatus] -> ShowS #
NFData DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods rnf :: DataSourceSyncJobStatus -> () #
Eq DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods (==) :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> Bool # (/=) :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> Bool #
Ord DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods compare :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> Ordering # (<) :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> Bool # (<=) :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> Bool # (>) :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> Bool # (>=) :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> Bool # max :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> DataSourceSyncJobStatus # min :: DataSourceSyncJobStatus -> DataSourceSyncJobStatus -> DataSourceSyncJobStatus #
Hashable DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus Methods hashWithSalt :: Int -> DataSourceSyncJobStatus -> Int # hash :: DataSourceSyncJobStatus -> Int #
type Rep DataSourceSyncJobStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobStatus type Rep DataSourceSyncJobStatus = D1 ('MetaData "DataSourceSyncJobStatus" "Amazonka.Kendra.Types.DataSourceSyncJobStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DataSourceSyncJobStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataSourceSyncJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataSourceType

newtype DataSourceType Source #

Constructors

DataSourceType'
Fields fromDataSourceType :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods parseJSON :: Value -> Parser DataSourceType # parseJSONList :: Value -> Parser [DataSourceType] #
FromJSONKey DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods fromJSONKey :: FromJSONKeyFunction DataSourceType # fromJSONKeyList :: FromJSONKeyFunction [DataSourceType] #
ToJSON DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods toJSON :: DataSourceType -> Value # toEncoding :: DataSourceType -> Encoding # toJSONList :: [DataSourceType] -> Value # toEncodingList :: [DataSourceType] -> Encoding #
ToJSONKey DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods toJSONKey :: ToJSONKeyFunction DataSourceType # toJSONKeyList :: ToJSONKeyFunction [DataSourceType] #
ToByteString DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods toBS :: DataSourceType -> ByteString #
ToHeader DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods toHeader :: HeaderName -> DataSourceType -> [Header] #
ToLog DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods build :: DataSourceType -> ByteStringBuilder #
ToQuery DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods toQuery :: DataSourceType -> QueryString #
FromText DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods fromText :: Text -> Either String DataSourceType #
ToText DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods toText :: DataSourceType -> Text #
FromXML DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods parseXML :: [Node] -> Either String DataSourceType #
ToXML DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods toXML :: DataSourceType -> XML #
Generic DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Associated Types type Rep DataSourceType :: Type -> Type # Methods from :: DataSourceType -> Rep DataSourceType x # to :: Rep DataSourceType x -> DataSourceType #
Read DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods readsPrec :: Int -> ReadS DataSourceType # readList :: ReadS [DataSourceType] # readPrec :: ReadPrec DataSourceType # readListPrec :: ReadPrec [DataSourceType] #
Show DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods showsPrec :: Int -> DataSourceType -> ShowS # show :: DataSourceType -> String # showList :: [DataSourceType] -> ShowS #
NFData DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods rnf :: DataSourceType -> () #
Eq DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods (==) :: DataSourceType -> DataSourceType -> Bool # (/=) :: DataSourceType -> DataSourceType -> Bool #
Ord DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods compare :: DataSourceType -> DataSourceType -> Ordering # (<) :: DataSourceType -> DataSourceType -> Bool # (<=) :: DataSourceType -> DataSourceType -> Bool # (>) :: DataSourceType -> DataSourceType -> Bool # (>=) :: DataSourceType -> DataSourceType -> Bool # max :: DataSourceType -> DataSourceType -> DataSourceType # min :: DataSourceType -> DataSourceType -> DataSourceType #
Hashable DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType Methods hashWithSalt :: Int -> DataSourceType -> Int # hash :: DataSourceType -> Int #
type Rep DataSourceType Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceType type Rep DataSourceType = D1 ('MetaData "DataSourceType" "Amazonka.Kendra.Types.DataSourceType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DataSourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataSourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DatabaseEngineType

newtype DatabaseEngineType Source #

Constructors

DatabaseEngineType'
Fields fromDatabaseEngineType :: Text

Bundled Patterns

pattern DatabaseEngineType_RDS_AURORA_MYSQL :: DatabaseEngineType
pattern DatabaseEngineType_RDS_AURORA_POSTGRESQL :: DatabaseEngineType
pattern DatabaseEngineType_RDS_MYSQL :: DatabaseEngineType
pattern DatabaseEngineType_RDS_POSTGRESQL :: DatabaseEngineType

Instances

Instances details

FromJSON DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods parseJSON :: Value -> Parser DatabaseEngineType # parseJSONList :: Value -> Parser [DatabaseEngineType] #
FromJSONKey DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods fromJSONKey :: FromJSONKeyFunction DatabaseEngineType # fromJSONKeyList :: FromJSONKeyFunction [DatabaseEngineType] #
ToJSON DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods toJSON :: DatabaseEngineType -> Value # toEncoding :: DatabaseEngineType -> Encoding # toJSONList :: [DatabaseEngineType] -> Value # toEncodingList :: [DatabaseEngineType] -> Encoding #
ToJSONKey DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods toJSONKey :: ToJSONKeyFunction DatabaseEngineType # toJSONKeyList :: ToJSONKeyFunction [DatabaseEngineType] #
ToByteString DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods toBS :: DatabaseEngineType -> ByteString #
ToHeader DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods toHeader :: HeaderName -> DatabaseEngineType -> [Header] #
ToLog DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods build :: DatabaseEngineType -> ByteStringBuilder #
ToQuery DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods toQuery :: DatabaseEngineType -> QueryString #
FromText DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods fromText :: Text -> Either String DatabaseEngineType #
ToText DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods toText :: DatabaseEngineType -> Text #
FromXML DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods parseXML :: [Node] -> Either String DatabaseEngineType #
ToXML DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods toXML :: DatabaseEngineType -> XML #
Generic DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Associated Types type Rep DatabaseEngineType :: Type -> Type # Methods from :: DatabaseEngineType -> Rep DatabaseEngineType x # to :: Rep DatabaseEngineType x -> DatabaseEngineType #
Read DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods readsPrec :: Int -> ReadS DatabaseEngineType # readList :: ReadS [DatabaseEngineType] # readPrec :: ReadPrec DatabaseEngineType # readListPrec :: ReadPrec [DatabaseEngineType] #
Show DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods showsPrec :: Int -> DatabaseEngineType -> ShowS # show :: DatabaseEngineType -> String # showList :: [DatabaseEngineType] -> ShowS #
NFData DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods rnf :: DatabaseEngineType -> () #
Eq DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods (==) :: DatabaseEngineType -> DatabaseEngineType -> Bool # (/=) :: DatabaseEngineType -> DatabaseEngineType -> Bool #
Ord DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods compare :: DatabaseEngineType -> DatabaseEngineType -> Ordering # (<) :: DatabaseEngineType -> DatabaseEngineType -> Bool # (<=) :: DatabaseEngineType -> DatabaseEngineType -> Bool # (>) :: DatabaseEngineType -> DatabaseEngineType -> Bool # (>=) :: DatabaseEngineType -> DatabaseEngineType -> Bool # max :: DatabaseEngineType -> DatabaseEngineType -> DatabaseEngineType # min :: DatabaseEngineType -> DatabaseEngineType -> DatabaseEngineType #
Hashable DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType Methods hashWithSalt :: Int -> DatabaseEngineType -> Int # hash :: DatabaseEngineType -> Int #
type Rep DatabaseEngineType Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseEngineType type Rep DatabaseEngineType = D1 ('MetaData "DatabaseEngineType" "Amazonka.Kendra.Types.DatabaseEngineType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DatabaseEngineType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDatabaseEngineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentAttributeValueType

newtype DocumentAttributeValueType Source #

Constructors

DocumentAttributeValueType'
Fields fromDocumentAttributeValueType :: Text

Bundled Patterns

pattern DocumentAttributeValueType_DATE_VALUE :: DocumentAttributeValueType
pattern DocumentAttributeValueType_LONG_VALUE :: DocumentAttributeValueType
pattern DocumentAttributeValueType_STRING_LIST_VALUE :: DocumentAttributeValueType
pattern DocumentAttributeValueType_STRING_VALUE :: DocumentAttributeValueType

Instances

Instances details

FromJSON DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods parseJSON :: Value -> Parser DocumentAttributeValueType # parseJSONList :: Value -> Parser [DocumentAttributeValueType] #
FromJSONKey DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods fromJSONKey :: FromJSONKeyFunction DocumentAttributeValueType # fromJSONKeyList :: FromJSONKeyFunction [DocumentAttributeValueType] #
ToJSON DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods toJSON :: DocumentAttributeValueType -> Value # toEncoding :: DocumentAttributeValueType -> Encoding # toJSONList :: [DocumentAttributeValueType] -> Value # toEncodingList :: [DocumentAttributeValueType] -> Encoding #
ToJSONKey DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods toJSONKey :: ToJSONKeyFunction DocumentAttributeValueType # toJSONKeyList :: ToJSONKeyFunction [DocumentAttributeValueType] #
ToByteString DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods toBS :: DocumentAttributeValueType -> ByteString #
ToHeader DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods toHeader :: HeaderName -> DocumentAttributeValueType -> [Header] #
ToLog DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods build :: DocumentAttributeValueType -> ByteStringBuilder #
ToQuery DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods toQuery :: DocumentAttributeValueType -> QueryString #
FromText DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods fromText :: Text -> Either String DocumentAttributeValueType #
ToText DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods toText :: DocumentAttributeValueType -> Text #
FromXML DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods parseXML :: [Node] -> Either String DocumentAttributeValueType #
ToXML DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods toXML :: DocumentAttributeValueType -> XML #
Generic DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Associated Types type Rep DocumentAttributeValueType :: Type -> Type # Methods from :: DocumentAttributeValueType -> Rep DocumentAttributeValueType x # to :: Rep DocumentAttributeValueType x -> DocumentAttributeValueType #
Read DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods readsPrec :: Int -> ReadS DocumentAttributeValueType # readList :: ReadS [DocumentAttributeValueType] # readPrec :: ReadPrec DocumentAttributeValueType # readListPrec :: ReadPrec [DocumentAttributeValueType] #
Show DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods showsPrec :: Int -> DocumentAttributeValueType -> ShowS # show :: DocumentAttributeValueType -> String # showList :: [DocumentAttributeValueType] -> ShowS #
NFData DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods rnf :: DocumentAttributeValueType -> () #
Eq DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods (==) :: DocumentAttributeValueType -> DocumentAttributeValueType -> Bool # (/=) :: DocumentAttributeValueType -> DocumentAttributeValueType -> Bool #
Ord DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods compare :: DocumentAttributeValueType -> DocumentAttributeValueType -> Ordering # (<) :: DocumentAttributeValueType -> DocumentAttributeValueType -> Bool # (<=) :: DocumentAttributeValueType -> DocumentAttributeValueType -> Bool # (>) :: DocumentAttributeValueType -> DocumentAttributeValueType -> Bool # (>=) :: DocumentAttributeValueType -> DocumentAttributeValueType -> Bool # max :: DocumentAttributeValueType -> DocumentAttributeValueType -> DocumentAttributeValueType # min :: DocumentAttributeValueType -> DocumentAttributeValueType -> DocumentAttributeValueType #
Hashable DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType Methods hashWithSalt :: Int -> DocumentAttributeValueType -> Int # hash :: DocumentAttributeValueType -> Int #
type Rep DocumentAttributeValueType Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueType type Rep DocumentAttributeValueType = D1 ('MetaData "DocumentAttributeValueType" "Amazonka.Kendra.Types.DocumentAttributeValueType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DocumentAttributeValueType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentAttributeValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentStatus

newtype DocumentStatus Source #

Constructors

DocumentStatus'
Fields fromDocumentStatus :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods parseJSON :: Value -> Parser DocumentStatus # parseJSONList :: Value -> Parser [DocumentStatus] #
FromJSONKey DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods fromJSONKey :: FromJSONKeyFunction DocumentStatus # fromJSONKeyList :: FromJSONKeyFunction [DocumentStatus] #
ToJSON DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods toJSON :: DocumentStatus -> Value # toEncoding :: DocumentStatus -> Encoding # toJSONList :: [DocumentStatus] -> Value # toEncodingList :: [DocumentStatus] -> Encoding #
ToJSONKey DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods toJSONKey :: ToJSONKeyFunction DocumentStatus # toJSONKeyList :: ToJSONKeyFunction [DocumentStatus] #
ToByteString DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods toBS :: DocumentStatus -> ByteString #
ToHeader DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods toHeader :: HeaderName -> DocumentStatus -> [Header] #
ToLog DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods build :: DocumentStatus -> ByteStringBuilder #
ToQuery DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods toQuery :: DocumentStatus -> QueryString #
FromText DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods fromText :: Text -> Either String DocumentStatus #
ToText DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods toText :: DocumentStatus -> Text #
FromXML DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods parseXML :: [Node] -> Either String DocumentStatus #
ToXML DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods toXML :: DocumentStatus -> XML #
Generic DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Associated Types type Rep DocumentStatus :: Type -> Type # Methods from :: DocumentStatus -> Rep DocumentStatus x # to :: Rep DocumentStatus x -> DocumentStatus #
Read DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods readsPrec :: Int -> ReadS DocumentStatus # readList :: ReadS [DocumentStatus] # readPrec :: ReadPrec DocumentStatus # readListPrec :: ReadPrec [DocumentStatus] #
Show DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods showsPrec :: Int -> DocumentStatus -> ShowS # show :: DocumentStatus -> String # showList :: [DocumentStatus] -> ShowS #
NFData DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods rnf :: DocumentStatus -> () #
Eq DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods (==) :: DocumentStatus -> DocumentStatus -> Bool # (/=) :: DocumentStatus -> DocumentStatus -> Bool #
Ord DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods compare :: DocumentStatus -> DocumentStatus -> Ordering # (<) :: DocumentStatus -> DocumentStatus -> Bool # (<=) :: DocumentStatus -> DocumentStatus -> Bool # (>) :: DocumentStatus -> DocumentStatus -> Bool # (>=) :: DocumentStatus -> DocumentStatus -> Bool # max :: DocumentStatus -> DocumentStatus -> DocumentStatus # min :: DocumentStatus -> DocumentStatus -> DocumentStatus #
Hashable DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus Methods hashWithSalt :: Int -> DocumentStatus -> Int # hash :: DocumentStatus -> Int #
type Rep DocumentStatus Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentStatus type Rep DocumentStatus = D1 ('MetaData "DocumentStatus" "Amazonka.Kendra.Types.DocumentStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "DocumentStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EndpointType

newtype EndpointType Source #

Constructors

EndpointType'
Fields fromEndpointType :: Text

Bundled Patterns

pattern EndpointType_HOME :: EndpointType

Instances

Instances details

FromJSON EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods parseJSON :: Value -> Parser EndpointType # parseJSONList :: Value -> Parser [EndpointType] #
FromJSONKey EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods fromJSONKey :: FromJSONKeyFunction EndpointType # fromJSONKeyList :: FromJSONKeyFunction [EndpointType] #
ToJSON EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods toJSON :: EndpointType -> Value # toEncoding :: EndpointType -> Encoding # toJSONList :: [EndpointType] -> Value # toEncodingList :: [EndpointType] -> Encoding #
ToJSONKey EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods toJSONKey :: ToJSONKeyFunction EndpointType # toJSONKeyList :: ToJSONKeyFunction [EndpointType] #
ToByteString EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods toBS :: EndpointType -> ByteString #
ToHeader EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods toHeader :: HeaderName -> EndpointType -> [Header] #
ToLog EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods build :: EndpointType -> ByteStringBuilder #
ToQuery EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods toQuery :: EndpointType -> QueryString #
FromText EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods fromText :: Text -> Either String EndpointType #
ToText EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods toText :: EndpointType -> Text #
FromXML EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods parseXML :: [Node] -> Either String EndpointType #
ToXML EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods toXML :: EndpointType -> XML #
Generic EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Associated Types type Rep EndpointType :: Type -> Type # Methods from :: EndpointType -> Rep EndpointType x # to :: Rep EndpointType x -> EndpointType #
Read EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods readsPrec :: Int -> ReadS EndpointType # readList :: ReadS [EndpointType] # readPrec :: ReadPrec EndpointType # readListPrec :: ReadPrec [EndpointType] #
Show EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods showsPrec :: Int -> EndpointType -> ShowS # show :: EndpointType -> String # showList :: [EndpointType] -> ShowS #
NFData EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods rnf :: EndpointType -> () #
Eq EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods (==) :: EndpointType -> EndpointType -> Bool # (/=) :: EndpointType -> EndpointType -> Bool #
Ord EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods compare :: EndpointType -> EndpointType -> Ordering # (<) :: EndpointType -> EndpointType -> Bool # (<=) :: EndpointType -> EndpointType -> Bool # (>) :: EndpointType -> EndpointType -> Bool # (>=) :: EndpointType -> EndpointType -> Bool # max :: EndpointType -> EndpointType -> EndpointType # min :: EndpointType -> EndpointType -> EndpointType #
Hashable EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType Methods hashWithSalt :: Int -> EndpointType -> Int # hash :: EndpointType -> Int #
type Rep EndpointType Source #
Instance details Defined in Amazonka.Kendra.Types.EndpointType type Rep EndpointType = D1 ('MetaData "EndpointType" "Amazonka.Kendra.Types.EndpointType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "EndpointType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EntityType

newtype EntityType Source #

Constructors

EntityType'
Fields fromEntityType :: Text

Bundled Patterns

pattern EntityType_GROUP :: EntityType
pattern EntityType_USER :: EntityType

Instances

Instances details

FromJSON EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods parseJSON :: Value -> Parser EntityType # parseJSONList :: Value -> Parser [EntityType] #
FromJSONKey EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods fromJSONKey :: FromJSONKeyFunction EntityType # fromJSONKeyList :: FromJSONKeyFunction [EntityType] #
ToJSON EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods toJSON :: EntityType -> Value # toEncoding :: EntityType -> Encoding # toJSONList :: [EntityType] -> Value # toEncodingList :: [EntityType] -> Encoding #
ToJSONKey EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods toJSONKey :: ToJSONKeyFunction EntityType # toJSONKeyList :: ToJSONKeyFunction [EntityType] #
ToByteString EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods toBS :: EntityType -> ByteString #
ToHeader EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods toHeader :: HeaderName -> EntityType -> [Header] #
ToLog EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods build :: EntityType -> ByteStringBuilder #
ToQuery EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods toQuery :: EntityType -> QueryString #
FromText EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods fromText :: Text -> Either String EntityType #
ToText EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods toText :: EntityType -> Text #
FromXML EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods parseXML :: [Node] -> Either String EntityType #
ToXML EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods toXML :: EntityType -> XML #
Generic EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Associated Types type Rep EntityType :: Type -> Type # Methods from :: EntityType -> Rep EntityType x # to :: Rep EntityType x -> EntityType #
Read EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods readsPrec :: Int -> ReadS EntityType # readList :: ReadS [EntityType] # readPrec :: ReadPrec EntityType # readListPrec :: ReadPrec [EntityType] #
Show EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods showsPrec :: Int -> EntityType -> ShowS # show :: EntityType -> String # showList :: [EntityType] -> ShowS #
NFData EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods rnf :: EntityType -> () #
Eq EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods (==) :: EntityType -> EntityType -> Bool # (/=) :: EntityType -> EntityType -> Bool #
Ord EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods compare :: EntityType -> EntityType -> Ordering # (<) :: EntityType -> EntityType -> Bool # (<=) :: EntityType -> EntityType -> Bool # (>) :: EntityType -> EntityType -> Bool # (>=) :: EntityType -> EntityType -> Bool # max :: EntityType -> EntityType -> EntityType # min :: EntityType -> EntityType -> EntityType #
Hashable EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType Methods hashWithSalt :: Int -> EntityType -> Int # hash :: EntityType -> Int #
type Rep EntityType Source #
Instance details Defined in Amazonka.Kendra.Types.EntityType type Rep EntityType = D1 ('MetaData "EntityType" "Amazonka.Kendra.Types.EntityType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "EntityType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEntityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ErrorCode

newtype ErrorCode Source #

Constructors

ErrorCode'
Fields fromErrorCode :: Text

Bundled Patterns

pattern ErrorCode_InternalError :: ErrorCode
pattern ErrorCode_InvalidRequest :: ErrorCode

Instances

Instances details

FromJSON ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods parseJSON :: Value -> Parser ErrorCode # parseJSONList :: Value -> Parser [ErrorCode] #
FromJSONKey ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods fromJSONKey :: FromJSONKeyFunction ErrorCode # fromJSONKeyList :: FromJSONKeyFunction [ErrorCode] #
ToJSON ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods toJSON :: ErrorCode -> Value # toEncoding :: ErrorCode -> Encoding # toJSONList :: [ErrorCode] -> Value # toEncodingList :: [ErrorCode] -> Encoding #
ToJSONKey ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods toJSONKey :: ToJSONKeyFunction ErrorCode # toJSONKeyList :: ToJSONKeyFunction [ErrorCode] #
ToByteString ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods toBS :: ErrorCode -> ByteString #
ToHeader ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods toHeader :: HeaderName -> ErrorCode -> [Header] #
ToLog ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods build :: ErrorCode -> ByteStringBuilder #
ToQuery ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods toQuery :: ErrorCode -> QueryString #
FromText ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods fromText :: Text -> Either String ErrorCode #
ToText ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods toText :: ErrorCode -> Text #
FromXML ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods parseXML :: [Node] -> Either String ErrorCode #
ToXML ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods toXML :: ErrorCode -> XML #
Generic ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Associated Types type Rep ErrorCode :: Type -> Type # Methods from :: ErrorCode -> Rep ErrorCode x # to :: Rep ErrorCode x -> ErrorCode #
Read ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods readsPrec :: Int -> ReadS ErrorCode # readList :: ReadS [ErrorCode] # readPrec :: ReadPrec ErrorCode # readListPrec :: ReadPrec [ErrorCode] #
Show ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods showsPrec :: Int -> ErrorCode -> ShowS # show :: ErrorCode -> String # showList :: [ErrorCode] -> ShowS #
NFData ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods rnf :: ErrorCode -> () #
Eq ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods (==) :: ErrorCode -> ErrorCode -> Bool # (/=) :: ErrorCode -> ErrorCode -> Bool #
Ord ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods compare :: ErrorCode -> ErrorCode -> Ordering # (<) :: ErrorCode -> ErrorCode -> Bool # (<=) :: ErrorCode -> ErrorCode -> Bool # (>) :: ErrorCode -> ErrorCode -> Bool # (>=) :: ErrorCode -> ErrorCode -> Bool # max :: ErrorCode -> ErrorCode -> ErrorCode # min :: ErrorCode -> ErrorCode -> ErrorCode #
Hashable ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode Methods hashWithSalt :: Int -> ErrorCode -> Int # hash :: ErrorCode -> Int #
type Rep ErrorCode Source #
Instance details Defined in Amazonka.Kendra.Types.ErrorCode type Rep ErrorCode = D1 ('MetaData "ErrorCode" "Amazonka.Kendra.Types.ErrorCode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ErrorCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromErrorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExperienceStatus

newtype ExperienceStatus Source #

Constructors

ExperienceStatus'
Fields fromExperienceStatus :: Text

Bundled Patterns

pattern ExperienceStatus_ACTIVE :: ExperienceStatus
pattern ExperienceStatus_CREATING :: ExperienceStatus
pattern ExperienceStatus_DELETING :: ExperienceStatus
pattern ExperienceStatus_FAILED :: ExperienceStatus

Instances

Instances details

FromJSON ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods parseJSON :: Value -> Parser ExperienceStatus # parseJSONList :: Value -> Parser [ExperienceStatus] #
FromJSONKey ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods fromJSONKey :: FromJSONKeyFunction ExperienceStatus # fromJSONKeyList :: FromJSONKeyFunction [ExperienceStatus] #
ToJSON ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods toJSON :: ExperienceStatus -> Value # toEncoding :: ExperienceStatus -> Encoding # toJSONList :: [ExperienceStatus] -> Value # toEncodingList :: [ExperienceStatus] -> Encoding #
ToJSONKey ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods toJSONKey :: ToJSONKeyFunction ExperienceStatus # toJSONKeyList :: ToJSONKeyFunction [ExperienceStatus] #
ToByteString ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods toBS :: ExperienceStatus -> ByteString #
ToHeader ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods toHeader :: HeaderName -> ExperienceStatus -> [Header] #
ToLog ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods build :: ExperienceStatus -> ByteStringBuilder #
ToQuery ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods toQuery :: ExperienceStatus -> QueryString #
FromText ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods fromText :: Text -> Either String ExperienceStatus #
ToText ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods toText :: ExperienceStatus -> Text #
FromXML ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods parseXML :: [Node] -> Either String ExperienceStatus #
ToXML ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods toXML :: ExperienceStatus -> XML #
Generic ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Associated Types type Rep ExperienceStatus :: Type -> Type # Methods from :: ExperienceStatus -> Rep ExperienceStatus x # to :: Rep ExperienceStatus x -> ExperienceStatus #
Read ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods readsPrec :: Int -> ReadS ExperienceStatus # readList :: ReadS [ExperienceStatus] # readPrec :: ReadPrec ExperienceStatus # readListPrec :: ReadPrec [ExperienceStatus] #
Show ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods showsPrec :: Int -> ExperienceStatus -> ShowS # show :: ExperienceStatus -> String # showList :: [ExperienceStatus] -> ShowS #
NFData ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods rnf :: ExperienceStatus -> () #
Eq ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods (==) :: ExperienceStatus -> ExperienceStatus -> Bool # (/=) :: ExperienceStatus -> ExperienceStatus -> Bool #
Ord ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods compare :: ExperienceStatus -> ExperienceStatus -> Ordering # (<) :: ExperienceStatus -> ExperienceStatus -> Bool # (<=) :: ExperienceStatus -> ExperienceStatus -> Bool # (>) :: ExperienceStatus -> ExperienceStatus -> Bool # (>=) :: ExperienceStatus -> ExperienceStatus -> Bool # max :: ExperienceStatus -> ExperienceStatus -> ExperienceStatus # min :: ExperienceStatus -> ExperienceStatus -> ExperienceStatus #
Hashable ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus Methods hashWithSalt :: Int -> ExperienceStatus -> Int # hash :: ExperienceStatus -> Int #
type Rep ExperienceStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceStatus type Rep ExperienceStatus = D1 ('MetaData "ExperienceStatus" "Amazonka.Kendra.Types.ExperienceStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ExperienceStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExperienceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FaqFileFormat

newtype FaqFileFormat Source #

Constructors

FaqFileFormat'
Fields fromFaqFileFormat :: Text

Bundled Patterns

pattern FaqFileFormat_CSV :: FaqFileFormat
pattern FaqFileFormat_CSV_WITH_HEADER :: FaqFileFormat
pattern FaqFileFormat_JSON :: FaqFileFormat

Instances

Instances details

FromJSON FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods parseJSON :: Value -> Parser FaqFileFormat # parseJSONList :: Value -> Parser [FaqFileFormat] #
FromJSONKey FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods fromJSONKey :: FromJSONKeyFunction FaqFileFormat # fromJSONKeyList :: FromJSONKeyFunction [FaqFileFormat] #
ToJSON FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods toJSON :: FaqFileFormat -> Value # toEncoding :: FaqFileFormat -> Encoding # toJSONList :: [FaqFileFormat] -> Value # toEncodingList :: [FaqFileFormat] -> Encoding #
ToJSONKey FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods toJSONKey :: ToJSONKeyFunction FaqFileFormat # toJSONKeyList :: ToJSONKeyFunction [FaqFileFormat] #
ToByteString FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods toBS :: FaqFileFormat -> ByteString #
ToHeader FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods toHeader :: HeaderName -> FaqFileFormat -> [Header] #
ToLog FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods build :: FaqFileFormat -> ByteStringBuilder #
ToQuery FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods toQuery :: FaqFileFormat -> QueryString #
FromText FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods fromText :: Text -> Either String FaqFileFormat #
ToText FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods toText :: FaqFileFormat -> Text #
FromXML FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods parseXML :: [Node] -> Either String FaqFileFormat #
ToXML FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods toXML :: FaqFileFormat -> XML #
Generic FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Associated Types type Rep FaqFileFormat :: Type -> Type # Methods from :: FaqFileFormat -> Rep FaqFileFormat x # to :: Rep FaqFileFormat x -> FaqFileFormat #
Read FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods readsPrec :: Int -> ReadS FaqFileFormat # readList :: ReadS [FaqFileFormat] # readPrec :: ReadPrec FaqFileFormat # readListPrec :: ReadPrec [FaqFileFormat] #
Show FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods showsPrec :: Int -> FaqFileFormat -> ShowS # show :: FaqFileFormat -> String # showList :: [FaqFileFormat] -> ShowS #
NFData FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods rnf :: FaqFileFormat -> () #
Eq FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods (==) :: FaqFileFormat -> FaqFileFormat -> Bool # (/=) :: FaqFileFormat -> FaqFileFormat -> Bool #
Ord FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods compare :: FaqFileFormat -> FaqFileFormat -> Ordering # (<) :: FaqFileFormat -> FaqFileFormat -> Bool # (<=) :: FaqFileFormat -> FaqFileFormat -> Bool # (>) :: FaqFileFormat -> FaqFileFormat -> Bool # (>=) :: FaqFileFormat -> FaqFileFormat -> Bool # max :: FaqFileFormat -> FaqFileFormat -> FaqFileFormat # min :: FaqFileFormat -> FaqFileFormat -> FaqFileFormat #
Hashable FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat Methods hashWithSalt :: Int -> FaqFileFormat -> Int # hash :: FaqFileFormat -> Int #
type Rep FaqFileFormat Source #
Instance details Defined in Amazonka.Kendra.Types.FaqFileFormat type Rep FaqFileFormat = D1 ('MetaData "FaqFileFormat" "Amazonka.Kendra.Types.FaqFileFormat" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "FaqFileFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFaqFileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FaqStatus

newtype FaqStatus Source #

Constructors

FaqStatus'
Fields fromFaqStatus :: Text

Bundled Patterns

pattern FaqStatus_ACTIVE :: FaqStatus
pattern FaqStatus_CREATING :: FaqStatus
pattern FaqStatus_DELETING :: FaqStatus
pattern FaqStatus_FAILED :: FaqStatus
pattern FaqStatus_UPDATING :: FaqStatus

Instances

Instances details

FromJSON FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods parseJSON :: Value -> Parser FaqStatus # parseJSONList :: Value -> Parser [FaqStatus] #
FromJSONKey FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods fromJSONKey :: FromJSONKeyFunction FaqStatus # fromJSONKeyList :: FromJSONKeyFunction [FaqStatus] #
ToJSON FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods toJSON :: FaqStatus -> Value # toEncoding :: FaqStatus -> Encoding # toJSONList :: [FaqStatus] -> Value # toEncodingList :: [FaqStatus] -> Encoding #
ToJSONKey FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods toJSONKey :: ToJSONKeyFunction FaqStatus # toJSONKeyList :: ToJSONKeyFunction [FaqStatus] #
ToByteString FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods toBS :: FaqStatus -> ByteString #
ToHeader FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods toHeader :: HeaderName -> FaqStatus -> [Header] #
ToLog FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods build :: FaqStatus -> ByteStringBuilder #
ToQuery FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods toQuery :: FaqStatus -> QueryString #
FromText FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods fromText :: Text -> Either String FaqStatus #
ToText FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods toText :: FaqStatus -> Text #
FromXML FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods parseXML :: [Node] -> Either String FaqStatus #
ToXML FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods toXML :: FaqStatus -> XML #
Generic FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Associated Types type Rep FaqStatus :: Type -> Type # Methods from :: FaqStatus -> Rep FaqStatus x # to :: Rep FaqStatus x -> FaqStatus #
Read FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods readsPrec :: Int -> ReadS FaqStatus # readList :: ReadS [FaqStatus] # readPrec :: ReadPrec FaqStatus # readListPrec :: ReadPrec [FaqStatus] #
Show FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods showsPrec :: Int -> FaqStatus -> ShowS # show :: FaqStatus -> String # showList :: [FaqStatus] -> ShowS #
NFData FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods rnf :: FaqStatus -> () #
Eq FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods (==) :: FaqStatus -> FaqStatus -> Bool # (/=) :: FaqStatus -> FaqStatus -> Bool #
Ord FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods compare :: FaqStatus -> FaqStatus -> Ordering # (<) :: FaqStatus -> FaqStatus -> Bool # (<=) :: FaqStatus -> FaqStatus -> Bool # (>) :: FaqStatus -> FaqStatus -> Bool # (>=) :: FaqStatus -> FaqStatus -> Bool # max :: FaqStatus -> FaqStatus -> FaqStatus # min :: FaqStatus -> FaqStatus -> FaqStatus #
Hashable FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus Methods hashWithSalt :: Int -> FaqStatus -> Int # hash :: FaqStatus -> Int #
type Rep FaqStatus Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatus type Rep FaqStatus = D1 ('MetaData "FaqStatus" "Amazonka.Kendra.Types.FaqStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "FaqStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFaqStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FsxFileSystemType

newtype FsxFileSystemType Source #

Constructors

FsxFileSystemType'
Fields fromFsxFileSystemType :: Text

Bundled Patterns

pattern FsxFileSystemType_WINDOWS :: FsxFileSystemType

Instances

Instances details

FromJSON FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods parseJSON :: Value -> Parser FsxFileSystemType # parseJSONList :: Value -> Parser [FsxFileSystemType] #
FromJSONKey FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods fromJSONKey :: FromJSONKeyFunction FsxFileSystemType # fromJSONKeyList :: FromJSONKeyFunction [FsxFileSystemType] #
ToJSON FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods toJSON :: FsxFileSystemType -> Value # toEncoding :: FsxFileSystemType -> Encoding # toJSONList :: [FsxFileSystemType] -> Value # toEncodingList :: [FsxFileSystemType] -> Encoding #
ToJSONKey FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods toJSONKey :: ToJSONKeyFunction FsxFileSystemType # toJSONKeyList :: ToJSONKeyFunction [FsxFileSystemType] #
ToByteString FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods toBS :: FsxFileSystemType -> ByteString #
ToHeader FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods toHeader :: HeaderName -> FsxFileSystemType -> [Header] #
ToLog FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods build :: FsxFileSystemType -> ByteStringBuilder #
ToQuery FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods toQuery :: FsxFileSystemType -> QueryString #
FromText FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods fromText :: Text -> Either String FsxFileSystemType #
ToText FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods toText :: FsxFileSystemType -> Text #
FromXML FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods parseXML :: [Node] -> Either String FsxFileSystemType #
ToXML FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods toXML :: FsxFileSystemType -> XML #
Generic FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Associated Types type Rep FsxFileSystemType :: Type -> Type # Methods from :: FsxFileSystemType -> Rep FsxFileSystemType x # to :: Rep FsxFileSystemType x -> FsxFileSystemType #
Read FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods readsPrec :: Int -> ReadS FsxFileSystemType # readList :: ReadS [FsxFileSystemType] # readPrec :: ReadPrec FsxFileSystemType # readListPrec :: ReadPrec [FsxFileSystemType] #
Show FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods showsPrec :: Int -> FsxFileSystemType -> ShowS # show :: FsxFileSystemType -> String # showList :: [FsxFileSystemType] -> ShowS #
NFData FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods rnf :: FsxFileSystemType -> () #
Eq FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods (==) :: FsxFileSystemType -> FsxFileSystemType -> Bool # (/=) :: FsxFileSystemType -> FsxFileSystemType -> Bool #
Ord FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods compare :: FsxFileSystemType -> FsxFileSystemType -> Ordering # (<) :: FsxFileSystemType -> FsxFileSystemType -> Bool # (<=) :: FsxFileSystemType -> FsxFileSystemType -> Bool # (>) :: FsxFileSystemType -> FsxFileSystemType -> Bool # (>=) :: FsxFileSystemType -> FsxFileSystemType -> Bool # max :: FsxFileSystemType -> FsxFileSystemType -> FsxFileSystemType # min :: FsxFileSystemType -> FsxFileSystemType -> FsxFileSystemType #
Hashable FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType Methods hashWithSalt :: Int -> FsxFileSystemType -> Int # hash :: FsxFileSystemType -> Int #
type Rep FsxFileSystemType Source #
Instance details Defined in Amazonka.Kendra.Types.FsxFileSystemType type Rep FsxFileSystemType = D1 ('MetaData "FsxFileSystemType" "Amazonka.Kendra.Types.FsxFileSystemType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "FsxFileSystemType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFsxFileSystemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

HighlightType

newtype HighlightType Source #

Constructors

HighlightType'
Fields fromHighlightType :: Text

Bundled Patterns

pattern HighlightType_STANDARD :: HighlightType
pattern HighlightType_THESAURUS_SYNONYM :: HighlightType

Instances

Instances details

FromJSON HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods parseJSON :: Value -> Parser HighlightType # parseJSONList :: Value -> Parser [HighlightType] #
FromJSONKey HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods fromJSONKey :: FromJSONKeyFunction HighlightType # fromJSONKeyList :: FromJSONKeyFunction [HighlightType] #
ToJSON HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods toJSON :: HighlightType -> Value # toEncoding :: HighlightType -> Encoding # toJSONList :: [HighlightType] -> Value # toEncodingList :: [HighlightType] -> Encoding #
ToJSONKey HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods toJSONKey :: ToJSONKeyFunction HighlightType # toJSONKeyList :: ToJSONKeyFunction [HighlightType] #
ToByteString HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods toBS :: HighlightType -> ByteString #
ToHeader HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods toHeader :: HeaderName -> HighlightType -> [Header] #
ToLog HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods build :: HighlightType -> ByteStringBuilder #
ToQuery HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods toQuery :: HighlightType -> QueryString #
FromText HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods fromText :: Text -> Either String HighlightType #
ToText HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods toText :: HighlightType -> Text #
FromXML HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods parseXML :: [Node] -> Either String HighlightType #
ToXML HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods toXML :: HighlightType -> XML #
Generic HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Associated Types type Rep HighlightType :: Type -> Type # Methods from :: HighlightType -> Rep HighlightType x # to :: Rep HighlightType x -> HighlightType #
Read HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods readsPrec :: Int -> ReadS HighlightType # readList :: ReadS [HighlightType] # readPrec :: ReadPrec HighlightType # readListPrec :: ReadPrec [HighlightType] #
Show HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods showsPrec :: Int -> HighlightType -> ShowS # show :: HighlightType -> String # showList :: [HighlightType] -> ShowS #
NFData HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods rnf :: HighlightType -> () #
Eq HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods (==) :: HighlightType -> HighlightType -> Bool # (/=) :: HighlightType -> HighlightType -> Bool #
Ord HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods compare :: HighlightType -> HighlightType -> Ordering # (<) :: HighlightType -> HighlightType -> Bool # (<=) :: HighlightType -> HighlightType -> Bool # (>) :: HighlightType -> HighlightType -> Bool # (>=) :: HighlightType -> HighlightType -> Bool # max :: HighlightType -> HighlightType -> HighlightType # min :: HighlightType -> HighlightType -> HighlightType #
Hashable HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType Methods hashWithSalt :: Int -> HighlightType -> Int # hash :: HighlightType -> Int #
type Rep HighlightType Source #
Instance details Defined in Amazonka.Kendra.Types.HighlightType type Rep HighlightType = D1 ('MetaData "HighlightType" "Amazonka.Kendra.Types.HighlightType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "HighlightType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromHighlightType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IndexEdition

newtype IndexEdition Source #

Constructors

IndexEdition'
Fields fromIndexEdition :: Text

Bundled Patterns

pattern IndexEdition_DEVELOPER_EDITION :: IndexEdition
pattern IndexEdition_ENTERPRISE_EDITION :: IndexEdition

Instances

Instances details

FromJSON IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods parseJSON :: Value -> Parser IndexEdition # parseJSONList :: Value -> Parser [IndexEdition] #
FromJSONKey IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods fromJSONKey :: FromJSONKeyFunction IndexEdition # fromJSONKeyList :: FromJSONKeyFunction [IndexEdition] #
ToJSON IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods toJSON :: IndexEdition -> Value # toEncoding :: IndexEdition -> Encoding # toJSONList :: [IndexEdition] -> Value # toEncodingList :: [IndexEdition] -> Encoding #
ToJSONKey IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods toJSONKey :: ToJSONKeyFunction IndexEdition # toJSONKeyList :: ToJSONKeyFunction [IndexEdition] #
ToByteString IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods toBS :: IndexEdition -> ByteString #
ToHeader IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods toHeader :: HeaderName -> IndexEdition -> [Header] #
ToLog IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods build :: IndexEdition -> ByteStringBuilder #
ToQuery IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods toQuery :: IndexEdition -> QueryString #
FromText IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods fromText :: Text -> Either String IndexEdition #
ToText IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods toText :: IndexEdition -> Text #
FromXML IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods parseXML :: [Node] -> Either String IndexEdition #
ToXML IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods toXML :: IndexEdition -> XML #
Generic IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Associated Types type Rep IndexEdition :: Type -> Type # Methods from :: IndexEdition -> Rep IndexEdition x # to :: Rep IndexEdition x -> IndexEdition #
Read IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods readsPrec :: Int -> ReadS IndexEdition # readList :: ReadS [IndexEdition] # readPrec :: ReadPrec IndexEdition # readListPrec :: ReadPrec [IndexEdition] #
Show IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods showsPrec :: Int -> IndexEdition -> ShowS # show :: IndexEdition -> String # showList :: [IndexEdition] -> ShowS #
NFData IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods rnf :: IndexEdition -> () #
Eq IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods (==) :: IndexEdition -> IndexEdition -> Bool # (/=) :: IndexEdition -> IndexEdition -> Bool #
Ord IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods compare :: IndexEdition -> IndexEdition -> Ordering # (<) :: IndexEdition -> IndexEdition -> Bool # (<=) :: IndexEdition -> IndexEdition -> Bool # (>) :: IndexEdition -> IndexEdition -> Bool # (>=) :: IndexEdition -> IndexEdition -> Bool # max :: IndexEdition -> IndexEdition -> IndexEdition # min :: IndexEdition -> IndexEdition -> IndexEdition #
Hashable IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition Methods hashWithSalt :: Int -> IndexEdition -> Int # hash :: IndexEdition -> Int #
type Rep IndexEdition Source #
Instance details Defined in Amazonka.Kendra.Types.IndexEdition type Rep IndexEdition = D1 ('MetaData "IndexEdition" "Amazonka.Kendra.Types.IndexEdition" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "IndexEdition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIndexEdition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IndexStatus

newtype IndexStatus Source #

Constructors

IndexStatus'
Fields fromIndexStatus :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods parseJSON :: Value -> Parser IndexStatus # parseJSONList :: Value -> Parser [IndexStatus] #
FromJSONKey IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods fromJSONKey :: FromJSONKeyFunction IndexStatus # fromJSONKeyList :: FromJSONKeyFunction [IndexStatus] #
ToJSON IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods toJSON :: IndexStatus -> Value # toEncoding :: IndexStatus -> Encoding # toJSONList :: [IndexStatus] -> Value # toEncodingList :: [IndexStatus] -> Encoding #
ToJSONKey IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods toJSONKey :: ToJSONKeyFunction IndexStatus # toJSONKeyList :: ToJSONKeyFunction [IndexStatus] #
ToByteString IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods toBS :: IndexStatus -> ByteString #
ToHeader IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods toHeader :: HeaderName -> IndexStatus -> [Header] #
ToLog IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods build :: IndexStatus -> ByteStringBuilder #
ToQuery IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods toQuery :: IndexStatus -> QueryString #
FromText IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods fromText :: Text -> Either String IndexStatus #
ToText IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods toText :: IndexStatus -> Text #
FromXML IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods parseXML :: [Node] -> Either String IndexStatus #
ToXML IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods toXML :: IndexStatus -> XML #
Generic IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Associated Types type Rep IndexStatus :: Type -> Type # Methods from :: IndexStatus -> Rep IndexStatus x # to :: Rep IndexStatus x -> IndexStatus #
Read IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods readsPrec :: Int -> ReadS IndexStatus # readList :: ReadS [IndexStatus] # readPrec :: ReadPrec IndexStatus # readListPrec :: ReadPrec [IndexStatus] #
Show IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods showsPrec :: Int -> IndexStatus -> ShowS # show :: IndexStatus -> String # showList :: [IndexStatus] -> ShowS #
NFData IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods rnf :: IndexStatus -> () #
Eq IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods (==) :: IndexStatus -> IndexStatus -> Bool # (/=) :: IndexStatus -> IndexStatus -> Bool #
Ord IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods compare :: IndexStatus -> IndexStatus -> Ordering # (<) :: IndexStatus -> IndexStatus -> Bool # (<=) :: IndexStatus -> IndexStatus -> Bool # (>) :: IndexStatus -> IndexStatus -> Bool # (>=) :: IndexStatus -> IndexStatus -> Bool # max :: IndexStatus -> IndexStatus -> IndexStatus # min :: IndexStatus -> IndexStatus -> IndexStatus #
Hashable IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus Methods hashWithSalt :: Int -> IndexStatus -> Int # hash :: IndexStatus -> Int #
type Rep IndexStatus Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatus type Rep IndexStatus = D1 ('MetaData "IndexStatus" "Amazonka.Kendra.Types.IndexStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "IndexStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIndexStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Interval

newtype Interval Source #

Constructors

Interval'
Fields fromInterval :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods parseJSON :: Value -> Parser Interval # parseJSONList :: Value -> Parser [Interval] #
FromJSONKey Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods fromJSONKey :: FromJSONKeyFunction Interval # fromJSONKeyList :: FromJSONKeyFunction [Interval] #
ToJSON Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods toJSON :: Interval -> Value # toEncoding :: Interval -> Encoding # toJSONList :: [Interval] -> Value # toEncodingList :: [Interval] -> Encoding #
ToJSONKey Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods toJSONKey :: ToJSONKeyFunction Interval # toJSONKeyList :: ToJSONKeyFunction [Interval] #
ToByteString Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods toBS :: Interval -> ByteString #
ToHeader Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods toHeader :: HeaderName -> Interval -> [Header] #
ToLog Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods build :: Interval -> ByteStringBuilder #
ToQuery Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods toQuery :: Interval -> QueryString #
FromText Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods fromText :: Text -> Either String Interval #
ToText Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods toText :: Interval -> Text #
FromXML Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods parseXML :: [Node] -> Either String Interval #
ToXML Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods toXML :: Interval -> XML #
Generic Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Associated Types type Rep Interval :: Type -> Type # Methods from :: Interval -> Rep Interval x # to :: Rep Interval x -> Interval #
Read Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods readsPrec :: Int -> ReadS Interval # readList :: ReadS [Interval] # readPrec :: ReadPrec Interval # readListPrec :: ReadPrec [Interval] #
Show Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods showsPrec :: Int -> Interval -> ShowS # show :: Interval -> String # showList :: [Interval] -> ShowS #
NFData Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods rnf :: Interval -> () #
Eq Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods (==) :: Interval -> Interval -> Bool # (/=) :: Interval -> Interval -> Bool #
Ord Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods compare :: Interval -> Interval -> Ordering # (<) :: Interval -> Interval -> Bool # (<=) :: Interval -> Interval -> Bool # (>) :: Interval -> Interval -> Bool # (>=) :: Interval -> Interval -> Bool # max :: Interval -> Interval -> Interval # min :: Interval -> Interval -> Interval #
Hashable Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval Methods hashWithSalt :: Int -> Interval -> Int # hash :: Interval -> Int #
type Rep Interval Source #
Instance details Defined in Amazonka.Kendra.Types.Interval type Rep Interval = D1 ('MetaData "Interval" "Amazonka.Kendra.Types.Interval" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Interval'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IssueSubEntity

newtype IssueSubEntity Source #

Constructors

IssueSubEntity'
Fields fromIssueSubEntity :: Text

Bundled Patterns

pattern IssueSubEntity_ATTACHMENTS :: IssueSubEntity
pattern IssueSubEntity_COMMENTS :: IssueSubEntity
pattern IssueSubEntity_WORKLOGS :: IssueSubEntity

Instances

Instances details

FromJSON IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods parseJSON :: Value -> Parser IssueSubEntity # parseJSONList :: Value -> Parser [IssueSubEntity] #
FromJSONKey IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods fromJSONKey :: FromJSONKeyFunction IssueSubEntity # fromJSONKeyList :: FromJSONKeyFunction [IssueSubEntity] #
ToJSON IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods toJSON :: IssueSubEntity -> Value # toEncoding :: IssueSubEntity -> Encoding # toJSONList :: [IssueSubEntity] -> Value # toEncodingList :: [IssueSubEntity] -> Encoding #
ToJSONKey IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods toJSONKey :: ToJSONKeyFunction IssueSubEntity # toJSONKeyList :: ToJSONKeyFunction [IssueSubEntity] #
ToByteString IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods toBS :: IssueSubEntity -> ByteString #
ToHeader IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods toHeader :: HeaderName -> IssueSubEntity -> [Header] #
ToLog IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods build :: IssueSubEntity -> ByteStringBuilder #
ToQuery IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods toQuery :: IssueSubEntity -> QueryString #
FromText IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods fromText :: Text -> Either String IssueSubEntity #
ToText IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods toText :: IssueSubEntity -> Text #
FromXML IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods parseXML :: [Node] -> Either String IssueSubEntity #
ToXML IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods toXML :: IssueSubEntity -> XML #
Generic IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Associated Types type Rep IssueSubEntity :: Type -> Type # Methods from :: IssueSubEntity -> Rep IssueSubEntity x # to :: Rep IssueSubEntity x -> IssueSubEntity #
Read IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods readsPrec :: Int -> ReadS IssueSubEntity # readList :: ReadS [IssueSubEntity] # readPrec :: ReadPrec IssueSubEntity # readListPrec :: ReadPrec [IssueSubEntity] #
Show IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods showsPrec :: Int -> IssueSubEntity -> ShowS # show :: IssueSubEntity -> String # showList :: [IssueSubEntity] -> ShowS #
NFData IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods rnf :: IssueSubEntity -> () #
Eq IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods (==) :: IssueSubEntity -> IssueSubEntity -> Bool # (/=) :: IssueSubEntity -> IssueSubEntity -> Bool #
Ord IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods compare :: IssueSubEntity -> IssueSubEntity -> Ordering # (<) :: IssueSubEntity -> IssueSubEntity -> Bool # (<=) :: IssueSubEntity -> IssueSubEntity -> Bool # (>) :: IssueSubEntity -> IssueSubEntity -> Bool # (>=) :: IssueSubEntity -> IssueSubEntity -> Bool # max :: IssueSubEntity -> IssueSubEntity -> IssueSubEntity # min :: IssueSubEntity -> IssueSubEntity -> IssueSubEntity #
Hashable IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity Methods hashWithSalt :: Int -> IssueSubEntity -> Int # hash :: IssueSubEntity -> Int #
type Rep IssueSubEntity Source #
Instance details Defined in Amazonka.Kendra.Types.IssueSubEntity type Rep IssueSubEntity = D1 ('MetaData "IssueSubEntity" "Amazonka.Kendra.Types.IssueSubEntity" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "IssueSubEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIssueSubEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

KeyLocation

newtype KeyLocation Source #

Constructors

KeyLocation'
Fields fromKeyLocation :: Text

Bundled Patterns

pattern KeyLocation_SECRET_MANAGER :: KeyLocation
pattern KeyLocation_URL :: KeyLocation

Instances

Instances details

FromJSON KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods parseJSON :: Value -> Parser KeyLocation # parseJSONList :: Value -> Parser [KeyLocation] #
FromJSONKey KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods fromJSONKey :: FromJSONKeyFunction KeyLocation # fromJSONKeyList :: FromJSONKeyFunction [KeyLocation] #
ToJSON KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods toJSON :: KeyLocation -> Value # toEncoding :: KeyLocation -> Encoding # toJSONList :: [KeyLocation] -> Value # toEncodingList :: [KeyLocation] -> Encoding #
ToJSONKey KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods toJSONKey :: ToJSONKeyFunction KeyLocation # toJSONKeyList :: ToJSONKeyFunction [KeyLocation] #
ToByteString KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods toBS :: KeyLocation -> ByteString #
ToHeader KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods toHeader :: HeaderName -> KeyLocation -> [Header] #
ToLog KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods build :: KeyLocation -> ByteStringBuilder #
ToQuery KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods toQuery :: KeyLocation -> QueryString #
FromText KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods fromText :: Text -> Either String KeyLocation #
ToText KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods toText :: KeyLocation -> Text #
FromXML KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods parseXML :: [Node] -> Either String KeyLocation #
ToXML KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods toXML :: KeyLocation -> XML #
Generic KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Associated Types type Rep KeyLocation :: Type -> Type # Methods from :: KeyLocation -> Rep KeyLocation x # to :: Rep KeyLocation x -> KeyLocation #
Read KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods readsPrec :: Int -> ReadS KeyLocation # readList :: ReadS [KeyLocation] # readPrec :: ReadPrec KeyLocation # readListPrec :: ReadPrec [KeyLocation] #
Show KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods showsPrec :: Int -> KeyLocation -> ShowS # show :: KeyLocation -> String # showList :: [KeyLocation] -> ShowS #
NFData KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods rnf :: KeyLocation -> () #
Eq KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods (==) :: KeyLocation -> KeyLocation -> Bool # (/=) :: KeyLocation -> KeyLocation -> Bool #
Ord KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods compare :: KeyLocation -> KeyLocation -> Ordering # (<) :: KeyLocation -> KeyLocation -> Bool # (<=) :: KeyLocation -> KeyLocation -> Bool # (>) :: KeyLocation -> KeyLocation -> Bool # (>=) :: KeyLocation -> KeyLocation -> Bool # max :: KeyLocation -> KeyLocation -> KeyLocation # min :: KeyLocation -> KeyLocation -> KeyLocation #
Hashable KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation Methods hashWithSalt :: Int -> KeyLocation -> Int # hash :: KeyLocation -> Int #
type Rep KeyLocation Source #
Instance details Defined in Amazonka.Kendra.Types.KeyLocation type Rep KeyLocation = D1 ('MetaData "KeyLocation" "Amazonka.Kendra.Types.KeyLocation" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "KeyLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromKeyLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MetricType

newtype MetricType Source #

Constructors

MetricType'
Fields fromMetricType :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods parseJSON :: Value -> Parser MetricType # parseJSONList :: Value -> Parser [MetricType] #
FromJSONKey MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods fromJSONKey :: FromJSONKeyFunction MetricType # fromJSONKeyList :: FromJSONKeyFunction [MetricType] #
ToJSON MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods toJSON :: MetricType -> Value # toEncoding :: MetricType -> Encoding # toJSONList :: [MetricType] -> Value # toEncodingList :: [MetricType] -> Encoding #
ToJSONKey MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods toJSONKey :: ToJSONKeyFunction MetricType # toJSONKeyList :: ToJSONKeyFunction [MetricType] #
ToByteString MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods toBS :: MetricType -> ByteString #
ToHeader MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods toHeader :: HeaderName -> MetricType -> [Header] #
ToLog MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods build :: MetricType -> ByteStringBuilder #
ToQuery MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods toQuery :: MetricType -> QueryString #
FromText MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods fromText :: Text -> Either String MetricType #
ToText MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods toText :: MetricType -> Text #
FromXML MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods parseXML :: [Node] -> Either String MetricType #
ToXML MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods toXML :: MetricType -> XML #
Generic MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Associated Types type Rep MetricType :: Type -> Type # Methods from :: MetricType -> Rep MetricType x # to :: Rep MetricType x -> MetricType #
Read MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods readsPrec :: Int -> ReadS MetricType # readList :: ReadS [MetricType] # readPrec :: ReadPrec MetricType # readListPrec :: ReadPrec [MetricType] #
Show MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods showsPrec :: Int -> MetricType -> ShowS # show :: MetricType -> String # showList :: [MetricType] -> ShowS #
NFData MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods rnf :: MetricType -> () #
Eq MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods (==) :: MetricType -> MetricType -> Bool # (/=) :: MetricType -> MetricType -> Bool #
Ord MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods compare :: MetricType -> MetricType -> Ordering # (<) :: MetricType -> MetricType -> Bool # (<=) :: MetricType -> MetricType -> Bool # (>) :: MetricType -> MetricType -> Bool # (>=) :: MetricType -> MetricType -> Bool # max :: MetricType -> MetricType -> MetricType # min :: MetricType -> MetricType -> MetricType #
Hashable MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType Methods hashWithSalt :: Int -> MetricType -> Int # hash :: MetricType -> Int #
type Rep MetricType Source #
Instance details Defined in Amazonka.Kendra.Types.MetricType type Rep MetricType = D1 ('MetaData "MetricType" "Amazonka.Kendra.Types.MetricType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "MetricType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMetricType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Mode

newtype Mode Source #

Constructors

Mode'
Fields fromMode :: Text

Bundled Patterns

pattern Mode_ENABLED :: Mode
pattern Mode_LEARN_ONLY :: Mode

Instances

Instances details

FromJSON Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods parseJSON :: Value -> Parser Mode # parseJSONList :: Value -> Parser [Mode] #
FromJSONKey Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods fromJSONKey :: FromJSONKeyFunction Mode # fromJSONKeyList :: FromJSONKeyFunction [Mode] #
ToJSON Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods toJSON :: Mode -> Value # toEncoding :: Mode -> Encoding # toJSONList :: [Mode] -> Value # toEncodingList :: [Mode] -> Encoding #
ToJSONKey Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods toJSONKey :: ToJSONKeyFunction Mode # toJSONKeyList :: ToJSONKeyFunction [Mode] #
ToByteString Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods toBS :: Mode -> ByteString #
ToHeader Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods toHeader :: HeaderName -> Mode -> [Header] #
ToLog Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods build :: Mode -> ByteStringBuilder #
ToQuery Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods toQuery :: Mode -> QueryString #
FromText Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods fromText :: Text -> Either String Mode #
ToText Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods toText :: Mode -> Text #
FromXML Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods parseXML :: [Node] -> Either String Mode #
ToXML Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods toXML :: Mode -> XML #
Generic Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Associated Types type Rep Mode :: Type -> Type # Methods from :: Mode -> Rep Mode x # to :: Rep Mode x -> Mode #
Read Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods readsPrec :: Int -> ReadS Mode # readList :: ReadS [Mode] # readPrec :: ReadPrec Mode # readListPrec :: ReadPrec [Mode] #
Show Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #
NFData Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods rnf :: Mode -> () #
Eq Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods (==) :: Mode -> Mode -> Bool # (/=) :: Mode -> Mode -> Bool #
Ord Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods compare :: Mode -> Mode -> Ordering # (<) :: Mode -> Mode -> Bool # (<=) :: Mode -> Mode -> Bool # (>) :: Mode -> Mode -> Bool # (>=) :: Mode -> Mode -> Bool # max :: Mode -> Mode -> Mode # min :: Mode -> Mode -> Mode #
Hashable Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode Methods hashWithSalt :: Int -> Mode -> Int # hash :: Mode -> Int #
type Rep Mode Source #
Instance details Defined in Amazonka.Kendra.Types.Mode type Rep Mode = D1 ('MetaData "Mode" "Amazonka.Kendra.Types.Mode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Mode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Order

newtype Order Source #

Constructors

Order'
Fields fromOrder :: Text

Bundled Patterns

pattern Order_ASCENDING :: Order
pattern Order_DESCENDING :: Order

Instances

Instances details

FromJSON Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods parseJSON :: Value -> Parser Order # parseJSONList :: Value -> Parser [Order] #
FromJSONKey Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods fromJSONKey :: FromJSONKeyFunction Order # fromJSONKeyList :: FromJSONKeyFunction [Order] #
ToJSON Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods toJSON :: Order -> Value # toEncoding :: Order -> Encoding # toJSONList :: [Order] -> Value # toEncodingList :: [Order] -> Encoding #
ToJSONKey Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods toJSONKey :: ToJSONKeyFunction Order # toJSONKeyList :: ToJSONKeyFunction [Order] #
ToByteString Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods toBS :: Order -> ByteString #
ToHeader Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods toHeader :: HeaderName -> Order -> [Header] #
ToLog Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods build :: Order -> ByteStringBuilder #
ToQuery Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods toQuery :: Order -> QueryString #
FromText Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods fromText :: Text -> Either String Order #
ToText Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods toText :: Order -> Text #
FromXML Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods parseXML :: [Node] -> Either String Order #
ToXML Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods toXML :: Order -> XML #
Generic Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Associated Types type Rep Order :: Type -> Type # Methods from :: Order -> Rep Order x # to :: Rep Order x -> Order #
Read Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods readsPrec :: Int -> ReadS Order # readList :: ReadS [Order] # readPrec :: ReadPrec Order # readListPrec :: ReadPrec [Order] #
Show Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods showsPrec :: Int -> Order -> ShowS # show :: Order -> String # showList :: [Order] -> ShowS #
NFData Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods rnf :: Order -> () #
Eq Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods (==) :: Order -> Order -> Bool # (/=) :: Order -> Order -> Bool #
Ord Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods compare :: Order -> Order -> Ordering # (<) :: Order -> Order -> Bool # (<=) :: Order -> Order -> Bool # (>) :: Order -> Order -> Bool # (>=) :: Order -> Order -> Bool # max :: Order -> Order -> Order # min :: Order -> Order -> Order #
Hashable Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order Methods hashWithSalt :: Int -> Order -> Int # hash :: Order -> Int #
type Rep Order Source #
Instance details Defined in Amazonka.Kendra.Types.Order type Rep Order = D1 ('MetaData "Order" "Amazonka.Kendra.Types.Order" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Order'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Persona

newtype Persona Source #

Constructors

Persona'
Fields fromPersona :: Text

Bundled Patterns

pattern Persona_OWNER :: Persona
pattern Persona_VIEWER :: Persona

Instances

Instances details

FromJSON Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods parseJSON :: Value -> Parser Persona # parseJSONList :: Value -> Parser [Persona] #
FromJSONKey Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods fromJSONKey :: FromJSONKeyFunction Persona # fromJSONKeyList :: FromJSONKeyFunction [Persona] #
ToJSON Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods toJSON :: Persona -> Value # toEncoding :: Persona -> Encoding # toJSONList :: [Persona] -> Value # toEncodingList :: [Persona] -> Encoding #
ToJSONKey Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods toJSONKey :: ToJSONKeyFunction Persona # toJSONKeyList :: ToJSONKeyFunction [Persona] #
ToByteString Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods toBS :: Persona -> ByteString #
ToHeader Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods toHeader :: HeaderName -> Persona -> [Header] #
ToLog Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods build :: Persona -> ByteStringBuilder #
ToQuery Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods toQuery :: Persona -> QueryString #
FromText Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods fromText :: Text -> Either String Persona #
ToText Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods toText :: Persona -> Text #
FromXML Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods parseXML :: [Node] -> Either String Persona #
ToXML Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods toXML :: Persona -> XML #
Generic Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Associated Types type Rep Persona :: Type -> Type # Methods from :: Persona -> Rep Persona x # to :: Rep Persona x -> Persona #
Read Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods readsPrec :: Int -> ReadS Persona # readList :: ReadS [Persona] # readPrec :: ReadPrec Persona # readListPrec :: ReadPrec [Persona] #
Show Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods showsPrec :: Int -> Persona -> ShowS # show :: Persona -> String # showList :: [Persona] -> ShowS #
NFData Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods rnf :: Persona -> () #
Eq Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods (==) :: Persona -> Persona -> Bool # (/=) :: Persona -> Persona -> Bool #
Ord Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods compare :: Persona -> Persona -> Ordering # (<) :: Persona -> Persona -> Bool # (<=) :: Persona -> Persona -> Bool # (>) :: Persona -> Persona -> Bool # (>=) :: Persona -> Persona -> Bool # max :: Persona -> Persona -> Persona # min :: Persona -> Persona -> Persona #
Hashable Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona Methods hashWithSalt :: Int -> Persona -> Int # hash :: Persona -> Int #
type Rep Persona Source #
Instance details Defined in Amazonka.Kendra.Types.Persona type Rep Persona = D1 ('MetaData "Persona" "Amazonka.Kendra.Types.Persona" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Persona'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPersona") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PrincipalMappingStatus

newtype PrincipalMappingStatus Source #

Constructors

PrincipalMappingStatus'
Fields fromPrincipalMappingStatus :: Text

Bundled Patterns

pattern PrincipalMappingStatus_DELETED :: PrincipalMappingStatus
pattern PrincipalMappingStatus_DELETING :: PrincipalMappingStatus
pattern PrincipalMappingStatus_FAILED :: PrincipalMappingStatus
pattern PrincipalMappingStatus_PROCESSING :: PrincipalMappingStatus
pattern PrincipalMappingStatus_SUCCEEDED :: PrincipalMappingStatus

Instances

Instances details

FromJSON PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods parseJSON :: Value -> Parser PrincipalMappingStatus # parseJSONList :: Value -> Parser [PrincipalMappingStatus] #
FromJSONKey PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods fromJSONKey :: FromJSONKeyFunction PrincipalMappingStatus # fromJSONKeyList :: FromJSONKeyFunction [PrincipalMappingStatus] #
ToJSON PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods toJSON :: PrincipalMappingStatus -> Value # toEncoding :: PrincipalMappingStatus -> Encoding # toJSONList :: [PrincipalMappingStatus] -> Value # toEncodingList :: [PrincipalMappingStatus] -> Encoding #
ToJSONKey PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods toJSONKey :: ToJSONKeyFunction PrincipalMappingStatus # toJSONKeyList :: ToJSONKeyFunction [PrincipalMappingStatus] #
ToByteString PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods toBS :: PrincipalMappingStatus -> ByteString #
ToHeader PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods toHeader :: HeaderName -> PrincipalMappingStatus -> [Header] #
ToLog PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods build :: PrincipalMappingStatus -> ByteStringBuilder #
ToQuery PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods toQuery :: PrincipalMappingStatus -> QueryString #
FromText PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods fromText :: Text -> Either String PrincipalMappingStatus #
ToText PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods toText :: PrincipalMappingStatus -> Text #
FromXML PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods parseXML :: [Node] -> Either String PrincipalMappingStatus #
ToXML PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods toXML :: PrincipalMappingStatus -> XML #
Generic PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Associated Types type Rep PrincipalMappingStatus :: Type -> Type # Methods from :: PrincipalMappingStatus -> Rep PrincipalMappingStatus x # to :: Rep PrincipalMappingStatus x -> PrincipalMappingStatus #
Read PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods readsPrec :: Int -> ReadS PrincipalMappingStatus # readList :: ReadS [PrincipalMappingStatus] # readPrec :: ReadPrec PrincipalMappingStatus # readListPrec :: ReadPrec [PrincipalMappingStatus] #
Show PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods showsPrec :: Int -> PrincipalMappingStatus -> ShowS # show :: PrincipalMappingStatus -> String # showList :: [PrincipalMappingStatus] -> ShowS #
NFData PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods rnf :: PrincipalMappingStatus -> () #
Eq PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods (==) :: PrincipalMappingStatus -> PrincipalMappingStatus -> Bool # (/=) :: PrincipalMappingStatus -> PrincipalMappingStatus -> Bool #
Ord PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods compare :: PrincipalMappingStatus -> PrincipalMappingStatus -> Ordering # (<) :: PrincipalMappingStatus -> PrincipalMappingStatus -> Bool # (<=) :: PrincipalMappingStatus -> PrincipalMappingStatus -> Bool # (>) :: PrincipalMappingStatus -> PrincipalMappingStatus -> Bool # (>=) :: PrincipalMappingStatus -> PrincipalMappingStatus -> Bool # max :: PrincipalMappingStatus -> PrincipalMappingStatus -> PrincipalMappingStatus # min :: PrincipalMappingStatus -> PrincipalMappingStatus -> PrincipalMappingStatus #
Hashable PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus Methods hashWithSalt :: Int -> PrincipalMappingStatus -> Int # hash :: PrincipalMappingStatus -> Int #
type Rep PrincipalMappingStatus Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalMappingStatus type Rep PrincipalMappingStatus = D1 ('MetaData "PrincipalMappingStatus" "Amazonka.Kendra.Types.PrincipalMappingStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "PrincipalMappingStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPrincipalMappingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PrincipalType

newtype PrincipalType Source #

Constructors

PrincipalType'
Fields fromPrincipalType :: Text

Bundled Patterns

pattern PrincipalType_GROUP :: PrincipalType
pattern PrincipalType_USER :: PrincipalType

Instances

Instances details

FromJSON PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods parseJSON :: Value -> Parser PrincipalType # parseJSONList :: Value -> Parser [PrincipalType] #
FromJSONKey PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods fromJSONKey :: FromJSONKeyFunction PrincipalType # fromJSONKeyList :: FromJSONKeyFunction [PrincipalType] #
ToJSON PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods toJSON :: PrincipalType -> Value # toEncoding :: PrincipalType -> Encoding # toJSONList :: [PrincipalType] -> Value # toEncodingList :: [PrincipalType] -> Encoding #
ToJSONKey PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods toJSONKey :: ToJSONKeyFunction PrincipalType # toJSONKeyList :: ToJSONKeyFunction [PrincipalType] #
ToByteString PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods toBS :: PrincipalType -> ByteString #
ToHeader PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods toHeader :: HeaderName -> PrincipalType -> [Header] #
ToLog PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods build :: PrincipalType -> ByteStringBuilder #
ToQuery PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods toQuery :: PrincipalType -> QueryString #
FromText PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods fromText :: Text -> Either String PrincipalType #
ToText PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods toText :: PrincipalType -> Text #
FromXML PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods parseXML :: [Node] -> Either String PrincipalType #
ToXML PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods toXML :: PrincipalType -> XML #
Generic PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Associated Types type Rep PrincipalType :: Type -> Type # Methods from :: PrincipalType -> Rep PrincipalType x # to :: Rep PrincipalType x -> PrincipalType #
Read PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods readsPrec :: Int -> ReadS PrincipalType # readList :: ReadS [PrincipalType] # readPrec :: ReadPrec PrincipalType # readListPrec :: ReadPrec [PrincipalType] #
Show PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods showsPrec :: Int -> PrincipalType -> ShowS # show :: PrincipalType -> String # showList :: [PrincipalType] -> ShowS #
NFData PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods rnf :: PrincipalType -> () #
Eq PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods (==) :: PrincipalType -> PrincipalType -> Bool # (/=) :: PrincipalType -> PrincipalType -> Bool #
Ord PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods compare :: PrincipalType -> PrincipalType -> Ordering # (<) :: PrincipalType -> PrincipalType -> Bool # (<=) :: PrincipalType -> PrincipalType -> Bool # (>) :: PrincipalType -> PrincipalType -> Bool # (>=) :: PrincipalType -> PrincipalType -> Bool # max :: PrincipalType -> PrincipalType -> PrincipalType # min :: PrincipalType -> PrincipalType -> PrincipalType #
Hashable PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType Methods hashWithSalt :: Int -> PrincipalType -> Int # hash :: PrincipalType -> Int #
type Rep PrincipalType Source #
Instance details Defined in Amazonka.Kendra.Types.PrincipalType type Rep PrincipalType = D1 ('MetaData "PrincipalType" "Amazonka.Kendra.Types.PrincipalType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "PrincipalType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPrincipalType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryIdentifiersEnclosingOption

newtype QueryIdentifiersEnclosingOption Source #

Constructors

QueryIdentifiersEnclosingOption'
Fields fromQueryIdentifiersEnclosingOption :: Text

Bundled Patterns

pattern QueryIdentifiersEnclosingOption_DOUBLE_QUOTES :: QueryIdentifiersEnclosingOption
pattern QueryIdentifiersEnclosingOption_NONE :: QueryIdentifiersEnclosingOption

Instances

Instances details

FromJSON QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods parseJSON :: Value -> Parser QueryIdentifiersEnclosingOption # parseJSONList :: Value -> Parser [QueryIdentifiersEnclosingOption] #
FromJSONKey QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods fromJSONKey :: FromJSONKeyFunction QueryIdentifiersEnclosingOption # fromJSONKeyList :: FromJSONKeyFunction [QueryIdentifiersEnclosingOption] #
ToJSON QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods toJSON :: QueryIdentifiersEnclosingOption -> Value # toEncoding :: QueryIdentifiersEnclosingOption -> Encoding # toJSONList :: [QueryIdentifiersEnclosingOption] -> Value # toEncodingList :: [QueryIdentifiersEnclosingOption] -> Encoding #
ToJSONKey QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods toJSONKey :: ToJSONKeyFunction QueryIdentifiersEnclosingOption # toJSONKeyList :: ToJSONKeyFunction [QueryIdentifiersEnclosingOption] #
ToByteString QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods toBS :: QueryIdentifiersEnclosingOption -> ByteString #
ToHeader QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods toHeader :: HeaderName -> QueryIdentifiersEnclosingOption -> [Header] #
ToLog QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods build :: QueryIdentifiersEnclosingOption -> ByteStringBuilder #
ToQuery QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods toQuery :: QueryIdentifiersEnclosingOption -> QueryString #
FromText QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods fromText :: Text -> Either String QueryIdentifiersEnclosingOption #
ToText QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods toText :: QueryIdentifiersEnclosingOption -> Text #
FromXML QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods parseXML :: [Node] -> Either String QueryIdentifiersEnclosingOption #
ToXML QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods toXML :: QueryIdentifiersEnclosingOption -> XML #
Generic QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Associated Types type Rep QueryIdentifiersEnclosingOption :: Type -> Type # Methods from :: QueryIdentifiersEnclosingOption -> Rep QueryIdentifiersEnclosingOption x # to :: Rep QueryIdentifiersEnclosingOption x -> QueryIdentifiersEnclosingOption #
Read QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods readsPrec :: Int -> ReadS QueryIdentifiersEnclosingOption # readList :: ReadS [QueryIdentifiersEnclosingOption] # readPrec :: ReadPrec QueryIdentifiersEnclosingOption # readListPrec :: ReadPrec [QueryIdentifiersEnclosingOption] #
Show QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods showsPrec :: Int -> QueryIdentifiersEnclosingOption -> ShowS # show :: QueryIdentifiersEnclosingOption -> String # showList :: [QueryIdentifiersEnclosingOption] -> ShowS #
NFData QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods rnf :: QueryIdentifiersEnclosingOption -> () #
Eq QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods (==) :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> Bool # (/=) :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> Bool #
Ord QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods compare :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> Ordering # (<) :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> Bool # (<=) :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> Bool # (>) :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> Bool # (>=) :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> Bool # max :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption # min :: QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption -> QueryIdentifiersEnclosingOption #
Hashable QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption Methods hashWithSalt :: Int -> QueryIdentifiersEnclosingOption -> Int # hash :: QueryIdentifiersEnclosingOption -> Int #
type Rep QueryIdentifiersEnclosingOption Source #
Instance details Defined in Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption type Rep QueryIdentifiersEnclosingOption = D1 ('MetaData "QueryIdentifiersEnclosingOption" "Amazonka.Kendra.Types.QueryIdentifiersEnclosingOption" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QueryIdentifiersEnclosingOption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueryIdentifiersEnclosingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryResultFormat

newtype QueryResultFormat Source #

Constructors

QueryResultFormat'
Fields fromQueryResultFormat :: Text

Bundled Patterns

pattern QueryResultFormat_TABLE :: QueryResultFormat
pattern QueryResultFormat_TEXT :: QueryResultFormat

Instances

Instances details

FromJSON QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods parseJSON :: Value -> Parser QueryResultFormat # parseJSONList :: Value -> Parser [QueryResultFormat] #
FromJSONKey QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods fromJSONKey :: FromJSONKeyFunction QueryResultFormat # fromJSONKeyList :: FromJSONKeyFunction [QueryResultFormat] #
ToJSON QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods toJSON :: QueryResultFormat -> Value # toEncoding :: QueryResultFormat -> Encoding # toJSONList :: [QueryResultFormat] -> Value # toEncodingList :: [QueryResultFormat] -> Encoding #
ToJSONKey QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods toJSONKey :: ToJSONKeyFunction QueryResultFormat # toJSONKeyList :: ToJSONKeyFunction [QueryResultFormat] #
ToByteString QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods toBS :: QueryResultFormat -> ByteString #
ToHeader QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods toHeader :: HeaderName -> QueryResultFormat -> [Header] #
ToLog QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods build :: QueryResultFormat -> ByteStringBuilder #
ToQuery QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods toQuery :: QueryResultFormat -> QueryString #
FromText QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods fromText :: Text -> Either String QueryResultFormat #
ToText QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods toText :: QueryResultFormat -> Text #
FromXML QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods parseXML :: [Node] -> Either String QueryResultFormat #
ToXML QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods toXML :: QueryResultFormat -> XML #
Generic QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Associated Types type Rep QueryResultFormat :: Type -> Type # Methods from :: QueryResultFormat -> Rep QueryResultFormat x # to :: Rep QueryResultFormat x -> QueryResultFormat #
Read QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods readsPrec :: Int -> ReadS QueryResultFormat # readList :: ReadS [QueryResultFormat] # readPrec :: ReadPrec QueryResultFormat # readListPrec :: ReadPrec [QueryResultFormat] #
Show QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods showsPrec :: Int -> QueryResultFormat -> ShowS # show :: QueryResultFormat -> String # showList :: [QueryResultFormat] -> ShowS #
NFData QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods rnf :: QueryResultFormat -> () #
Eq QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods (==) :: QueryResultFormat -> QueryResultFormat -> Bool # (/=) :: QueryResultFormat -> QueryResultFormat -> Bool #
Ord QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods compare :: QueryResultFormat -> QueryResultFormat -> Ordering # (<) :: QueryResultFormat -> QueryResultFormat -> Bool # (<=) :: QueryResultFormat -> QueryResultFormat -> Bool # (>) :: QueryResultFormat -> QueryResultFormat -> Bool # (>=) :: QueryResultFormat -> QueryResultFormat -> Bool # max :: QueryResultFormat -> QueryResultFormat -> QueryResultFormat # min :: QueryResultFormat -> QueryResultFormat -> QueryResultFormat #
Hashable QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat Methods hashWithSalt :: Int -> QueryResultFormat -> Int # hash :: QueryResultFormat -> Int #
type Rep QueryResultFormat Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultFormat type Rep QueryResultFormat = D1 ('MetaData "QueryResultFormat" "Amazonka.Kendra.Types.QueryResultFormat" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QueryResultFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueryResultFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryResultType

newtype QueryResultType Source #

Constructors

QueryResultType'
Fields fromQueryResultType :: Text

Bundled Patterns

pattern QueryResultType_ANSWER :: QueryResultType
pattern QueryResultType_DOCUMENT :: QueryResultType
pattern QueryResultType_QUESTION_ANSWER :: QueryResultType

Instances

Instances details

FromJSON QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods parseJSON :: Value -> Parser QueryResultType # parseJSONList :: Value -> Parser [QueryResultType] #
FromJSONKey QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods fromJSONKey :: FromJSONKeyFunction QueryResultType # fromJSONKeyList :: FromJSONKeyFunction [QueryResultType] #
ToJSON QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods toJSON :: QueryResultType -> Value # toEncoding :: QueryResultType -> Encoding # toJSONList :: [QueryResultType] -> Value # toEncodingList :: [QueryResultType] -> Encoding #
ToJSONKey QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods toJSONKey :: ToJSONKeyFunction QueryResultType # toJSONKeyList :: ToJSONKeyFunction [QueryResultType] #
ToByteString QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods toBS :: QueryResultType -> ByteString #
ToHeader QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods toHeader :: HeaderName -> QueryResultType -> [Header] #
ToLog QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods build :: QueryResultType -> ByteStringBuilder #
ToQuery QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods toQuery :: QueryResultType -> QueryString #
FromText QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods fromText :: Text -> Either String QueryResultType #
ToText QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods toText :: QueryResultType -> Text #
FromXML QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods parseXML :: [Node] -> Either String QueryResultType #
ToXML QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods toXML :: QueryResultType -> XML #
Generic QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Associated Types type Rep QueryResultType :: Type -> Type # Methods from :: QueryResultType -> Rep QueryResultType x # to :: Rep QueryResultType x -> QueryResultType #
Read QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods readsPrec :: Int -> ReadS QueryResultType # readList :: ReadS [QueryResultType] # readPrec :: ReadPrec QueryResultType # readListPrec :: ReadPrec [QueryResultType] #
Show QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods showsPrec :: Int -> QueryResultType -> ShowS # show :: QueryResultType -> String # showList :: [QueryResultType] -> ShowS #
NFData QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods rnf :: QueryResultType -> () #
Eq QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods (==) :: QueryResultType -> QueryResultType -> Bool # (/=) :: QueryResultType -> QueryResultType -> Bool #
Ord QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods compare :: QueryResultType -> QueryResultType -> Ordering # (<) :: QueryResultType -> QueryResultType -> Bool # (<=) :: QueryResultType -> QueryResultType -> Bool # (>) :: QueryResultType -> QueryResultType -> Bool # (>=) :: QueryResultType -> QueryResultType -> Bool # max :: QueryResultType -> QueryResultType -> QueryResultType # min :: QueryResultType -> QueryResultType -> QueryResultType #
Hashable QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType Methods hashWithSalt :: Int -> QueryResultType -> Int # hash :: QueryResultType -> Int #
type Rep QueryResultType Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultType type Rep QueryResultType = D1 ('MetaData "QueryResultType" "Amazonka.Kendra.Types.QueryResultType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QueryResultType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueryResultType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QuerySuggestionsBlockListStatus

newtype QuerySuggestionsBlockListStatus Source #

Constructors

QuerySuggestionsBlockListStatus'
Fields fromQuerySuggestionsBlockListStatus :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods parseJSON :: Value -> Parser QuerySuggestionsBlockListStatus # parseJSONList :: Value -> Parser [QuerySuggestionsBlockListStatus] #
FromJSONKey QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods fromJSONKey :: FromJSONKeyFunction QuerySuggestionsBlockListStatus # fromJSONKeyList :: FromJSONKeyFunction [QuerySuggestionsBlockListStatus] #
ToJSON QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods toJSON :: QuerySuggestionsBlockListStatus -> Value # toEncoding :: QuerySuggestionsBlockListStatus -> Encoding # toJSONList :: [QuerySuggestionsBlockListStatus] -> Value # toEncodingList :: [QuerySuggestionsBlockListStatus] -> Encoding #
ToJSONKey QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods toJSONKey :: ToJSONKeyFunction QuerySuggestionsBlockListStatus # toJSONKeyList :: ToJSONKeyFunction [QuerySuggestionsBlockListStatus] #
ToByteString QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods toBS :: QuerySuggestionsBlockListStatus -> ByteString #
ToHeader QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods toHeader :: HeaderName -> QuerySuggestionsBlockListStatus -> [Header] #
ToLog QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods build :: QuerySuggestionsBlockListStatus -> ByteStringBuilder #
ToQuery QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods toQuery :: QuerySuggestionsBlockListStatus -> QueryString #
FromText QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods fromText :: Text -> Either String QuerySuggestionsBlockListStatus #
ToText QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods toText :: QuerySuggestionsBlockListStatus -> Text #
FromXML QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods parseXML :: [Node] -> Either String QuerySuggestionsBlockListStatus #
ToXML QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods toXML :: QuerySuggestionsBlockListStatus -> XML #
Generic QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Associated Types type Rep QuerySuggestionsBlockListStatus :: Type -> Type # Methods from :: QuerySuggestionsBlockListStatus -> Rep QuerySuggestionsBlockListStatus x # to :: Rep QuerySuggestionsBlockListStatus x -> QuerySuggestionsBlockListStatus #
Read QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods readsPrec :: Int -> ReadS QuerySuggestionsBlockListStatus # readList :: ReadS [QuerySuggestionsBlockListStatus] # readPrec :: ReadPrec QuerySuggestionsBlockListStatus # readListPrec :: ReadPrec [QuerySuggestionsBlockListStatus] #
Show QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods showsPrec :: Int -> QuerySuggestionsBlockListStatus -> ShowS # show :: QuerySuggestionsBlockListStatus -> String # showList :: [QuerySuggestionsBlockListStatus] -> ShowS #
NFData QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods rnf :: QuerySuggestionsBlockListStatus -> () #
Eq QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods (==) :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> Bool # (/=) :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> Bool #
Ord QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods compare :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> Ordering # (<) :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> Bool # (<=) :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> Bool # (>) :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> Bool # (>=) :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> Bool # max :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus # min :: QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus -> QuerySuggestionsBlockListStatus #
Hashable QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus Methods hashWithSalt :: Int -> QuerySuggestionsBlockListStatus -> Int # hash :: QuerySuggestionsBlockListStatus -> Int #
type Rep QuerySuggestionsBlockListStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus type Rep QuerySuggestionsBlockListStatus = D1 ('MetaData "QuerySuggestionsBlockListStatus" "Amazonka.Kendra.Types.QuerySuggestionsBlockListStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QuerySuggestionsBlockListStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQuerySuggestionsBlockListStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QuerySuggestionsStatus

newtype QuerySuggestionsStatus Source #

Constructors

QuerySuggestionsStatus'
Fields fromQuerySuggestionsStatus :: Text

Bundled Patterns

pattern QuerySuggestionsStatus_ACTIVE :: QuerySuggestionsStatus
pattern QuerySuggestionsStatus_UPDATING :: QuerySuggestionsStatus

Instances

Instances details

FromJSON QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods parseJSON :: Value -> Parser QuerySuggestionsStatus # parseJSONList :: Value -> Parser [QuerySuggestionsStatus] #
FromJSONKey QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods fromJSONKey :: FromJSONKeyFunction QuerySuggestionsStatus # fromJSONKeyList :: FromJSONKeyFunction [QuerySuggestionsStatus] #
ToJSON QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods toJSON :: QuerySuggestionsStatus -> Value # toEncoding :: QuerySuggestionsStatus -> Encoding # toJSONList :: [QuerySuggestionsStatus] -> Value # toEncodingList :: [QuerySuggestionsStatus] -> Encoding #
ToJSONKey QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods toJSONKey :: ToJSONKeyFunction QuerySuggestionsStatus # toJSONKeyList :: ToJSONKeyFunction [QuerySuggestionsStatus] #
ToByteString QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods toBS :: QuerySuggestionsStatus -> ByteString #
ToHeader QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods toHeader :: HeaderName -> QuerySuggestionsStatus -> [Header] #
ToLog QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods build :: QuerySuggestionsStatus -> ByteStringBuilder #
ToQuery QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods toQuery :: QuerySuggestionsStatus -> QueryString #
FromText QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods fromText :: Text -> Either String QuerySuggestionsStatus #
ToText QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods toText :: QuerySuggestionsStatus -> Text #
FromXML QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods parseXML :: [Node] -> Either String QuerySuggestionsStatus #
ToXML QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods toXML :: QuerySuggestionsStatus -> XML #
Generic QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Associated Types type Rep QuerySuggestionsStatus :: Type -> Type # Methods from :: QuerySuggestionsStatus -> Rep QuerySuggestionsStatus x # to :: Rep QuerySuggestionsStatus x -> QuerySuggestionsStatus #
Read QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods readsPrec :: Int -> ReadS QuerySuggestionsStatus # readList :: ReadS [QuerySuggestionsStatus] # readPrec :: ReadPrec QuerySuggestionsStatus # readListPrec :: ReadPrec [QuerySuggestionsStatus] #
Show QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods showsPrec :: Int -> QuerySuggestionsStatus -> ShowS # show :: QuerySuggestionsStatus -> String # showList :: [QuerySuggestionsStatus] -> ShowS #
NFData QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods rnf :: QuerySuggestionsStatus -> () #
Eq QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods (==) :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> Bool # (/=) :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> Bool #
Ord QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods compare :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> Ordering # (<) :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> Bool # (<=) :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> Bool # (>) :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> Bool # (>=) :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> Bool # max :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> QuerySuggestionsStatus # min :: QuerySuggestionsStatus -> QuerySuggestionsStatus -> QuerySuggestionsStatus #
Hashable QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus Methods hashWithSalt :: Int -> QuerySuggestionsStatus -> Int # hash :: QuerySuggestionsStatus -> Int #
type Rep QuerySuggestionsStatus Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsStatus type Rep QuerySuggestionsStatus = D1 ('MetaData "QuerySuggestionsStatus" "Amazonka.Kendra.Types.QuerySuggestionsStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "QuerySuggestionsStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQuerySuggestionsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ReadAccessType

newtype ReadAccessType Source #

Constructors

ReadAccessType'
Fields fromReadAccessType :: Text

Bundled Patterns

pattern ReadAccessType_ALLOW :: ReadAccessType
pattern ReadAccessType_DENY :: ReadAccessType

Instances

Instances details

FromJSON ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods parseJSON :: Value -> Parser ReadAccessType # parseJSONList :: Value -> Parser [ReadAccessType] #
FromJSONKey ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods fromJSONKey :: FromJSONKeyFunction ReadAccessType # fromJSONKeyList :: FromJSONKeyFunction [ReadAccessType] #
ToJSON ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods toJSON :: ReadAccessType -> Value # toEncoding :: ReadAccessType -> Encoding # toJSONList :: [ReadAccessType] -> Value # toEncodingList :: [ReadAccessType] -> Encoding #
ToJSONKey ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods toJSONKey :: ToJSONKeyFunction ReadAccessType # toJSONKeyList :: ToJSONKeyFunction [ReadAccessType] #
ToByteString ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods toBS :: ReadAccessType -> ByteString #
ToHeader ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods toHeader :: HeaderName -> ReadAccessType -> [Header] #
ToLog ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods build :: ReadAccessType -> ByteStringBuilder #
ToQuery ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods toQuery :: ReadAccessType -> QueryString #
FromText ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods fromText :: Text -> Either String ReadAccessType #
ToText ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods toText :: ReadAccessType -> Text #
FromXML ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods parseXML :: [Node] -> Either String ReadAccessType #
ToXML ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods toXML :: ReadAccessType -> XML #
Generic ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Associated Types type Rep ReadAccessType :: Type -> Type # Methods from :: ReadAccessType -> Rep ReadAccessType x # to :: Rep ReadAccessType x -> ReadAccessType #
Read ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods readsPrec :: Int -> ReadS ReadAccessType # readList :: ReadS [ReadAccessType] # readPrec :: ReadPrec ReadAccessType # readListPrec :: ReadPrec [ReadAccessType] #
Show ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods showsPrec :: Int -> ReadAccessType -> ShowS # show :: ReadAccessType -> String # showList :: [ReadAccessType] -> ShowS #
NFData ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods rnf :: ReadAccessType -> () #
Eq ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods (==) :: ReadAccessType -> ReadAccessType -> Bool # (/=) :: ReadAccessType -> ReadAccessType -> Bool #
Ord ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods compare :: ReadAccessType -> ReadAccessType -> Ordering # (<) :: ReadAccessType -> ReadAccessType -> Bool # (<=) :: ReadAccessType -> ReadAccessType -> Bool # (>) :: ReadAccessType -> ReadAccessType -> Bool # (>=) :: ReadAccessType -> ReadAccessType -> Bool # max :: ReadAccessType -> ReadAccessType -> ReadAccessType # min :: ReadAccessType -> ReadAccessType -> ReadAccessType #
Hashable ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType Methods hashWithSalt :: Int -> ReadAccessType -> Int # hash :: ReadAccessType -> Int #
type Rep ReadAccessType Source #
Instance details Defined in Amazonka.Kendra.Types.ReadAccessType type Rep ReadAccessType = D1 ('MetaData "ReadAccessType" "Amazonka.Kendra.Types.ReadAccessType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ReadAccessType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromReadAccessType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

RelevanceType

newtype RelevanceType Source #

Constructors

RelevanceType'
Fields fromRelevanceType :: Text

Bundled Patterns

pattern RelevanceType_NOT_RELEVANT :: RelevanceType
pattern RelevanceType_RELEVANT :: RelevanceType

Instances

Instances details

FromJSON RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods parseJSON :: Value -> Parser RelevanceType # parseJSONList :: Value -> Parser [RelevanceType] #
FromJSONKey RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods fromJSONKey :: FromJSONKeyFunction RelevanceType # fromJSONKeyList :: FromJSONKeyFunction [RelevanceType] #
ToJSON RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods toJSON :: RelevanceType -> Value # toEncoding :: RelevanceType -> Encoding # toJSONList :: [RelevanceType] -> Value # toEncodingList :: [RelevanceType] -> Encoding #
ToJSONKey RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods toJSONKey :: ToJSONKeyFunction RelevanceType # toJSONKeyList :: ToJSONKeyFunction [RelevanceType] #
ToByteString RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods toBS :: RelevanceType -> ByteString #
ToHeader RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods toHeader :: HeaderName -> RelevanceType -> [Header] #
ToLog RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods build :: RelevanceType -> ByteStringBuilder #
ToQuery RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods toQuery :: RelevanceType -> QueryString #
FromText RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods fromText :: Text -> Either String RelevanceType #
ToText RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods toText :: RelevanceType -> Text #
FromXML RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods parseXML :: [Node] -> Either String RelevanceType #
ToXML RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods toXML :: RelevanceType -> XML #
Generic RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Associated Types type Rep RelevanceType :: Type -> Type # Methods from :: RelevanceType -> Rep RelevanceType x # to :: Rep RelevanceType x -> RelevanceType #
Read RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods readsPrec :: Int -> ReadS RelevanceType # readList :: ReadS [RelevanceType] # readPrec :: ReadPrec RelevanceType # readListPrec :: ReadPrec [RelevanceType] #
Show RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods showsPrec :: Int -> RelevanceType -> ShowS # show :: RelevanceType -> String # showList :: [RelevanceType] -> ShowS #
NFData RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods rnf :: RelevanceType -> () #
Eq RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods (==) :: RelevanceType -> RelevanceType -> Bool # (/=) :: RelevanceType -> RelevanceType -> Bool #
Ord RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods compare :: RelevanceType -> RelevanceType -> Ordering # (<) :: RelevanceType -> RelevanceType -> Bool # (<=) :: RelevanceType -> RelevanceType -> Bool # (>) :: RelevanceType -> RelevanceType -> Bool # (>=) :: RelevanceType -> RelevanceType -> Bool # max :: RelevanceType -> RelevanceType -> RelevanceType # min :: RelevanceType -> RelevanceType -> RelevanceType #
Hashable RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType Methods hashWithSalt :: Int -> RelevanceType -> Int # hash :: RelevanceType -> Int #
type Rep RelevanceType Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceType type Rep RelevanceType = D1 ('MetaData "RelevanceType" "Amazonka.Kendra.Types.RelevanceType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "RelevanceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRelevanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SalesforceChatterFeedIncludeFilterType

newtype SalesforceChatterFeedIncludeFilterType Source #

Constructors

SalesforceChatterFeedIncludeFilterType'
Fields fromSalesforceChatterFeedIncludeFilterType :: Text

Bundled Patterns

pattern SalesforceChatterFeedIncludeFilterType_ACTIVE_USER :: SalesforceChatterFeedIncludeFilterType
pattern SalesforceChatterFeedIncludeFilterType_STANDARD_USER :: SalesforceChatterFeedIncludeFilterType

Instances

Instances details

FromJSON SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods parseJSON :: Value -> Parser SalesforceChatterFeedIncludeFilterType # parseJSONList :: Value -> Parser [SalesforceChatterFeedIncludeFilterType] #
FromJSONKey SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods fromJSONKey :: FromJSONKeyFunction SalesforceChatterFeedIncludeFilterType # fromJSONKeyList :: FromJSONKeyFunction [SalesforceChatterFeedIncludeFilterType] #
ToJSON SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods toJSON :: SalesforceChatterFeedIncludeFilterType -> Value # toEncoding :: SalesforceChatterFeedIncludeFilterType -> Encoding # toJSONList :: [SalesforceChatterFeedIncludeFilterType] -> Value # toEncodingList :: [SalesforceChatterFeedIncludeFilterType] -> Encoding #
ToJSONKey SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods toJSONKey :: ToJSONKeyFunction SalesforceChatterFeedIncludeFilterType # toJSONKeyList :: ToJSONKeyFunction [SalesforceChatterFeedIncludeFilterType] #
ToByteString SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods toBS :: SalesforceChatterFeedIncludeFilterType -> ByteString #
ToHeader SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods toHeader :: HeaderName -> SalesforceChatterFeedIncludeFilterType -> [Header] #
ToLog SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods build :: SalesforceChatterFeedIncludeFilterType -> ByteStringBuilder #
ToQuery SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods toQuery :: SalesforceChatterFeedIncludeFilterType -> QueryString #
FromText SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods fromText :: Text -> Either String SalesforceChatterFeedIncludeFilterType #
ToText SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods toText :: SalesforceChatterFeedIncludeFilterType -> Text #
FromXML SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods parseXML :: [Node] -> Either String SalesforceChatterFeedIncludeFilterType #
ToXML SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods toXML :: SalesforceChatterFeedIncludeFilterType -> XML #
Generic SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Associated Types type Rep SalesforceChatterFeedIncludeFilterType :: Type -> Type # Methods from :: SalesforceChatterFeedIncludeFilterType -> Rep SalesforceChatterFeedIncludeFilterType x # to :: Rep SalesforceChatterFeedIncludeFilterType x -> SalesforceChatterFeedIncludeFilterType #
Read SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods readsPrec :: Int -> ReadS SalesforceChatterFeedIncludeFilterType # readList :: ReadS [SalesforceChatterFeedIncludeFilterType] # readPrec :: ReadPrec SalesforceChatterFeedIncludeFilterType # readListPrec :: ReadPrec [SalesforceChatterFeedIncludeFilterType] #
Show SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods showsPrec :: Int -> SalesforceChatterFeedIncludeFilterType -> ShowS # show :: SalesforceChatterFeedIncludeFilterType -> String # showList :: [SalesforceChatterFeedIncludeFilterType] -> ShowS #
NFData SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods rnf :: SalesforceChatterFeedIncludeFilterType -> () #
Eq SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods (==) :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> Bool # (/=) :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> Bool #
Ord SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods compare :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> Ordering # (<) :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> Bool # (<=) :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> Bool # (>) :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> Bool # (>=) :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> Bool # max :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType # min :: SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType -> SalesforceChatterFeedIncludeFilterType #
Hashable SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType Methods hashWithSalt :: Int -> SalesforceChatterFeedIncludeFilterType -> Int # hash :: SalesforceChatterFeedIncludeFilterType -> Int #
type Rep SalesforceChatterFeedIncludeFilterType Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType type Rep SalesforceChatterFeedIncludeFilterType = D1 ('MetaData "SalesforceChatterFeedIncludeFilterType" "Amazonka.Kendra.Types.SalesforceChatterFeedIncludeFilterType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SalesforceChatterFeedIncludeFilterType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSalesforceChatterFeedIncludeFilterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SalesforceKnowledgeArticleState

newtype SalesforceKnowledgeArticleState Source #

Constructors

SalesforceKnowledgeArticleState'
Fields fromSalesforceKnowledgeArticleState :: Text

Bundled Patterns

pattern SalesforceKnowledgeArticleState_ARCHIVED :: SalesforceKnowledgeArticleState
pattern SalesforceKnowledgeArticleState_DRAFT :: SalesforceKnowledgeArticleState
pattern SalesforceKnowledgeArticleState_PUBLISHED :: SalesforceKnowledgeArticleState

Instances

Instances details

FromJSON SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods parseJSON :: Value -> Parser SalesforceKnowledgeArticleState # parseJSONList :: Value -> Parser [SalesforceKnowledgeArticleState] #
FromJSONKey SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods fromJSONKey :: FromJSONKeyFunction SalesforceKnowledgeArticleState # fromJSONKeyList :: FromJSONKeyFunction [SalesforceKnowledgeArticleState] #
ToJSON SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods toJSON :: SalesforceKnowledgeArticleState -> Value # toEncoding :: SalesforceKnowledgeArticleState -> Encoding # toJSONList :: [SalesforceKnowledgeArticleState] -> Value # toEncodingList :: [SalesforceKnowledgeArticleState] -> Encoding #
ToJSONKey SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods toJSONKey :: ToJSONKeyFunction SalesforceKnowledgeArticleState # toJSONKeyList :: ToJSONKeyFunction [SalesforceKnowledgeArticleState] #
ToByteString SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods toBS :: SalesforceKnowledgeArticleState -> ByteString #
ToHeader SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods toHeader :: HeaderName -> SalesforceKnowledgeArticleState -> [Header] #
ToLog SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods build :: SalesforceKnowledgeArticleState -> ByteStringBuilder #
ToQuery SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods toQuery :: SalesforceKnowledgeArticleState -> QueryString #
FromText SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods fromText :: Text -> Either String SalesforceKnowledgeArticleState #
ToText SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods toText :: SalesforceKnowledgeArticleState -> Text #
FromXML SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods parseXML :: [Node] -> Either String SalesforceKnowledgeArticleState #
ToXML SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods toXML :: SalesforceKnowledgeArticleState -> XML #
Generic SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Associated Types type Rep SalesforceKnowledgeArticleState :: Type -> Type # Methods from :: SalesforceKnowledgeArticleState -> Rep SalesforceKnowledgeArticleState x # to :: Rep SalesforceKnowledgeArticleState x -> SalesforceKnowledgeArticleState #
Read SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods readsPrec :: Int -> ReadS SalesforceKnowledgeArticleState # readList :: ReadS [SalesforceKnowledgeArticleState] # readPrec :: ReadPrec SalesforceKnowledgeArticleState # readListPrec :: ReadPrec [SalesforceKnowledgeArticleState] #
Show SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods showsPrec :: Int -> SalesforceKnowledgeArticleState -> ShowS # show :: SalesforceKnowledgeArticleState -> String # showList :: [SalesforceKnowledgeArticleState] -> ShowS #
NFData SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods rnf :: SalesforceKnowledgeArticleState -> () #
Eq SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods (==) :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> Bool # (/=) :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> Bool #
Ord SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods compare :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> Ordering # (<) :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> Bool # (<=) :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> Bool # (>) :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> Bool # (>=) :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> Bool # max :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState # min :: SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState -> SalesforceKnowledgeArticleState #
Hashable SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState Methods hashWithSalt :: Int -> SalesforceKnowledgeArticleState -> Int # hash :: SalesforceKnowledgeArticleState -> Int #
type Rep SalesforceKnowledgeArticleState Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleState type Rep SalesforceKnowledgeArticleState = D1 ('MetaData "SalesforceKnowledgeArticleState" "Amazonka.Kendra.Types.SalesforceKnowledgeArticleState" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SalesforceKnowledgeArticleState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSalesforceKnowledgeArticleState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SalesforceStandardObjectName

newtype SalesforceStandardObjectName Source #

Constructors

SalesforceStandardObjectName'
Fields fromSalesforceStandardObjectName :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods parseJSON :: Value -> Parser SalesforceStandardObjectName # parseJSONList :: Value -> Parser [SalesforceStandardObjectName] #
FromJSONKey SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods fromJSONKey :: FromJSONKeyFunction SalesforceStandardObjectName # fromJSONKeyList :: FromJSONKeyFunction [SalesforceStandardObjectName] #
ToJSON SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods toJSON :: SalesforceStandardObjectName -> Value # toEncoding :: SalesforceStandardObjectName -> Encoding # toJSONList :: [SalesforceStandardObjectName] -> Value # toEncodingList :: [SalesforceStandardObjectName] -> Encoding #
ToJSONKey SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods toJSONKey :: ToJSONKeyFunction SalesforceStandardObjectName # toJSONKeyList :: ToJSONKeyFunction [SalesforceStandardObjectName] #
ToByteString SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods toBS :: SalesforceStandardObjectName -> ByteString #
ToHeader SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods toHeader :: HeaderName -> SalesforceStandardObjectName -> [Header] #
ToLog SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods build :: SalesforceStandardObjectName -> ByteStringBuilder #
ToQuery SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods toQuery :: SalesforceStandardObjectName -> QueryString #
FromText SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods fromText :: Text -> Either String SalesforceStandardObjectName #
ToText SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods toText :: SalesforceStandardObjectName -> Text #
FromXML SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods parseXML :: [Node] -> Either String SalesforceStandardObjectName #
ToXML SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods toXML :: SalesforceStandardObjectName -> XML #
Generic SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Associated Types type Rep SalesforceStandardObjectName :: Type -> Type # Methods from :: SalesforceStandardObjectName -> Rep SalesforceStandardObjectName x # to :: Rep SalesforceStandardObjectName x -> SalesforceStandardObjectName #
Read SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods readsPrec :: Int -> ReadS SalesforceStandardObjectName # readList :: ReadS [SalesforceStandardObjectName] # readPrec :: ReadPrec SalesforceStandardObjectName # readListPrec :: ReadPrec [SalesforceStandardObjectName] #
Show SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods showsPrec :: Int -> SalesforceStandardObjectName -> ShowS # show :: SalesforceStandardObjectName -> String # showList :: [SalesforceStandardObjectName] -> ShowS #
NFData SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods rnf :: SalesforceStandardObjectName -> () #
Eq SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods (==) :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> Bool # (/=) :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> Bool #
Ord SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods compare :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> Ordering # (<) :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> Bool # (<=) :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> Bool # (>) :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> Bool # (>=) :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> Bool # max :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> SalesforceStandardObjectName # min :: SalesforceStandardObjectName -> SalesforceStandardObjectName -> SalesforceStandardObjectName #
Hashable SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName Methods hashWithSalt :: Int -> SalesforceStandardObjectName -> Int # hash :: SalesforceStandardObjectName -> Int #
type Rep SalesforceStandardObjectName Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectName type Rep SalesforceStandardObjectName = D1 ('MetaData "SalesforceStandardObjectName" "Amazonka.Kendra.Types.SalesforceStandardObjectName" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SalesforceStandardObjectName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSalesforceStandardObjectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ScoreConfidence

newtype ScoreConfidence Source #

Enumeration for query score confidence.

Constructors

ScoreConfidence'
Fields fromScoreConfidence :: Text

Bundled Patterns

pattern ScoreConfidence_HIGH :: ScoreConfidence
pattern ScoreConfidence_LOW :: ScoreConfidence
pattern ScoreConfidence_MEDIUM :: ScoreConfidence
pattern ScoreConfidence_NOT_AVAILABLE :: ScoreConfidence
pattern ScoreConfidence_VERY_HIGH :: ScoreConfidence

Instances

Instances details

FromJSON ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods parseJSON :: Value -> Parser ScoreConfidence # parseJSONList :: Value -> Parser [ScoreConfidence] #
FromJSONKey ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods fromJSONKey :: FromJSONKeyFunction ScoreConfidence # fromJSONKeyList :: FromJSONKeyFunction [ScoreConfidence] #
ToJSON ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods toJSON :: ScoreConfidence -> Value # toEncoding :: ScoreConfidence -> Encoding # toJSONList :: [ScoreConfidence] -> Value # toEncodingList :: [ScoreConfidence] -> Encoding #
ToJSONKey ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods toJSONKey :: ToJSONKeyFunction ScoreConfidence # toJSONKeyList :: ToJSONKeyFunction [ScoreConfidence] #
ToByteString ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods toBS :: ScoreConfidence -> ByteString #
ToHeader ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods toHeader :: HeaderName -> ScoreConfidence -> [Header] #
ToLog ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods build :: ScoreConfidence -> ByteStringBuilder #
ToQuery ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods toQuery :: ScoreConfidence -> QueryString #
FromText ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods fromText :: Text -> Either String ScoreConfidence #
ToText ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods toText :: ScoreConfidence -> Text #
FromXML ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods parseXML :: [Node] -> Either String ScoreConfidence #
ToXML ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods toXML :: ScoreConfidence -> XML #
Generic ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Associated Types type Rep ScoreConfidence :: Type -> Type # Methods from :: ScoreConfidence -> Rep ScoreConfidence x # to :: Rep ScoreConfidence x -> ScoreConfidence #
Read ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods readsPrec :: Int -> ReadS ScoreConfidence # readList :: ReadS [ScoreConfidence] # readPrec :: ReadPrec ScoreConfidence # readListPrec :: ReadPrec [ScoreConfidence] #
Show ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods showsPrec :: Int -> ScoreConfidence -> ShowS # show :: ScoreConfidence -> String # showList :: [ScoreConfidence] -> ShowS #
NFData ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods rnf :: ScoreConfidence -> () #
Eq ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods (==) :: ScoreConfidence -> ScoreConfidence -> Bool # (/=) :: ScoreConfidence -> ScoreConfidence -> Bool #
Ord ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods compare :: ScoreConfidence -> ScoreConfidence -> Ordering # (<) :: ScoreConfidence -> ScoreConfidence -> Bool # (<=) :: ScoreConfidence -> ScoreConfidence -> Bool # (>) :: ScoreConfidence -> ScoreConfidence -> Bool # (>=) :: ScoreConfidence -> ScoreConfidence -> Bool # max :: ScoreConfidence -> ScoreConfidence -> ScoreConfidence # min :: ScoreConfidence -> ScoreConfidence -> ScoreConfidence #
Hashable ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence Methods hashWithSalt :: Int -> ScoreConfidence -> Int # hash :: ScoreConfidence -> Int #
type Rep ScoreConfidence Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreConfidence type Rep ScoreConfidence = D1 ('MetaData "ScoreConfidence" "Amazonka.Kendra.Types.ScoreConfidence" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ScoreConfidence'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromScoreConfidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ServiceNowAuthenticationType

newtype ServiceNowAuthenticationType Source #

Constructors

ServiceNowAuthenticationType'
Fields fromServiceNowAuthenticationType :: Text

Bundled Patterns

pattern ServiceNowAuthenticationType_HTTP_BASIC :: ServiceNowAuthenticationType
pattern ServiceNowAuthenticationType_OAUTH2 :: ServiceNowAuthenticationType

Instances

Instances details

FromJSON ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods parseJSON :: Value -> Parser ServiceNowAuthenticationType # parseJSONList :: Value -> Parser [ServiceNowAuthenticationType] #
FromJSONKey ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods fromJSONKey :: FromJSONKeyFunction ServiceNowAuthenticationType # fromJSONKeyList :: FromJSONKeyFunction [ServiceNowAuthenticationType] #
ToJSON ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods toJSON :: ServiceNowAuthenticationType -> Value # toEncoding :: ServiceNowAuthenticationType -> Encoding # toJSONList :: [ServiceNowAuthenticationType] -> Value # toEncodingList :: [ServiceNowAuthenticationType] -> Encoding #
ToJSONKey ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods toJSONKey :: ToJSONKeyFunction ServiceNowAuthenticationType # toJSONKeyList :: ToJSONKeyFunction [ServiceNowAuthenticationType] #
ToByteString ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods toBS :: ServiceNowAuthenticationType -> ByteString #
ToHeader ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods toHeader :: HeaderName -> ServiceNowAuthenticationType -> [Header] #
ToLog ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods build :: ServiceNowAuthenticationType -> ByteStringBuilder #
ToQuery ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods toQuery :: ServiceNowAuthenticationType -> QueryString #
FromText ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods fromText :: Text -> Either String ServiceNowAuthenticationType #
ToText ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods toText :: ServiceNowAuthenticationType -> Text #
FromXML ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods parseXML :: [Node] -> Either String ServiceNowAuthenticationType #
ToXML ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods toXML :: ServiceNowAuthenticationType -> XML #
Generic ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Associated Types type Rep ServiceNowAuthenticationType :: Type -> Type # Methods from :: ServiceNowAuthenticationType -> Rep ServiceNowAuthenticationType x # to :: Rep ServiceNowAuthenticationType x -> ServiceNowAuthenticationType #
Read ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods readsPrec :: Int -> ReadS ServiceNowAuthenticationType # readList :: ReadS [ServiceNowAuthenticationType] # readPrec :: ReadPrec ServiceNowAuthenticationType # readListPrec :: ReadPrec [ServiceNowAuthenticationType] #
Show ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods showsPrec :: Int -> ServiceNowAuthenticationType -> ShowS # show :: ServiceNowAuthenticationType -> String # showList :: [ServiceNowAuthenticationType] -> ShowS #
NFData ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods rnf :: ServiceNowAuthenticationType -> () #
Eq ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods (==) :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> Bool # (/=) :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> Bool #
Ord ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods compare :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> Ordering # (<) :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> Bool # (<=) :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> Bool # (>) :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> Bool # (>=) :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> Bool # max :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> ServiceNowAuthenticationType # min :: ServiceNowAuthenticationType -> ServiceNowAuthenticationType -> ServiceNowAuthenticationType #
Hashable ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType Methods hashWithSalt :: Int -> ServiceNowAuthenticationType -> Int # hash :: ServiceNowAuthenticationType -> Int #
type Rep ServiceNowAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowAuthenticationType type Rep ServiceNowAuthenticationType = D1 ('MetaData "ServiceNowAuthenticationType" "Amazonka.Kendra.Types.ServiceNowAuthenticationType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ServiceNowAuthenticationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromServiceNowAuthenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ServiceNowBuildVersionType

newtype ServiceNowBuildVersionType Source #

Constructors

ServiceNowBuildVersionType'
Fields fromServiceNowBuildVersionType :: Text

Bundled Patterns

pattern ServiceNowBuildVersionType_LONDON :: ServiceNowBuildVersionType
pattern ServiceNowBuildVersionType_OTHERS :: ServiceNowBuildVersionType

Instances

Instances details

FromJSON ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods parseJSON :: Value -> Parser ServiceNowBuildVersionType # parseJSONList :: Value -> Parser [ServiceNowBuildVersionType] #
FromJSONKey ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods fromJSONKey :: FromJSONKeyFunction ServiceNowBuildVersionType # fromJSONKeyList :: FromJSONKeyFunction [ServiceNowBuildVersionType] #
ToJSON ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods toJSON :: ServiceNowBuildVersionType -> Value # toEncoding :: ServiceNowBuildVersionType -> Encoding # toJSONList :: [ServiceNowBuildVersionType] -> Value # toEncodingList :: [ServiceNowBuildVersionType] -> Encoding #
ToJSONKey ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods toJSONKey :: ToJSONKeyFunction ServiceNowBuildVersionType # toJSONKeyList :: ToJSONKeyFunction [ServiceNowBuildVersionType] #
ToByteString ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods toBS :: ServiceNowBuildVersionType -> ByteString #
ToHeader ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods toHeader :: HeaderName -> ServiceNowBuildVersionType -> [Header] #
ToLog ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods build :: ServiceNowBuildVersionType -> ByteStringBuilder #
ToQuery ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods toQuery :: ServiceNowBuildVersionType -> QueryString #
FromText ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods fromText :: Text -> Either String ServiceNowBuildVersionType #
ToText ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods toText :: ServiceNowBuildVersionType -> Text #
FromXML ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods parseXML :: [Node] -> Either String ServiceNowBuildVersionType #
ToXML ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods toXML :: ServiceNowBuildVersionType -> XML #
Generic ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Associated Types type Rep ServiceNowBuildVersionType :: Type -> Type # Methods from :: ServiceNowBuildVersionType -> Rep ServiceNowBuildVersionType x # to :: Rep ServiceNowBuildVersionType x -> ServiceNowBuildVersionType #
Read ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods readsPrec :: Int -> ReadS ServiceNowBuildVersionType # readList :: ReadS [ServiceNowBuildVersionType] # readPrec :: ReadPrec ServiceNowBuildVersionType # readListPrec :: ReadPrec [ServiceNowBuildVersionType] #
Show ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods showsPrec :: Int -> ServiceNowBuildVersionType -> ShowS # show :: ServiceNowBuildVersionType -> String # showList :: [ServiceNowBuildVersionType] -> ShowS #
NFData ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods rnf :: ServiceNowBuildVersionType -> () #
Eq ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods (==) :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> Bool # (/=) :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> Bool #
Ord ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods compare :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> Ordering # (<) :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> Bool # (<=) :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> Bool # (>) :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> Bool # (>=) :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> Bool # max :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> ServiceNowBuildVersionType # min :: ServiceNowBuildVersionType -> ServiceNowBuildVersionType -> ServiceNowBuildVersionType #
Hashable ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType Methods hashWithSalt :: Int -> ServiceNowBuildVersionType -> Int # hash :: ServiceNowBuildVersionType -> Int #
type Rep ServiceNowBuildVersionType Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowBuildVersionType type Rep ServiceNowBuildVersionType = D1 ('MetaData "ServiceNowBuildVersionType" "Amazonka.Kendra.Types.ServiceNowBuildVersionType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ServiceNowBuildVersionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromServiceNowBuildVersionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SharePointOnlineAuthenticationType

newtype SharePointOnlineAuthenticationType Source #

Constructors

SharePointOnlineAuthenticationType'
Fields fromSharePointOnlineAuthenticationType :: Text

Bundled Patterns

pattern SharePointOnlineAuthenticationType_HTTP_BASIC :: SharePointOnlineAuthenticationType
pattern SharePointOnlineAuthenticationType_OAUTH2 :: SharePointOnlineAuthenticationType

Instances

Instances details

FromJSON SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods parseJSON :: Value -> Parser SharePointOnlineAuthenticationType # parseJSONList :: Value -> Parser [SharePointOnlineAuthenticationType] #
FromJSONKey SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods fromJSONKey :: FromJSONKeyFunction SharePointOnlineAuthenticationType # fromJSONKeyList :: FromJSONKeyFunction [SharePointOnlineAuthenticationType] #
ToJSON SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods toJSON :: SharePointOnlineAuthenticationType -> Value # toEncoding :: SharePointOnlineAuthenticationType -> Encoding # toJSONList :: [SharePointOnlineAuthenticationType] -> Value # toEncodingList :: [SharePointOnlineAuthenticationType] -> Encoding #
ToJSONKey SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods toJSONKey :: ToJSONKeyFunction SharePointOnlineAuthenticationType # toJSONKeyList :: ToJSONKeyFunction [SharePointOnlineAuthenticationType] #
ToByteString SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods toBS :: SharePointOnlineAuthenticationType -> ByteString #
ToHeader SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods toHeader :: HeaderName -> SharePointOnlineAuthenticationType -> [Header] #
ToLog SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods build :: SharePointOnlineAuthenticationType -> ByteStringBuilder #
ToQuery SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods toQuery :: SharePointOnlineAuthenticationType -> QueryString #
FromText SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods fromText :: Text -> Either String SharePointOnlineAuthenticationType #
ToText SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods toText :: SharePointOnlineAuthenticationType -> Text #
FromXML SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods parseXML :: [Node] -> Either String SharePointOnlineAuthenticationType #
ToXML SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods toXML :: SharePointOnlineAuthenticationType -> XML #
Generic SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Associated Types type Rep SharePointOnlineAuthenticationType :: Type -> Type # Methods from :: SharePointOnlineAuthenticationType -> Rep SharePointOnlineAuthenticationType x # to :: Rep SharePointOnlineAuthenticationType x -> SharePointOnlineAuthenticationType #
Read SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods readsPrec :: Int -> ReadS SharePointOnlineAuthenticationType # readList :: ReadS [SharePointOnlineAuthenticationType] # readPrec :: ReadPrec SharePointOnlineAuthenticationType # readListPrec :: ReadPrec [SharePointOnlineAuthenticationType] #
Show SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods showsPrec :: Int -> SharePointOnlineAuthenticationType -> ShowS # show :: SharePointOnlineAuthenticationType -> String # showList :: [SharePointOnlineAuthenticationType] -> ShowS #
NFData SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods rnf :: SharePointOnlineAuthenticationType -> () #
Eq SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods (==) :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> Bool # (/=) :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> Bool #
Ord SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods compare :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> Ordering # (<) :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> Bool # (<=) :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> Bool # (>) :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> Bool # (>=) :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> Bool # max :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType # min :: SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType -> SharePointOnlineAuthenticationType #
Hashable SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType Methods hashWithSalt :: Int -> SharePointOnlineAuthenticationType -> Int # hash :: SharePointOnlineAuthenticationType -> Int #
type Rep SharePointOnlineAuthenticationType Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointOnlineAuthenticationType type Rep SharePointOnlineAuthenticationType = D1 ('MetaData "SharePointOnlineAuthenticationType" "Amazonka.Kendra.Types.SharePointOnlineAuthenticationType" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SharePointOnlineAuthenticationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSharePointOnlineAuthenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SharePointVersion

newtype SharePointVersion Source #

Constructors

SharePointVersion'
Fields fromSharePointVersion :: Text

Bundled Patterns

pattern SharePointVersion_SHAREPOINT_2013 :: SharePointVersion
pattern SharePointVersion_SHAREPOINT_2016 :: SharePointVersion
pattern SharePointVersion_SHAREPOINT_2019 :: SharePointVersion
pattern SharePointVersion_SHAREPOINT_ONLINE :: SharePointVersion

Instances

Instances details

FromJSON SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods parseJSON :: Value -> Parser SharePointVersion # parseJSONList :: Value -> Parser [SharePointVersion] #
FromJSONKey SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods fromJSONKey :: FromJSONKeyFunction SharePointVersion # fromJSONKeyList :: FromJSONKeyFunction [SharePointVersion] #
ToJSON SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods toJSON :: SharePointVersion -> Value # toEncoding :: SharePointVersion -> Encoding # toJSONList :: [SharePointVersion] -> Value # toEncodingList :: [SharePointVersion] -> Encoding #
ToJSONKey SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods toJSONKey :: ToJSONKeyFunction SharePointVersion # toJSONKeyList :: ToJSONKeyFunction [SharePointVersion] #
ToByteString SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods toBS :: SharePointVersion -> ByteString #
ToHeader SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods toHeader :: HeaderName -> SharePointVersion -> [Header] #
ToLog SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods build :: SharePointVersion -> ByteStringBuilder #
ToQuery SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods toQuery :: SharePointVersion -> QueryString #
FromText SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods fromText :: Text -> Either String SharePointVersion #
ToText SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods toText :: SharePointVersion -> Text #
FromXML SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods parseXML :: [Node] -> Either String SharePointVersion #
ToXML SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods toXML :: SharePointVersion -> XML #
Generic SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Associated Types type Rep SharePointVersion :: Type -> Type # Methods from :: SharePointVersion -> Rep SharePointVersion x # to :: Rep SharePointVersion x -> SharePointVersion #
Read SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods readsPrec :: Int -> ReadS SharePointVersion # readList :: ReadS [SharePointVersion] # readPrec :: ReadPrec SharePointVersion # readListPrec :: ReadPrec [SharePointVersion] #
Show SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods showsPrec :: Int -> SharePointVersion -> ShowS # show :: SharePointVersion -> String # showList :: [SharePointVersion] -> ShowS #
NFData SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods rnf :: SharePointVersion -> () #
Eq SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods (==) :: SharePointVersion -> SharePointVersion -> Bool # (/=) :: SharePointVersion -> SharePointVersion -> Bool #
Ord SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods compare :: SharePointVersion -> SharePointVersion -> Ordering # (<) :: SharePointVersion -> SharePointVersion -> Bool # (<=) :: SharePointVersion -> SharePointVersion -> Bool # (>) :: SharePointVersion -> SharePointVersion -> Bool # (>=) :: SharePointVersion -> SharePointVersion -> Bool # max :: SharePointVersion -> SharePointVersion -> SharePointVersion # min :: SharePointVersion -> SharePointVersion -> SharePointVersion #
Hashable SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion Methods hashWithSalt :: Int -> SharePointVersion -> Int # hash :: SharePointVersion -> Int #
type Rep SharePointVersion Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointVersion type Rep SharePointVersion = D1 ('MetaData "SharePointVersion" "Amazonka.Kendra.Types.SharePointVersion" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SharePointVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSharePointVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SlackEntity

newtype SlackEntity Source #

Constructors

SlackEntity'
Fields fromSlackEntity :: Text

Bundled Patterns

pattern SlackEntity_DIRECT_MESSAGE :: SlackEntity
pattern SlackEntity_GROUP_MESSAGE :: SlackEntity
pattern SlackEntity_PRIVATE_CHANNEL :: SlackEntity
pattern SlackEntity_PUBLIC_CHANNEL :: SlackEntity

Instances

Instances details

FromJSON SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods parseJSON :: Value -> Parser SlackEntity # parseJSONList :: Value -> Parser [SlackEntity] #
FromJSONKey SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods fromJSONKey :: FromJSONKeyFunction SlackEntity # fromJSONKeyList :: FromJSONKeyFunction [SlackEntity] #
ToJSON SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods toJSON :: SlackEntity -> Value # toEncoding :: SlackEntity -> Encoding # toJSONList :: [SlackEntity] -> Value # toEncodingList :: [SlackEntity] -> Encoding #
ToJSONKey SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods toJSONKey :: ToJSONKeyFunction SlackEntity # toJSONKeyList :: ToJSONKeyFunction [SlackEntity] #
ToByteString SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods toBS :: SlackEntity -> ByteString #
ToHeader SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods toHeader :: HeaderName -> SlackEntity -> [Header] #
ToLog SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods build :: SlackEntity -> ByteStringBuilder #
ToQuery SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods toQuery :: SlackEntity -> QueryString #
FromText SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods fromText :: Text -> Either String SlackEntity #
ToText SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods toText :: SlackEntity -> Text #
FromXML SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods parseXML :: [Node] -> Either String SlackEntity #
ToXML SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods toXML :: SlackEntity -> XML #
Generic SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Associated Types type Rep SlackEntity :: Type -> Type # Methods from :: SlackEntity -> Rep SlackEntity x # to :: Rep SlackEntity x -> SlackEntity #
Read SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods readsPrec :: Int -> ReadS SlackEntity # readList :: ReadS [SlackEntity] # readPrec :: ReadPrec SlackEntity # readListPrec :: ReadPrec [SlackEntity] #
Show SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods showsPrec :: Int -> SlackEntity -> ShowS # show :: SlackEntity -> String # showList :: [SlackEntity] -> ShowS #
NFData SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods rnf :: SlackEntity -> () #
Eq SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods (==) :: SlackEntity -> SlackEntity -> Bool # (/=) :: SlackEntity -> SlackEntity -> Bool #
Ord SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods compare :: SlackEntity -> SlackEntity -> Ordering # (<) :: SlackEntity -> SlackEntity -> Bool # (<=) :: SlackEntity -> SlackEntity -> Bool # (>) :: SlackEntity -> SlackEntity -> Bool # (>=) :: SlackEntity -> SlackEntity -> Bool # max :: SlackEntity -> SlackEntity -> SlackEntity # min :: SlackEntity -> SlackEntity -> SlackEntity #
Hashable SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity Methods hashWithSalt :: Int -> SlackEntity -> Int # hash :: SlackEntity -> Int #
type Rep SlackEntity Source #
Instance details Defined in Amazonka.Kendra.Types.SlackEntity type Rep SlackEntity = D1 ('MetaData "SlackEntity" "Amazonka.Kendra.Types.SlackEntity" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SlackEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSlackEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SortOrder

newtype SortOrder Source #

Constructors

SortOrder'
Fields fromSortOrder :: Text

Bundled Patterns

pattern SortOrder_ASC :: SortOrder
pattern SortOrder_DESC :: SortOrder

Instances

Instances details

FromJSON SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods parseJSON :: Value -> Parser SortOrder # parseJSONList :: Value -> Parser [SortOrder] #
FromJSONKey SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods fromJSONKey :: FromJSONKeyFunction SortOrder # fromJSONKeyList :: FromJSONKeyFunction [SortOrder] #
ToJSON SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods toJSON :: SortOrder -> Value # toEncoding :: SortOrder -> Encoding # toJSONList :: [SortOrder] -> Value # toEncodingList :: [SortOrder] -> Encoding #
ToJSONKey SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods toJSONKey :: ToJSONKeyFunction SortOrder # toJSONKeyList :: ToJSONKeyFunction [SortOrder] #
ToByteString SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods toBS :: SortOrder -> ByteString #
ToHeader SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods toHeader :: HeaderName -> SortOrder -> [Header] #
ToLog SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods build :: SortOrder -> ByteStringBuilder #
ToQuery SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods toQuery :: SortOrder -> QueryString #
FromText SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods fromText :: Text -> Either String SortOrder #
ToText SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods toText :: SortOrder -> Text #
FromXML SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods parseXML :: [Node] -> Either String SortOrder #
ToXML SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods toXML :: SortOrder -> XML #
Generic SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Associated Types type Rep SortOrder :: Type -> Type # Methods from :: SortOrder -> Rep SortOrder x # to :: Rep SortOrder x -> SortOrder #
Read SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods readsPrec :: Int -> ReadS SortOrder # readList :: ReadS [SortOrder] # readPrec :: ReadPrec SortOrder # readListPrec :: ReadPrec [SortOrder] #
Show SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods showsPrec :: Int -> SortOrder -> ShowS # show :: SortOrder -> String # showList :: [SortOrder] -> ShowS #
NFData SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods rnf :: SortOrder -> () #
Eq SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods (==) :: SortOrder -> SortOrder -> Bool # (/=) :: SortOrder -> SortOrder -> Bool #
Ord SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods compare :: SortOrder -> SortOrder -> Ordering # (<) :: SortOrder -> SortOrder -> Bool # (<=) :: SortOrder -> SortOrder -> Bool # (>) :: SortOrder -> SortOrder -> Bool # (>=) :: SortOrder -> SortOrder -> Bool # max :: SortOrder -> SortOrder -> SortOrder # min :: SortOrder -> SortOrder -> SortOrder #
Hashable SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder Methods hashWithSalt :: Int -> SortOrder -> Int # hash :: SortOrder -> Int #
type Rep SortOrder Source #
Instance details Defined in Amazonka.Kendra.Types.SortOrder type Rep SortOrder = D1 ('MetaData "SortOrder" "Amazonka.Kendra.Types.SortOrder" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "SortOrder'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ThesaurusStatus

newtype ThesaurusStatus Source #

Constructors

ThesaurusStatus'
Fields fromThesaurusStatus :: Text

Bundled Patterns

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

Instances

Instances details

FromJSON ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods parseJSON :: Value -> Parser ThesaurusStatus # parseJSONList :: Value -> Parser [ThesaurusStatus] #
FromJSONKey ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods fromJSONKey :: FromJSONKeyFunction ThesaurusStatus # fromJSONKeyList :: FromJSONKeyFunction [ThesaurusStatus] #
ToJSON ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods toJSON :: ThesaurusStatus -> Value # toEncoding :: ThesaurusStatus -> Encoding # toJSONList :: [ThesaurusStatus] -> Value # toEncodingList :: [ThesaurusStatus] -> Encoding #
ToJSONKey ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods toJSONKey :: ToJSONKeyFunction ThesaurusStatus # toJSONKeyList :: ToJSONKeyFunction [ThesaurusStatus] #
ToByteString ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods toBS :: ThesaurusStatus -> ByteString #
ToHeader ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods toHeader :: HeaderName -> ThesaurusStatus -> [Header] #
ToLog ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods build :: ThesaurusStatus -> ByteStringBuilder #
ToQuery ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods toQuery :: ThesaurusStatus -> QueryString #
FromText ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods fromText :: Text -> Either String ThesaurusStatus #
ToText ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods toText :: ThesaurusStatus -> Text #
FromXML ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods parseXML :: [Node] -> Either String ThesaurusStatus #
ToXML ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods toXML :: ThesaurusStatus -> XML #
Generic ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Associated Types type Rep ThesaurusStatus :: Type -> Type # Methods from :: ThesaurusStatus -> Rep ThesaurusStatus x # to :: Rep ThesaurusStatus x -> ThesaurusStatus #
Read ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods readsPrec :: Int -> ReadS ThesaurusStatus # readList :: ReadS [ThesaurusStatus] # readPrec :: ReadPrec ThesaurusStatus # readListPrec :: ReadPrec [ThesaurusStatus] #
Show ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods showsPrec :: Int -> ThesaurusStatus -> ShowS # show :: ThesaurusStatus -> String # showList :: [ThesaurusStatus] -> ShowS #
NFData ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods rnf :: ThesaurusStatus -> () #
Eq ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods (==) :: ThesaurusStatus -> ThesaurusStatus -> Bool # (/=) :: ThesaurusStatus -> ThesaurusStatus -> Bool #
Ord ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods compare :: ThesaurusStatus -> ThesaurusStatus -> Ordering # (<) :: ThesaurusStatus -> ThesaurusStatus -> Bool # (<=) :: ThesaurusStatus -> ThesaurusStatus -> Bool # (>) :: ThesaurusStatus -> ThesaurusStatus -> Bool # (>=) :: ThesaurusStatus -> ThesaurusStatus -> Bool # max :: ThesaurusStatus -> ThesaurusStatus -> ThesaurusStatus # min :: ThesaurusStatus -> ThesaurusStatus -> ThesaurusStatus #
Hashable ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus Methods hashWithSalt :: Int -> ThesaurusStatus -> Int # hash :: ThesaurusStatus -> Int #
type Rep ThesaurusStatus Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusStatus type Rep ThesaurusStatus = D1 ('MetaData "ThesaurusStatus" "Amazonka.Kendra.Types.ThesaurusStatus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "ThesaurusStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromThesaurusStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Type

newtype Type Source #

Constructors

Type'
Fields fromType :: Text

Bundled Patterns

pattern Type_ON_PREMISE :: Type
pattern Type_SAAS :: Type

Instances

Instances details

FromJSON Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods parseJSON :: Value -> Parser Type # parseJSONList :: Value -> Parser [Type] #
FromJSONKey Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods fromJSONKey :: FromJSONKeyFunction Type # fromJSONKeyList :: FromJSONKeyFunction [Type] #
ToJSON Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods toJSON :: Type -> Value # toEncoding :: Type -> Encoding # toJSONList :: [Type] -> Value # toEncodingList :: [Type] -> Encoding #
ToJSONKey Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods toJSONKey :: ToJSONKeyFunction Type # toJSONKeyList :: ToJSONKeyFunction [Type] #
ToByteString Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods toBS :: Type -> ByteString #
ToHeader Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods toHeader :: HeaderName -> Type -> [Header] #
ToLog Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods build :: Type -> ByteStringBuilder #
ToQuery Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods toQuery :: Type -> QueryString #
FromText Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods fromText :: Text -> Either String Type #
ToText Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods toText :: Type -> Text #
FromXML Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods parseXML :: [Node] -> Either String Type #
ToXML Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods toXML :: Type -> XML #
Generic Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Associated Types type Rep Type :: Type -> Type # Methods from :: Type -> Rep Type x # to :: Rep Type x -> Type #
Read Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods readsPrec :: Int -> ReadS Type # readList :: ReadS [Type] # readPrec :: ReadPrec Type # readListPrec :: ReadPrec [Type] #
Show Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods showsPrec :: Int -> Type -> ShowS # show :: Type -> String # showList :: [Type] -> ShowS #
NFData Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods rnf :: Type -> () #
Eq Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods (==) :: Type -> Type -> Bool # (/=) :: Type -> Type -> Bool #
Ord Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods compare :: Type -> Type -> Ordering # (<) :: Type -> Type -> Bool # (<=) :: Type -> Type -> Bool # (>) :: Type -> Type -> Bool # (>=) :: Type -> Type -> Bool # max :: Type -> Type -> Type # min :: Type -> Type -> Type #
Hashable Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type Methods hashWithSalt :: Int -> Type -> Int # hash :: Type -> Int #
type Rep Type Source #
Instance details Defined in Amazonka.Kendra.Types.Type type Rep Type = D1 ('MetaData "Type" "Amazonka.Kendra.Types.Type" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "Type'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

UserContextPolicy

newtype UserContextPolicy Source #

Constructors

UserContextPolicy'
Fields fromUserContextPolicy :: Text

Bundled Patterns

pattern UserContextPolicy_ATTRIBUTE_FILTER :: UserContextPolicy
pattern UserContextPolicy_USER_TOKEN :: UserContextPolicy

Instances

Instances details

FromJSON UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods parseJSON :: Value -> Parser UserContextPolicy # parseJSONList :: Value -> Parser [UserContextPolicy] #
FromJSONKey UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods fromJSONKey :: FromJSONKeyFunction UserContextPolicy # fromJSONKeyList :: FromJSONKeyFunction [UserContextPolicy] #
ToJSON UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods toJSON :: UserContextPolicy -> Value # toEncoding :: UserContextPolicy -> Encoding # toJSONList :: [UserContextPolicy] -> Value # toEncodingList :: [UserContextPolicy] -> Encoding #
ToJSONKey UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods toJSONKey :: ToJSONKeyFunction UserContextPolicy # toJSONKeyList :: ToJSONKeyFunction [UserContextPolicy] #
ToByteString UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods toBS :: UserContextPolicy -> ByteString #
ToHeader UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods toHeader :: HeaderName -> UserContextPolicy -> [Header] #
ToLog UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods build :: UserContextPolicy -> ByteStringBuilder #
ToQuery UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods toQuery :: UserContextPolicy -> QueryString #
FromText UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods fromText :: Text -> Either String UserContextPolicy #
ToText UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods toText :: UserContextPolicy -> Text #
FromXML UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods parseXML :: [Node] -> Either String UserContextPolicy #
ToXML UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods toXML :: UserContextPolicy -> XML #
Generic UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Associated Types type Rep UserContextPolicy :: Type -> Type # Methods from :: UserContextPolicy -> Rep UserContextPolicy x # to :: Rep UserContextPolicy x -> UserContextPolicy #
Read UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods readsPrec :: Int -> ReadS UserContextPolicy # readList :: ReadS [UserContextPolicy] # readPrec :: ReadPrec UserContextPolicy # readListPrec :: ReadPrec [UserContextPolicy] #
Show UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods showsPrec :: Int -> UserContextPolicy -> ShowS # show :: UserContextPolicy -> String # showList :: [UserContextPolicy] -> ShowS #
NFData UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods rnf :: UserContextPolicy -> () #
Eq UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods (==) :: UserContextPolicy -> UserContextPolicy -> Bool # (/=) :: UserContextPolicy -> UserContextPolicy -> Bool #
Ord UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods compare :: UserContextPolicy -> UserContextPolicy -> Ordering # (<) :: UserContextPolicy -> UserContextPolicy -> Bool # (<=) :: UserContextPolicy -> UserContextPolicy -> Bool # (>) :: UserContextPolicy -> UserContextPolicy -> Bool # (>=) :: UserContextPolicy -> UserContextPolicy -> Bool # max :: UserContextPolicy -> UserContextPolicy -> UserContextPolicy # min :: UserContextPolicy -> UserContextPolicy -> UserContextPolicy #
Hashable UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy Methods hashWithSalt :: Int -> UserContextPolicy -> Int # hash :: UserContextPolicy -> Int #
type Rep UserContextPolicy Source #
Instance details Defined in Amazonka.Kendra.Types.UserContextPolicy type Rep UserContextPolicy = D1 ('MetaData "UserContextPolicy" "Amazonka.Kendra.Types.UserContextPolicy" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "UserContextPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUserContextPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

UserGroupResolutionMode

newtype UserGroupResolutionMode Source #

Constructors

UserGroupResolutionMode'
Fields fromUserGroupResolutionMode :: Text

Bundled Patterns

pattern UserGroupResolutionMode_AWS_SSO :: UserGroupResolutionMode
pattern UserGroupResolutionMode_NONE :: UserGroupResolutionMode

Instances

Instances details

FromJSON UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods parseJSON :: Value -> Parser UserGroupResolutionMode # parseJSONList :: Value -> Parser [UserGroupResolutionMode] #
FromJSONKey UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods fromJSONKey :: FromJSONKeyFunction UserGroupResolutionMode # fromJSONKeyList :: FromJSONKeyFunction [UserGroupResolutionMode] #
ToJSON UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods toJSON :: UserGroupResolutionMode -> Value # toEncoding :: UserGroupResolutionMode -> Encoding # toJSONList :: [UserGroupResolutionMode] -> Value # toEncodingList :: [UserGroupResolutionMode] -> Encoding #
ToJSONKey UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods toJSONKey :: ToJSONKeyFunction UserGroupResolutionMode # toJSONKeyList :: ToJSONKeyFunction [UserGroupResolutionMode] #
ToByteString UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods toBS :: UserGroupResolutionMode -> ByteString #
ToHeader UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods toHeader :: HeaderName -> UserGroupResolutionMode -> [Header] #
ToLog UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods build :: UserGroupResolutionMode -> ByteStringBuilder #
ToQuery UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods toQuery :: UserGroupResolutionMode -> QueryString #
FromText UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods fromText :: Text -> Either String UserGroupResolutionMode #
ToText UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods toText :: UserGroupResolutionMode -> Text #
FromXML UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods parseXML :: [Node] -> Either String UserGroupResolutionMode #
ToXML UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods toXML :: UserGroupResolutionMode -> XML #
Generic UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Associated Types type Rep UserGroupResolutionMode :: Type -> Type # Methods from :: UserGroupResolutionMode -> Rep UserGroupResolutionMode x # to :: Rep UserGroupResolutionMode x -> UserGroupResolutionMode #
Read UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods readsPrec :: Int -> ReadS UserGroupResolutionMode # readList :: ReadS [UserGroupResolutionMode] # readPrec :: ReadPrec UserGroupResolutionMode # readListPrec :: ReadPrec [UserGroupResolutionMode] #
Show UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods showsPrec :: Int -> UserGroupResolutionMode -> ShowS # show :: UserGroupResolutionMode -> String # showList :: [UserGroupResolutionMode] -> ShowS #
NFData UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods rnf :: UserGroupResolutionMode -> () #
Eq UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods (==) :: UserGroupResolutionMode -> UserGroupResolutionMode -> Bool # (/=) :: UserGroupResolutionMode -> UserGroupResolutionMode -> Bool #
Ord UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods compare :: UserGroupResolutionMode -> UserGroupResolutionMode -> Ordering # (<) :: UserGroupResolutionMode -> UserGroupResolutionMode -> Bool # (<=) :: UserGroupResolutionMode -> UserGroupResolutionMode -> Bool # (>) :: UserGroupResolutionMode -> UserGroupResolutionMode -> Bool # (>=) :: UserGroupResolutionMode -> UserGroupResolutionMode -> Bool # max :: UserGroupResolutionMode -> UserGroupResolutionMode -> UserGroupResolutionMode # min :: UserGroupResolutionMode -> UserGroupResolutionMode -> UserGroupResolutionMode #
Hashable UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode Methods hashWithSalt :: Int -> UserGroupResolutionMode -> Int # hash :: UserGroupResolutionMode -> Int #
type Rep UserGroupResolutionMode Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionMode type Rep UserGroupResolutionMode = D1 ('MetaData "UserGroupResolutionMode" "Amazonka.Kendra.Types.UserGroupResolutionMode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "UserGroupResolutionMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUserGroupResolutionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WarningCode

newtype WarningCode Source #

Constructors

WarningCode'
Fields fromWarningCode :: Text

Bundled Patterns

pattern WarningCode_QUERY_LANGUAGE_INVALID_SYNTAX :: WarningCode

Instances

Instances details

FromJSON WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods parseJSON :: Value -> Parser WarningCode # parseJSONList :: Value -> Parser [WarningCode] #
FromJSONKey WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods fromJSONKey :: FromJSONKeyFunction WarningCode # fromJSONKeyList :: FromJSONKeyFunction [WarningCode] #
ToJSON WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods toJSON :: WarningCode -> Value # toEncoding :: WarningCode -> Encoding # toJSONList :: [WarningCode] -> Value # toEncodingList :: [WarningCode] -> Encoding #
ToJSONKey WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods toJSONKey :: ToJSONKeyFunction WarningCode # toJSONKeyList :: ToJSONKeyFunction [WarningCode] #
ToByteString WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods toBS :: WarningCode -> ByteString #
ToHeader WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods toHeader :: HeaderName -> WarningCode -> [Header] #
ToLog WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods build :: WarningCode -> ByteStringBuilder #
ToQuery WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods toQuery :: WarningCode -> QueryString #
FromText WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods fromText :: Text -> Either String WarningCode #
ToText WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods toText :: WarningCode -> Text #
FromXML WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods parseXML :: [Node] -> Either String WarningCode #
ToXML WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods toXML :: WarningCode -> XML #
Generic WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Associated Types type Rep WarningCode :: Type -> Type # Methods from :: WarningCode -> Rep WarningCode x # to :: Rep WarningCode x -> WarningCode #
Read WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods readsPrec :: Int -> ReadS WarningCode # readList :: ReadS [WarningCode] # readPrec :: ReadPrec WarningCode # readListPrec :: ReadPrec [WarningCode] #
Show WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods showsPrec :: Int -> WarningCode -> ShowS # show :: WarningCode -> String # showList :: [WarningCode] -> ShowS #
NFData WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods rnf :: WarningCode -> () #
Eq WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods (==) :: WarningCode -> WarningCode -> Bool # (/=) :: WarningCode -> WarningCode -> Bool #
Ord WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods compare :: WarningCode -> WarningCode -> Ordering # (<) :: WarningCode -> WarningCode -> Bool # (<=) :: WarningCode -> WarningCode -> Bool # (>) :: WarningCode -> WarningCode -> Bool # (>=) :: WarningCode -> WarningCode -> Bool # max :: WarningCode -> WarningCode -> WarningCode # min :: WarningCode -> WarningCode -> WarningCode #
Hashable WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode Methods hashWithSalt :: Int -> WarningCode -> Int # hash :: WarningCode -> Int #
type Rep WarningCode Source #
Instance details Defined in Amazonka.Kendra.Types.WarningCode type Rep WarningCode = D1 ('MetaData "WarningCode" "Amazonka.Kendra.Types.WarningCode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "WarningCode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWarningCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WebCrawlerMode

newtype WebCrawlerMode Source #

Constructors

WebCrawlerMode'
Fields fromWebCrawlerMode :: Text

Bundled Patterns

pattern WebCrawlerMode_EVERYTHING :: WebCrawlerMode
pattern WebCrawlerMode_HOST_ONLY :: WebCrawlerMode
pattern WebCrawlerMode_SUBDOMAINS :: WebCrawlerMode

Instances

Instances details

FromJSON WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods parseJSON :: Value -> Parser WebCrawlerMode # parseJSONList :: Value -> Parser [WebCrawlerMode] #
FromJSONKey WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods fromJSONKey :: FromJSONKeyFunction WebCrawlerMode # fromJSONKeyList :: FromJSONKeyFunction [WebCrawlerMode] #
ToJSON WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods toJSON :: WebCrawlerMode -> Value # toEncoding :: WebCrawlerMode -> Encoding # toJSONList :: [WebCrawlerMode] -> Value # toEncodingList :: [WebCrawlerMode] -> Encoding #
ToJSONKey WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods toJSONKey :: ToJSONKeyFunction WebCrawlerMode # toJSONKeyList :: ToJSONKeyFunction [WebCrawlerMode] #
ToByteString WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods toBS :: WebCrawlerMode -> ByteString #
ToHeader WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods toHeader :: HeaderName -> WebCrawlerMode -> [Header] #
ToLog WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods build :: WebCrawlerMode -> ByteStringBuilder #
ToQuery WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods toQuery :: WebCrawlerMode -> QueryString #
FromText WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods fromText :: Text -> Either String WebCrawlerMode #
ToText WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods toText :: WebCrawlerMode -> Text #
FromXML WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods parseXML :: [Node] -> Either String WebCrawlerMode #
ToXML WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods toXML :: WebCrawlerMode -> XML #
Generic WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Associated Types type Rep WebCrawlerMode :: Type -> Type # Methods from :: WebCrawlerMode -> Rep WebCrawlerMode x # to :: Rep WebCrawlerMode x -> WebCrawlerMode #
Read WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods readsPrec :: Int -> ReadS WebCrawlerMode # readList :: ReadS [WebCrawlerMode] # readPrec :: ReadPrec WebCrawlerMode # readListPrec :: ReadPrec [WebCrawlerMode] #
Show WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods showsPrec :: Int -> WebCrawlerMode -> ShowS # show :: WebCrawlerMode -> String # showList :: [WebCrawlerMode] -> ShowS #
NFData WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods rnf :: WebCrawlerMode -> () #
Eq WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods (==) :: WebCrawlerMode -> WebCrawlerMode -> Bool # (/=) :: WebCrawlerMode -> WebCrawlerMode -> Bool #
Ord WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods compare :: WebCrawlerMode -> WebCrawlerMode -> Ordering # (<) :: WebCrawlerMode -> WebCrawlerMode -> Bool # (<=) :: WebCrawlerMode -> WebCrawlerMode -> Bool # (>) :: WebCrawlerMode -> WebCrawlerMode -> Bool # (>=) :: WebCrawlerMode -> WebCrawlerMode -> Bool # max :: WebCrawlerMode -> WebCrawlerMode -> WebCrawlerMode # min :: WebCrawlerMode -> WebCrawlerMode -> WebCrawlerMode #
Hashable WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode Methods hashWithSalt :: Int -> WebCrawlerMode -> Int # hash :: WebCrawlerMode -> Int #
type Rep WebCrawlerMode Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerMode type Rep WebCrawlerMode = D1 ('MetaData "WebCrawlerMode" "Amazonka.Kendra.Types.WebCrawlerMode" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'True) (C1 ('MetaCons "WebCrawlerMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWebCrawlerMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AccessControlConfigurationSummary

data AccessControlConfigurationSummary Source #

Summary information on an access control configuration that you created for your documents in an index.

See: newAccessControlConfigurationSummary smart constructor.

Constructors

AccessControlConfigurationSummary'
Fields id :: Text The identifier of the access control configuration.

Instances

Instances details

FromJSON AccessControlConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary Methods parseJSON :: Value -> Parser AccessControlConfigurationSummary # parseJSONList :: Value -> Parser [AccessControlConfigurationSummary] #
Generic AccessControlConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary Associated Types type Rep AccessControlConfigurationSummary :: Type -> Type # Methods from :: AccessControlConfigurationSummary -> Rep AccessControlConfigurationSummary x # to :: Rep AccessControlConfigurationSummary x -> AccessControlConfigurationSummary #
Read AccessControlConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary Methods readsPrec :: Int -> ReadS AccessControlConfigurationSummary # readList :: ReadS [AccessControlConfigurationSummary] # readPrec :: ReadPrec AccessControlConfigurationSummary # readListPrec :: ReadPrec [AccessControlConfigurationSummary] #
Show AccessControlConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary Methods showsPrec :: Int -> AccessControlConfigurationSummary -> ShowS # show :: AccessControlConfigurationSummary -> String # showList :: [AccessControlConfigurationSummary] -> ShowS #
NFData AccessControlConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary Methods rnf :: AccessControlConfigurationSummary -> () #
Eq AccessControlConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary Methods (==) :: AccessControlConfigurationSummary -> AccessControlConfigurationSummary -> Bool # (/=) :: AccessControlConfigurationSummary -> AccessControlConfigurationSummary -> Bool #
Hashable AccessControlConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary Methods hashWithSalt :: Int -> AccessControlConfigurationSummary -> Int # hash :: AccessControlConfigurationSummary -> Int #
type Rep AccessControlConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlConfigurationSummary type Rep AccessControlConfigurationSummary = D1 ('MetaData "AccessControlConfigurationSummary" "Amazonka.Kendra.Types.AccessControlConfigurationSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AccessControlConfigurationSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAccessControlConfigurationSummary Source #

Arguments

:: Text	`$sel:id:AccessControlConfigurationSummary'`
-> AccessControlConfigurationSummary

Create a value of AccessControlConfigurationSummary with all optional fields omitted.

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

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

$sel:id:AccessControlConfigurationSummary', accessControlConfigurationSummary_id - The identifier of the access control configuration.

accessControlConfigurationSummary_id :: Lens' AccessControlConfigurationSummary Text Source #

The identifier of the access control configuration.

AccessControlListConfiguration

data AccessControlListConfiguration Source #

Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources.

See: newAccessControlListConfiguration smart constructor.

Constructors

AccessControlListConfiguration'
Fields keyPath :: Maybe Text Path to the Amazon S3 bucket that contains the ACL files.

Instances

Instances details

FromJSON AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration Methods parseJSON :: Value -> Parser AccessControlListConfiguration # parseJSONList :: Value -> Parser [AccessControlListConfiguration] #
ToJSON AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration Methods toJSON :: AccessControlListConfiguration -> Value # toEncoding :: AccessControlListConfiguration -> Encoding # toJSONList :: [AccessControlListConfiguration] -> Value # toEncodingList :: [AccessControlListConfiguration] -> Encoding #
Generic AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration Associated Types type Rep AccessControlListConfiguration :: Type -> Type # Methods from :: AccessControlListConfiguration -> Rep AccessControlListConfiguration x # to :: Rep AccessControlListConfiguration x -> AccessControlListConfiguration #
Read AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration Methods readsPrec :: Int -> ReadS AccessControlListConfiguration # readList :: ReadS [AccessControlListConfiguration] # readPrec :: ReadPrec AccessControlListConfiguration # readListPrec :: ReadPrec [AccessControlListConfiguration] #
Show AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration Methods showsPrec :: Int -> AccessControlListConfiguration -> ShowS # show :: AccessControlListConfiguration -> String # showList :: [AccessControlListConfiguration] -> ShowS #
NFData AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration Methods rnf :: AccessControlListConfiguration -> () #
Eq AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration Methods (==) :: AccessControlListConfiguration -> AccessControlListConfiguration -> Bool # (/=) :: AccessControlListConfiguration -> AccessControlListConfiguration -> Bool #
Hashable AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration Methods hashWithSalt :: Int -> AccessControlListConfiguration -> Int # hash :: AccessControlListConfiguration -> Int #
type Rep AccessControlListConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AccessControlListConfiguration type Rep AccessControlListConfiguration = D1 ('MetaData "AccessControlListConfiguration" "Amazonka.Kendra.Types.AccessControlListConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AccessControlListConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAccessControlListConfiguration :: AccessControlListConfiguration Source #

Create a value of AccessControlListConfiguration with all optional fields omitted.

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

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

$sel:keyPath:AccessControlListConfiguration', accessControlListConfiguration_keyPath - Path to the Amazon S3 bucket that contains the ACL files.

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

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

AclConfiguration

data AclConfiguration Source #

Provides information about the column that should be used for filtering the query response by groups.

See: newAclConfiguration smart constructor.

Constructors

AclConfiguration'
Fields allowedGroupsColumnName :: Text A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the `UserContext` field of the `Query` API.

Instances

Instances details

FromJSON AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration Methods parseJSON :: Value -> Parser AclConfiguration # parseJSONList :: Value -> Parser [AclConfiguration] #
ToJSON AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration Methods toJSON :: AclConfiguration -> Value # toEncoding :: AclConfiguration -> Encoding # toJSONList :: [AclConfiguration] -> Value # toEncodingList :: [AclConfiguration] -> Encoding #
Generic AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration Associated Types type Rep AclConfiguration :: Type -> Type # Methods from :: AclConfiguration -> Rep AclConfiguration x # to :: Rep AclConfiguration x -> AclConfiguration #
Read AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration Methods readsPrec :: Int -> ReadS AclConfiguration # readList :: ReadS [AclConfiguration] # readPrec :: ReadPrec AclConfiguration # readListPrec :: ReadPrec [AclConfiguration] #
Show AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration Methods showsPrec :: Int -> AclConfiguration -> ShowS # show :: AclConfiguration -> String # showList :: [AclConfiguration] -> ShowS #
NFData AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration Methods rnf :: AclConfiguration -> () #
Eq AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration Methods (==) :: AclConfiguration -> AclConfiguration -> Bool # (/=) :: AclConfiguration -> AclConfiguration -> Bool #
Hashable AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration Methods hashWithSalt :: Int -> AclConfiguration -> Int # hash :: AclConfiguration -> Int #
type Rep AclConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AclConfiguration type Rep AclConfiguration = D1 ('MetaData "AclConfiguration" "Amazonka.Kendra.Types.AclConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AclConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowedGroupsColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAclConfiguration Source #

Arguments

:: Text	`$sel:allowedGroupsColumnName:AclConfiguration'`
-> AclConfiguration

Create a value of AclConfiguration with all optional fields omitted.

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

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

$sel:allowedGroupsColumnName:AclConfiguration', aclConfiguration_allowedGroupsColumnName - A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query API.

aclConfiguration_allowedGroupsColumnName :: Lens' AclConfiguration Text Source #

A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query API.

AdditionalResultAttribute

data AdditionalResultAttribute Source #

An attribute returned from an index query.

See: newAdditionalResultAttribute smart constructor.

Constructors

AdditionalResultAttribute'
Fields key :: Text The key that identifies the attribute. valueType :: AdditionalResultAttributeValueType The data type of the `Value` property. value :: AdditionalResultAttributeValue An object that contains the attribute value.

Instances

Instances details

FromJSON AdditionalResultAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttribute Methods parseJSON :: Value -> Parser AdditionalResultAttribute # parseJSONList :: Value -> Parser [AdditionalResultAttribute] #
Generic AdditionalResultAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttribute Associated Types type Rep AdditionalResultAttribute :: Type -> Type # Methods from :: AdditionalResultAttribute -> Rep AdditionalResultAttribute x # to :: Rep AdditionalResultAttribute x -> AdditionalResultAttribute #
Read AdditionalResultAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttribute Methods readsPrec :: Int -> ReadS AdditionalResultAttribute # readList :: ReadS [AdditionalResultAttribute] # readPrec :: ReadPrec AdditionalResultAttribute # readListPrec :: ReadPrec [AdditionalResultAttribute] #
Show AdditionalResultAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttribute Methods showsPrec :: Int -> AdditionalResultAttribute -> ShowS # show :: AdditionalResultAttribute -> String # showList :: [AdditionalResultAttribute] -> ShowS #
NFData AdditionalResultAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttribute Methods rnf :: AdditionalResultAttribute -> () #
Eq AdditionalResultAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttribute Methods (==) :: AdditionalResultAttribute -> AdditionalResultAttribute -> Bool # (/=) :: AdditionalResultAttribute -> AdditionalResultAttribute -> Bool #
Hashable AdditionalResultAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttribute Methods hashWithSalt :: Int -> AdditionalResultAttribute -> Int # hash :: AdditionalResultAttribute -> Int #
type Rep AdditionalResultAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttribute type Rep AdditionalResultAttribute = D1 ('MetaData "AdditionalResultAttribute" "Amazonka.Kendra.Types.AdditionalResultAttribute" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AdditionalResultAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "valueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AdditionalResultAttributeValueType) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AdditionalResultAttributeValue))))

newAdditionalResultAttribute Source #

Arguments

:: Text	`$sel:key:AdditionalResultAttribute'`
-> AdditionalResultAttributeValueType	`$sel:valueType:AdditionalResultAttribute'`
-> AdditionalResultAttributeValue	`$sel:value:AdditionalResultAttribute'`
-> AdditionalResultAttribute

Create a value of AdditionalResultAttribute with all optional fields omitted.

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

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

$sel:key:AdditionalResultAttribute', additionalResultAttribute_key - The key that identifies the attribute.

$sel:valueType:AdditionalResultAttribute', additionalResultAttribute_valueType - The data type of the Value property.

$sel:value:AdditionalResultAttribute', additionalResultAttribute_value - An object that contains the attribute value.

additionalResultAttribute_key :: Lens' AdditionalResultAttribute Text Source #

The key that identifies the attribute.

additionalResultAttribute_valueType :: Lens' AdditionalResultAttribute AdditionalResultAttributeValueType Source #

The data type of the Value property.

additionalResultAttribute_value :: Lens' AdditionalResultAttribute AdditionalResultAttributeValue Source #

An object that contains the attribute value.

AdditionalResultAttributeValue

data AdditionalResultAttributeValue Source #

An attribute returned with a document from a search.

See: newAdditionalResultAttributeValue smart constructor.

Constructors

AdditionalResultAttributeValue'
Fields textWithHighlightsValue :: Maybe TextWithHighlights The text associated with the attribute and information about the highlight to apply to the text.

Instances

Instances details

FromJSON AdditionalResultAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue Methods parseJSON :: Value -> Parser AdditionalResultAttributeValue # parseJSONList :: Value -> Parser [AdditionalResultAttributeValue] #
Generic AdditionalResultAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue Associated Types type Rep AdditionalResultAttributeValue :: Type -> Type # Methods from :: AdditionalResultAttributeValue -> Rep AdditionalResultAttributeValue x # to :: Rep AdditionalResultAttributeValue x -> AdditionalResultAttributeValue #
Read AdditionalResultAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue Methods readsPrec :: Int -> ReadS AdditionalResultAttributeValue # readList :: ReadS [AdditionalResultAttributeValue] # readPrec :: ReadPrec AdditionalResultAttributeValue # readListPrec :: ReadPrec [AdditionalResultAttributeValue] #
Show AdditionalResultAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue Methods showsPrec :: Int -> AdditionalResultAttributeValue -> ShowS # show :: AdditionalResultAttributeValue -> String # showList :: [AdditionalResultAttributeValue] -> ShowS #
NFData AdditionalResultAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue Methods rnf :: AdditionalResultAttributeValue -> () #
Eq AdditionalResultAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue Methods (==) :: AdditionalResultAttributeValue -> AdditionalResultAttributeValue -> Bool # (/=) :: AdditionalResultAttributeValue -> AdditionalResultAttributeValue -> Bool #
Hashable AdditionalResultAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue Methods hashWithSalt :: Int -> AdditionalResultAttributeValue -> Int # hash :: AdditionalResultAttributeValue -> Int #
type Rep AdditionalResultAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.AdditionalResultAttributeValue type Rep AdditionalResultAttributeValue = D1 ('MetaData "AdditionalResultAttributeValue" "Amazonka.Kendra.Types.AdditionalResultAttributeValue" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AdditionalResultAttributeValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "textWithHighlightsValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextWithHighlights))))

newAdditionalResultAttributeValue :: AdditionalResultAttributeValue Source #

Create a value of AdditionalResultAttributeValue with all optional fields omitted.

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

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

$sel:textWithHighlightsValue:AdditionalResultAttributeValue', additionalResultAttributeValue_textWithHighlightsValue - The text associated with the attribute and information about the highlight to apply to the text.

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

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

AlfrescoConfiguration

data AlfrescoConfiguration Source #

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

Alfresco data source connector is currently in preview mode. Basic authentication is currently supported. If you would like to use Alfresco connector in production, contact Support.

See: newAlfrescoConfiguration smart constructor.

Constructors

AlfrescoConfiguration'

Fields

blogFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
crawlComments :: Maybe Bool
TRUE to index comments of blogs and other content.
crawlSystemFolders :: Maybe Bool
TRUE to index shared files.
documentLibraryFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
entityFilter :: Maybe (NonEmpty AlfrescoEntity)
Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
wikiFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.
siteUrl :: Text
The URL of the Alfresco site. For example, https://hostname:8080.
siteId :: Text
The identifier of the Alfresco site. For example, my-site.
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:
- username—The user name of the Alfresco account.
- password—The password of the Alfresco account.
sslCertificateS3Path :: S3Path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.
You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

Instances

Instances details

FromJSON AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration Methods parseJSON :: Value -> Parser AlfrescoConfiguration # parseJSONList :: Value -> Parser [AlfrescoConfiguration] #
ToJSON AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration Methods toJSON :: AlfrescoConfiguration -> Value # toEncoding :: AlfrescoConfiguration -> Encoding # toJSONList :: [AlfrescoConfiguration] -> Value # toEncodingList :: [AlfrescoConfiguration] -> Encoding #
Generic AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration Associated Types type Rep AlfrescoConfiguration :: Type -> Type # Methods from :: AlfrescoConfiguration -> Rep AlfrescoConfiguration x # to :: Rep AlfrescoConfiguration x -> AlfrescoConfiguration #
Read AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration Methods readsPrec :: Int -> ReadS AlfrescoConfiguration # readList :: ReadS [AlfrescoConfiguration] # readPrec :: ReadPrec AlfrescoConfiguration # readListPrec :: ReadPrec [AlfrescoConfiguration] #
Show AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration Methods showsPrec :: Int -> AlfrescoConfiguration -> ShowS # show :: AlfrescoConfiguration -> String # showList :: [AlfrescoConfiguration] -> ShowS #
NFData AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration Methods rnf :: AlfrescoConfiguration -> () #
Eq AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration Methods (==) :: AlfrescoConfiguration -> AlfrescoConfiguration -> Bool # (/=) :: AlfrescoConfiguration -> AlfrescoConfiguration -> Bool #
Hashable AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration Methods hashWithSalt :: Int -> AlfrescoConfiguration -> Int # hash :: AlfrescoConfiguration -> Int #
type Rep AlfrescoConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AlfrescoConfiguration type Rep AlfrescoConfiguration = D1 ('MetaData "AlfrescoConfiguration" "Amazonka.Kendra.Types.AlfrescoConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AlfrescoConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blogFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "crawlComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "crawlSystemFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "documentLibraryFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "entityFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AlfrescoEntity))) :: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :: S1 ('MetaSel ('Just "wikiFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :: ((S1 ('MetaSel ('Just "siteUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "siteId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sslCertificateS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Path))))))

newAlfrescoConfiguration Source #

Arguments

:: Text	`$sel:siteUrl:AlfrescoConfiguration'`
-> Text	`$sel:siteId:AlfrescoConfiguration'`
-> Text	`$sel:secretArn:AlfrescoConfiguration'`
-> S3Path	`$sel:sslCertificateS3Path:AlfrescoConfiguration'`
-> AlfrescoConfiguration

Create a value of AlfrescoConfiguration with all optional fields omitted.

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

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

$sel:blogFieldMappings:AlfrescoConfiguration', alfrescoConfiguration_blogFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

$sel:crawlComments:AlfrescoConfiguration', alfrescoConfiguration_crawlComments - TRUE to index comments of blogs and other content.

$sel:crawlSystemFolders:AlfrescoConfiguration', alfrescoConfiguration_crawlSystemFolders - TRUE to index shared files.

$sel:documentLibraryFieldMappings:AlfrescoConfiguration', alfrescoConfiguration_documentLibraryFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

$sel:entityFilter:AlfrescoConfiguration', alfrescoConfiguration_entityFilter - Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.

$sel:exclusionPatterns:AlfrescoConfiguration', alfrescoConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:inclusionPatterns:AlfrescoConfiguration', alfrescoConfiguration_inclusionPatterns - A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:vpcConfiguration:AlfrescoConfiguration', alfrescoConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.

$sel:wikiFieldMappings:AlfrescoConfiguration', alfrescoConfiguration_wikiFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

$sel:siteUrl:AlfrescoConfiguration', alfrescoConfiguration_siteUrl - The URL of the Alfresco site. For example, https://hostname:8080.

$sel:siteId:AlfrescoConfiguration', alfrescoConfiguration_siteId - The identifier of the Alfresco site. For example, my-site.

$sel:secretArn:AlfrescoConfiguration', alfrescoConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:

username—The user name of the Alfresco account.
password—The password of the Alfresco account.

$sel:sslCertificateS3Path:AlfrescoConfiguration', alfrescoConfiguration_sslCertificateS3Path - The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

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

TRUE to index comments of blogs and other content.

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

TRUE to index shared files.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

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

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

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

A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

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

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Alfresco fields. For more information, see Mapping data source fields. The Alfresco data source field names must exist in your Alfresco custom metadata.

alfrescoConfiguration_siteUrl :: Lens' AlfrescoConfiguration Text Source #

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

alfrescoConfiguration_siteId :: Lens' AlfrescoConfiguration Text Source #

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

alfrescoConfiguration_secretArn :: Lens' AlfrescoConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:

username—The user name of the Alfresco account.
password—The password of the Alfresco account.

alfrescoConfiguration_sslCertificateS3Path :: Lens' AlfrescoConfiguration S3Path Source #

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

AttributeFilter

data AttributeFilter Source #

Provides filtering the query results based on document attributes or metadata fields.

When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:

<AndAllFilters>

```
 <OrAllFilters>
```
```
 <EqualsTo>
```

If you use more than 2 layers, you receive a ValidationException exception with the message "AttributeFilter cannot have a depth of more than 2."

If you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message "AttributeFilter cannot have a length of more than 10".

See: newAttributeFilter smart constructor.

Constructors

Fields

andAllFilters :: Maybe [AttributeFilter]
Performs a logical AND operation on all supplied filters.
containsAll :: Maybe DocumentAttribute
Returns true when a document contains all of the specified document attributes or metadata fields. This filter is only applicable to StringListValue metadata.
containsAny :: Maybe DocumentAttribute
Returns true when a document contains any of the specified document attributes or metadata fields. This filter is only applicable to StringListValue metadata.
equalsTo :: Maybe DocumentAttribute
Performs an equals operation on two document attributes or metadata fields.
greaterThan :: Maybe DocumentAttribute
Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
greaterThanOrEquals :: Maybe DocumentAttribute
Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
lessThan :: Maybe DocumentAttribute
Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
lessThanOrEquals :: Maybe DocumentAttribute
Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
notFilter :: Maybe AttributeFilter
Performs a logical NOT operation on all supplied filters.
orAllFilters :: Maybe [AttributeFilter]
Performs a logical OR operation on all supplied filters.

Instances

newAttributeFilter :: AttributeFilter Source #

Create a value of AttributeFilter with all optional fields omitted.

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

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

$sel:andAllFilters:AttributeFilter', attributeFilter_andAllFilters - Performs a logical AND operation on all supplied filters.

$sel:containsAll:AttributeFilter', attributeFilter_containsAll - Returns true when a document contains all of the specified document attributes or metadata fields. This filter is only applicable to StringListValue metadata.

$sel:containsAny:AttributeFilter', attributeFilter_containsAny - Returns true when a document contains any of the specified document attributes or metadata fields. This filter is only applicable to StringListValue metadata.

$sel:equalsTo:AttributeFilter', attributeFilter_equalsTo - Performs an equals operation on two document attributes or metadata fields.

$sel:greaterThan:AttributeFilter', attributeFilter_greaterThan - Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

$sel:greaterThanOrEquals:AttributeFilter', attributeFilter_greaterThanOrEquals - Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

$sel:lessThan:AttributeFilter', attributeFilter_lessThan - Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

$sel:lessThanOrEquals:AttributeFilter', attributeFilter_lessThanOrEquals - Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.

$sel:notFilter:AttributeFilter', attributeFilter_notFilter - Performs a logical NOT operation on all supplied filters.

$sel:orAllFilters:AttributeFilter', attributeFilter_orAllFilters - Performs a logical OR operation on all supplied filters.

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

Performs a logical AND operation on all supplied filters.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Performs a logical NOT operation on all supplied filters.

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

Performs a logical OR operation on all supplied filters.

AuthenticationConfiguration

data AuthenticationConfiguration Source #

Provides the configuration information to connect to websites that require user authentication.

See: newAuthenticationConfiguration smart constructor.

Constructors

AuthenticationConfiguration'
Fields basicAuthentication :: Maybe [BasicAuthenticationConfiguration] The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials. The list includes the name and port number of the website host.

Instances

Instances details

FromJSON AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration Methods parseJSON :: Value -> Parser AuthenticationConfiguration # parseJSONList :: Value -> Parser [AuthenticationConfiguration] #
ToJSON AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration Methods toJSON :: AuthenticationConfiguration -> Value # toEncoding :: AuthenticationConfiguration -> Encoding # toJSONList :: [AuthenticationConfiguration] -> Value # toEncodingList :: [AuthenticationConfiguration] -> Encoding #
Generic AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration Associated Types type Rep AuthenticationConfiguration :: Type -> Type # Methods from :: AuthenticationConfiguration -> Rep AuthenticationConfiguration x # to :: Rep AuthenticationConfiguration x -> AuthenticationConfiguration #
Read AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration Methods readsPrec :: Int -> ReadS AuthenticationConfiguration # readList :: ReadS [AuthenticationConfiguration] # readPrec :: ReadPrec AuthenticationConfiguration # readListPrec :: ReadPrec [AuthenticationConfiguration] #
Show AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration Methods showsPrec :: Int -> AuthenticationConfiguration -> ShowS # show :: AuthenticationConfiguration -> String # showList :: [AuthenticationConfiguration] -> ShowS #
NFData AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration Methods rnf :: AuthenticationConfiguration -> () #
Eq AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration Methods (==) :: AuthenticationConfiguration -> AuthenticationConfiguration -> Bool # (/=) :: AuthenticationConfiguration -> AuthenticationConfiguration -> Bool #
Hashable AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration Methods hashWithSalt :: Int -> AuthenticationConfiguration -> Int # hash :: AuthenticationConfiguration -> Int #
type Rep AuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.AuthenticationConfiguration type Rep AuthenticationConfiguration = D1 ('MetaData "AuthenticationConfiguration" "Amazonka.Kendra.Types.AuthenticationConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AuthenticationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "basicAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BasicAuthenticationConfiguration]))))

newAuthenticationConfiguration :: AuthenticationConfiguration Source #

Create a value of AuthenticationConfiguration with all optional fields omitted.

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

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

$sel:basicAuthentication:AuthenticationConfiguration', authenticationConfiguration_basicAuthentication - The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

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

The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

BasicAuthenticationConfiguration

data BasicAuthenticationConfiguration Source #

Provides the configuration information to connect to websites that require basic user authentication.

See: newBasicAuthenticationConfiguration smart constructor.

Constructors

BasicAuthenticationConfiguration'

Fields

host :: Text
The name of the website host you want to connect to using authentication credentials.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
port :: Natural
The port number of the website host you want to connect to using authentication credentials.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
credentials :: Text
Your secret ARN, which you can create in Secrets Manager
You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

Instances

Instances details

FromJSON BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods parseJSON :: Value -> Parser BasicAuthenticationConfiguration # parseJSONList :: Value -> Parser [BasicAuthenticationConfiguration] #
ToJSON BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods toJSON :: BasicAuthenticationConfiguration -> Value # toEncoding :: BasicAuthenticationConfiguration -> Encoding # toJSONList :: [BasicAuthenticationConfiguration] -> Value # toEncodingList :: [BasicAuthenticationConfiguration] -> Encoding #
Generic BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Associated Types type Rep BasicAuthenticationConfiguration :: Type -> Type # Methods from :: BasicAuthenticationConfiguration -> Rep BasicAuthenticationConfiguration x # to :: Rep BasicAuthenticationConfiguration x -> BasicAuthenticationConfiguration #
Read BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods readsPrec :: Int -> ReadS BasicAuthenticationConfiguration # readList :: ReadS [BasicAuthenticationConfiguration] # readPrec :: ReadPrec BasicAuthenticationConfiguration # readListPrec :: ReadPrec [BasicAuthenticationConfiguration] #
Show BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods showsPrec :: Int -> BasicAuthenticationConfiguration -> ShowS # show :: BasicAuthenticationConfiguration -> String # showList :: [BasicAuthenticationConfiguration] -> ShowS #
NFData BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods rnf :: BasicAuthenticationConfiguration -> () #
Eq BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods (==) :: BasicAuthenticationConfiguration -> BasicAuthenticationConfiguration -> Bool # (/=) :: BasicAuthenticationConfiguration -> BasicAuthenticationConfiguration -> Bool #
Hashable BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration Methods hashWithSalt :: Int -> BasicAuthenticationConfiguration -> Int # hash :: BasicAuthenticationConfiguration -> Int #
type Rep BasicAuthenticationConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BasicAuthenticationConfiguration type Rep BasicAuthenticationConfiguration = D1 ('MetaData "BasicAuthenticationConfiguration" "Amazonka.Kendra.Types.BasicAuthenticationConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BasicAuthenticationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newBasicAuthenticationConfiguration Source #

Arguments

:: Text	`$sel:host:BasicAuthenticationConfiguration'`
-> Natural	`$sel:port:BasicAuthenticationConfiguration'`
-> Text	`$sel:credentials:BasicAuthenticationConfiguration'`
-> BasicAuthenticationConfiguration

Create a value of BasicAuthenticationConfiguration with all optional fields omitted.

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

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

$sel:host:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_host - The name of the website host you want to connect to using authentication credentials.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

$sel:port:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_port - The port number of the website host you want to connect to using authentication credentials.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

$sel:credentials:BasicAuthenticationConfiguration', basicAuthenticationConfiguration_credentials - Your secret ARN, which you can create in Secrets Manager

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

basicAuthenticationConfiguration_host :: Lens' BasicAuthenticationConfiguration Text Source #

The name of the website host you want to connect to using authentication credentials.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

basicAuthenticationConfiguration_port :: Lens' BasicAuthenticationConfiguration Natural Source #

The port number of the website host you want to connect to using authentication credentials.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

basicAuthenticationConfiguration_credentials :: Lens' BasicAuthenticationConfiguration Text Source #

Your secret ARN, which you can create in Secrets Manager

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

BatchDeleteDocumentResponseFailedDocument

data BatchDeleteDocumentResponseFailedDocument Source #

Provides information about documents that could not be removed from an index by the BatchDeleteDocument API.

See: newBatchDeleteDocumentResponseFailedDocument smart constructor.

Constructors

BatchDeleteDocumentResponseFailedDocument'
Fields errorCode :: Maybe ErrorCode The error code for why the document couldn't be removed from the index. errorMessage :: Maybe Text An explanation for why the document couldn't be removed from the index. id :: Maybe Text The identifier of the document that couldn't be removed from the index.

Instances

Instances details

FromJSON BatchDeleteDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument Methods parseJSON :: Value -> Parser BatchDeleteDocumentResponseFailedDocument # parseJSONList :: Value -> Parser [BatchDeleteDocumentResponseFailedDocument] #
Generic BatchDeleteDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument Associated Types type Rep BatchDeleteDocumentResponseFailedDocument :: Type -> Type # Methods from :: BatchDeleteDocumentResponseFailedDocument -> Rep BatchDeleteDocumentResponseFailedDocument x # to :: Rep BatchDeleteDocumentResponseFailedDocument x -> BatchDeleteDocumentResponseFailedDocument #
Read BatchDeleteDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument Methods readsPrec :: Int -> ReadS BatchDeleteDocumentResponseFailedDocument # readList :: ReadS [BatchDeleteDocumentResponseFailedDocument] # readPrec :: ReadPrec BatchDeleteDocumentResponseFailedDocument # readListPrec :: ReadPrec [BatchDeleteDocumentResponseFailedDocument] #
Show BatchDeleteDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument Methods showsPrec :: Int -> BatchDeleteDocumentResponseFailedDocument -> ShowS # show :: BatchDeleteDocumentResponseFailedDocument -> String # showList :: [BatchDeleteDocumentResponseFailedDocument] -> ShowS #
NFData BatchDeleteDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument Methods rnf :: BatchDeleteDocumentResponseFailedDocument -> () #
Eq BatchDeleteDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument Methods (==) :: BatchDeleteDocumentResponseFailedDocument -> BatchDeleteDocumentResponseFailedDocument -> Bool # (/=) :: BatchDeleteDocumentResponseFailedDocument -> BatchDeleteDocumentResponseFailedDocument -> Bool #
Hashable BatchDeleteDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument Methods hashWithSalt :: Int -> BatchDeleteDocumentResponseFailedDocument -> Int # hash :: BatchDeleteDocumentResponseFailedDocument -> Int #
type Rep BatchDeleteDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument type Rep BatchDeleteDocumentResponseFailedDocument = D1 ('MetaData "BatchDeleteDocumentResponseFailedDocument" "Amazonka.Kendra.Types.BatchDeleteDocumentResponseFailedDocument" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchDeleteDocumentResponseFailedDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBatchDeleteDocumentResponseFailedDocument :: BatchDeleteDocumentResponseFailedDocument Source #

Create a value of BatchDeleteDocumentResponseFailedDocument with all optional fields omitted.

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

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

$sel:errorCode:BatchDeleteDocumentResponseFailedDocument', batchDeleteDocumentResponseFailedDocument_errorCode - The error code for why the document couldn't be removed from the index.

$sel:errorMessage:BatchDeleteDocumentResponseFailedDocument', batchDeleteDocumentResponseFailedDocument_errorMessage - An explanation for why the document couldn't be removed from the index.

$sel:id:BatchDeleteDocumentResponseFailedDocument', batchDeleteDocumentResponseFailedDocument_id - The identifier of the document that couldn't be removed from the index.

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

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

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

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

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

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

BatchGetDocumentStatusResponseError

data BatchGetDocumentStatusResponseError Source #

Provides a response when the status of a document could not be retrieved.

See: newBatchGetDocumentStatusResponseError smart constructor.

Constructors

BatchGetDocumentStatusResponseError'
Fields documentId :: Maybe Text The identifier of the document whose status could not be retrieved. errorCode :: Maybe ErrorCode Indicates the source of the error. errorMessage :: Maybe Text States that the API could not get the status of a document. This could be because the request is not valid or there is a system error.

Instances

Instances details

FromJSON BatchGetDocumentStatusResponseError Source #
Instance details Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError Methods parseJSON :: Value -> Parser BatchGetDocumentStatusResponseError # parseJSONList :: Value -> Parser [BatchGetDocumentStatusResponseError] #
Generic BatchGetDocumentStatusResponseError Source #
Instance details Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError Associated Types type Rep BatchGetDocumentStatusResponseError :: Type -> Type # Methods from :: BatchGetDocumentStatusResponseError -> Rep BatchGetDocumentStatusResponseError x # to :: Rep BatchGetDocumentStatusResponseError x -> BatchGetDocumentStatusResponseError #
Read BatchGetDocumentStatusResponseError Source #
Instance details Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError Methods readsPrec :: Int -> ReadS BatchGetDocumentStatusResponseError # readList :: ReadS [BatchGetDocumentStatusResponseError] # readPrec :: ReadPrec BatchGetDocumentStatusResponseError # readListPrec :: ReadPrec [BatchGetDocumentStatusResponseError] #
Show BatchGetDocumentStatusResponseError Source #
Instance details Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError Methods showsPrec :: Int -> BatchGetDocumentStatusResponseError -> ShowS # show :: BatchGetDocumentStatusResponseError -> String # showList :: [BatchGetDocumentStatusResponseError] -> ShowS #
NFData BatchGetDocumentStatusResponseError Source #
Instance details Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError Methods rnf :: BatchGetDocumentStatusResponseError -> () #
Eq BatchGetDocumentStatusResponseError Source #
Instance details Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError Methods (==) :: BatchGetDocumentStatusResponseError -> BatchGetDocumentStatusResponseError -> Bool # (/=) :: BatchGetDocumentStatusResponseError -> BatchGetDocumentStatusResponseError -> Bool #
Hashable BatchGetDocumentStatusResponseError Source #
Instance details Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError Methods hashWithSalt :: Int -> BatchGetDocumentStatusResponseError -> Int # hash :: BatchGetDocumentStatusResponseError -> Int #
type Rep BatchGetDocumentStatusResponseError Source #
Instance details Defined in Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError type Rep BatchGetDocumentStatusResponseError = D1 ('MetaData "BatchGetDocumentStatusResponseError" "Amazonka.Kendra.Types.BatchGetDocumentStatusResponseError" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchGetDocumentStatusResponseError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBatchGetDocumentStatusResponseError :: BatchGetDocumentStatusResponseError Source #

Create a value of BatchGetDocumentStatusResponseError with all optional fields omitted.

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

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

$sel:documentId:BatchGetDocumentStatusResponseError', batchGetDocumentStatusResponseError_documentId - The identifier of the document whose status could not be retrieved.

$sel:errorCode:BatchGetDocumentStatusResponseError', batchGetDocumentStatusResponseError_errorCode - Indicates the source of the error.

$sel:errorMessage:BatchGetDocumentStatusResponseError', batchGetDocumentStatusResponseError_errorMessage - States that the API could not get the status of a document. This could be because the request is not valid or there is a system error.

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

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

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

Indicates the source of the error.

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

States that the API could not get the status of a document. This could be because the request is not valid or there is a system error.

BatchPutDocumentResponseFailedDocument

data BatchPutDocumentResponseFailedDocument Source #

Provides information about a document that could not be indexed.

See: newBatchPutDocumentResponseFailedDocument smart constructor.

Constructors

BatchPutDocumentResponseFailedDocument'
Fields errorCode :: Maybe ErrorCode The type of error that caused the document to fail to be indexed. errorMessage :: Maybe Text A description of the reason why the document could not be indexed. id :: Maybe Text The identifier of the document.

Instances

Instances details

FromJSON BatchPutDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument Methods parseJSON :: Value -> Parser BatchPutDocumentResponseFailedDocument # parseJSONList :: Value -> Parser [BatchPutDocumentResponseFailedDocument] #
Generic BatchPutDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument Associated Types type Rep BatchPutDocumentResponseFailedDocument :: Type -> Type # Methods from :: BatchPutDocumentResponseFailedDocument -> Rep BatchPutDocumentResponseFailedDocument x # to :: Rep BatchPutDocumentResponseFailedDocument x -> BatchPutDocumentResponseFailedDocument #
Read BatchPutDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument Methods readsPrec :: Int -> ReadS BatchPutDocumentResponseFailedDocument # readList :: ReadS [BatchPutDocumentResponseFailedDocument] # readPrec :: ReadPrec BatchPutDocumentResponseFailedDocument # readListPrec :: ReadPrec [BatchPutDocumentResponseFailedDocument] #
Show BatchPutDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument Methods showsPrec :: Int -> BatchPutDocumentResponseFailedDocument -> ShowS # show :: BatchPutDocumentResponseFailedDocument -> String # showList :: [BatchPutDocumentResponseFailedDocument] -> ShowS #
NFData BatchPutDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument Methods rnf :: BatchPutDocumentResponseFailedDocument -> () #
Eq BatchPutDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument Methods (==) :: BatchPutDocumentResponseFailedDocument -> BatchPutDocumentResponseFailedDocument -> Bool # (/=) :: BatchPutDocumentResponseFailedDocument -> BatchPutDocumentResponseFailedDocument -> Bool #
Hashable BatchPutDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument Methods hashWithSalt :: Int -> BatchPutDocumentResponseFailedDocument -> Int # hash :: BatchPutDocumentResponseFailedDocument -> Int #
type Rep BatchPutDocumentResponseFailedDocument Source #
Instance details Defined in Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument type Rep BatchPutDocumentResponseFailedDocument = D1 ('MetaData "BatchPutDocumentResponseFailedDocument" "Amazonka.Kendra.Types.BatchPutDocumentResponseFailedDocument" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BatchPutDocumentResponseFailedDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBatchPutDocumentResponseFailedDocument :: BatchPutDocumentResponseFailedDocument Source #

Create a value of BatchPutDocumentResponseFailedDocument with all optional fields omitted.

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

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

$sel:errorCode:BatchPutDocumentResponseFailedDocument', batchPutDocumentResponseFailedDocument_errorCode - The type of error that caused the document to fail to be indexed.

$sel:errorMessage:BatchPutDocumentResponseFailedDocument', batchPutDocumentResponseFailedDocument_errorMessage - A description of the reason why the document could not be indexed.

$sel:id:BatchPutDocumentResponseFailedDocument', batchPutDocumentResponseFailedDocument_id - The identifier of the document.

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

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

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

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

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

The identifier of the document.

BoxConfiguration

data BoxConfiguration Source #

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

See: newBoxConfiguration smart constructor.

Constructors

BoxConfiguration'

Fields

commentFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.
crawlComments :: Maybe Bool
TRUE to index comments.
crawlTasks :: Maybe Bool
TRUE to index the contents of tasks.
crawlWebLinks :: Maybe Bool
TRUE to index web links.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
fileFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
taskFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.
useChangeLog :: Maybe Bool
TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.
webLinkFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.
enterpriseId :: Text
The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:
- clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
- clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
- publicKeyId—The identifier of the public key contained within an identity certificate.
- privateKey—A set of characters that make up an encryption key.
- passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.

Instances

Instances details

FromJSON BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration Methods parseJSON :: Value -> Parser BoxConfiguration # parseJSONList :: Value -> Parser [BoxConfiguration] #
ToJSON BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration Methods toJSON :: BoxConfiguration -> Value # toEncoding :: BoxConfiguration -> Encoding # toJSONList :: [BoxConfiguration] -> Value # toEncodingList :: [BoxConfiguration] -> Encoding #
Generic BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration Associated Types type Rep BoxConfiguration :: Type -> Type # Methods from :: BoxConfiguration -> Rep BoxConfiguration x # to :: Rep BoxConfiguration x -> BoxConfiguration #
Read BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration Methods readsPrec :: Int -> ReadS BoxConfiguration # readList :: ReadS [BoxConfiguration] # readPrec :: ReadPrec BoxConfiguration # readListPrec :: ReadPrec [BoxConfiguration] #
Show BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration Methods showsPrec :: Int -> BoxConfiguration -> ShowS # show :: BoxConfiguration -> String # showList :: [BoxConfiguration] -> ShowS #
NFData BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration Methods rnf :: BoxConfiguration -> () #
Eq BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration Methods (==) :: BoxConfiguration -> BoxConfiguration -> Bool # (/=) :: BoxConfiguration -> BoxConfiguration -> Bool #
Hashable BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration Methods hashWithSalt :: Int -> BoxConfiguration -> Int # hash :: BoxConfiguration -> Int #
type Rep BoxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.BoxConfiguration type Rep BoxConfiguration = D1 ('MetaData "BoxConfiguration" "Amazonka.Kendra.Types.BoxConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "BoxConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "commentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "crawlComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "crawlTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "crawlWebLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "fileFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))))) :: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "taskFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :: S1 ('MetaSel ('Just "webLinkFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "enterpriseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newBoxConfiguration Source #

Arguments

:: Text	`$sel:enterpriseId:BoxConfiguration'`
-> Text	`$sel:secretArn:BoxConfiguration'`
-> BoxConfiguration

Create a value of BoxConfiguration with all optional fields omitted.

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

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

$sel:commentFieldMappings:BoxConfiguration', boxConfiguration_commentFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

$sel:crawlComments:BoxConfiguration', boxConfiguration_crawlComments - TRUE to index comments.

$sel:crawlTasks:BoxConfiguration', boxConfiguration_crawlTasks - TRUE to index the contents of tasks.

$sel:crawlWebLinks:BoxConfiguration', boxConfiguration_crawlWebLinks - TRUE to index web links.

$sel:exclusionPatterns:BoxConfiguration', boxConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

$sel:fileFieldMappings:BoxConfiguration', boxConfiguration_fileFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

$sel:inclusionPatterns:BoxConfiguration', boxConfiguration_inclusionPatterns - A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

$sel:taskFieldMappings:BoxConfiguration', boxConfiguration_taskFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

$sel:useChangeLog:BoxConfiguration', boxConfiguration_useChangeLog - TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents.

$sel:vpcConfiguration:BoxConfiguration', boxConfiguration_vpcConfiguration - Configuration information for an Amazon VPC to connect to your Box. For more information, see Configuring a VPC.

$sel:webLinkFieldMappings:BoxConfiguration', boxConfiguration_webLinkFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

$sel:enterpriseId:BoxConfiguration', boxConfiguration_enterpriseId - The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.

$sel:secretArn:BoxConfiguration', boxConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:

clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.

You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

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

TRUE to index comments.

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

TRUE to index the contents of tasks.

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

TRUE to index web links.

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

A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box files to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

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

A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box tasks to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

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

TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents.

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

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

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Box web links to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Box fields. For more information, see Mapping data source fields. The Box field names must exist in your Box custom metadata.

boxConfiguration_enterpriseId :: Lens' BoxConfiguration Text Source #

The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.

boxConfiguration_secretArn :: Lens' BoxConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:

clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.

You create an application in Box to generate the keys or credentials required for the secret. For more information, see Using a Box data source.

CapacityUnitsConfiguration

data CapacityUnitsConfiguration Source #

Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.

See: newCapacityUnitsConfiguration smart constructor.

Constructors

CapacityUnitsConfiguration'

Fields

storageCapacityUnits :: Natural
The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
queryCapacityUnits :: Natural
The amount of extra query capacity for an index and GetQuerySuggestions capacity.
A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.
GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

Instances

Instances details

FromJSON CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration Methods parseJSON :: Value -> Parser CapacityUnitsConfiguration # parseJSONList :: Value -> Parser [CapacityUnitsConfiguration] #
ToJSON CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration Methods toJSON :: CapacityUnitsConfiguration -> Value # toEncoding :: CapacityUnitsConfiguration -> Encoding # toJSONList :: [CapacityUnitsConfiguration] -> Value # toEncodingList :: [CapacityUnitsConfiguration] -> Encoding #
Generic CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration Associated Types type Rep CapacityUnitsConfiguration :: Type -> Type # Methods from :: CapacityUnitsConfiguration -> Rep CapacityUnitsConfiguration x # to :: Rep CapacityUnitsConfiguration x -> CapacityUnitsConfiguration #
Read CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration Methods readsPrec :: Int -> ReadS CapacityUnitsConfiguration # readList :: ReadS [CapacityUnitsConfiguration] # readPrec :: ReadPrec CapacityUnitsConfiguration # readListPrec :: ReadPrec [CapacityUnitsConfiguration] #
Show CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration Methods showsPrec :: Int -> CapacityUnitsConfiguration -> ShowS # show :: CapacityUnitsConfiguration -> String # showList :: [CapacityUnitsConfiguration] -> ShowS #
NFData CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration Methods rnf :: CapacityUnitsConfiguration -> () #
Eq CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration Methods (==) :: CapacityUnitsConfiguration -> CapacityUnitsConfiguration -> Bool # (/=) :: CapacityUnitsConfiguration -> CapacityUnitsConfiguration -> Bool #
Hashable CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration Methods hashWithSalt :: Int -> CapacityUnitsConfiguration -> Int # hash :: CapacityUnitsConfiguration -> Int #
type Rep CapacityUnitsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CapacityUnitsConfiguration type Rep CapacityUnitsConfiguration = D1 ('MetaData "CapacityUnitsConfiguration" "Amazonka.Kendra.Types.CapacityUnitsConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CapacityUnitsConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "storageCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "queryCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newCapacityUnitsConfiguration Source #

Arguments

:: Natural	`$sel:storageCapacityUnits:CapacityUnitsConfiguration'`
-> Natural	`$sel:queryCapacityUnits:CapacityUnitsConfiguration'`
-> CapacityUnitsConfiguration

Create a value of CapacityUnitsConfiguration with all optional fields omitted.

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

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

$sel:storageCapacityUnits:CapacityUnitsConfiguration', capacityUnitsConfiguration_storageCapacityUnits - The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.

$sel:queryCapacityUnits:CapacityUnitsConfiguration', capacityUnitsConfiguration_queryCapacityUnits - The amount of extra query capacity for an index and GetQuerySuggestions capacity.

A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

capacityUnitsConfiguration_storageCapacityUnits :: Lens' CapacityUnitsConfiguration Natural Source #

The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.

capacityUnitsConfiguration_queryCapacityUnits :: Lens' CapacityUnitsConfiguration Natural Source #

The amount of extra query capacity for an index and GetQuerySuggestions capacity.

A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

ClickFeedback

data ClickFeedback Source #

Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback API to provide click information.

See: newClickFeedback smart constructor.

Constructors

ClickFeedback'
Fields resultId :: Text The identifier of the search result that was clicked. clickTime :: POSIX The Unix timestamp of the date and time that the result was clicked.

Instances

Instances details

ToJSON ClickFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.ClickFeedback Methods toJSON :: ClickFeedback -> Value # toEncoding :: ClickFeedback -> Encoding # toJSONList :: [ClickFeedback] -> Value # toEncodingList :: [ClickFeedback] -> Encoding #
Generic ClickFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.ClickFeedback Associated Types type Rep ClickFeedback :: Type -> Type # Methods from :: ClickFeedback -> Rep ClickFeedback x # to :: Rep ClickFeedback x -> ClickFeedback #
Read ClickFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.ClickFeedback Methods readsPrec :: Int -> ReadS ClickFeedback # readList :: ReadS [ClickFeedback] # readPrec :: ReadPrec ClickFeedback # readListPrec :: ReadPrec [ClickFeedback] #
Show ClickFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.ClickFeedback Methods showsPrec :: Int -> ClickFeedback -> ShowS # show :: ClickFeedback -> String # showList :: [ClickFeedback] -> ShowS #
NFData ClickFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.ClickFeedback Methods rnf :: ClickFeedback -> () #
Eq ClickFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.ClickFeedback Methods (==) :: ClickFeedback -> ClickFeedback -> Bool # (/=) :: ClickFeedback -> ClickFeedback -> Bool #
Hashable ClickFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.ClickFeedback Methods hashWithSalt :: Int -> ClickFeedback -> Int # hash :: ClickFeedback -> Int #
type Rep ClickFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.ClickFeedback type Rep ClickFeedback = D1 ('MetaData "ClickFeedback" "Amazonka.Kendra.Types.ClickFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ClickFeedback'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clickTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))

newClickFeedback Source #

Arguments

:: Text	`$sel:resultId:ClickFeedback'`
-> UTCTime	`$sel:clickTime:ClickFeedback'`
-> ClickFeedback

Create a value of ClickFeedback with all optional fields omitted.

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

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

$sel:resultId:ClickFeedback', clickFeedback_resultId - The identifier of the search result that was clicked.

$sel:clickTime:ClickFeedback', clickFeedback_clickTime - The Unix timestamp of the date and time that the result was clicked.

clickFeedback_resultId :: Lens' ClickFeedback Text Source #

The identifier of the search result that was clicked.

clickFeedback_clickTime :: Lens' ClickFeedback UTCTime Source #

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

ColumnConfiguration

data ColumnConfiguration Source #

Provides information about how Amazon Kendra should use the columns of a database in an index.

See: newColumnConfiguration smart constructor.

Constructors

ColumnConfiguration'

Fields

documentTitleColumnName :: Maybe Text
The column that contains the title of the document.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.
documentIdColumnName :: Text
The column that provides the document's identifier.
documentDataColumnName :: Text
The column that contains the contents of the document.
changeDetectingColumns :: NonEmpty Text
One to five columns that indicate when a document in the database has changed.

Instances

Instances details

FromJSON ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration Methods parseJSON :: Value -> Parser ColumnConfiguration # parseJSONList :: Value -> Parser [ColumnConfiguration] #
ToJSON ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration Methods toJSON :: ColumnConfiguration -> Value # toEncoding :: ColumnConfiguration -> Encoding # toJSONList :: [ColumnConfiguration] -> Value # toEncodingList :: [ColumnConfiguration] -> Encoding #
Generic ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration Associated Types type Rep ColumnConfiguration :: Type -> Type # Methods from :: ColumnConfiguration -> Rep ColumnConfiguration x # to :: Rep ColumnConfiguration x -> ColumnConfiguration #
Read ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration Methods readsPrec :: Int -> ReadS ColumnConfiguration # readList :: ReadS [ColumnConfiguration] # readPrec :: ReadPrec ColumnConfiguration # readListPrec :: ReadPrec [ColumnConfiguration] #
Show ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration Methods showsPrec :: Int -> ColumnConfiguration -> ShowS # show :: ColumnConfiguration -> String # showList :: [ColumnConfiguration] -> ShowS #
NFData ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration Methods rnf :: ColumnConfiguration -> () #
Eq ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration Methods (==) :: ColumnConfiguration -> ColumnConfiguration -> Bool # (/=) :: ColumnConfiguration -> ColumnConfiguration -> Bool #
Hashable ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration Methods hashWithSalt :: Int -> ColumnConfiguration -> Int # hash :: ColumnConfiguration -> Int #
type Rep ColumnConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ColumnConfiguration type Rep ColumnConfiguration = D1 ('MetaData "ColumnConfiguration" "Amazonka.Kendra.Types.ColumnConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ColumnConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "documentIdColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "documentDataColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "changeDetectingColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))

newColumnConfiguration Source #

Arguments

:: Text	`$sel:documentIdColumnName:ColumnConfiguration'`
-> Text	`$sel:documentDataColumnName:ColumnConfiguration'`
-> NonEmpty Text	`$sel:changeDetectingColumns:ColumnConfiguration'`
-> ColumnConfiguration

Create a value of ColumnConfiguration with all optional fields omitted.

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

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

$sel:documentTitleColumnName:ColumnConfiguration', columnConfiguration_documentTitleColumnName - The column that contains the title of the document.

$sel:fieldMappings:ColumnConfiguration', columnConfiguration_fieldMappings - An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

$sel:documentIdColumnName:ColumnConfiguration', columnConfiguration_documentIdColumnName - The column that provides the document's identifier.

$sel:documentDataColumnName:ColumnConfiguration', columnConfiguration_documentDataColumnName - The column that contains the contents of the document.

$sel:changeDetectingColumns:ColumnConfiguration', columnConfiguration_changeDetectingColumns - One to five columns that indicate when a document in the database has changed.

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

The column that contains the title of the document.

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

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

columnConfiguration_documentIdColumnName :: Lens' ColumnConfiguration Text Source #

The column that provides the document's identifier.

columnConfiguration_documentDataColumnName :: Lens' ColumnConfiguration Text Source #

The column that contains the contents of the document.

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

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

ConfluenceAttachmentConfiguration

data ConfluenceAttachmentConfiguration Source #

Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

See: newConfluenceAttachmentConfiguration smart constructor.

Constructors

ConfluenceAttachmentConfiguration'

Fields

attachmentFieldMappings :: Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping)
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.
crawlAttachments :: Maybe Bool
TRUE to index attachments of pages and blogs in Confluence.

Instances

Instances details

FromJSON ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods parseJSON :: Value -> Parser ConfluenceAttachmentConfiguration # parseJSONList :: Value -> Parser [ConfluenceAttachmentConfiguration] #
ToJSON ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods toJSON :: ConfluenceAttachmentConfiguration -> Value # toEncoding :: ConfluenceAttachmentConfiguration -> Encoding # toJSONList :: [ConfluenceAttachmentConfiguration] -> Value # toEncodingList :: [ConfluenceAttachmentConfiguration] -> Encoding #
Generic ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Associated Types type Rep ConfluenceAttachmentConfiguration :: Type -> Type # Methods from :: ConfluenceAttachmentConfiguration -> Rep ConfluenceAttachmentConfiguration x # to :: Rep ConfluenceAttachmentConfiguration x -> ConfluenceAttachmentConfiguration #
Read ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods readsPrec :: Int -> ReadS ConfluenceAttachmentConfiguration # readList :: ReadS [ConfluenceAttachmentConfiguration] # readPrec :: ReadPrec ConfluenceAttachmentConfiguration # readListPrec :: ReadPrec [ConfluenceAttachmentConfiguration] #
Show ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods showsPrec :: Int -> ConfluenceAttachmentConfiguration -> ShowS # show :: ConfluenceAttachmentConfiguration -> String # showList :: [ConfluenceAttachmentConfiguration] -> ShowS #
NFData ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods rnf :: ConfluenceAttachmentConfiguration -> () #
Eq ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods (==) :: ConfluenceAttachmentConfiguration -> ConfluenceAttachmentConfiguration -> Bool # (/=) :: ConfluenceAttachmentConfiguration -> ConfluenceAttachmentConfiguration -> Bool #
Hashable ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods hashWithSalt :: Int -> ConfluenceAttachmentConfiguration -> Int # hash :: ConfluenceAttachmentConfiguration -> Int #
type Rep ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration type Rep ConfluenceAttachmentConfiguration = D1 ('MetaData "ConfluenceAttachmentConfiguration" "Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceAttachmentConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newConfluenceAttachmentConfiguration :: ConfluenceAttachmentConfiguration Source #

Create a value of ConfluenceAttachmentConfiguration with all optional fields omitted.

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

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

$sel:attachmentFieldMappings:ConfluenceAttachmentConfiguration', confluenceAttachmentConfiguration_attachmentFieldMappings - Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

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

$sel:crawlAttachments:ConfluenceAttachmentConfiguration', confluenceAttachmentConfiguration_crawlAttachments - TRUE to index attachments of pages and blogs in Confluence.

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

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

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

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

TRUE to index attachments of pages and blogs in Confluence.

ConfluenceAttachmentToIndexFieldMapping

data ConfluenceAttachmentToIndexFieldMapping Source #

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

See: newConfluenceAttachmentToIndexFieldMapping smart constructor.

Constructors

ConfluenceAttachmentToIndexFieldMapping'

Fields

dataSourceFieldName :: Maybe ConfluenceAttachmentFieldName
The name of the field in the data source.
You must first create the index field using the UpdateIndex API.
dateFieldFormat :: Maybe Text
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
indexFieldName :: Maybe Text
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Instances

Instances details

FromJSON ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods parseJSON :: Value -> Parser ConfluenceAttachmentToIndexFieldMapping # parseJSONList :: Value -> Parser [ConfluenceAttachmentToIndexFieldMapping] #
ToJSON ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods toJSON :: ConfluenceAttachmentToIndexFieldMapping -> Value # toEncoding :: ConfluenceAttachmentToIndexFieldMapping -> Encoding # toJSONList :: [ConfluenceAttachmentToIndexFieldMapping] -> Value # toEncodingList :: [ConfluenceAttachmentToIndexFieldMapping] -> Encoding #
Generic ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Associated Types type Rep ConfluenceAttachmentToIndexFieldMapping :: Type -> Type # Methods from :: ConfluenceAttachmentToIndexFieldMapping -> Rep ConfluenceAttachmentToIndexFieldMapping x # to :: Rep ConfluenceAttachmentToIndexFieldMapping x -> ConfluenceAttachmentToIndexFieldMapping #
Read ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods readsPrec :: Int -> ReadS ConfluenceAttachmentToIndexFieldMapping # readList :: ReadS [ConfluenceAttachmentToIndexFieldMapping] # readPrec :: ReadPrec ConfluenceAttachmentToIndexFieldMapping # readListPrec :: ReadPrec [ConfluenceAttachmentToIndexFieldMapping] #
Show ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods showsPrec :: Int -> ConfluenceAttachmentToIndexFieldMapping -> ShowS # show :: ConfluenceAttachmentToIndexFieldMapping -> String # showList :: [ConfluenceAttachmentToIndexFieldMapping] -> ShowS #
NFData ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods rnf :: ConfluenceAttachmentToIndexFieldMapping -> () #
Eq ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods (==) :: ConfluenceAttachmentToIndexFieldMapping -> ConfluenceAttachmentToIndexFieldMapping -> Bool # (/=) :: ConfluenceAttachmentToIndexFieldMapping -> ConfluenceAttachmentToIndexFieldMapping -> Bool #
Hashable ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods hashWithSalt :: Int -> ConfluenceAttachmentToIndexFieldMapping -> Int # hash :: ConfluenceAttachmentToIndexFieldMapping -> Int #
type Rep ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping type Rep ConfluenceAttachmentToIndexFieldMapping = D1 ('MetaData "ConfluenceAttachmentToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceAttachmentToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAttachmentFieldName)) :: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluenceAttachmentToIndexFieldMapping :: ConfluenceAttachmentToIndexFieldMapping Source #

Create a value of ConfluenceAttachmentToIndexFieldMapping with all optional fields omitted.

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

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

$sel:dataSourceFieldName:ConfluenceAttachmentToIndexFieldMapping', confluenceAttachmentToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

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

$sel:dateFieldFormat:ConfluenceAttachmentToIndexFieldMapping', confluenceAttachmentToIndexFieldMapping_dateFieldFormat - The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

$sel:indexFieldName:ConfluenceAttachmentToIndexFieldMapping', confluenceAttachmentToIndexFieldMapping_indexFieldName - The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

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

The name of the field in the data source.

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

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

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

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

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

ConfluenceBlogConfiguration

data ConfluenceBlogConfiguration Source #

Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.

See: newConfluenceBlogConfiguration smart constructor.

Constructors

ConfluenceBlogConfiguration'

Fields

blogFieldMappings :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

Instances

Instances details

FromJSON ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration Methods parseJSON :: Value -> Parser ConfluenceBlogConfiguration # parseJSONList :: Value -> Parser [ConfluenceBlogConfiguration] #
ToJSON ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration Methods toJSON :: ConfluenceBlogConfiguration -> Value # toEncoding :: ConfluenceBlogConfiguration -> Encoding # toJSONList :: [ConfluenceBlogConfiguration] -> Value # toEncodingList :: [ConfluenceBlogConfiguration] -> Encoding #
Generic ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration Associated Types type Rep ConfluenceBlogConfiguration :: Type -> Type # Methods from :: ConfluenceBlogConfiguration -> Rep ConfluenceBlogConfiguration x # to :: Rep ConfluenceBlogConfiguration x -> ConfluenceBlogConfiguration #
Read ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration Methods readsPrec :: Int -> ReadS ConfluenceBlogConfiguration # readList :: ReadS [ConfluenceBlogConfiguration] # readPrec :: ReadPrec ConfluenceBlogConfiguration # readListPrec :: ReadPrec [ConfluenceBlogConfiguration] #
Show ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration Methods showsPrec :: Int -> ConfluenceBlogConfiguration -> ShowS # show :: ConfluenceBlogConfiguration -> String # showList :: [ConfluenceBlogConfiguration] -> ShowS #
NFData ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration Methods rnf :: ConfluenceBlogConfiguration -> () #
Eq ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration Methods (==) :: ConfluenceBlogConfiguration -> ConfluenceBlogConfiguration -> Bool # (/=) :: ConfluenceBlogConfiguration -> ConfluenceBlogConfiguration -> Bool #
Hashable ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration Methods hashWithSalt :: Int -> ConfluenceBlogConfiguration -> Int # hash :: ConfluenceBlogConfiguration -> Int #
type Rep ConfluenceBlogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration type Rep ConfluenceBlogConfiguration = D1 ('MetaData "ConfluenceBlogConfiguration" "Amazonka.Kendra.Types.ConfluenceBlogConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceBlogConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blogFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)))))

newConfluenceBlogConfiguration :: ConfluenceBlogConfiguration Source #

Create a value of ConfluenceBlogConfiguration with all optional fields omitted.

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

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

$sel:blogFieldMappings:ConfluenceBlogConfiguration', confluenceBlogConfiguration_blogFieldMappings - Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

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

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

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

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

ConfluenceBlogToIndexFieldMapping

data ConfluenceBlogToIndexFieldMapping Source #

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

See: newConfluenceBlogToIndexFieldMapping smart constructor.

Constructors

ConfluenceBlogToIndexFieldMapping'

Fields

dataSourceFieldName :: Maybe ConfluenceBlogFieldName
The name of the field in the data source.
dateFieldFormat :: Maybe Text
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
indexFieldName :: Maybe Text
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Instances

Instances details

FromJSON ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping Methods parseJSON :: Value -> Parser ConfluenceBlogToIndexFieldMapping # parseJSONList :: Value -> Parser [ConfluenceBlogToIndexFieldMapping] #
ToJSON ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping Methods toJSON :: ConfluenceBlogToIndexFieldMapping -> Value # toEncoding :: ConfluenceBlogToIndexFieldMapping -> Encoding # toJSONList :: [ConfluenceBlogToIndexFieldMapping] -> Value # toEncodingList :: [ConfluenceBlogToIndexFieldMapping] -> Encoding #
Generic ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping Associated Types type Rep ConfluenceBlogToIndexFieldMapping :: Type -> Type # Methods from :: ConfluenceBlogToIndexFieldMapping -> Rep ConfluenceBlogToIndexFieldMapping x # to :: Rep ConfluenceBlogToIndexFieldMapping x -> ConfluenceBlogToIndexFieldMapping #
Read ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping Methods readsPrec :: Int -> ReadS ConfluenceBlogToIndexFieldMapping # readList :: ReadS [ConfluenceBlogToIndexFieldMapping] # readPrec :: ReadPrec ConfluenceBlogToIndexFieldMapping # readListPrec :: ReadPrec [ConfluenceBlogToIndexFieldMapping] #
Show ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping Methods showsPrec :: Int -> ConfluenceBlogToIndexFieldMapping -> ShowS # show :: ConfluenceBlogToIndexFieldMapping -> String # showList :: [ConfluenceBlogToIndexFieldMapping] -> ShowS #
NFData ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping Methods rnf :: ConfluenceBlogToIndexFieldMapping -> () #
Eq ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping Methods (==) :: ConfluenceBlogToIndexFieldMapping -> ConfluenceBlogToIndexFieldMapping -> Bool # (/=) :: ConfluenceBlogToIndexFieldMapping -> ConfluenceBlogToIndexFieldMapping -> Bool #
Hashable ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping Methods hashWithSalt :: Int -> ConfluenceBlogToIndexFieldMapping -> Int # hash :: ConfluenceBlogToIndexFieldMapping -> Int #
type Rep ConfluenceBlogToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping type Rep ConfluenceBlogToIndexFieldMapping = D1 ('MetaData "ConfluenceBlogToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluenceBlogToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceBlogToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceBlogFieldName)) :: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluenceBlogToIndexFieldMapping :: ConfluenceBlogToIndexFieldMapping Source #

Create a value of ConfluenceBlogToIndexFieldMapping with all optional fields omitted.

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

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

$sel:dataSourceFieldName:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

$sel:dateFieldFormat:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_dateFieldFormat - The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

$sel:indexFieldName:ConfluenceBlogToIndexFieldMapping', confluenceBlogToIndexFieldMapping_indexFieldName - The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

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

The name of the field in the data source.

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

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

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

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

ConfluenceConfiguration

data ConfluenceConfiguration Source #

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

See: newConfluenceConfiguration smart constructor.

Constructors

ConfluenceConfiguration'

Fields

attachmentConfiguration :: Maybe ConfluenceAttachmentConfiguration
Configuration information for indexing attachments to Confluence blogs and pages.
authenticationType :: Maybe ConfluenceAuthenticationType
Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.
blogConfiguration :: Maybe ConfluenceBlogConfiguration
Configuration information for indexing Confluence blogs.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
pageConfiguration :: Maybe ConfluencePageConfiguration
Configuration information for indexing Confluence pages.
proxyConfiguration :: Maybe ProxyConfiguration
Configuration information to connect to your Confluence URL instance via a web proxy. You can use this option for Confluence Server.
You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.
Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.
It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.
spaceConfiguration :: Maybe ConfluenceSpaceConfiguration
Configuration information for indexing Confluence spaces.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.
serverUrl :: Text
The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password.
You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source.
version :: ConfluenceVersion
The version or the type of Confluence installation to connect to.

Instances

Instances details

FromJSON ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration Methods parseJSON :: Value -> Parser ConfluenceConfiguration # parseJSONList :: Value -> Parser [ConfluenceConfiguration] #
ToJSON ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration Methods toJSON :: ConfluenceConfiguration -> Value # toEncoding :: ConfluenceConfiguration -> Encoding # toJSONList :: [ConfluenceConfiguration] -> Value # toEncodingList :: [ConfluenceConfiguration] -> Encoding #
Generic ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration Associated Types type Rep ConfluenceConfiguration :: Type -> Type # Methods from :: ConfluenceConfiguration -> Rep ConfluenceConfiguration x # to :: Rep ConfluenceConfiguration x -> ConfluenceConfiguration #
Read ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration Methods readsPrec :: Int -> ReadS ConfluenceConfiguration # readList :: ReadS [ConfluenceConfiguration] # readPrec :: ReadPrec ConfluenceConfiguration # readListPrec :: ReadPrec [ConfluenceConfiguration] #
Show ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration Methods showsPrec :: Int -> ConfluenceConfiguration -> ShowS # show :: ConfluenceConfiguration -> String # showList :: [ConfluenceConfiguration] -> ShowS #
NFData ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration Methods rnf :: ConfluenceConfiguration -> () #
Eq ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration Methods (==) :: ConfluenceConfiguration -> ConfluenceConfiguration -> Bool # (/=) :: ConfluenceConfiguration -> ConfluenceConfiguration -> Bool #
Hashable ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration Methods hashWithSalt :: Int -> ConfluenceConfiguration -> Int # hash :: ConfluenceConfiguration -> Int #
type Rep ConfluenceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceConfiguration type Rep ConfluenceConfiguration = D1 ('MetaData "ConfluenceConfiguration" "Amazonka.Kendra.Types.ConfluenceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAttachmentConfiguration)) :: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAuthenticationType)) :: S1 ('MetaSel ('Just "blogConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceBlogConfiguration)))) :: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "pageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluencePageConfiguration))))) :: ((S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration)) :: (S1 ('MetaSel ('Just "spaceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceSpaceConfiguration)) :: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :: (S1 ('MetaSel ('Just "serverUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfluenceVersion))))))

newConfluenceConfiguration Source #

Arguments

:: Text	`$sel:serverUrl:ConfluenceConfiguration'`
-> Text	`$sel:secretArn:ConfluenceConfiguration'`
-> ConfluenceVersion	`$sel:version:ConfluenceConfiguration'`
-> ConfluenceConfiguration

Create a value of ConfluenceConfiguration with all optional fields omitted.

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

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

$sel:attachmentConfiguration:ConfluenceConfiguration', confluenceConfiguration_attachmentConfiguration - Configuration information for indexing attachments to Confluence blogs and pages.

$sel:authenticationType:ConfluenceConfiguration', confluenceConfiguration_authenticationType - Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.

$sel:blogConfiguration:ConfluenceConfiguration', confluenceConfiguration_blogConfiguration - Configuration information for indexing Confluence blogs.

$sel:exclusionPatterns:ConfluenceConfiguration', confluenceConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

$sel:inclusionPatterns:ConfluenceConfiguration', confluenceConfiguration_inclusionPatterns - A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

$sel:pageConfiguration:ConfluenceConfiguration', confluenceConfiguration_pageConfiguration - Configuration information for indexing Confluence pages.

$sel:proxyConfiguration:ConfluenceConfiguration', confluenceConfiguration_proxyConfiguration - Configuration information to connect to your Confluence URL instance via a web proxy. You can use this option for Confluence Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

$sel:spaceConfiguration:ConfluenceConfiguration', confluenceConfiguration_spaceConfiguration - Configuration information for indexing Confluence spaces.

$sel:vpcConfiguration:ConfluenceConfiguration', confluenceConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

$sel:serverUrl:ConfluenceConfiguration', confluenceConfiguration_serverUrl - The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

$sel:secretArn:ConfluenceConfiguration', confluenceConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password.

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source.

$sel:version:ConfluenceConfiguration', confluenceConfiguration_version - The version or the type of Confluence installation to connect to.

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

Configuration information for indexing attachments to Confluence blogs and pages.

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

Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.

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

Configuration information for indexing Confluence blogs.

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

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

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

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

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

Configuration information for indexing Confluence pages.

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

Configuration information to connect to your Confluence URL instance via a web proxy. You can use this option for Confluence Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

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

Configuration information for indexing Confluence spaces.

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

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

confluenceConfiguration_serverUrl :: Lens' ConfluenceConfiguration Text Source #

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/. You can also use an IP address, for example, https://192.168.1.113/.

confluenceConfiguration_secretArn :: Lens' ConfluenceConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password.

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source.

confluenceConfiguration_version :: Lens' ConfluenceConfiguration ConfluenceVersion Source #

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

ConfluencePageConfiguration

data ConfluencePageConfiguration Source #

Configuration of the page settings for the Confluence data source.

See: newConfluencePageConfiguration smart constructor.

Constructors

ConfluencePageConfiguration'

Fields

pageFieldMappings :: Maybe (NonEmpty ConfluencePageToIndexFieldMapping)
Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

Instances

Instances details

FromJSON ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods parseJSON :: Value -> Parser ConfluencePageConfiguration # parseJSONList :: Value -> Parser [ConfluencePageConfiguration] #
ToJSON ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods toJSON :: ConfluencePageConfiguration -> Value # toEncoding :: ConfluencePageConfiguration -> Encoding # toJSONList :: [ConfluencePageConfiguration] -> Value # toEncodingList :: [ConfluencePageConfiguration] -> Encoding #
Generic ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Associated Types type Rep ConfluencePageConfiguration :: Type -> Type # Methods from :: ConfluencePageConfiguration -> Rep ConfluencePageConfiguration x # to :: Rep ConfluencePageConfiguration x -> ConfluencePageConfiguration #
Read ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods readsPrec :: Int -> ReadS ConfluencePageConfiguration # readList :: ReadS [ConfluencePageConfiguration] # readPrec :: ReadPrec ConfluencePageConfiguration # readListPrec :: ReadPrec [ConfluencePageConfiguration] #
Show ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods showsPrec :: Int -> ConfluencePageConfiguration -> ShowS # show :: ConfluencePageConfiguration -> String # showList :: [ConfluencePageConfiguration] -> ShowS #
NFData ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods rnf :: ConfluencePageConfiguration -> () #
Eq ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods (==) :: ConfluencePageConfiguration -> ConfluencePageConfiguration -> Bool # (/=) :: ConfluencePageConfiguration -> ConfluencePageConfiguration -> Bool #
Hashable ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods hashWithSalt :: Int -> ConfluencePageConfiguration -> Int # hash :: ConfluencePageConfiguration -> Int #
type Rep ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration type Rep ConfluencePageConfiguration = D1 ('MetaData "ConfluencePageConfiguration" "Amazonka.Kendra.Types.ConfluencePageConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluencePageConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluencePageToIndexFieldMapping)))))

newConfluencePageConfiguration :: ConfluencePageConfiguration Source #

Create a value of ConfluencePageConfiguration with all optional fields omitted.

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

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

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

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

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

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

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

ConfluencePageToIndexFieldMapping

data ConfluencePageToIndexFieldMapping Source #

Maps attributes or field names of Confluence pages to Amazon Kendra

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

See: newConfluencePageToIndexFieldMapping smart constructor.

Constructors

ConfluencePageToIndexFieldMapping'

Fields

dataSourceFieldName :: Maybe ConfluencePageFieldName
The name of the field in the data source.
dateFieldFormat :: Maybe Text
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
indexFieldName :: Maybe Text
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Instances

Instances details

FromJSON ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping Methods parseJSON :: Value -> Parser ConfluencePageToIndexFieldMapping # parseJSONList :: Value -> Parser [ConfluencePageToIndexFieldMapping] #
ToJSON ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping Methods toJSON :: ConfluencePageToIndexFieldMapping -> Value # toEncoding :: ConfluencePageToIndexFieldMapping -> Encoding # toJSONList :: [ConfluencePageToIndexFieldMapping] -> Value # toEncodingList :: [ConfluencePageToIndexFieldMapping] -> Encoding #
Generic ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping Associated Types type Rep ConfluencePageToIndexFieldMapping :: Type -> Type # Methods from :: ConfluencePageToIndexFieldMapping -> Rep ConfluencePageToIndexFieldMapping x # to :: Rep ConfluencePageToIndexFieldMapping x -> ConfluencePageToIndexFieldMapping #
Read ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping Methods readsPrec :: Int -> ReadS ConfluencePageToIndexFieldMapping # readList :: ReadS [ConfluencePageToIndexFieldMapping] # readPrec :: ReadPrec ConfluencePageToIndexFieldMapping # readListPrec :: ReadPrec [ConfluencePageToIndexFieldMapping] #
Show ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping Methods showsPrec :: Int -> ConfluencePageToIndexFieldMapping -> ShowS # show :: ConfluencePageToIndexFieldMapping -> String # showList :: [ConfluencePageToIndexFieldMapping] -> ShowS #
NFData ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping Methods rnf :: ConfluencePageToIndexFieldMapping -> () #
Eq ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping Methods (==) :: ConfluencePageToIndexFieldMapping -> ConfluencePageToIndexFieldMapping -> Bool # (/=) :: ConfluencePageToIndexFieldMapping -> ConfluencePageToIndexFieldMapping -> Bool #
Hashable ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping Methods hashWithSalt :: Int -> ConfluencePageToIndexFieldMapping -> Int # hash :: ConfluencePageToIndexFieldMapping -> Int #
type Rep ConfluencePageToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping type Rep ConfluencePageToIndexFieldMapping = D1 ('MetaData "ConfluencePageToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluencePageToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluencePageToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluencePageFieldName)) :: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluencePageToIndexFieldMapping :: ConfluencePageToIndexFieldMapping Source #

Create a value of ConfluencePageToIndexFieldMapping with all optional fields omitted.

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

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

$sel:dataSourceFieldName:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

$sel:dateFieldFormat:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_dateFieldFormat - The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

$sel:indexFieldName:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_indexFieldName - The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

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

The name of the field in the data source.

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

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

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

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

ConfluenceSpaceConfiguration

data ConfluenceSpaceConfiguration Source #

Configuration information for indexing Confluence spaces.

See: newConfluenceSpaceConfiguration smart constructor.

Constructors

ConfluenceSpaceConfiguration'

Fields

crawlArchivedSpaces :: Maybe Bool
TRUE to index archived spaces.
crawlPersonalSpaces :: Maybe Bool
TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.
excludeSpaces :: Maybe (NonEmpty Text)
A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.
includeSpaces :: Maybe (NonEmpty Text)
A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.
spaceFieldMappings :: Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping)
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

Instances

Instances details

FromJSON ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration Methods parseJSON :: Value -> Parser ConfluenceSpaceConfiguration # parseJSONList :: Value -> Parser [ConfluenceSpaceConfiguration] #
ToJSON ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration Methods toJSON :: ConfluenceSpaceConfiguration -> Value # toEncoding :: ConfluenceSpaceConfiguration -> Encoding # toJSONList :: [ConfluenceSpaceConfiguration] -> Value # toEncodingList :: [ConfluenceSpaceConfiguration] -> Encoding #
Generic ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration Associated Types type Rep ConfluenceSpaceConfiguration :: Type -> Type # Methods from :: ConfluenceSpaceConfiguration -> Rep ConfluenceSpaceConfiguration x # to :: Rep ConfluenceSpaceConfiguration x -> ConfluenceSpaceConfiguration #
Read ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration Methods readsPrec :: Int -> ReadS ConfluenceSpaceConfiguration # readList :: ReadS [ConfluenceSpaceConfiguration] # readPrec :: ReadPrec ConfluenceSpaceConfiguration # readListPrec :: ReadPrec [ConfluenceSpaceConfiguration] #
Show ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration Methods showsPrec :: Int -> ConfluenceSpaceConfiguration -> ShowS # show :: ConfluenceSpaceConfiguration -> String # showList :: [ConfluenceSpaceConfiguration] -> ShowS #
NFData ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration Methods rnf :: ConfluenceSpaceConfiguration -> () #
Eq ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration Methods (==) :: ConfluenceSpaceConfiguration -> ConfluenceSpaceConfiguration -> Bool # (/=) :: ConfluenceSpaceConfiguration -> ConfluenceSpaceConfiguration -> Bool #
Hashable ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration Methods hashWithSalt :: Int -> ConfluenceSpaceConfiguration -> Int # hash :: ConfluenceSpaceConfiguration -> Int #
type Rep ConfluenceSpaceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration type Rep ConfluenceSpaceConfiguration = D1 ('MetaData "ConfluenceSpaceConfiguration" "Amazonka.Kendra.Types.ConfluenceSpaceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceSpaceConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlArchivedSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "crawlPersonalSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "excludeSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "includeSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "spaceFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping)))))))

newConfluenceSpaceConfiguration :: ConfluenceSpaceConfiguration Source #

Create a value of ConfluenceSpaceConfiguration with all optional fields omitted.

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

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

$sel:crawlArchivedSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_crawlArchivedSpaces - TRUE to index archived spaces.

$sel:crawlPersonalSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_crawlPersonalSpaces - TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.

$sel:excludeSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_excludeSpaces - A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

$sel:includeSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_includeSpaces - A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

$sel:spaceFieldMappings:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_spaceFieldMappings - Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

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

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

TRUE to index archived spaces.

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

TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.

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

A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

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

A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

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

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

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

ConfluenceSpaceToIndexFieldMapping

data ConfluenceSpaceToIndexFieldMapping Source #

Maps attributes or field names of Confluence spaces to Amazon Kendra

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

See: newConfluenceSpaceToIndexFieldMapping smart constructor.

Constructors

ConfluenceSpaceToIndexFieldMapping'

Fields

dataSourceFieldName :: Maybe ConfluenceSpaceFieldName
The name of the field in the data source.
dateFieldFormat :: Maybe Text
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
indexFieldName :: Maybe Text
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Instances

Instances details

FromJSON ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping Methods parseJSON :: Value -> Parser ConfluenceSpaceToIndexFieldMapping # parseJSONList :: Value -> Parser [ConfluenceSpaceToIndexFieldMapping] #
ToJSON ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping Methods toJSON :: ConfluenceSpaceToIndexFieldMapping -> Value # toEncoding :: ConfluenceSpaceToIndexFieldMapping -> Encoding # toJSONList :: [ConfluenceSpaceToIndexFieldMapping] -> Value # toEncodingList :: [ConfluenceSpaceToIndexFieldMapping] -> Encoding #
Generic ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping Associated Types type Rep ConfluenceSpaceToIndexFieldMapping :: Type -> Type # Methods from :: ConfluenceSpaceToIndexFieldMapping -> Rep ConfluenceSpaceToIndexFieldMapping x # to :: Rep ConfluenceSpaceToIndexFieldMapping x -> ConfluenceSpaceToIndexFieldMapping #
Read ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping Methods readsPrec :: Int -> ReadS ConfluenceSpaceToIndexFieldMapping # readList :: ReadS [ConfluenceSpaceToIndexFieldMapping] # readPrec :: ReadPrec ConfluenceSpaceToIndexFieldMapping # readListPrec :: ReadPrec [ConfluenceSpaceToIndexFieldMapping] #
Show ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping Methods showsPrec :: Int -> ConfluenceSpaceToIndexFieldMapping -> ShowS # show :: ConfluenceSpaceToIndexFieldMapping -> String # showList :: [ConfluenceSpaceToIndexFieldMapping] -> ShowS #
NFData ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping Methods rnf :: ConfluenceSpaceToIndexFieldMapping -> () #
Eq ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping Methods (==) :: ConfluenceSpaceToIndexFieldMapping -> ConfluenceSpaceToIndexFieldMapping -> Bool # (/=) :: ConfluenceSpaceToIndexFieldMapping -> ConfluenceSpaceToIndexFieldMapping -> Bool #
Hashable ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping Methods hashWithSalt :: Int -> ConfluenceSpaceToIndexFieldMapping -> Int # hash :: ConfluenceSpaceToIndexFieldMapping -> Int #
type Rep ConfluenceSpaceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping type Rep ConfluenceSpaceToIndexFieldMapping = D1 ('MetaData "ConfluenceSpaceToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluenceSpaceToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceSpaceToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceSpaceFieldName)) :: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluenceSpaceToIndexFieldMapping :: ConfluenceSpaceToIndexFieldMapping Source #

Create a value of ConfluenceSpaceToIndexFieldMapping with all optional fields omitted.

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

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

$sel:dataSourceFieldName:ConfluenceSpaceToIndexFieldMapping', confluenceSpaceToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

$sel:dateFieldFormat:ConfluenceSpaceToIndexFieldMapping', confluenceSpaceToIndexFieldMapping_dateFieldFormat - The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

$sel:indexFieldName:ConfluenceSpaceToIndexFieldMapping', confluenceSpaceToIndexFieldMapping_indexFieldName - The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

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

The name of the field in the data source.

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

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

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

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

ConnectionConfiguration

data ConnectionConfiguration Source #

Provides the configuration information that's required to connect to a database.

See: newConnectionConfiguration smart constructor.

Constructors

ConnectionConfiguration'

Fields

databaseHost :: Text
The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
databasePort :: Natural
The port that the database uses for connections.
databaseName :: Text
The name of the database containing the document data.
tableName :: Text
The name of the table that contains the document data.
secretArn :: Text
The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

Instances

Instances details

FromJSON ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration Methods parseJSON :: Value -> Parser ConnectionConfiguration # parseJSONList :: Value -> Parser [ConnectionConfiguration] #
ToJSON ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration Methods toJSON :: ConnectionConfiguration -> Value # toEncoding :: ConnectionConfiguration -> Encoding # toJSONList :: [ConnectionConfiguration] -> Value # toEncodingList :: [ConnectionConfiguration] -> Encoding #
Generic ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration Associated Types type Rep ConnectionConfiguration :: Type -> Type # Methods from :: ConnectionConfiguration -> Rep ConnectionConfiguration x # to :: Rep ConnectionConfiguration x -> ConnectionConfiguration #
Read ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration Methods readsPrec :: Int -> ReadS ConnectionConfiguration # readList :: ReadS [ConnectionConfiguration] # readPrec :: ReadPrec ConnectionConfiguration # readListPrec :: ReadPrec [ConnectionConfiguration] #
Show ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration Methods showsPrec :: Int -> ConnectionConfiguration -> ShowS # show :: ConnectionConfiguration -> String # showList :: [ConnectionConfiguration] -> ShowS #
NFData ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration Methods rnf :: ConnectionConfiguration -> () #
Eq ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration Methods (==) :: ConnectionConfiguration -> ConnectionConfiguration -> Bool # (/=) :: ConnectionConfiguration -> ConnectionConfiguration -> Bool #
Hashable ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration Methods hashWithSalt :: Int -> ConnectionConfiguration -> Int # hash :: ConnectionConfiguration -> Int #
type Rep ConnectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConnectionConfiguration type Rep ConnectionConfiguration = D1 ('MetaData "ConnectionConfiguration" "Amazonka.Kendra.Types.ConnectionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConnectionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "databaseHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "databasePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newConnectionConfiguration Source #

Arguments

:: Text	`$sel:databaseHost:ConnectionConfiguration'`
-> Natural	`$sel:databasePort:ConnectionConfiguration'`
-> Text	`$sel:databaseName:ConnectionConfiguration'`
-> Text	`$sel:tableName:ConnectionConfiguration'`
-> Text	`$sel:secretArn:ConnectionConfiguration'`
-> ConnectionConfiguration

Create a value of ConnectionConfiguration with all optional fields omitted.

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

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

$sel:databaseHost:ConnectionConfiguration', connectionConfiguration_databaseHost - The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

$sel:databasePort:ConnectionConfiguration', connectionConfiguration_databasePort - The port that the database uses for connections.

$sel:databaseName:ConnectionConfiguration', connectionConfiguration_databaseName - The name of the database containing the document data.

$sel:tableName:ConnectionConfiguration', connectionConfiguration_tableName - The name of the table that contains the document data.

$sel:secretArn:ConnectionConfiguration', connectionConfiguration_secretArn - The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

connectionConfiguration_databaseHost :: Lens' ConnectionConfiguration Text Source #

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

connectionConfiguration_databasePort :: Lens' ConnectionConfiguration Natural Source #

The port that the database uses for connections.

connectionConfiguration_databaseName :: Lens' ConnectionConfiguration Text Source #

The name of the database containing the document data.

connectionConfiguration_tableName :: Lens' ConnectionConfiguration Text Source #

The name of the table that contains the document data.

connectionConfiguration_secretArn :: Lens' ConnectionConfiguration Text Source #

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

ContentSourceConfiguration

data ContentSourceConfiguration Source #

Provides the configuration information for your content sources, such as data sources, FAQs, and content indexed directly via BatchPutDocument.

See: newContentSourceConfiguration smart constructor.

Constructors

ContentSourceConfiguration'
Fields dataSourceIds :: Maybe (NonEmpty Text) The identifier of the data sources you want to use for your Amazon Kendra experience. directPutContent :: Maybe Bool `TRUE` to use documents you indexed directly using the `BatchPutDocument` API. faqIds :: Maybe (NonEmpty Text) The identifier of the FAQs that you want to use for your Amazon Kendra experience.

Instances

Instances details

FromJSON ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration Methods parseJSON :: Value -> Parser ContentSourceConfiguration # parseJSONList :: Value -> Parser [ContentSourceConfiguration] #
ToJSON ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration Methods toJSON :: ContentSourceConfiguration -> Value # toEncoding :: ContentSourceConfiguration -> Encoding # toJSONList :: [ContentSourceConfiguration] -> Value # toEncodingList :: [ContentSourceConfiguration] -> Encoding #
Generic ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration Associated Types type Rep ContentSourceConfiguration :: Type -> Type # Methods from :: ContentSourceConfiguration -> Rep ContentSourceConfiguration x # to :: Rep ContentSourceConfiguration x -> ContentSourceConfiguration #
Read ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration Methods readsPrec :: Int -> ReadS ContentSourceConfiguration # readList :: ReadS [ContentSourceConfiguration] # readPrec :: ReadPrec ContentSourceConfiguration # readListPrec :: ReadPrec [ContentSourceConfiguration] #
Show ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration Methods showsPrec :: Int -> ContentSourceConfiguration -> ShowS # show :: ContentSourceConfiguration -> String # showList :: [ContentSourceConfiguration] -> ShowS #
NFData ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration Methods rnf :: ContentSourceConfiguration -> () #
Eq ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration Methods (==) :: ContentSourceConfiguration -> ContentSourceConfiguration -> Bool # (/=) :: ContentSourceConfiguration -> ContentSourceConfiguration -> Bool #
Hashable ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration Methods hashWithSalt :: Int -> ContentSourceConfiguration -> Int # hash :: ContentSourceConfiguration -> Int #
type Rep ContentSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ContentSourceConfiguration type Rep ContentSourceConfiguration = D1 ('MetaData "ContentSourceConfiguration" "Amazonka.Kendra.Types.ContentSourceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ContentSourceConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "directPutContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "faqIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))))

newContentSourceConfiguration :: ContentSourceConfiguration Source #

Create a value of ContentSourceConfiguration with all optional fields omitted.

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

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

$sel:dataSourceIds:ContentSourceConfiguration', contentSourceConfiguration_dataSourceIds - The identifier of the data sources you want to use for your Amazon Kendra experience.

$sel:directPutContent:ContentSourceConfiguration', contentSourceConfiguration_directPutContent - TRUE to use documents you indexed directly using the BatchPutDocument API.

$sel:faqIds:ContentSourceConfiguration', contentSourceConfiguration_faqIds - The identifier of the FAQs that you want to use for your Amazon Kendra experience.

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

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

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

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

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

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

Correction

data Correction Source #

A corrected misspelled word in a query.

See: newCorrection smart constructor.

Constructors

Correction'
Fields beginOffset :: Maybe Int The zero-based location in the response string or text where the corrected word starts. correctedTerm :: Maybe Text The string or text of a corrected misspelled word in a query. endOffset :: Maybe Int The zero-based location in the response string or text where the corrected word ends. term :: Maybe Text The string or text of a misspelled word in a query.

Instances

Instances details

FromJSON Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods parseJSON :: Value -> Parser Correction # parseJSONList :: Value -> Parser [Correction] #
Generic Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Associated Types type Rep Correction :: Type -> Type # Methods from :: Correction -> Rep Correction x # to :: Rep Correction x -> Correction #
Read Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods readsPrec :: Int -> ReadS Correction # readList :: ReadS [Correction] # readPrec :: ReadPrec Correction # readListPrec :: ReadPrec [Correction] #
Show Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods showsPrec :: Int -> Correction -> ShowS # show :: Correction -> String # showList :: [Correction] -> ShowS #
NFData Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods rnf :: Correction -> () #
Eq Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods (==) :: Correction -> Correction -> Bool # (/=) :: Correction -> Correction -> Bool #
Hashable Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction Methods hashWithSalt :: Int -> Correction -> Int # hash :: Correction -> Int #
type Rep Correction Source #
Instance details Defined in Amazonka.Kendra.Types.Correction type Rep Correction = D1 ('MetaData "Correction" "Amazonka.Kendra.Types.Correction" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Correction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "correctedTerm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "term") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCorrection :: Correction Source #

Create a value of Correction with all optional fields omitted.

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

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

$sel:beginOffset:Correction', correction_beginOffset - The zero-based location in the response string or text where the corrected word starts.

$sel:correctedTerm:Correction', correction_correctedTerm - The string or text of a corrected misspelled word in a query.

$sel:endOffset:Correction', correction_endOffset - The zero-based location in the response string or text where the corrected word ends.

$sel:term:Correction', correction_term - The string or text of a misspelled word in a query.

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

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

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

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

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

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

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

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

CustomDocumentEnrichmentConfiguration

data CustomDocumentEnrichmentConfiguration Source #

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Customizing document metadata during the ingestion process.

See: newCustomDocumentEnrichmentConfiguration smart constructor.

Constructors

CustomDocumentEnrichmentConfiguration'

Fields

inlineConfigurations :: Maybe [InlineCustomDocumentEnrichmentConfiguration]
Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
postExtractionHookConfiguration :: Maybe HookConfiguration
Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.
preExtractionHookConfiguration :: Maybe HookConfiguration
Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see IAM roles for Amazon Kendra.

Instances

Instances details

FromJSON CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods parseJSON :: Value -> Parser CustomDocumentEnrichmentConfiguration # parseJSONList :: Value -> Parser [CustomDocumentEnrichmentConfiguration] #
ToJSON CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods toJSON :: CustomDocumentEnrichmentConfiguration -> Value # toEncoding :: CustomDocumentEnrichmentConfiguration -> Encoding # toJSONList :: [CustomDocumentEnrichmentConfiguration] -> Value # toEncodingList :: [CustomDocumentEnrichmentConfiguration] -> Encoding #
Generic CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Associated Types type Rep CustomDocumentEnrichmentConfiguration :: Type -> Type # Methods from :: CustomDocumentEnrichmentConfiguration -> Rep CustomDocumentEnrichmentConfiguration x # to :: Rep CustomDocumentEnrichmentConfiguration x -> CustomDocumentEnrichmentConfiguration #
Read CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods readsPrec :: Int -> ReadS CustomDocumentEnrichmentConfiguration # readList :: ReadS [CustomDocumentEnrichmentConfiguration] # readPrec :: ReadPrec CustomDocumentEnrichmentConfiguration # readListPrec :: ReadPrec [CustomDocumentEnrichmentConfiguration] #
Show CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods showsPrec :: Int -> CustomDocumentEnrichmentConfiguration -> ShowS # show :: CustomDocumentEnrichmentConfiguration -> String # showList :: [CustomDocumentEnrichmentConfiguration] -> ShowS #
NFData CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods rnf :: CustomDocumentEnrichmentConfiguration -> () #
Eq CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods (==) :: CustomDocumentEnrichmentConfiguration -> CustomDocumentEnrichmentConfiguration -> Bool # (/=) :: CustomDocumentEnrichmentConfiguration -> CustomDocumentEnrichmentConfiguration -> Bool #
Hashable CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods hashWithSalt :: Int -> CustomDocumentEnrichmentConfiguration -> Int # hash :: CustomDocumentEnrichmentConfiguration -> Int #
type Rep CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration type Rep CustomDocumentEnrichmentConfiguration = D1 ('MetaData "CustomDocumentEnrichmentConfiguration" "Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CustomDocumentEnrichmentConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "inlineConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InlineCustomDocumentEnrichmentConfiguration])) :: S1 ('MetaSel ('Just "postExtractionHookConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookConfiguration))) :: (S1 ('MetaSel ('Just "preExtractionHookConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookConfiguration)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCustomDocumentEnrichmentConfiguration :: CustomDocumentEnrichmentConfiguration Source #

Create a value of CustomDocumentEnrichmentConfiguration with all optional fields omitted.

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

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

$sel:inlineConfigurations:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_inlineConfigurations - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

$sel:postExtractionHookConfiguration:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_postExtractionHookConfiguration - Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

$sel:preExtractionHookConfiguration:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_preExtractionHookConfiguration - Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

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

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

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

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

Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

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

Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

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

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

DataSourceConfiguration

data DataSourceConfiguration Source #

Provides the configuration information for an Amazon Kendra data source.

See: newDataSourceConfiguration smart constructor.

Constructors

DataSourceConfiguration'

Fields

alfrescoConfiguration :: Maybe AlfrescoConfiguration
Provides the configuration information to connect to Alfresco as your data source.
boxConfiguration :: Maybe BoxConfiguration
Provides the configuration information to connect to Box as your data source.
confluenceConfiguration :: Maybe ConfluenceConfiguration
Provides the configuration information to connect to Confluence as your data source.
databaseConfiguration :: Maybe DatabaseConfiguration
Provides the configuration information to connect to a database as your data source.
fsxConfiguration :: Maybe FsxConfiguration
Provides the configuration information to connect to Amazon FSx as your data source.
gitHubConfiguration :: Maybe GitHubConfiguration
Provides the configuration information to connect to GitHub as your data source.
googleDriveConfiguration :: Maybe GoogleDriveConfiguration
Provides the configuration information to connect to Google Drive as your data source.
jiraConfiguration :: Maybe JiraConfiguration
Provides the configuration information to connect to Jira as your data source.
oneDriveConfiguration :: Maybe OneDriveConfiguration
Provides the configuration information to connect to Microsoft OneDrive as your data source.
quipConfiguration :: Maybe QuipConfiguration
Provides the configuration information to connect to Quip as your data source.
s3Configuration :: Maybe S3DataSourceConfiguration
Provides the configuration information to connect to an Amazon S3 bucket as your data source.
salesforceConfiguration :: Maybe SalesforceConfiguration
Provides the configuration information to connect to Salesforce as your data source.
serviceNowConfiguration :: Maybe ServiceNowConfiguration
Provides the configuration information to connect to ServiceNow as your data source.
sharePointConfiguration :: Maybe SharePointConfiguration
Provides the configuration information to connect to Microsoft SharePoint as your data source.
slackConfiguration :: Maybe SlackConfiguration
Provides the configuration information to connect to Slack as your data source.
templateConfiguration :: Maybe TemplateConfiguration
Provides a template for the configuration information to connect to your data source.
webCrawlerConfiguration :: Maybe WebCrawlerConfiguration
workDocsConfiguration :: Maybe WorkDocsConfiguration
Provides the configuration information to connect to Amazon WorkDocs as your data source.

Instances

Instances details

FromJSON DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration Methods parseJSON :: Value -> Parser DataSourceConfiguration # parseJSONList :: Value -> Parser [DataSourceConfiguration] #
ToJSON DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration Methods toJSON :: DataSourceConfiguration -> Value # toEncoding :: DataSourceConfiguration -> Encoding # toJSONList :: [DataSourceConfiguration] -> Value # toEncodingList :: [DataSourceConfiguration] -> Encoding #
Generic DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration Associated Types type Rep DataSourceConfiguration :: Type -> Type # Methods from :: DataSourceConfiguration -> Rep DataSourceConfiguration x # to :: Rep DataSourceConfiguration x -> DataSourceConfiguration #
Read DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration Methods readsPrec :: Int -> ReadS DataSourceConfiguration # readList :: ReadS [DataSourceConfiguration] # readPrec :: ReadPrec DataSourceConfiguration # readListPrec :: ReadPrec [DataSourceConfiguration] #
Show DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration Methods showsPrec :: Int -> DataSourceConfiguration -> ShowS # show :: DataSourceConfiguration -> String # showList :: [DataSourceConfiguration] -> ShowS #
NFData DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration Methods rnf :: DataSourceConfiguration -> () #
Eq DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration Methods (==) :: DataSourceConfiguration -> DataSourceConfiguration -> Bool # (/=) :: DataSourceConfiguration -> DataSourceConfiguration -> Bool #
Hashable DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration Methods hashWithSalt :: Int -> DataSourceConfiguration -> Int # hash :: DataSourceConfiguration -> Int #
type Rep DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceConfiguration type Rep DataSourceConfiguration = D1 ('MetaData "DataSourceConfiguration" "Amazonka.Kendra.Types.DataSourceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceConfiguration'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alfrescoConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlfrescoConfiguration)) :: S1 ('MetaSel ('Just "boxConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BoxConfiguration))) :: (S1 ('MetaSel ('Just "confluenceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceConfiguration)) :: S1 ('MetaSel ('Just "databaseConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatabaseConfiguration)))) :: ((S1 ('MetaSel ('Just "fsxConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FsxConfiguration)) :: S1 ('MetaSel ('Just "gitHubConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GitHubConfiguration))) :: (S1 ('MetaSel ('Just "googleDriveConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GoogleDriveConfiguration)) :: (S1 ('MetaSel ('Just "jiraConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JiraConfiguration)) :: S1 ('MetaSel ('Just "oneDriveConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OneDriveConfiguration)))))) :: (((S1 ('MetaSel ('Just "quipConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuipConfiguration)) :: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DataSourceConfiguration))) :: (S1 ('MetaSel ('Just "salesforceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceConfiguration)) :: S1 ('MetaSel ('Just "serviceNowConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowConfiguration)))) :: ((S1 ('MetaSel ('Just "sharePointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SharePointConfiguration)) :: S1 ('MetaSel ('Just "slackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlackConfiguration))) :: (S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)) :: (S1 ('MetaSel ('Just "webCrawlerConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebCrawlerConfiguration)) :*: S1 ('MetaSel ('Just "workDocsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkDocsConfiguration))))))))

newDataSourceConfiguration :: DataSourceConfiguration Source #

Create a value of DataSourceConfiguration with all optional fields omitted.

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

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

$sel:alfrescoConfiguration:DataSourceConfiguration', dataSourceConfiguration_alfrescoConfiguration - Provides the configuration information to connect to Alfresco as your data source.

$sel:boxConfiguration:DataSourceConfiguration', dataSourceConfiguration_boxConfiguration - Provides the configuration information to connect to Box as your data source.

$sel:confluenceConfiguration:DataSourceConfiguration', dataSourceConfiguration_confluenceConfiguration - Provides the configuration information to connect to Confluence as your data source.

$sel:databaseConfiguration:DataSourceConfiguration', dataSourceConfiguration_databaseConfiguration - Provides the configuration information to connect to a database as your data source.

$sel:fsxConfiguration:DataSourceConfiguration', dataSourceConfiguration_fsxConfiguration - Provides the configuration information to connect to Amazon FSx as your data source.

$sel:gitHubConfiguration:DataSourceConfiguration', dataSourceConfiguration_gitHubConfiguration - Provides the configuration information to connect to GitHub as your data source.

$sel:googleDriveConfiguration:DataSourceConfiguration', dataSourceConfiguration_googleDriveConfiguration - Provides the configuration information to connect to Google Drive as your data source.

$sel:jiraConfiguration:DataSourceConfiguration', dataSourceConfiguration_jiraConfiguration - Provides the configuration information to connect to Jira as your data source.

$sel:oneDriveConfiguration:DataSourceConfiguration', dataSourceConfiguration_oneDriveConfiguration - Provides the configuration information to connect to Microsoft OneDrive as your data source.

$sel:quipConfiguration:DataSourceConfiguration', dataSourceConfiguration_quipConfiguration - Provides the configuration information to connect to Quip as your data source.

$sel:s3Configuration:DataSourceConfiguration', dataSourceConfiguration_s3Configuration - Provides the configuration information to connect to an Amazon S3 bucket as your data source.

$sel:salesforceConfiguration:DataSourceConfiguration', dataSourceConfiguration_salesforceConfiguration - Provides the configuration information to connect to Salesforce as your data source.

$sel:serviceNowConfiguration:DataSourceConfiguration', dataSourceConfiguration_serviceNowConfiguration - Provides the configuration information to connect to ServiceNow as your data source.

$sel:sharePointConfiguration:DataSourceConfiguration', dataSourceConfiguration_sharePointConfiguration - Provides the configuration information to connect to Microsoft SharePoint as your data source.

$sel:slackConfiguration:DataSourceConfiguration', dataSourceConfiguration_slackConfiguration - Provides the configuration information to connect to Slack as your data source.

$sel:templateConfiguration:DataSourceConfiguration', dataSourceConfiguration_templateConfiguration - Provides a template for the configuration information to connect to your data source.

$sel:webCrawlerConfiguration:DataSourceConfiguration', dataSourceConfiguration_webCrawlerConfiguration - Undocumented member.

$sel:workDocsConfiguration:DataSourceConfiguration', dataSourceConfiguration_workDocsConfiguration - Provides the configuration information to connect to Amazon WorkDocs as your data source.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Undocumented member.

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

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

DataSourceGroup

data DataSourceGroup Source #

Data source information for user context filtering.

See: newDataSourceGroup smart constructor.

Constructors

DataSourceGroup'
Fields groupId :: Text The identifier of the group you want to add to your list of groups. This is for filtering search results based on the groups' access to documents. dataSourceId :: Text The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups' access to documents in that data source.

Instances

Instances details

ToJSON DataSourceGroup Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceGroup Methods toJSON :: DataSourceGroup -> Value # toEncoding :: DataSourceGroup -> Encoding # toJSONList :: [DataSourceGroup] -> Value # toEncodingList :: [DataSourceGroup] -> Encoding #
Generic DataSourceGroup Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceGroup Associated Types type Rep DataSourceGroup :: Type -> Type # Methods from :: DataSourceGroup -> Rep DataSourceGroup x # to :: Rep DataSourceGroup x -> DataSourceGroup #
Read DataSourceGroup Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceGroup Methods readsPrec :: Int -> ReadS DataSourceGroup # readList :: ReadS [DataSourceGroup] # readPrec :: ReadPrec DataSourceGroup # readListPrec :: ReadPrec [DataSourceGroup] #
Show DataSourceGroup Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceGroup Methods showsPrec :: Int -> DataSourceGroup -> ShowS # show :: DataSourceGroup -> String # showList :: [DataSourceGroup] -> ShowS #
NFData DataSourceGroup Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceGroup Methods rnf :: DataSourceGroup -> () #
Eq DataSourceGroup Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceGroup Methods (==) :: DataSourceGroup -> DataSourceGroup -> Bool # (/=) :: DataSourceGroup -> DataSourceGroup -> Bool #
Hashable DataSourceGroup Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceGroup Methods hashWithSalt :: Int -> DataSourceGroup -> Int # hash :: DataSourceGroup -> Int #
type Rep DataSourceGroup Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceGroup type Rep DataSourceGroup = D1 ('MetaData "DataSourceGroup" "Amazonka.Kendra.Types.DataSourceGroup" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDataSourceGroup Source #

Arguments

:: Text	`$sel:groupId:DataSourceGroup'`
-> Text	`$sel:dataSourceId:DataSourceGroup'`
-> DataSourceGroup

Create a value of DataSourceGroup with all optional fields omitted.

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

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

$sel:groupId:DataSourceGroup', dataSourceGroup_groupId - The identifier of the group you want to add to your list of groups. This is for filtering search results based on the groups' access to documents.

$sel:dataSourceId:DataSourceGroup', dataSourceGroup_dataSourceId - The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups' access to documents in that data source.

dataSourceGroup_groupId :: Lens' DataSourceGroup Text Source #

The identifier of the group you want to add to your list of groups. This is for filtering search results based on the groups' access to documents.

dataSourceGroup_dataSourceId :: Lens' DataSourceGroup Text Source #

The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups' access to documents in that data source.

DataSourceSummary

data DataSourceSummary Source #

Summary information for a Amazon Kendra data source.

See: newDataSourceSummary smart constructor.

Constructors

DataSourceSummary'

Fields

createdAt :: Maybe POSIX
The UNIX datetime that the data source was created.
id :: Maybe Text
The identifier for the data source.
languageCode :: Maybe Text
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.
name :: Maybe Text
The name of the data source.
status :: Maybe DataSourceStatus
The status of the data source. When the status is ACTIVE the data source is ready to use.
type' :: Maybe DataSourceType
The type of the data source.
updatedAt :: Maybe POSIX
The UNIX datetime that the data source was lasted updated.

Instances

Instances details

FromJSON DataSourceSummary Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSummary Methods parseJSON :: Value -> Parser DataSourceSummary # parseJSONList :: Value -> Parser [DataSourceSummary] #
Generic DataSourceSummary Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSummary Associated Types type Rep DataSourceSummary :: Type -> Type # Methods from :: DataSourceSummary -> Rep DataSourceSummary x # to :: Rep DataSourceSummary x -> DataSourceSummary #
Read DataSourceSummary Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSummary Methods readsPrec :: Int -> ReadS DataSourceSummary # readList :: ReadS [DataSourceSummary] # readPrec :: ReadPrec DataSourceSummary # readListPrec :: ReadPrec [DataSourceSummary] #
Show DataSourceSummary Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSummary Methods showsPrec :: Int -> DataSourceSummary -> ShowS # show :: DataSourceSummary -> String # showList :: [DataSourceSummary] -> ShowS #
NFData DataSourceSummary Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSummary Methods rnf :: DataSourceSummary -> () #
Eq DataSourceSummary Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSummary Methods (==) :: DataSourceSummary -> DataSourceSummary -> Bool # (/=) :: DataSourceSummary -> DataSourceSummary -> Bool #
Hashable DataSourceSummary Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSummary Methods hashWithSalt :: Int -> DataSourceSummary -> Int # hash :: DataSourceSummary -> Int #
type Rep DataSourceSummary Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSummary type Rep DataSourceSummary = D1 ('MetaData "DataSourceSummary" "Amazonka.Kendra.Types.DataSourceSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceStatus))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceType)) :: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newDataSourceSummary :: DataSourceSummary Source #

Create a value of DataSourceSummary with all optional fields omitted.

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

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

$sel:createdAt:DataSourceSummary', dataSourceSummary_createdAt - The UNIX datetime that the data source was created.

$sel:id:DataSourceSummary', dataSourceSummary_id - The identifier for the data source.

$sel:languageCode:DataSourceSummary', dataSourceSummary_languageCode - The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

$sel:name:DataSourceSummary', dataSourceSummary_name - The name of the data source.

$sel:status:DataSourceSummary', dataSourceSummary_status - The status of the data source. When the status is ACTIVE the data source is ready to use.

$sel:type':DataSourceSummary', dataSourceSummary_type - The type of the data source.

$sel:updatedAt:DataSourceSummary', dataSourceSummary_updatedAt - The UNIX datetime that the data source was lasted updated.

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

The UNIX datetime that the data source was created.

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

The identifier for the data source.

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

The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

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

The name of the data source.

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

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

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

The type of the data source.

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

The UNIX datetime that the data source was lasted updated.

DataSourceSyncJob

data DataSourceSyncJob Source #

Provides information about a data source synchronization job.

See: newDataSourceSyncJob smart constructor.

Constructors

DataSourceSyncJob'

Fields

dataSourceErrorCode :: Maybe Text
If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
endTime :: Maybe POSIX
The UNIX datetime that the synchronization job completed.
errorCode :: Maybe ErrorCode
If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
errorMessage :: Maybe Text
If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
executionId :: Maybe Text
A identifier for the synchronization job.
metrics :: Maybe DataSourceSyncJobMetrics
Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
startTime :: Maybe POSIX
The UNIX datetime that the synchronization job started.
status :: Maybe DataSourceSyncJobStatus
The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

Instances

Instances details

FromJSON DataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJob Methods parseJSON :: Value -> Parser DataSourceSyncJob # parseJSONList :: Value -> Parser [DataSourceSyncJob] #
Generic DataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJob Associated Types type Rep DataSourceSyncJob :: Type -> Type # Methods from :: DataSourceSyncJob -> Rep DataSourceSyncJob x # to :: Rep DataSourceSyncJob x -> DataSourceSyncJob #
Read DataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJob Methods readsPrec :: Int -> ReadS DataSourceSyncJob # readList :: ReadS [DataSourceSyncJob] # readPrec :: ReadPrec DataSourceSyncJob # readListPrec :: ReadPrec [DataSourceSyncJob] #
Show DataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJob Methods showsPrec :: Int -> DataSourceSyncJob -> ShowS # show :: DataSourceSyncJob -> String # showList :: [DataSourceSyncJob] -> ShowS #
NFData DataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJob Methods rnf :: DataSourceSyncJob -> () #
Eq DataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJob Methods (==) :: DataSourceSyncJob -> DataSourceSyncJob -> Bool # (/=) :: DataSourceSyncJob -> DataSourceSyncJob -> Bool #
Hashable DataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJob Methods hashWithSalt :: Int -> DataSourceSyncJob -> Int # hash :: DataSourceSyncJob -> Int #
type Rep DataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJob type Rep DataSourceSyncJob = D1 ('MetaData "DataSourceSyncJob" "Amazonka.Kendra.Types.DataSourceSyncJob" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceSyncJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataSourceErrorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceSyncJobMetrics))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceSyncJobStatus))))))

newDataSourceSyncJob :: DataSourceSyncJob Source #

Create a value of DataSourceSyncJob with all optional fields omitted.

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

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

$sel:dataSourceErrorCode:DataSourceSyncJob', dataSourceSyncJob_dataSourceErrorCode - If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

$sel:endTime:DataSourceSyncJob', dataSourceSyncJob_endTime - The UNIX datetime that the synchronization job completed.

$sel:errorCode:DataSourceSyncJob', dataSourceSyncJob_errorCode - If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

$sel:errorMessage:DataSourceSyncJob', dataSourceSyncJob_errorMessage - If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

$sel:executionId:DataSourceSyncJob', dataSourceSyncJob_executionId - A identifier for the synchronization job.

$sel:metrics:DataSourceSyncJob', dataSourceSyncJob_metrics - Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

$sel:startTime:DataSourceSyncJob', dataSourceSyncJob_startTime - The UNIX datetime that the synchronization job started.

$sel:status:DataSourceSyncJob', dataSourceSyncJob_status - The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

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

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

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

The UNIX datetime that the synchronization job completed.

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

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

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

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

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

A identifier for the synchronization job.

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

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

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

The UNIX datetime that the synchronization job started.

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

The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

DataSourceSyncJobMetricTarget

data DataSourceSyncJobMetricTarget Source #

Maps a particular data source sync job to a particular data source.

See: newDataSourceSyncJobMetricTarget smart constructor.

Constructors

DataSourceSyncJobMetricTarget'

Fields

dataSourceSyncJobId :: Maybe Text
The ID of the sync job that is running on the data source.
If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job.
If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.
dataSourceId :: Text
The ID of the data source that is running the sync job.

Instances

Instances details

ToJSON DataSourceSyncJobMetricTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget Methods toJSON :: DataSourceSyncJobMetricTarget -> Value # toEncoding :: DataSourceSyncJobMetricTarget -> Encoding # toJSONList :: [DataSourceSyncJobMetricTarget] -> Value # toEncodingList :: [DataSourceSyncJobMetricTarget] -> Encoding #
Generic DataSourceSyncJobMetricTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget Associated Types type Rep DataSourceSyncJobMetricTarget :: Type -> Type # Methods from :: DataSourceSyncJobMetricTarget -> Rep DataSourceSyncJobMetricTarget x # to :: Rep DataSourceSyncJobMetricTarget x -> DataSourceSyncJobMetricTarget #
Read DataSourceSyncJobMetricTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget Methods readsPrec :: Int -> ReadS DataSourceSyncJobMetricTarget # readList :: ReadS [DataSourceSyncJobMetricTarget] # readPrec :: ReadPrec DataSourceSyncJobMetricTarget # readListPrec :: ReadPrec [DataSourceSyncJobMetricTarget] #
Show DataSourceSyncJobMetricTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget Methods showsPrec :: Int -> DataSourceSyncJobMetricTarget -> ShowS # show :: DataSourceSyncJobMetricTarget -> String # showList :: [DataSourceSyncJobMetricTarget] -> ShowS #
NFData DataSourceSyncJobMetricTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget Methods rnf :: DataSourceSyncJobMetricTarget -> () #
Eq DataSourceSyncJobMetricTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget Methods (==) :: DataSourceSyncJobMetricTarget -> DataSourceSyncJobMetricTarget -> Bool # (/=) :: DataSourceSyncJobMetricTarget -> DataSourceSyncJobMetricTarget -> Bool #
Hashable DataSourceSyncJobMetricTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget Methods hashWithSalt :: Int -> DataSourceSyncJobMetricTarget -> Int # hash :: DataSourceSyncJobMetricTarget -> Int #
type Rep DataSourceSyncJobMetricTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget type Rep DataSourceSyncJobMetricTarget = D1 ('MetaData "DataSourceSyncJobMetricTarget" "Amazonka.Kendra.Types.DataSourceSyncJobMetricTarget" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceSyncJobMetricTarget'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceSyncJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDataSourceSyncJobMetricTarget Source #

Arguments

:: Text	`$sel:dataSourceId:DataSourceSyncJobMetricTarget'`
-> DataSourceSyncJobMetricTarget

Create a value of DataSourceSyncJobMetricTarget with all optional fields omitted.

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

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

$sel:dataSourceSyncJobId:DataSourceSyncJobMetricTarget', dataSourceSyncJobMetricTarget_dataSourceSyncJobId - The ID of the sync job that is running on the data source.

If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job.

If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.

$sel:dataSourceId:DataSourceSyncJobMetricTarget', dataSourceSyncJobMetricTarget_dataSourceId - The ID of the data source that is running the sync job.

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

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

If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job.

If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.

dataSourceSyncJobMetricTarget_dataSourceId :: Lens' DataSourceSyncJobMetricTarget Text Source #

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

DataSourceSyncJobMetrics

data DataSourceSyncJobMetrics Source #

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

See: newDataSourceSyncJobMetrics smart constructor.

Constructors

DataSourceSyncJobMetrics'

Fields

documentsAdded :: Maybe Text
The number of documents added from the data source up to now in the data source sync.
documentsDeleted :: Maybe Text
The number of documents deleted from the data source up to now in the data source sync run.
documentsFailed :: Maybe Text
The number of documents that failed to sync from the data source up to now in the data source sync run.
documentsModified :: Maybe Text
The number of documents modified in the data source up to now in the data source sync run.
documentsScanned :: Maybe Text
The current number of documents crawled by the current sync job in the data source.

Instances

Instances details

FromJSON DataSourceSyncJobMetrics Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics Methods parseJSON :: Value -> Parser DataSourceSyncJobMetrics # parseJSONList :: Value -> Parser [DataSourceSyncJobMetrics] #
Generic DataSourceSyncJobMetrics Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics Associated Types type Rep DataSourceSyncJobMetrics :: Type -> Type # Methods from :: DataSourceSyncJobMetrics -> Rep DataSourceSyncJobMetrics x # to :: Rep DataSourceSyncJobMetrics x -> DataSourceSyncJobMetrics #
Read DataSourceSyncJobMetrics Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics Methods readsPrec :: Int -> ReadS DataSourceSyncJobMetrics # readList :: ReadS [DataSourceSyncJobMetrics] # readPrec :: ReadPrec DataSourceSyncJobMetrics # readListPrec :: ReadPrec [DataSourceSyncJobMetrics] #
Show DataSourceSyncJobMetrics Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics Methods showsPrec :: Int -> DataSourceSyncJobMetrics -> ShowS # show :: DataSourceSyncJobMetrics -> String # showList :: [DataSourceSyncJobMetrics] -> ShowS #
NFData DataSourceSyncJobMetrics Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics Methods rnf :: DataSourceSyncJobMetrics -> () #
Eq DataSourceSyncJobMetrics Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics Methods (==) :: DataSourceSyncJobMetrics -> DataSourceSyncJobMetrics -> Bool # (/=) :: DataSourceSyncJobMetrics -> DataSourceSyncJobMetrics -> Bool #
Hashable DataSourceSyncJobMetrics Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics Methods hashWithSalt :: Int -> DataSourceSyncJobMetrics -> Int # hash :: DataSourceSyncJobMetrics -> Int #
type Rep DataSourceSyncJobMetrics Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceSyncJobMetrics type Rep DataSourceSyncJobMetrics = D1 ('MetaData "DataSourceSyncJobMetrics" "Amazonka.Kendra.Types.DataSourceSyncJobMetrics" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceSyncJobMetrics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentsAdded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentsDeleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "documentsFailed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentsModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentsScanned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDataSourceSyncJobMetrics :: DataSourceSyncJobMetrics Source #

Create a value of DataSourceSyncJobMetrics with all optional fields omitted.

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

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

$sel:documentsAdded:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsAdded - The number of documents added from the data source up to now in the data source sync.

$sel:documentsDeleted:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsDeleted - The number of documents deleted from the data source up to now in the data source sync run.

$sel:documentsFailed:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsFailed - The number of documents that failed to sync from the data source up to now in the data source sync run.

$sel:documentsModified:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsModified - The number of documents modified in the data source up to now in the data source sync run.

$sel:documentsScanned:DataSourceSyncJobMetrics', dataSourceSyncJobMetrics_documentsScanned - The current number of documents crawled by the current sync job in the data source.

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

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

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

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

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

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

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

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

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

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

DataSourceToIndexFieldMapping

data DataSourceToIndexFieldMapping Source #

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex API.

See: newDataSourceToIndexFieldMapping smart constructor.

Constructors

DataSourceToIndexFieldMapping'
Fields dateFieldFormat :: Maybe Text The type of data stored in the column or attribute. dataSourceFieldName :: Text The name of the column or attribute in the data source. indexFieldName :: Text The name of the field in the index.

Instances

Instances details

FromJSON DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping Methods parseJSON :: Value -> Parser DataSourceToIndexFieldMapping # parseJSONList :: Value -> Parser [DataSourceToIndexFieldMapping] #
ToJSON DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping Methods toJSON :: DataSourceToIndexFieldMapping -> Value # toEncoding :: DataSourceToIndexFieldMapping -> Encoding # toJSONList :: [DataSourceToIndexFieldMapping] -> Value # toEncodingList :: [DataSourceToIndexFieldMapping] -> Encoding #
Generic DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping Associated Types type Rep DataSourceToIndexFieldMapping :: Type -> Type # Methods from :: DataSourceToIndexFieldMapping -> Rep DataSourceToIndexFieldMapping x # to :: Rep DataSourceToIndexFieldMapping x -> DataSourceToIndexFieldMapping #
Read DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping Methods readsPrec :: Int -> ReadS DataSourceToIndexFieldMapping # readList :: ReadS [DataSourceToIndexFieldMapping] # readPrec :: ReadPrec DataSourceToIndexFieldMapping # readListPrec :: ReadPrec [DataSourceToIndexFieldMapping] #
Show DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping Methods showsPrec :: Int -> DataSourceToIndexFieldMapping -> ShowS # show :: DataSourceToIndexFieldMapping -> String # showList :: [DataSourceToIndexFieldMapping] -> ShowS #
NFData DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping Methods rnf :: DataSourceToIndexFieldMapping -> () #
Eq DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping Methods (==) :: DataSourceToIndexFieldMapping -> DataSourceToIndexFieldMapping -> Bool # (/=) :: DataSourceToIndexFieldMapping -> DataSourceToIndexFieldMapping -> Bool #
Hashable DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping Methods hashWithSalt :: Int -> DataSourceToIndexFieldMapping -> Int # hash :: DataSourceToIndexFieldMapping -> Int #
type Rep DataSourceToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceToIndexFieldMapping type Rep DataSourceToIndexFieldMapping = D1 ('MetaData "DataSourceToIndexFieldMapping" "Amazonka.Kendra.Types.DataSourceToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDataSourceToIndexFieldMapping Source #

Arguments

:: Text	`$sel:dataSourceFieldName:DataSourceToIndexFieldMapping'`
-> Text	`$sel:indexFieldName:DataSourceToIndexFieldMapping'`
-> DataSourceToIndexFieldMapping

Create a value of DataSourceToIndexFieldMapping with all optional fields omitted.

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

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

$sel:dateFieldFormat:DataSourceToIndexFieldMapping', dataSourceToIndexFieldMapping_dateFieldFormat - The type of data stored in the column or attribute.

$sel:dataSourceFieldName:DataSourceToIndexFieldMapping', dataSourceToIndexFieldMapping_dataSourceFieldName - The name of the column or attribute in the data source.

$sel:indexFieldName:DataSourceToIndexFieldMapping', dataSourceToIndexFieldMapping_indexFieldName - The name of the field in the index.

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

The type of data stored in the column or attribute.

dataSourceToIndexFieldMapping_dataSourceFieldName :: Lens' DataSourceToIndexFieldMapping Text Source #

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

dataSourceToIndexFieldMapping_indexFieldName :: Lens' DataSourceToIndexFieldMapping Text Source #

The name of the field in the index.

DataSourceVpcConfiguration

data DataSourceVpcConfiguration Source #

Provides the configuration information to connect to an Amazon VPC.

See: newDataSourceVpcConfiguration smart constructor.

Constructors

DataSourceVpcConfiguration'

Fields

subnetIds :: NonEmpty Text
A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
securityGroupIds :: NonEmpty Text
A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

Instances

Instances details

FromJSON DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration Methods parseJSON :: Value -> Parser DataSourceVpcConfiguration # parseJSONList :: Value -> Parser [DataSourceVpcConfiguration] #
ToJSON DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration Methods toJSON :: DataSourceVpcConfiguration -> Value # toEncoding :: DataSourceVpcConfiguration -> Encoding # toJSONList :: [DataSourceVpcConfiguration] -> Value # toEncodingList :: [DataSourceVpcConfiguration] -> Encoding #
Generic DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration Associated Types type Rep DataSourceVpcConfiguration :: Type -> Type # Methods from :: DataSourceVpcConfiguration -> Rep DataSourceVpcConfiguration x # to :: Rep DataSourceVpcConfiguration x -> DataSourceVpcConfiguration #
Read DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration Methods readsPrec :: Int -> ReadS DataSourceVpcConfiguration # readList :: ReadS [DataSourceVpcConfiguration] # readPrec :: ReadPrec DataSourceVpcConfiguration # readListPrec :: ReadPrec [DataSourceVpcConfiguration] #
Show DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration Methods showsPrec :: Int -> DataSourceVpcConfiguration -> ShowS # show :: DataSourceVpcConfiguration -> String # showList :: [DataSourceVpcConfiguration] -> ShowS #
NFData DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration Methods rnf :: DataSourceVpcConfiguration -> () #
Eq DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration Methods (==) :: DataSourceVpcConfiguration -> DataSourceVpcConfiguration -> Bool # (/=) :: DataSourceVpcConfiguration -> DataSourceVpcConfiguration -> Bool #
Hashable DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration Methods hashWithSalt :: Int -> DataSourceVpcConfiguration -> Int # hash :: DataSourceVpcConfiguration -> Int #
type Rep DataSourceVpcConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DataSourceVpcConfiguration type Rep DataSourceVpcConfiguration = D1 ('MetaData "DataSourceVpcConfiguration" "Amazonka.Kendra.Types.DataSourceVpcConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DataSourceVpcConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newDataSourceVpcConfiguration Source #

Arguments

:: NonEmpty Text	`$sel:subnetIds:DataSourceVpcConfiguration'`
-> NonEmpty Text	`$sel:securityGroupIds:DataSourceVpcConfiguration'`
-> DataSourceVpcConfiguration

Create a value of DataSourceVpcConfiguration with all optional fields omitted.

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

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

$sel:subnetIds:DataSourceVpcConfiguration', dataSourceVpcConfiguration_subnetIds - A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

$sel:securityGroupIds:DataSourceVpcConfiguration', dataSourceVpcConfiguration_securityGroupIds - A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.

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

A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

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

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

DatabaseConfiguration

data DatabaseConfiguration Source #

Provides the configuration information to connect to a index.

See: newDatabaseConfiguration smart constructor.

Constructors

DatabaseConfiguration'

Fields

aclConfiguration :: Maybe AclConfiguration
Information about the database column that provides information for user context filtering.
sqlConfiguration :: Maybe SqlConfiguration
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
databaseEngineType :: DatabaseEngineType
The type of database engine that runs the database.
connectionConfiguration :: ConnectionConfiguration
Configuration information that's required to connect to a database.
columnConfiguration :: ColumnConfiguration
Information about where the index should get the document information from the database.

Instances

Instances details

FromJSON DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration Methods parseJSON :: Value -> Parser DatabaseConfiguration # parseJSONList :: Value -> Parser [DatabaseConfiguration] #
ToJSON DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration Methods toJSON :: DatabaseConfiguration -> Value # toEncoding :: DatabaseConfiguration -> Encoding # toJSONList :: [DatabaseConfiguration] -> Value # toEncodingList :: [DatabaseConfiguration] -> Encoding #
Generic DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration Associated Types type Rep DatabaseConfiguration :: Type -> Type # Methods from :: DatabaseConfiguration -> Rep DatabaseConfiguration x # to :: Rep DatabaseConfiguration x -> DatabaseConfiguration #
Read DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration Methods readsPrec :: Int -> ReadS DatabaseConfiguration # readList :: ReadS [DatabaseConfiguration] # readPrec :: ReadPrec DatabaseConfiguration # readListPrec :: ReadPrec [DatabaseConfiguration] #
Show DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration Methods showsPrec :: Int -> DatabaseConfiguration -> ShowS # show :: DatabaseConfiguration -> String # showList :: [DatabaseConfiguration] -> ShowS #
NFData DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration Methods rnf :: DatabaseConfiguration -> () #
Eq DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration Methods (==) :: DatabaseConfiguration -> DatabaseConfiguration -> Bool # (/=) :: DatabaseConfiguration -> DatabaseConfiguration -> Bool #
Hashable DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration Methods hashWithSalt :: Int -> DatabaseConfiguration -> Int # hash :: DatabaseConfiguration -> Int #
type Rep DatabaseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DatabaseConfiguration type Rep DatabaseConfiguration = D1 ('MetaData "DatabaseConfiguration" "Amazonka.Kendra.Types.DatabaseConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DatabaseConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aclConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AclConfiguration)) :: (S1 ('MetaSel ('Just "sqlConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SqlConfiguration)) :: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :: (S1 ('MetaSel ('Just "databaseEngineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DatabaseEngineType) :: (S1 ('MetaSel ('Just "connectionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConnectionConfiguration) :*: S1 ('MetaSel ('Just "columnConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ColumnConfiguration)))))

newDatabaseConfiguration Source #

Arguments

:: DatabaseEngineType	`$sel:databaseEngineType:DatabaseConfiguration'`
-> ConnectionConfiguration	`$sel:connectionConfiguration:DatabaseConfiguration'`
-> ColumnConfiguration	`$sel:columnConfiguration:DatabaseConfiguration'`
-> DatabaseConfiguration

Create a value of DatabaseConfiguration with all optional fields omitted.

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

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

$sel:aclConfiguration:DatabaseConfiguration', databaseConfiguration_aclConfiguration - Information about the database column that provides information for user context filtering.

$sel:sqlConfiguration:DatabaseConfiguration', databaseConfiguration_sqlConfiguration - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

$sel:vpcConfiguration:DatabaseConfiguration', databaseConfiguration_vpcConfiguration - Undocumented member.

$sel:databaseEngineType:DatabaseConfiguration', databaseConfiguration_databaseEngineType - The type of database engine that runs the database.

$sel:connectionConfiguration:DatabaseConfiguration', databaseConfiguration_connectionConfiguration - Configuration information that's required to connect to a database.

$sel:columnConfiguration:DatabaseConfiguration', databaseConfiguration_columnConfiguration - Information about where the index should get the document information from the database.

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

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

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

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

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

Undocumented member.

databaseConfiguration_databaseEngineType :: Lens' DatabaseConfiguration DatabaseEngineType Source #

The type of database engine that runs the database.

databaseConfiguration_connectionConfiguration :: Lens' DatabaseConfiguration ConnectionConfiguration Source #

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

databaseConfiguration_columnConfiguration :: Lens' DatabaseConfiguration ColumnConfiguration Source #

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

Document

data Document Source #

A document in an index.

See: newDocument smart constructor.

Constructors

Document'

Fields

accessControlConfigurationId :: Maybe Text
The identifier of the access control configuration that you want to apply to the document.
accessControlList :: Maybe [Principal]
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.
attributes :: Maybe [DocumentAttribute]
Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.
For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.
blob :: Maybe Base64
The contents of the document.
Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
contentType :: Maybe ContentType
The file type of the document in the Blob field.
hierarchicalAccessControlList :: Maybe (NonEmpty HierarchicalPrincipal)
The list of principal lists that define the hierarchy for which documents users should have access to.
s3Path :: Maybe S3Path
title :: Maybe Text
The title of the document.
id :: Text
A identifier of the document in the index.
Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa. You can delete a data source and then use the BatchPutDocument API to index the same documents, or vice versa.

Instances

Instances details

ToJSON Document Source #
Instance details Defined in Amazonka.Kendra.Types.Document Methods toJSON :: Document -> Value # toEncoding :: Document -> Encoding # toJSONList :: [Document] -> Value # toEncodingList :: [Document] -> Encoding #
Generic Document Source #
Instance details Defined in Amazonka.Kendra.Types.Document Associated Types type Rep Document :: Type -> Type # Methods from :: Document -> Rep Document x # to :: Rep Document x -> Document #
Read Document Source #
Instance details Defined in Amazonka.Kendra.Types.Document Methods readsPrec :: Int -> ReadS Document # readList :: ReadS [Document] # readPrec :: ReadPrec Document # readListPrec :: ReadPrec [Document] #
Show Document Source #
Instance details Defined in Amazonka.Kendra.Types.Document Methods showsPrec :: Int -> Document -> ShowS # show :: Document -> String # showList :: [Document] -> ShowS #
NFData Document Source #
Instance details Defined in Amazonka.Kendra.Types.Document Methods rnf :: Document -> () #
Eq Document Source #
Instance details Defined in Amazonka.Kendra.Types.Document Methods (==) :: Document -> Document -> Bool # (/=) :: Document -> Document -> Bool #
Hashable Document Source #
Instance details Defined in Amazonka.Kendra.Types.Document Methods hashWithSalt :: Int -> Document -> Int # hash :: Document -> Int #
type Rep Document Source #
Instance details Defined in Amazonka.Kendra.Types.Document type Rep Document = D1 ('MetaData "Document" "Amazonka.Kendra.Types.Document" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Document'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accessControlConfigurationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "accessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Principal]))) :: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttribute])) :: S1 ('MetaSel ('Just "blob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)))) :: ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentType)) :: S1 ('MetaSel ('Just "hierarchicalAccessControlList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HierarchicalPrincipal)))) :: (S1 ('MetaSel ('Just "s3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDocument Source #

Arguments

:: Text	`$sel:id:Document'`
-> Document

Create a value of Document with all optional fields omitted.

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

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

$sel:accessControlConfigurationId:Document', document_accessControlConfigurationId - The identifier of the access control configuration that you want to apply to the document.

$sel:accessControlList:Document', document_accessControlList - Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

$sel:attributes:Document', document_attributes - Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

$sel:blob:Document', document_blob - The contents of the document.

Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:contentType:Document', document_contentType - The file type of the document in the Blob field.

$sel:hierarchicalAccessControlList:Document', document_hierarchicalAccessControlList - The list of principal lists that define the hierarchy for which documents users should have access to.

$sel:s3Path:Document', document_s3Path - Undocumented member.

$sel:title:Document', document_title - The title of the document.

$sel:id:Document', document_id - A identifier of the document in the index.

Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa. You can delete a data source and then use the BatchPutDocument API to index the same documents, or vice versa.

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

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

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

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

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

Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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

The contents of the document.

Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

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

The file type of the document in the Blob field.

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

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

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

Undocumented member.

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

The title of the document.

document_id :: Lens' Document Text Source #

A identifier of the document in the index.

Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the BatchPutDocument API to index the same documents, or vice versa. You can delete a data source and then use the BatchPutDocument API to index the same documents, or vice versa.

DocumentAttribute

data DocumentAttribute Source #

A document attribute or metadata field. To create custom document attributes, see Custom attributes.

See: newDocumentAttribute smart constructor.

Constructors

DocumentAttribute'
Fields key :: Text The identifier for the attribute. value :: DocumentAttributeValue The value of the attribute.

Instances

Instances details

FromJSON DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute Methods parseJSON :: Value -> Parser DocumentAttribute # parseJSONList :: Value -> Parser [DocumentAttribute] #
ToJSON DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute Methods toJSON :: DocumentAttribute -> Value # toEncoding :: DocumentAttribute -> Encoding # toJSONList :: [DocumentAttribute] -> Value # toEncodingList :: [DocumentAttribute] -> Encoding #
Generic DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute Associated Types type Rep DocumentAttribute :: Type -> Type # Methods from :: DocumentAttribute -> Rep DocumentAttribute x # to :: Rep DocumentAttribute x -> DocumentAttribute #
Read DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute Methods readsPrec :: Int -> ReadS DocumentAttribute # readList :: ReadS [DocumentAttribute] # readPrec :: ReadPrec DocumentAttribute # readListPrec :: ReadPrec [DocumentAttribute] #
Show DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute Methods showsPrec :: Int -> DocumentAttribute -> ShowS # show :: DocumentAttribute -> String # showList :: [DocumentAttribute] -> ShowS #
NFData DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute Methods rnf :: DocumentAttribute -> () #
Eq DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute Methods (==) :: DocumentAttribute -> DocumentAttribute -> Bool # (/=) :: DocumentAttribute -> DocumentAttribute -> Bool #
Hashable DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute Methods hashWithSalt :: Int -> DocumentAttribute -> Int # hash :: DocumentAttribute -> Int #
type Rep DocumentAttribute Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttribute type Rep DocumentAttribute = D1 ('MetaData "DocumentAttribute" "Amazonka.Kendra.Types.DocumentAttribute" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentAttributeValue)))

newDocumentAttribute Source #

Arguments

:: Text	`$sel:key:DocumentAttribute'`
-> DocumentAttributeValue	`$sel:value:DocumentAttribute'`
-> DocumentAttribute

Create a value of DocumentAttribute with all optional fields omitted.

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

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

$sel:key:DocumentAttribute', documentAttribute_key - The identifier for the attribute.

$sel:value:DocumentAttribute', documentAttribute_value - The value of the attribute.

documentAttribute_key :: Lens' DocumentAttribute Text Source #

The identifier for the attribute.

documentAttribute_value :: Lens' DocumentAttribute DocumentAttributeValue Source #

The value of the attribute.

DocumentAttributeCondition

data DocumentAttributeCondition Source #

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

See: newDocumentAttributeCondition smart constructor.

Constructors

DocumentAttributeCondition'

Fields

conditionOnValue :: Maybe DocumentAttributeValue
The value used by the operator.
For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.
conditionDocumentAttributeKey :: Text
The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Kendra currently does not support _document_body as an attribute key used for the condition.
operator :: ConditionOperator
The condition operator.
For example, you can use 'Contains' to partially match a string.

Instances

Instances details

FromJSON DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods parseJSON :: Value -> Parser DocumentAttributeCondition # parseJSONList :: Value -> Parser [DocumentAttributeCondition] #
ToJSON DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods toJSON :: DocumentAttributeCondition -> Value # toEncoding :: DocumentAttributeCondition -> Encoding # toJSONList :: [DocumentAttributeCondition] -> Value # toEncodingList :: [DocumentAttributeCondition] -> Encoding #
Generic DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Associated Types type Rep DocumentAttributeCondition :: Type -> Type # Methods from :: DocumentAttributeCondition -> Rep DocumentAttributeCondition x # to :: Rep DocumentAttributeCondition x -> DocumentAttributeCondition #
Read DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods readsPrec :: Int -> ReadS DocumentAttributeCondition # readList :: ReadS [DocumentAttributeCondition] # readPrec :: ReadPrec DocumentAttributeCondition # readListPrec :: ReadPrec [DocumentAttributeCondition] #
Show DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods showsPrec :: Int -> DocumentAttributeCondition -> ShowS # show :: DocumentAttributeCondition -> String # showList :: [DocumentAttributeCondition] -> ShowS #
NFData DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods rnf :: DocumentAttributeCondition -> () #
Eq DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods (==) :: DocumentAttributeCondition -> DocumentAttributeCondition -> Bool # (/=) :: DocumentAttributeCondition -> DocumentAttributeCondition -> Bool #
Hashable DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition Methods hashWithSalt :: Int -> DocumentAttributeCondition -> Int # hash :: DocumentAttributeCondition -> Int #
type Rep DocumentAttributeCondition Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeCondition type Rep DocumentAttributeCondition = D1 ('MetaData "DocumentAttributeCondition" "Amazonka.Kendra.Types.DocumentAttributeCondition" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "conditionOnValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValue)) :: (S1 ('MetaSel ('Just "conditionDocumentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConditionOperator))))

newDocumentAttributeCondition Source #

Arguments

:: Text	`$sel:conditionDocumentAttributeKey:DocumentAttributeCondition'`
-> ConditionOperator	`$sel:operator:DocumentAttributeCondition'`
-> DocumentAttributeCondition

Create a value of DocumentAttributeCondition with all optional fields omitted.

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

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

$sel:conditionOnValue:DocumentAttributeCondition', documentAttributeCondition_conditionOnValue - The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

$sel:conditionDocumentAttributeKey:DocumentAttributeCondition', documentAttributeCondition_conditionDocumentAttributeKey - The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

$sel:operator:DocumentAttributeCondition', documentAttributeCondition_operator - The condition operator.

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

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

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

documentAttributeCondition_conditionDocumentAttributeKey :: Lens' DocumentAttributeCondition Text Source #

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

documentAttributeCondition_operator :: Lens' DocumentAttributeCondition ConditionOperator Source #

The condition operator.

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

DocumentAttributeTarget

data DocumentAttributeTarget Source #

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

You can also use this with DocumentAttributeCondition.

See: newDocumentAttributeTarget smart constructor.

Constructors

DocumentAttributeTarget'

Fields

targetDocumentAttributeKey :: Maybe Text
The identifier of the target document attribute or metadata field.
For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
targetDocumentAttributeValue :: Maybe DocumentAttributeValue
The target value you want to create for the target attribute.
For example, 'Finance' could be the target value for the target attribute key 'Department'.
targetDocumentAttributeValueDeletion :: Maybe Bool
TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.

Instances

Instances details

FromJSON DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget Methods parseJSON :: Value -> Parser DocumentAttributeTarget # parseJSONList :: Value -> Parser [DocumentAttributeTarget] #
ToJSON DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget Methods toJSON :: DocumentAttributeTarget -> Value # toEncoding :: DocumentAttributeTarget -> Encoding # toJSONList :: [DocumentAttributeTarget] -> Value # toEncodingList :: [DocumentAttributeTarget] -> Encoding #
Generic DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget Associated Types type Rep DocumentAttributeTarget :: Type -> Type # Methods from :: DocumentAttributeTarget -> Rep DocumentAttributeTarget x # to :: Rep DocumentAttributeTarget x -> DocumentAttributeTarget #
Read DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget Methods readsPrec :: Int -> ReadS DocumentAttributeTarget # readList :: ReadS [DocumentAttributeTarget] # readPrec :: ReadPrec DocumentAttributeTarget # readListPrec :: ReadPrec [DocumentAttributeTarget] #
Show DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget Methods showsPrec :: Int -> DocumentAttributeTarget -> ShowS # show :: DocumentAttributeTarget -> String # showList :: [DocumentAttributeTarget] -> ShowS #
NFData DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget Methods rnf :: DocumentAttributeTarget -> () #
Eq DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget Methods (==) :: DocumentAttributeTarget -> DocumentAttributeTarget -> Bool # (/=) :: DocumentAttributeTarget -> DocumentAttributeTarget -> Bool #
Hashable DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget Methods hashWithSalt :: Int -> DocumentAttributeTarget -> Int # hash :: DocumentAttributeTarget -> Int #
type Rep DocumentAttributeTarget Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeTarget type Rep DocumentAttributeTarget = D1 ('MetaData "DocumentAttributeTarget" "Amazonka.Kendra.Types.DocumentAttributeTarget" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeTarget'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetDocumentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "targetDocumentAttributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValue)) :: S1 ('MetaSel ('Just "targetDocumentAttributeValueDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newDocumentAttributeTarget :: DocumentAttributeTarget Source #

Create a value of DocumentAttributeTarget with all optional fields omitted.

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

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

$sel:targetDocumentAttributeKey:DocumentAttributeTarget', documentAttributeTarget_targetDocumentAttributeKey - The identifier of the target document attribute or metadata field.

For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

$sel:targetDocumentAttributeValue:DocumentAttributeTarget', documentAttributeTarget_targetDocumentAttributeValue - The target value you want to create for the target attribute.

For example, 'Finance' could be the target value for the target attribute key 'Department'.

$sel:targetDocumentAttributeValueDeletion:DocumentAttributeTarget', documentAttributeTarget_targetDocumentAttributeValueDeletion - TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.

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

The identifier of the target document attribute or metadata field.

For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

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

The target value you want to create for the target attribute.

For example, 'Finance' could be the target value for the target attribute key 'Department'.

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

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.

DocumentAttributeValue

data DocumentAttributeValue Source #

The value of a document attribute. You can only provide one value for a document attribute.

See: newDocumentAttributeValue smart constructor.

Constructors

DocumentAttributeValue'

Fields

dateValue :: Maybe POSIX
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
longValue :: Maybe Integer
A long integer value.
stringListValue :: Maybe [Text]
A list of strings. The default maximum length or number of strings is 10.
stringValue :: Maybe Text
A string, such as "department".

Instances

Instances details

FromJSON DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue Methods parseJSON :: Value -> Parser DocumentAttributeValue # parseJSONList :: Value -> Parser [DocumentAttributeValue] #
ToJSON DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue Methods toJSON :: DocumentAttributeValue -> Value # toEncoding :: DocumentAttributeValue -> Encoding # toJSONList :: [DocumentAttributeValue] -> Value # toEncodingList :: [DocumentAttributeValue] -> Encoding #
Generic DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue Associated Types type Rep DocumentAttributeValue :: Type -> Type # Methods from :: DocumentAttributeValue -> Rep DocumentAttributeValue x # to :: Rep DocumentAttributeValue x -> DocumentAttributeValue #
Read DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue Methods readsPrec :: Int -> ReadS DocumentAttributeValue # readList :: ReadS [DocumentAttributeValue] # readPrec :: ReadPrec DocumentAttributeValue # readListPrec :: ReadPrec [DocumentAttributeValue] #
Show DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue Methods showsPrec :: Int -> DocumentAttributeValue -> ShowS # show :: DocumentAttributeValue -> String # showList :: [DocumentAttributeValue] -> ShowS #
NFData DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue Methods rnf :: DocumentAttributeValue -> () #
Eq DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue Methods (==) :: DocumentAttributeValue -> DocumentAttributeValue -> Bool # (/=) :: DocumentAttributeValue -> DocumentAttributeValue -> Bool #
Hashable DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue Methods hashWithSalt :: Int -> DocumentAttributeValue -> Int # hash :: DocumentAttributeValue -> Int #
type Rep DocumentAttributeValue Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValue type Rep DocumentAttributeValue = D1 ('MetaData "DocumentAttributeValue" "Amazonka.Kendra.Types.DocumentAttributeValue" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dateValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "longValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "stringListValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "stringValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentAttributeValue :: DocumentAttributeValue Source #

Create a value of DocumentAttributeValue with all optional fields omitted.

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

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

$sel:dateValue:DocumentAttributeValue', documentAttributeValue_dateValue - A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

$sel:longValue:DocumentAttributeValue', documentAttributeValue_longValue - A long integer value.

$sel:stringListValue:DocumentAttributeValue', documentAttributeValue_stringListValue - A list of strings. The default maximum length or number of strings is 10.

$sel:stringValue:DocumentAttributeValue', documentAttributeValue_stringValue - A string, such as "department".

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

A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

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

A long integer value.

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

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

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

A string, such as "department".

DocumentAttributeValueCountPair

data DocumentAttributeValueCountPair Source #

Provides the count of documents that match a particular attribute when doing a faceted search.

See: newDocumentAttributeValueCountPair smart constructor.

Constructors

DocumentAttributeValueCountPair'

Fields

count :: Maybe Int
The number of documents in the response that have the attribute value for the key.
documentAttributeValue :: Maybe DocumentAttributeValue
The value of the attribute. For example, "HR".
facetResults :: Maybe [FacetResult]
Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

Instances

Instances details

FromJSON DocumentAttributeValueCountPair Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair Methods parseJSON :: Value -> Parser DocumentAttributeValueCountPair # parseJSONList :: Value -> Parser [DocumentAttributeValueCountPair] #
Generic DocumentAttributeValueCountPair Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair Associated Types type Rep DocumentAttributeValueCountPair :: Type -> Type # Methods from :: DocumentAttributeValueCountPair -> Rep DocumentAttributeValueCountPair x # to :: Rep DocumentAttributeValueCountPair x -> DocumentAttributeValueCountPair #
Read DocumentAttributeValueCountPair Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair Methods readsPrec :: Int -> ReadS DocumentAttributeValueCountPair # readList :: ReadS [DocumentAttributeValueCountPair] # readPrec :: ReadPrec DocumentAttributeValueCountPair # readListPrec :: ReadPrec [DocumentAttributeValueCountPair] #
Show DocumentAttributeValueCountPair Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair Methods showsPrec :: Int -> DocumentAttributeValueCountPair -> ShowS # show :: DocumentAttributeValueCountPair -> String # showList :: [DocumentAttributeValueCountPair] -> ShowS #
NFData DocumentAttributeValueCountPair Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair Methods rnf :: DocumentAttributeValueCountPair -> () #
Eq DocumentAttributeValueCountPair Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair Methods (==) :: DocumentAttributeValueCountPair -> DocumentAttributeValueCountPair -> Bool # (/=) :: DocumentAttributeValueCountPair -> DocumentAttributeValueCountPair -> Bool #
Hashable DocumentAttributeValueCountPair Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair Methods hashWithSalt :: Int -> DocumentAttributeValueCountPair -> Int # hash :: DocumentAttributeValueCountPair -> Int #
type Rep DocumentAttributeValueCountPair Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentAttributeValueCountPair type Rep DocumentAttributeValueCountPair = D1 ('MetaData "DocumentAttributeValueCountPair" "Amazonka.Kendra.Types.DocumentAttributeValueCountPair" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeValueCountPair'" 'PrefixI 'True) (S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "documentAttributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValue)) :: S1 ('MetaSel ('Just "facetResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FacetResult])))))

newDocumentAttributeValueCountPair :: DocumentAttributeValueCountPair Source #

Create a value of DocumentAttributeValueCountPair with all optional fields omitted.

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

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

$sel:count:DocumentAttributeValueCountPair', documentAttributeValueCountPair_count - The number of documents in the response that have the attribute value for the key.

$sel:documentAttributeValue:DocumentAttributeValueCountPair', documentAttributeValueCountPair_documentAttributeValue - The value of the attribute. For example, "HR".

$sel:facetResults:DocumentAttributeValueCountPair', documentAttributeValueCountPair_facetResults - Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

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

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

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

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

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

Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

DocumentInfo

data DocumentInfo Source #

Identifies a document for which to retrieve status information

See: newDocumentInfo smart constructor.

Constructors

DocumentInfo'

Fields

attributes :: Maybe [DocumentAttribute]
Attributes that identify a specific version of a document to check.
The only valid attributes are:
- version
- datasourceId
- jobExecutionId
The attributes follow these rules:
- dataSourceId and jobExecutionId must be used together.
- version is ignored if dataSourceId and jobExecutionId are not provided.
- If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".
documentId :: Text
The identifier of the document.

Instances

Instances details

ToJSON DocumentInfo Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentInfo Methods toJSON :: DocumentInfo -> Value # toEncoding :: DocumentInfo -> Encoding # toJSONList :: [DocumentInfo] -> Value # toEncodingList :: [DocumentInfo] -> Encoding #
Generic DocumentInfo Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentInfo Associated Types type Rep DocumentInfo :: Type -> Type # Methods from :: DocumentInfo -> Rep DocumentInfo x # to :: Rep DocumentInfo x -> DocumentInfo #
Read DocumentInfo Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentInfo Methods readsPrec :: Int -> ReadS DocumentInfo # readList :: ReadS [DocumentInfo] # readPrec :: ReadPrec DocumentInfo # readListPrec :: ReadPrec [DocumentInfo] #
Show DocumentInfo Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentInfo Methods showsPrec :: Int -> DocumentInfo -> ShowS # show :: DocumentInfo -> String # showList :: [DocumentInfo] -> ShowS #
NFData DocumentInfo Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentInfo Methods rnf :: DocumentInfo -> () #
Eq DocumentInfo Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentInfo Methods (==) :: DocumentInfo -> DocumentInfo -> Bool # (/=) :: DocumentInfo -> DocumentInfo -> Bool #
Hashable DocumentInfo Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentInfo Methods hashWithSalt :: Int -> DocumentInfo -> Int # hash :: DocumentInfo -> Int #
type Rep DocumentInfo Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentInfo type Rep DocumentInfo = D1 ('MetaData "DocumentInfo" "Amazonka.Kendra.Types.DocumentInfo" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttribute])) :*: S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDocumentInfo Source #

Arguments

:: Text	`$sel:documentId:DocumentInfo'`
-> DocumentInfo

Create a value of DocumentInfo with all optional fields omitted.

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

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

$sel:attributes:DocumentInfo', documentInfo_attributes - Attributes that identify a specific version of a document to check.

The only valid attributes are:

version
datasourceId
jobExecutionId

The attributes follow these rules:

dataSourceId and jobExecutionId must be used together.
version is ignored if dataSourceId and jobExecutionId are not provided.
If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

$sel:documentId:DocumentInfo', documentInfo_documentId - The identifier of the document.

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

Attributes that identify a specific version of a document to check.

The only valid attributes are:

version
datasourceId
jobExecutionId

The attributes follow these rules:

dataSourceId and jobExecutionId must be used together.
version is ignored if dataSourceId and jobExecutionId are not provided.
If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

documentInfo_documentId :: Lens' DocumentInfo Text Source #

The identifier of the document.

DocumentMetadataConfiguration

data DocumentMetadataConfiguration Source #

Specifies the properties, such as relevance tuning and searchability, of an index field.

See: newDocumentMetadataConfiguration smart constructor.

Constructors

DocumentMetadataConfiguration'
Fields relevance :: Maybe Relevance Provides tuning parameters to determine how the field affects the search results. search :: Maybe Search Provides information about how the field is used during a search. name :: Text The name of the index field. type' :: DocumentAttributeValueType The data type of the index field.

Instances

Instances details

FromJSON DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration Methods parseJSON :: Value -> Parser DocumentMetadataConfiguration # parseJSONList :: Value -> Parser [DocumentMetadataConfiguration] #
ToJSON DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration Methods toJSON :: DocumentMetadataConfiguration -> Value # toEncoding :: DocumentMetadataConfiguration -> Encoding # toJSONList :: [DocumentMetadataConfiguration] -> Value # toEncodingList :: [DocumentMetadataConfiguration] -> Encoding #
Generic DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration Associated Types type Rep DocumentMetadataConfiguration :: Type -> Type # Methods from :: DocumentMetadataConfiguration -> Rep DocumentMetadataConfiguration x # to :: Rep DocumentMetadataConfiguration x -> DocumentMetadataConfiguration #
Read DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration Methods readsPrec :: Int -> ReadS DocumentMetadataConfiguration # readList :: ReadS [DocumentMetadataConfiguration] # readPrec :: ReadPrec DocumentMetadataConfiguration # readListPrec :: ReadPrec [DocumentMetadataConfiguration] #
Show DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration Methods showsPrec :: Int -> DocumentMetadataConfiguration -> ShowS # show :: DocumentMetadataConfiguration -> String # showList :: [DocumentMetadataConfiguration] -> ShowS #
NFData DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration Methods rnf :: DocumentMetadataConfiguration -> () #
Eq DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration Methods (==) :: DocumentMetadataConfiguration -> DocumentMetadataConfiguration -> Bool # (/=) :: DocumentMetadataConfiguration -> DocumentMetadataConfiguration -> Bool #
Hashable DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration Methods hashWithSalt :: Int -> DocumentMetadataConfiguration -> Int # hash :: DocumentMetadataConfiguration -> Int #
type Rep DocumentMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentMetadataConfiguration type Rep DocumentMetadataConfiguration = D1 ('MetaData "DocumentMetadataConfiguration" "Amazonka.Kendra.Types.DocumentMetadataConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentMetadataConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "relevance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Relevance)) :: S1 ('MetaSel ('Just "search") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Search))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentAttributeValueType))))

newDocumentMetadataConfiguration Source #

Arguments

:: Text	`$sel:name:DocumentMetadataConfiguration'`
-> DocumentAttributeValueType	`$sel:type':DocumentMetadataConfiguration'`
-> DocumentMetadataConfiguration

Create a value of DocumentMetadataConfiguration with all optional fields omitted.

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

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

$sel:relevance:DocumentMetadataConfiguration', documentMetadataConfiguration_relevance - Provides tuning parameters to determine how the field affects the search results.

$sel:search:DocumentMetadataConfiguration', documentMetadataConfiguration_search - Provides information about how the field is used during a search.

$sel:name:DocumentMetadataConfiguration', documentMetadataConfiguration_name - The name of the index field.

$sel:type':DocumentMetadataConfiguration', documentMetadataConfiguration_type - The data type of the index field.

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

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

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

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

documentMetadataConfiguration_name :: Lens' DocumentMetadataConfiguration Text Source #

The name of the index field.

documentMetadataConfiguration_type :: Lens' DocumentMetadataConfiguration DocumentAttributeValueType Source #

The data type of the index field.

DocumentRelevanceConfiguration

data DocumentRelevanceConfiguration Source #

Overrides the document relevance properties of a custom index field.

See: newDocumentRelevanceConfiguration smart constructor.

Constructors

DocumentRelevanceConfiguration'
Fields name :: Text The name of the index field. relevance :: Relevance Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

Instances

Instances details

ToJSON DocumentRelevanceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration Methods toJSON :: DocumentRelevanceConfiguration -> Value # toEncoding :: DocumentRelevanceConfiguration -> Encoding # toJSONList :: [DocumentRelevanceConfiguration] -> Value # toEncodingList :: [DocumentRelevanceConfiguration] -> Encoding #
Generic DocumentRelevanceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration Associated Types type Rep DocumentRelevanceConfiguration :: Type -> Type # Methods from :: DocumentRelevanceConfiguration -> Rep DocumentRelevanceConfiguration x # to :: Rep DocumentRelevanceConfiguration x -> DocumentRelevanceConfiguration #
Read DocumentRelevanceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration Methods readsPrec :: Int -> ReadS DocumentRelevanceConfiguration # readList :: ReadS [DocumentRelevanceConfiguration] # readPrec :: ReadPrec DocumentRelevanceConfiguration # readListPrec :: ReadPrec [DocumentRelevanceConfiguration] #
Show DocumentRelevanceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration Methods showsPrec :: Int -> DocumentRelevanceConfiguration -> ShowS # show :: DocumentRelevanceConfiguration -> String # showList :: [DocumentRelevanceConfiguration] -> ShowS #
NFData DocumentRelevanceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration Methods rnf :: DocumentRelevanceConfiguration -> () #
Eq DocumentRelevanceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration Methods (==) :: DocumentRelevanceConfiguration -> DocumentRelevanceConfiguration -> Bool # (/=) :: DocumentRelevanceConfiguration -> DocumentRelevanceConfiguration -> Bool #
Hashable DocumentRelevanceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration Methods hashWithSalt :: Int -> DocumentRelevanceConfiguration -> Int # hash :: DocumentRelevanceConfiguration -> Int #
type Rep DocumentRelevanceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentRelevanceConfiguration type Rep DocumentRelevanceConfiguration = D1 ('MetaData "DocumentRelevanceConfiguration" "Amazonka.Kendra.Types.DocumentRelevanceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentRelevanceConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "relevance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Relevance)))

newDocumentRelevanceConfiguration Source #

Arguments

:: Text	`$sel:name:DocumentRelevanceConfiguration'`
-> Relevance	`$sel:relevance:DocumentRelevanceConfiguration'`
-> DocumentRelevanceConfiguration

Create a value of DocumentRelevanceConfiguration with all optional fields omitted.

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

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

$sel:name:DocumentRelevanceConfiguration', documentRelevanceConfiguration_name - The name of the index field.

$sel:relevance:DocumentRelevanceConfiguration', documentRelevanceConfiguration_relevance - Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

documentRelevanceConfiguration_name :: Lens' DocumentRelevanceConfiguration Text Source #

The name of the index field.

documentRelevanceConfiguration_relevance :: Lens' DocumentRelevanceConfiguration Relevance Source #

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

DocumentsMetadataConfiguration

data DocumentsMetadataConfiguration Source #

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

See: newDocumentsMetadataConfiguration smart constructor.

Constructors

DocumentsMetadataConfiguration'
Fields s3Prefix :: Maybe Text A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use `S3Prefix` to include only the desired metadata files.

Instances

Instances details

FromJSON DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration Methods parseJSON :: Value -> Parser DocumentsMetadataConfiguration # parseJSONList :: Value -> Parser [DocumentsMetadataConfiguration] #
ToJSON DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration Methods toJSON :: DocumentsMetadataConfiguration -> Value # toEncoding :: DocumentsMetadataConfiguration -> Encoding # toJSONList :: [DocumentsMetadataConfiguration] -> Value # toEncodingList :: [DocumentsMetadataConfiguration] -> Encoding #
Generic DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration Associated Types type Rep DocumentsMetadataConfiguration :: Type -> Type # Methods from :: DocumentsMetadataConfiguration -> Rep DocumentsMetadataConfiguration x # to :: Rep DocumentsMetadataConfiguration x -> DocumentsMetadataConfiguration #
Read DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration Methods readsPrec :: Int -> ReadS DocumentsMetadataConfiguration # readList :: ReadS [DocumentsMetadataConfiguration] # readPrec :: ReadPrec DocumentsMetadataConfiguration # readListPrec :: ReadPrec [DocumentsMetadataConfiguration] #
Show DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration Methods showsPrec :: Int -> DocumentsMetadataConfiguration -> ShowS # show :: DocumentsMetadataConfiguration -> String # showList :: [DocumentsMetadataConfiguration] -> ShowS #
NFData DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration Methods rnf :: DocumentsMetadataConfiguration -> () #
Eq DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration Methods (==) :: DocumentsMetadataConfiguration -> DocumentsMetadataConfiguration -> Bool # (/=) :: DocumentsMetadataConfiguration -> DocumentsMetadataConfiguration -> Bool #
Hashable DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration Methods hashWithSalt :: Int -> DocumentsMetadataConfiguration -> Int # hash :: DocumentsMetadataConfiguration -> Int #
type Rep DocumentsMetadataConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.DocumentsMetadataConfiguration type Rep DocumentsMetadataConfiguration = D1 ('MetaData "DocumentsMetadataConfiguration" "Amazonka.Kendra.Types.DocumentsMetadataConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentsMetadataConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDocumentsMetadataConfiguration :: DocumentsMetadataConfiguration Source #

Create a value of DocumentsMetadataConfiguration with all optional fields omitted.

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

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

$sel:s3Prefix:DocumentsMetadataConfiguration', documentsMetadataConfiguration_s3Prefix - A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

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

A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

EntityConfiguration

data EntityConfiguration Source #

Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience.

See: newEntityConfiguration smart constructor.

Constructors

EntityConfiguration'
Fields entityId :: Text The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email. entityType :: EntityType Specifies whether you are configuring a `User` or a `Group`.

Instances

Instances details

ToJSON EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods toJSON :: EntityConfiguration -> Value # toEncoding :: EntityConfiguration -> Encoding # toJSONList :: [EntityConfiguration] -> Value # toEncodingList :: [EntityConfiguration] -> Encoding #
Generic EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Associated Types type Rep EntityConfiguration :: Type -> Type # Methods from :: EntityConfiguration -> Rep EntityConfiguration x # to :: Rep EntityConfiguration x -> EntityConfiguration #
Read EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods readsPrec :: Int -> ReadS EntityConfiguration # readList :: ReadS [EntityConfiguration] # readPrec :: ReadPrec EntityConfiguration # readListPrec :: ReadPrec [EntityConfiguration] #
Show EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods showsPrec :: Int -> EntityConfiguration -> ShowS # show :: EntityConfiguration -> String # showList :: [EntityConfiguration] -> ShowS #
NFData EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods rnf :: EntityConfiguration -> () #
Eq EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods (==) :: EntityConfiguration -> EntityConfiguration -> Bool # (/=) :: EntityConfiguration -> EntityConfiguration -> Bool #
Hashable EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration Methods hashWithSalt :: Int -> EntityConfiguration -> Int # hash :: EntityConfiguration -> Int #
type Rep EntityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityConfiguration type Rep EntityConfiguration = D1 ('MetaData "EntityConfiguration" "Amazonka.Kendra.Types.EntityConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "EntityConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EntityType)))

newEntityConfiguration Source #

Arguments

:: Text	`$sel:entityId:EntityConfiguration'`
-> EntityType	`$sel:entityType:EntityConfiguration'`
-> EntityConfiguration

Create a value of EntityConfiguration with all optional fields omitted.

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

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

$sel:entityId:EntityConfiguration', entityConfiguration_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:entityType:EntityConfiguration', entityConfiguration_entityType - Specifies whether you are configuring a User or a Group.

entityConfiguration_entityId :: Lens' EntityConfiguration Text Source #

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

entityConfiguration_entityType :: Lens' EntityConfiguration EntityType Source #

Specifies whether you are configuring a User or a Group.

EntityDisplayData

data EntityDisplayData Source #

Information about the user entity.

See: newEntityDisplayData smart constructor.

Constructors

EntityDisplayData'
Fields firstName :: Maybe (Sensitive Text) The first name of the user. groupName :: Maybe (Sensitive Text) The name of the group. identifiedUserName :: Maybe (Sensitive Text) The user name of the user. lastName :: Maybe (Sensitive Text) The last name of the user. userName :: Maybe (Sensitive Text) The name of the user.

Instances

Instances details

FromJSON EntityDisplayData Source #
Instance details Defined in Amazonka.Kendra.Types.EntityDisplayData Methods parseJSON :: Value -> Parser EntityDisplayData # parseJSONList :: Value -> Parser [EntityDisplayData] #
Generic EntityDisplayData Source #
Instance details Defined in Amazonka.Kendra.Types.EntityDisplayData Associated Types type Rep EntityDisplayData :: Type -> Type # Methods from :: EntityDisplayData -> Rep EntityDisplayData x # to :: Rep EntityDisplayData x -> EntityDisplayData #
Show EntityDisplayData Source #
Instance details Defined in Amazonka.Kendra.Types.EntityDisplayData Methods showsPrec :: Int -> EntityDisplayData -> ShowS # show :: EntityDisplayData -> String # showList :: [EntityDisplayData] -> ShowS #
NFData EntityDisplayData Source #
Instance details Defined in Amazonka.Kendra.Types.EntityDisplayData Methods rnf :: EntityDisplayData -> () #
Eq EntityDisplayData Source #
Instance details Defined in Amazonka.Kendra.Types.EntityDisplayData Methods (==) :: EntityDisplayData -> EntityDisplayData -> Bool # (/=) :: EntityDisplayData -> EntityDisplayData -> Bool #
Hashable EntityDisplayData Source #
Instance details Defined in Amazonka.Kendra.Types.EntityDisplayData Methods hashWithSalt :: Int -> EntityDisplayData -> Int # hash :: EntityDisplayData -> Int #
type Rep EntityDisplayData Source #
Instance details Defined in Amazonka.Kendra.Types.EntityDisplayData type Rep EntityDisplayData = D1 ('MetaData "EntityDisplayData" "Amazonka.Kendra.Types.EntityDisplayData" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "EntityDisplayData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "firstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "identifiedUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))))

newEntityDisplayData :: EntityDisplayData Source #

Create a value of EntityDisplayData with all optional fields omitted.

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

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

$sel:firstName:EntityDisplayData', entityDisplayData_firstName - The first name of the user.

$sel:groupName:EntityDisplayData', entityDisplayData_groupName - The name of the group.

$sel:identifiedUserName:EntityDisplayData', entityDisplayData_identifiedUserName - The user name of the user.

$sel:lastName:EntityDisplayData', entityDisplayData_lastName - The last name of the user.

$sel:userName:EntityDisplayData', entityDisplayData_userName - The name of the user.

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

The first name of the user.

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

The name of the group.

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

The user name of the user.

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

The last name of the user.

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

The name of the user.

EntityPersonaConfiguration

data EntityPersonaConfiguration Source #

Provides the configuration information for users or groups in your IAM Identity Center identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.

See: newEntityPersonaConfiguration smart constructor.

Constructors

EntityPersonaConfiguration'

Fields

entityId :: Text
The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.
persona :: Persona
The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

Instances

Instances details

ToJSON EntityPersonaConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration Methods toJSON :: EntityPersonaConfiguration -> Value # toEncoding :: EntityPersonaConfiguration -> Encoding # toJSONList :: [EntityPersonaConfiguration] -> Value # toEncodingList :: [EntityPersonaConfiguration] -> Encoding #
Generic EntityPersonaConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration Associated Types type Rep EntityPersonaConfiguration :: Type -> Type # Methods from :: EntityPersonaConfiguration -> Rep EntityPersonaConfiguration x # to :: Rep EntityPersonaConfiguration x -> EntityPersonaConfiguration #
Read EntityPersonaConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration Methods readsPrec :: Int -> ReadS EntityPersonaConfiguration # readList :: ReadS [EntityPersonaConfiguration] # readPrec :: ReadPrec EntityPersonaConfiguration # readListPrec :: ReadPrec [EntityPersonaConfiguration] #
Show EntityPersonaConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration Methods showsPrec :: Int -> EntityPersonaConfiguration -> ShowS # show :: EntityPersonaConfiguration -> String # showList :: [EntityPersonaConfiguration] -> ShowS #
NFData EntityPersonaConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration Methods rnf :: EntityPersonaConfiguration -> () #
Eq EntityPersonaConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration Methods (==) :: EntityPersonaConfiguration -> EntityPersonaConfiguration -> Bool # (/=) :: EntityPersonaConfiguration -> EntityPersonaConfiguration -> Bool #
Hashable EntityPersonaConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration Methods hashWithSalt :: Int -> EntityPersonaConfiguration -> Int # hash :: EntityPersonaConfiguration -> Int #
type Rep EntityPersonaConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.EntityPersonaConfiguration type Rep EntityPersonaConfiguration = D1 ('MetaData "EntityPersonaConfiguration" "Amazonka.Kendra.Types.EntityPersonaConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "EntityPersonaConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "persona") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Persona)))

newEntityPersonaConfiguration Source #

Arguments

:: Text	`$sel:entityId:EntityPersonaConfiguration'`
-> Persona	`$sel:persona:EntityPersonaConfiguration'`
-> EntityPersonaConfiguration

Create a value of EntityPersonaConfiguration with all optional fields omitted.

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

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

$sel:entityId:EntityPersonaConfiguration', entityPersonaConfiguration_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:persona:EntityPersonaConfiguration', entityPersonaConfiguration_persona - The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

entityPersonaConfiguration_entityId :: Lens' EntityPersonaConfiguration Text Source #

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

entityPersonaConfiguration_persona :: Lens' EntityPersonaConfiguration Persona Source #

The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

ExperienceConfiguration

data ExperienceConfiguration Source #

Provides the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.

See: newExperienceConfiguration smart constructor.

Constructors

ExperienceConfiguration'

Fields

contentSourceConfiguration :: Maybe ContentSourceConfiguration
The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.
userIdentityConfiguration :: Maybe UserIdentityConfiguration
The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

Instances

Instances details

FromJSON ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration Methods parseJSON :: Value -> Parser ExperienceConfiguration # parseJSONList :: Value -> Parser [ExperienceConfiguration] #
ToJSON ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration Methods toJSON :: ExperienceConfiguration -> Value # toEncoding :: ExperienceConfiguration -> Encoding # toJSONList :: [ExperienceConfiguration] -> Value # toEncodingList :: [ExperienceConfiguration] -> Encoding #
Generic ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration Associated Types type Rep ExperienceConfiguration :: Type -> Type # Methods from :: ExperienceConfiguration -> Rep ExperienceConfiguration x # to :: Rep ExperienceConfiguration x -> ExperienceConfiguration #
Read ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration Methods readsPrec :: Int -> ReadS ExperienceConfiguration # readList :: ReadS [ExperienceConfiguration] # readPrec :: ReadPrec ExperienceConfiguration # readListPrec :: ReadPrec [ExperienceConfiguration] #
Show ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration Methods showsPrec :: Int -> ExperienceConfiguration -> ShowS # show :: ExperienceConfiguration -> String # showList :: [ExperienceConfiguration] -> ShowS #
NFData ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration Methods rnf :: ExperienceConfiguration -> () #
Eq ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration Methods (==) :: ExperienceConfiguration -> ExperienceConfiguration -> Bool # (/=) :: ExperienceConfiguration -> ExperienceConfiguration -> Bool #
Hashable ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration Methods hashWithSalt :: Int -> ExperienceConfiguration -> Int # hash :: ExperienceConfiguration -> Int #
type Rep ExperienceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceConfiguration type Rep ExperienceConfiguration = D1 ('MetaData "ExperienceConfiguration" "Amazonka.Kendra.Types.ExperienceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ExperienceConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contentSourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentSourceConfiguration)) :*: S1 ('MetaSel ('Just "userIdentityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserIdentityConfiguration))))

newExperienceConfiguration :: ExperienceConfiguration Source #

Create a value of ExperienceConfiguration with all optional fields omitted.

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

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

$sel:contentSourceConfiguration:ExperienceConfiguration', experienceConfiguration_contentSourceConfiguration - The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.

$sel:userIdentityConfiguration:ExperienceConfiguration', experienceConfiguration_userIdentityConfiguration - The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

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

The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.

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

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

ExperienceEndpoint

data ExperienceEndpoint Source #

Provides the configuration information for the endpoint for your Amazon Kendra experience.

See: newExperienceEndpoint smart constructor.

Constructors

ExperienceEndpoint'
Fields endpoint :: Maybe Text The endpoint of your Amazon Kendra experience. endpointType :: Maybe EndpointType The type of endpoint for your Amazon Kendra experience. The type currently available is `HOME`, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.

Instances

Instances details

FromJSON ExperienceEndpoint Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEndpoint Methods parseJSON :: Value -> Parser ExperienceEndpoint # parseJSONList :: Value -> Parser [ExperienceEndpoint] #
Generic ExperienceEndpoint Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEndpoint Associated Types type Rep ExperienceEndpoint :: Type -> Type # Methods from :: ExperienceEndpoint -> Rep ExperienceEndpoint x # to :: Rep ExperienceEndpoint x -> ExperienceEndpoint #
Read ExperienceEndpoint Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEndpoint Methods readsPrec :: Int -> ReadS ExperienceEndpoint # readList :: ReadS [ExperienceEndpoint] # readPrec :: ReadPrec ExperienceEndpoint # readListPrec :: ReadPrec [ExperienceEndpoint] #
Show ExperienceEndpoint Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEndpoint Methods showsPrec :: Int -> ExperienceEndpoint -> ShowS # show :: ExperienceEndpoint -> String # showList :: [ExperienceEndpoint] -> ShowS #
NFData ExperienceEndpoint Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEndpoint Methods rnf :: ExperienceEndpoint -> () #
Eq ExperienceEndpoint Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEndpoint Methods (==) :: ExperienceEndpoint -> ExperienceEndpoint -> Bool # (/=) :: ExperienceEndpoint -> ExperienceEndpoint -> Bool #
Hashable ExperienceEndpoint Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEndpoint Methods hashWithSalt :: Int -> ExperienceEndpoint -> Int # hash :: ExperienceEndpoint -> Int #
type Rep ExperienceEndpoint Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEndpoint type Rep ExperienceEndpoint = D1 ('MetaData "ExperienceEndpoint" "Amazonka.Kendra.Types.ExperienceEndpoint" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ExperienceEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointType))))

newExperienceEndpoint :: ExperienceEndpoint Source #

Create a value of ExperienceEndpoint with all optional fields omitted.

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

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

$sel:endpoint:ExperienceEndpoint', experienceEndpoint_endpoint - The endpoint of your Amazon Kendra experience.

$sel:endpointType:ExperienceEndpoint', experienceEndpoint_endpointType - The type of endpoint for your Amazon Kendra experience. The type currently available is HOME, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.

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

The endpoint of your Amazon Kendra experience.

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

The type of endpoint for your Amazon Kendra experience. The type currently available is HOME, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.

ExperienceEntitiesSummary

data ExperienceEntitiesSummary Source #

Summary information for users or groups in your IAM Identity Center identity source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

See: newExperienceEntitiesSummary smart constructor.

Constructors

ExperienceEntitiesSummary'
Fields displayData :: Maybe EntityDisplayData Information about the user entity. entityId :: Maybe Text The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email. entityType :: Maybe EntityType Shows the type as `User` or `Group`.

Instances

Instances details

FromJSON ExperienceEntitiesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary Methods parseJSON :: Value -> Parser ExperienceEntitiesSummary # parseJSONList :: Value -> Parser [ExperienceEntitiesSummary] #
Generic ExperienceEntitiesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary Associated Types type Rep ExperienceEntitiesSummary :: Type -> Type # Methods from :: ExperienceEntitiesSummary -> Rep ExperienceEntitiesSummary x # to :: Rep ExperienceEntitiesSummary x -> ExperienceEntitiesSummary #
Show ExperienceEntitiesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary Methods showsPrec :: Int -> ExperienceEntitiesSummary -> ShowS # show :: ExperienceEntitiesSummary -> String # showList :: [ExperienceEntitiesSummary] -> ShowS #
NFData ExperienceEntitiesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary Methods rnf :: ExperienceEntitiesSummary -> () #
Eq ExperienceEntitiesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary Methods (==) :: ExperienceEntitiesSummary -> ExperienceEntitiesSummary -> Bool # (/=) :: ExperienceEntitiesSummary -> ExperienceEntitiesSummary -> Bool #
Hashable ExperienceEntitiesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary Methods hashWithSalt :: Int -> ExperienceEntitiesSummary -> Int # hash :: ExperienceEntitiesSummary -> Int #
type Rep ExperienceEntitiesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperienceEntitiesSummary type Rep ExperienceEntitiesSummary = D1 ('MetaData "ExperienceEntitiesSummary" "Amazonka.Kendra.Types.ExperienceEntitiesSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ExperienceEntitiesSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "displayData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityDisplayData)) :: (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityType)))))

newExperienceEntitiesSummary :: ExperienceEntitiesSummary Source #

Create a value of ExperienceEntitiesSummary with all optional fields omitted.

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

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

$sel:displayData:ExperienceEntitiesSummary', experienceEntitiesSummary_displayData - Information about the user entity.

$sel:entityId:ExperienceEntitiesSummary', experienceEntitiesSummary_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:entityType:ExperienceEntitiesSummary', experienceEntitiesSummary_entityType - Shows the type as User or Group.

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

Information about the user entity.

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

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

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

Shows the type as User or Group.

ExperiencesSummary

data ExperiencesSummary Source #

Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

See: newExperiencesSummary smart constructor.

Constructors

ExperiencesSummary'

Fields

createdAt :: Maybe POSIX
The date-time your Amazon Kendra experience was created.
endpoints :: Maybe (NonEmpty ExperienceEndpoint)
The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
id :: Maybe Text
The identifier of your Amazon Kendra experience.
name :: Maybe Text
The name of your Amazon Kendra experience.
status :: Maybe ExperienceStatus
The processing status of your Amazon Kendra experience.

Instances

Instances details

FromJSON ExperiencesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperiencesSummary Methods parseJSON :: Value -> Parser ExperiencesSummary # parseJSONList :: Value -> Parser [ExperiencesSummary] #
Generic ExperiencesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperiencesSummary Associated Types type Rep ExperiencesSummary :: Type -> Type # Methods from :: ExperiencesSummary -> Rep ExperiencesSummary x # to :: Rep ExperiencesSummary x -> ExperiencesSummary #
Read ExperiencesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperiencesSummary Methods readsPrec :: Int -> ReadS ExperiencesSummary # readList :: ReadS [ExperiencesSummary] # readPrec :: ReadPrec ExperiencesSummary # readListPrec :: ReadPrec [ExperiencesSummary] #
Show ExperiencesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperiencesSummary Methods showsPrec :: Int -> ExperiencesSummary -> ShowS # show :: ExperiencesSummary -> String # showList :: [ExperiencesSummary] -> ShowS #
NFData ExperiencesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperiencesSummary Methods rnf :: ExperiencesSummary -> () #
Eq ExperiencesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperiencesSummary Methods (==) :: ExperiencesSummary -> ExperiencesSummary -> Bool # (/=) :: ExperiencesSummary -> ExperiencesSummary -> Bool #
Hashable ExperiencesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperiencesSummary Methods hashWithSalt :: Int -> ExperiencesSummary -> Int # hash :: ExperiencesSummary -> Int #
type Rep ExperiencesSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ExperiencesSummary type Rep ExperiencesSummary = D1 ('MetaData "ExperiencesSummary" "Amazonka.Kendra.Types.ExperiencesSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ExperiencesSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExperienceEndpoint)))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExperienceStatus))))))

newExperiencesSummary :: ExperiencesSummary Source #

Create a value of ExperiencesSummary with all optional fields omitted.

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

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

$sel:createdAt:ExperiencesSummary', experiencesSummary_createdAt - The date-time your Amazon Kendra experience was created.

$sel:endpoints:ExperiencesSummary', experiencesSummary_endpoints - The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

$sel:id:ExperiencesSummary', experiencesSummary_id - The identifier of your Amazon Kendra experience.

$sel:name:ExperiencesSummary', experiencesSummary_name - The name of your Amazon Kendra experience.

$sel:status:ExperiencesSummary', experiencesSummary_status - The processing status of your Amazon Kendra experience.

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

The date-time your Amazon Kendra experience was created.

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

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

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

The identifier of your Amazon Kendra experience.

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

The name of your Amazon Kendra experience.

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

The processing status of your Amazon Kendra experience.

Facet

data Facet Source #

Information about a document attribute. You can use document attributes as facets.

For example, the document attribute or facet "Department" includes the values "HR", "Engineering", and "Accounting". You can display these values in the search results so that documents can be searched by department.

You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support.

See: newFacet smart constructor.

Constructors

Fields

documentAttributeKey :: Maybe Text
The unique key for the document attribute.
facets :: Maybe [Facet]
An array of document attributes that are nested facets within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
maxResults :: Maybe Natural
Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.

Instances

newFacet :: Facet Source #

Create a value of Facet with all optional fields omitted.

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

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

$sel:documentAttributeKey:Facet', facet_documentAttributeKey - The unique key for the document attribute.

$sel:facets:Facet', facet_facets - An array of document attributes that are nested facets within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.

You can only have one nested facet within a facet. If you want to increase this limit, contact Support.

$sel:maxResults:Facet', facet_maxResults - Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.

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

The unique key for the document attribute.

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

An array of document attributes that are nested facets within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.

You can only have one nested facet within a facet. If you want to increase this limit, contact Support.

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

Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.

FacetResult

data FacetResult Source #

The facet values for the documents in the response.

See: newFacetResult smart constructor.

Constructors

FacetResult'

Fields

documentAttributeKey :: Maybe Text
The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.
documentAttributeValueCountPairs :: Maybe [DocumentAttributeValueCountPair]
An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
documentAttributeValueType :: Maybe DocumentAttributeValueType
The data type of the facet value. This is the same as the type defined for the index field when it was created.

Instances

Instances details

FromJSON FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods parseJSON :: Value -> Parser FacetResult # parseJSONList :: Value -> Parser [FacetResult] #
Generic FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Associated Types type Rep FacetResult :: Type -> Type # Methods from :: FacetResult -> Rep FacetResult x # to :: Rep FacetResult x -> FacetResult #
Read FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods readsPrec :: Int -> ReadS FacetResult # readList :: ReadS [FacetResult] # readPrec :: ReadPrec FacetResult # readListPrec :: ReadPrec [FacetResult] #
Show FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods showsPrec :: Int -> FacetResult -> ShowS # show :: FacetResult -> String # showList :: [FacetResult] -> ShowS #
NFData FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods rnf :: FacetResult -> () #
Eq FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods (==) :: FacetResult -> FacetResult -> Bool # (/=) :: FacetResult -> FacetResult -> Bool #
Hashable FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods hashWithSalt :: Int -> FacetResult -> Int # hash :: FacetResult -> Int #
type Rep FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult type Rep FacetResult = D1 ('MetaData "FacetResult" "Amazonka.Kendra.Types.FacetResult" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FacetResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentAttributeValueCountPairs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttributeValueCountPair])) :: S1 ('MetaSel ('Just "documentAttributeValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValueType)))))

newFacetResult :: FacetResult Source #

Create a value of FacetResult with all optional fields omitted.

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

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

$sel:documentAttributeKey:FacetResult', facetResult_documentAttributeKey - The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

$sel:documentAttributeValueCountPairs:FacetResult', facetResult_documentAttributeValueCountPairs - An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

$sel:documentAttributeValueType:FacetResult', facetResult_documentAttributeValueType - The data type of the facet value. This is the same as the type defined for the index field when it was created.

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

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

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

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

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

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

FailedEntity

data FailedEntity Source #

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

See: newFailedEntity smart constructor.

Constructors

FailedEntity'
Fields entityId :: Maybe Text The identifier of the user or group in your IAM Identity Center identity source. For example, a user ID could be an email. errorMessage :: Maybe Text The reason the user or group in your IAM Identity Center identity source failed to properly configure with your Amazon Kendra experience.

Instances

Instances details

FromJSON FailedEntity Source #
Instance details Defined in Amazonka.Kendra.Types.FailedEntity Methods parseJSON :: Value -> Parser FailedEntity # parseJSONList :: Value -> Parser [FailedEntity] #
Generic FailedEntity Source #
Instance details Defined in Amazonka.Kendra.Types.FailedEntity Associated Types type Rep FailedEntity :: Type -> Type # Methods from :: FailedEntity -> Rep FailedEntity x # to :: Rep FailedEntity x -> FailedEntity #
Read FailedEntity Source #
Instance details Defined in Amazonka.Kendra.Types.FailedEntity Methods readsPrec :: Int -> ReadS FailedEntity # readList :: ReadS [FailedEntity] # readPrec :: ReadPrec FailedEntity # readListPrec :: ReadPrec [FailedEntity] #
Show FailedEntity Source #
Instance details Defined in Amazonka.Kendra.Types.FailedEntity Methods showsPrec :: Int -> FailedEntity -> ShowS # show :: FailedEntity -> String # showList :: [FailedEntity] -> ShowS #
NFData FailedEntity Source #
Instance details Defined in Amazonka.Kendra.Types.FailedEntity Methods rnf :: FailedEntity -> () #
Eq FailedEntity Source #
Instance details Defined in Amazonka.Kendra.Types.FailedEntity Methods (==) :: FailedEntity -> FailedEntity -> Bool # (/=) :: FailedEntity -> FailedEntity -> Bool #
Hashable FailedEntity Source #
Instance details Defined in Amazonka.Kendra.Types.FailedEntity Methods hashWithSalt :: Int -> FailedEntity -> Int # hash :: FailedEntity -> Int #
type Rep FailedEntity Source #
Instance details Defined in Amazonka.Kendra.Types.FailedEntity type Rep FailedEntity = D1 ('MetaData "FailedEntity" "Amazonka.Kendra.Types.FailedEntity" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FailedEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newFailedEntity :: FailedEntity Source #

Create a value of FailedEntity with all optional fields omitted.

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

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

$sel:entityId:FailedEntity', failedEntity_entityId - The identifier of the user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:errorMessage:FailedEntity', failedEntity_errorMessage - The reason the user or group in your IAM Identity Center identity source failed to properly configure with your Amazon Kendra experience.

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

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

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

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

FaqStatistics

data FaqStatistics Source #

Provides statistical information about the FAQ questions and answers contained in an index.

See: newFaqStatistics smart constructor.

Constructors

FaqStatistics'
Fields indexedQuestionAnswersCount :: Natural The total number of FAQ questions and answers contained in the index.

Instances

Instances details

FromJSON FaqStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatistics Methods parseJSON :: Value -> Parser FaqStatistics # parseJSONList :: Value -> Parser [FaqStatistics] #
Generic FaqStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatistics Associated Types type Rep FaqStatistics :: Type -> Type # Methods from :: FaqStatistics -> Rep FaqStatistics x # to :: Rep FaqStatistics x -> FaqStatistics #
Read FaqStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatistics Methods readsPrec :: Int -> ReadS FaqStatistics # readList :: ReadS [FaqStatistics] # readPrec :: ReadPrec FaqStatistics # readListPrec :: ReadPrec [FaqStatistics] #
Show FaqStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatistics Methods showsPrec :: Int -> FaqStatistics -> ShowS # show :: FaqStatistics -> String # showList :: [FaqStatistics] -> ShowS #
NFData FaqStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatistics Methods rnf :: FaqStatistics -> () #
Eq FaqStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatistics Methods (==) :: FaqStatistics -> FaqStatistics -> Bool # (/=) :: FaqStatistics -> FaqStatistics -> Bool #
Hashable FaqStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatistics Methods hashWithSalt :: Int -> FaqStatistics -> Int # hash :: FaqStatistics -> Int #
type Rep FaqStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.FaqStatistics type Rep FaqStatistics = D1 ('MetaData "FaqStatistics" "Amazonka.Kendra.Types.FaqStatistics" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FaqStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexedQuestionAnswersCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newFaqStatistics Source #

Arguments

:: Natural	`$sel:indexedQuestionAnswersCount:FaqStatistics'`
-> FaqStatistics

Create a value of FaqStatistics with all optional fields omitted.

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

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

$sel:indexedQuestionAnswersCount:FaqStatistics', faqStatistics_indexedQuestionAnswersCount - The total number of FAQ questions and answers contained in the index.

faqStatistics_indexedQuestionAnswersCount :: Lens' FaqStatistics Natural Source #

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

FaqSummary

data FaqSummary Source #

Summary information for frequently asked questions and answers included in an index.

See: newFaqSummary smart constructor.

Constructors

FaqSummary'

Fields

createdAt :: Maybe POSIX
The UNIX datetime that the FAQ was added to the index.
fileFormat :: Maybe FaqFileFormat
The file type used to create the FAQ.
id :: Maybe Text
The identifier of the FAQ.
languageCode :: Maybe Text
The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
name :: Maybe Text
The name that you assigned the FAQ when you created or updated the FAQ.
status :: Maybe FaqStatus
The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.
updatedAt :: Maybe POSIX
The UNIX datetime that the FAQ was last updated.

Instances

Instances details

FromJSON FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods parseJSON :: Value -> Parser FaqSummary # parseJSONList :: Value -> Parser [FaqSummary] #
Generic FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Associated Types type Rep FaqSummary :: Type -> Type # Methods from :: FaqSummary -> Rep FaqSummary x # to :: Rep FaqSummary x -> FaqSummary #
Read FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods readsPrec :: Int -> ReadS FaqSummary # readList :: ReadS [FaqSummary] # readPrec :: ReadPrec FaqSummary # readListPrec :: ReadPrec [FaqSummary] #
Show FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods showsPrec :: Int -> FaqSummary -> ShowS # show :: FaqSummary -> String # showList :: [FaqSummary] -> ShowS #
NFData FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods rnf :: FaqSummary -> () #
Eq FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods (==) :: FaqSummary -> FaqSummary -> Bool # (/=) :: FaqSummary -> FaqSummary -> Bool #
Hashable FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods hashWithSalt :: Int -> FaqSummary -> Int # hash :: FaqSummary -> Int #
type Rep FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary type Rep FaqSummary = D1 ('MetaData "FaqSummary" "Amazonka.Kendra.Types.FaqSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FaqSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "fileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqFileFormat)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqStatus)) :: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newFaqSummary :: FaqSummary Source #

Create a value of FaqSummary with all optional fields omitted.

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

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

$sel:createdAt:FaqSummary', faqSummary_createdAt - The UNIX datetime that the FAQ was added to the index.

$sel:fileFormat:FaqSummary', faqSummary_fileFormat - The file type used to create the FAQ.

$sel:id:FaqSummary', faqSummary_id - The identifier of the FAQ.

$sel:languageCode:FaqSummary', faqSummary_languageCode - The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

$sel:name:FaqSummary', faqSummary_name - The name that you assigned the FAQ when you created or updated the FAQ.

$sel:status:FaqSummary', faqSummary_status - The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

$sel:updatedAt:FaqSummary', faqSummary_updatedAt - The UNIX datetime that the FAQ was last updated.

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

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

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

The file type used to create the FAQ.

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

The identifier of the FAQ.

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

The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

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

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

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

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

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

The UNIX datetime that the FAQ was last updated.

FsxConfiguration

data FsxConfiguration Source #

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

See: newFsxConfiguration smart constructor.

Constructors

FsxConfiguration'

Fields

exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
secretArn :: Maybe Text
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:
- username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.
- password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.
fileSystemId :: Text
The identifier of the Amazon FSx file system.
You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.
fileSystemType :: FsxFileSystemType
The Amazon FSx file system type. Windows is currently the only supported type.
vpcConfiguration :: DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

Instances

Instances details

FromJSON FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration Methods parseJSON :: Value -> Parser FsxConfiguration # parseJSONList :: Value -> Parser [FsxConfiguration] #
ToJSON FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration Methods toJSON :: FsxConfiguration -> Value # toEncoding :: FsxConfiguration -> Encoding # toJSONList :: [FsxConfiguration] -> Value # toEncodingList :: [FsxConfiguration] -> Encoding #
Generic FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration Associated Types type Rep FsxConfiguration :: Type -> Type # Methods from :: FsxConfiguration -> Rep FsxConfiguration x # to :: Rep FsxConfiguration x -> FsxConfiguration #
Read FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration Methods readsPrec :: Int -> ReadS FsxConfiguration # readList :: ReadS [FsxConfiguration] # readPrec :: ReadPrec FsxConfiguration # readListPrec :: ReadPrec [FsxConfiguration] #
Show FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration Methods showsPrec :: Int -> FsxConfiguration -> ShowS # show :: FsxConfiguration -> String # showList :: [FsxConfiguration] -> ShowS #
NFData FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration Methods rnf :: FsxConfiguration -> () #
Eq FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration Methods (==) :: FsxConfiguration -> FsxConfiguration -> Bool # (/=) :: FsxConfiguration -> FsxConfiguration -> Bool #
Hashable FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration Methods hashWithSalt :: Int -> FsxConfiguration -> Int # hash :: FsxConfiguration -> Int #
type Rep FsxConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.FsxConfiguration type Rep FsxConfiguration = D1 ('MetaData "FsxConfiguration" "Amazonka.Kendra.Types.FsxConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FsxConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "fileSystemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FsxFileSystemType) :: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataSourceVpcConfiguration)))))

newFsxConfiguration Source #

Arguments

:: Text	`$sel:fileSystemId:FsxConfiguration'`
-> FsxFileSystemType	`$sel:fileSystemType:FsxConfiguration'`
-> DataSourceVpcConfiguration	`$sel:vpcConfiguration:FsxConfiguration'`
-> FsxConfiguration

Create a value of FsxConfiguration with all optional fields omitted.

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

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

$sel:exclusionPatterns:FsxConfiguration', fsxConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:fieldMappings:FsxConfiguration', fsxConfiguration_fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.

$sel:inclusionPatterns:FsxConfiguration', fsxConfiguration_inclusionPatterns - A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:secretArn:FsxConfiguration', fsxConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:

username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.

$sel:fileSystemId:FsxConfiguration', fsxConfiguration_fileSystemId - The identifier of the Amazon FSx file system.

You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.

$sel:fileSystemType:FsxConfiguration', fsxConfiguration_fileSystemType - The Amazon FSx file system type. Windows is currently the only supported type.

$sel:vpcConfiguration:FsxConfiguration', fsxConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

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

A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.

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

A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:

username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.

fsxConfiguration_fileSystemId :: Lens' FsxConfiguration Text Source #

The identifier of the Amazon FSx file system.

You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.

fsxConfiguration_fileSystemType :: Lens' FsxConfiguration FsxFileSystemType Source #

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

fsxConfiguration_vpcConfiguration :: Lens' FsxConfiguration DataSourceVpcConfiguration Source #

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

GitHubConfiguration

data GitHubConfiguration Source #

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

See: newGitHubConfiguration smart constructor.

Constructors

GitHubConfiguration'

Fields

exclusionFileNamePatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain file names in your GitHub repository or repositories. File names that match the patterns are excluded from the index. File names that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
exclusionFileTypePatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain file types in your GitHub repository or repositories. File types that match the patterns are excluded from the index. File types that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
exclusionFolderNamePatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain folder names in your GitHub repository or repositories. Folder names that match the patterns are excluded from the index. Folder names that don't match the patterns are included in the index. If a folder matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.
gitHubCommitConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub commits to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.
gitHubDocumentCrawlProperties :: Maybe GitHubDocumentCrawlProperties
Configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.
gitHubIssueAttachmentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.
gitHubIssueCommentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.
gitHubIssueDocumentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.
gitHubPullRequestCommentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull request comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.
gitHubPullRequestDocumentAttachmentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull request attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.
gitHubPullRequestDocumentConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull requests to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.
gitHubRepositoryConfigurationFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map GitHub repository attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.
inclusionFileNamePatterns :: Maybe [Text]
A list of regular expression patterns to include certain file names in your GitHub repository or repositories. File names that match the patterns are included in the index. File names that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
inclusionFileTypePatterns :: Maybe [Text]
A list of regular expression patterns to include certain file types in your GitHub repository or repositories. File types that match the patterns are included in the index. File types that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
inclusionFolderNamePatterns :: Maybe [Text]
A list of regular expression patterns to include certain folder names in your GitHub repository or repositories. Folder names that match the patterns are included in the index. Folder names that don't match the patterns are excluded from the index. If a folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.
onPremiseConfiguration :: Maybe OnPremiseConfiguration
Configuration information to connect to GitHub Enterprise Server (on premises).
repositoryFilter :: Maybe [Text]
A list of names of the specific repositories you want to index.
saaSConfiguration :: Maybe SaaSConfiguration
Configuration information to connect to GitHub Enterprise Cloud (SaaS).
type' :: Maybe Type
The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).
useChangeLog :: Maybe Bool
TRUE to use the GitHub change log to determine which documents require updating in the index. Depending on the GitHub change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in GitHub.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC.
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your GitHub. The secret must contain a JSON structure with the following keys:
- personalToken—The access token created in GitHub. For more information on creating a token in GitHub, see Using a GitHub data source.

Instances

Instances details

FromJSON GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration Methods parseJSON :: Value -> Parser GitHubConfiguration # parseJSONList :: Value -> Parser [GitHubConfiguration] #
ToJSON GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration Methods toJSON :: GitHubConfiguration -> Value # toEncoding :: GitHubConfiguration -> Encoding # toJSONList :: [GitHubConfiguration] -> Value # toEncodingList :: [GitHubConfiguration] -> Encoding #
Generic GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration Associated Types type Rep GitHubConfiguration :: Type -> Type # Methods from :: GitHubConfiguration -> Rep GitHubConfiguration x # to :: Rep GitHubConfiguration x -> GitHubConfiguration #
Read GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration Methods readsPrec :: Int -> ReadS GitHubConfiguration # readList :: ReadS [GitHubConfiguration] # readPrec :: ReadPrec GitHubConfiguration # readListPrec :: ReadPrec [GitHubConfiguration] #
Show GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration Methods showsPrec :: Int -> GitHubConfiguration -> ShowS # show :: GitHubConfiguration -> String # showList :: [GitHubConfiguration] -> ShowS #
NFData GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration Methods rnf :: GitHubConfiguration -> () #
Eq GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration Methods (==) :: GitHubConfiguration -> GitHubConfiguration -> Bool # (/=) :: GitHubConfiguration -> GitHubConfiguration -> Bool #
Hashable GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration Methods hashWithSalt :: Int -> GitHubConfiguration -> Int # hash :: GitHubConfiguration -> Int #
type Rep GitHubConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubConfiguration type Rep GitHubConfiguration = D1 ('MetaData "GitHubConfiguration" "Amazonka.Kendra.Types.GitHubConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GitHubConfiguration'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "exclusionFileNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "exclusionFileTypePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "exclusionFolderNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "gitHubCommitConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "gitHubDocumentCrawlProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GitHubDocumentCrawlProperties))))) :: ((S1 ('MetaSel ('Just "gitHubIssueAttachmentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "gitHubIssueCommentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "gitHubIssueDocumentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :: (S1 ('MetaSel ('Just "gitHubPullRequestCommentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "gitHubPullRequestDocumentAttachmentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "gitHubPullRequestDocumentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))))) :: (((S1 ('MetaSel ('Just "gitHubRepositoryConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "inclusionFileNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "inclusionFileTypePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "inclusionFolderNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "onPremiseConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnPremiseConfiguration))))) :: ((S1 ('MetaSel ('Just "repositoryFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "saaSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SaaSConfiguration)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Type)))) :: (S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newGitHubConfiguration Source #

Arguments

:: Text	`$sel:secretArn:GitHubConfiguration'`
-> GitHubConfiguration

Create a value of GitHubConfiguration with all optional fields omitted.

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

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

$sel:exclusionFileNamePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFileNamePatterns - A list of regular expression patterns to exclude certain file names in your GitHub repository or repositories. File names that match the patterns are excluded from the index. File names that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:exclusionFileTypePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFileTypePatterns - A list of regular expression patterns to exclude certain file types in your GitHub repository or repositories. File types that match the patterns are excluded from the index. File types that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:exclusionFolderNamePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFolderNamePatterns - A list of regular expression patterns to exclude certain folder names in your GitHub repository or repositories. Folder names that match the patterns are excluded from the index. Folder names that don't match the patterns are included in the index. If a folder matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.

$sel:gitHubCommitConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubCommitConfigurationFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub commits to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

$sel:gitHubDocumentCrawlProperties:GitHubConfiguration', gitHubConfiguration_gitHubDocumentCrawlProperties - Configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

$sel:gitHubIssueAttachmentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueAttachmentConfigurationFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

$sel:gitHubIssueCommentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueCommentConfigurationFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

$sel:gitHubIssueDocumentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueDocumentConfigurationFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

$sel:gitHubPullRequestCommentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestCommentConfigurationFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull request comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

$sel:gitHubPullRequestDocumentAttachmentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestDocumentAttachmentConfigurationFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull request attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

$sel:gitHubPullRequestDocumentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestDocumentConfigurationFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull requests to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

$sel:gitHubRepositoryConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubRepositoryConfigurationFieldMappings - A list of DataSourceToIndexFieldMapping objects that map GitHub repository attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

$sel:inclusionFileNamePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFileNamePatterns - A list of regular expression patterns to include certain file names in your GitHub repository or repositories. File names that match the patterns are included in the index. File names that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:inclusionFileTypePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFileTypePatterns - A list of regular expression patterns to include certain file types in your GitHub repository or repositories. File types that match the patterns are included in the index. File types that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:inclusionFolderNamePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFolderNamePatterns - A list of regular expression patterns to include certain folder names in your GitHub repository or repositories. Folder names that match the patterns are included in the index. Folder names that don't match the patterns are excluded from the index. If a folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.

$sel:onPremiseConfiguration:GitHubConfiguration', gitHubConfiguration_onPremiseConfiguration - Configuration information to connect to GitHub Enterprise Server (on premises).

$sel:repositoryFilter:GitHubConfiguration', gitHubConfiguration_repositoryFilter - A list of names of the specific repositories you want to index.

$sel:saaSConfiguration:GitHubConfiguration', gitHubConfiguration_saaSConfiguration - Configuration information to connect to GitHub Enterprise Cloud (SaaS).

$sel:type':GitHubConfiguration', gitHubConfiguration_type - The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).

$sel:useChangeLog:GitHubConfiguration', gitHubConfiguration_useChangeLog - TRUE to use the GitHub change log to determine which documents require updating in the index. Depending on the GitHub change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in GitHub.

$sel:vpcConfiguration:GitHubConfiguration', gitHubConfiguration_vpcConfiguration - Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC.

$sel:secretArn:GitHubConfiguration', gitHubConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your GitHub. The secret must contain a JSON structure with the following keys:

personalToken—The access token created in GitHub. For more information on creating a token in GitHub, see Using a GitHub data source.

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

A list of regular expression patterns to exclude certain file names in your GitHub repository or repositories. File names that match the patterns are excluded from the index. File names that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to exclude certain file types in your GitHub repository or repositories. File types that match the patterns are excluded from the index. File types that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to exclude certain folder names in your GitHub repository or repositories. Folder names that match the patterns are excluded from the index. Folder names that don't match the patterns are included in the index. If a folder matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub commits to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

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

Configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issue comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull request comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull request attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

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

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of GitHub pull requests to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

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

A list of DataSourceToIndexFieldMapping objects that map GitHub repository attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to GitHub fields. For more information, see Mapping data source fields. The GitHub data source field names must exist in your GitHub custom metadata.

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

A list of regular expression patterns to include certain file names in your GitHub repository or repositories. File names that match the patterns are included in the index. File names that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to include certain file types in your GitHub repository or repositories. File types that match the patterns are included in the index. File types that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

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

A list of regular expression patterns to include certain folder names in your GitHub repository or repositories. Folder names that match the patterns are included in the index. Folder names that don't match the patterns are excluded from the index. If a folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.

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

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

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

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

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

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

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

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

gitHubConfiguration_useChangeLog :: Lens' GitHubConfiguration (Maybe Bool) Source #

TRUE to use the GitHub change log to determine which documents require updating in the index. Depending on the GitHub change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in GitHub.

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

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

gitHubConfiguration_secretArn :: Lens' GitHubConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your GitHub. The secret must contain a JSON structure with the following keys:

personalToken—The access token created in GitHub. For more information on creating a token in GitHub, see Using a GitHub data source.

GitHubDocumentCrawlProperties

data GitHubDocumentCrawlProperties Source #

Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

See: newGitHubDocumentCrawlProperties smart constructor.

Constructors

GitHubDocumentCrawlProperties'

Fields

crawlIssue :: Maybe Bool
TRUE to index all issues within a repository.
crawlIssueComment :: Maybe Bool
TRUE to index all comments on issues.
crawlIssueCommentAttachment :: Maybe Bool
TRUE to include all comment attachments for issues.
crawlPullRequest :: Maybe Bool
TRUE to index all pull requests within a repository.
crawlPullRequestComment :: Maybe Bool
TRUE to index all comments on pull requests.
crawlPullRequestCommentAttachment :: Maybe Bool
TRUE to include all comment attachments for pull requests.
crawlRepositoryDocuments :: Maybe Bool
TRUE to index all files with a repository.

Instances

Instances details

FromJSON GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties Methods parseJSON :: Value -> Parser GitHubDocumentCrawlProperties # parseJSONList :: Value -> Parser [GitHubDocumentCrawlProperties] #
ToJSON GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties Methods toJSON :: GitHubDocumentCrawlProperties -> Value # toEncoding :: GitHubDocumentCrawlProperties -> Encoding # toJSONList :: [GitHubDocumentCrawlProperties] -> Value # toEncodingList :: [GitHubDocumentCrawlProperties] -> Encoding #
Generic GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties Associated Types type Rep GitHubDocumentCrawlProperties :: Type -> Type # Methods from :: GitHubDocumentCrawlProperties -> Rep GitHubDocumentCrawlProperties x # to :: Rep GitHubDocumentCrawlProperties x -> GitHubDocumentCrawlProperties #
Read GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties Methods readsPrec :: Int -> ReadS GitHubDocumentCrawlProperties # readList :: ReadS [GitHubDocumentCrawlProperties] # readPrec :: ReadPrec GitHubDocumentCrawlProperties # readListPrec :: ReadPrec [GitHubDocumentCrawlProperties] #
Show GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties Methods showsPrec :: Int -> GitHubDocumentCrawlProperties -> ShowS # show :: GitHubDocumentCrawlProperties -> String # showList :: [GitHubDocumentCrawlProperties] -> ShowS #
NFData GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties Methods rnf :: GitHubDocumentCrawlProperties -> () #
Eq GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties Methods (==) :: GitHubDocumentCrawlProperties -> GitHubDocumentCrawlProperties -> Bool # (/=) :: GitHubDocumentCrawlProperties -> GitHubDocumentCrawlProperties -> Bool #
Hashable GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties Methods hashWithSalt :: Int -> GitHubDocumentCrawlProperties -> Int # hash :: GitHubDocumentCrawlProperties -> Int #
type Rep GitHubDocumentCrawlProperties Source #
Instance details Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties type Rep GitHubDocumentCrawlProperties = D1 ('MetaData "GitHubDocumentCrawlProperties" "Amazonka.Kendra.Types.GitHubDocumentCrawlProperties" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GitHubDocumentCrawlProperties'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlIssue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "crawlIssueComment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "crawlIssueCommentAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "crawlPullRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "crawlPullRequestComment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "crawlPullRequestCommentAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "crawlRepositoryDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newGitHubDocumentCrawlProperties :: GitHubDocumentCrawlProperties Source #

Create a value of GitHubDocumentCrawlProperties with all optional fields omitted.

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:crawlIssue:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlIssue - TRUE to index all issues within a repository.

$sel:crawlIssueComment:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlIssueComment - TRUE to index all comments on issues.

$sel:crawlIssueCommentAttachment:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlIssueCommentAttachment - TRUE to include all comment attachments for issues.

$sel:crawlPullRequest:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlPullRequest - TRUE to index all pull requests within a repository.

$sel:crawlPullRequestComment:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlPullRequestComment - TRUE to index all comments on pull requests.

$sel:crawlPullRequestCommentAttachment:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlPullRequestCommentAttachment - TRUE to include all comment attachments for pull requests.

$sel:crawlRepositoryDocuments:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlRepositoryDocuments - TRUE to index all files with a repository.

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

TRUE to index all issues within a repository.

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

TRUE to index all comments on issues.

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

TRUE to include all comment attachments for issues.

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

TRUE to index all pull requests within a repository.

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

TRUE to index all comments on pull requests.

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

TRUE to include all comment attachments for pull requests.

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

TRUE to index all files with a repository.

GoogleDriveConfiguration

data GoogleDriveConfiguration Source #

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

See: newGoogleDriveConfiguration smart constructor.

Constructors

GoogleDriveConfiguration'

Fields

excludeMimeTypes :: Maybe [Text]
A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.
For a list of MIME types, see Using a Google Workspace Drive data source.
excludeSharedDrives :: Maybe [Text]
A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
excludeUserAccounts :: Maybe [Text]
A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive custom metadata.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
secretArn :: Text
The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

Instances

Instances details

FromJSON GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration Methods parseJSON :: Value -> Parser GoogleDriveConfiguration # parseJSONList :: Value -> Parser [GoogleDriveConfiguration] #
ToJSON GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration Methods toJSON :: GoogleDriveConfiguration -> Value # toEncoding :: GoogleDriveConfiguration -> Encoding # toJSONList :: [GoogleDriveConfiguration] -> Value # toEncodingList :: [GoogleDriveConfiguration] -> Encoding #
Generic GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration Associated Types type Rep GoogleDriveConfiguration :: Type -> Type # Methods from :: GoogleDriveConfiguration -> Rep GoogleDriveConfiguration x # to :: Rep GoogleDriveConfiguration x -> GoogleDriveConfiguration #
Read GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration Methods readsPrec :: Int -> ReadS GoogleDriveConfiguration # readList :: ReadS [GoogleDriveConfiguration] # readPrec :: ReadPrec GoogleDriveConfiguration # readListPrec :: ReadPrec [GoogleDriveConfiguration] #
Show GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration Methods showsPrec :: Int -> GoogleDriveConfiguration -> ShowS # show :: GoogleDriveConfiguration -> String # showList :: [GoogleDriveConfiguration] -> ShowS #
NFData GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration Methods rnf :: GoogleDriveConfiguration -> () #
Eq GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration Methods (==) :: GoogleDriveConfiguration -> GoogleDriveConfiguration -> Bool # (/=) :: GoogleDriveConfiguration -> GoogleDriveConfiguration -> Bool #
Hashable GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration Methods hashWithSalt :: Int -> GoogleDriveConfiguration -> Int # hash :: GoogleDriveConfiguration -> Int #
type Rep GoogleDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration type Rep GoogleDriveConfiguration = D1 ('MetaData "GoogleDriveConfiguration" "Amazonka.Kendra.Types.GoogleDriveConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GoogleDriveConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "excludeMimeTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "excludeSharedDrives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "excludeUserAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGoogleDriveConfiguration Source #

Arguments

:: Text	`$sel:secretArn:GoogleDriveConfiguration'`
-> GoogleDriveConfiguration

Create a value of GoogleDriveConfiguration with all optional fields omitted.

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

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

$sel:excludeMimeTypes:GoogleDriveConfiguration', googleDriveConfiguration_excludeMimeTypes - A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source.

$sel:excludeSharedDrives:GoogleDriveConfiguration', googleDriveConfiguration_excludeSharedDrives - A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

$sel:excludeUserAccounts:GoogleDriveConfiguration', googleDriveConfiguration_excludeUserAccounts - A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

$sel:exclusionPatterns:GoogleDriveConfiguration', googleDriveConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

$sel:fieldMappings:GoogleDriveConfiguration', googleDriveConfiguration_fieldMappings - Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive custom metadata.

$sel:inclusionPatterns:GoogleDriveConfiguration', googleDriveConfiguration_inclusionPatterns - A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

$sel:secretArn:GoogleDriveConfiguration', googleDriveConfiguration_secretArn - The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

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

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source.

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

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

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

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

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

A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

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

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

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

A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

googleDriveConfiguration_secretArn :: Lens' GoogleDriveConfiguration Text Source #

The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

GroupMembers

data GroupMembers Source #

A list of users or sub groups that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

See: newGroupMembers smart constructor.

Constructors

GroupMembers'

Fields

memberGroups :: Maybe (NonEmpty MemberGroup)
A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".
memberUsers :: Maybe (NonEmpty MemberUser)
A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
s3PathforGroupMembers :: Maybe S3Path
If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

Instances

Instances details

ToJSON GroupMembers Source #
Instance details Defined in Amazonka.Kendra.Types.GroupMembers Methods toJSON :: GroupMembers -> Value # toEncoding :: GroupMembers -> Encoding # toJSONList :: [GroupMembers] -> Value # toEncodingList :: [GroupMembers] -> Encoding #
Generic GroupMembers Source #
Instance details Defined in Amazonka.Kendra.Types.GroupMembers Associated Types type Rep GroupMembers :: Type -> Type # Methods from :: GroupMembers -> Rep GroupMembers x # to :: Rep GroupMembers x -> GroupMembers #
Read GroupMembers Source #
Instance details Defined in Amazonka.Kendra.Types.GroupMembers Methods readsPrec :: Int -> ReadS GroupMembers # readList :: ReadS [GroupMembers] # readPrec :: ReadPrec GroupMembers # readListPrec :: ReadPrec [GroupMembers] #
Show GroupMembers Source #
Instance details Defined in Amazonka.Kendra.Types.GroupMembers Methods showsPrec :: Int -> GroupMembers -> ShowS # show :: GroupMembers -> String # showList :: [GroupMembers] -> ShowS #
NFData GroupMembers Source #
Instance details Defined in Amazonka.Kendra.Types.GroupMembers Methods rnf :: GroupMembers -> () #
Eq GroupMembers Source #
Instance details Defined in Amazonka.Kendra.Types.GroupMembers Methods (==) :: GroupMembers -> GroupMembers -> Bool # (/=) :: GroupMembers -> GroupMembers -> Bool #
Hashable GroupMembers Source #
Instance details Defined in Amazonka.Kendra.Types.GroupMembers Methods hashWithSalt :: Int -> GroupMembers -> Int # hash :: GroupMembers -> Int #
type Rep GroupMembers Source #
Instance details Defined in Amazonka.Kendra.Types.GroupMembers type Rep GroupMembers = D1 ('MetaData "GroupMembers" "Amazonka.Kendra.Types.GroupMembers" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GroupMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "memberGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty MemberGroup))) :: (S1 ('MetaSel ('Just "memberUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty MemberUser))) :: S1 ('MetaSel ('Just "s3PathforGroupMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)))))

newGroupMembers :: GroupMembers Source #

Create a value of GroupMembers with all optional fields omitted.

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

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

$sel:memberGroups:GroupMembers', groupMembers_memberGroups - A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

$sel:memberUsers:GroupMembers', groupMembers_memberUsers - A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

$sel:s3PathforGroupMembers:GroupMembers', groupMembers_s3PathforGroupMembers - If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

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

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

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

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

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

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

GroupOrderingIdSummary

data GroupOrderingIdSummary Source #

Summary information on the processing of PUT and DELETE actions for mapping users to their groups.

See: newGroupOrderingIdSummary smart constructor.

Constructors

GroupOrderingIdSummary'

Fields

failureReason :: Maybe Text
The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.
lastUpdatedAt :: Maybe POSIX
The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.
orderingId :: Maybe Natural
The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.
receivedAt :: Maybe POSIX
The date-time an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.
status :: Maybe PrincipalMappingStatus
The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

Instances

Instances details

FromJSON GroupOrderingIdSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary Methods parseJSON :: Value -> Parser GroupOrderingIdSummary # parseJSONList :: Value -> Parser [GroupOrderingIdSummary] #
Generic GroupOrderingIdSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary Associated Types type Rep GroupOrderingIdSummary :: Type -> Type # Methods from :: GroupOrderingIdSummary -> Rep GroupOrderingIdSummary x # to :: Rep GroupOrderingIdSummary x -> GroupOrderingIdSummary #
Read GroupOrderingIdSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary Methods readsPrec :: Int -> ReadS GroupOrderingIdSummary # readList :: ReadS [GroupOrderingIdSummary] # readPrec :: ReadPrec GroupOrderingIdSummary # readListPrec :: ReadPrec [GroupOrderingIdSummary] #
Show GroupOrderingIdSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary Methods showsPrec :: Int -> GroupOrderingIdSummary -> ShowS # show :: GroupOrderingIdSummary -> String # showList :: [GroupOrderingIdSummary] -> ShowS #
NFData GroupOrderingIdSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary Methods rnf :: GroupOrderingIdSummary -> () #
Eq GroupOrderingIdSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary Methods (==) :: GroupOrderingIdSummary -> GroupOrderingIdSummary -> Bool # (/=) :: GroupOrderingIdSummary -> GroupOrderingIdSummary -> Bool #
Hashable GroupOrderingIdSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary Methods hashWithSalt :: Int -> GroupOrderingIdSummary -> Int # hash :: GroupOrderingIdSummary -> Int #
type Rep GroupOrderingIdSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupOrderingIdSummary type Rep GroupOrderingIdSummary = D1 ('MetaData "GroupOrderingIdSummary" "Amazonka.Kendra.Types.GroupOrderingIdSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GroupOrderingIdSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "orderingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "receivedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrincipalMappingStatus))))))

newGroupOrderingIdSummary :: GroupOrderingIdSummary Source #

Create a value of GroupOrderingIdSummary with all optional fields omitted.

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

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

$sel:failureReason:GroupOrderingIdSummary', groupOrderingIdSummary_failureReason - The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.

$sel:lastUpdatedAt:GroupOrderingIdSummary', groupOrderingIdSummary_lastUpdatedAt - The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.

$sel:orderingId:GroupOrderingIdSummary', groupOrderingIdSummary_orderingId - The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.

$sel:receivedAt:GroupOrderingIdSummary', groupOrderingIdSummary_receivedAt - The date-time an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

$sel:status:GroupOrderingIdSummary', groupOrderingIdSummary_status - The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

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

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

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

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

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

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

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

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

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

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

GroupSummary

data GroupSummary Source #

Summary information for groups.

See: newGroupSummary smart constructor.

Constructors

GroupSummary'
Fields groupId :: Maybe Text The identifier of the group you want group summary information on. orderingId :: Maybe Natural The timestamp identifier used for the latest `PUT` or `DELETE` action.

Instances

Instances details

FromJSON GroupSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupSummary Methods parseJSON :: Value -> Parser GroupSummary # parseJSONList :: Value -> Parser [GroupSummary] #
Generic GroupSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupSummary Associated Types type Rep GroupSummary :: Type -> Type # Methods from :: GroupSummary -> Rep GroupSummary x # to :: Rep GroupSummary x -> GroupSummary #
Read GroupSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupSummary Methods readsPrec :: Int -> ReadS GroupSummary # readList :: ReadS [GroupSummary] # readPrec :: ReadPrec GroupSummary # readListPrec :: ReadPrec [GroupSummary] #
Show GroupSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupSummary Methods showsPrec :: Int -> GroupSummary -> ShowS # show :: GroupSummary -> String # showList :: [GroupSummary] -> ShowS #
NFData GroupSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupSummary Methods rnf :: GroupSummary -> () #
Eq GroupSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupSummary Methods (==) :: GroupSummary -> GroupSummary -> Bool # (/=) :: GroupSummary -> GroupSummary -> Bool #
Hashable GroupSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupSummary Methods hashWithSalt :: Int -> GroupSummary -> Int # hash :: GroupSummary -> Int #
type Rep GroupSummary Source #
Instance details Defined in Amazonka.Kendra.Types.GroupSummary type Rep GroupSummary = D1 ('MetaData "GroupSummary" "Amazonka.Kendra.Types.GroupSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GroupSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "orderingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newGroupSummary :: GroupSummary Source #

Create a value of GroupSummary with all optional fields omitted.

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

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

$sel:groupId:GroupSummary', groupSummary_groupId - The identifier of the group you want group summary information on.

$sel:orderingId:GroupSummary', groupSummary_orderingId - The timestamp identifier used for the latest PUT or DELETE action.

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

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

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

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

HierarchicalPrincipal

data HierarchicalPrincipal Source #

Information to define the hierarchy for which documents users should have access to.

See: newHierarchicalPrincipal smart constructor.

Constructors

HierarchicalPrincipal'
Fields principalList :: [Principal] A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.

Instances

Instances details

FromJSON HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal Methods parseJSON :: Value -> Parser HierarchicalPrincipal # parseJSONList :: Value -> Parser [HierarchicalPrincipal] #
ToJSON HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal Methods toJSON :: HierarchicalPrincipal -> Value # toEncoding :: HierarchicalPrincipal -> Encoding # toJSONList :: [HierarchicalPrincipal] -> Value # toEncodingList :: [HierarchicalPrincipal] -> Encoding #
Generic HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal Associated Types type Rep HierarchicalPrincipal :: Type -> Type # Methods from :: HierarchicalPrincipal -> Rep HierarchicalPrincipal x # to :: Rep HierarchicalPrincipal x -> HierarchicalPrincipal #
Read HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal Methods readsPrec :: Int -> ReadS HierarchicalPrincipal # readList :: ReadS [HierarchicalPrincipal] # readPrec :: ReadPrec HierarchicalPrincipal # readListPrec :: ReadPrec [HierarchicalPrincipal] #
Show HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal Methods showsPrec :: Int -> HierarchicalPrincipal -> ShowS # show :: HierarchicalPrincipal -> String # showList :: [HierarchicalPrincipal] -> ShowS #
NFData HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal Methods rnf :: HierarchicalPrincipal -> () #
Eq HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal Methods (==) :: HierarchicalPrincipal -> HierarchicalPrincipal -> Bool # (/=) :: HierarchicalPrincipal -> HierarchicalPrincipal -> Bool #
Hashable HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal Methods hashWithSalt :: Int -> HierarchicalPrincipal -> Int # hash :: HierarchicalPrincipal -> Int #
type Rep HierarchicalPrincipal Source #
Instance details Defined in Amazonka.Kendra.Types.HierarchicalPrincipal type Rep HierarchicalPrincipal = D1 ('MetaData "HierarchicalPrincipal" "Amazonka.Kendra.Types.HierarchicalPrincipal" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "HierarchicalPrincipal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "principalList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Principal])))

newHierarchicalPrincipal :: HierarchicalPrincipal Source #

Create a value of HierarchicalPrincipal with all optional fields omitted.

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

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

$sel:principalList:HierarchicalPrincipal', hierarchicalPrincipal_principalList - A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.

hierarchicalPrincipal_principalList :: Lens' HierarchicalPrincipal [Principal] Source #

A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.

Highlight

data Highlight Source #

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

See: newHighlight smart constructor.

Constructors

Highlight'
Fields topAnswer :: Maybe Bool Indicates whether the response is the best response. True if this is the best response; otherwise, false. type' :: Maybe HighlightType The highlight type. beginOffset :: Int The zero-based location in the response string where the highlight starts. endOffset :: Int The zero-based location in the response string where the highlight ends.

Instances

Instances details

FromJSON Highlight Source #
Instance details Defined in Amazonka.Kendra.Types.Highlight Methods parseJSON :: Value -> Parser Highlight # parseJSONList :: Value -> Parser [Highlight] #
Generic Highlight Source #
Instance details Defined in Amazonka.Kendra.Types.Highlight Associated Types type Rep Highlight :: Type -> Type # Methods from :: Highlight -> Rep Highlight x # to :: Rep Highlight x -> Highlight #
Read Highlight Source #
Instance details Defined in Amazonka.Kendra.Types.Highlight Methods readsPrec :: Int -> ReadS Highlight # readList :: ReadS [Highlight] # readPrec :: ReadPrec Highlight # readListPrec :: ReadPrec [Highlight] #
Show Highlight Source #
Instance details Defined in Amazonka.Kendra.Types.Highlight Methods showsPrec :: Int -> Highlight -> ShowS # show :: Highlight -> String # showList :: [Highlight] -> ShowS #
NFData Highlight Source #
Instance details Defined in Amazonka.Kendra.Types.Highlight Methods rnf :: Highlight -> () #
Eq Highlight Source #
Instance details Defined in Amazonka.Kendra.Types.Highlight Methods (==) :: Highlight -> Highlight -> Bool # (/=) :: Highlight -> Highlight -> Bool #
Hashable Highlight Source #
Instance details Defined in Amazonka.Kendra.Types.Highlight Methods hashWithSalt :: Int -> Highlight -> Int # hash :: Highlight -> Int #
type Rep Highlight Source #
Instance details Defined in Amazonka.Kendra.Types.Highlight type Rep Highlight = D1 ('MetaData "Highlight" "Amazonka.Kendra.Types.Highlight" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Highlight'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "topAnswer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HighlightType))) :: (S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newHighlight Source #

Arguments

:: Int	`$sel:beginOffset:Highlight'`
-> Int	`$sel:endOffset:Highlight'`
-> Highlight

Create a value of Highlight with all optional fields omitted.

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

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

$sel:topAnswer:Highlight', highlight_topAnswer - Indicates whether the response is the best response. True if this is the best response; otherwise, false.

$sel:type':Highlight', highlight_type - The highlight type.

$sel:beginOffset:Highlight', highlight_beginOffset - The zero-based location in the response string where the highlight starts.

$sel:endOffset:Highlight', highlight_endOffset - The zero-based location in the response string where the highlight ends.

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

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

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

The highlight type.

highlight_beginOffset :: Lens' Highlight Int Source #

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

highlight_endOffset :: Lens' Highlight Int Source #

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

HookConfiguration

data HookConfiguration Source #

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using PostExtractionHookConfiguration. You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Customizing document metadata during the ingestion process.

See: newHookConfiguration smart constructor.

Constructors

HookConfiguration'

Fields

invocationCondition :: Maybe DocumentAttributeCondition
The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.
lambdaArn :: Text
The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Amazon Kendra.
s3Bucket :: Text
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

Instances

Instances details

FromJSON HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration Methods parseJSON :: Value -> Parser HookConfiguration # parseJSONList :: Value -> Parser [HookConfiguration] #
ToJSON HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration Methods toJSON :: HookConfiguration -> Value # toEncoding :: HookConfiguration -> Encoding # toJSONList :: [HookConfiguration] -> Value # toEncodingList :: [HookConfiguration] -> Encoding #
Generic HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration Associated Types type Rep HookConfiguration :: Type -> Type # Methods from :: HookConfiguration -> Rep HookConfiguration x # to :: Rep HookConfiguration x -> HookConfiguration #
Read HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration Methods readsPrec :: Int -> ReadS HookConfiguration # readList :: ReadS [HookConfiguration] # readPrec :: ReadPrec HookConfiguration # readListPrec :: ReadPrec [HookConfiguration] #
Show HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration Methods showsPrec :: Int -> HookConfiguration -> ShowS # show :: HookConfiguration -> String # showList :: [HookConfiguration] -> ShowS #
NFData HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration Methods rnf :: HookConfiguration -> () #
Eq HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration Methods (==) :: HookConfiguration -> HookConfiguration -> Bool # (/=) :: HookConfiguration -> HookConfiguration -> Bool #
Hashable HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration Methods hashWithSalt :: Int -> HookConfiguration -> Int # hash :: HookConfiguration -> Int #
type Rep HookConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.HookConfiguration type Rep HookConfiguration = D1 ('MetaData "HookConfiguration" "Amazonka.Kendra.Types.HookConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "HookConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "invocationCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeCondition)) :: (S1 ('MetaSel ('Just "lambdaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newHookConfiguration Source #

Arguments

:: Text	`$sel:lambdaArn:HookConfiguration'`
-> Text	`$sel:s3Bucket:HookConfiguration'`
-> HookConfiguration

Create a value of HookConfiguration with all optional fields omitted.

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

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

$sel:invocationCondition:HookConfiguration', hookConfiguration_invocationCondition - The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

$sel:lambdaArn:HookConfiguration', hookConfiguration_lambdaArn - The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Amazon Kendra.

$sel:s3Bucket:HookConfiguration', hookConfiguration_s3Bucket - Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

hookConfiguration_invocationCondition :: Lens' HookConfiguration (Maybe DocumentAttributeCondition) Source #

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

hookConfiguration_lambdaArn :: Lens' HookConfiguration Text Source #

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Amazon Kendra.

hookConfiguration_s3Bucket :: Lens' HookConfiguration Text Source #

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

IndexConfigurationSummary

data IndexConfigurationSummary Source #

Summary information on the configuration of an index.

See: newIndexConfigurationSummary smart constructor.

Constructors

IndexConfigurationSummary'

Fields

edition :: Maybe IndexEdition
Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
id :: Maybe Text
A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
name :: Maybe Text
The name of the index.
createdAt :: POSIX
The Unix timestamp when the index was created.
updatedAt :: POSIX
The Unix timestamp when the index was last updated by the UpdateIndex API.
status :: IndexStatus
The current status of the index. When the status is ACTIVE, the index is ready to search.

Instances

Instances details

FromJSON IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods parseJSON :: Value -> Parser IndexConfigurationSummary # parseJSONList :: Value -> Parser [IndexConfigurationSummary] #
Generic IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Associated Types type Rep IndexConfigurationSummary :: Type -> Type # Methods from :: IndexConfigurationSummary -> Rep IndexConfigurationSummary x # to :: Rep IndexConfigurationSummary x -> IndexConfigurationSummary #
Read IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods readsPrec :: Int -> ReadS IndexConfigurationSummary # readList :: ReadS [IndexConfigurationSummary] # readPrec :: ReadPrec IndexConfigurationSummary # readListPrec :: ReadPrec [IndexConfigurationSummary] #
Show IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods showsPrec :: Int -> IndexConfigurationSummary -> ShowS # show :: IndexConfigurationSummary -> String # showList :: [IndexConfigurationSummary] -> ShowS #
NFData IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods rnf :: IndexConfigurationSummary -> () #
Eq IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods (==) :: IndexConfigurationSummary -> IndexConfigurationSummary -> Bool # (/=) :: IndexConfigurationSummary -> IndexConfigurationSummary -> Bool #
Hashable IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary Methods hashWithSalt :: Int -> IndexConfigurationSummary -> Int # hash :: IndexConfigurationSummary -> Int #
type Rep IndexConfigurationSummary Source #
Instance details Defined in Amazonka.Kendra.Types.IndexConfigurationSummary type Rep IndexConfigurationSummary = D1 ('MetaData "IndexConfigurationSummary" "Amazonka.Kendra.Types.IndexConfigurationSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "IndexConfigurationSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "edition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexEdition)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IndexStatus)))))

newIndexConfigurationSummary Source #

Arguments

:: UTCTime	`$sel:createdAt:IndexConfigurationSummary'`
-> UTCTime	`$sel:updatedAt:IndexConfigurationSummary'`
-> IndexStatus	`$sel:status:IndexConfigurationSummary'`
-> IndexConfigurationSummary

Create a value of IndexConfigurationSummary with all optional fields omitted.

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

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

$sel:edition:IndexConfigurationSummary', indexConfigurationSummary_edition - Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

$sel:id:IndexConfigurationSummary', indexConfigurationSummary_id - A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

$sel:name:IndexConfigurationSummary', indexConfigurationSummary_name - The name of the index.

$sel:createdAt:IndexConfigurationSummary', indexConfigurationSummary_createdAt - The Unix timestamp when the index was created.

$sel:updatedAt:IndexConfigurationSummary', indexConfigurationSummary_updatedAt - The Unix timestamp when the index was last updated by the UpdateIndex API.

$sel:status:IndexConfigurationSummary', indexConfigurationSummary_status - The current status of the index. When the status is ACTIVE, the index is ready to search.

indexConfigurationSummary_edition :: Lens' IndexConfigurationSummary (Maybe IndexEdition) Source #

Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

indexConfigurationSummary_id :: Lens' IndexConfigurationSummary (Maybe Text) Source #

A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

indexConfigurationSummary_name :: Lens' IndexConfigurationSummary (Maybe Text) Source #

The name of the index.

indexConfigurationSummary_createdAt :: Lens' IndexConfigurationSummary UTCTime Source #

The Unix timestamp when the index was created.

indexConfigurationSummary_updatedAt :: Lens' IndexConfigurationSummary UTCTime Source #

The Unix timestamp when the index was last updated by the UpdateIndex API.

indexConfigurationSummary_status :: Lens' IndexConfigurationSummary IndexStatus Source #

The current status of the index. When the status is ACTIVE, the index is ready to search.

IndexStatistics

data IndexStatistics Source #

Provides information about the number of documents and the number of questions and answers in an index.

See: newIndexStatistics smart constructor.

Constructors

IndexStatistics'
Fields faqStatistics :: FaqStatistics The number of question and answer topics in the index. textDocumentStatistics :: TextDocumentStatistics The number of text documents indexed.

Instances

Instances details

FromJSON IndexStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatistics Methods parseJSON :: Value -> Parser IndexStatistics # parseJSONList :: Value -> Parser [IndexStatistics] #
Generic IndexStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatistics Associated Types type Rep IndexStatistics :: Type -> Type # Methods from :: IndexStatistics -> Rep IndexStatistics x # to :: Rep IndexStatistics x -> IndexStatistics #
Read IndexStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatistics Methods readsPrec :: Int -> ReadS IndexStatistics # readList :: ReadS [IndexStatistics] # readPrec :: ReadPrec IndexStatistics # readListPrec :: ReadPrec [IndexStatistics] #
Show IndexStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatistics Methods showsPrec :: Int -> IndexStatistics -> ShowS # show :: IndexStatistics -> String # showList :: [IndexStatistics] -> ShowS #
NFData IndexStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatistics Methods rnf :: IndexStatistics -> () #
Eq IndexStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatistics Methods (==) :: IndexStatistics -> IndexStatistics -> Bool # (/=) :: IndexStatistics -> IndexStatistics -> Bool #
Hashable IndexStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatistics Methods hashWithSalt :: Int -> IndexStatistics -> Int # hash :: IndexStatistics -> Int #
type Rep IndexStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.IndexStatistics type Rep IndexStatistics = D1 ('MetaData "IndexStatistics" "Amazonka.Kendra.Types.IndexStatistics" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "IndexStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "faqStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FaqStatistics) :*: S1 ('MetaSel ('Just "textDocumentStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextDocumentStatistics)))

newIndexStatistics Source #

Arguments

:: FaqStatistics	`$sel:faqStatistics:IndexStatistics'`
-> TextDocumentStatistics	`$sel:textDocumentStatistics:IndexStatistics'`
-> IndexStatistics

Create a value of IndexStatistics with all optional fields omitted.

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

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

$sel:faqStatistics:IndexStatistics', indexStatistics_faqStatistics - The number of question and answer topics in the index.

$sel:textDocumentStatistics:IndexStatistics', indexStatistics_textDocumentStatistics - The number of text documents indexed.

indexStatistics_faqStatistics :: Lens' IndexStatistics FaqStatistics Source #

The number of question and answer topics in the index.

indexStatistics_textDocumentStatistics :: Lens' IndexStatistics TextDocumentStatistics Source #

The number of text documents indexed.

InlineCustomDocumentEnrichmentConfiguration

data InlineCustomDocumentEnrichmentConfiguration Source #

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration.

For more information, see Customizing document metadata during the ingestion process.

See: newInlineCustomDocumentEnrichmentConfiguration smart constructor.

Constructors

InlineCustomDocumentEnrichmentConfiguration'

Fields

condition :: Maybe DocumentAttributeCondition
Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.
documentContentDeletion :: Maybe Bool
TRUE to delete content if the condition used for the target attribute is met.
target :: Maybe DocumentAttributeTarget
Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.

Instances

Instances details

FromJSON InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration Methods parseJSON :: Value -> Parser InlineCustomDocumentEnrichmentConfiguration # parseJSONList :: Value -> Parser [InlineCustomDocumentEnrichmentConfiguration] #
ToJSON InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration Methods toJSON :: InlineCustomDocumentEnrichmentConfiguration -> Value # toEncoding :: InlineCustomDocumentEnrichmentConfiguration -> Encoding # toJSONList :: [InlineCustomDocumentEnrichmentConfiguration] -> Value # toEncodingList :: [InlineCustomDocumentEnrichmentConfiguration] -> Encoding #
Generic InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration Associated Types type Rep InlineCustomDocumentEnrichmentConfiguration :: Type -> Type # Methods from :: InlineCustomDocumentEnrichmentConfiguration -> Rep InlineCustomDocumentEnrichmentConfiguration x # to :: Rep InlineCustomDocumentEnrichmentConfiguration x -> InlineCustomDocumentEnrichmentConfiguration #
Read InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration Methods readsPrec :: Int -> ReadS InlineCustomDocumentEnrichmentConfiguration # readList :: ReadS [InlineCustomDocumentEnrichmentConfiguration] # readPrec :: ReadPrec InlineCustomDocumentEnrichmentConfiguration # readListPrec :: ReadPrec [InlineCustomDocumentEnrichmentConfiguration] #
Show InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration Methods showsPrec :: Int -> InlineCustomDocumentEnrichmentConfiguration -> ShowS # show :: InlineCustomDocumentEnrichmentConfiguration -> String # showList :: [InlineCustomDocumentEnrichmentConfiguration] -> ShowS #
NFData InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration Methods rnf :: InlineCustomDocumentEnrichmentConfiguration -> () #
Eq InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration Methods (==) :: InlineCustomDocumentEnrichmentConfiguration -> InlineCustomDocumentEnrichmentConfiguration -> Bool # (/=) :: InlineCustomDocumentEnrichmentConfiguration -> InlineCustomDocumentEnrichmentConfiguration -> Bool #
Hashable InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration Methods hashWithSalt :: Int -> InlineCustomDocumentEnrichmentConfiguration -> Int # hash :: InlineCustomDocumentEnrichmentConfiguration -> Int #
type Rep InlineCustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration type Rep InlineCustomDocumentEnrichmentConfiguration = D1 ('MetaData "InlineCustomDocumentEnrichmentConfiguration" "Amazonka.Kendra.Types.InlineCustomDocumentEnrichmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "InlineCustomDocumentEnrichmentConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeCondition)) :: (S1 ('MetaSel ('Just "documentContentDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeTarget)))))

newInlineCustomDocumentEnrichmentConfiguration :: InlineCustomDocumentEnrichmentConfiguration Source #

Create a value of InlineCustomDocumentEnrichmentConfiguration with all optional fields omitted.

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

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

$sel:condition:InlineCustomDocumentEnrichmentConfiguration', inlineCustomDocumentEnrichmentConfiguration_condition - Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.

$sel:documentContentDeletion:InlineCustomDocumentEnrichmentConfiguration', inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion - TRUE to delete content if the condition used for the target attribute is met.

$sel:target:InlineCustomDocumentEnrichmentConfiguration', inlineCustomDocumentEnrichmentConfiguration_target - Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.

inlineCustomDocumentEnrichmentConfiguration_condition :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe DocumentAttributeCondition) Source #

Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.

inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe Bool) Source #

TRUE to delete content if the condition used for the target attribute is met.

inlineCustomDocumentEnrichmentConfiguration_target :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe DocumentAttributeTarget) Source #

Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.

JiraConfiguration

data JiraConfiguration Source #

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

See: newJiraConfiguration smart constructor.

Constructors

JiraConfiguration'

Fields

attachmentFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
commentFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
issueFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
issueSubEntityFilter :: Maybe [IssueSubEntity]
Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
issueType :: Maybe [Text]
Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
project :: Maybe [Text]
Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
projectFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira projects to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
status :: Maybe [Text]
Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
useChangeLog :: Maybe Bool
TRUE to use the Jira change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Jira.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.
workLogFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira work logs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.
jiraAccountUrl :: Text
The URL of the Jira account. For example, company.atlassian.net or https://jira.company.com. You can find your Jira account URL in the URL of your profile page for Jira desktop.
secretArn :: Text
The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:
- jiraId—The Jira username.
- jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Using a Jira data source.

Instances

Instances details

FromJSON JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods parseJSON :: Value -> Parser JiraConfiguration # parseJSONList :: Value -> Parser [JiraConfiguration] #
ToJSON JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods toJSON :: JiraConfiguration -> Value # toEncoding :: JiraConfiguration -> Encoding # toJSONList :: [JiraConfiguration] -> Value # toEncodingList :: [JiraConfiguration] -> Encoding #
Generic JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Associated Types type Rep JiraConfiguration :: Type -> Type # Methods from :: JiraConfiguration -> Rep JiraConfiguration x # to :: Rep JiraConfiguration x -> JiraConfiguration #
Read JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods readsPrec :: Int -> ReadS JiraConfiguration # readList :: ReadS [JiraConfiguration] # readPrec :: ReadPrec JiraConfiguration # readListPrec :: ReadPrec [JiraConfiguration] #
Show JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods showsPrec :: Int -> JiraConfiguration -> ShowS # show :: JiraConfiguration -> String # showList :: [JiraConfiguration] -> ShowS #
NFData JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods rnf :: JiraConfiguration -> () #
Eq JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods (==) :: JiraConfiguration -> JiraConfiguration -> Bool # (/=) :: JiraConfiguration -> JiraConfiguration -> Bool #
Hashable JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods hashWithSalt :: Int -> JiraConfiguration -> Int # hash :: JiraConfiguration -> Int #
type Rep JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration type Rep JiraConfiguration = D1 ('MetaData "JiraConfiguration" "Amazonka.Kendra.Types.JiraConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "JiraConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "commentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "issueFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "issueSubEntityFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IssueSubEntity])) :: S1 ('MetaSel ('Just "issueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: (((S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "projectFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :: S1 ('MetaSel ('Just "workLogFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "jiraAccountUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJiraConfiguration Source #

Arguments

:: Text	`$sel:jiraAccountUrl:JiraConfiguration'`
-> Text	`$sel:secretArn:JiraConfiguration'`
-> JiraConfiguration

Create a value of JiraConfiguration with all optional fields omitted.

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

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

$sel:attachmentFieldMappings:JiraConfiguration', jiraConfiguration_attachmentFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

$sel:commentFieldMappings:JiraConfiguration', jiraConfiguration_commentFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

$sel:exclusionPatterns:JiraConfiguration', jiraConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:inclusionPatterns:JiraConfiguration', jiraConfiguration_inclusionPatterns - A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:issueFieldMappings:JiraConfiguration', jiraConfiguration_issueFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

$sel:issueSubEntityFilter:JiraConfiguration', jiraConfiguration_issueSubEntityFilter - Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

$sel:issueType:JiraConfiguration', jiraConfiguration_issueType - Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

$sel:project:JiraConfiguration', jiraConfiguration_project - Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

$sel:projectFieldMappings:JiraConfiguration', jiraConfiguration_projectFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira projects to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

$sel:status:JiraConfiguration', jiraConfiguration_status - Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

$sel:useChangeLog:JiraConfiguration', jiraConfiguration_useChangeLog - TRUE to use the Jira change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Jira.

$sel:vpcConfiguration:JiraConfiguration', jiraConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.

$sel:workLogFieldMappings:JiraConfiguration', jiraConfiguration_workLogFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira work logs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

$sel:jiraAccountUrl:JiraConfiguration', jiraConfiguration_jiraAccountUrl - The URL of the Jira account. For example, company.atlassian.net or https://jira.company.com. You can find your Jira account URL in the URL of your profile page for Jira desktop.

$sel:secretArn:JiraConfiguration', jiraConfiguration_secretArn - The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

jiraId—The Jira username.
jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Using a Jira data source.

jiraConfiguration_attachmentFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

jiraConfiguration_commentFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

jiraConfiguration_exclusionPatterns :: Lens' JiraConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

jiraConfiguration_inclusionPatterns :: Lens' JiraConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

jiraConfiguration_issueFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira issues to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

jiraConfiguration_issueSubEntityFilter :: Lens' JiraConfiguration (Maybe [IssueSubEntity]) Source #

Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

jiraConfiguration_issueType :: Lens' JiraConfiguration (Maybe [Text]) Source #

Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

jiraConfiguration_project :: Lens' JiraConfiguration (Maybe [Text]) Source #

Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

jiraConfiguration_projectFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira projects to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

jiraConfiguration_status :: Lens' JiraConfiguration (Maybe [Text]) Source #

Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

jiraConfiguration_useChangeLog :: Lens' JiraConfiguration (Maybe Bool) Source #

TRUE to use the Jira change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Jira.

jiraConfiguration_vpcConfiguration :: Lens' JiraConfiguration (Maybe DataSourceVpcConfiguration) Source #

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

jiraConfiguration_workLogFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Jira work logs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Jira fields. For more information, see Mapping data source fields. The Jira data source field names must exist in your Jira custom metadata.

jiraConfiguration_jiraAccountUrl :: Lens' JiraConfiguration Text Source #

The URL of the Jira account. For example, company.atlassian.net or https://jira.company.com. You can find your Jira account URL in the URL of your profile page for Jira desktop.

jiraConfiguration_secretArn :: Lens' JiraConfiguration Text Source #

The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

jiraId—The Jira username.
jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Using a Jira data source.

JsonTokenTypeConfiguration

data JsonTokenTypeConfiguration Source #

Provides the configuration information for the JSON token type.

See: newJsonTokenTypeConfiguration smart constructor.

Constructors

JsonTokenTypeConfiguration'
Fields userNameAttributeField :: Text The user name attribute field. groupAttributeField :: Text The group attribute field.

Instances

Instances details

FromJSON JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration Methods parseJSON :: Value -> Parser JsonTokenTypeConfiguration # parseJSONList :: Value -> Parser [JsonTokenTypeConfiguration] #
ToJSON JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration Methods toJSON :: JsonTokenTypeConfiguration -> Value # toEncoding :: JsonTokenTypeConfiguration -> Encoding # toJSONList :: [JsonTokenTypeConfiguration] -> Value # toEncodingList :: [JsonTokenTypeConfiguration] -> Encoding #
Generic JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration Associated Types type Rep JsonTokenTypeConfiguration :: Type -> Type # Methods from :: JsonTokenTypeConfiguration -> Rep JsonTokenTypeConfiguration x # to :: Rep JsonTokenTypeConfiguration x -> JsonTokenTypeConfiguration #
Read JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration Methods readsPrec :: Int -> ReadS JsonTokenTypeConfiguration # readList :: ReadS [JsonTokenTypeConfiguration] # readPrec :: ReadPrec JsonTokenTypeConfiguration # readListPrec :: ReadPrec [JsonTokenTypeConfiguration] #
Show JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration Methods showsPrec :: Int -> JsonTokenTypeConfiguration -> ShowS # show :: JsonTokenTypeConfiguration -> String # showList :: [JsonTokenTypeConfiguration] -> ShowS #
NFData JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration Methods rnf :: JsonTokenTypeConfiguration -> () #
Eq JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration Methods (==) :: JsonTokenTypeConfiguration -> JsonTokenTypeConfiguration -> Bool # (/=) :: JsonTokenTypeConfiguration -> JsonTokenTypeConfiguration -> Bool #
Hashable JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration Methods hashWithSalt :: Int -> JsonTokenTypeConfiguration -> Int # hash :: JsonTokenTypeConfiguration -> Int #
type Rep JsonTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JsonTokenTypeConfiguration type Rep JsonTokenTypeConfiguration = D1 ('MetaData "JsonTokenTypeConfiguration" "Amazonka.Kendra.Types.JsonTokenTypeConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "JsonTokenTypeConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userNameAttributeField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupAttributeField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newJsonTokenTypeConfiguration Source #

Arguments

:: Text	`$sel:userNameAttributeField:JsonTokenTypeConfiguration'`
-> Text	`$sel:groupAttributeField:JsonTokenTypeConfiguration'`
-> JsonTokenTypeConfiguration

Create a value of JsonTokenTypeConfiguration with all optional fields omitted.

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

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

$sel:userNameAttributeField:JsonTokenTypeConfiguration', jsonTokenTypeConfiguration_userNameAttributeField - The user name attribute field.

$sel:groupAttributeField:JsonTokenTypeConfiguration', jsonTokenTypeConfiguration_groupAttributeField - The group attribute field.

jsonTokenTypeConfiguration_userNameAttributeField :: Lens' JsonTokenTypeConfiguration Text Source #

The user name attribute field.

jsonTokenTypeConfiguration_groupAttributeField :: Lens' JsonTokenTypeConfiguration Text Source #

The group attribute field.

JwtTokenTypeConfiguration

data JwtTokenTypeConfiguration Source #

Provides the configuration information for the JWT token type.

See: newJwtTokenTypeConfiguration smart constructor.

Constructors

JwtTokenTypeConfiguration'

Fields

claimRegex :: Maybe Text
The regular expression that identifies the claim.
groupAttributeField :: Maybe Text
The group attribute field.
issuer :: Maybe Text
The issuer of the token.
secretManagerArn :: Maybe Text
The Amazon Resource Name (arn) of the secret.
url :: Maybe Text
The signing key URL.
userNameAttributeField :: Maybe Text
The user name attribute field.
keyLocation :: KeyLocation
The location of the key.

Instances

Instances details

FromJSON JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration Methods parseJSON :: Value -> Parser JwtTokenTypeConfiguration # parseJSONList :: Value -> Parser [JwtTokenTypeConfiguration] #
ToJSON JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration Methods toJSON :: JwtTokenTypeConfiguration -> Value # toEncoding :: JwtTokenTypeConfiguration -> Encoding # toJSONList :: [JwtTokenTypeConfiguration] -> Value # toEncodingList :: [JwtTokenTypeConfiguration] -> Encoding #
Generic JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration Associated Types type Rep JwtTokenTypeConfiguration :: Type -> Type # Methods from :: JwtTokenTypeConfiguration -> Rep JwtTokenTypeConfiguration x # to :: Rep JwtTokenTypeConfiguration x -> JwtTokenTypeConfiguration #
Read JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration Methods readsPrec :: Int -> ReadS JwtTokenTypeConfiguration # readList :: ReadS [JwtTokenTypeConfiguration] # readPrec :: ReadPrec JwtTokenTypeConfiguration # readListPrec :: ReadPrec [JwtTokenTypeConfiguration] #
Show JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration Methods showsPrec :: Int -> JwtTokenTypeConfiguration -> ShowS # show :: JwtTokenTypeConfiguration -> String # showList :: [JwtTokenTypeConfiguration] -> ShowS #
NFData JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration Methods rnf :: JwtTokenTypeConfiguration -> () #
Eq JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration Methods (==) :: JwtTokenTypeConfiguration -> JwtTokenTypeConfiguration -> Bool # (/=) :: JwtTokenTypeConfiguration -> JwtTokenTypeConfiguration -> Bool #
Hashable JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration Methods hashWithSalt :: Int -> JwtTokenTypeConfiguration -> Int # hash :: JwtTokenTypeConfiguration -> Int #
type Rep JwtTokenTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JwtTokenTypeConfiguration type Rep JwtTokenTypeConfiguration = D1 ('MetaData "JwtTokenTypeConfiguration" "Amazonka.Kendra.Types.JwtTokenTypeConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "JwtTokenTypeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "claimRegex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "groupAttributeField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "issuer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "secretManagerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "userNameAttributeField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "keyLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KeyLocation)))))

newJwtTokenTypeConfiguration Source #

Arguments

:: KeyLocation	`$sel:keyLocation:JwtTokenTypeConfiguration'`
-> JwtTokenTypeConfiguration

Create a value of JwtTokenTypeConfiguration with all optional fields omitted.

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:claimRegex:JwtTokenTypeConfiguration', jwtTokenTypeConfiguration_claimRegex - The regular expression that identifies the claim.

$sel:groupAttributeField:JwtTokenTypeConfiguration', jwtTokenTypeConfiguration_groupAttributeField - The group attribute field.

$sel:issuer:JwtTokenTypeConfiguration', jwtTokenTypeConfiguration_issuer - The issuer of the token.

$sel:secretManagerArn:JwtTokenTypeConfiguration', jwtTokenTypeConfiguration_secretManagerArn - The Amazon Resource Name (arn) of the secret.

$sel:url:JwtTokenTypeConfiguration', jwtTokenTypeConfiguration_url - The signing key URL.

$sel:userNameAttributeField:JwtTokenTypeConfiguration', jwtTokenTypeConfiguration_userNameAttributeField - The user name attribute field.

$sel:keyLocation:JwtTokenTypeConfiguration', jwtTokenTypeConfiguration_keyLocation - The location of the key.

jwtTokenTypeConfiguration_claimRegex :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The regular expression that identifies the claim.

jwtTokenTypeConfiguration_groupAttributeField :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The group attribute field.

jwtTokenTypeConfiguration_issuer :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The issuer of the token.

jwtTokenTypeConfiguration_secretManagerArn :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The Amazon Resource Name (arn) of the secret.

jwtTokenTypeConfiguration_url :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The signing key URL.

jwtTokenTypeConfiguration_userNameAttributeField :: Lens' JwtTokenTypeConfiguration (Maybe Text) Source #

The user name attribute field.

jwtTokenTypeConfiguration_keyLocation :: Lens' JwtTokenTypeConfiguration KeyLocation Source #

The location of the key.

MemberGroup

data MemberGroup Source #

The sub groups that belong to a group.

See: newMemberGroup smart constructor.

Constructors

MemberGroup'
Fields dataSourceId :: Maybe Text The identifier of the data source for the sub group you want to map to a group. groupId :: Text The identifier of the sub group you want to map to a group.

Instances

Instances details

ToJSON MemberGroup Source #
Instance details Defined in Amazonka.Kendra.Types.MemberGroup Methods toJSON :: MemberGroup -> Value # toEncoding :: MemberGroup -> Encoding # toJSONList :: [MemberGroup] -> Value # toEncodingList :: [MemberGroup] -> Encoding #
Generic MemberGroup Source #
Instance details Defined in Amazonka.Kendra.Types.MemberGroup Associated Types type Rep MemberGroup :: Type -> Type # Methods from :: MemberGroup -> Rep MemberGroup x # to :: Rep MemberGroup x -> MemberGroup #
Read MemberGroup Source #
Instance details Defined in Amazonka.Kendra.Types.MemberGroup Methods readsPrec :: Int -> ReadS MemberGroup # readList :: ReadS [MemberGroup] # readPrec :: ReadPrec MemberGroup # readListPrec :: ReadPrec [MemberGroup] #
Show MemberGroup Source #
Instance details Defined in Amazonka.Kendra.Types.MemberGroup Methods showsPrec :: Int -> MemberGroup -> ShowS # show :: MemberGroup -> String # showList :: [MemberGroup] -> ShowS #
NFData MemberGroup Source #
Instance details Defined in Amazonka.Kendra.Types.MemberGroup Methods rnf :: MemberGroup -> () #
Eq MemberGroup Source #
Instance details Defined in Amazonka.Kendra.Types.MemberGroup Methods (==) :: MemberGroup -> MemberGroup -> Bool # (/=) :: MemberGroup -> MemberGroup -> Bool #
Hashable MemberGroup Source #
Instance details Defined in Amazonka.Kendra.Types.MemberGroup Methods hashWithSalt :: Int -> MemberGroup -> Int # hash :: MemberGroup -> Int #
type Rep MemberGroup Source #
Instance details Defined in Amazonka.Kendra.Types.MemberGroup type Rep MemberGroup = D1 ('MetaData "MemberGroup" "Amazonka.Kendra.Types.MemberGroup" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "MemberGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newMemberGroup Source #

Arguments

:: Text	`$sel:groupId:MemberGroup'`
-> MemberGroup

Create a value of MemberGroup with all optional fields omitted.

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

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

$sel:dataSourceId:MemberGroup', memberGroup_dataSourceId - The identifier of the data source for the sub group you want to map to a group.

$sel:groupId:MemberGroup', memberGroup_groupId - The identifier of the sub group you want to map to a group.

memberGroup_dataSourceId :: Lens' MemberGroup (Maybe Text) Source #

The identifier of the data source for the sub group you want to map to a group.

memberGroup_groupId :: Lens' MemberGroup Text Source #

The identifier of the sub group you want to map to a group.

MemberUser

data MemberUser Source #

The users that belong to a group.

See: newMemberUser smart constructor.

Constructors

MemberUser'
Fields userId :: Text The identifier of the user you want to map to a group.

Instances

Instances details

ToJSON MemberUser Source #
Instance details Defined in Amazonka.Kendra.Types.MemberUser Methods toJSON :: MemberUser -> Value # toEncoding :: MemberUser -> Encoding # toJSONList :: [MemberUser] -> Value # toEncodingList :: [MemberUser] -> Encoding #
Generic MemberUser Source #
Instance details Defined in Amazonka.Kendra.Types.MemberUser Associated Types type Rep MemberUser :: Type -> Type # Methods from :: MemberUser -> Rep MemberUser x # to :: Rep MemberUser x -> MemberUser #
Read MemberUser Source #
Instance details Defined in Amazonka.Kendra.Types.MemberUser Methods readsPrec :: Int -> ReadS MemberUser # readList :: ReadS [MemberUser] # readPrec :: ReadPrec MemberUser # readListPrec :: ReadPrec [MemberUser] #
Show MemberUser Source #
Instance details Defined in Amazonka.Kendra.Types.MemberUser Methods showsPrec :: Int -> MemberUser -> ShowS # show :: MemberUser -> String # showList :: [MemberUser] -> ShowS #
NFData MemberUser Source #
Instance details Defined in Amazonka.Kendra.Types.MemberUser Methods rnf :: MemberUser -> () #
Eq MemberUser Source #
Instance details Defined in Amazonka.Kendra.Types.MemberUser Methods (==) :: MemberUser -> MemberUser -> Bool # (/=) :: MemberUser -> MemberUser -> Bool #
Hashable MemberUser Source #
Instance details Defined in Amazonka.Kendra.Types.MemberUser Methods hashWithSalt :: Int -> MemberUser -> Int # hash :: MemberUser -> Int #
type Rep MemberUser Source #
Instance details Defined in Amazonka.Kendra.Types.MemberUser type Rep MemberUser = D1 ('MetaData "MemberUser" "Amazonka.Kendra.Types.MemberUser" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "MemberUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newMemberUser Source #

Arguments

:: Text	`$sel:userId:MemberUser'`
-> MemberUser

Create a value of MemberUser with all optional fields omitted.

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

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

$sel:userId:MemberUser', memberUser_userId - The identifier of the user you want to map to a group.

memberUser_userId :: Lens' MemberUser Text Source #

The identifier of the user you want to map to a group.

OnPremiseConfiguration

data OnPremiseConfiguration Source #

Provides the configuration information to connect to GitHub Enterprise Server (on premises).

See: newOnPremiseConfiguration smart constructor.

Constructors

OnPremiseConfiguration'

Fields

hostUrl :: Text
The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/
organizationName :: Text
The name of the organization of the GitHub Enterprise Server (in-premise) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting __Your organizations__ under your profile picture dropdown.
sslCertificateS3Path :: S3Path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.
You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

Instances

Instances details

FromJSON OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration Methods parseJSON :: Value -> Parser OnPremiseConfiguration # parseJSONList :: Value -> Parser [OnPremiseConfiguration] #
ToJSON OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration Methods toJSON :: OnPremiseConfiguration -> Value # toEncoding :: OnPremiseConfiguration -> Encoding # toJSONList :: [OnPremiseConfiguration] -> Value # toEncodingList :: [OnPremiseConfiguration] -> Encoding #
Generic OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration Associated Types type Rep OnPremiseConfiguration :: Type -> Type # Methods from :: OnPremiseConfiguration -> Rep OnPremiseConfiguration x # to :: Rep OnPremiseConfiguration x -> OnPremiseConfiguration #
Read OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration Methods readsPrec :: Int -> ReadS OnPremiseConfiguration # readList :: ReadS [OnPremiseConfiguration] # readPrec :: ReadPrec OnPremiseConfiguration # readListPrec :: ReadPrec [OnPremiseConfiguration] #
Show OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration Methods showsPrec :: Int -> OnPremiseConfiguration -> ShowS # show :: OnPremiseConfiguration -> String # showList :: [OnPremiseConfiguration] -> ShowS #
NFData OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration Methods rnf :: OnPremiseConfiguration -> () #
Eq OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration Methods (==) :: OnPremiseConfiguration -> OnPremiseConfiguration -> Bool # (/=) :: OnPremiseConfiguration -> OnPremiseConfiguration -> Bool #
Hashable OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration Methods hashWithSalt :: Int -> OnPremiseConfiguration -> Int # hash :: OnPremiseConfiguration -> Int #
type Rep OnPremiseConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OnPremiseConfiguration type Rep OnPremiseConfiguration = D1 ('MetaData "OnPremiseConfiguration" "Amazonka.Kendra.Types.OnPremiseConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "OnPremiseConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "organizationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sslCertificateS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Path))))

newOnPremiseConfiguration Source #

Arguments

:: Text	`$sel:hostUrl:OnPremiseConfiguration'`
-> Text	`$sel:organizationName:OnPremiseConfiguration'`
-> S3Path	`$sel:sslCertificateS3Path:OnPremiseConfiguration'`
-> OnPremiseConfiguration

Create a value of OnPremiseConfiguration with all optional fields omitted.

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

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

$sel:hostUrl:OnPremiseConfiguration', onPremiseConfiguration_hostUrl - The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/

$sel:organizationName:OnPremiseConfiguration', onPremiseConfiguration_organizationName - The name of the organization of the GitHub Enterprise Server (in-premise) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting __Your organizations__ under your profile picture dropdown.

$sel:sslCertificateS3Path:OnPremiseConfiguration', onPremiseConfiguration_sslCertificateS3Path - The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

onPremiseConfiguration_hostUrl :: Lens' OnPremiseConfiguration Text Source #

The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/

onPremiseConfiguration_organizationName :: Lens' OnPremiseConfiguration Text Source #

The name of the organization of the GitHub Enterprise Server (in-premise) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting __Your organizations__ under your profile picture dropdown.

onPremiseConfiguration_sslCertificateS3Path :: Lens' OnPremiseConfiguration S3Path Source #

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

OneDriveConfiguration

data OneDriveConfiguration Source #

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

See: newOneDriveConfiguration smart constructor.

Constructors

OneDriveConfiguration'

Fields

disableLocalGroups :: Maybe Bool
TRUE to disable local groups information.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the file name.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the file name.
tenantDomain :: Text
The Azure Active Directory domain of the organization.
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
oneDriveUsers :: OneDriveUsers
A list of user accounts whose documents should be indexed.

Instances

Instances details

FromJSON OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration Methods parseJSON :: Value -> Parser OneDriveConfiguration # parseJSONList :: Value -> Parser [OneDriveConfiguration] #
ToJSON OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration Methods toJSON :: OneDriveConfiguration -> Value # toEncoding :: OneDriveConfiguration -> Encoding # toJSONList :: [OneDriveConfiguration] -> Value # toEncodingList :: [OneDriveConfiguration] -> Encoding #
Generic OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration Associated Types type Rep OneDriveConfiguration :: Type -> Type # Methods from :: OneDriveConfiguration -> Rep OneDriveConfiguration x # to :: Rep OneDriveConfiguration x -> OneDriveConfiguration #
Read OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration Methods readsPrec :: Int -> ReadS OneDriveConfiguration # readList :: ReadS [OneDriveConfiguration] # readPrec :: ReadPrec OneDriveConfiguration # readListPrec :: ReadPrec [OneDriveConfiguration] #
Show OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration Methods showsPrec :: Int -> OneDriveConfiguration -> ShowS # show :: OneDriveConfiguration -> String # showList :: [OneDriveConfiguration] -> ShowS #
NFData OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration Methods rnf :: OneDriveConfiguration -> () #
Eq OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration Methods (==) :: OneDriveConfiguration -> OneDriveConfiguration -> Bool # (/=) :: OneDriveConfiguration -> OneDriveConfiguration -> Bool #
Hashable OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration Methods hashWithSalt :: Int -> OneDriveConfiguration -> Int # hash :: OneDriveConfiguration -> Int #
type Rep OneDriveConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveConfiguration type Rep OneDriveConfiguration = D1 ('MetaData "OneDriveConfiguration" "Amazonka.Kendra.Types.OneDriveConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "OneDriveConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disableLocalGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "tenantDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "oneDriveUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OneDriveUsers)))))

newOneDriveConfiguration Source #

Arguments

:: Text	`$sel:tenantDomain:OneDriveConfiguration'`
-> Text	`$sel:secretArn:OneDriveConfiguration'`
-> OneDriveUsers	`$sel:oneDriveUsers:OneDriveConfiguration'`
-> OneDriveConfiguration

Create a value of OneDriveConfiguration with all optional fields omitted.

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

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

$sel:disableLocalGroups:OneDriveConfiguration', oneDriveConfiguration_disableLocalGroups - TRUE to disable local groups information.

$sel:exclusionPatterns:OneDriveConfiguration', oneDriveConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

$sel:fieldMappings:OneDriveConfiguration', oneDriveConfiguration_fieldMappings - A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.

$sel:inclusionPatterns:OneDriveConfiguration', oneDriveConfiguration_inclusionPatterns - A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

$sel:tenantDomain:OneDriveConfiguration', oneDriveConfiguration_tenantDomain - The Azure Active Directory domain of the organization.

$sel:secretArn:OneDriveConfiguration', oneDriveConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

$sel:oneDriveUsers:OneDriveConfiguration', oneDriveConfiguration_oneDriveUsers - A list of user accounts whose documents should be indexed.

oneDriveConfiguration_disableLocalGroups :: Lens' OneDriveConfiguration (Maybe Bool) Source #

TRUE to disable local groups information.

oneDriveConfiguration_exclusionPatterns :: Lens' OneDriveConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

oneDriveConfiguration_fieldMappings :: Lens' OneDriveConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.

oneDriveConfiguration_inclusionPatterns :: Lens' OneDriveConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

oneDriveConfiguration_tenantDomain :: Lens' OneDriveConfiguration Text Source #

The Azure Active Directory domain of the organization.

oneDriveConfiguration_secretArn :: Lens' OneDriveConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

oneDriveConfiguration_oneDriveUsers :: Lens' OneDriveConfiguration OneDriveUsers Source #

A list of user accounts whose documents should be indexed.

OneDriveUsers

data OneDriveUsers Source #

User accounts whose documents should be indexed.

See: newOneDriveUsers smart constructor.

Constructors

OneDriveUsers'

Fields

oneDriveUserList :: Maybe (NonEmpty Text)
A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain. If you need to index the documents of more than 100 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.
oneDriveUserS3Path :: Maybe S3Path
The S3 bucket location of a file containing a list of users whose documents should be indexed.

Instances

Instances details

FromJSON OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers Methods parseJSON :: Value -> Parser OneDriveUsers # parseJSONList :: Value -> Parser [OneDriveUsers] #
ToJSON OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers Methods toJSON :: OneDriveUsers -> Value # toEncoding :: OneDriveUsers -> Encoding # toJSONList :: [OneDriveUsers] -> Value # toEncodingList :: [OneDriveUsers] -> Encoding #
Generic OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers Associated Types type Rep OneDriveUsers :: Type -> Type # Methods from :: OneDriveUsers -> Rep OneDriveUsers x # to :: Rep OneDriveUsers x -> OneDriveUsers #
Read OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers Methods readsPrec :: Int -> ReadS OneDriveUsers # readList :: ReadS [OneDriveUsers] # readPrec :: ReadPrec OneDriveUsers # readListPrec :: ReadPrec [OneDriveUsers] #
Show OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers Methods showsPrec :: Int -> OneDriveUsers -> ShowS # show :: OneDriveUsers -> String # showList :: [OneDriveUsers] -> ShowS #
NFData OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers Methods rnf :: OneDriveUsers -> () #
Eq OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers Methods (==) :: OneDriveUsers -> OneDriveUsers -> Bool # (/=) :: OneDriveUsers -> OneDriveUsers -> Bool #
Hashable OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers Methods hashWithSalt :: Int -> OneDriveUsers -> Int # hash :: OneDriveUsers -> Int #
type Rep OneDriveUsers Source #
Instance details Defined in Amazonka.Kendra.Types.OneDriveUsers type Rep OneDriveUsers = D1 ('MetaData "OneDriveUsers" "Amazonka.Kendra.Types.OneDriveUsers" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "OneDriveUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "oneDriveUserList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "oneDriveUserS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path))))

newOneDriveUsers :: OneDriveUsers Source #

Create a value of OneDriveUsers with all optional fields omitted.

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

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

$sel:oneDriveUserList:OneDriveUsers', oneDriveUsers_oneDriveUserList - A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain. If you need to index the documents of more than 100 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.

$sel:oneDriveUserS3Path:OneDriveUsers', oneDriveUsers_oneDriveUserS3Path - The S3 bucket location of a file containing a list of users whose documents should be indexed.

oneDriveUsers_oneDriveUserList :: Lens' OneDriveUsers (Maybe (NonEmpty Text)) Source #

A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain. If you need to index the documents of more than 100 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.

oneDriveUsers_oneDriveUserS3Path :: Lens' OneDriveUsers (Maybe S3Path) Source #

The S3 bucket location of a file containing a list of users whose documents should be indexed.

PersonasSummary

data PersonasSummary Source #

Summary information for users or groups in your IAM Identity Center identity source. This applies to users and groups with specific permissions that define their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

See: newPersonasSummary smart constructor.

Constructors

PersonasSummary'

Fields

createdAt :: Maybe POSIX
The date-time the summary information was created.
entityId :: Maybe Text
The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.
persona :: Maybe Persona
The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.
updatedAt :: Maybe POSIX
The date-time the summary information was last updated.

Instances

Instances details

FromJSON PersonasSummary Source #
Instance details Defined in Amazonka.Kendra.Types.PersonasSummary Methods parseJSON :: Value -> Parser PersonasSummary # parseJSONList :: Value -> Parser [PersonasSummary] #
Generic PersonasSummary Source #
Instance details Defined in Amazonka.Kendra.Types.PersonasSummary Associated Types type Rep PersonasSummary :: Type -> Type # Methods from :: PersonasSummary -> Rep PersonasSummary x # to :: Rep PersonasSummary x -> PersonasSummary #
Read PersonasSummary Source #
Instance details Defined in Amazonka.Kendra.Types.PersonasSummary Methods readsPrec :: Int -> ReadS PersonasSummary # readList :: ReadS [PersonasSummary] # readPrec :: ReadPrec PersonasSummary # readListPrec :: ReadPrec [PersonasSummary] #
Show PersonasSummary Source #
Instance details Defined in Amazonka.Kendra.Types.PersonasSummary Methods showsPrec :: Int -> PersonasSummary -> ShowS # show :: PersonasSummary -> String # showList :: [PersonasSummary] -> ShowS #
NFData PersonasSummary Source #
Instance details Defined in Amazonka.Kendra.Types.PersonasSummary Methods rnf :: PersonasSummary -> () #
Eq PersonasSummary Source #
Instance details Defined in Amazonka.Kendra.Types.PersonasSummary Methods (==) :: PersonasSummary -> PersonasSummary -> Bool # (/=) :: PersonasSummary -> PersonasSummary -> Bool #
Hashable PersonasSummary Source #
Instance details Defined in Amazonka.Kendra.Types.PersonasSummary Methods hashWithSalt :: Int -> PersonasSummary -> Int # hash :: PersonasSummary -> Int #
type Rep PersonasSummary Source #
Instance details Defined in Amazonka.Kendra.Types.PersonasSummary type Rep PersonasSummary = D1 ('MetaData "PersonasSummary" "Amazonka.Kendra.Types.PersonasSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "PersonasSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "persona") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Persona)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))

newPersonasSummary :: PersonasSummary Source #

Create a value of PersonasSummary with all optional fields omitted.

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

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

$sel:createdAt:PersonasSummary', personasSummary_createdAt - The date-time the summary information was created.

$sel:entityId:PersonasSummary', personasSummary_entityId - The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

$sel:persona:PersonasSummary', personasSummary_persona - The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

$sel:updatedAt:PersonasSummary', personasSummary_updatedAt - The date-time the summary information was last updated.

personasSummary_createdAt :: Lens' PersonasSummary (Maybe UTCTime) Source #

The date-time the summary information was created.

personasSummary_entityId :: Lens' PersonasSummary (Maybe Text) Source #

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

personasSummary_persona :: Lens' PersonasSummary (Maybe Persona) Source #

The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

personasSummary_updatedAt :: Lens' PersonasSummary (Maybe UTCTime) Source #

The date-time the summary information was last updated.

Principal

data Principal Source #

Provides user and group information for user context filtering.

See: newPrincipal smart constructor.

Constructors

Principal'
Fields dataSourceId :: Maybe Text The identifier of the data source the principal should access documents from. name :: Text The name of the user or group. type' :: PrincipalType The type of principal. access :: ReadAccessType Whether to allow or deny document access to the principal.

Instances

Instances details

FromJSON Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal Methods parseJSON :: Value -> Parser Principal # parseJSONList :: Value -> Parser [Principal] #
ToJSON Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal Methods toJSON :: Principal -> Value # toEncoding :: Principal -> Encoding # toJSONList :: [Principal] -> Value # toEncodingList :: [Principal] -> Encoding #
Generic Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal Associated Types type Rep Principal :: Type -> Type # Methods from :: Principal -> Rep Principal x # to :: Rep Principal x -> Principal #
Read Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal Methods readsPrec :: Int -> ReadS Principal # readList :: ReadS [Principal] # readPrec :: ReadPrec Principal # readListPrec :: ReadPrec [Principal] #
Show Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal Methods showsPrec :: Int -> Principal -> ShowS # show :: Principal -> String # showList :: [Principal] -> ShowS #
NFData Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal Methods rnf :: Principal -> () #
Eq Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal Methods (==) :: Principal -> Principal -> Bool # (/=) :: Principal -> Principal -> Bool #
Hashable Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal Methods hashWithSalt :: Int -> Principal -> Int # hash :: Principal -> Int #
type Rep Principal Source #
Instance details Defined in Amazonka.Kendra.Types.Principal type Rep Principal = D1 ('MetaData "Principal" "Amazonka.Kendra.Types.Principal" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Principal'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PrincipalType) :*: S1 ('MetaSel ('Just "access") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReadAccessType))))

newPrincipal Source #

Arguments

:: Text	`$sel:name:Principal'`
-> PrincipalType	`$sel:type':Principal'`
-> ReadAccessType	`$sel:access:Principal'`
-> Principal

Create a value of Principal with all optional fields omitted.

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

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

$sel:dataSourceId:Principal', principal_dataSourceId - The identifier of the data source the principal should access documents from.

$sel:name:Principal', principal_name - The name of the user or group.

$sel:type':Principal', principal_type - The type of principal.

$sel:access:Principal', principal_access - Whether to allow or deny document access to the principal.

principal_dataSourceId :: Lens' Principal (Maybe Text) Source #

The identifier of the data source the principal should access documents from.

principal_name :: Lens' Principal Text Source #

The name of the user or group.

principal_type :: Lens' Principal PrincipalType Source #

The type of principal.

principal_access :: Lens' Principal ReadAccessType Source #

Whether to allow or deny document access to the principal.

ProxyConfiguration

data ProxyConfiguration Source #

Provides the configuration information for a web proxy to connect to website hosts.

See: newProxyConfiguration smart constructor.

Constructors

ProxyConfiguration'

Fields

credentials :: Maybe Text
Your secret ARN, which you can create in Secrets Manager
The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
host :: Text
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
port :: Natural
The port number of the website host you want to connect to via a web proxy server.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

Instances

Instances details

FromJSON ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration Methods parseJSON :: Value -> Parser ProxyConfiguration # parseJSONList :: Value -> Parser [ProxyConfiguration] #
ToJSON ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration Methods toJSON :: ProxyConfiguration -> Value # toEncoding :: ProxyConfiguration -> Encoding # toJSONList :: [ProxyConfiguration] -> Value # toEncodingList :: [ProxyConfiguration] -> Encoding #
Generic ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration Associated Types type Rep ProxyConfiguration :: Type -> Type # Methods from :: ProxyConfiguration -> Rep ProxyConfiguration x # to :: Rep ProxyConfiguration x -> ProxyConfiguration #
Read ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration Methods readsPrec :: Int -> ReadS ProxyConfiguration # readList :: ReadS [ProxyConfiguration] # readPrec :: ReadPrec ProxyConfiguration # readListPrec :: ReadPrec [ProxyConfiguration] #
Show ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration Methods showsPrec :: Int -> ProxyConfiguration -> ShowS # show :: ProxyConfiguration -> String # showList :: [ProxyConfiguration] -> ShowS #
NFData ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration Methods rnf :: ProxyConfiguration -> () #
Eq ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration Methods (==) :: ProxyConfiguration -> ProxyConfiguration -> Bool # (/=) :: ProxyConfiguration -> ProxyConfiguration -> Bool #
Hashable ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration Methods hashWithSalt :: Int -> ProxyConfiguration -> Int # hash :: ProxyConfiguration -> Int #
type Rep ProxyConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ProxyConfiguration type Rep ProxyConfiguration = D1 ('MetaData "ProxyConfiguration" "Amazonka.Kendra.Types.ProxyConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ProxyConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newProxyConfiguration Source #

Arguments

:: Text	`$sel:host:ProxyConfiguration'`
-> Natural	`$sel:port:ProxyConfiguration'`
-> ProxyConfiguration

Create a value of ProxyConfiguration with all optional fields omitted.

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

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

$sel:credentials:ProxyConfiguration', proxyConfiguration_credentials - Your secret ARN, which you can create in Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

$sel:host:ProxyConfiguration', proxyConfiguration_host - The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

$sel:port:ProxyConfiguration', proxyConfiguration_port - The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

proxyConfiguration_credentials :: Lens' ProxyConfiguration (Maybe Text) Source #

Your secret ARN, which you can create in Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

proxyConfiguration_host :: Lens' ProxyConfiguration Text Source #

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

proxyConfiguration_port :: Lens' ProxyConfiguration Natural Source #

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

QueryResultItem

data QueryResultItem Source #

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

See: newQueryResultItem smart constructor.

Constructors

QueryResultItem'

Fields

additionalAttributes :: Maybe [AdditionalResultAttribute]
One or more additional attributes associated with the query result.
documentAttributes :: Maybe [DocumentAttribute]
An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
documentExcerpt :: Maybe TextWithHighlights
An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
documentId :: Maybe Text
The identifier for the document.
documentTitle :: Maybe TextWithHighlights
The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
documentURI :: Maybe Text
The URI of the original location of the document.
feedbackToken :: Maybe Text
A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .
format :: Maybe QueryResultFormat
If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.
id :: Maybe Text
The identifier for the query result.
scoreAttributes :: Maybe ScoreAttributes
Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.
The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.
tableExcerpt :: Maybe TableExcerpt
An excerpt from a table within a document.
type' :: Maybe QueryResultType
The type of document within the response. For example, a response could include a question-answer that's relevant to the query.

Instances

Instances details

FromJSON QueryResultItem Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultItem Methods parseJSON :: Value -> Parser QueryResultItem # parseJSONList :: Value -> Parser [QueryResultItem] #
Generic QueryResultItem Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultItem Associated Types type Rep QueryResultItem :: Type -> Type # Methods from :: QueryResultItem -> Rep QueryResultItem x # to :: Rep QueryResultItem x -> QueryResultItem #
Read QueryResultItem Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultItem Methods readsPrec :: Int -> ReadS QueryResultItem # readList :: ReadS [QueryResultItem] # readPrec :: ReadPrec QueryResultItem # readListPrec :: ReadPrec [QueryResultItem] #
Show QueryResultItem Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultItem Methods showsPrec :: Int -> QueryResultItem -> ShowS # show :: QueryResultItem -> String # showList :: [QueryResultItem] -> ShowS #
NFData QueryResultItem Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultItem Methods rnf :: QueryResultItem -> () #
Eq QueryResultItem Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultItem Methods (==) :: QueryResultItem -> QueryResultItem -> Bool # (/=) :: QueryResultItem -> QueryResultItem -> Bool #
Hashable QueryResultItem Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultItem Methods hashWithSalt :: Int -> QueryResultItem -> Int # hash :: QueryResultItem -> Int #
type Rep QueryResultItem Source #
Instance details Defined in Amazonka.Kendra.Types.QueryResultItem type Rep QueryResultItem = D1 ('MetaData "QueryResultItem" "Amazonka.Kendra.Types.QueryResultItem" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "QueryResultItem'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdditionalResultAttribute])) :: (S1 ('MetaSel ('Just "documentAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttribute])) :: S1 ('MetaSel ('Just "documentExcerpt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextWithHighlights)))) :: (S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TextWithHighlights)) :: S1 ('MetaSel ('Just "documentURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "feedbackToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryResultFormat)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "scoreAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScoreAttributes)) :: (S1 ('MetaSel ('Just "tableExcerpt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TableExcerpt)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryResultType)))))))

newQueryResultItem :: QueryResultItem Source #

Create a value of QueryResultItem with all optional fields omitted.

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

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

$sel:additionalAttributes:QueryResultItem', queryResultItem_additionalAttributes - One or more additional attributes associated with the query result.

$sel:documentAttributes:QueryResultItem', queryResultItem_documentAttributes - An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

$sel:documentExcerpt:QueryResultItem', queryResultItem_documentExcerpt - An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

$sel:documentId:QueryResultItem', queryResultItem_documentId - The identifier for the document.

$sel:documentTitle:QueryResultItem', queryResultItem_documentTitle - The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

$sel:documentURI:QueryResultItem', queryResultItem_documentURI - The URI of the original location of the document.

$sel:feedbackToken:QueryResultItem', queryResultItem_feedbackToken - A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

$sel:format:QueryResultItem', queryResultItem_format - If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.

$sel:id:QueryResultItem', queryResultItem_id - The identifier for the query result.

$sel:scoreAttributes:QueryResultItem', queryResultItem_scoreAttributes - Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

$sel:tableExcerpt:QueryResultItem', queryResultItem_tableExcerpt - An excerpt from a table within a document.

$sel:type':QueryResultItem', queryResultItem_type - The type of document within the response. For example, a response could include a question-answer that's relevant to the query.

queryResultItem_additionalAttributes :: Lens' QueryResultItem (Maybe [AdditionalResultAttribute]) Source #

One or more additional attributes associated with the query result.

queryResultItem_documentAttributes :: Lens' QueryResultItem (Maybe [DocumentAttribute]) Source #

An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

queryResultItem_documentExcerpt :: Lens' QueryResultItem (Maybe TextWithHighlights) Source #

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

queryResultItem_documentId :: Lens' QueryResultItem (Maybe Text) Source #

The identifier for the document.

queryResultItem_documentTitle :: Lens' QueryResultItem (Maybe TextWithHighlights) Source #

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

queryResultItem_documentURI :: Lens' QueryResultItem (Maybe Text) Source #

The URI of the original location of the document.

queryResultItem_feedbackToken :: Lens' QueryResultItem (Maybe Text) Source #

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

queryResultItem_format :: Lens' QueryResultItem (Maybe QueryResultFormat) Source #

If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.

queryResultItem_id :: Lens' QueryResultItem (Maybe Text) Source #

The identifier for the query result.

queryResultItem_scoreAttributes :: Lens' QueryResultItem (Maybe ScoreAttributes) Source #

Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

queryResultItem_tableExcerpt :: Lens' QueryResultItem (Maybe TableExcerpt) Source #

An excerpt from a table within a document.

queryResultItem_type :: Lens' QueryResultItem (Maybe QueryResultType) Source #

The type of document within the response. For example, a response could include a question-answer that's relevant to the query.

QuerySuggestionsBlockListSummary

data QuerySuggestionsBlockListSummary Source #

Summary information on a query suggestions block list.

This includes information on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

See: newQuerySuggestionsBlockListSummary smart constructor.

Constructors

QuerySuggestionsBlockListSummary'

Fields

createdAt :: Maybe POSIX
The date-time summary information for a query suggestions block list was last created.
id :: Maybe Text
The identifier of a block list.
itemCount :: Maybe Int
The number of items in the block list file.
name :: Maybe Text
The name of the block list.
status :: Maybe QuerySuggestionsBlockListStatus
The status of the block list.
updatedAt :: Maybe POSIX
The date-time the block list was last updated.

Instances

Instances details

FromJSON QuerySuggestionsBlockListSummary Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary Methods parseJSON :: Value -> Parser QuerySuggestionsBlockListSummary # parseJSONList :: Value -> Parser [QuerySuggestionsBlockListSummary] #
Generic QuerySuggestionsBlockListSummary Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary Associated Types type Rep QuerySuggestionsBlockListSummary :: Type -> Type # Methods from :: QuerySuggestionsBlockListSummary -> Rep QuerySuggestionsBlockListSummary x # to :: Rep QuerySuggestionsBlockListSummary x -> QuerySuggestionsBlockListSummary #
Read QuerySuggestionsBlockListSummary Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary Methods readsPrec :: Int -> ReadS QuerySuggestionsBlockListSummary # readList :: ReadS [QuerySuggestionsBlockListSummary] # readPrec :: ReadPrec QuerySuggestionsBlockListSummary # readListPrec :: ReadPrec [QuerySuggestionsBlockListSummary] #
Show QuerySuggestionsBlockListSummary Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary Methods showsPrec :: Int -> QuerySuggestionsBlockListSummary -> ShowS # show :: QuerySuggestionsBlockListSummary -> String # showList :: [QuerySuggestionsBlockListSummary] -> ShowS #
NFData QuerySuggestionsBlockListSummary Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary Methods rnf :: QuerySuggestionsBlockListSummary -> () #
Eq QuerySuggestionsBlockListSummary Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary Methods (==) :: QuerySuggestionsBlockListSummary -> QuerySuggestionsBlockListSummary -> Bool # (/=) :: QuerySuggestionsBlockListSummary -> QuerySuggestionsBlockListSummary -> Bool #
Hashable QuerySuggestionsBlockListSummary Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary Methods hashWithSalt :: Int -> QuerySuggestionsBlockListSummary -> Int # hash :: QuerySuggestionsBlockListSummary -> Int #
type Rep QuerySuggestionsBlockListSummary Source #
Instance details Defined in Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary type Rep QuerySuggestionsBlockListSummary = D1 ('MetaData "QuerySuggestionsBlockListSummary" "Amazonka.Kendra.Types.QuerySuggestionsBlockListSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "QuerySuggestionsBlockListSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "itemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuerySuggestionsBlockListStatus)) :*: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newQuerySuggestionsBlockListSummary :: QuerySuggestionsBlockListSummary Source #

Create a value of QuerySuggestionsBlockListSummary with all optional fields omitted.

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

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

$sel:createdAt:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_createdAt - The date-time summary information for a query suggestions block list was last created.

$sel:id:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_id - The identifier of a block list.

$sel:itemCount:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_itemCount - The number of items in the block list file.

$sel:name:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_name - The name of the block list.

$sel:status:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_status - The status of the block list.

$sel:updatedAt:QuerySuggestionsBlockListSummary', querySuggestionsBlockListSummary_updatedAt - The date-time the block list was last updated.

querySuggestionsBlockListSummary_createdAt :: Lens' QuerySuggestionsBlockListSummary (Maybe UTCTime) Source #

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

querySuggestionsBlockListSummary_id :: Lens' QuerySuggestionsBlockListSummary (Maybe Text) Source #

The identifier of a block list.

querySuggestionsBlockListSummary_itemCount :: Lens' QuerySuggestionsBlockListSummary (Maybe Int) Source #

The number of items in the block list file.

querySuggestionsBlockListSummary_name :: Lens' QuerySuggestionsBlockListSummary (Maybe Text) Source #

The name of the block list.

querySuggestionsBlockListSummary_status :: Lens' QuerySuggestionsBlockListSummary (Maybe QuerySuggestionsBlockListStatus) Source #

The status of the block list.

querySuggestionsBlockListSummary_updatedAt :: Lens' QuerySuggestionsBlockListSummary (Maybe UTCTime) Source #

The date-time the block list was last updated.

QuipConfiguration

data QuipConfiguration Source #

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

See: newQuipConfiguration smart constructor.

Constructors

QuipConfiguration'

Fields

attachmentFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
crawlAttachments :: Maybe Bool
TRUE to index attachments.
crawlChatRooms :: Maybe Bool
TRUE to index the contents of chat rooms.
crawlFileComments :: Maybe Bool
TRUE to index file comments.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain files in your Quip file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
folderIds :: Maybe [Text]
The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain files in your Quip file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
messageFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
threadFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
domain :: Text
The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:
- accessToken—The token created in Quip. For more information, see Using a Quip data source.

Instances

Instances details

FromJSON QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration Methods parseJSON :: Value -> Parser QuipConfiguration # parseJSONList :: Value -> Parser [QuipConfiguration] #
ToJSON QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration Methods toJSON :: QuipConfiguration -> Value # toEncoding :: QuipConfiguration -> Encoding # toJSONList :: [QuipConfiguration] -> Value # toEncodingList :: [QuipConfiguration] -> Encoding #
Generic QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration Associated Types type Rep QuipConfiguration :: Type -> Type # Methods from :: QuipConfiguration -> Rep QuipConfiguration x # to :: Rep QuipConfiguration x -> QuipConfiguration #
Read QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration Methods readsPrec :: Int -> ReadS QuipConfiguration # readList :: ReadS [QuipConfiguration] # readPrec :: ReadPrec QuipConfiguration # readListPrec :: ReadPrec [QuipConfiguration] #
Show QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration Methods showsPrec :: Int -> QuipConfiguration -> ShowS # show :: QuipConfiguration -> String # showList :: [QuipConfiguration] -> ShowS #
NFData QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration Methods rnf :: QuipConfiguration -> () #
Eq QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration Methods (==) :: QuipConfiguration -> QuipConfiguration -> Bool # (/=) :: QuipConfiguration -> QuipConfiguration -> Bool #
Hashable QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration Methods hashWithSalt :: Int -> QuipConfiguration -> Int # hash :: QuipConfiguration -> Int #
type Rep QuipConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.QuipConfiguration type Rep QuipConfiguration = D1 ('MetaData "QuipConfiguration" "Amazonka.Kendra.Types.QuipConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "QuipConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "crawlChatRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "crawlFileComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "folderIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "messageFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "threadFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newQuipConfiguration Source #

Arguments

:: Text	`$sel:domain:QuipConfiguration'`
-> Text	`$sel:secretArn:QuipConfiguration'`
-> QuipConfiguration

Create a value of QuipConfiguration with all optional fields omitted.

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

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

$sel:attachmentFieldMappings:QuipConfiguration', quipConfiguration_attachmentFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

$sel:crawlAttachments:QuipConfiguration', quipConfiguration_crawlAttachments - TRUE to index attachments.

$sel:crawlChatRooms:QuipConfiguration', quipConfiguration_crawlChatRooms - TRUE to index the contents of chat rooms.

$sel:crawlFileComments:QuipConfiguration', quipConfiguration_crawlFileComments - TRUE to index file comments.

$sel:exclusionPatterns:QuipConfiguration', quipConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain files in your Quip file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

$sel:folderIds:QuipConfiguration', quipConfiguration_folderIds - The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".

$sel:inclusionPatterns:QuipConfiguration', quipConfiguration_inclusionPatterns - A list of regular expression patterns to include certain files in your Quip file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

$sel:messageFieldMappings:QuipConfiguration', quipConfiguration_messageFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

$sel:threadFieldMappings:QuipConfiguration', quipConfiguration_threadFieldMappings - A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

$sel:vpcConfiguration:QuipConfiguration', quipConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

$sel:domain:QuipConfiguration', quipConfiguration_domain - The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".

$sel:secretArn:QuipConfiguration', quipConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:

accessToken—The token created in Quip. For more information, see Using a Quip data source.

quipConfiguration_attachmentFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

quipConfiguration_crawlAttachments :: Lens' QuipConfiguration (Maybe Bool) Source #

TRUE to index attachments.

quipConfiguration_crawlChatRooms :: Lens' QuipConfiguration (Maybe Bool) Source #

TRUE to index the contents of chat rooms.

quipConfiguration_crawlFileComments :: Lens' QuipConfiguration (Maybe Bool) Source #

TRUE to index file comments.

quipConfiguration_exclusionPatterns :: Lens' QuipConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain files in your Quip file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

quipConfiguration_folderIds :: Lens' QuipConfiguration (Maybe [Text]) Source #

The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".

quipConfiguration_inclusionPatterns :: Lens' QuipConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain files in your Quip file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

quipConfiguration_messageFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

quipConfiguration_threadFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

quipConfiguration_vpcConfiguration :: Lens' QuipConfiguration (Maybe DataSourceVpcConfiguration) Source #

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

quipConfiguration_domain :: Lens' QuipConfiguration Text Source #

The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".

quipConfiguration_secretArn :: Lens' QuipConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:

accessToken—The token created in Quip. For more information, see Using a Quip data source.

Relevance

data Relevance Source #

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

See: newRelevance smart constructor.

Constructors

Relevance'

Fields

duration :: Maybe Text
Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.
Only applies to DATE fields.
freshness :: Maybe Bool
Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.
importance :: Maybe Natural
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
rankOrder :: Maybe Order
Determines how values should be interpreted.
When the RankOrder field is ASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.
When the RankOrder field is DESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.
Only applies to LONG and DOUBLE fields.
valueImportanceMap :: Maybe (HashMap Text Natural)
A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.
For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

Instances

Instances details

FromJSON Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance Methods parseJSON :: Value -> Parser Relevance # parseJSONList :: Value -> Parser [Relevance] #
ToJSON Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance Methods toJSON :: Relevance -> Value # toEncoding :: Relevance -> Encoding # toJSONList :: [Relevance] -> Value # toEncodingList :: [Relevance] -> Encoding #
Generic Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance Associated Types type Rep Relevance :: Type -> Type # Methods from :: Relevance -> Rep Relevance x # to :: Rep Relevance x -> Relevance #
Read Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance Methods readsPrec :: Int -> ReadS Relevance # readList :: ReadS [Relevance] # readPrec :: ReadPrec Relevance # readListPrec :: ReadPrec [Relevance] #
Show Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance Methods showsPrec :: Int -> Relevance -> ShowS # show :: Relevance -> String # showList :: [Relevance] -> ShowS #
NFData Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance Methods rnf :: Relevance -> () #
Eq Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance Methods (==) :: Relevance -> Relevance -> Bool # (/=) :: Relevance -> Relevance -> Bool #
Hashable Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance Methods hashWithSalt :: Int -> Relevance -> Int # hash :: Relevance -> Int #
type Rep Relevance Source #
Instance details Defined in Amazonka.Kendra.Types.Relevance type Rep Relevance = D1 ('MetaData "Relevance" "Amazonka.Kendra.Types.Relevance" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Relevance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "freshness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "importance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "rankOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Order)) :: S1 ('MetaSel ('Just "valueImportanceMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Natural)))))))

newRelevance :: Relevance Source #

Create a value of Relevance with all optional fields omitted.

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

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

$sel:duration:Relevance', relevance_duration - Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

Only applies to DATE fields.

$sel:freshness:Relevance', relevance_freshness - Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

$sel:importance:Relevance', relevance_importance - The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

$sel:rankOrder:Relevance', relevance_rankOrder - Determines how values should be interpreted.

When the RankOrder field is ASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

When the RankOrder field is DESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

Only applies to LONG and DOUBLE fields.

$sel:valueImportanceMap:Relevance', relevance_valueImportanceMap - A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

relevance_duration :: Lens' Relevance (Maybe Text) Source #

Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

Only applies to DATE fields.

relevance_freshness :: Lens' Relevance (Maybe Bool) Source #

Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

relevance_importance :: Lens' Relevance (Maybe Natural) Source #

The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

relevance_rankOrder :: Lens' Relevance (Maybe Order) Source #

Determines how values should be interpreted.

When the RankOrder field is ASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

When the RankOrder field is DESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

Only applies to LONG and DOUBLE fields.

relevance_valueImportanceMap :: Lens' Relevance (Maybe (HashMap Text Natural)) Source #

A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

RelevanceFeedback

data RelevanceFeedback Source #

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback API to provide relevance information.

See: newRelevanceFeedback smart constructor.

Constructors

RelevanceFeedback'
Fields resultId :: Text The identifier of the search result that the user provided relevance feedback for. relevanceValue :: RelevanceType Whether to document was relevant or not relevant to the search.

Instances

Instances details

ToJSON RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods toJSON :: RelevanceFeedback -> Value # toEncoding :: RelevanceFeedback -> Encoding # toJSONList :: [RelevanceFeedback] -> Value # toEncodingList :: [RelevanceFeedback] -> Encoding #
Generic RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Associated Types type Rep RelevanceFeedback :: Type -> Type # Methods from :: RelevanceFeedback -> Rep RelevanceFeedback x # to :: Rep RelevanceFeedback x -> RelevanceFeedback #
Read RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods readsPrec :: Int -> ReadS RelevanceFeedback # readList :: ReadS [RelevanceFeedback] # readPrec :: ReadPrec RelevanceFeedback # readListPrec :: ReadPrec [RelevanceFeedback] #
Show RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods showsPrec :: Int -> RelevanceFeedback -> ShowS # show :: RelevanceFeedback -> String # showList :: [RelevanceFeedback] -> ShowS #
NFData RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods rnf :: RelevanceFeedback -> () #
Eq RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods (==) :: RelevanceFeedback -> RelevanceFeedback -> Bool # (/=) :: RelevanceFeedback -> RelevanceFeedback -> Bool #
Hashable RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods hashWithSalt :: Int -> RelevanceFeedback -> Int # hash :: RelevanceFeedback -> Int #
type Rep RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback type Rep RelevanceFeedback = D1 ('MetaData "RelevanceFeedback" "Amazonka.Kendra.Types.RelevanceFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "RelevanceFeedback'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "relevanceValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelevanceType)))

newRelevanceFeedback Source #

Arguments

:: Text	`$sel:resultId:RelevanceFeedback'`
-> RelevanceType	`$sel:relevanceValue:RelevanceFeedback'`
-> RelevanceFeedback

Create a value of RelevanceFeedback with all optional fields omitted.

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

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

$sel:resultId:RelevanceFeedback', relevanceFeedback_resultId - The identifier of the search result that the user provided relevance feedback for.

$sel:relevanceValue:RelevanceFeedback', relevanceFeedback_relevanceValue - Whether to document was relevant or not relevant to the search.

relevanceFeedback_resultId :: Lens' RelevanceFeedback Text Source #

The identifier of the search result that the user provided relevance feedback for.

relevanceFeedback_relevanceValue :: Lens' RelevanceFeedback RelevanceType Source #

Whether to document was relevant or not relevant to the search.

S3DataSourceConfiguration

data S3DataSourceConfiguration Source #

Provides the configuration information to connect to an Amazon S3 bucket.

See: newS3DataSourceConfiguration smart constructor.

Constructors

S3DataSourceConfiguration'

Fields

accessControlListConfiguration :: Maybe AccessControlListConfiguration
Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.
documentsMetadataConfiguration :: Maybe DocumentsMetadataConfiguration
exclusionPatterns :: Maybe [Text]
A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.
Some examples are:
- *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
- *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
- **/*internal* will exclude all internal-related files in a directory and its subdirectories.
inclusionPatterns :: Maybe [Text]
A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.
Some examples are:
- *.txt will include all text files in a directory (files with the extension .txt).
- **/*.txt will include all text files in a directory and its subdirectories.
- *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.
inclusionPrefixes :: Maybe [Text]
A list of S3 prefixes for the documents that should be included in the index.
bucketName :: Text
The name of the bucket that contains the documents.

Instances

Instances details

FromJSON S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration Methods parseJSON :: Value -> Parser S3DataSourceConfiguration # parseJSONList :: Value -> Parser [S3DataSourceConfiguration] #
ToJSON S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration Methods toJSON :: S3DataSourceConfiguration -> Value # toEncoding :: S3DataSourceConfiguration -> Encoding # toJSONList :: [S3DataSourceConfiguration] -> Value # toEncodingList :: [S3DataSourceConfiguration] -> Encoding #
Generic S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration Associated Types type Rep S3DataSourceConfiguration :: Type -> Type # Methods from :: S3DataSourceConfiguration -> Rep S3DataSourceConfiguration x # to :: Rep S3DataSourceConfiguration x -> S3DataSourceConfiguration #
Read S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration Methods readsPrec :: Int -> ReadS S3DataSourceConfiguration # readList :: ReadS [S3DataSourceConfiguration] # readPrec :: ReadPrec S3DataSourceConfiguration # readListPrec :: ReadPrec [S3DataSourceConfiguration] #
Show S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration Methods showsPrec :: Int -> S3DataSourceConfiguration -> ShowS # show :: S3DataSourceConfiguration -> String # showList :: [S3DataSourceConfiguration] -> ShowS #
NFData S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration Methods rnf :: S3DataSourceConfiguration -> () #
Eq S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration Methods (==) :: S3DataSourceConfiguration -> S3DataSourceConfiguration -> Bool # (/=) :: S3DataSourceConfiguration -> S3DataSourceConfiguration -> Bool #
Hashable S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration Methods hashWithSalt :: Int -> S3DataSourceConfiguration -> Int # hash :: S3DataSourceConfiguration -> Int #
type Rep S3DataSourceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.S3DataSourceConfiguration type Rep S3DataSourceConfiguration = D1 ('MetaData "S3DataSourceConfiguration" "Amazonka.Kendra.Types.S3DataSourceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "S3DataSourceConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessControlListConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessControlListConfiguration)) :: (S1 ('MetaSel ('Just "documentsMetadataConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentsMetadataConfiguration)) :: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "inclusionPrefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newS3DataSourceConfiguration Source #

Arguments

:: Text	`$sel:bucketName:S3DataSourceConfiguration'`
-> S3DataSourceConfiguration

Create a value of S3DataSourceConfiguration with all optional fields omitted.

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

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

$sel:accessControlListConfiguration:S3DataSourceConfiguration', s3DataSourceConfiguration_accessControlListConfiguration - Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

$sel:documentsMetadataConfiguration:S3DataSourceConfiguration', s3DataSourceConfiguration_documentsMetadataConfiguration - Undocumented member.

$sel:exclusionPatterns:S3DataSourceConfiguration', s3DataSourceConfiguration_exclusionPatterns - A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples are:

*.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/*internal* will exclude all internal-related files in a directory and its subdirectories.

$sel:inclusionPatterns:S3DataSourceConfiguration', s3DataSourceConfiguration_inclusionPatterns - A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples are:

*.txt will include all text files in a directory (files with the extension .txt).
**/*.txt will include all text files in a directory and its subdirectories.
*tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

$sel:inclusionPrefixes:S3DataSourceConfiguration', s3DataSourceConfiguration_inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.

$sel:bucketName:S3DataSourceConfiguration', s3DataSourceConfiguration_bucketName - The name of the bucket that contains the documents.

s3DataSourceConfiguration_accessControlListConfiguration :: Lens' S3DataSourceConfiguration (Maybe AccessControlListConfiguration) Source #

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

s3DataSourceConfiguration_documentsMetadataConfiguration :: Lens' S3DataSourceConfiguration (Maybe DocumentsMetadataConfiguration) Source #

Undocumented member.

s3DataSourceConfiguration_exclusionPatterns :: Lens' S3DataSourceConfiguration (Maybe [Text]) Source #

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples are:

*.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
*internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/*internal* will exclude all internal-related files in a directory and its subdirectories.

s3DataSourceConfiguration_inclusionPatterns :: Lens' S3DataSourceConfiguration (Maybe [Text]) Source #

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples are:

*.txt will include all text files in a directory (files with the extension .txt).
**/*.txt will include all text files in a directory and its subdirectories.
*tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

s3DataSourceConfiguration_inclusionPrefixes :: Lens' S3DataSourceConfiguration (Maybe [Text]) Source #

A list of S3 prefixes for the documents that should be included in the index.

s3DataSourceConfiguration_bucketName :: Lens' S3DataSourceConfiguration Text Source #

The name of the bucket that contains the documents.

S3Path

data S3Path Source #

Information required to find a specific file in an Amazon S3 bucket.

See: newS3Path smart constructor.

Constructors

S3Path'
Fields bucket :: Text The name of the S3 bucket that contains the file. key :: Text The name of the file.

Instances

Instances details

FromJSON S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path Methods parseJSON :: Value -> Parser S3Path # parseJSONList :: Value -> Parser [S3Path] #
ToJSON S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path Methods toJSON :: S3Path -> Value # toEncoding :: S3Path -> Encoding # toJSONList :: [S3Path] -> Value # toEncodingList :: [S3Path] -> Encoding #
Generic S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path Associated Types type Rep S3Path :: Type -> Type # Methods from :: S3Path -> Rep S3Path x # to :: Rep S3Path x -> S3Path #
Read S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path Methods readsPrec :: Int -> ReadS S3Path # readList :: ReadS [S3Path] # readPrec :: ReadPrec S3Path # readListPrec :: ReadPrec [S3Path] #
Show S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path Methods showsPrec :: Int -> S3Path -> ShowS # show :: S3Path -> String # showList :: [S3Path] -> ShowS #
NFData S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path Methods rnf :: S3Path -> () #
Eq S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path Methods (==) :: S3Path -> S3Path -> Bool # (/=) :: S3Path -> S3Path -> Bool #
Hashable S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path Methods hashWithSalt :: Int -> S3Path -> Int # hash :: S3Path -> Int #
type Rep S3Path Source #
Instance details Defined in Amazonka.Kendra.Types.S3Path type Rep S3Path = D1 ('MetaData "S3Path" "Amazonka.Kendra.Types.S3Path" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "S3Path'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newS3Path Source #

Arguments

:: Text	`$sel:bucket:S3Path'`
-> Text	`$sel:key:S3Path'`
-> S3Path

Create a value of S3Path with all optional fields omitted.

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

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

$sel:bucket:S3Path', s3Path_bucket - The name of the S3 bucket that contains the file.

$sel:key:S3Path', s3Path_key - The name of the file.

s3Path_bucket :: Lens' S3Path Text Source #

The name of the S3 bucket that contains the file.

s3Path_key :: Lens' S3Path Text Source #

The name of the file.

SaaSConfiguration

data SaaSConfiguration Source #

Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).

See: newSaaSConfiguration smart constructor.

Constructors

SaaSConfiguration'
Fields organizationName :: Text The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown. hostUrl :: Text The GitHub host URL or API endpoint URL. For example, https://api.github.com.

Instances

Instances details

FromJSON SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration Methods parseJSON :: Value -> Parser SaaSConfiguration # parseJSONList :: Value -> Parser [SaaSConfiguration] #
ToJSON SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration Methods toJSON :: SaaSConfiguration -> Value # toEncoding :: SaaSConfiguration -> Encoding # toJSONList :: [SaaSConfiguration] -> Value # toEncodingList :: [SaaSConfiguration] -> Encoding #
Generic SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration Associated Types type Rep SaaSConfiguration :: Type -> Type # Methods from :: SaaSConfiguration -> Rep SaaSConfiguration x # to :: Rep SaaSConfiguration x -> SaaSConfiguration #
Read SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration Methods readsPrec :: Int -> ReadS SaaSConfiguration # readList :: ReadS [SaaSConfiguration] # readPrec :: ReadPrec SaaSConfiguration # readListPrec :: ReadPrec [SaaSConfiguration] #
Show SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration Methods showsPrec :: Int -> SaaSConfiguration -> ShowS # show :: SaaSConfiguration -> String # showList :: [SaaSConfiguration] -> ShowS #
NFData SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration Methods rnf :: SaaSConfiguration -> () #
Eq SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration Methods (==) :: SaaSConfiguration -> SaaSConfiguration -> Bool # (/=) :: SaaSConfiguration -> SaaSConfiguration -> Bool #
Hashable SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration Methods hashWithSalt :: Int -> SaaSConfiguration -> Int # hash :: SaaSConfiguration -> Int #
type Rep SaaSConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SaaSConfiguration type Rep SaaSConfiguration = D1 ('MetaData "SaaSConfiguration" "Amazonka.Kendra.Types.SaaSConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SaaSConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "hostUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSaaSConfiguration Source #

Arguments

:: Text	`$sel:organizationName:SaaSConfiguration'`
-> Text	`$sel:hostUrl:SaaSConfiguration'`
-> SaaSConfiguration

Create a value of SaaSConfiguration with all optional fields omitted.

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

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

$sel:organizationName:SaaSConfiguration', saaSConfiguration_organizationName - The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.

$sel:hostUrl:SaaSConfiguration', saaSConfiguration_hostUrl - The GitHub host URL or API endpoint URL. For example, https://api.github.com.

saaSConfiguration_organizationName :: Lens' SaaSConfiguration Text Source #

The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting Your organizations under your profile picture dropdown.

saaSConfiguration_hostUrl :: Lens' SaaSConfiguration Text Source #

The GitHub host URL or API endpoint URL. For example, https://api.github.com.

SalesforceChatterFeedConfiguration

data SalesforceChatterFeedConfiguration Source #

The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.

See: newSalesforceChatterFeedConfiguration smart constructor.

Constructors

SalesforceChatterFeedConfiguration'

Fields

documentTitleFieldName :: Maybe Text
The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
includeFilterTypes :: Maybe (NonEmpty SalesforceChatterFeedIncludeFilterType)
Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.
documentDataFieldName :: Text
The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

Instances

Instances details

FromJSON SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration Methods parseJSON :: Value -> Parser SalesforceChatterFeedConfiguration # parseJSONList :: Value -> Parser [SalesforceChatterFeedConfiguration] #
ToJSON SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration Methods toJSON :: SalesforceChatterFeedConfiguration -> Value # toEncoding :: SalesforceChatterFeedConfiguration -> Encoding # toJSONList :: [SalesforceChatterFeedConfiguration] -> Value # toEncodingList :: [SalesforceChatterFeedConfiguration] -> Encoding #
Generic SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration Associated Types type Rep SalesforceChatterFeedConfiguration :: Type -> Type # Methods from :: SalesforceChatterFeedConfiguration -> Rep SalesforceChatterFeedConfiguration x # to :: Rep SalesforceChatterFeedConfiguration x -> SalesforceChatterFeedConfiguration #
Read SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration Methods readsPrec :: Int -> ReadS SalesforceChatterFeedConfiguration # readList :: ReadS [SalesforceChatterFeedConfiguration] # readPrec :: ReadPrec SalesforceChatterFeedConfiguration # readListPrec :: ReadPrec [SalesforceChatterFeedConfiguration] #
Show SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration Methods showsPrec :: Int -> SalesforceChatterFeedConfiguration -> ShowS # show :: SalesforceChatterFeedConfiguration -> String # showList :: [SalesforceChatterFeedConfiguration] -> ShowS #
NFData SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration Methods rnf :: SalesforceChatterFeedConfiguration -> () #
Eq SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration Methods (==) :: SalesforceChatterFeedConfiguration -> SalesforceChatterFeedConfiguration -> Bool # (/=) :: SalesforceChatterFeedConfiguration -> SalesforceChatterFeedConfiguration -> Bool #
Hashable SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration Methods hashWithSalt :: Int -> SalesforceChatterFeedConfiguration -> Int # hash :: SalesforceChatterFeedConfiguration -> Int #
type Rep SalesforceChatterFeedConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration type Rep SalesforceChatterFeedConfiguration = D1 ('MetaData "SalesforceChatterFeedConfiguration" "Amazonka.Kendra.Types.SalesforceChatterFeedConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceChatterFeedConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "includeFilterTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SalesforceChatterFeedIncludeFilterType))) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSalesforceChatterFeedConfiguration Source #

Arguments

:: Text	`$sel:documentDataFieldName:SalesforceChatterFeedConfiguration'`
-> SalesforceChatterFeedConfiguration

Create a value of SalesforceChatterFeedConfiguration with all optional fields omitted.

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

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

$sel:documentTitleFieldName:SalesforceChatterFeedConfiguration', salesforceChatterFeedConfiguration_documentTitleFieldName - The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.

$sel:fieldMappings:SalesforceChatterFeedConfiguration', salesforceChatterFeedConfiguration_fieldMappings - Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

$sel:includeFilterTypes:SalesforceChatterFeedConfiguration', salesforceChatterFeedConfiguration_includeFilterTypes - Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

$sel:documentDataFieldName:SalesforceChatterFeedConfiguration', salesforceChatterFeedConfiguration_documentDataFieldName - The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

salesforceChatterFeedConfiguration_documentTitleFieldName :: Lens' SalesforceChatterFeedConfiguration (Maybe Text) Source #

The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.

salesforceChatterFeedConfiguration_fieldMappings :: Lens' SalesforceChatterFeedConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

salesforceChatterFeedConfiguration_includeFilterTypes :: Lens' SalesforceChatterFeedConfiguration (Maybe (NonEmpty SalesforceChatterFeedIncludeFilterType)) Source #

Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

salesforceChatterFeedConfiguration_documentDataFieldName :: Lens' SalesforceChatterFeedConfiguration Text Source #

The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.

SalesforceConfiguration

data SalesforceConfiguration Source #

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

See: newSalesforceConfiguration smart constructor.

Constructors

SalesforceConfiguration'

Fields

chatterFeedConfiguration :: Maybe SalesforceChatterFeedConfiguration
Configuration information for Salesforce chatter feeds.
crawlAttachments :: Maybe Bool
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
excludeAttachmentFilePatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
includeAttachmentFilePatterns :: Maybe [Text]
A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
knowledgeArticleConfiguration :: Maybe SalesforceKnowledgeArticleConfiguration
Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.
standardObjectAttachmentConfiguration :: Maybe SalesforceStandardObjectAttachmentConfiguration
Configuration information for processing attachments to Salesforce standard objects.
standardObjectConfigurations :: Maybe (NonEmpty SalesforceStandardObjectConfiguration)
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
serverUrl :: Text
The instance URL for the Salesforce site that you want to index.
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
- authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
- consumerKey - The application public key generated when you created your Salesforce application.
- consumerSecret - The application private key generated when you created your Salesforce application.
- password - The password associated with the user logging in to the Salesforce instance.
- securityToken - The token associated with the user account logging in to the Salesforce instance.
- username - The user name of the user logging in to the Salesforce instance.

Instances

Instances details

FromJSON SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration Methods parseJSON :: Value -> Parser SalesforceConfiguration # parseJSONList :: Value -> Parser [SalesforceConfiguration] #
ToJSON SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration Methods toJSON :: SalesforceConfiguration -> Value # toEncoding :: SalesforceConfiguration -> Encoding # toJSONList :: [SalesforceConfiguration] -> Value # toEncodingList :: [SalesforceConfiguration] -> Encoding #
Generic SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration Associated Types type Rep SalesforceConfiguration :: Type -> Type # Methods from :: SalesforceConfiguration -> Rep SalesforceConfiguration x # to :: Rep SalesforceConfiguration x -> SalesforceConfiguration #
Read SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration Methods readsPrec :: Int -> ReadS SalesforceConfiguration # readList :: ReadS [SalesforceConfiguration] # readPrec :: ReadPrec SalesforceConfiguration # readListPrec :: ReadPrec [SalesforceConfiguration] #
Show SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration Methods showsPrec :: Int -> SalesforceConfiguration -> ShowS # show :: SalesforceConfiguration -> String # showList :: [SalesforceConfiguration] -> ShowS #
NFData SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration Methods rnf :: SalesforceConfiguration -> () #
Eq SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration Methods (==) :: SalesforceConfiguration -> SalesforceConfiguration -> Bool # (/=) :: SalesforceConfiguration -> SalesforceConfiguration -> Bool #
Hashable SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration Methods hashWithSalt :: Int -> SalesforceConfiguration -> Int # hash :: SalesforceConfiguration -> Int #
type Rep SalesforceConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceConfiguration type Rep SalesforceConfiguration = D1 ('MetaData "SalesforceConfiguration" "Amazonka.Kendra.Types.SalesforceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "chatterFeedConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceChatterFeedConfiguration)) :: S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "excludeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "includeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "knowledgeArticleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceKnowledgeArticleConfiguration)) :: S1 ('MetaSel ('Just "standardObjectAttachmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceStandardObjectAttachmentConfiguration))) :: (S1 ('MetaSel ('Just "standardObjectConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SalesforceStandardObjectConfiguration))) :: (S1 ('MetaSel ('Just "serverUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSalesforceConfiguration Source #

Arguments

:: Text	`$sel:serverUrl:SalesforceConfiguration'`
-> Text	`$sel:secretArn:SalesforceConfiguration'`
-> SalesforceConfiguration

Create a value of SalesforceConfiguration with all optional fields omitted.

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

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

$sel:chatterFeedConfiguration:SalesforceConfiguration', salesforceConfiguration_chatterFeedConfiguration - Configuration information for Salesforce chatter feeds.

$sel:crawlAttachments:SalesforceConfiguration', salesforceConfiguration_crawlAttachments - Indicates whether Amazon Kendra should index attachments to Salesforce objects.

$sel:excludeAttachmentFilePatterns:SalesforceConfiguration', salesforceConfiguration_excludeAttachmentFilePatterns - A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

$sel:includeAttachmentFilePatterns:SalesforceConfiguration', salesforceConfiguration_includeAttachmentFilePatterns - A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

$sel:knowledgeArticleConfiguration:SalesforceConfiguration', salesforceConfiguration_knowledgeArticleConfiguration - Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

$sel:standardObjectAttachmentConfiguration:SalesforceConfiguration', salesforceConfiguration_standardObjectAttachmentConfiguration - Configuration information for processing attachments to Salesforce standard objects.

$sel:standardObjectConfigurations:SalesforceConfiguration', salesforceConfiguration_standardObjectConfigurations - Configuration of the Salesforce standard objects that Amazon Kendra indexes.

$sel:serverUrl:SalesforceConfiguration', salesforceConfiguration_serverUrl - The instance URL for the Salesforce site that you want to index.

$sel:secretArn:SalesforceConfiguration', salesforceConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user account logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

salesforceConfiguration_chatterFeedConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceChatterFeedConfiguration) Source #

Configuration information for Salesforce chatter feeds.

salesforceConfiguration_crawlAttachments :: Lens' SalesforceConfiguration (Maybe Bool) Source #

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

salesforceConfiguration_excludeAttachmentFilePatterns :: Lens' SalesforceConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

salesforceConfiguration_includeAttachmentFilePatterns :: Lens' SalesforceConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

salesforceConfiguration_knowledgeArticleConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceKnowledgeArticleConfiguration) Source #

Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

salesforceConfiguration_standardObjectAttachmentConfiguration :: Lens' SalesforceConfiguration (Maybe SalesforceStandardObjectAttachmentConfiguration) Source #

Configuration information for processing attachments to Salesforce standard objects.

salesforceConfiguration_standardObjectConfigurations :: Lens' SalesforceConfiguration (Maybe (NonEmpty SalesforceStandardObjectConfiguration)) Source #

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

salesforceConfiguration_serverUrl :: Lens' SalesforceConfiguration Text Source #

The instance URL for the Salesforce site that you want to index.

salesforceConfiguration_secretArn :: Lens' SalesforceConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user account logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

SalesforceCustomKnowledgeArticleTypeConfiguration

data SalesforceCustomKnowledgeArticleTypeConfiguration Source #

Provides the configuration information for indexing Salesforce custom articles.

See: newSalesforceCustomKnowledgeArticleTypeConfiguration smart constructor.

Constructors

SalesforceCustomKnowledgeArticleTypeConfiguration'

Fields

documentTitleFieldName :: Maybe Text
The name of the field in the custom knowledge article that contains the document title.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.
name :: Text
The name of the configuration.
documentDataFieldName :: Text
The name of the field in the custom knowledge article that contains the document data to index.

Instances

Instances details

FromJSON SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration Methods parseJSON :: Value -> Parser SalesforceCustomKnowledgeArticleTypeConfiguration # parseJSONList :: Value -> Parser [SalesforceCustomKnowledgeArticleTypeConfiguration] #
ToJSON SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration Methods toJSON :: SalesforceCustomKnowledgeArticleTypeConfiguration -> Value # toEncoding :: SalesforceCustomKnowledgeArticleTypeConfiguration -> Encoding # toJSONList :: [SalesforceCustomKnowledgeArticleTypeConfiguration] -> Value # toEncodingList :: [SalesforceCustomKnowledgeArticleTypeConfiguration] -> Encoding #
Generic SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration Associated Types type Rep SalesforceCustomKnowledgeArticleTypeConfiguration :: Type -> Type # Methods from :: SalesforceCustomKnowledgeArticleTypeConfiguration -> Rep SalesforceCustomKnowledgeArticleTypeConfiguration x # to :: Rep SalesforceCustomKnowledgeArticleTypeConfiguration x -> SalesforceCustomKnowledgeArticleTypeConfiguration #
Read SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration Methods readsPrec :: Int -> ReadS SalesforceCustomKnowledgeArticleTypeConfiguration # readList :: ReadS [SalesforceCustomKnowledgeArticleTypeConfiguration] # readPrec :: ReadPrec SalesforceCustomKnowledgeArticleTypeConfiguration # readListPrec :: ReadPrec [SalesforceCustomKnowledgeArticleTypeConfiguration] #
Show SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration Methods showsPrec :: Int -> SalesforceCustomKnowledgeArticleTypeConfiguration -> ShowS # show :: SalesforceCustomKnowledgeArticleTypeConfiguration -> String # showList :: [SalesforceCustomKnowledgeArticleTypeConfiguration] -> ShowS #
NFData SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration Methods rnf :: SalesforceCustomKnowledgeArticleTypeConfiguration -> () #
Eq SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration Methods (==) :: SalesforceCustomKnowledgeArticleTypeConfiguration -> SalesforceCustomKnowledgeArticleTypeConfiguration -> Bool # (/=) :: SalesforceCustomKnowledgeArticleTypeConfiguration -> SalesforceCustomKnowledgeArticleTypeConfiguration -> Bool #
Hashable SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration Methods hashWithSalt :: Int -> SalesforceCustomKnowledgeArticleTypeConfiguration -> Int # hash :: SalesforceCustomKnowledgeArticleTypeConfiguration -> Int #
type Rep SalesforceCustomKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration type Rep SalesforceCustomKnowledgeArticleTypeConfiguration = D1 ('MetaData "SalesforceCustomKnowledgeArticleTypeConfiguration" "Amazonka.Kendra.Types.SalesforceCustomKnowledgeArticleTypeConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceCustomKnowledgeArticleTypeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSalesforceCustomKnowledgeArticleTypeConfiguration Source #

Arguments

:: Text	`$sel:name:SalesforceCustomKnowledgeArticleTypeConfiguration'`
-> Text	`$sel:documentDataFieldName:SalesforceCustomKnowledgeArticleTypeConfiguration'`
-> SalesforceCustomKnowledgeArticleTypeConfiguration

Create a value of SalesforceCustomKnowledgeArticleTypeConfiguration with all optional fields omitted.

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

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

$sel:documentTitleFieldName:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_documentTitleFieldName - The name of the field in the custom knowledge article that contains the document title.

$sel:fieldMappings:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_fieldMappings - Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

$sel:name:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_name - The name of the configuration.

$sel:documentDataFieldName:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_documentDataFieldName - The name of the field in the custom knowledge article that contains the document data to index.

salesforceCustomKnowledgeArticleTypeConfiguration_documentTitleFieldName :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration (Maybe Text) Source #

The name of the field in the custom knowledge article that contains the document title.

salesforceCustomKnowledgeArticleTypeConfiguration_fieldMappings :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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

salesforceCustomKnowledgeArticleTypeConfiguration_name :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration Text Source #

The name of the configuration.

salesforceCustomKnowledgeArticleTypeConfiguration_documentDataFieldName :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration Text Source #

The name of the field in the custom knowledge article that contains the document data to index.

SalesforceKnowledgeArticleConfiguration

data SalesforceKnowledgeArticleConfiguration Source #

Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

See: newSalesforceKnowledgeArticleConfiguration smart constructor.

Constructors

SalesforceKnowledgeArticleConfiguration'

Fields

customKnowledgeArticleTypeConfigurations :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
Configuration information for custom Salesforce knowledge articles.
standardKnowledgeArticleTypeConfiguration :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
Configuration information for standard Salesforce knowledge articles.
includedStates :: NonEmpty SalesforceKnowledgeArticleState
Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Instances

Instances details

FromJSON SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration Methods parseJSON :: Value -> Parser SalesforceKnowledgeArticleConfiguration # parseJSONList :: Value -> Parser [SalesforceKnowledgeArticleConfiguration] #
ToJSON SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration Methods toJSON :: SalesforceKnowledgeArticleConfiguration -> Value # toEncoding :: SalesforceKnowledgeArticleConfiguration -> Encoding # toJSONList :: [SalesforceKnowledgeArticleConfiguration] -> Value # toEncodingList :: [SalesforceKnowledgeArticleConfiguration] -> Encoding #
Generic SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration Associated Types type Rep SalesforceKnowledgeArticleConfiguration :: Type -> Type # Methods from :: SalesforceKnowledgeArticleConfiguration -> Rep SalesforceKnowledgeArticleConfiguration x # to :: Rep SalesforceKnowledgeArticleConfiguration x -> SalesforceKnowledgeArticleConfiguration #
Read SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration Methods readsPrec :: Int -> ReadS SalesforceKnowledgeArticleConfiguration # readList :: ReadS [SalesforceKnowledgeArticleConfiguration] # readPrec :: ReadPrec SalesforceKnowledgeArticleConfiguration # readListPrec :: ReadPrec [SalesforceKnowledgeArticleConfiguration] #
Show SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration Methods showsPrec :: Int -> SalesforceKnowledgeArticleConfiguration -> ShowS # show :: SalesforceKnowledgeArticleConfiguration -> String # showList :: [SalesforceKnowledgeArticleConfiguration] -> ShowS #
NFData SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration Methods rnf :: SalesforceKnowledgeArticleConfiguration -> () #
Eq SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration Methods (==) :: SalesforceKnowledgeArticleConfiguration -> SalesforceKnowledgeArticleConfiguration -> Bool # (/=) :: SalesforceKnowledgeArticleConfiguration -> SalesforceKnowledgeArticleConfiguration -> Bool #
Hashable SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration Methods hashWithSalt :: Int -> SalesforceKnowledgeArticleConfiguration -> Int # hash :: SalesforceKnowledgeArticleConfiguration -> Int #
type Rep SalesforceKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration type Rep SalesforceKnowledgeArticleConfiguration = D1 ('MetaData "SalesforceKnowledgeArticleConfiguration" "Amazonka.Kendra.Types.SalesforceKnowledgeArticleConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceKnowledgeArticleConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKnowledgeArticleTypeConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration))) :: (S1 ('MetaSel ('Just "standardKnowledgeArticleTypeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SalesforceStandardKnowledgeArticleTypeConfiguration)) :: S1 ('MetaSel ('Just "includedStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SalesforceKnowledgeArticleState)))))

newSalesforceKnowledgeArticleConfiguration Source #

Arguments

:: NonEmpty SalesforceKnowledgeArticleState	`$sel:includedStates:SalesforceKnowledgeArticleConfiguration'`
-> SalesforceKnowledgeArticleConfiguration

Create a value of SalesforceKnowledgeArticleConfiguration with all optional fields omitted.

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

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

$sel:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations - Configuration information for custom Salesforce knowledge articles.

$sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration - Configuration information for standard Salesforce knowledge articles.

$sel:includedStates:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_includedStates - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations :: Lens' SalesforceKnowledgeArticleConfiguration (Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)) Source #

Configuration information for custom Salesforce knowledge articles.

salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration :: Lens' SalesforceKnowledgeArticleConfiguration (Maybe SalesforceStandardKnowledgeArticleTypeConfiguration) Source #

Configuration information for standard Salesforce knowledge articles.

salesforceKnowledgeArticleConfiguration_includedStates :: Lens' SalesforceKnowledgeArticleConfiguration (NonEmpty SalesforceKnowledgeArticleState) Source #

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

SalesforceStandardKnowledgeArticleTypeConfiguration

data SalesforceStandardKnowledgeArticleTypeConfiguration Source #

Provides the configuration information for standard Salesforce knowledge articles.

See: newSalesforceStandardKnowledgeArticleTypeConfiguration smart constructor.

Constructors

SalesforceStandardKnowledgeArticleTypeConfiguration'

Fields

documentTitleFieldName :: Maybe Text
The name of the field that contains the document title.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.
documentDataFieldName :: Text
The name of the field that contains the document data to index.

Instances

Instances details

FromJSON SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration Methods parseJSON :: Value -> Parser SalesforceStandardKnowledgeArticleTypeConfiguration # parseJSONList :: Value -> Parser [SalesforceStandardKnowledgeArticleTypeConfiguration] #
ToJSON SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration Methods toJSON :: SalesforceStandardKnowledgeArticleTypeConfiguration -> Value # toEncoding :: SalesforceStandardKnowledgeArticleTypeConfiguration -> Encoding # toJSONList :: [SalesforceStandardKnowledgeArticleTypeConfiguration] -> Value # toEncodingList :: [SalesforceStandardKnowledgeArticleTypeConfiguration] -> Encoding #
Generic SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration Associated Types type Rep SalesforceStandardKnowledgeArticleTypeConfiguration :: Type -> Type # Methods from :: SalesforceStandardKnowledgeArticleTypeConfiguration -> Rep SalesforceStandardKnowledgeArticleTypeConfiguration x # to :: Rep SalesforceStandardKnowledgeArticleTypeConfiguration x -> SalesforceStandardKnowledgeArticleTypeConfiguration #
Read SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration Methods readsPrec :: Int -> ReadS SalesforceStandardKnowledgeArticleTypeConfiguration # readList :: ReadS [SalesforceStandardKnowledgeArticleTypeConfiguration] # readPrec :: ReadPrec SalesforceStandardKnowledgeArticleTypeConfiguration # readListPrec :: ReadPrec [SalesforceStandardKnowledgeArticleTypeConfiguration] #
Show SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration Methods showsPrec :: Int -> SalesforceStandardKnowledgeArticleTypeConfiguration -> ShowS # show :: SalesforceStandardKnowledgeArticleTypeConfiguration -> String # showList :: [SalesforceStandardKnowledgeArticleTypeConfiguration] -> ShowS #
NFData SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration Methods rnf :: SalesforceStandardKnowledgeArticleTypeConfiguration -> () #
Eq SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration Methods (==) :: SalesforceStandardKnowledgeArticleTypeConfiguration -> SalesforceStandardKnowledgeArticleTypeConfiguration -> Bool # (/=) :: SalesforceStandardKnowledgeArticleTypeConfiguration -> SalesforceStandardKnowledgeArticleTypeConfiguration -> Bool #
Hashable SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration Methods hashWithSalt :: Int -> SalesforceStandardKnowledgeArticleTypeConfiguration -> Int # hash :: SalesforceStandardKnowledgeArticleTypeConfiguration -> Int #
type Rep SalesforceStandardKnowledgeArticleTypeConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration type Rep SalesforceStandardKnowledgeArticleTypeConfiguration = D1 ('MetaData "SalesforceStandardKnowledgeArticleTypeConfiguration" "Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceStandardKnowledgeArticleTypeConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSalesforceStandardKnowledgeArticleTypeConfiguration Source #

Arguments

:: Text	`$sel:documentDataFieldName:SalesforceStandardKnowledgeArticleTypeConfiguration'`
-> SalesforceStandardKnowledgeArticleTypeConfiguration

Create a value of SalesforceStandardKnowledgeArticleTypeConfiguration with all optional fields omitted.

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

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

$sel:documentTitleFieldName:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_documentTitleFieldName - The name of the field that contains the document title.

$sel:fieldMappings:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_fieldMappings - Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

$sel:documentDataFieldName:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_documentDataFieldName - The name of the field that contains the document data to index.

salesforceStandardKnowledgeArticleTypeConfiguration_documentTitleFieldName :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration (Maybe Text) Source #

The name of the field that contains the document title.

salesforceStandardKnowledgeArticleTypeConfiguration_fieldMappings :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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

salesforceStandardKnowledgeArticleTypeConfiguration_documentDataFieldName :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration Text Source #

The name of the field that contains the document data to index.

SalesforceStandardObjectAttachmentConfiguration

data SalesforceStandardObjectAttachmentConfiguration Source #

Provides the configuration information for processing attachments to Salesforce standard objects.

See: newSalesforceStandardObjectAttachmentConfiguration smart constructor.

Constructors

SalesforceStandardObjectAttachmentConfiguration'
Fields documentTitleFieldName :: Maybe Text The name of the field used for the document title. fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping) One or more objects that map fields in attachments to Amazon Kendra index fields.

Instances

Instances details

FromJSON SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration Methods parseJSON :: Value -> Parser SalesforceStandardObjectAttachmentConfiguration # parseJSONList :: Value -> Parser [SalesforceStandardObjectAttachmentConfiguration] #
ToJSON SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration Methods toJSON :: SalesforceStandardObjectAttachmentConfiguration -> Value # toEncoding :: SalesforceStandardObjectAttachmentConfiguration -> Encoding # toJSONList :: [SalesforceStandardObjectAttachmentConfiguration] -> Value # toEncodingList :: [SalesforceStandardObjectAttachmentConfiguration] -> Encoding #
Generic SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration Associated Types type Rep SalesforceStandardObjectAttachmentConfiguration :: Type -> Type # Methods from :: SalesforceStandardObjectAttachmentConfiguration -> Rep SalesforceStandardObjectAttachmentConfiguration x # to :: Rep SalesforceStandardObjectAttachmentConfiguration x -> SalesforceStandardObjectAttachmentConfiguration #
Read SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration Methods readsPrec :: Int -> ReadS SalesforceStandardObjectAttachmentConfiguration # readList :: ReadS [SalesforceStandardObjectAttachmentConfiguration] # readPrec :: ReadPrec SalesforceStandardObjectAttachmentConfiguration # readListPrec :: ReadPrec [SalesforceStandardObjectAttachmentConfiguration] #
Show SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration Methods showsPrec :: Int -> SalesforceStandardObjectAttachmentConfiguration -> ShowS # show :: SalesforceStandardObjectAttachmentConfiguration -> String # showList :: [SalesforceStandardObjectAttachmentConfiguration] -> ShowS #
NFData SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration Methods rnf :: SalesforceStandardObjectAttachmentConfiguration -> () #
Eq SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration Methods (==) :: SalesforceStandardObjectAttachmentConfiguration -> SalesforceStandardObjectAttachmentConfiguration -> Bool # (/=) :: SalesforceStandardObjectAttachmentConfiguration -> SalesforceStandardObjectAttachmentConfiguration -> Bool #
Hashable SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration Methods hashWithSalt :: Int -> SalesforceStandardObjectAttachmentConfiguration -> Int # hash :: SalesforceStandardObjectAttachmentConfiguration -> Int #
type Rep SalesforceStandardObjectAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration type Rep SalesforceStandardObjectAttachmentConfiguration = D1 ('MetaData "SalesforceStandardObjectAttachmentConfiguration" "Amazonka.Kendra.Types.SalesforceStandardObjectAttachmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceStandardObjectAttachmentConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))))

newSalesforceStandardObjectAttachmentConfiguration :: SalesforceStandardObjectAttachmentConfiguration Source #

Create a value of SalesforceStandardObjectAttachmentConfiguration with all optional fields omitted.

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

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

$sel:documentTitleFieldName:SalesforceStandardObjectAttachmentConfiguration', salesforceStandardObjectAttachmentConfiguration_documentTitleFieldName - The name of the field used for the document title.

$sel:fieldMappings:SalesforceStandardObjectAttachmentConfiguration', salesforceStandardObjectAttachmentConfiguration_fieldMappings - One or more objects that map fields in attachments to Amazon Kendra index fields.

salesforceStandardObjectAttachmentConfiguration_documentTitleFieldName :: Lens' SalesforceStandardObjectAttachmentConfiguration (Maybe Text) Source #

The name of the field used for the document title.

salesforceStandardObjectAttachmentConfiguration_fieldMappings :: Lens' SalesforceStandardObjectAttachmentConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

One or more objects that map fields in attachments to Amazon Kendra index fields.

SalesforceStandardObjectConfiguration

data SalesforceStandardObjectConfiguration Source #

Provides the configuration information for indexing a single standard object.

See: newSalesforceStandardObjectConfiguration smart constructor.

Constructors

SalesforceStandardObjectConfiguration'

Fields

documentTitleFieldName :: Maybe Text
The name of the field in the standard object table that contains the document title.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.
name :: SalesforceStandardObjectName
The name of the standard object.
documentDataFieldName :: Text
The name of the field in the standard object table that contains the document contents.

Instances

Instances details

FromJSON SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration Methods parseJSON :: Value -> Parser SalesforceStandardObjectConfiguration # parseJSONList :: Value -> Parser [SalesforceStandardObjectConfiguration] #
ToJSON SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration Methods toJSON :: SalesforceStandardObjectConfiguration -> Value # toEncoding :: SalesforceStandardObjectConfiguration -> Encoding # toJSONList :: [SalesforceStandardObjectConfiguration] -> Value # toEncodingList :: [SalesforceStandardObjectConfiguration] -> Encoding #
Generic SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration Associated Types type Rep SalesforceStandardObjectConfiguration :: Type -> Type # Methods from :: SalesforceStandardObjectConfiguration -> Rep SalesforceStandardObjectConfiguration x # to :: Rep SalesforceStandardObjectConfiguration x -> SalesforceStandardObjectConfiguration #
Read SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration Methods readsPrec :: Int -> ReadS SalesforceStandardObjectConfiguration # readList :: ReadS [SalesforceStandardObjectConfiguration] # readPrec :: ReadPrec SalesforceStandardObjectConfiguration # readListPrec :: ReadPrec [SalesforceStandardObjectConfiguration] #
Show SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration Methods showsPrec :: Int -> SalesforceStandardObjectConfiguration -> ShowS # show :: SalesforceStandardObjectConfiguration -> String # showList :: [SalesforceStandardObjectConfiguration] -> ShowS #
NFData SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration Methods rnf :: SalesforceStandardObjectConfiguration -> () #
Eq SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration Methods (==) :: SalesforceStandardObjectConfiguration -> SalesforceStandardObjectConfiguration -> Bool # (/=) :: SalesforceStandardObjectConfiguration -> SalesforceStandardObjectConfiguration -> Bool #
Hashable SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration Methods hashWithSalt :: Int -> SalesforceStandardObjectConfiguration -> Int # hash :: SalesforceStandardObjectConfiguration -> Int #
type Rep SalesforceStandardObjectConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration type Rep SalesforceStandardObjectConfiguration = D1 ('MetaData "SalesforceStandardObjectConfiguration" "Amazonka.Kendra.Types.SalesforceStandardObjectConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SalesforceStandardObjectConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SalesforceStandardObjectName) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSalesforceStandardObjectConfiguration Source #

Arguments

:: SalesforceStandardObjectName	`$sel:name:SalesforceStandardObjectConfiguration'`
-> Text	`$sel:documentDataFieldName:SalesforceStandardObjectConfiguration'`
-> SalesforceStandardObjectConfiguration

Create a value of SalesforceStandardObjectConfiguration with all optional fields omitted.

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

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

$sel:documentTitleFieldName:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_documentTitleFieldName - The name of the field in the standard object table that contains the document title.

$sel:fieldMappings:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_fieldMappings - Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

$sel:name:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_name - The name of the standard object.

$sel:documentDataFieldName:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_documentDataFieldName - The name of the field in the standard object table that contains the document contents.

salesforceStandardObjectConfiguration_documentTitleFieldName :: Lens' SalesforceStandardObjectConfiguration (Maybe Text) Source #

The name of the field in the standard object table that contains the document title.

salesforceStandardObjectConfiguration_fieldMappings :: Lens' SalesforceStandardObjectConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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

salesforceStandardObjectConfiguration_name :: Lens' SalesforceStandardObjectConfiguration SalesforceStandardObjectName Source #

The name of the standard object.

salesforceStandardObjectConfiguration_documentDataFieldName :: Lens' SalesforceStandardObjectConfiguration Text Source #

The name of the field in the standard object table that contains the document contents.

ScoreAttributes

data ScoreAttributes Source #

Provides a relative ranking that indicates how confident Amazon Kendra is that the response matches the query.

See: newScoreAttributes smart constructor.

Constructors

ScoreAttributes'
Fields scoreConfidence :: Maybe ScoreConfidence A relative ranking for how well the response matches the query.

Instances

Instances details

FromJSON ScoreAttributes Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreAttributes Methods parseJSON :: Value -> Parser ScoreAttributes # parseJSONList :: Value -> Parser [ScoreAttributes] #
Generic ScoreAttributes Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreAttributes Associated Types type Rep ScoreAttributes :: Type -> Type # Methods from :: ScoreAttributes -> Rep ScoreAttributes x # to :: Rep ScoreAttributes x -> ScoreAttributes #
Read ScoreAttributes Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreAttributes Methods readsPrec :: Int -> ReadS ScoreAttributes # readList :: ReadS [ScoreAttributes] # readPrec :: ReadPrec ScoreAttributes # readListPrec :: ReadPrec [ScoreAttributes] #
Show ScoreAttributes Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreAttributes Methods showsPrec :: Int -> ScoreAttributes -> ShowS # show :: ScoreAttributes -> String # showList :: [ScoreAttributes] -> ShowS #
NFData ScoreAttributes Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreAttributes Methods rnf :: ScoreAttributes -> () #
Eq ScoreAttributes Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreAttributes Methods (==) :: ScoreAttributes -> ScoreAttributes -> Bool # (/=) :: ScoreAttributes -> ScoreAttributes -> Bool #
Hashable ScoreAttributes Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreAttributes Methods hashWithSalt :: Int -> ScoreAttributes -> Int # hash :: ScoreAttributes -> Int #
type Rep ScoreAttributes Source #
Instance details Defined in Amazonka.Kendra.Types.ScoreAttributes type Rep ScoreAttributes = D1 ('MetaData "ScoreAttributes" "Amazonka.Kendra.Types.ScoreAttributes" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ScoreAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scoreConfidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScoreConfidence))))

newScoreAttributes :: ScoreAttributes Source #

Create a value of ScoreAttributes with all optional fields omitted.

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

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

$sel:scoreConfidence:ScoreAttributes', scoreAttributes_scoreConfidence - A relative ranking for how well the response matches the query.

scoreAttributes_scoreConfidence :: Lens' ScoreAttributes (Maybe ScoreConfidence) Source #

A relative ranking for how well the response matches the query.

Search

data Search Source #

Provides information about how a custom index field is used during a search.

See: newSearch smart constructor.

Constructors

Search'

Fields

displayable :: Maybe Bool
Determines whether the field is returned in the query response. The default is true.
facetable :: Maybe Bool
Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .
searchable :: Maybe Bool
Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
sortable :: Maybe Bool
Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Instances

Instances details

FromJSON Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search Methods parseJSON :: Value -> Parser Search # parseJSONList :: Value -> Parser [Search] #
ToJSON Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search Methods toJSON :: Search -> Value # toEncoding :: Search -> Encoding # toJSONList :: [Search] -> Value # toEncodingList :: [Search] -> Encoding #
Generic Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search Associated Types type Rep Search :: Type -> Type # Methods from :: Search -> Rep Search x # to :: Rep Search x -> Search #
Read Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search Methods readsPrec :: Int -> ReadS Search # readList :: ReadS [Search] # readPrec :: ReadPrec Search # readListPrec :: ReadPrec [Search] #
Show Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search Methods showsPrec :: Int -> Search -> ShowS # show :: Search -> String # showList :: [Search] -> ShowS #
NFData Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search Methods rnf :: Search -> () #
Eq Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search Methods (==) :: Search -> Search -> Bool # (/=) :: Search -> Search -> Bool #
Hashable Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search Methods hashWithSalt :: Int -> Search -> Int # hash :: Search -> Int #
type Rep Search Source #
Instance details Defined in Amazonka.Kendra.Types.Search type Rep Search = D1 ('MetaData "Search" "Amazonka.Kendra.Types.Search" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Search'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "displayable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "facetable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "searchable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sortable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newSearch :: Search Source #

Create a value of Search with all optional fields omitted.

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

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

$sel:displayable:Search', search_displayable - Determines whether the field is returned in the query response. The default is true.

$sel:facetable:Search', search_facetable - Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

$sel:searchable:Search', search_searchable - Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

$sel:sortable:Search', search_sortable - Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

search_displayable :: Lens' Search (Maybe Bool) Source #

Determines whether the field is returned in the query response. The default is true.

search_facetable :: Lens' Search (Maybe Bool) Source #

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

search_searchable :: Lens' Search (Maybe Bool) Source #

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

search_sortable :: Lens' Search (Maybe Bool) Source #

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

SeedUrlConfiguration

data SeedUrlConfiguration Source #

Provides the configuration information for the seed or starting point URLs to crawl.

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

See: newSeedUrlConfiguration smart constructor.

Constructors

SeedUrlConfiguration'

Fields

webCrawlerMode :: Maybe WebCrawlerMode
You can choose one of the following modes:
- HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
- SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
- EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.
The default mode is set to HOST_ONLY.
seedUrls :: [Text]
The list of seed or starting point URLs of the websites you want to crawl.
The list can include a maximum of 100 seed URLs.

Instances

Instances details

FromJSON SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods parseJSON :: Value -> Parser SeedUrlConfiguration # parseJSONList :: Value -> Parser [SeedUrlConfiguration] #
ToJSON SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods toJSON :: SeedUrlConfiguration -> Value # toEncoding :: SeedUrlConfiguration -> Encoding # toJSONList :: [SeedUrlConfiguration] -> Value # toEncodingList :: [SeedUrlConfiguration] -> Encoding #
Generic SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Associated Types type Rep SeedUrlConfiguration :: Type -> Type # Methods from :: SeedUrlConfiguration -> Rep SeedUrlConfiguration x # to :: Rep SeedUrlConfiguration x -> SeedUrlConfiguration #
Read SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods readsPrec :: Int -> ReadS SeedUrlConfiguration # readList :: ReadS [SeedUrlConfiguration] # readPrec :: ReadPrec SeedUrlConfiguration # readListPrec :: ReadPrec [SeedUrlConfiguration] #
Show SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods showsPrec :: Int -> SeedUrlConfiguration -> ShowS # show :: SeedUrlConfiguration -> String # showList :: [SeedUrlConfiguration] -> ShowS #
NFData SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods rnf :: SeedUrlConfiguration -> () #
Eq SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods (==) :: SeedUrlConfiguration -> SeedUrlConfiguration -> Bool # (/=) :: SeedUrlConfiguration -> SeedUrlConfiguration -> Bool #
Hashable SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration Methods hashWithSalt :: Int -> SeedUrlConfiguration -> Int # hash :: SeedUrlConfiguration -> Int #
type Rep SeedUrlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SeedUrlConfiguration type Rep SeedUrlConfiguration = D1 ('MetaData "SeedUrlConfiguration" "Amazonka.Kendra.Types.SeedUrlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SeedUrlConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "webCrawlerMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebCrawlerMode)) :*: S1 ('MetaSel ('Just "seedUrls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newSeedUrlConfiguration :: SeedUrlConfiguration Source #

Create a value of SeedUrlConfiguration with all optional fields omitted.

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

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

$sel:webCrawlerMode:SeedUrlConfiguration', seedUrlConfiguration_webCrawlerMode - You can choose one of the following modes:

HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.

The default mode is set to HOST_ONLY.

$sel:seedUrls:SeedUrlConfiguration', seedUrlConfiguration_seedUrls - The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

seedUrlConfiguration_webCrawlerMode :: Lens' SeedUrlConfiguration (Maybe WebCrawlerMode) Source #

You can choose one of the following modes:

HOST_ONLY – crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS – crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING – crawl the website host names with subdomains and other domains that the webpages link to.

The default mode is set to HOST_ONLY.

seedUrlConfiguration_seedUrls :: Lens' SeedUrlConfiguration [Text] Source #

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

ServerSideEncryptionConfiguration

data ServerSideEncryptionConfiguration Source #

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.

See: newServerSideEncryptionConfiguration smart constructor.

Constructors

ServerSideEncryptionConfiguration'
Fields kmsKeyId :: Maybe (Sensitive Text) The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.

Instances

Instances details

FromJSON ServerSideEncryptionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration Methods parseJSON :: Value -> Parser ServerSideEncryptionConfiguration # parseJSONList :: Value -> Parser [ServerSideEncryptionConfiguration] #
ToJSON ServerSideEncryptionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration Methods toJSON :: ServerSideEncryptionConfiguration -> Value # toEncoding :: ServerSideEncryptionConfiguration -> Encoding # toJSONList :: [ServerSideEncryptionConfiguration] -> Value # toEncodingList :: [ServerSideEncryptionConfiguration] -> Encoding #
Generic ServerSideEncryptionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration Associated Types type Rep ServerSideEncryptionConfiguration :: Type -> Type # Methods from :: ServerSideEncryptionConfiguration -> Rep ServerSideEncryptionConfiguration x # to :: Rep ServerSideEncryptionConfiguration x -> ServerSideEncryptionConfiguration #
Show ServerSideEncryptionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration Methods showsPrec :: Int -> ServerSideEncryptionConfiguration -> ShowS # show :: ServerSideEncryptionConfiguration -> String # showList :: [ServerSideEncryptionConfiguration] -> ShowS #
NFData ServerSideEncryptionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration Methods rnf :: ServerSideEncryptionConfiguration -> () #
Eq ServerSideEncryptionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration Methods (==) :: ServerSideEncryptionConfiguration -> ServerSideEncryptionConfiguration -> Bool # (/=) :: ServerSideEncryptionConfiguration -> ServerSideEncryptionConfiguration -> Bool #
Hashable ServerSideEncryptionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration Methods hashWithSalt :: Int -> ServerSideEncryptionConfiguration -> Int # hash :: ServerSideEncryptionConfiguration -> Int #
type Rep ServerSideEncryptionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServerSideEncryptionConfiguration type Rep ServerSideEncryptionConfiguration = D1 ('MetaData "ServerSideEncryptionConfiguration" "Amazonka.Kendra.Types.ServerSideEncryptionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServerSideEncryptionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))

newServerSideEncryptionConfiguration :: ServerSideEncryptionConfiguration Source #

Create a value of ServerSideEncryptionConfiguration with all optional fields omitted.

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

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

$sel:kmsKeyId:ServerSideEncryptionConfiguration', serverSideEncryptionConfiguration_kmsKeyId - The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.

serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration (Maybe Text) Source #

The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.

ServiceNowConfiguration

data ServiceNowConfiguration Source #

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

See: newServiceNowConfiguration smart constructor.

Constructors

ServiceNowConfiguration'

Fields

authenticationType :: Maybe ServiceNowAuthenticationType
The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. If you choose OAUTH2, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.
When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.
knowledgeArticleConfiguration :: Maybe ServiceNowKnowledgeArticleConfiguration
Configuration information for crawling knowledge articles in the ServiceNow site.
serviceCatalogConfiguration :: Maybe ServiceNowServiceCatalogConfiguration
Configuration information for crawling service catalogs in the ServiceNow site.
hostUrl :: Text
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
secretArn :: Text
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source.
serviceNowBuildVersion :: ServiceNowBuildVersionType
The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

Instances

Instances details

FromJSON ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods parseJSON :: Value -> Parser ServiceNowConfiguration # parseJSONList :: Value -> Parser [ServiceNowConfiguration] #
ToJSON ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods toJSON :: ServiceNowConfiguration -> Value # toEncoding :: ServiceNowConfiguration -> Encoding # toJSONList :: [ServiceNowConfiguration] -> Value # toEncodingList :: [ServiceNowConfiguration] -> Encoding #
Generic ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Associated Types type Rep ServiceNowConfiguration :: Type -> Type # Methods from :: ServiceNowConfiguration -> Rep ServiceNowConfiguration x # to :: Rep ServiceNowConfiguration x -> ServiceNowConfiguration #
Read ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods readsPrec :: Int -> ReadS ServiceNowConfiguration # readList :: ReadS [ServiceNowConfiguration] # readPrec :: ReadPrec ServiceNowConfiguration # readListPrec :: ReadPrec [ServiceNowConfiguration] #
Show ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods showsPrec :: Int -> ServiceNowConfiguration -> ShowS # show :: ServiceNowConfiguration -> String # showList :: [ServiceNowConfiguration] -> ShowS #
NFData ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods rnf :: ServiceNowConfiguration -> () #
Eq ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods (==) :: ServiceNowConfiguration -> ServiceNowConfiguration -> Bool # (/=) :: ServiceNowConfiguration -> ServiceNowConfiguration -> Bool #
Hashable ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration Methods hashWithSalt :: Int -> ServiceNowConfiguration -> Int # hash :: ServiceNowConfiguration -> Int #
type Rep ServiceNowConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowConfiguration type Rep ServiceNowConfiguration = D1 ('MetaData "ServiceNowConfiguration" "Amazonka.Kendra.Types.ServiceNowConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServiceNowConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowAuthenticationType)) :: (S1 ('MetaSel ('Just "knowledgeArticleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowKnowledgeArticleConfiguration)) :: S1 ('MetaSel ('Just "serviceCatalogConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceNowServiceCatalogConfiguration)))) :: (S1 ('MetaSel ('Just "hostUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceNowBuildVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceNowBuildVersionType)))))

newServiceNowConfiguration Source #

Arguments

:: Text	`$sel:hostUrl:ServiceNowConfiguration'`
-> Text	`$sel:secretArn:ServiceNowConfiguration'`
-> ServiceNowBuildVersionType	`$sel:serviceNowBuildVersion:ServiceNowConfiguration'`
-> ServiceNowConfiguration

Create a value of ServiceNowConfiguration with all optional fields omitted.

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

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

$sel:authenticationType:ServiceNowConfiguration', serviceNowConfiguration_authenticationType - The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. If you choose OAUTH2, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

$sel:knowledgeArticleConfiguration:ServiceNowConfiguration', serviceNowConfiguration_knowledgeArticleConfiguration - Configuration information for crawling knowledge articles in the ServiceNow site.

$sel:serviceCatalogConfiguration:ServiceNowConfiguration', serviceNowConfiguration_serviceCatalogConfiguration - Configuration information for crawling service catalogs in the ServiceNow site.

$sel:hostUrl:ServiceNowConfiguration', serviceNowConfiguration_hostUrl - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

$sel:secretArn:ServiceNowConfiguration', serviceNowConfiguration_secretArn - The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source.

$sel:serviceNowBuildVersion:ServiceNowConfiguration', serviceNowConfiguration_serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

serviceNowConfiguration_authenticationType :: Lens' ServiceNowConfiguration (Maybe ServiceNowAuthenticationType) Source #

The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the SecretArn field. If you choose OAUTH2, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.

serviceNowConfiguration_knowledgeArticleConfiguration :: Lens' ServiceNowConfiguration (Maybe ServiceNowKnowledgeArticleConfiguration) Source #

Configuration information for crawling knowledge articles in the ServiceNow site.

serviceNowConfiguration_serviceCatalogConfiguration :: Lens' ServiceNowConfiguration (Maybe ServiceNowServiceCatalogConfiguration) Source #

Configuration information for crawling service catalogs in the ServiceNow site.

serviceNowConfiguration_hostUrl :: Lens' ServiceNowConfiguration Text Source #

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

serviceNowConfiguration_secretArn :: Lens' ServiceNowConfiguration Text Source #

The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source.

serviceNowConfiguration_serviceNowBuildVersion :: Lens' ServiceNowConfiguration ServiceNowBuildVersionType Source #

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

ServiceNowKnowledgeArticleConfiguration

data ServiceNowKnowledgeArticleConfiguration Source #

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

See: newServiceNowKnowledgeArticleConfiguration smart constructor.

Constructors

ServiceNowKnowledgeArticleConfiguration'

Fields

crawlAttachments :: Maybe Bool
TRUE to index attachments to knowledge articles.
documentTitleFieldName :: Maybe Text
The name of the ServiceNow field that is mapped to the index document title field.
excludeAttachmentFilePatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the field specified in the PatternTargetField.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.
filterQuery :: Maybe Text
A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.
The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.
includeAttachmentFilePatterns :: Maybe [Text]
A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the field specified in the PatternTargetField.
documentDataFieldName :: Text
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

Instances

Instances details

FromJSON ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration Methods parseJSON :: Value -> Parser ServiceNowKnowledgeArticleConfiguration # parseJSONList :: Value -> Parser [ServiceNowKnowledgeArticleConfiguration] #
ToJSON ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration Methods toJSON :: ServiceNowKnowledgeArticleConfiguration -> Value # toEncoding :: ServiceNowKnowledgeArticleConfiguration -> Encoding # toJSONList :: [ServiceNowKnowledgeArticleConfiguration] -> Value # toEncodingList :: [ServiceNowKnowledgeArticleConfiguration] -> Encoding #
Generic ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration Associated Types type Rep ServiceNowKnowledgeArticleConfiguration :: Type -> Type # Methods from :: ServiceNowKnowledgeArticleConfiguration -> Rep ServiceNowKnowledgeArticleConfiguration x # to :: Rep ServiceNowKnowledgeArticleConfiguration x -> ServiceNowKnowledgeArticleConfiguration #
Read ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration Methods readsPrec :: Int -> ReadS ServiceNowKnowledgeArticleConfiguration # readList :: ReadS [ServiceNowKnowledgeArticleConfiguration] # readPrec :: ReadPrec ServiceNowKnowledgeArticleConfiguration # readListPrec :: ReadPrec [ServiceNowKnowledgeArticleConfiguration] #
Show ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration Methods showsPrec :: Int -> ServiceNowKnowledgeArticleConfiguration -> ShowS # show :: ServiceNowKnowledgeArticleConfiguration -> String # showList :: [ServiceNowKnowledgeArticleConfiguration] -> ShowS #
NFData ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration Methods rnf :: ServiceNowKnowledgeArticleConfiguration -> () #
Eq ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration Methods (==) :: ServiceNowKnowledgeArticleConfiguration -> ServiceNowKnowledgeArticleConfiguration -> Bool # (/=) :: ServiceNowKnowledgeArticleConfiguration -> ServiceNowKnowledgeArticleConfiguration -> Bool #
Hashable ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration Methods hashWithSalt :: Int -> ServiceNowKnowledgeArticleConfiguration -> Int # hash :: ServiceNowKnowledgeArticleConfiguration -> Int #
type Rep ServiceNowKnowledgeArticleConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration type Rep ServiceNowKnowledgeArticleConfiguration = D1 ('MetaData "ServiceNowKnowledgeArticleConfiguration" "Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServiceNowKnowledgeArticleConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "excludeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "filterQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "includeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newServiceNowKnowledgeArticleConfiguration Source #

Arguments

:: Text	`$sel:documentDataFieldName:ServiceNowKnowledgeArticleConfiguration'`
-> ServiceNowKnowledgeArticleConfiguration

Create a value of ServiceNowKnowledgeArticleConfiguration with all optional fields omitted.

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

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

$sel:crawlAttachments:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_crawlAttachments - TRUE to index attachments to knowledge articles.

$sel:documentTitleFieldName:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.

$sel:excludeAttachmentFilePatterns:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_excludeAttachmentFilePatterns - A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the field specified in the PatternTargetField.

$sel:fieldMappings:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_fieldMappings - Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.

$sel:filterQuery:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_filterQuery - A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

$sel:includeAttachmentFilePatterns:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_includeAttachmentFilePatterns - A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the field specified in the PatternTargetField.

$sel:documentDataFieldName:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

serviceNowKnowledgeArticleConfiguration_crawlAttachments :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Bool) Source #

TRUE to index attachments to knowledge articles.

serviceNowKnowledgeArticleConfiguration_documentTitleFieldName :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Text) Source #

The name of the ServiceNow field that is mapped to the index document title field.

serviceNowKnowledgeArticleConfiguration_excludeAttachmentFilePatterns :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the field specified in the PatternTargetField.

serviceNowKnowledgeArticleConfiguration_fieldMappings :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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

serviceNowKnowledgeArticleConfiguration_filterQuery :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Text) Source #

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

serviceNowKnowledgeArticleConfiguration_includeAttachmentFilePatterns :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the field specified in the PatternTargetField.

serviceNowKnowledgeArticleConfiguration_documentDataFieldName :: Lens' ServiceNowKnowledgeArticleConfiguration Text Source #

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

ServiceNowServiceCatalogConfiguration

data ServiceNowServiceCatalogConfiguration Source #

Provides the configuration information for crawling service catalog items in the ServiceNow site

See: newServiceNowServiceCatalogConfiguration smart constructor.

Constructors

ServiceNowServiceCatalogConfiguration'

Fields

crawlAttachments :: Maybe Bool
TRUE to index attachments to service catalog items.
documentTitleFieldName :: Maybe Text
The name of the ServiceNow field that is mapped to the index document title field.
excludeAttachmentFilePatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the file name of the attachment.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.
includeAttachmentFilePatterns :: Maybe [Text]
A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the file name of the attachment.
documentDataFieldName :: Text
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

Instances

Instances details

FromJSON ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration Methods parseJSON :: Value -> Parser ServiceNowServiceCatalogConfiguration # parseJSONList :: Value -> Parser [ServiceNowServiceCatalogConfiguration] #
ToJSON ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration Methods toJSON :: ServiceNowServiceCatalogConfiguration -> Value # toEncoding :: ServiceNowServiceCatalogConfiguration -> Encoding # toJSONList :: [ServiceNowServiceCatalogConfiguration] -> Value # toEncodingList :: [ServiceNowServiceCatalogConfiguration] -> Encoding #
Generic ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration Associated Types type Rep ServiceNowServiceCatalogConfiguration :: Type -> Type # Methods from :: ServiceNowServiceCatalogConfiguration -> Rep ServiceNowServiceCatalogConfiguration x # to :: Rep ServiceNowServiceCatalogConfiguration x -> ServiceNowServiceCatalogConfiguration #
Read ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration Methods readsPrec :: Int -> ReadS ServiceNowServiceCatalogConfiguration # readList :: ReadS [ServiceNowServiceCatalogConfiguration] # readPrec :: ReadPrec ServiceNowServiceCatalogConfiguration # readListPrec :: ReadPrec [ServiceNowServiceCatalogConfiguration] #
Show ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration Methods showsPrec :: Int -> ServiceNowServiceCatalogConfiguration -> ShowS # show :: ServiceNowServiceCatalogConfiguration -> String # showList :: [ServiceNowServiceCatalogConfiguration] -> ShowS #
NFData ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration Methods rnf :: ServiceNowServiceCatalogConfiguration -> () #
Eq ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration Methods (==) :: ServiceNowServiceCatalogConfiguration -> ServiceNowServiceCatalogConfiguration -> Bool # (/=) :: ServiceNowServiceCatalogConfiguration -> ServiceNowServiceCatalogConfiguration -> Bool #
Hashable ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration Methods hashWithSalt :: Int -> ServiceNowServiceCatalogConfiguration -> Int # hash :: ServiceNowServiceCatalogConfiguration -> Int #
type Rep ServiceNowServiceCatalogConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration type Rep ServiceNowServiceCatalogConfiguration = D1 ('MetaData "ServiceNowServiceCatalogConfiguration" "Amazonka.Kendra.Types.ServiceNowServiceCatalogConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServiceNowServiceCatalogConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "excludeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "includeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newServiceNowServiceCatalogConfiguration Source #

Arguments

:: Text	`$sel:documentDataFieldName:ServiceNowServiceCatalogConfiguration'`
-> ServiceNowServiceCatalogConfiguration

Create a value of ServiceNowServiceCatalogConfiguration with all optional fields omitted.

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

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

$sel:crawlAttachments:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_crawlAttachments - TRUE to index attachments to service catalog items.

$sel:documentTitleFieldName:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.

$sel:excludeAttachmentFilePatterns:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_excludeAttachmentFilePatterns - A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

$sel:fieldMappings:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_fieldMappings - Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow custom metadata.

$sel:includeAttachmentFilePatterns:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_includeAttachmentFilePatterns - A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

$sel:documentDataFieldName:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

serviceNowServiceCatalogConfiguration_crawlAttachments :: Lens' ServiceNowServiceCatalogConfiguration (Maybe Bool) Source #

TRUE to index attachments to service catalog items.

serviceNowServiceCatalogConfiguration_documentTitleFieldName :: Lens' ServiceNowServiceCatalogConfiguration (Maybe Text) Source #

The name of the ServiceNow field that is mapped to the index document title field.

serviceNowServiceCatalogConfiguration_excludeAttachmentFilePatterns :: Lens' ServiceNowServiceCatalogConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

serviceNowServiceCatalogConfiguration_fieldMappings :: Lens' ServiceNowServiceCatalogConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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

serviceNowServiceCatalogConfiguration_includeAttachmentFilePatterns :: Lens' ServiceNowServiceCatalogConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

serviceNowServiceCatalogConfiguration_documentDataFieldName :: Lens' ServiceNowServiceCatalogConfiguration Text Source #

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

SharePointConfiguration

data SharePointConfiguration Source #

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

See: newSharePointConfiguration smart constructor.

Constructors

SharePointConfiguration'

Fields

authenticationType :: Maybe SharePointOnlineAuthenticationType
Whether you want to connect to SharePoint using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret. You can use OAuth authentication for SharePoint Online.
crawlAttachments :: Maybe Bool
TRUE to index document attachments.
disableLocalGroups :: Maybe Bool
TRUE to disable local groups information.
documentTitleFieldName :: Maybe Text
The Microsoft SharePoint attribute field that contains the title of the document.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
proxyConfiguration :: Maybe ProxyConfiguration
Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.
You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.
Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.
It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.
sslCertificateS3Path :: Maybe S3Path
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.
You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
useChangeLog :: Maybe Bool
TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.
sharePointVersion :: SharePointVersion
The version of Microsoft SharePoint that you use.
urls :: NonEmpty Text
The Microsoft SharePoint site URLs for the documents you want to index.
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source.
You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a SharePoint data source.

Instances

Instances details

FromJSON SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration Methods parseJSON :: Value -> Parser SharePointConfiguration # parseJSONList :: Value -> Parser [SharePointConfiguration] #
ToJSON SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration Methods toJSON :: SharePointConfiguration -> Value # toEncoding :: SharePointConfiguration -> Encoding # toJSONList :: [SharePointConfiguration] -> Value # toEncodingList :: [SharePointConfiguration] -> Encoding #
Generic SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration Associated Types type Rep SharePointConfiguration :: Type -> Type # Methods from :: SharePointConfiguration -> Rep SharePointConfiguration x # to :: Rep SharePointConfiguration x -> SharePointConfiguration #
Read SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration Methods readsPrec :: Int -> ReadS SharePointConfiguration # readList :: ReadS [SharePointConfiguration] # readPrec :: ReadPrec SharePointConfiguration # readListPrec :: ReadPrec [SharePointConfiguration] #
Show SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration Methods showsPrec :: Int -> SharePointConfiguration -> ShowS # show :: SharePointConfiguration -> String # showList :: [SharePointConfiguration] -> ShowS #
NFData SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration Methods rnf :: SharePointConfiguration -> () #
Eq SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration Methods (==) :: SharePointConfiguration -> SharePointConfiguration -> Bool # (/=) :: SharePointConfiguration -> SharePointConfiguration -> Bool #
Hashable SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration Methods hashWithSalt :: Int -> SharePointConfiguration -> Int # hash :: SharePointConfiguration -> Int #
type Rep SharePointConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SharePointConfiguration type Rep SharePointConfiguration = D1 ('MetaData "SharePointConfiguration" "Amazonka.Kendra.Types.SharePointConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SharePointConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SharePointOnlineAuthenticationType)) :: (S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "disableLocalGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration)) :: (S1 ('MetaSel ('Just "sslCertificateS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :: S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :: S1 ('MetaSel ('Just "sharePointVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SharePointVersion)) :: (S1 ('MetaSel ('Just "urls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSharePointConfiguration Source #

Arguments

:: SharePointVersion	`$sel:sharePointVersion:SharePointConfiguration'`
-> NonEmpty Text	`$sel:urls:SharePointConfiguration'`
-> Text	`$sel:secretArn:SharePointConfiguration'`
-> SharePointConfiguration

Create a value of SharePointConfiguration with all optional fields omitted.

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

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

$sel:authenticationType:SharePointConfiguration', sharePointConfiguration_authenticationType - Whether you want to connect to SharePoint using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret. You can use OAuth authentication for SharePoint Online.

$sel:crawlAttachments:SharePointConfiguration', sharePointConfiguration_crawlAttachments - TRUE to index document attachments.

$sel:disableLocalGroups:SharePointConfiguration', sharePointConfiguration_disableLocalGroups - TRUE to disable local groups information.

$sel:documentTitleFieldName:SharePointConfiguration', sharePointConfiguration_documentTitleFieldName - The Microsoft SharePoint attribute field that contains the title of the document.

$sel:exclusionPatterns:SharePointConfiguration', sharePointConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

$sel:fieldMappings:SharePointConfiguration', sharePointConfiguration_fieldMappings - A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

$sel:inclusionPatterns:SharePointConfiguration', sharePointConfiguration_inclusionPatterns - A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

$sel:proxyConfiguration:SharePointConfiguration', sharePointConfiguration_proxyConfiguration - Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

$sel:sslCertificateS3Path:SharePointConfiguration', sharePointConfiguration_sslCertificateS3Path - The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

$sel:useChangeLog:SharePointConfiguration', sharePointConfiguration_useChangeLog - TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

$sel:vpcConfiguration:SharePointConfiguration', sharePointConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see Configuring a VPC.

$sel:sharePointVersion:SharePointConfiguration', sharePointConfiguration_sharePointVersion - The version of Microsoft SharePoint that you use.

$sel:urls:SharePointConfiguration', sharePointConfiguration_urls - The Microsoft SharePoint site URLs for the documents you want to index.

$sel:secretArn:SharePointConfiguration', sharePointConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source.

You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a SharePoint data source.

sharePointConfiguration_authenticationType :: Lens' SharePointConfiguration (Maybe SharePointOnlineAuthenticationType) Source #

Whether you want to connect to SharePoint using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret. You can use OAuth authentication for SharePoint Online.

sharePointConfiguration_crawlAttachments :: Lens' SharePointConfiguration (Maybe Bool) Source #

TRUE to index document attachments.

sharePointConfiguration_disableLocalGroups :: Lens' SharePointConfiguration (Maybe Bool) Source #

TRUE to disable local groups information.

sharePointConfiguration_documentTitleFieldName :: Lens' SharePointConfiguration (Maybe Text) Source #

The Microsoft SharePoint attribute field that contains the title of the document.

sharePointConfiguration_exclusionPatterns :: Lens' SharePointConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

sharePointConfiguration_fieldMappings :: Lens' SharePointConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

sharePointConfiguration_inclusionPatterns :: Lens' SharePointConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

sharePointConfiguration_proxyConfiguration :: Lens' SharePointConfiguration (Maybe ProxyConfiguration) Source #

Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

sharePointConfiguration_sslCertificateS3Path :: Lens' SharePointConfiguration (Maybe S3Path) Source #

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.

sharePointConfiguration_useChangeLog :: Lens' SharePointConfiguration (Maybe Bool) Source #

TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

sharePointConfiguration_vpcConfiguration :: Lens' SharePointConfiguration (Maybe DataSourceVpcConfiguration) Source #

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

sharePointConfiguration_sharePointVersion :: Lens' SharePointConfiguration SharePointVersion Source #

The version of Microsoft SharePoint that you use.

sharePointConfiguration_urls :: Lens' SharePointConfiguration (NonEmpty Text) Source #

The Microsoft SharePoint site URLs for the documents you want to index.

sharePointConfiguration_secretArn :: Lens' SharePointConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source.

You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a SharePoint data source.

SiteMapsConfiguration

data SiteMapsConfiguration Source #

Provides the configuration information for the sitemap URLs to crawl.

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

See: newSiteMapsConfiguration smart constructor.

Constructors

SiteMapsConfiguration'
Fields siteMaps :: [Text] The list of sitemap URLs of the websites you want to crawl. The list can include a maximum of three sitemap URLs.

Instances

Instances details

FromJSON SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration Methods parseJSON :: Value -> Parser SiteMapsConfiguration # parseJSONList :: Value -> Parser [SiteMapsConfiguration] #
ToJSON SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration Methods toJSON :: SiteMapsConfiguration -> Value # toEncoding :: SiteMapsConfiguration -> Encoding # toJSONList :: [SiteMapsConfiguration] -> Value # toEncodingList :: [SiteMapsConfiguration] -> Encoding #
Generic SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration Associated Types type Rep SiteMapsConfiguration :: Type -> Type # Methods from :: SiteMapsConfiguration -> Rep SiteMapsConfiguration x # to :: Rep SiteMapsConfiguration x -> SiteMapsConfiguration #
Read SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration Methods readsPrec :: Int -> ReadS SiteMapsConfiguration # readList :: ReadS [SiteMapsConfiguration] # readPrec :: ReadPrec SiteMapsConfiguration # readListPrec :: ReadPrec [SiteMapsConfiguration] #
Show SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration Methods showsPrec :: Int -> SiteMapsConfiguration -> ShowS # show :: SiteMapsConfiguration -> String # showList :: [SiteMapsConfiguration] -> ShowS #
NFData SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration Methods rnf :: SiteMapsConfiguration -> () #
Eq SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration Methods (==) :: SiteMapsConfiguration -> SiteMapsConfiguration -> Bool # (/=) :: SiteMapsConfiguration -> SiteMapsConfiguration -> Bool #
Hashable SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration Methods hashWithSalt :: Int -> SiteMapsConfiguration -> Int # hash :: SiteMapsConfiguration -> Int #
type Rep SiteMapsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SiteMapsConfiguration type Rep SiteMapsConfiguration = D1 ('MetaData "SiteMapsConfiguration" "Amazonka.Kendra.Types.SiteMapsConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SiteMapsConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "siteMaps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newSiteMapsConfiguration :: SiteMapsConfiguration Source #

Create a value of SiteMapsConfiguration with all optional fields omitted.

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

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

$sel:siteMaps:SiteMapsConfiguration', siteMapsConfiguration_siteMaps - The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

siteMapsConfiguration_siteMaps :: Lens' SiteMapsConfiguration [Text] Source #

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

SlackConfiguration

data SlackConfiguration Source #

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

See: newSlackConfiguration smart constructor.

Constructors

SlackConfiguration'

Fields

crawlBotMessage :: Maybe Bool
TRUE to index bot messages from your Slack workspace team.
excludeArchived :: Maybe Bool
TRUE to exclude archived messages to index from your Slack workspace team.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack custom metadata.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
lookBackPeriod :: Maybe Natural
The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.
Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the LookBackPeriod to the number of hours you want change log to look back.
privateChannelFilter :: Maybe [Text]
The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.
publicChannelFilter :: Maybe [Text]
The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.
useChangeLog :: Maybe Bool
TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.
teamId :: Text
The identifier of the team in the Slack workspace. For example, T0123456789.
You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....
secretArn :: Text
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys:
- slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see Authentication for a Slack data source.
slackEntityList :: NonEmpty SlackEntity
Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
sinceCrawlDate :: Text
The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.

Instances

Instances details

FromJSON SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration Methods parseJSON :: Value -> Parser SlackConfiguration # parseJSONList :: Value -> Parser [SlackConfiguration] #
ToJSON SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration Methods toJSON :: SlackConfiguration -> Value # toEncoding :: SlackConfiguration -> Encoding # toJSONList :: [SlackConfiguration] -> Value # toEncodingList :: [SlackConfiguration] -> Encoding #
Generic SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration Associated Types type Rep SlackConfiguration :: Type -> Type # Methods from :: SlackConfiguration -> Rep SlackConfiguration x # to :: Rep SlackConfiguration x -> SlackConfiguration #
Read SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration Methods readsPrec :: Int -> ReadS SlackConfiguration # readList :: ReadS [SlackConfiguration] # readPrec :: ReadPrec SlackConfiguration # readListPrec :: ReadPrec [SlackConfiguration] #
Show SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration Methods showsPrec :: Int -> SlackConfiguration -> ShowS # show :: SlackConfiguration -> String # showList :: [SlackConfiguration] -> ShowS #
NFData SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration Methods rnf :: SlackConfiguration -> () #
Eq SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration Methods (==) :: SlackConfiguration -> SlackConfiguration -> Bool # (/=) :: SlackConfiguration -> SlackConfiguration -> Bool #
Hashable SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration Methods hashWithSalt :: Int -> SlackConfiguration -> Int # hash :: SlackConfiguration -> Int #
type Rep SlackConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SlackConfiguration type Rep SlackConfiguration = D1 ('MetaData "SlackConfiguration" "Amazonka.Kendra.Types.SlackConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SlackConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "crawlBotMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "excludeArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "lookBackPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "privateChannelFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "publicChannelFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :: ((S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "slackEntityList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SlackEntity)) :*: S1 ('MetaSel ('Just "sinceCrawlDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSlackConfiguration Source #

Arguments

:: Text	`$sel:teamId:SlackConfiguration'`
-> Text	`$sel:secretArn:SlackConfiguration'`
-> NonEmpty SlackEntity	`$sel:slackEntityList:SlackConfiguration'`
-> Text	`$sel:sinceCrawlDate:SlackConfiguration'`
-> SlackConfiguration

Create a value of SlackConfiguration with all optional fields omitted.

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

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

$sel:crawlBotMessage:SlackConfiguration', slackConfiguration_crawlBotMessage - TRUE to index bot messages from your Slack workspace team.

$sel:excludeArchived:SlackConfiguration', slackConfiguration_excludeArchived - TRUE to exclude archived messages to index from your Slack workspace team.

$sel:exclusionPatterns:SlackConfiguration', slackConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:fieldMappings:SlackConfiguration', slackConfiguration_fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack custom metadata.

$sel:inclusionPatterns:SlackConfiguration', slackConfiguration_inclusionPatterns - A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:lookBackPeriod:SlackConfiguration', slackConfiguration_lookBackPeriod - The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.

Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the LookBackPeriod to the number of hours you want change log to look back.

$sel:privateChannelFilter:SlackConfiguration', slackConfiguration_privateChannelFilter - The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.

$sel:publicChannelFilter:SlackConfiguration', slackConfiguration_publicChannelFilter - The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.

$sel:useChangeLog:SlackConfiguration', slackConfiguration_useChangeLog - TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.

$sel:vpcConfiguration:SlackConfiguration', slackConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see Configuring a VPC.

$sel:teamId:SlackConfiguration', slackConfiguration_teamId - The identifier of the team in the Slack workspace. For example, T0123456789.

You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....

$sel:secretArn:SlackConfiguration', slackConfiguration_secretArn - The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys:

slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see Authentication for a Slack data source.

$sel:slackEntityList:SlackConfiguration', slackConfiguration_slackEntityList - Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

$sel:sinceCrawlDate:SlackConfiguration', slackConfiguration_sinceCrawlDate - The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.

slackConfiguration_crawlBotMessage :: Lens' SlackConfiguration (Maybe Bool) Source #

TRUE to index bot messages from your Slack workspace team.

slackConfiguration_excludeArchived :: Lens' SlackConfiguration (Maybe Bool) Source #

TRUE to exclude archived messages to index from your Slack workspace team.

slackConfiguration_exclusionPatterns :: Lens' SlackConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

slackConfiguration_fieldMappings :: Lens' SlackConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Slack fields. For more information, see Mapping data source fields. The Slack data source field names must exist in your Slack custom metadata.

slackConfiguration_inclusionPatterns :: Lens' SlackConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

slackConfiguration_lookBackPeriod :: Lens' SlackConfiguration (Maybe Natural) Source #

The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.

Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the LookBackPeriod to the number of hours you want change log to look back.

slackConfiguration_privateChannelFilter :: Lens' SlackConfiguration (Maybe [Text]) Source #

The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.

slackConfiguration_publicChannelFilter :: Lens' SlackConfiguration (Maybe [Text]) Source #

The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.

slackConfiguration_useChangeLog :: Lens' SlackConfiguration (Maybe Bool) Source #

TRUE to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.

slackConfiguration_vpcConfiguration :: Lens' SlackConfiguration (Maybe DataSourceVpcConfiguration) Source #

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

slackConfiguration_teamId :: Lens' SlackConfiguration Text Source #

The identifier of the team in the Slack workspace. For example, T0123456789.

You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, https://app.slack.com/client/T0123456789/....

slackConfiguration_secretArn :: Lens' SlackConfiguration Text Source #

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys:

slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see Authentication for a Slack data source.

slackConfiguration_slackEntityList :: Lens' SlackConfiguration (NonEmpty SlackEntity) Source #

Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

slackConfiguration_sinceCrawlDate :: Lens' SlackConfiguration Text Source #

The date to start crawling your data from your Slack workspace team. The date must follow this format: yyyy-mm-dd.

SortingConfiguration

data SortingConfiguration Source #

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.

You can sort attributes of the following types.

Date value
Long value
String value

You can't sort attributes of the following type.

String list value

See: newSortingConfiguration smart constructor.

Constructors

SortingConfiguration'

Fields

documentAttributeKey :: Text
The name of the document attribute used to sort the response. You can use any field that has the Sortable flag set to true.
You can also sort by any of the following built-in attributes:
- _category
- _created_at
- _last_updated_at
- _version
- _view_count
sortOrder :: SortOrder
The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Instances

Instances details

ToJSON SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods toJSON :: SortingConfiguration -> Value # toEncoding :: SortingConfiguration -> Encoding # toJSONList :: [SortingConfiguration] -> Value # toEncodingList :: [SortingConfiguration] -> Encoding #
Generic SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Associated Types type Rep SortingConfiguration :: Type -> Type # Methods from :: SortingConfiguration -> Rep SortingConfiguration x # to :: Rep SortingConfiguration x -> SortingConfiguration #
Read SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods readsPrec :: Int -> ReadS SortingConfiguration # readList :: ReadS [SortingConfiguration] # readPrec :: ReadPrec SortingConfiguration # readListPrec :: ReadPrec [SortingConfiguration] #
Show SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods showsPrec :: Int -> SortingConfiguration -> ShowS # show :: SortingConfiguration -> String # showList :: [SortingConfiguration] -> ShowS #
NFData SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods rnf :: SortingConfiguration -> () #
Eq SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods (==) :: SortingConfiguration -> SortingConfiguration -> Bool # (/=) :: SortingConfiguration -> SortingConfiguration -> Bool #
Hashable SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration Methods hashWithSalt :: Int -> SortingConfiguration -> Int # hash :: SortingConfiguration -> Int #
type Rep SortingConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SortingConfiguration type Rep SortingConfiguration = D1 ('MetaData "SortingConfiguration" "Amazonka.Kendra.Types.SortingConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SortingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SortOrder)))

newSortingConfiguration Source #

Arguments

:: Text	`$sel:documentAttributeKey:SortingConfiguration'`
-> SortOrder	`$sel:sortOrder:SortingConfiguration'`
-> SortingConfiguration

Create a value of SortingConfiguration with all optional fields omitted.

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

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

$sel:documentAttributeKey:SortingConfiguration', sortingConfiguration_documentAttributeKey - The name of the document attribute used to sort the response. You can use any field that has the Sortable flag set to true.

You can also sort by any of the following built-in attributes:

_category
_created_at
_last_updated_at
_version
_view_count

$sel:sortOrder:SortingConfiguration', sortingConfiguration_sortOrder - The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

sortingConfiguration_documentAttributeKey :: Lens' SortingConfiguration Text Source #

The name of the document attribute used to sort the response. You can use any field that has the Sortable flag set to true.

You can also sort by any of the following built-in attributes:

_category
_created_at
_last_updated_at
_version
_view_count

sortingConfiguration_sortOrder :: Lens' SortingConfiguration SortOrder Source #

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

SpellCorrectedQuery

data SpellCorrectedQuery Source #

A query with suggested spell corrections.

See: newSpellCorrectedQuery smart constructor.

Constructors

SpellCorrectedQuery'
Fields corrections :: Maybe [Correction] The corrected misspelled word or words in a query. suggestedQueryText :: Maybe Text The query with the suggested spell corrections.

Instances

Instances details

FromJSON SpellCorrectedQuery Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectedQuery Methods parseJSON :: Value -> Parser SpellCorrectedQuery # parseJSONList :: Value -> Parser [SpellCorrectedQuery] #
Generic SpellCorrectedQuery Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectedQuery Associated Types type Rep SpellCorrectedQuery :: Type -> Type # Methods from :: SpellCorrectedQuery -> Rep SpellCorrectedQuery x # to :: Rep SpellCorrectedQuery x -> SpellCorrectedQuery #
Read SpellCorrectedQuery Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectedQuery Methods readsPrec :: Int -> ReadS SpellCorrectedQuery # readList :: ReadS [SpellCorrectedQuery] # readPrec :: ReadPrec SpellCorrectedQuery # readListPrec :: ReadPrec [SpellCorrectedQuery] #
Show SpellCorrectedQuery Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectedQuery Methods showsPrec :: Int -> SpellCorrectedQuery -> ShowS # show :: SpellCorrectedQuery -> String # showList :: [SpellCorrectedQuery] -> ShowS #
NFData SpellCorrectedQuery Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectedQuery Methods rnf :: SpellCorrectedQuery -> () #
Eq SpellCorrectedQuery Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectedQuery Methods (==) :: SpellCorrectedQuery -> SpellCorrectedQuery -> Bool # (/=) :: SpellCorrectedQuery -> SpellCorrectedQuery -> Bool #
Hashable SpellCorrectedQuery Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectedQuery Methods hashWithSalt :: Int -> SpellCorrectedQuery -> Int # hash :: SpellCorrectedQuery -> Int #
type Rep SpellCorrectedQuery Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectedQuery type Rep SpellCorrectedQuery = D1 ('MetaData "SpellCorrectedQuery" "Amazonka.Kendra.Types.SpellCorrectedQuery" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SpellCorrectedQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "corrections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Correction])) :*: S1 ('MetaSel ('Just "suggestedQueryText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSpellCorrectedQuery :: SpellCorrectedQuery Source #

Create a value of SpellCorrectedQuery with all optional fields omitted.

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

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

$sel:corrections:SpellCorrectedQuery', spellCorrectedQuery_corrections - The corrected misspelled word or words in a query.

$sel:suggestedQueryText:SpellCorrectedQuery', spellCorrectedQuery_suggestedQueryText - The query with the suggested spell corrections.

spellCorrectedQuery_corrections :: Lens' SpellCorrectedQuery (Maybe [Correction]) Source #

The corrected misspelled word or words in a query.

spellCorrectedQuery_suggestedQueryText :: Lens' SpellCorrectedQuery (Maybe Text) Source #

The query with the suggested spell corrections.

SpellCorrectionConfiguration

data SpellCorrectionConfiguration Source #

Provides the configuration information for suggested query spell corrections.

Suggested spell corrections are based on words that appear in your indexed documents and how closely a corrected word matches a misspelled word.

This feature is designed with certain defaults or limits. For information on the current limits and how to request more support for some limits, see the Spell Checker documentation.

See: newSpellCorrectionConfiguration smart constructor.

Constructors

SpellCorrectionConfiguration'
Fields includeQuerySpellCheckSuggestions :: Bool `TRUE` to suggest spell corrections for queries.

Instances

Instances details

ToJSON SpellCorrectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration Methods toJSON :: SpellCorrectionConfiguration -> Value # toEncoding :: SpellCorrectionConfiguration -> Encoding # toJSONList :: [SpellCorrectionConfiguration] -> Value # toEncodingList :: [SpellCorrectionConfiguration] -> Encoding #
Generic SpellCorrectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration Associated Types type Rep SpellCorrectionConfiguration :: Type -> Type # Methods from :: SpellCorrectionConfiguration -> Rep SpellCorrectionConfiguration x # to :: Rep SpellCorrectionConfiguration x -> SpellCorrectionConfiguration #
Read SpellCorrectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration Methods readsPrec :: Int -> ReadS SpellCorrectionConfiguration # readList :: ReadS [SpellCorrectionConfiguration] # readPrec :: ReadPrec SpellCorrectionConfiguration # readListPrec :: ReadPrec [SpellCorrectionConfiguration] #
Show SpellCorrectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration Methods showsPrec :: Int -> SpellCorrectionConfiguration -> ShowS # show :: SpellCorrectionConfiguration -> String # showList :: [SpellCorrectionConfiguration] -> ShowS #
NFData SpellCorrectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration Methods rnf :: SpellCorrectionConfiguration -> () #
Eq SpellCorrectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration Methods (==) :: SpellCorrectionConfiguration -> SpellCorrectionConfiguration -> Bool # (/=) :: SpellCorrectionConfiguration -> SpellCorrectionConfiguration -> Bool #
Hashable SpellCorrectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration Methods hashWithSalt :: Int -> SpellCorrectionConfiguration -> Int # hash :: SpellCorrectionConfiguration -> Int #
type Rep SpellCorrectionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SpellCorrectionConfiguration type Rep SpellCorrectionConfiguration = D1 ('MetaData "SpellCorrectionConfiguration" "Amazonka.Kendra.Types.SpellCorrectionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SpellCorrectionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeQuerySpellCheckSuggestions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

newSpellCorrectionConfiguration Source #

Arguments

:: Bool	`$sel:includeQuerySpellCheckSuggestions:SpellCorrectionConfiguration'`
-> SpellCorrectionConfiguration

Create a value of SpellCorrectionConfiguration with all optional fields omitted.

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

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

$sel:includeQuerySpellCheckSuggestions:SpellCorrectionConfiguration', spellCorrectionConfiguration_includeQuerySpellCheckSuggestions - TRUE to suggest spell corrections for queries.

spellCorrectionConfiguration_includeQuerySpellCheckSuggestions :: Lens' SpellCorrectionConfiguration Bool Source #

TRUE to suggest spell corrections for queries.

SqlConfiguration

data SqlConfiguration Source #

Provides the configuration information to use a SQL database.

See: newSqlConfiguration smart constructor.

Constructors

SqlConfiguration'

Fields

queryIdentifiersEnclosingOption :: Maybe QueryIdentifiersEnclosingOption
Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.
By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.
PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.
For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

Instances

Instances details

FromJSON SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration Methods parseJSON :: Value -> Parser SqlConfiguration # parseJSONList :: Value -> Parser [SqlConfiguration] #
ToJSON SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration Methods toJSON :: SqlConfiguration -> Value # toEncoding :: SqlConfiguration -> Encoding # toJSONList :: [SqlConfiguration] -> Value # toEncodingList :: [SqlConfiguration] -> Encoding #
Generic SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration Associated Types type Rep SqlConfiguration :: Type -> Type # Methods from :: SqlConfiguration -> Rep SqlConfiguration x # to :: Rep SqlConfiguration x -> SqlConfiguration #
Read SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration Methods readsPrec :: Int -> ReadS SqlConfiguration # readList :: ReadS [SqlConfiguration] # readPrec :: ReadPrec SqlConfiguration # readListPrec :: ReadPrec [SqlConfiguration] #
Show SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration Methods showsPrec :: Int -> SqlConfiguration -> ShowS # show :: SqlConfiguration -> String # showList :: [SqlConfiguration] -> ShowS #
NFData SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration Methods rnf :: SqlConfiguration -> () #
Eq SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration Methods (==) :: SqlConfiguration -> SqlConfiguration -> Bool # (/=) :: SqlConfiguration -> SqlConfiguration -> Bool #
Hashable SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration Methods hashWithSalt :: Int -> SqlConfiguration -> Int # hash :: SqlConfiguration -> Int #
type Rep SqlConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.SqlConfiguration type Rep SqlConfiguration = D1 ('MetaData "SqlConfiguration" "Amazonka.Kendra.Types.SqlConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SqlConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryIdentifiersEnclosingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryIdentifiersEnclosingOption))))

newSqlConfiguration :: SqlConfiguration Source #

Create a value of SqlConfiguration with all optional fields omitted.

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

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

$sel:queryIdentifiersEnclosingOption:SqlConfiguration', sqlConfiguration_queryIdentifiersEnclosingOption - Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

sqlConfiguration_queryIdentifiersEnclosingOption :: Lens' SqlConfiguration (Maybe QueryIdentifiersEnclosingOption) Source #

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

Status

data Status Source #

Provides information about the status of documents submitted for indexing.

See: newStatus smart constructor.

Constructors

Status'

Fields

documentId :: Maybe Text
The identifier of the document.
documentStatus :: Maybe DocumentStatus
The current status of a document.
If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.
failureCode :: Maybe Text
Indicates the source of the error.
failureReason :: Maybe Text
Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Instances

Instances details

FromJSON Status Source #
Instance details Defined in Amazonka.Kendra.Types.Status Methods parseJSON :: Value -> Parser Status # parseJSONList :: Value -> Parser [Status] #
Generic Status Source #
Instance details Defined in Amazonka.Kendra.Types.Status Associated Types type Rep Status :: Type -> Type # Methods from :: Status -> Rep Status x # to :: Rep Status x -> Status #
Read Status Source #
Instance details Defined in Amazonka.Kendra.Types.Status Methods readsPrec :: Int -> ReadS Status # readList :: ReadS [Status] # readPrec :: ReadPrec Status # readListPrec :: ReadPrec [Status] #
Show Status Source #
Instance details Defined in Amazonka.Kendra.Types.Status Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
NFData Status Source #
Instance details Defined in Amazonka.Kendra.Types.Status Methods rnf :: Status -> () #
Eq Status Source #
Instance details Defined in Amazonka.Kendra.Types.Status Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #
Hashable Status Source #
Instance details Defined in Amazonka.Kendra.Types.Status Methods hashWithSalt :: Int -> Status -> Int # hash :: Status -> Int #
type Rep Status Source #
Instance details Defined in Amazonka.Kendra.Types.Status type Rep Status = D1 ('MetaData "Status" "Amazonka.Kendra.Types.Status" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Status'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentStatus))) :: (S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newStatus :: Status Source #

Create a value of Status with all optional fields omitted.

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

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

$sel:documentId:Status', status_documentId - The identifier of the document.

$sel:documentStatus:Status', status_documentStatus - The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

$sel:failureCode:Status', status_failureCode - Indicates the source of the error.

$sel:failureReason:Status', status_failureReason - Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

status_documentId :: Lens' Status (Maybe Text) Source #

The identifier of the document.

status_documentStatus :: Lens' Status (Maybe DocumentStatus) Source #

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

status_failureCode :: Lens' Status (Maybe Text) Source #

Indicates the source of the error.

status_failureReason :: Lens' Status (Maybe Text) Source #

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Suggestion

data Suggestion Source #

A single query suggestion.

See: newSuggestion smart constructor.

Constructors

Suggestion'
Fields id :: Maybe Text The UUID (universally unique identifier) of a single query suggestion. value :: Maybe SuggestionValue The value for the UUID (universally unique identifier) of a single query suggestion. The value is the text string of a suggestion.

Instances

Instances details

FromJSON Suggestion Source #
Instance details Defined in Amazonka.Kendra.Types.Suggestion Methods parseJSON :: Value -> Parser Suggestion # parseJSONList :: Value -> Parser [Suggestion] #
Generic Suggestion Source #
Instance details Defined in Amazonka.Kendra.Types.Suggestion Associated Types type Rep Suggestion :: Type -> Type # Methods from :: Suggestion -> Rep Suggestion x # to :: Rep Suggestion x -> Suggestion #
Read Suggestion Source #
Instance details Defined in Amazonka.Kendra.Types.Suggestion Methods readsPrec :: Int -> ReadS Suggestion # readList :: ReadS [Suggestion] # readPrec :: ReadPrec Suggestion # readListPrec :: ReadPrec [Suggestion] #
Show Suggestion Source #
Instance details Defined in Amazonka.Kendra.Types.Suggestion Methods showsPrec :: Int -> Suggestion -> ShowS # show :: Suggestion -> String # showList :: [Suggestion] -> ShowS #
NFData Suggestion Source #
Instance details Defined in Amazonka.Kendra.Types.Suggestion Methods rnf :: Suggestion -> () #
Eq Suggestion Source #
Instance details Defined in Amazonka.Kendra.Types.Suggestion Methods (==) :: Suggestion -> Suggestion -> Bool # (/=) :: Suggestion -> Suggestion -> Bool #
Hashable Suggestion Source #
Instance details Defined in Amazonka.Kendra.Types.Suggestion Methods hashWithSalt :: Int -> Suggestion -> Int # hash :: Suggestion -> Int #
type Rep Suggestion Source #
Instance details Defined in Amazonka.Kendra.Types.Suggestion type Rep Suggestion = D1 ('MetaData "Suggestion" "Amazonka.Kendra.Types.Suggestion" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Suggestion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestionValue))))

newSuggestion :: Suggestion Source #

Create a value of Suggestion with all optional fields omitted.

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

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

$sel:id:Suggestion', suggestion_id - The UUID (universally unique identifier) of a single query suggestion.

$sel:value:Suggestion', suggestion_value - The value for the UUID (universally unique identifier) of a single query suggestion.

The value is the text string of a suggestion.

suggestion_id :: Lens' Suggestion (Maybe Text) Source #

The UUID (universally unique identifier) of a single query suggestion.

suggestion_value :: Lens' Suggestion (Maybe SuggestionValue) Source #

The value for the UUID (universally unique identifier) of a single query suggestion.

The value is the text string of a suggestion.

SuggestionHighlight

data SuggestionHighlight Source #

The text highlights for a single query suggestion.

See: newSuggestionHighlight smart constructor.

Constructors

SuggestionHighlight'
Fields beginOffset :: Maybe Int The zero-based location in the response string where the highlight starts. endOffset :: Maybe Int The zero-based location in the response string where the highlight ends.

Instances

Instances details

FromJSON SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods parseJSON :: Value -> Parser SuggestionHighlight # parseJSONList :: Value -> Parser [SuggestionHighlight] #
Generic SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Associated Types type Rep SuggestionHighlight :: Type -> Type # Methods from :: SuggestionHighlight -> Rep SuggestionHighlight x # to :: Rep SuggestionHighlight x -> SuggestionHighlight #
Read SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods readsPrec :: Int -> ReadS SuggestionHighlight # readList :: ReadS [SuggestionHighlight] # readPrec :: ReadPrec SuggestionHighlight # readListPrec :: ReadPrec [SuggestionHighlight] #
Show SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods showsPrec :: Int -> SuggestionHighlight -> ShowS # show :: SuggestionHighlight -> String # showList :: [SuggestionHighlight] -> ShowS #
NFData SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods rnf :: SuggestionHighlight -> () #
Eq SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods (==) :: SuggestionHighlight -> SuggestionHighlight -> Bool # (/=) :: SuggestionHighlight -> SuggestionHighlight -> Bool #
Hashable SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight Methods hashWithSalt :: Int -> SuggestionHighlight -> Int # hash :: SuggestionHighlight -> Int #
type Rep SuggestionHighlight Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionHighlight type Rep SuggestionHighlight = D1 ('MetaData "SuggestionHighlight" "Amazonka.Kendra.Types.SuggestionHighlight" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SuggestionHighlight'" 'PrefixI 'True) (S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newSuggestionHighlight :: SuggestionHighlight Source #

Create a value of SuggestionHighlight with all optional fields omitted.

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

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

$sel:beginOffset:SuggestionHighlight', suggestionHighlight_beginOffset - The zero-based location in the response string where the highlight starts.

$sel:endOffset:SuggestionHighlight', suggestionHighlight_endOffset - The zero-based location in the response string where the highlight ends.

suggestionHighlight_beginOffset :: Lens' SuggestionHighlight (Maybe Int) Source #

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

suggestionHighlight_endOffset :: Lens' SuggestionHighlight (Maybe Int) Source #

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

SuggestionTextWithHighlights

data SuggestionTextWithHighlights Source #

Provides text and information about where to highlight the query suggestion text.

See: newSuggestionTextWithHighlights smart constructor.

Constructors

SuggestionTextWithHighlights'
Fields highlights :: Maybe [SuggestionHighlight] The beginning and end of the query suggestion text that should be highlighted. text :: Maybe Text The query suggestion text to display to the user.

Instances

Instances details

FromJSON SuggestionTextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights Methods parseJSON :: Value -> Parser SuggestionTextWithHighlights # parseJSONList :: Value -> Parser [SuggestionTextWithHighlights] #
Generic SuggestionTextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights Associated Types type Rep SuggestionTextWithHighlights :: Type -> Type # Methods from :: SuggestionTextWithHighlights -> Rep SuggestionTextWithHighlights x # to :: Rep SuggestionTextWithHighlights x -> SuggestionTextWithHighlights #
Read SuggestionTextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights Methods readsPrec :: Int -> ReadS SuggestionTextWithHighlights # readList :: ReadS [SuggestionTextWithHighlights] # readPrec :: ReadPrec SuggestionTextWithHighlights # readListPrec :: ReadPrec [SuggestionTextWithHighlights] #
Show SuggestionTextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights Methods showsPrec :: Int -> SuggestionTextWithHighlights -> ShowS # show :: SuggestionTextWithHighlights -> String # showList :: [SuggestionTextWithHighlights] -> ShowS #
NFData SuggestionTextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights Methods rnf :: SuggestionTextWithHighlights -> () #
Eq SuggestionTextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights Methods (==) :: SuggestionTextWithHighlights -> SuggestionTextWithHighlights -> Bool # (/=) :: SuggestionTextWithHighlights -> SuggestionTextWithHighlights -> Bool #
Hashable SuggestionTextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights Methods hashWithSalt :: Int -> SuggestionTextWithHighlights -> Int # hash :: SuggestionTextWithHighlights -> Int #
type Rep SuggestionTextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionTextWithHighlights type Rep SuggestionTextWithHighlights = D1 ('MetaData "SuggestionTextWithHighlights" "Amazonka.Kendra.Types.SuggestionTextWithHighlights" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SuggestionTextWithHighlights'" 'PrefixI 'True) (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SuggestionHighlight])) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSuggestionTextWithHighlights :: SuggestionTextWithHighlights Source #

Create a value of SuggestionTextWithHighlights with all optional fields omitted.

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

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

$sel:highlights:SuggestionTextWithHighlights', suggestionTextWithHighlights_highlights - The beginning and end of the query suggestion text that should be highlighted.

$sel:text:SuggestionTextWithHighlights', suggestionTextWithHighlights_text - The query suggestion text to display to the user.

suggestionTextWithHighlights_highlights :: Lens' SuggestionTextWithHighlights (Maybe [SuggestionHighlight]) Source #

The beginning and end of the query suggestion text that should be highlighted.

suggestionTextWithHighlights_text :: Lens' SuggestionTextWithHighlights (Maybe Text) Source #

The query suggestion text to display to the user.

SuggestionValue

data SuggestionValue Source #

The SuggestionTextWithHighlights structure information.

See: newSuggestionValue smart constructor.

Constructors

SuggestionValue'
Fields text :: Maybe SuggestionTextWithHighlights The `SuggestionTextWithHighlights` structure that contains the query suggestion text and highlights.

Instances

Instances details

FromJSON SuggestionValue Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionValue Methods parseJSON :: Value -> Parser SuggestionValue # parseJSONList :: Value -> Parser [SuggestionValue] #
Generic SuggestionValue Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionValue Associated Types type Rep SuggestionValue :: Type -> Type # Methods from :: SuggestionValue -> Rep SuggestionValue x # to :: Rep SuggestionValue x -> SuggestionValue #
Read SuggestionValue Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionValue Methods readsPrec :: Int -> ReadS SuggestionValue # readList :: ReadS [SuggestionValue] # readPrec :: ReadPrec SuggestionValue # readListPrec :: ReadPrec [SuggestionValue] #
Show SuggestionValue Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionValue Methods showsPrec :: Int -> SuggestionValue -> ShowS # show :: SuggestionValue -> String # showList :: [SuggestionValue] -> ShowS #
NFData SuggestionValue Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionValue Methods rnf :: SuggestionValue -> () #
Eq SuggestionValue Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionValue Methods (==) :: SuggestionValue -> SuggestionValue -> Bool # (/=) :: SuggestionValue -> SuggestionValue -> Bool #
Hashable SuggestionValue Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionValue Methods hashWithSalt :: Int -> SuggestionValue -> Int # hash :: SuggestionValue -> Int #
type Rep SuggestionValue Source #
Instance details Defined in Amazonka.Kendra.Types.SuggestionValue type Rep SuggestionValue = D1 ('MetaData "SuggestionValue" "Amazonka.Kendra.Types.SuggestionValue" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SuggestionValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestionTextWithHighlights))))

newSuggestionValue :: SuggestionValue Source #

Create a value of SuggestionValue with all optional fields omitted.

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

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

SuggestionValue, suggestionValue_text - The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.

suggestionValue_text :: Lens' SuggestionValue (Maybe SuggestionTextWithHighlights) Source #

The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.

TableCell

data TableCell Source #

Provides information about a table cell in a table excerpt.

See: newTableCell smart constructor.

Constructors

TableCell'

Fields

header :: Maybe Bool
TRUE means that the table cell should be treated as a header.
highlighted :: Maybe Bool
TRUE means that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted.
topAnswer :: Maybe Bool
TRUE if the response of the table cell is the top answer. This is the cell value or content with the highest confidence score or is the most relevant to the query.
value :: Maybe Text
The actual value or content within a table cell. A table cell could contain a date value of a year, or a string value of text, for example.

Instances

Instances details

FromJSON TableCell Source #
Instance details Defined in Amazonka.Kendra.Types.TableCell Methods parseJSON :: Value -> Parser TableCell # parseJSONList :: Value -> Parser [TableCell] #
Generic TableCell Source #
Instance details Defined in Amazonka.Kendra.Types.TableCell Associated Types type Rep TableCell :: Type -> Type # Methods from :: TableCell -> Rep TableCell x # to :: Rep TableCell x -> TableCell #
Read TableCell Source #
Instance details Defined in Amazonka.Kendra.Types.TableCell Methods readsPrec :: Int -> ReadS TableCell # readList :: ReadS [TableCell] # readPrec :: ReadPrec TableCell # readListPrec :: ReadPrec [TableCell] #
Show TableCell Source #
Instance details Defined in Amazonka.Kendra.Types.TableCell Methods showsPrec :: Int -> TableCell -> ShowS # show :: TableCell -> String # showList :: [TableCell] -> ShowS #
NFData TableCell Source #
Instance details Defined in Amazonka.Kendra.Types.TableCell Methods rnf :: TableCell -> () #
Eq TableCell Source #
Instance details Defined in Amazonka.Kendra.Types.TableCell Methods (==) :: TableCell -> TableCell -> Bool # (/=) :: TableCell -> TableCell -> Bool #
Hashable TableCell Source #
Instance details Defined in Amazonka.Kendra.Types.TableCell Methods hashWithSalt :: Int -> TableCell -> Int # hash :: TableCell -> Int #
type Rep TableCell Source #
Instance details Defined in Amazonka.Kendra.Types.TableCell type Rep TableCell = D1 ('MetaData "TableCell" "Amazonka.Kendra.Types.TableCell" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TableCell'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "highlighted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "topAnswer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newTableCell :: TableCell Source #

Create a value of TableCell with all optional fields omitted.

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

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

$sel:header:TableCell', tableCell_header - TRUE means that the table cell should be treated as a header.

$sel:highlighted:TableCell', tableCell_highlighted - TRUE means that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted.

$sel:topAnswer:TableCell', tableCell_topAnswer - TRUE if the response of the table cell is the top answer. This is the cell value or content with the highest confidence score or is the most relevant to the query.

$sel:value:TableCell', tableCell_value - The actual value or content within a table cell. A table cell could contain a date value of a year, or a string value of text, for example.

tableCell_header :: Lens' TableCell (Maybe Bool) Source #

TRUE means that the table cell should be treated as a header.

tableCell_highlighted :: Lens' TableCell (Maybe Bool) Source #

TRUE means that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted.

tableCell_topAnswer :: Lens' TableCell (Maybe Bool) Source #

TRUE if the response of the table cell is the top answer. This is the cell value or content with the highest confidence score or is the most relevant to the query.

tableCell_value :: Lens' TableCell (Maybe Text) Source #

The actual value or content within a table cell. A table cell could contain a date value of a year, or a string value of text, for example.

TableExcerpt

data TableExcerpt Source #

An excerpt from a table within a document. The table excerpt displays up to five columns and three rows, depending on how many table cells are relevant to the query and how many columns are available in the original table. The top most relevant cell is displayed in the table excerpt, along with the next most relevant cells.

See: newTableExcerpt smart constructor.

Constructors

TableExcerpt'
Fields rows :: Maybe [TableRow] A list of rows in the table excerpt. totalNumberOfRows :: Maybe Int A count of the number of rows in the original table within the document.

Instances

Instances details

FromJSON TableExcerpt Source #
Instance details Defined in Amazonka.Kendra.Types.TableExcerpt Methods parseJSON :: Value -> Parser TableExcerpt # parseJSONList :: Value -> Parser [TableExcerpt] #
Generic TableExcerpt Source #
Instance details Defined in Amazonka.Kendra.Types.TableExcerpt Associated Types type Rep TableExcerpt :: Type -> Type # Methods from :: TableExcerpt -> Rep TableExcerpt x # to :: Rep TableExcerpt x -> TableExcerpt #
Read TableExcerpt Source #
Instance details Defined in Amazonka.Kendra.Types.TableExcerpt Methods readsPrec :: Int -> ReadS TableExcerpt # readList :: ReadS [TableExcerpt] # readPrec :: ReadPrec TableExcerpt # readListPrec :: ReadPrec [TableExcerpt] #
Show TableExcerpt Source #
Instance details Defined in Amazonka.Kendra.Types.TableExcerpt Methods showsPrec :: Int -> TableExcerpt -> ShowS # show :: TableExcerpt -> String # showList :: [TableExcerpt] -> ShowS #
NFData TableExcerpt Source #
Instance details Defined in Amazonka.Kendra.Types.TableExcerpt Methods rnf :: TableExcerpt -> () #
Eq TableExcerpt Source #
Instance details Defined in Amazonka.Kendra.Types.TableExcerpt Methods (==) :: TableExcerpt -> TableExcerpt -> Bool # (/=) :: TableExcerpt -> TableExcerpt -> Bool #
Hashable TableExcerpt Source #
Instance details Defined in Amazonka.Kendra.Types.TableExcerpt Methods hashWithSalt :: Int -> TableExcerpt -> Int # hash :: TableExcerpt -> Int #
type Rep TableExcerpt Source #
Instance details Defined in Amazonka.Kendra.Types.TableExcerpt type Rep TableExcerpt = D1 ('MetaData "TableExcerpt" "Amazonka.Kendra.Types.TableExcerpt" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TableExcerpt'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TableRow])) :*: S1 ('MetaSel ('Just "totalNumberOfRows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newTableExcerpt :: TableExcerpt Source #

Create a value of TableExcerpt with all optional fields omitted.

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

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

$sel:rows:TableExcerpt', tableExcerpt_rows - A list of rows in the table excerpt.

$sel:totalNumberOfRows:TableExcerpt', tableExcerpt_totalNumberOfRows - A count of the number of rows in the original table within the document.

tableExcerpt_rows :: Lens' TableExcerpt (Maybe [TableRow]) Source #

A list of rows in the table excerpt.

tableExcerpt_totalNumberOfRows :: Lens' TableExcerpt (Maybe Int) Source #

A count of the number of rows in the original table within the document.

TableRow

data TableRow Source #

Information about a row in a table excerpt.

See: newTableRow smart constructor.

Constructors

TableRow'
Fields cells :: Maybe [TableCell] A list of table cells in a row.

Instances

Instances details

FromJSON TableRow Source #
Instance details Defined in Amazonka.Kendra.Types.TableRow Methods parseJSON :: Value -> Parser TableRow # parseJSONList :: Value -> Parser [TableRow] #
Generic TableRow Source #
Instance details Defined in Amazonka.Kendra.Types.TableRow Associated Types type Rep TableRow :: Type -> Type # Methods from :: TableRow -> Rep TableRow x # to :: Rep TableRow x -> TableRow #
Read TableRow Source #
Instance details Defined in Amazonka.Kendra.Types.TableRow Methods readsPrec :: Int -> ReadS TableRow # readList :: ReadS [TableRow] # readPrec :: ReadPrec TableRow # readListPrec :: ReadPrec [TableRow] #
Show TableRow Source #
Instance details Defined in Amazonka.Kendra.Types.TableRow Methods showsPrec :: Int -> TableRow -> ShowS # show :: TableRow -> String # showList :: [TableRow] -> ShowS #
NFData TableRow Source #
Instance details Defined in Amazonka.Kendra.Types.TableRow Methods rnf :: TableRow -> () #
Eq TableRow Source #
Instance details Defined in Amazonka.Kendra.Types.TableRow Methods (==) :: TableRow -> TableRow -> Bool # (/=) :: TableRow -> TableRow -> Bool #
Hashable TableRow Source #
Instance details Defined in Amazonka.Kendra.Types.TableRow Methods hashWithSalt :: Int -> TableRow -> Int # hash :: TableRow -> Int #
type Rep TableRow Source #
Instance details Defined in Amazonka.Kendra.Types.TableRow type Rep TableRow = D1 ('MetaData "TableRow" "Amazonka.Kendra.Types.TableRow" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TableRow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TableCell]))))

newTableRow :: TableRow Source #

Create a value of TableRow with all optional fields omitted.

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

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

$sel:cells:TableRow', tableRow_cells - A list of table cells in a row.

tableRow_cells :: Lens' TableRow (Maybe [TableCell]) Source #

A list of table cells in a row.

Tag

data Tag Source #

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

See: newTag smart constructor.

Constructors

Tag'
Fields key :: Text The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source. value :: Text The value associated with the tag. The value may be an empty string but it can't be null.

Instances

Instances details

FromJSON Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] #
ToJSON Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag Methods toJSON :: Tag -> Value # toEncoding :: Tag -> Encoding # toJSONList :: [Tag] -> Value # toEncodingList :: [Tag] -> Encoding #
Generic Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag Associated Types type Rep Tag :: Type -> Type # Methods from :: Tag -> Rep Tag x # to :: Rep Tag x -> Tag #
Read Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag Methods readsPrec :: Int -> ReadS Tag # readList :: ReadS [Tag] # readPrec :: ReadPrec Tag # readListPrec :: ReadPrec [Tag] #
Show Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
NFData Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag Methods rnf :: Tag -> () #
Eq Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Hashable Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag Methods hashWithSalt :: Int -> Tag -> Int # hash :: Tag -> Int #
type Rep Tag Source #
Instance details Defined in Amazonka.Kendra.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Kendra.Types.Tag" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Arguments

:: Text	`$sel:key:Tag'`
-> Text	`$sel:value:Tag'`
-> Tag

Create a value of Tag with all optional fields omitted.

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

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

$sel:key:Tag', tag_key - The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

$sel:value:Tag', tag_value - The value associated with the tag. The value may be an empty string but it can't be null.

tag_key :: Lens' Tag Text Source #

The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

tag_value :: Lens' Tag Text Source #

The value associated with the tag. The value may be an empty string but it can't be null.

Template

data Template Source #

The template schema used for the data source, where templates schemas are supported.

See Data source template schemas.

See: newTemplate smart constructor.

Constructors

Template'

Instances

Instances details

FromJSON Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template Methods parseJSON :: Value -> Parser Template # parseJSONList :: Value -> Parser [Template] #
ToJSON Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template Methods toJSON :: Template -> Value # toEncoding :: Template -> Encoding # toJSONList :: [Template] -> Value # toEncodingList :: [Template] -> Encoding #
Generic Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template Associated Types type Rep Template :: Type -> Type # Methods from :: Template -> Rep Template x # to :: Rep Template x -> Template #
Read Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template Methods readsPrec :: Int -> ReadS Template # readList :: ReadS [Template] # readPrec :: ReadPrec Template # readListPrec :: ReadPrec [Template] #
Show Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template Methods showsPrec :: Int -> Template -> ShowS # show :: Template -> String # showList :: [Template] -> ShowS #
NFData Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template Methods rnf :: Template -> () #
Eq Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template Methods (==) :: Template -> Template -> Bool # (/=) :: Template -> Template -> Bool #
Hashable Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template Methods hashWithSalt :: Int -> Template -> Int # hash :: Template -> Int #
type Rep Template Source #
Instance details Defined in Amazonka.Kendra.Types.Template type Rep Template = D1 ('MetaData "Template" "Amazonka.Kendra.Types.Template" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Template'" 'PrefixI 'False) (U1 :: Type -> Type))

newTemplate :: Template Source #

Create a value of Template with all optional fields omitted.

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

TemplateConfiguration

data TemplateConfiguration Source #

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

See: newTemplateConfiguration smart constructor.

Constructors

TemplateConfiguration'
Fields template :: Maybe Template The template schema used for the data source, where templates schemas are supported. See Data source template schemas.

Instances

Instances details

FromJSON TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration Methods parseJSON :: Value -> Parser TemplateConfiguration # parseJSONList :: Value -> Parser [TemplateConfiguration] #
ToJSON TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration Methods toJSON :: TemplateConfiguration -> Value # toEncoding :: TemplateConfiguration -> Encoding # toJSONList :: [TemplateConfiguration] -> Value # toEncodingList :: [TemplateConfiguration] -> Encoding #
Generic TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration Associated Types type Rep TemplateConfiguration :: Type -> Type # Methods from :: TemplateConfiguration -> Rep TemplateConfiguration x # to :: Rep TemplateConfiguration x -> TemplateConfiguration #
Read TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration Methods readsPrec :: Int -> ReadS TemplateConfiguration # readList :: ReadS [TemplateConfiguration] # readPrec :: ReadPrec TemplateConfiguration # readListPrec :: ReadPrec [TemplateConfiguration] #
Show TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration Methods showsPrec :: Int -> TemplateConfiguration -> ShowS # show :: TemplateConfiguration -> String # showList :: [TemplateConfiguration] -> ShowS #
NFData TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration Methods rnf :: TemplateConfiguration -> () #
Eq TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration Methods (==) :: TemplateConfiguration -> TemplateConfiguration -> Bool # (/=) :: TemplateConfiguration -> TemplateConfiguration -> Bool #
Hashable TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration Methods hashWithSalt :: Int -> TemplateConfiguration -> Int # hash :: TemplateConfiguration -> Int #
type Rep TemplateConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.TemplateConfiguration type Rep TemplateConfiguration = D1 ('MetaData "TemplateConfiguration" "Amazonka.Kendra.Types.TemplateConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TemplateConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Template))))

newTemplateConfiguration :: TemplateConfiguration Source #

Create a value of TemplateConfiguration with all optional fields omitted.

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

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

$sel:template:TemplateConfiguration', templateConfiguration_template - The template schema used for the data source, where templates schemas are supported.

See Data source template schemas.

templateConfiguration_template :: Lens' TemplateConfiguration (Maybe Template) Source #

The template schema used for the data source, where templates schemas are supported.

See Data source template schemas.

TextDocumentStatistics

data TextDocumentStatistics Source #

Provides information about text documents indexed in an index.

See: newTextDocumentStatistics smart constructor.

Constructors

TextDocumentStatistics'
Fields indexedTextDocumentsCount :: Natural The number of text documents indexed. indexedTextBytes :: Natural The total size, in bytes, of the indexed documents.

Instances

Instances details

FromJSON TextDocumentStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.TextDocumentStatistics Methods parseJSON :: Value -> Parser TextDocumentStatistics # parseJSONList :: Value -> Parser [TextDocumentStatistics] #
Generic TextDocumentStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.TextDocumentStatistics Associated Types type Rep TextDocumentStatistics :: Type -> Type # Methods from :: TextDocumentStatistics -> Rep TextDocumentStatistics x # to :: Rep TextDocumentStatistics x -> TextDocumentStatistics #
Read TextDocumentStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.TextDocumentStatistics Methods readsPrec :: Int -> ReadS TextDocumentStatistics # readList :: ReadS [TextDocumentStatistics] # readPrec :: ReadPrec TextDocumentStatistics # readListPrec :: ReadPrec [TextDocumentStatistics] #
Show TextDocumentStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.TextDocumentStatistics Methods showsPrec :: Int -> TextDocumentStatistics -> ShowS # show :: TextDocumentStatistics -> String # showList :: [TextDocumentStatistics] -> ShowS #
NFData TextDocumentStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.TextDocumentStatistics Methods rnf :: TextDocumentStatistics -> () #
Eq TextDocumentStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.TextDocumentStatistics Methods (==) :: TextDocumentStatistics -> TextDocumentStatistics -> Bool # (/=) :: TextDocumentStatistics -> TextDocumentStatistics -> Bool #
Hashable TextDocumentStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.TextDocumentStatistics Methods hashWithSalt :: Int -> TextDocumentStatistics -> Int # hash :: TextDocumentStatistics -> Int #
type Rep TextDocumentStatistics Source #
Instance details Defined in Amazonka.Kendra.Types.TextDocumentStatistics type Rep TextDocumentStatistics = D1 ('MetaData "TextDocumentStatistics" "Amazonka.Kendra.Types.TextDocumentStatistics" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TextDocumentStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexedTextDocumentsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "indexedTextBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newTextDocumentStatistics Source #

Arguments

:: Natural	`$sel:indexedTextDocumentsCount:TextDocumentStatistics'`
-> Natural	`$sel:indexedTextBytes:TextDocumentStatistics'`
-> TextDocumentStatistics

Create a value of TextDocumentStatistics with all optional fields omitted.

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

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

$sel:indexedTextDocumentsCount:TextDocumentStatistics', textDocumentStatistics_indexedTextDocumentsCount - The number of text documents indexed.

$sel:indexedTextBytes:TextDocumentStatistics', textDocumentStatistics_indexedTextBytes - The total size, in bytes, of the indexed documents.

textDocumentStatistics_indexedTextDocumentsCount :: Lens' TextDocumentStatistics Natural Source #

The number of text documents indexed.

textDocumentStatistics_indexedTextBytes :: Lens' TextDocumentStatistics Natural Source #

The total size, in bytes, of the indexed documents.

TextWithHighlights

data TextWithHighlights Source #

Provides text and information about where to highlight the text.

See: newTextWithHighlights smart constructor.

Constructors

TextWithHighlights'
Fields highlights :: Maybe [Highlight] The beginning and end of the text that should be highlighted. text :: Maybe Text The text to display to the user.

Instances

Instances details

FromJSON TextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.TextWithHighlights Methods parseJSON :: Value -> Parser TextWithHighlights # parseJSONList :: Value -> Parser [TextWithHighlights] #
Generic TextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.TextWithHighlights Associated Types type Rep TextWithHighlights :: Type -> Type # Methods from :: TextWithHighlights -> Rep TextWithHighlights x # to :: Rep TextWithHighlights x -> TextWithHighlights #
Read TextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.TextWithHighlights Methods readsPrec :: Int -> ReadS TextWithHighlights # readList :: ReadS [TextWithHighlights] # readPrec :: ReadPrec TextWithHighlights # readListPrec :: ReadPrec [TextWithHighlights] #
Show TextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.TextWithHighlights Methods showsPrec :: Int -> TextWithHighlights -> ShowS # show :: TextWithHighlights -> String # showList :: [TextWithHighlights] -> ShowS #
NFData TextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.TextWithHighlights Methods rnf :: TextWithHighlights -> () #
Eq TextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.TextWithHighlights Methods (==) :: TextWithHighlights -> TextWithHighlights -> Bool # (/=) :: TextWithHighlights -> TextWithHighlights -> Bool #
Hashable TextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.TextWithHighlights Methods hashWithSalt :: Int -> TextWithHighlights -> Int # hash :: TextWithHighlights -> Int #
type Rep TextWithHighlights Source #
Instance details Defined in Amazonka.Kendra.Types.TextWithHighlights type Rep TextWithHighlights = D1 ('MetaData "TextWithHighlights" "Amazonka.Kendra.Types.TextWithHighlights" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TextWithHighlights'" 'PrefixI 'True) (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Highlight])) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTextWithHighlights :: TextWithHighlights Source #

Create a value of TextWithHighlights with all optional fields omitted.

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

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

$sel:highlights:TextWithHighlights', textWithHighlights_highlights - The beginning and end of the text that should be highlighted.

$sel:text:TextWithHighlights', textWithHighlights_text - The text to display to the user.

textWithHighlights_highlights :: Lens' TextWithHighlights (Maybe [Highlight]) Source #

The beginning and end of the text that should be highlighted.

textWithHighlights_text :: Lens' TextWithHighlights (Maybe Text) Source #

The text to display to the user.

ThesaurusSummary

data ThesaurusSummary Source #

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

See: newThesaurusSummary smart constructor.

Constructors

ThesaurusSummary'
Fields createdAt :: Maybe POSIX The Unix datetime that the thesaurus was created. id :: Maybe Text The identifier of the thesaurus. name :: Maybe Text The name of the thesaurus. status :: Maybe ThesaurusStatus The status of the thesaurus. updatedAt :: Maybe POSIX The Unix datetime that the thesaurus was last updated.

Instances

Instances details

FromJSON ThesaurusSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusSummary Methods parseJSON :: Value -> Parser ThesaurusSummary # parseJSONList :: Value -> Parser [ThesaurusSummary] #
Generic ThesaurusSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusSummary Associated Types type Rep ThesaurusSummary :: Type -> Type # Methods from :: ThesaurusSummary -> Rep ThesaurusSummary x # to :: Rep ThesaurusSummary x -> ThesaurusSummary #
Read ThesaurusSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusSummary Methods readsPrec :: Int -> ReadS ThesaurusSummary # readList :: ReadS [ThesaurusSummary] # readPrec :: ReadPrec ThesaurusSummary # readListPrec :: ReadPrec [ThesaurusSummary] #
Show ThesaurusSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusSummary Methods showsPrec :: Int -> ThesaurusSummary -> ShowS # show :: ThesaurusSummary -> String # showList :: [ThesaurusSummary] -> ShowS #
NFData ThesaurusSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusSummary Methods rnf :: ThesaurusSummary -> () #
Eq ThesaurusSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusSummary Methods (==) :: ThesaurusSummary -> ThesaurusSummary -> Bool # (/=) :: ThesaurusSummary -> ThesaurusSummary -> Bool #
Hashable ThesaurusSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusSummary Methods hashWithSalt :: Int -> ThesaurusSummary -> Int # hash :: ThesaurusSummary -> Int #
type Rep ThesaurusSummary Source #
Instance details Defined in Amazonka.Kendra.Types.ThesaurusSummary type Rep ThesaurusSummary = D1 ('MetaData "ThesaurusSummary" "Amazonka.Kendra.Types.ThesaurusSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ThesaurusSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThesaurusStatus)) :: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newThesaurusSummary :: ThesaurusSummary Source #

Create a value of ThesaurusSummary with all optional fields omitted.

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

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

$sel:createdAt:ThesaurusSummary', thesaurusSummary_createdAt - The Unix datetime that the thesaurus was created.

$sel:id:ThesaurusSummary', thesaurusSummary_id - The identifier of the thesaurus.

$sel:name:ThesaurusSummary', thesaurusSummary_name - The name of the thesaurus.

$sel:status:ThesaurusSummary', thesaurusSummary_status - The status of the thesaurus.

$sel:updatedAt:ThesaurusSummary', thesaurusSummary_updatedAt - The Unix datetime that the thesaurus was last updated.

thesaurusSummary_createdAt :: Lens' ThesaurusSummary (Maybe UTCTime) Source #

The Unix datetime that the thesaurus was created.

thesaurusSummary_id :: Lens' ThesaurusSummary (Maybe Text) Source #

The identifier of the thesaurus.

thesaurusSummary_name :: Lens' ThesaurusSummary (Maybe Text) Source #

The name of the thesaurus.

thesaurusSummary_status :: Lens' ThesaurusSummary (Maybe ThesaurusStatus) Source #

The status of the thesaurus.

thesaurusSummary_updatedAt :: Lens' ThesaurusSummary (Maybe UTCTime) Source #

The Unix datetime that the thesaurus was last updated.

TimeRange

data TimeRange Source #

Provides a range of time.

See: newTimeRange smart constructor.

Constructors

TimeRange'
Fields endTime :: Maybe POSIX The UNIX datetime of the end of the time range. startTime :: Maybe POSIX The UNIX datetime of the beginning of the time range.

Instances

Instances details

FromJSON TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange Methods parseJSON :: Value -> Parser TimeRange # parseJSONList :: Value -> Parser [TimeRange] #
ToJSON TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange Methods toJSON :: TimeRange -> Value # toEncoding :: TimeRange -> Encoding # toJSONList :: [TimeRange] -> Value # toEncodingList :: [TimeRange] -> Encoding #
Generic TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange Associated Types type Rep TimeRange :: Type -> Type # Methods from :: TimeRange -> Rep TimeRange x # to :: Rep TimeRange x -> TimeRange #
Read TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange Methods readsPrec :: Int -> ReadS TimeRange # readList :: ReadS [TimeRange] # readPrec :: ReadPrec TimeRange # readListPrec :: ReadPrec [TimeRange] #
Show TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange Methods showsPrec :: Int -> TimeRange -> ShowS # show :: TimeRange -> String # showList :: [TimeRange] -> ShowS #
NFData TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange Methods rnf :: TimeRange -> () #
Eq TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange Methods (==) :: TimeRange -> TimeRange -> Bool # (/=) :: TimeRange -> TimeRange -> Bool #
Hashable TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange Methods hashWithSalt :: Int -> TimeRange -> Int # hash :: TimeRange -> Int #
type Rep TimeRange Source #
Instance details Defined in Amazonka.Kendra.Types.TimeRange type Rep TimeRange = D1 ('MetaData "TimeRange" "Amazonka.Kendra.Types.TimeRange" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TimeRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))

newTimeRange :: TimeRange Source #

Create a value of TimeRange with all optional fields omitted.

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

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

$sel:endTime:TimeRange', timeRange_endTime - The UNIX datetime of the end of the time range.

$sel:startTime:TimeRange', timeRange_startTime - The UNIX datetime of the beginning of the time range.

timeRange_endTime :: Lens' TimeRange (Maybe UTCTime) Source #

The UNIX datetime of the end of the time range.

timeRange_startTime :: Lens' TimeRange (Maybe UTCTime) Source #

The UNIX datetime of the beginning of the time range.

Urls

data Urls Source #

Provides the configuration information of the URLs to crawl.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

See: newUrls smart constructor.

Constructors

Urls'

Fields

seedUrlConfiguration :: Maybe SeedUrlConfiguration
Configuration of the seed or starting point URLs of the websites you want to crawl.
You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.
You can list up to 100 seed URLs.
siteMapsConfiguration :: Maybe SiteMapsConfiguration
Configuration of the sitemap URLs of the websites you want to crawl.
Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

Instances

Instances details

FromJSON Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls Methods parseJSON :: Value -> Parser Urls # parseJSONList :: Value -> Parser [Urls] #
ToJSON Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls Methods toJSON :: Urls -> Value # toEncoding :: Urls -> Encoding # toJSONList :: [Urls] -> Value # toEncodingList :: [Urls] -> Encoding #
Generic Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls Associated Types type Rep Urls :: Type -> Type # Methods from :: Urls -> Rep Urls x # to :: Rep Urls x -> Urls #
Read Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls Methods readsPrec :: Int -> ReadS Urls # readList :: ReadS [Urls] # readPrec :: ReadPrec Urls # readListPrec :: ReadPrec [Urls] #
Show Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls Methods showsPrec :: Int -> Urls -> ShowS # show :: Urls -> String # showList :: [Urls] -> ShowS #
NFData Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls Methods rnf :: Urls -> () #
Eq Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls Methods (==) :: Urls -> Urls -> Bool # (/=) :: Urls -> Urls -> Bool #
Hashable Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls Methods hashWithSalt :: Int -> Urls -> Int # hash :: Urls -> Int #
type Rep Urls Source #
Instance details Defined in Amazonka.Kendra.Types.Urls type Rep Urls = D1 ('MetaData "Urls" "Amazonka.Kendra.Types.Urls" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Urls'" 'PrefixI 'True) (S1 ('MetaSel ('Just "seedUrlConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SeedUrlConfiguration)) :*: S1 ('MetaSel ('Just "siteMapsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SiteMapsConfiguration))))

newUrls :: Urls Source #

Create a value of Urls with all optional fields omitted.

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

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

$sel:seedUrlConfiguration:Urls', urls_seedUrlConfiguration - Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.

You can list up to 100 seed URLs.

$sel:siteMapsConfiguration:Urls', urls_siteMapsConfiguration - Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

urls_seedUrlConfiguration :: Lens' Urls (Maybe SeedUrlConfiguration) Source #

Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.

You can list up to 100 seed URLs.

urls_siteMapsConfiguration :: Lens' Urls (Maybe SiteMapsConfiguration) Source #

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

UserContext

data UserContext Source #

Provides information about the user context for an Amazon Kendra index.

User context filtering is a kind of personalized search with the benefit of controlling access to documents. For example, not all teams that search the company portal for information should access top-secret company documents, nor are these documents relevant to all users. Only specific users or groups of teams given access to top-secret documents should see these documents in their search results.

You provide one of the following:

User token
User ID, the groups the user belongs to, and any data sources the groups can access.

If you provide both, an exception is thrown.

See: newUserContext smart constructor.

Constructors

UserContext'

Fields

dataSourceGroups :: Maybe (NonEmpty DataSourceGroup)
The list of data source groups you want to filter search results based on groups' access to documents in that data source.
groups :: Maybe (NonEmpty Text)
The list of groups you want to filter search results based on the groups' access to documents.
token :: Maybe Text
The user context token for filtering search results for a user. It must be a JWT or a JSON token.
userId :: Maybe Text
The identifier of the user you want to filter search results based on their access to documents.

Instances

Instances details

ToJSON UserContext Source #
Instance details Defined in Amazonka.Kendra.Types.UserContext Methods toJSON :: UserContext -> Value # toEncoding :: UserContext -> Encoding # toJSONList :: [UserContext] -> Value # toEncodingList :: [UserContext] -> Encoding #
Generic UserContext Source #
Instance details Defined in Amazonka.Kendra.Types.UserContext Associated Types type Rep UserContext :: Type -> Type # Methods from :: UserContext -> Rep UserContext x # to :: Rep UserContext x -> UserContext #
Read UserContext Source #
Instance details Defined in Amazonka.Kendra.Types.UserContext Methods readsPrec :: Int -> ReadS UserContext # readList :: ReadS [UserContext] # readPrec :: ReadPrec UserContext # readListPrec :: ReadPrec [UserContext] #
Show UserContext Source #
Instance details Defined in Amazonka.Kendra.Types.UserContext Methods showsPrec :: Int -> UserContext -> ShowS # show :: UserContext -> String # showList :: [UserContext] -> ShowS #
NFData UserContext Source #
Instance details Defined in Amazonka.Kendra.Types.UserContext Methods rnf :: UserContext -> () #
Eq UserContext Source #
Instance details Defined in Amazonka.Kendra.Types.UserContext Methods (==) :: UserContext -> UserContext -> Bool # (/=) :: UserContext -> UserContext -> Bool #
Hashable UserContext Source #
Instance details Defined in Amazonka.Kendra.Types.UserContext Methods hashWithSalt :: Int -> UserContext -> Int # hash :: UserContext -> Int #
type Rep UserContext Source #
Instance details Defined in Amazonka.Kendra.Types.UserContext type Rep UserContext = D1 ('MetaData "UserContext" "Amazonka.Kendra.Types.UserContext" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserContext'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceGroup))) :: S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newUserContext :: UserContext Source #

Create a value of UserContext with all optional fields omitted.

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

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

$sel:dataSourceGroups:UserContext', userContext_dataSourceGroups - The list of data source groups you want to filter search results based on groups' access to documents in that data source.

$sel:groups:UserContext', userContext_groups - The list of groups you want to filter search results based on the groups' access to documents.

$sel:token:UserContext', userContext_token - The user context token for filtering search results for a user. It must be a JWT or a JSON token.

$sel:userId:UserContext', userContext_userId - The identifier of the user you want to filter search results based on their access to documents.

userContext_dataSourceGroups :: Lens' UserContext (Maybe (NonEmpty DataSourceGroup)) Source #

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

userContext_groups :: Lens' UserContext (Maybe (NonEmpty Text)) Source #

The list of groups you want to filter search results based on the groups' access to documents.

userContext_token :: Lens' UserContext (Maybe Text) Source #

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

userContext_userId :: Lens' UserContext (Maybe Text) Source #

The identifier of the user you want to filter search results based on their access to documents.

UserGroupResolutionConfiguration

data UserGroupResolutionConfiguration Source #

Provides the configuration information to fetch access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the PutPrincipalMapping API to map users to their groups so that you only need to provide the user ID when you issue the query.

To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see Getting started with an IAM Identity Center identity source. You must also grant the required permissions to use IAM Identity Center with Amazon Kendra. For more information, see IAM roles for IAM Identity Center.

Amazon Kendra currently does not support using UserGroupResolutionConfiguration with an Amazon Web Services organization member account for your IAM Identity Center identify source. You must create your index in the management account for the organization in order to use UserGroupResolutionConfiguration.

See: newUserGroupResolutionConfiguration smart constructor.

Constructors

UserGroupResolutionConfiguration'
Fields userGroupResolutionMode :: UserGroupResolutionMode The identity store provider (mode) you want to use to fetch access levels of groups and users. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Instances

Instances details

FromJSON UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration Methods parseJSON :: Value -> Parser UserGroupResolutionConfiguration # parseJSONList :: Value -> Parser [UserGroupResolutionConfiguration] #
ToJSON UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration Methods toJSON :: UserGroupResolutionConfiguration -> Value # toEncoding :: UserGroupResolutionConfiguration -> Encoding # toJSONList :: [UserGroupResolutionConfiguration] -> Value # toEncodingList :: [UserGroupResolutionConfiguration] -> Encoding #
Generic UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration Associated Types type Rep UserGroupResolutionConfiguration :: Type -> Type # Methods from :: UserGroupResolutionConfiguration -> Rep UserGroupResolutionConfiguration x # to :: Rep UserGroupResolutionConfiguration x -> UserGroupResolutionConfiguration #
Read UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration Methods readsPrec :: Int -> ReadS UserGroupResolutionConfiguration # readList :: ReadS [UserGroupResolutionConfiguration] # readPrec :: ReadPrec UserGroupResolutionConfiguration # readListPrec :: ReadPrec [UserGroupResolutionConfiguration] #
Show UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration Methods showsPrec :: Int -> UserGroupResolutionConfiguration -> ShowS # show :: UserGroupResolutionConfiguration -> String # showList :: [UserGroupResolutionConfiguration] -> ShowS #
NFData UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration Methods rnf :: UserGroupResolutionConfiguration -> () #
Eq UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration Methods (==) :: UserGroupResolutionConfiguration -> UserGroupResolutionConfiguration -> Bool # (/=) :: UserGroupResolutionConfiguration -> UserGroupResolutionConfiguration -> Bool #
Hashable UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration Methods hashWithSalt :: Int -> UserGroupResolutionConfiguration -> Int # hash :: UserGroupResolutionConfiguration -> Int #
type Rep UserGroupResolutionConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserGroupResolutionConfiguration type Rep UserGroupResolutionConfiguration = D1 ('MetaData "UserGroupResolutionConfiguration" "Amazonka.Kendra.Types.UserGroupResolutionConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserGroupResolutionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userGroupResolutionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserGroupResolutionMode)))

newUserGroupResolutionConfiguration Source #

Arguments

:: UserGroupResolutionMode	`$sel:userGroupResolutionMode:UserGroupResolutionConfiguration'`
-> UserGroupResolutionConfiguration

Create a value of UserGroupResolutionConfiguration with all optional fields omitted.

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

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

$sel:userGroupResolutionMode:UserGroupResolutionConfiguration', userGroupResolutionConfiguration_userGroupResolutionMode - The identity store provider (mode) you want to use to fetch access levels of groups and users. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

userGroupResolutionConfiguration_userGroupResolutionMode :: Lens' UserGroupResolutionConfiguration UserGroupResolutionMode Source #

The identity store provider (mode) you want to use to fetch access levels of groups and users. IAM Identity Center (successor to Single Sign-On) is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

UserIdentityConfiguration

data UserIdentityConfiguration Source #

Provides the configuration information for the identifiers of your users.

See: newUserIdentityConfiguration smart constructor.

Constructors

UserIdentityConfiguration'

Fields

identityAttributeName :: Maybe Text
The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for user context filtering and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see Getting started with an IAM Identity Center identity source.

Instances

Instances details

FromJSON UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods parseJSON :: Value -> Parser UserIdentityConfiguration # parseJSONList :: Value -> Parser [UserIdentityConfiguration] #
ToJSON UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods toJSON :: UserIdentityConfiguration -> Value # toEncoding :: UserIdentityConfiguration -> Encoding # toJSONList :: [UserIdentityConfiguration] -> Value # toEncodingList :: [UserIdentityConfiguration] -> Encoding #
Generic UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Associated Types type Rep UserIdentityConfiguration :: Type -> Type # Methods from :: UserIdentityConfiguration -> Rep UserIdentityConfiguration x # to :: Rep UserIdentityConfiguration x -> UserIdentityConfiguration #
Read UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods readsPrec :: Int -> ReadS UserIdentityConfiguration # readList :: ReadS [UserIdentityConfiguration] # readPrec :: ReadPrec UserIdentityConfiguration # readListPrec :: ReadPrec [UserIdentityConfiguration] #
Show UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods showsPrec :: Int -> UserIdentityConfiguration -> ShowS # show :: UserIdentityConfiguration -> String # showList :: [UserIdentityConfiguration] -> ShowS #
NFData UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods rnf :: UserIdentityConfiguration -> () #
Eq UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods (==) :: UserIdentityConfiguration -> UserIdentityConfiguration -> Bool # (/=) :: UserIdentityConfiguration -> UserIdentityConfiguration -> Bool #
Hashable UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods hashWithSalt :: Int -> UserIdentityConfiguration -> Int # hash :: UserIdentityConfiguration -> Int #
type Rep UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration type Rep UserIdentityConfiguration = D1 ('MetaData "UserIdentityConfiguration" "Amazonka.Kendra.Types.UserIdentityConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserIdentityConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityAttributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newUserIdentityConfiguration :: UserIdentityConfiguration Source #

Create a value of UserIdentityConfiguration with all optional fields omitted.

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

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

$sel:identityAttributeName:UserIdentityConfiguration', userIdentityConfiguration_identityAttributeName - The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for user context filtering and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see Getting started with an IAM Identity Center identity source.

userIdentityConfiguration_identityAttributeName :: Lens' UserIdentityConfiguration (Maybe Text) Source #

The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for user context filtering and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see Getting started with an IAM Identity Center identity source.

UserTokenConfiguration

data UserTokenConfiguration Source #

Provides the configuration information for a token.

See: newUserTokenConfiguration smart constructor.

Constructors

UserTokenConfiguration'
Fields jsonTokenTypeConfiguration :: Maybe JsonTokenTypeConfiguration Information about the JSON token type configuration. jwtTokenTypeConfiguration :: Maybe JwtTokenTypeConfiguration Information about the JWT token type configuration.

Instances

Instances details

FromJSON UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration Methods parseJSON :: Value -> Parser UserTokenConfiguration # parseJSONList :: Value -> Parser [UserTokenConfiguration] #
ToJSON UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration Methods toJSON :: UserTokenConfiguration -> Value # toEncoding :: UserTokenConfiguration -> Encoding # toJSONList :: [UserTokenConfiguration] -> Value # toEncodingList :: [UserTokenConfiguration] -> Encoding #
Generic UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration Associated Types type Rep UserTokenConfiguration :: Type -> Type # Methods from :: UserTokenConfiguration -> Rep UserTokenConfiguration x # to :: Rep UserTokenConfiguration x -> UserTokenConfiguration #
Read UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration Methods readsPrec :: Int -> ReadS UserTokenConfiguration # readList :: ReadS [UserTokenConfiguration] # readPrec :: ReadPrec UserTokenConfiguration # readListPrec :: ReadPrec [UserTokenConfiguration] #
Show UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration Methods showsPrec :: Int -> UserTokenConfiguration -> ShowS # show :: UserTokenConfiguration -> String # showList :: [UserTokenConfiguration] -> ShowS #
NFData UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration Methods rnf :: UserTokenConfiguration -> () #
Eq UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration Methods (==) :: UserTokenConfiguration -> UserTokenConfiguration -> Bool # (/=) :: UserTokenConfiguration -> UserTokenConfiguration -> Bool #
Hashable UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration Methods hashWithSalt :: Int -> UserTokenConfiguration -> Int # hash :: UserTokenConfiguration -> Int #
type Rep UserTokenConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserTokenConfiguration type Rep UserTokenConfiguration = D1 ('MetaData "UserTokenConfiguration" "Amazonka.Kendra.Types.UserTokenConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserTokenConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jsonTokenTypeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JsonTokenTypeConfiguration)) :*: S1 ('MetaSel ('Just "jwtTokenTypeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JwtTokenTypeConfiguration))))

newUserTokenConfiguration :: UserTokenConfiguration Source #

Create a value of UserTokenConfiguration with all optional fields omitted.

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

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

$sel:jsonTokenTypeConfiguration:UserTokenConfiguration', userTokenConfiguration_jsonTokenTypeConfiguration - Information about the JSON token type configuration.

$sel:jwtTokenTypeConfiguration:UserTokenConfiguration', userTokenConfiguration_jwtTokenTypeConfiguration - Information about the JWT token type configuration.

userTokenConfiguration_jsonTokenTypeConfiguration :: Lens' UserTokenConfiguration (Maybe JsonTokenTypeConfiguration) Source #

Information about the JSON token type configuration.

userTokenConfiguration_jwtTokenTypeConfiguration :: Lens' UserTokenConfiguration (Maybe JwtTokenTypeConfiguration) Source #

Information about the JWT token type configuration.

Warning

data Warning Source #

The warning code and message that explains a problem with a query.

See: newWarning smart constructor.

Constructors

Warning'
Fields code :: Maybe WarningCode The code used to show the type of warning for the query. message :: Maybe Text The message that explains the problem with the query.

Instances

Instances details

FromJSON Warning Source #
Instance details Defined in Amazonka.Kendra.Types.Warning Methods parseJSON :: Value -> Parser Warning # parseJSONList :: Value -> Parser [Warning] #
Generic Warning Source #
Instance details Defined in Amazonka.Kendra.Types.Warning Associated Types type Rep Warning :: Type -> Type # Methods from :: Warning -> Rep Warning x # to :: Rep Warning x -> Warning #
Read Warning Source #
Instance details Defined in Amazonka.Kendra.Types.Warning Methods readsPrec :: Int -> ReadS Warning # readList :: ReadS [Warning] # readPrec :: ReadPrec Warning # readListPrec :: ReadPrec [Warning] #
Show Warning Source #
Instance details Defined in Amazonka.Kendra.Types.Warning Methods showsPrec :: Int -> Warning -> ShowS # show :: Warning -> String # showList :: [Warning] -> ShowS #
NFData Warning Source #
Instance details Defined in Amazonka.Kendra.Types.Warning Methods rnf :: Warning -> () #
Eq Warning Source #
Instance details Defined in Amazonka.Kendra.Types.Warning Methods (==) :: Warning -> Warning -> Bool # (/=) :: Warning -> Warning -> Bool #
Hashable Warning Source #
Instance details Defined in Amazonka.Kendra.Types.Warning Methods hashWithSalt :: Int -> Warning -> Int # hash :: Warning -> Int #
type Rep Warning Source #
Instance details Defined in Amazonka.Kendra.Types.Warning type Rep Warning = D1 ('MetaData "Warning" "Amazonka.Kendra.Types.Warning" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Warning'" 'PrefixI 'True) (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WarningCode)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newWarning :: Warning Source #

Create a value of Warning with all optional fields omitted.

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

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

$sel:code:Warning', warning_code - The code used to show the type of warning for the query.

$sel:message:Warning', warning_message - The message that explains the problem with the query.

warning_code :: Lens' Warning (Maybe WarningCode) Source #

The code used to show the type of warning for the query.

warning_message :: Lens' Warning (Maybe Text) Source #

The message that explains the problem with the query.

WebCrawlerConfiguration

data WebCrawlerConfiguration Source #

Provides the configuration information required for Amazon Kendra Web Crawler.

See: newWebCrawlerConfiguration smart constructor.

Constructors

WebCrawlerConfiguration'

Fields

authenticationConfiguration :: Maybe AuthenticationConfiguration
Configuration information required to connect to websites using authentication.
You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.
You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.
crawlDepth :: Maybe Natural
Specifies the number of levels in a website that you want to crawl.
The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.
The default crawl depth is set to 2.
maxContentSizePerPageInMegaBytes :: Maybe Double
The maximum size (in MB) of a webpage or attachment to crawl.
Files larger than this size (in MB) are skipped/not crawled.
The default maximum size of a webpage or attachment is set to 50 MB.
maxLinksPerPage :: Maybe Natural
The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.
As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.
The default maximum links per page is 100.
maxUrlsPerMinuteCrawlRate :: Maybe Natural
The maximum number of URLs crawled per website host per minute.
A minimum of one URL is required.
The default maximum number of URLs crawled per website host per minute is 300.
proxyConfiguration :: Maybe ProxyConfiguration
Configuration information required to connect to your internal websites via a web proxy.
You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.
Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.
urlExclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
urlInclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
urls :: Urls
Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.
You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.
You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.
/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

Instances

Instances details

FromJSON WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration Methods parseJSON :: Value -> Parser WebCrawlerConfiguration # parseJSONList :: Value -> Parser [WebCrawlerConfiguration] #
ToJSON WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration Methods toJSON :: WebCrawlerConfiguration -> Value # toEncoding :: WebCrawlerConfiguration -> Encoding # toJSONList :: [WebCrawlerConfiguration] -> Value # toEncodingList :: [WebCrawlerConfiguration] -> Encoding #
Generic WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration Associated Types type Rep WebCrawlerConfiguration :: Type -> Type # Methods from :: WebCrawlerConfiguration -> Rep WebCrawlerConfiguration x # to :: Rep WebCrawlerConfiguration x -> WebCrawlerConfiguration #
Read WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration Methods readsPrec :: Int -> ReadS WebCrawlerConfiguration # readList :: ReadS [WebCrawlerConfiguration] # readPrec :: ReadPrec WebCrawlerConfiguration # readListPrec :: ReadPrec [WebCrawlerConfiguration] #
Show WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration Methods showsPrec :: Int -> WebCrawlerConfiguration -> ShowS # show :: WebCrawlerConfiguration -> String # showList :: [WebCrawlerConfiguration] -> ShowS #
NFData WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration Methods rnf :: WebCrawlerConfiguration -> () #
Eq WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration Methods (==) :: WebCrawlerConfiguration -> WebCrawlerConfiguration -> Bool # (/=) :: WebCrawlerConfiguration -> WebCrawlerConfiguration -> Bool #
Hashable WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration Methods hashWithSalt :: Int -> WebCrawlerConfiguration -> Int # hash :: WebCrawlerConfiguration -> Int #
type Rep WebCrawlerConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WebCrawlerConfiguration type Rep WebCrawlerConfiguration = D1 ('MetaData "WebCrawlerConfiguration" "Amazonka.Kendra.Types.WebCrawlerConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "WebCrawlerConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationConfiguration)) :: S1 ('MetaSel ('Just "crawlDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "maxContentSizePerPageInMegaBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "maxLinksPerPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "maxUrlsPerMinuteCrawlRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration))) :: (S1 ('MetaSel ('Just "urlExclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "urlInclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "urls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Urls))))))

newWebCrawlerConfiguration Source #

Arguments

:: Urls	`$sel:urls:WebCrawlerConfiguration'`
-> WebCrawlerConfiguration

Create a value of WebCrawlerConfiguration with all optional fields omitted.

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

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

$sel:authenticationConfiguration:WebCrawlerConfiguration', webCrawlerConfiguration_authenticationConfiguration - Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

$sel:crawlDepth:WebCrawlerConfiguration', webCrawlerConfiguration_crawlDepth - Specifies the number of levels in a website that you want to crawl.

The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

The default crawl depth is set to 2.

$sel:maxContentSizePerPageInMegaBytes:WebCrawlerConfiguration', webCrawlerConfiguration_maxContentSizePerPageInMegaBytes - The maximum size (in MB) of a webpage or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a webpage or attachment is set to 50 MB.

$sel:maxLinksPerPage:WebCrawlerConfiguration', webCrawlerConfiguration_maxLinksPerPage - The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

The default maximum links per page is 100.

$sel:maxUrlsPerMinuteCrawlRate:WebCrawlerConfiguration', webCrawlerConfiguration_maxUrlsPerMinuteCrawlRate - The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

$sel:proxyConfiguration:WebCrawlerConfiguration', webCrawlerConfiguration_proxyConfiguration - Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

$sel:urlExclusionPatterns:WebCrawlerConfiguration', webCrawlerConfiguration_urlExclusionPatterns - A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

$sel:urlInclusionPatterns:WebCrawlerConfiguration', webCrawlerConfiguration_urlInclusionPatterns - A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

$sel:urls:WebCrawlerConfiguration', webCrawlerConfiguration_urls - Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

webCrawlerConfiguration_authenticationConfiguration :: Lens' WebCrawlerConfiguration (Maybe AuthenticationConfiguration) Source #

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

webCrawlerConfiguration_crawlDepth :: Lens' WebCrawlerConfiguration (Maybe Natural) Source #

Specifies the number of levels in a website that you want to crawl.

The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

The default crawl depth is set to 2.

webCrawlerConfiguration_maxContentSizePerPageInMegaBytes :: Lens' WebCrawlerConfiguration (Maybe Double) Source #

The maximum size (in MB) of a webpage or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a webpage or attachment is set to 50 MB.

webCrawlerConfiguration_maxLinksPerPage :: Lens' WebCrawlerConfiguration (Maybe Natural) Source #

The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

The default maximum links per page is 100.

webCrawlerConfiguration_maxUrlsPerMinuteCrawlRate :: Lens' WebCrawlerConfiguration (Maybe Natural) Source #

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

webCrawlerConfiguration_proxyConfiguration :: Lens' WebCrawlerConfiguration (Maybe ProxyConfiguration) Source #

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

webCrawlerConfiguration_urlExclusionPatterns :: Lens' WebCrawlerConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

webCrawlerConfiguration_urlInclusionPatterns :: Lens' WebCrawlerConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

webCrawlerConfiguration_urls :: Lens' WebCrawlerConfiguration Urls Source #

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

/When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index./

WorkDocsConfiguration

data WorkDocsConfiguration Source #

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

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

See: newWorkDocsConfiguration smart constructor.

Constructors

WorkDocsConfiguration'

Fields

crawlComments :: Maybe Bool
TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
The default is set to FALSE.
exclusionPatterns :: Maybe [Text]
A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.
inclusionPatterns :: Maybe [Text]
A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
useChangeLog :: Maybe Bool
TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.
organizationId :: Text
The identifier of the directory corresponding to your Amazon WorkDocs site repository.
You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

Instances

Instances details

FromJSON WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration Methods parseJSON :: Value -> Parser WorkDocsConfiguration # parseJSONList :: Value -> Parser [WorkDocsConfiguration] #
ToJSON WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration Methods toJSON :: WorkDocsConfiguration -> Value # toEncoding :: WorkDocsConfiguration -> Encoding # toJSONList :: [WorkDocsConfiguration] -> Value # toEncodingList :: [WorkDocsConfiguration] -> Encoding #
Generic WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration Associated Types type Rep WorkDocsConfiguration :: Type -> Type # Methods from :: WorkDocsConfiguration -> Rep WorkDocsConfiguration x # to :: Rep WorkDocsConfiguration x -> WorkDocsConfiguration #
Read WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration Methods readsPrec :: Int -> ReadS WorkDocsConfiguration # readList :: ReadS [WorkDocsConfiguration] # readPrec :: ReadPrec WorkDocsConfiguration # readListPrec :: ReadPrec [WorkDocsConfiguration] #
Show WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration Methods showsPrec :: Int -> WorkDocsConfiguration -> ShowS # show :: WorkDocsConfiguration -> String # showList :: [WorkDocsConfiguration] -> ShowS #
NFData WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration Methods rnf :: WorkDocsConfiguration -> () #
Eq WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration Methods (==) :: WorkDocsConfiguration -> WorkDocsConfiguration -> Bool # (/=) :: WorkDocsConfiguration -> WorkDocsConfiguration -> Bool #
Hashable WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration Methods hashWithSalt :: Int -> WorkDocsConfiguration -> Int # hash :: WorkDocsConfiguration -> Int #
type Rep WorkDocsConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.WorkDocsConfiguration type Rep WorkDocsConfiguration = D1 ('MetaData "WorkDocsConfiguration" "Amazonka.Kendra.Types.WorkDocsConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "WorkDocsConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newWorkDocsConfiguration Source #

Arguments

:: Text	`$sel:organizationId:WorkDocsConfiguration'`
-> WorkDocsConfiguration

Create a value of WorkDocsConfiguration with all optional fields omitted.

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

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

$sel:crawlComments:WorkDocsConfiguration', workDocsConfiguration_crawlComments - TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE.

$sel:exclusionPatterns:WorkDocsConfiguration', workDocsConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:fieldMappings:WorkDocsConfiguration', workDocsConfiguration_fieldMappings - A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.

$sel:inclusionPatterns:WorkDocsConfiguration', workDocsConfiguration_inclusionPatterns - A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

$sel:useChangeLog:WorkDocsConfiguration', workDocsConfiguration_useChangeLog - TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

$sel:organizationId:WorkDocsConfiguration', workDocsConfiguration_organizationId - The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

workDocsConfiguration_crawlComments :: Lens' WorkDocsConfiguration (Maybe Bool) Source #

TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE.

workDocsConfiguration_exclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

workDocsConfiguration_fieldMappings :: Lens' WorkDocsConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.

workDocsConfiguration_inclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

workDocsConfiguration_useChangeLog :: Lens' WorkDocsConfiguration (Maybe Bool) Source #

TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

workDocsConfiguration_organizationId :: Lens' WorkDocsConfiguration Text Source #

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

ToJSON AttributeFilter Source #
Instance details Defined in Amazonka.Kendra.Types.AttributeFilter Methods toJSON :: AttributeFilter -> Value # toEncoding :: AttributeFilter -> Encoding # toJSONList :: [AttributeFilter] -> Value # toEncodingList :: [AttributeFilter] -> Encoding #
Generic AttributeFilter Source #
Instance details Defined in Amazonka.Kendra.Types.AttributeFilter Associated Types type Rep AttributeFilter :: Type -> Type # Methods from :: AttributeFilter -> Rep AttributeFilter x # to :: Rep AttributeFilter x -> AttributeFilter #
Read AttributeFilter Source #
Instance details Defined in Amazonka.Kendra.Types.AttributeFilter Methods readsPrec :: Int -> ReadS AttributeFilter # readList :: ReadS [AttributeFilter] # readPrec :: ReadPrec AttributeFilter # readListPrec :: ReadPrec [AttributeFilter] #
Show AttributeFilter Source #
Instance details Defined in Amazonka.Kendra.Types.AttributeFilter Methods showsPrec :: Int -> AttributeFilter -> ShowS # show :: AttributeFilter -> String # showList :: [AttributeFilter] -> ShowS #
NFData AttributeFilter Source #
Instance details Defined in Amazonka.Kendra.Types.AttributeFilter Methods rnf :: AttributeFilter -> () #
Eq AttributeFilter Source #
Instance details Defined in Amazonka.Kendra.Types.AttributeFilter Methods (==) :: AttributeFilter -> AttributeFilter -> Bool # (/=) :: AttributeFilter -> AttributeFilter -> Bool #
Hashable AttributeFilter Source #
Instance details Defined in Amazonka.Kendra.Types.AttributeFilter Methods hashWithSalt :: Int -> AttributeFilter -> Int # hash :: AttributeFilter -> Int #
type Rep AttributeFilter Source #
Instance details Defined in Amazonka.Kendra.Types.AttributeFilter type Rep AttributeFilter = D1 ('MetaData "AttributeFilter" "Amazonka.Kendra.Types.AttributeFilter" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "AttributeFilter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "andAllFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeFilter])) :: S1 ('MetaSel ('Just "containsAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute))) :: (S1 ('MetaSel ('Just "containsAny") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute)) :: (S1 ('MetaSel ('Just "equalsTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute)) :: S1 ('MetaSel ('Just "greaterThan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute))))) :: ((S1 ('MetaSel ('Just "greaterThanOrEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute)) :: S1 ('MetaSel ('Just "lessThan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute))) :: (S1 ('MetaSel ('Just "lessThanOrEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttribute)) :: (S1 ('MetaSel ('Just "notFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeFilter)) :*: S1 ('MetaSel ('Just "orAllFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeFilter])))))))

ToJSON Facet Source #
Instance details Defined in Amazonka.Kendra.Types.Facet Methods toJSON :: Facet -> Value # toEncoding :: Facet -> Encoding # toJSONList :: [Facet] -> Value # toEncodingList :: [Facet] -> Encoding #
Generic Facet Source #
Instance details Defined in Amazonka.Kendra.Types.Facet Associated Types type Rep Facet :: Type -> Type # Methods from :: Facet -> Rep Facet x # to :: Rep Facet x -> Facet #
Read Facet Source #
Instance details Defined in Amazonka.Kendra.Types.Facet Methods readsPrec :: Int -> ReadS Facet # readList :: ReadS [Facet] # readPrec :: ReadPrec Facet # readListPrec :: ReadPrec [Facet] #
Show Facet Source #
Instance details Defined in Amazonka.Kendra.Types.Facet Methods showsPrec :: Int -> Facet -> ShowS # show :: Facet -> String # showList :: [Facet] -> ShowS #
NFData Facet Source #
Instance details Defined in Amazonka.Kendra.Types.Facet Methods rnf :: Facet -> () #
Eq Facet Source #
Instance details Defined in Amazonka.Kendra.Types.Facet Methods (==) :: Facet -> Facet -> Bool # (/=) :: Facet -> Facet -> Bool #
Hashable Facet Source #
Instance details Defined in Amazonka.Kendra.Types.Facet Methods hashWithSalt :: Int -> Facet -> Int # hash :: Facet -> Int #
type Rep Facet Source #
Instance details Defined in Amazonka.Kendra.Types.Facet type Rep Facet = D1 ('MetaData "Facet" "Amazonka.Kendra.Types.Facet" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "Facet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "facets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Facet])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))