| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Wisdom.Types
Contents
- Service Configuration
- Errors
- AssistantStatus
- AssistantType
- AssociationType
- ContentStatus
- FilterField
- FilterOperator
- KnowledgeBaseStatus
- KnowledgeBaseType
- RelevanceLevel
- AppIntegrationsConfiguration
- AssistantAssociationData
- AssistantAssociationInputData
- AssistantAssociationOutputData
- AssistantAssociationSummary
- AssistantData
- AssistantSummary
- ContentData
- ContentReference
- ContentSummary
- Document
- DocumentText
- Filter
- Highlight
- KnowledgeBaseAssociationData
- KnowledgeBaseData
- KnowledgeBaseSummary
- NotifyRecommendationsReceivedError
- RecommendationData
- RenderingConfiguration
- ResultData
- SearchExpression
- ServerSideEncryptionConfiguration
- SessionData
- SessionSummary
- SourceConfiguration
Description
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PreconditionFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AssistantStatus where
- AssistantStatus' { }
- pattern AssistantStatus_ACTIVE :: AssistantStatus
- pattern AssistantStatus_CREATE_FAILED :: AssistantStatus
- pattern AssistantStatus_CREATE_IN_PROGRESS :: AssistantStatus
- pattern AssistantStatus_DELETED :: AssistantStatus
- pattern AssistantStatus_DELETE_FAILED :: AssistantStatus
- pattern AssistantStatus_DELETE_IN_PROGRESS :: AssistantStatus
- newtype AssistantType where
- AssistantType' { }
- pattern AssistantType_AGENT :: AssistantType
- newtype AssociationType where
- AssociationType' { }
- pattern AssociationType_KNOWLEDGE_BASE :: AssociationType
- newtype ContentStatus where
- ContentStatus' { }
- pattern ContentStatus_ACTIVE :: ContentStatus
- pattern ContentStatus_CREATE_FAILED :: ContentStatus
- pattern ContentStatus_CREATE_IN_PROGRESS :: ContentStatus
- pattern ContentStatus_DELETED :: ContentStatus
- pattern ContentStatus_DELETE_FAILED :: ContentStatus
- pattern ContentStatus_DELETE_IN_PROGRESS :: ContentStatus
- pattern ContentStatus_UPDATE_FAILED :: ContentStatus
- newtype FilterField where
- FilterField' { }
- pattern FilterField_NAME :: FilterField
- newtype FilterOperator where
- FilterOperator' { }
- pattern FilterOperator_EQUALS :: FilterOperator
- newtype KnowledgeBaseStatus where
- KnowledgeBaseStatus' { }
- pattern KnowledgeBaseStatus_ACTIVE :: KnowledgeBaseStatus
- pattern KnowledgeBaseStatus_CREATE_FAILED :: KnowledgeBaseStatus
- pattern KnowledgeBaseStatus_CREATE_IN_PROGRESS :: KnowledgeBaseStatus
- pattern KnowledgeBaseStatus_DELETED :: KnowledgeBaseStatus
- pattern KnowledgeBaseStatus_DELETE_FAILED :: KnowledgeBaseStatus
- pattern KnowledgeBaseStatus_DELETE_IN_PROGRESS :: KnowledgeBaseStatus
- newtype KnowledgeBaseType where
- KnowledgeBaseType' { }
- pattern KnowledgeBaseType_CUSTOM :: KnowledgeBaseType
- pattern KnowledgeBaseType_EXTERNAL :: KnowledgeBaseType
- newtype RelevanceLevel where
- RelevanceLevel' { }
- pattern RelevanceLevel_HIGH :: RelevanceLevel
- pattern RelevanceLevel_LOW :: RelevanceLevel
- pattern RelevanceLevel_MEDIUM :: RelevanceLevel
- data AppIntegrationsConfiguration = AppIntegrationsConfiguration' {}
- newAppIntegrationsConfiguration :: Text -> NonEmpty Text -> AppIntegrationsConfiguration
- appIntegrationsConfiguration_appIntegrationArn :: Lens' AppIntegrationsConfiguration Text
- appIntegrationsConfiguration_objectFields :: Lens' AppIntegrationsConfiguration (NonEmpty Text)
- data AssistantAssociationData = AssistantAssociationData' {}
- newAssistantAssociationData :: Text -> Text -> Text -> Text -> AssistantAssociationOutputData -> AssociationType -> AssistantAssociationData
- assistantAssociationData_tags :: Lens' AssistantAssociationData (Maybe (HashMap Text Text))
- assistantAssociationData_assistantArn :: Lens' AssistantAssociationData Text
- assistantAssociationData_assistantAssociationArn :: Lens' AssistantAssociationData Text
- assistantAssociationData_assistantAssociationId :: Lens' AssistantAssociationData Text
- assistantAssociationData_assistantId :: Lens' AssistantAssociationData Text
- assistantAssociationData_associationData :: Lens' AssistantAssociationData AssistantAssociationOutputData
- assistantAssociationData_associationType :: Lens' AssistantAssociationData AssociationType
- data AssistantAssociationInputData = AssistantAssociationInputData' {}
- newAssistantAssociationInputData :: AssistantAssociationInputData
- assistantAssociationInputData_knowledgeBaseId :: Lens' AssistantAssociationInputData (Maybe Text)
- data AssistantAssociationOutputData = AssistantAssociationOutputData' {}
- newAssistantAssociationOutputData :: AssistantAssociationOutputData
- assistantAssociationOutputData_knowledgeBaseAssociation :: Lens' AssistantAssociationOutputData (Maybe KnowledgeBaseAssociationData)
- data AssistantAssociationSummary = AssistantAssociationSummary' {}
- newAssistantAssociationSummary :: Text -> Text -> Text -> Text -> AssistantAssociationOutputData -> AssociationType -> AssistantAssociationSummary
- assistantAssociationSummary_tags :: Lens' AssistantAssociationSummary (Maybe (HashMap Text Text))
- assistantAssociationSummary_assistantArn :: Lens' AssistantAssociationSummary Text
- assistantAssociationSummary_assistantAssociationArn :: Lens' AssistantAssociationSummary Text
- assistantAssociationSummary_assistantAssociationId :: Lens' AssistantAssociationSummary Text
- assistantAssociationSummary_assistantId :: Lens' AssistantAssociationSummary Text
- assistantAssociationSummary_associationData :: Lens' AssistantAssociationSummary AssistantAssociationOutputData
- assistantAssociationSummary_associationType :: Lens' AssistantAssociationSummary AssociationType
- data AssistantData = AssistantData' {}
- newAssistantData :: Text -> Text -> Text -> AssistantStatus -> AssistantType -> AssistantData
- assistantData_description :: Lens' AssistantData (Maybe Text)
- assistantData_serverSideEncryptionConfiguration :: Lens' AssistantData (Maybe ServerSideEncryptionConfiguration)
- assistantData_tags :: Lens' AssistantData (Maybe (HashMap Text Text))
- assistantData_assistantArn :: Lens' AssistantData Text
- assistantData_assistantId :: Lens' AssistantData Text
- assistantData_name :: Lens' AssistantData Text
- assistantData_status :: Lens' AssistantData AssistantStatus
- assistantData_type :: Lens' AssistantData AssistantType
- data AssistantSummary = AssistantSummary' {}
- newAssistantSummary :: Text -> Text -> Text -> AssistantStatus -> AssistantType -> AssistantSummary
- assistantSummary_description :: Lens' AssistantSummary (Maybe Text)
- assistantSummary_serverSideEncryptionConfiguration :: Lens' AssistantSummary (Maybe ServerSideEncryptionConfiguration)
- assistantSummary_tags :: Lens' AssistantSummary (Maybe (HashMap Text Text))
- assistantSummary_assistantArn :: Lens' AssistantSummary Text
- assistantSummary_assistantId :: Lens' AssistantSummary Text
- assistantSummary_name :: Lens' AssistantSummary Text
- assistantSummary_status :: Lens' AssistantSummary AssistantStatus
- assistantSummary_type :: Lens' AssistantSummary AssistantType
- data ContentData = ContentData' {
- linkOutUri :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- contentArn :: Text
- contentId :: Text
- contentType :: Text
- knowledgeBaseArn :: Text
- knowledgeBaseId :: Text
- metadata :: HashMap Text Text
- name :: Text
- revisionId :: Text
- status :: ContentStatus
- title :: Text
- url :: Sensitive Text
- urlExpiry :: POSIX
- newContentData :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> ContentStatus -> Text -> Text -> UTCTime -> ContentData
- contentData_linkOutUri :: Lens' ContentData (Maybe Text)
- contentData_tags :: Lens' ContentData (Maybe (HashMap Text Text))
- contentData_contentArn :: Lens' ContentData Text
- contentData_contentId :: Lens' ContentData Text
- contentData_contentType :: Lens' ContentData Text
- contentData_knowledgeBaseArn :: Lens' ContentData Text
- contentData_knowledgeBaseId :: Lens' ContentData Text
- contentData_metadata :: Lens' ContentData (HashMap Text Text)
- contentData_name :: Lens' ContentData Text
- contentData_revisionId :: Lens' ContentData Text
- contentData_status :: Lens' ContentData ContentStatus
- contentData_title :: Lens' ContentData Text
- contentData_url :: Lens' ContentData Text
- contentData_urlExpiry :: Lens' ContentData UTCTime
- data ContentReference = ContentReference' {}
- newContentReference :: ContentReference
- contentReference_contentArn :: Lens' ContentReference (Maybe Text)
- contentReference_contentId :: Lens' ContentReference (Maybe Text)
- contentReference_knowledgeBaseArn :: Lens' ContentReference (Maybe Text)
- contentReference_knowledgeBaseId :: Lens' ContentReference (Maybe Text)
- data ContentSummary = ContentSummary' {
- tags :: Maybe (HashMap Text Text)
- contentArn :: Text
- contentId :: Text
- contentType :: Text
- knowledgeBaseArn :: Text
- knowledgeBaseId :: Text
- metadata :: HashMap Text Text
- name :: Text
- revisionId :: Text
- status :: ContentStatus
- title :: Text
- newContentSummary :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> ContentStatus -> Text -> ContentSummary
- contentSummary_tags :: Lens' ContentSummary (Maybe (HashMap Text Text))
- contentSummary_contentArn :: Lens' ContentSummary Text
- contentSummary_contentId :: Lens' ContentSummary Text
- contentSummary_contentType :: Lens' ContentSummary Text
- contentSummary_knowledgeBaseArn :: Lens' ContentSummary Text
- contentSummary_knowledgeBaseId :: Lens' ContentSummary Text
- contentSummary_metadata :: Lens' ContentSummary (HashMap Text Text)
- contentSummary_name :: Lens' ContentSummary Text
- contentSummary_revisionId :: Lens' ContentSummary Text
- contentSummary_status :: Lens' ContentSummary ContentStatus
- contentSummary_title :: Lens' ContentSummary Text
- data Document = Document' {}
- newDocument :: ContentReference -> Document
- document_excerpt :: Lens' Document (Maybe DocumentText)
- document_title :: Lens' Document (Maybe DocumentText)
- document_contentReference :: Lens' Document ContentReference
- data DocumentText = DocumentText' {}
- newDocumentText :: DocumentText
- documentText_text :: Lens' DocumentText (Maybe Text)
- documentText_highlights :: Lens' DocumentText (Maybe [Highlight])
- data Filter = Filter' {
- field :: FilterField
- operator :: FilterOperator
- value :: Text
- newFilter :: FilterField -> FilterOperator -> Text -> Filter
- filter_field :: Lens' Filter FilterField
- filter_operator :: Lens' Filter FilterOperator
- filter_value :: Lens' Filter Text
- data Highlight = Highlight' {}
- newHighlight :: Highlight
- highlight_endOffsetExclusive :: Lens' Highlight (Maybe Int)
- highlight_beginOffsetInclusive :: Lens' Highlight (Maybe Int)
- data KnowledgeBaseAssociationData = KnowledgeBaseAssociationData' {}
- newKnowledgeBaseAssociationData :: KnowledgeBaseAssociationData
- knowledgeBaseAssociationData_knowledgeBaseArn :: Lens' KnowledgeBaseAssociationData (Maybe Text)
- knowledgeBaseAssociationData_knowledgeBaseId :: Lens' KnowledgeBaseAssociationData (Maybe Text)
- data KnowledgeBaseData = KnowledgeBaseData' {
- renderingConfiguration :: Maybe RenderingConfiguration
- sourceConfiguration :: Maybe SourceConfiguration
- lastContentModificationTime :: Maybe POSIX
- description :: Maybe Text
- serverSideEncryptionConfiguration :: Maybe ServerSideEncryptionConfiguration
- tags :: Maybe (HashMap Text Text)
- knowledgeBaseArn :: Text
- knowledgeBaseId :: Text
- knowledgeBaseType :: KnowledgeBaseType
- name :: Text
- status :: KnowledgeBaseStatus
- newKnowledgeBaseData :: Text -> Text -> KnowledgeBaseType -> Text -> KnowledgeBaseStatus -> KnowledgeBaseData
- knowledgeBaseData_renderingConfiguration :: Lens' KnowledgeBaseData (Maybe RenderingConfiguration)
- knowledgeBaseData_sourceConfiguration :: Lens' KnowledgeBaseData (Maybe SourceConfiguration)
- knowledgeBaseData_lastContentModificationTime :: Lens' KnowledgeBaseData (Maybe UTCTime)
- knowledgeBaseData_description :: Lens' KnowledgeBaseData (Maybe Text)
- knowledgeBaseData_serverSideEncryptionConfiguration :: Lens' KnowledgeBaseData (Maybe ServerSideEncryptionConfiguration)
- knowledgeBaseData_tags :: Lens' KnowledgeBaseData (Maybe (HashMap Text Text))
- knowledgeBaseData_knowledgeBaseArn :: Lens' KnowledgeBaseData Text
- knowledgeBaseData_knowledgeBaseId :: Lens' KnowledgeBaseData Text
- knowledgeBaseData_knowledgeBaseType :: Lens' KnowledgeBaseData KnowledgeBaseType
- knowledgeBaseData_name :: Lens' KnowledgeBaseData Text
- knowledgeBaseData_status :: Lens' KnowledgeBaseData KnowledgeBaseStatus
- data KnowledgeBaseSummary = KnowledgeBaseSummary' {
- renderingConfiguration :: Maybe RenderingConfiguration
- sourceConfiguration :: Maybe SourceConfiguration
- description :: Maybe Text
- serverSideEncryptionConfiguration :: Maybe ServerSideEncryptionConfiguration
- tags :: Maybe (HashMap Text Text)
- knowledgeBaseArn :: Text
- knowledgeBaseId :: Text
- knowledgeBaseType :: KnowledgeBaseType
- name :: Text
- status :: KnowledgeBaseStatus
- newKnowledgeBaseSummary :: Text -> Text -> KnowledgeBaseType -> Text -> KnowledgeBaseStatus -> KnowledgeBaseSummary
- knowledgeBaseSummary_renderingConfiguration :: Lens' KnowledgeBaseSummary (Maybe RenderingConfiguration)
- knowledgeBaseSummary_sourceConfiguration :: Lens' KnowledgeBaseSummary (Maybe SourceConfiguration)
- knowledgeBaseSummary_description :: Lens' KnowledgeBaseSummary (Maybe Text)
- knowledgeBaseSummary_serverSideEncryptionConfiguration :: Lens' KnowledgeBaseSummary (Maybe ServerSideEncryptionConfiguration)
- knowledgeBaseSummary_tags :: Lens' KnowledgeBaseSummary (Maybe (HashMap Text Text))
- knowledgeBaseSummary_knowledgeBaseArn :: Lens' KnowledgeBaseSummary Text
- knowledgeBaseSummary_knowledgeBaseId :: Lens' KnowledgeBaseSummary Text
- knowledgeBaseSummary_knowledgeBaseType :: Lens' KnowledgeBaseSummary KnowledgeBaseType
- knowledgeBaseSummary_name :: Lens' KnowledgeBaseSummary Text
- knowledgeBaseSummary_status :: Lens' KnowledgeBaseSummary KnowledgeBaseStatus
- data NotifyRecommendationsReceivedError = NotifyRecommendationsReceivedError' {}
- newNotifyRecommendationsReceivedError :: NotifyRecommendationsReceivedError
- notifyRecommendationsReceivedError_recommendationId :: Lens' NotifyRecommendationsReceivedError (Maybe Text)
- notifyRecommendationsReceivedError_message :: Lens' NotifyRecommendationsReceivedError (Maybe Text)
- data RecommendationData = RecommendationData' {}
- newRecommendationData :: Document -> Text -> RecommendationData
- recommendationData_relevanceLevel :: Lens' RecommendationData (Maybe RelevanceLevel)
- recommendationData_relevanceScore :: Lens' RecommendationData (Maybe Double)
- recommendationData_document :: Lens' RecommendationData Document
- recommendationData_recommendationId :: Lens' RecommendationData Text
- data RenderingConfiguration = RenderingConfiguration' {
- templateUri :: Maybe Text
- newRenderingConfiguration :: RenderingConfiguration
- renderingConfiguration_templateUri :: Lens' RenderingConfiguration (Maybe Text)
- data ResultData = ResultData' {}
- newResultData :: Document -> Text -> ResultData
- resultData_relevanceScore :: Lens' ResultData (Maybe Double)
- resultData_document :: Lens' ResultData Document
- resultData_resultId :: Lens' ResultData Text
- data SearchExpression = SearchExpression' {}
- newSearchExpression :: SearchExpression
- searchExpression_filters :: Lens' SearchExpression [Filter]
- data ServerSideEncryptionConfiguration = ServerSideEncryptionConfiguration' {}
- newServerSideEncryptionConfiguration :: ServerSideEncryptionConfiguration
- serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration (Maybe Text)
- data SessionData = SessionData' {}
- newSessionData :: Text -> Text -> Text -> SessionData
- sessionData_description :: Lens' SessionData (Maybe Text)
- sessionData_tags :: Lens' SessionData (Maybe (HashMap Text Text))
- sessionData_name :: Lens' SessionData Text
- sessionData_sessionArn :: Lens' SessionData Text
- sessionData_sessionId :: Lens' SessionData Text
- data SessionSummary = SessionSummary' {
- assistantArn :: Text
- assistantId :: Text
- sessionArn :: Text
- sessionId :: Text
- newSessionSummary :: Text -> Text -> Text -> Text -> SessionSummary
- sessionSummary_assistantArn :: Lens' SessionSummary Text
- sessionSummary_assistantId :: Lens' SessionSummary Text
- sessionSummary_sessionArn :: Lens' SessionSummary Text
- sessionSummary_sessionId :: Lens' SessionSummary Text
- data SourceConfiguration = SourceConfiguration' {}
- newSourceConfiguration :: SourceConfiguration
- sourceConfiguration_appIntegrations :: Lens' SourceConfiguration (Maybe AppIntegrationsConfiguration)
Service Configuration
defaultService :: Service Source #
API version 2020-10-19 of the Amazon Connect Wisdom Service SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
_PreconditionFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The provided revisionId does not match, indicating the content has
been modified since it was last read.
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request could not be processed because of conflict in the current
state of the resource. For example, if you're using a Create API
(such as CreateAssistant) that accepts name, a conflicting resource
(usually with the same name) is being created or mutated.
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource does not exist.
AssistantStatus
newtype AssistantStatus Source #
Constructors
| AssistantStatus' | |
Fields | |
Bundled Patterns
| pattern AssistantStatus_ACTIVE :: AssistantStatus | |
| pattern AssistantStatus_CREATE_FAILED :: AssistantStatus | |
| pattern AssistantStatus_CREATE_IN_PROGRESS :: AssistantStatus | |
| pattern AssistantStatus_DELETED :: AssistantStatus | |
| pattern AssistantStatus_DELETE_FAILED :: AssistantStatus | |
| pattern AssistantStatus_DELETE_IN_PROGRESS :: AssistantStatus |
Instances
AssistantType
newtype AssistantType Source #
Constructors
| AssistantType' | |
Fields | |
Bundled Patterns
| pattern AssistantType_AGENT :: AssistantType |
Instances
AssociationType
newtype AssociationType Source #
Constructors
| AssociationType' | |
Fields | |
Bundled Patterns
| pattern AssociationType_KNOWLEDGE_BASE :: AssociationType |
Instances
ContentStatus
newtype ContentStatus Source #
Constructors
| ContentStatus' | |
Fields | |
Bundled Patterns
| pattern ContentStatus_ACTIVE :: ContentStatus | |
| pattern ContentStatus_CREATE_FAILED :: ContentStatus | |
| pattern ContentStatus_CREATE_IN_PROGRESS :: ContentStatus | |
| pattern ContentStatus_DELETED :: ContentStatus | |
| pattern ContentStatus_DELETE_FAILED :: ContentStatus | |
| pattern ContentStatus_DELETE_IN_PROGRESS :: ContentStatus | |
| pattern ContentStatus_UPDATE_FAILED :: ContentStatus |
Instances
FilterField
newtype FilterField Source #
Constructors
| FilterField' | |
Fields | |
Bundled Patterns
| pattern FilterField_NAME :: FilterField |
Instances
FilterOperator
newtype FilterOperator Source #
Constructors
| FilterOperator' | |
Fields | |
Bundled Patterns
| pattern FilterOperator_EQUALS :: FilterOperator |
Instances
KnowledgeBaseStatus
newtype KnowledgeBaseStatus Source #
Constructors
| KnowledgeBaseStatus' | |
Fields | |
Bundled Patterns
Instances
KnowledgeBaseType
newtype KnowledgeBaseType Source #
Constructors
| KnowledgeBaseType' | |
Fields | |
Bundled Patterns
| pattern KnowledgeBaseType_CUSTOM :: KnowledgeBaseType | |
| pattern KnowledgeBaseType_EXTERNAL :: KnowledgeBaseType |
Instances
RelevanceLevel
newtype RelevanceLevel Source #
Constructors
| RelevanceLevel' | |
Fields | |
Bundled Patterns
| pattern RelevanceLevel_HIGH :: RelevanceLevel | |
| pattern RelevanceLevel_LOW :: RelevanceLevel | |
| pattern RelevanceLevel_MEDIUM :: RelevanceLevel |
Instances
AppIntegrationsConfiguration
data AppIntegrationsConfiguration Source #
Configuration information for Amazon AppIntegrations to automatically ingest content.
See: newAppIntegrationsConfiguration smart constructor.
Constructors
| AppIntegrationsConfiguration' | |
Fields
| |
Instances
newAppIntegrationsConfiguration Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> AppIntegrationsConfiguration |
Create a value of AppIntegrationsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appIntegrationArn:AppIntegrationsConfiguration', appIntegrationsConfiguration_appIntegrationArn - The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to
use for ingesting content.
$sel:objectFields:AppIntegrationsConfiguration', appIntegrationsConfiguration_objectFields - The fields from the source that are made available to your agents in
Wisdom.
- For
Salesforce,
you must include at least
Id,ArticleNumber,VersionNumber,Title,PublishStatus, andIsDeleted. - For
ServiceNow,
you must include at least
number,short_description,sys_mod_count,workflow_state, andactive.
Make sure to include additional field(s); these are indexed and used to source recommendations.
appIntegrationsConfiguration_appIntegrationArn :: Lens' AppIntegrationsConfiguration Text Source #
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
appIntegrationsConfiguration_objectFields :: Lens' AppIntegrationsConfiguration (NonEmpty Text) Source #
The fields from the source that are made available to your agents in Wisdom.
- For
Salesforce,
you must include at least
Id,ArticleNumber,VersionNumber,Title,PublishStatus, andIsDeleted. - For
ServiceNow,
you must include at least
number,short_description,sys_mod_count,workflow_state, andactive.
Make sure to include additional field(s); these are indexed and used to source recommendations.
AssistantAssociationData
data AssistantAssociationData Source #
Information about the assistant association.
See: newAssistantAssociationData smart constructor.
Constructors
| AssistantAssociationData' | |
Fields
| |
Instances
newAssistantAssociationData Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> AssistantAssociationOutputData | |
| -> AssociationType | |
| -> AssistantAssociationData |
Create a value of AssistantAssociationData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:AssistantAssociationData', assistantAssociationData_tags - The tags used to organize, track, or control access for this resource.
$sel:assistantArn:AssistantAssociationData', assistantAssociationData_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant
$sel:assistantAssociationArn:AssistantAssociationData', assistantAssociationData_assistantAssociationArn - The Amazon Resource Name (ARN) of the assistant association.
$sel:assistantAssociationId:AssistantAssociationData', assistantAssociationData_assistantAssociationId - The identifier of the assistant association.
$sel:assistantId:AssistantAssociationData', assistantAssociationData_assistantId - The identifier of the Wisdom assistant.
$sel:associationData:AssistantAssociationData', assistantAssociationData_associationData - A union type that currently has a single argument, the knowledge base
ID.
$sel:associationType:AssistantAssociationData', assistantAssociationData_associationType - The type of association.
assistantAssociationData_tags :: Lens' AssistantAssociationData (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
assistantAssociationData_assistantArn :: Lens' AssistantAssociationData Text Source #
The Amazon Resource Name (ARN) of the Wisdom assistant
assistantAssociationData_assistantAssociationArn :: Lens' AssistantAssociationData Text Source #
The Amazon Resource Name (ARN) of the assistant association.
assistantAssociationData_assistantAssociationId :: Lens' AssistantAssociationData Text Source #
The identifier of the assistant association.
assistantAssociationData_assistantId :: Lens' AssistantAssociationData Text Source #
The identifier of the Wisdom assistant.
assistantAssociationData_associationData :: Lens' AssistantAssociationData AssistantAssociationOutputData Source #
A union type that currently has a single argument, the knowledge base ID.
assistantAssociationData_associationType :: Lens' AssistantAssociationData AssociationType Source #
The type of association.
AssistantAssociationInputData
data AssistantAssociationInputData Source #
The data that is input into Wisdom as a result of the assistant association.
See: newAssistantAssociationInputData smart constructor.
Constructors
| AssistantAssociationInputData' | |
Fields
| |
Instances
newAssistantAssociationInputData :: AssistantAssociationInputData Source #
Create a value of AssistantAssociationInputData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:knowledgeBaseId:AssistantAssociationInputData', assistantAssociationInputData_knowledgeBaseId - The the identifier of the knowledge base.
assistantAssociationInputData_knowledgeBaseId :: Lens' AssistantAssociationInputData (Maybe Text) Source #
The the identifier of the knowledge base.
AssistantAssociationOutputData
data AssistantAssociationOutputData Source #
The data that is output as a result of the assistant association.
See: newAssistantAssociationOutputData smart constructor.
Constructors
| AssistantAssociationOutputData' | |
Fields
| |
Instances
newAssistantAssociationOutputData :: AssistantAssociationOutputData Source #
Create a value of AssistantAssociationOutputData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:knowledgeBaseAssociation:AssistantAssociationOutputData', assistantAssociationOutputData_knowledgeBaseAssociation - The knowledge base where output data is sent.
assistantAssociationOutputData_knowledgeBaseAssociation :: Lens' AssistantAssociationOutputData (Maybe KnowledgeBaseAssociationData) Source #
The knowledge base where output data is sent.
AssistantAssociationSummary
data AssistantAssociationSummary Source #
Summary information about the assistant association.
See: newAssistantAssociationSummary smart constructor.
Constructors
| AssistantAssociationSummary' | |
Fields
| |
Instances
newAssistantAssociationSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> AssistantAssociationOutputData | |
| -> AssociationType | |
| -> AssistantAssociationSummary |
Create a value of AssistantAssociationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:AssistantAssociationSummary', assistantAssociationSummary_tags - The tags used to organize, track, or control access for this resource.
$sel:assistantArn:AssistantAssociationSummary', assistantAssociationSummary_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant
$sel:assistantAssociationArn:AssistantAssociationSummary', assistantAssociationSummary_assistantAssociationArn - The Amazon Resource Name (ARN) of the assistant association.
$sel:assistantAssociationId:AssistantAssociationSummary', assistantAssociationSummary_assistantAssociationId - The identifier of the assistant association.
$sel:assistantId:AssistantAssociationSummary', assistantAssociationSummary_assistantId - The identifier of the Wisdom assistant.
$sel:associationData:AssistantAssociationSummary', assistantAssociationSummary_associationData - The association data.
$sel:associationType:AssistantAssociationSummary', assistantAssociationSummary_associationType - The type of association.
assistantAssociationSummary_tags :: Lens' AssistantAssociationSummary (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
assistantAssociationSummary_assistantArn :: Lens' AssistantAssociationSummary Text Source #
The Amazon Resource Name (ARN) of the Wisdom assistant
assistantAssociationSummary_assistantAssociationArn :: Lens' AssistantAssociationSummary Text Source #
The Amazon Resource Name (ARN) of the assistant association.
assistantAssociationSummary_assistantAssociationId :: Lens' AssistantAssociationSummary Text Source #
The identifier of the assistant association.
assistantAssociationSummary_assistantId :: Lens' AssistantAssociationSummary Text Source #
The identifier of the Wisdom assistant.
assistantAssociationSummary_associationData :: Lens' AssistantAssociationSummary AssistantAssociationOutputData Source #
The association data.
assistantAssociationSummary_associationType :: Lens' AssistantAssociationSummary AssociationType Source #
The type of association.
AssistantData
data AssistantData Source #
The assistant data.
See: newAssistantData smart constructor.
Constructors
| AssistantData' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssistantStatus | |
| -> AssistantType | |
| -> AssistantData |
Create a value of AssistantData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:AssistantData', assistantData_description - The description.
$sel:serverSideEncryptionConfiguration:AssistantData', assistantData_serverSideEncryptionConfiguration - The KMS key used for encryption.
$sel:tags:AssistantData', assistantData_tags - The tags used to organize, track, or control access for this resource.
$sel:assistantArn:AssistantData', assistantData_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant
$sel:assistantId:AssistantData', assistantData_assistantId - The identifier of the Wisdom assistant.
$sel:name:AssistantData', assistantData_name - The name.
$sel:status:AssistantData', assistantData_status - The status of the assistant.
$sel:type':AssistantData', assistantData_type - The type of assistant.
assistantData_description :: Lens' AssistantData (Maybe Text) Source #
The description.
assistantData_serverSideEncryptionConfiguration :: Lens' AssistantData (Maybe ServerSideEncryptionConfiguration) Source #
The KMS key used for encryption.
assistantData_tags :: Lens' AssistantData (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
assistantData_assistantArn :: Lens' AssistantData Text Source #
The Amazon Resource Name (ARN) of the Wisdom assistant
assistantData_assistantId :: Lens' AssistantData Text Source #
The identifier of the Wisdom assistant.
assistantData_name :: Lens' AssistantData Text Source #
The name.
assistantData_status :: Lens' AssistantData AssistantStatus Source #
The status of the assistant.
assistantData_type :: Lens' AssistantData AssistantType Source #
The type of assistant.
AssistantSummary
data AssistantSummary Source #
Summary information about the assistant.
See: newAssistantSummary smart constructor.
Constructors
| AssistantSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssistantStatus | |
| -> AssistantType | |
| -> AssistantSummary |
Create a value of AssistantSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:AssistantSummary', assistantSummary_description - The description of the assistant.
$sel:serverSideEncryptionConfiguration:AssistantSummary', assistantSummary_serverSideEncryptionConfiguration - The KMS key used for encryption.
$sel:tags:AssistantSummary', assistantSummary_tags - The tags used to organize, track, or control access for this resource.
$sel:assistantArn:AssistantSummary', assistantSummary_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant
$sel:assistantId:AssistantSummary', assistantSummary_assistantId - The identifier of the Wisdom assistant.
$sel:name:AssistantSummary', assistantSummary_name - The name of the assistant.
$sel:status:AssistantSummary', assistantSummary_status - The status of the assistant.
$sel:type':AssistantSummary', assistantSummary_type - The type of the assistant.
assistantSummary_description :: Lens' AssistantSummary (Maybe Text) Source #
The description of the assistant.
assistantSummary_serverSideEncryptionConfiguration :: Lens' AssistantSummary (Maybe ServerSideEncryptionConfiguration) Source #
The KMS key used for encryption.
assistantSummary_tags :: Lens' AssistantSummary (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
assistantSummary_assistantArn :: Lens' AssistantSummary Text Source #
The Amazon Resource Name (ARN) of the Wisdom assistant
assistantSummary_assistantId :: Lens' AssistantSummary Text Source #
The identifier of the Wisdom assistant.
assistantSummary_name :: Lens' AssistantSummary Text Source #
The name of the assistant.
assistantSummary_status :: Lens' AssistantSummary AssistantStatus Source #
The status of the assistant.
assistantSummary_type :: Lens' AssistantSummary AssistantType Source #
The type of the assistant.
ContentData
data ContentData Source #
Information about the content.
See: newContentData smart constructor.
Constructors
| ContentData' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ContentStatus | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> ContentData |
Create a value of ContentData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:linkOutUri:ContentData', contentData_linkOutUri - The URI of the content.
$sel:tags:ContentData', contentData_tags - The tags used to organize, track, or control access for this resource.
$sel:contentArn:ContentData', contentData_contentArn - The Amazon Resource Name (ARN) of the content.
$sel:contentId:ContentData', contentData_contentId - The identifier of the content.
$sel:contentType:ContentData', contentData_contentType - The media type of the content.
$sel:knowledgeBaseArn:ContentData', contentData_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
$sel:knowledgeBaseId:ContentData', contentData_knowledgeBaseId - The the identifier of the knowledge base.
$sel:metadata:ContentData', contentData_metadata - A key/value map to store attributes without affecting tagging or
recommendations. For example, when synchronizing data between an
external system and Wisdom, you can store an external version identifier
as metadata to utilize for determining drift.
$sel:name:ContentData', contentData_name - The name of the content.
$sel:revisionId:ContentData', contentData_revisionId - The identifier of the content revision.
$sel:status:ContentData', contentData_status - The status of the content.
$sel:title:ContentData', contentData_title - The title of the content.
$sel:url:ContentData', contentData_url - The URL of the content.
$sel:urlExpiry:ContentData', contentData_urlExpiry - The expiration time of the URL as an epoch timestamp.
contentData_linkOutUri :: Lens' ContentData (Maybe Text) Source #
The URI of the content.
contentData_tags :: Lens' ContentData (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
contentData_contentArn :: Lens' ContentData Text Source #
The Amazon Resource Name (ARN) of the content.
contentData_contentId :: Lens' ContentData Text Source #
The identifier of the content.
contentData_contentType :: Lens' ContentData Text Source #
The media type of the content.
contentData_knowledgeBaseArn :: Lens' ContentData Text Source #
The Amazon Resource Name (ARN) of the knowledge base.
contentData_knowledgeBaseId :: Lens' ContentData Text Source #
The the identifier of the knowledge base.
contentData_metadata :: Lens' ContentData (HashMap Text Text) Source #
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
contentData_name :: Lens' ContentData Text Source #
The name of the content.
contentData_revisionId :: Lens' ContentData Text Source #
The identifier of the content revision.
contentData_status :: Lens' ContentData ContentStatus Source #
The status of the content.
contentData_title :: Lens' ContentData Text Source #
The title of the content.
contentData_url :: Lens' ContentData Text Source #
The URL of the content.
contentData_urlExpiry :: Lens' ContentData UTCTime Source #
The expiration time of the URL as an epoch timestamp.
ContentReference
data ContentReference Source #
Reference information about the content.
See: newContentReference smart constructor.
Constructors
| ContentReference' | |
Fields
| |
Instances
newContentReference :: ContentReference Source #
Create a value of ContentReference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentArn:ContentReference', contentReference_contentArn - The Amazon Resource Name (ARN) of the content.
$sel:contentId:ContentReference', contentReference_contentId - The identifier of the content.
$sel:knowledgeBaseArn:ContentReference', contentReference_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
$sel:knowledgeBaseId:ContentReference', contentReference_knowledgeBaseId - The the identifier of the knowledge base.
contentReference_contentArn :: Lens' ContentReference (Maybe Text) Source #
The Amazon Resource Name (ARN) of the content.
contentReference_contentId :: Lens' ContentReference (Maybe Text) Source #
The identifier of the content.
contentReference_knowledgeBaseArn :: Lens' ContentReference (Maybe Text) Source #
The Amazon Resource Name (ARN) of the knowledge base.
contentReference_knowledgeBaseId :: Lens' ContentReference (Maybe Text) Source #
The the identifier of the knowledge base.
ContentSummary
data ContentSummary Source #
Summary information about the content.
See: newContentSummary smart constructor.
Constructors
| ContentSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ContentStatus | |
| -> Text | |
| -> ContentSummary |
Create a value of ContentSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ContentSummary', contentSummary_tags - The tags used to organize, track, or control access for this resource.
$sel:contentArn:ContentSummary', contentSummary_contentArn - The Amazon Resource Name (ARN) of the content.
$sel:contentId:ContentSummary', contentSummary_contentId - The identifier of the content.
$sel:contentType:ContentSummary', contentSummary_contentType - The media type of the content.
$sel:knowledgeBaseArn:ContentSummary', contentSummary_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
$sel:knowledgeBaseId:ContentSummary', contentSummary_knowledgeBaseId - The the identifier of the knowledge base.
$sel:metadata:ContentSummary', contentSummary_metadata - A key/value map to store attributes without affecting tagging or
recommendations. For example, when synchronizing data between an
external system and Wisdom, you can store an external version identifier
as metadata to utilize for determining drift.
$sel:name:ContentSummary', contentSummary_name - The name of the content.
$sel:revisionId:ContentSummary', contentSummary_revisionId - The identifier of the revision of the content.
$sel:status:ContentSummary', contentSummary_status - The status of the content.
$sel:title:ContentSummary', contentSummary_title - The title of the content.
contentSummary_tags :: Lens' ContentSummary (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
contentSummary_contentArn :: Lens' ContentSummary Text Source #
The Amazon Resource Name (ARN) of the content.
contentSummary_contentId :: Lens' ContentSummary Text Source #
The identifier of the content.
contentSummary_contentType :: Lens' ContentSummary Text Source #
The media type of the content.
contentSummary_knowledgeBaseArn :: Lens' ContentSummary Text Source #
The Amazon Resource Name (ARN) of the knowledge base.
contentSummary_knowledgeBaseId :: Lens' ContentSummary Text Source #
The the identifier of the knowledge base.
contentSummary_metadata :: Lens' ContentSummary (HashMap Text Text) Source #
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
contentSummary_name :: Lens' ContentSummary Text Source #
The name of the content.
contentSummary_revisionId :: Lens' ContentSummary Text Source #
The identifier of the revision of the content.
contentSummary_status :: Lens' ContentSummary ContentStatus Source #
The status of the content.
contentSummary_title :: Lens' ContentSummary Text Source #
The title of the content.
Document
The document.
See: newDocument smart constructor.
Constructors
| Document' | |
Fields
| |
Instances
| Eq Document Source # | |
| Show Document Source # | |
| Generic Document Source # | |
| NFData Document Source # | |
Defined in Amazonka.Wisdom.Types.Document | |
| Hashable Document Source # | |
Defined in Amazonka.Wisdom.Types.Document | |
| FromJSON Document Source # | |
| type Rep Document Source # | |
Defined in Amazonka.Wisdom.Types.Document type Rep Document = D1 ('MetaData "Document" "Amazonka.Wisdom.Types.Document" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "Document'" 'PrefixI 'True) (S1 ('MetaSel ('Just "excerpt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentText)) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentText)) :*: S1 ('MetaSel ('Just "contentReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContentReference)))) | |
Arguments
| :: ContentReference | |
| -> 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:excerpt:Document', document_excerpt - The excerpt from the document.
$sel:title:Document', document_title - The title of the document.
$sel:contentReference:Document', document_contentReference - A reference to the content resource.
document_excerpt :: Lens' Document (Maybe DocumentText) Source #
The excerpt from the document.
document_title :: Lens' Document (Maybe DocumentText) Source #
The title of the document.
document_contentReference :: Lens' Document ContentReference Source #
A reference to the content resource.
DocumentText
data DocumentText Source #
The text of the document.
See: newDocumentText smart constructor.
Constructors
| DocumentText' | |
Instances
newDocumentText :: DocumentText Source #
Create a value of DocumentText with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DocumentText', documentText_text - Text in the document.
$sel:highlights:DocumentText', documentText_highlights - Highlights in the document text.
documentText_text :: Lens' DocumentText (Maybe Text) Source #
Text in the document.
documentText_highlights :: Lens' DocumentText (Maybe [Highlight]) Source #
Highlights in the document text.
Filter
A search filter.
See: newFilter smart constructor.
Constructors
| Filter' | |
Fields
| |
Instances
| Eq Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| Generic Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.Wisdom.Types.Filter | |
| Hashable Filter Source # | |
Defined in Amazonka.Wisdom.Types.Filter | |
| ToJSON Filter Source # | |
Defined in Amazonka.Wisdom.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.Wisdom.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.Wisdom.Types.Filter" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "field") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterField) :*: (S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterOperator) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Arguments
| :: FilterField | |
| -> FilterOperator | |
| -> Text | |
| -> Filter |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:field:Filter', filter_field - The field on which to filter.
$sel:operator:Filter', filter_operator - The operator to use for comparing the field’s value with the provided
value.
$sel:value:Filter', filter_value - The desired field value on which to filter.
filter_field :: Lens' Filter FilterField Source #
The field on which to filter.
filter_operator :: Lens' Filter FilterOperator Source #
The operator to use for comparing the field’s value with the provided value.
Highlight
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
See: newHighlight smart constructor.
Constructors
| Highlight' | |
Fields
| |
Instances
| Eq Highlight Source # | |
| Read Highlight Source # | |
| Show Highlight Source # | |
| Generic Highlight Source # | |
| NFData Highlight Source # | |
Defined in Amazonka.Wisdom.Types.Highlight | |
| Hashable Highlight Source # | |
Defined in Amazonka.Wisdom.Types.Highlight | |
| FromJSON Highlight Source # | |
| type Rep Highlight Source # | |
Defined in Amazonka.Wisdom.Types.Highlight type Rep Highlight = D1 ('MetaData "Highlight" "Amazonka.Wisdom.Types.Highlight" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "Highlight'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endOffsetExclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "beginOffsetInclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) | |
newHighlight :: Highlight Source #
Create a value of Highlight with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endOffsetExclusive:Highlight', highlight_endOffsetExclusive - The offset for the end of the highlight.
$sel:beginOffsetInclusive:Highlight', highlight_beginOffsetInclusive - The offset for the start of the highlight.
highlight_endOffsetExclusive :: Lens' Highlight (Maybe Int) Source #
The offset for the end of the highlight.
highlight_beginOffsetInclusive :: Lens' Highlight (Maybe Int) Source #
The offset for the start of the highlight.
KnowledgeBaseAssociationData
data KnowledgeBaseAssociationData Source #
Association information about the knowledge base.
See: newKnowledgeBaseAssociationData smart constructor.
Constructors
| KnowledgeBaseAssociationData' | |
Fields
| |
Instances
newKnowledgeBaseAssociationData :: KnowledgeBaseAssociationData Source #
Create a value of KnowledgeBaseAssociationData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:knowledgeBaseArn:KnowledgeBaseAssociationData', knowledgeBaseAssociationData_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
$sel:knowledgeBaseId:KnowledgeBaseAssociationData', knowledgeBaseAssociationData_knowledgeBaseId - The the identifier of the knowledge base.
knowledgeBaseAssociationData_knowledgeBaseArn :: Lens' KnowledgeBaseAssociationData (Maybe Text) Source #
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseAssociationData_knowledgeBaseId :: Lens' KnowledgeBaseAssociationData (Maybe Text) Source #
The the identifier of the knowledge base.
KnowledgeBaseData
data KnowledgeBaseData Source #
Information about the knowledge base.
See: newKnowledgeBaseData smart constructor.
Constructors
| KnowledgeBaseData' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> KnowledgeBaseType | |
| -> Text | |
| -> KnowledgeBaseStatus | |
| -> KnowledgeBaseData |
Create a value of KnowledgeBaseData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:renderingConfiguration:KnowledgeBaseData', knowledgeBaseData_renderingConfiguration - Information about how to render the content.
$sel:sourceConfiguration:KnowledgeBaseData', knowledgeBaseData_sourceConfiguration - Source configuration information about the knowledge base.
$sel:lastContentModificationTime:KnowledgeBaseData', knowledgeBaseData_lastContentModificationTime - An epoch timestamp indicating the most recent content modification
inside the knowledge base. If no content exists in a knowledge base,
this value is unset.
$sel:description:KnowledgeBaseData', knowledgeBaseData_description - The description.
$sel:serverSideEncryptionConfiguration:KnowledgeBaseData', knowledgeBaseData_serverSideEncryptionConfiguration - The KMS key used for encryption.
$sel:tags:KnowledgeBaseData', knowledgeBaseData_tags - The tags used to organize, track, or control access for this resource.
$sel:knowledgeBaseArn:KnowledgeBaseData', knowledgeBaseData_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
$sel:knowledgeBaseId:KnowledgeBaseData', knowledgeBaseData_knowledgeBaseId - The the identifier of the knowledge base.
$sel:knowledgeBaseType:KnowledgeBaseData', knowledgeBaseData_knowledgeBaseType - The type of knowledge base.
$sel:name:KnowledgeBaseData', knowledgeBaseData_name - The name of the knowledge base.
$sel:status:KnowledgeBaseData', knowledgeBaseData_status - The status of the knowledge base.
knowledgeBaseData_renderingConfiguration :: Lens' KnowledgeBaseData (Maybe RenderingConfiguration) Source #
Information about how to render the content.
knowledgeBaseData_sourceConfiguration :: Lens' KnowledgeBaseData (Maybe SourceConfiguration) Source #
Source configuration information about the knowledge base.
knowledgeBaseData_lastContentModificationTime :: Lens' KnowledgeBaseData (Maybe UTCTime) Source #
An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
knowledgeBaseData_description :: Lens' KnowledgeBaseData (Maybe Text) Source #
The description.
knowledgeBaseData_serverSideEncryptionConfiguration :: Lens' KnowledgeBaseData (Maybe ServerSideEncryptionConfiguration) Source #
The KMS key used for encryption.
knowledgeBaseData_tags :: Lens' KnowledgeBaseData (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
knowledgeBaseData_knowledgeBaseArn :: Lens' KnowledgeBaseData Text Source #
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseData_knowledgeBaseId :: Lens' KnowledgeBaseData Text Source #
The the identifier of the knowledge base.
knowledgeBaseData_knowledgeBaseType :: Lens' KnowledgeBaseData KnowledgeBaseType Source #
The type of knowledge base.
knowledgeBaseData_name :: Lens' KnowledgeBaseData Text Source #
The name of the knowledge base.
knowledgeBaseData_status :: Lens' KnowledgeBaseData KnowledgeBaseStatus Source #
The status of the knowledge base.
KnowledgeBaseSummary
data KnowledgeBaseSummary Source #
Summary information about the knowledge base.
See: newKnowledgeBaseSummary smart constructor.
Constructors
| KnowledgeBaseSummary' | |
Fields
| |
Instances
newKnowledgeBaseSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> KnowledgeBaseType | |
| -> Text | |
| -> KnowledgeBaseStatus | |
| -> KnowledgeBaseSummary |
Create a value of KnowledgeBaseSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:renderingConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_renderingConfiguration - Information about how to render the content.
$sel:sourceConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_sourceConfiguration - [KEVIN]
$sel:description:KnowledgeBaseSummary', knowledgeBaseSummary_description - The description of the knowledge base.
$sel:serverSideEncryptionConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_serverSideEncryptionConfiguration - The KMS key used for encryption.
$sel:tags:KnowledgeBaseSummary', knowledgeBaseSummary_tags - The tags used to organize, track, or control access for this resource.
$sel:knowledgeBaseArn:KnowledgeBaseSummary', knowledgeBaseSummary_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
$sel:knowledgeBaseId:KnowledgeBaseSummary', knowledgeBaseSummary_knowledgeBaseId - The the identifier of the knowledge base.
$sel:knowledgeBaseType:KnowledgeBaseSummary', knowledgeBaseSummary_knowledgeBaseType - The type of knowledge base.
$sel:name:KnowledgeBaseSummary', knowledgeBaseSummary_name - The name of the knowledge base.
$sel:status:KnowledgeBaseSummary', knowledgeBaseSummary_status - The status of the knowledge base summary.
knowledgeBaseSummary_renderingConfiguration :: Lens' KnowledgeBaseSummary (Maybe RenderingConfiguration) Source #
Information about how to render the content.
knowledgeBaseSummary_sourceConfiguration :: Lens' KnowledgeBaseSummary (Maybe SourceConfiguration) Source #
- KEVIN
knowledgeBaseSummary_description :: Lens' KnowledgeBaseSummary (Maybe Text) Source #
The description of the knowledge base.
knowledgeBaseSummary_serverSideEncryptionConfiguration :: Lens' KnowledgeBaseSummary (Maybe ServerSideEncryptionConfiguration) Source #
The KMS key used for encryption.
knowledgeBaseSummary_tags :: Lens' KnowledgeBaseSummary (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
knowledgeBaseSummary_knowledgeBaseArn :: Lens' KnowledgeBaseSummary Text Source #
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseSummary_knowledgeBaseId :: Lens' KnowledgeBaseSummary Text Source #
The the identifier of the knowledge base.
knowledgeBaseSummary_knowledgeBaseType :: Lens' KnowledgeBaseSummary KnowledgeBaseType Source #
The type of knowledge base.
knowledgeBaseSummary_name :: Lens' KnowledgeBaseSummary Text Source #
The name of the knowledge base.
knowledgeBaseSummary_status :: Lens' KnowledgeBaseSummary KnowledgeBaseStatus Source #
The status of the knowledge base summary.
NotifyRecommendationsReceivedError
data NotifyRecommendationsReceivedError Source #
An error occurred when creating a recommendation.
See: newNotifyRecommendationsReceivedError smart constructor.
Constructors
| NotifyRecommendationsReceivedError' | |
Instances
newNotifyRecommendationsReceivedError :: NotifyRecommendationsReceivedError Source #
Create a value of NotifyRecommendationsReceivedError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recommendationId:NotifyRecommendationsReceivedError', notifyRecommendationsReceivedError_recommendationId - The identifier of the recommendation that is in error.
$sel:message:NotifyRecommendationsReceivedError', notifyRecommendationsReceivedError_message - A recommendation is causing an error.
notifyRecommendationsReceivedError_recommendationId :: Lens' NotifyRecommendationsReceivedError (Maybe Text) Source #
The identifier of the recommendation that is in error.
notifyRecommendationsReceivedError_message :: Lens' NotifyRecommendationsReceivedError (Maybe Text) Source #
A recommendation is causing an error.
RecommendationData
data RecommendationData Source #
Information about the recommendation.
See: newRecommendationData smart constructor.
Constructors
| RecommendationData' | |
Fields
| |
Instances
newRecommendationData Source #
Arguments
| :: Document | |
| -> Text | |
| -> RecommendationData |
Create a value of RecommendationData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relevanceLevel:RecommendationData', recommendationData_relevanceLevel - The relevance level of the recommendation.
$sel:relevanceScore:RecommendationData', recommendationData_relevanceScore - The relevance score of the recommendation.
$sel:document:RecommendationData', recommendationData_document - The recommended document.
$sel:recommendationId:RecommendationData', recommendationData_recommendationId - The identifier of the recommendation.
recommendationData_relevanceLevel :: Lens' RecommendationData (Maybe RelevanceLevel) Source #
The relevance level of the recommendation.
recommendationData_relevanceScore :: Lens' RecommendationData (Maybe Double) Source #
The relevance score of the recommendation.
recommendationData_document :: Lens' RecommendationData Document Source #
The recommended document.
recommendationData_recommendationId :: Lens' RecommendationData Text Source #
The identifier of the recommendation.
RenderingConfiguration
data RenderingConfiguration Source #
Information about how to render the content.
See: newRenderingConfiguration smart constructor.
Constructors
| RenderingConfiguration' | |
Fields
| |
Instances
newRenderingConfiguration :: RenderingConfiguration Source #
Create a value of RenderingConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:templateUri:RenderingConfiguration', renderingConfiguration_templateUri - A URI template containing exactly one variable in
${variableName} format. This can only be set for EXTERNAL knowledge
bases. For Salesforce and ServiceNow, the variable must be one of the
following:
- Salesforce:
Id,ArticleNumber,VersionNumber,Title,PublishStatus, orIsDeleted - ServiceNow:
number,short_description,sys_mod_count,workflow_state, oractive
<p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
renderingConfiguration_templateUri :: Lens' RenderingConfiguration (Maybe Text) Source #
A URI template containing exactly one variable in
${variableName} format. This can only be set for EXTERNAL knowledge
bases. For Salesforce and ServiceNow, the variable must be one of the
following:
- Salesforce:
Id,ArticleNumber,VersionNumber,Title,PublishStatus, orIsDeleted - ServiceNow:
number,short_description,sys_mod_count,workflow_state, oractive
<p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
ResultData
data ResultData Source #
Information about the result.
See: newResultData smart constructor.
Constructors
| ResultData' | |
Instances
Arguments
| :: Document | |
| -> Text | |
| -> ResultData |
Create a value of ResultData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relevanceScore:ResultData', resultData_relevanceScore - The relevance score of the results.
$sel:document:ResultData', resultData_document - The document.
$sel:resultId:ResultData', resultData_resultId - The identifier of the result data.
resultData_relevanceScore :: Lens' ResultData (Maybe Double) Source #
The relevance score of the results.
resultData_document :: Lens' ResultData Document Source #
The document.
resultData_resultId :: Lens' ResultData Text Source #
The identifier of the result data.
SearchExpression
data SearchExpression Source #
The search expression.
See: newSearchExpression smart constructor.
Constructors
| SearchExpression' | |
Instances
newSearchExpression :: SearchExpression Source #
Create a value of SearchExpression with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:SearchExpression', searchExpression_filters - The search expression filters.
searchExpression_filters :: Lens' SearchExpression [Filter] Source #
The search expression filters.
ServerSideEncryptionConfiguration
data ServerSideEncryptionConfiguration Source #
The KMS key used for encryption.
See: newServerSideEncryptionConfiguration smart constructor.
Constructors
| ServerSideEncryptionConfiguration' | |
Fields
| |
Instances
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 KMS key. For information about valid ID values, see
Key identifiers (KeyId)
in the AWS Key Management Service Developer Guide.
serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration (Maybe Text) Source #
The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.
SessionData
data SessionData Source #
Information about the session.
See: newSessionData smart constructor.
Constructors
| SessionData' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> SessionData |
Create a value of SessionData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:SessionData', sessionData_description - The description of the session.
$sel:tags:SessionData', sessionData_tags - The tags used to organize, track, or control access for this resource.
$sel:name:SessionData', sessionData_name - The name of the session.
$sel:sessionArn:SessionData', sessionData_sessionArn - The Amazon Resource Name (ARN) of the session.
$sel:sessionId:SessionData', sessionData_sessionId - The identifier of the session.
sessionData_description :: Lens' SessionData (Maybe Text) Source #
The description of the session.
sessionData_tags :: Lens' SessionData (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
sessionData_name :: Lens' SessionData Text Source #
The name of the session.
sessionData_sessionArn :: Lens' SessionData Text Source #
The Amazon Resource Name (ARN) of the session.
sessionData_sessionId :: Lens' SessionData Text Source #
The identifier of the session.
SessionSummary
data SessionSummary Source #
Summary information about the session.
See: newSessionSummary smart constructor.
Constructors
| SessionSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> SessionSummary |
Create a value of SessionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantArn:SessionSummary', sessionSummary_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant
$sel:assistantId:SessionSummary', sessionSummary_assistantId - The identifier of the Wisdom assistant.
$sel:sessionArn:SessionSummary', sessionSummary_sessionArn - The Amazon Resource Name (ARN) of the session.
$sel:sessionId:SessionSummary', sessionSummary_sessionId - The identifier of the session.
sessionSummary_assistantArn :: Lens' SessionSummary Text Source #
The Amazon Resource Name (ARN) of the Wisdom assistant
sessionSummary_assistantId :: Lens' SessionSummary Text Source #
The identifier of the Wisdom assistant.
sessionSummary_sessionArn :: Lens' SessionSummary Text Source #
The Amazon Resource Name (ARN) of the session.
sessionSummary_sessionId :: Lens' SessionSummary Text Source #
The identifier of the session.
SourceConfiguration
data SourceConfiguration Source #
Configuration information about the external data source.
See: newSourceConfiguration smart constructor.
Constructors
| SourceConfiguration' | |
Fields
| |
Instances
newSourceConfiguration :: SourceConfiguration Source #
Create a value of SourceConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appIntegrations:SourceConfiguration', sourceConfiguration_appIntegrations - Configuration information for Amazon AppIntegrations to automatically
ingest content.
sourceConfiguration_appIntegrations :: Lens' SourceConfiguration (Maybe AppIntegrationsConfiguration) Source #
Configuration information for Amazon AppIntegrations to automatically ingest content.