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 |
- Service Configuration
- Errors
- Waiters
- Operations
- ListAssistantAssociations (Paginated)
- GetRecommendations
- SearchContent (Paginated)
- RemoveKnowledgeBaseTemplateUri
- GetAssistant
- ListTagsForResource
- ListAssistants (Paginated)
- UpdateKnowledgeBaseTemplateUri
- ListContents (Paginated)
- DeleteContent
- UpdateContent
- CreateAssistant
- GetContentSummary
- NotifyRecommendationsReceived
- DeleteAssistantAssociation
- GetContent
- StartContentUpload
- CreateSession
- CreateContent
- DeleteAssistant
- GetSession
- TagResource
- CreateKnowledgeBase
- GetAssistantAssociation
- UntagResource
- SearchSessions (Paginated)
- ListKnowledgeBases (Paginated)
- QueryAssistant (Paginated)
- DeleteKnowledgeBase
- CreateAssistantAssociation
- GetKnowledgeBase
- Types
- 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
Derived from API version 2020-10-19
of the AWS service descriptions, licensed under Apache 2.0.
All Amazon Connect Wisdom functionality is accessible using the API. For example, you can create an assistant and a knowledge base.
<p>Some more advanced features are only accessible using the Wisdom API. For example, you can manually manage content by uploading custom files and control their lifecycle. </p>
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
- data ListAssistantAssociations = ListAssistantAssociations' (Maybe Text) (Maybe Natural) Text
- newListAssistantAssociations :: Text -> ListAssistantAssociations
- data ListAssistantAssociationsResponse = ListAssistantAssociationsResponse' (Maybe Text) Int [AssistantAssociationSummary]
- newListAssistantAssociationsResponse :: Int -> ListAssistantAssociationsResponse
- data GetRecommendations = GetRecommendations' (Maybe Natural) (Maybe Natural) Text Text
- newGetRecommendations :: Text -> Text -> GetRecommendations
- data GetRecommendationsResponse = GetRecommendationsResponse' Int [RecommendationData]
- newGetRecommendationsResponse :: Int -> GetRecommendationsResponse
- data SearchContent = SearchContent' (Maybe Text) (Maybe Natural) Text SearchExpression
- newSearchContent :: Text -> SearchExpression -> SearchContent
- data SearchContentResponse = SearchContentResponse' (Maybe Text) Int [ContentSummary]
- newSearchContentResponse :: Int -> SearchContentResponse
- data RemoveKnowledgeBaseTemplateUri = RemoveKnowledgeBaseTemplateUri' Text
- newRemoveKnowledgeBaseTemplateUri :: Text -> RemoveKnowledgeBaseTemplateUri
- data RemoveKnowledgeBaseTemplateUriResponse = RemoveKnowledgeBaseTemplateUriResponse' Int
- newRemoveKnowledgeBaseTemplateUriResponse :: Int -> RemoveKnowledgeBaseTemplateUriResponse
- data GetAssistant = GetAssistant' Text
- newGetAssistant :: Text -> GetAssistant
- data GetAssistantResponse = GetAssistantResponse' (Maybe AssistantData) Int
- newGetAssistantResponse :: Int -> GetAssistantResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListAssistants = ListAssistants' (Maybe Text) (Maybe Natural)
- newListAssistants :: ListAssistants
- data ListAssistantsResponse = ListAssistantsResponse' (Maybe Text) Int [AssistantSummary]
- newListAssistantsResponse :: Int -> ListAssistantsResponse
- data UpdateKnowledgeBaseTemplateUri = UpdateKnowledgeBaseTemplateUri' Text Text
- newUpdateKnowledgeBaseTemplateUri :: Text -> Text -> UpdateKnowledgeBaseTemplateUri
- data UpdateKnowledgeBaseTemplateUriResponse = UpdateKnowledgeBaseTemplateUriResponse' (Maybe KnowledgeBaseData) Int
- newUpdateKnowledgeBaseTemplateUriResponse :: Int -> UpdateKnowledgeBaseTemplateUriResponse
- data ListContents = ListContents' (Maybe Text) (Maybe Natural) Text
- newListContents :: Text -> ListContents
- data ListContentsResponse = ListContentsResponse' (Maybe Text) Int [ContentSummary]
- newListContentsResponse :: Int -> ListContentsResponse
- data DeleteContent = DeleteContent' Text Text
- newDeleteContent :: Text -> Text -> DeleteContent
- data DeleteContentResponse = DeleteContentResponse' Int
- newDeleteContentResponse :: Int -> DeleteContentResponse
- data UpdateContent = UpdateContent' (Maybe Text) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newUpdateContent :: Text -> Text -> UpdateContent
- data UpdateContentResponse = UpdateContentResponse' (Maybe ContentData) Int
- newUpdateContentResponse :: Int -> UpdateContentResponse
- data CreateAssistant = CreateAssistant' (Maybe Text) (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text AssistantType
- newCreateAssistant :: Text -> AssistantType -> CreateAssistant
- data CreateAssistantResponse = CreateAssistantResponse' (Maybe AssistantData) Int
- newCreateAssistantResponse :: Int -> CreateAssistantResponse
- data GetContentSummary = GetContentSummary' Text Text
- newGetContentSummary :: Text -> Text -> GetContentSummary
- data GetContentSummaryResponse = GetContentSummaryResponse' (Maybe ContentSummary) Int
- newGetContentSummaryResponse :: Int -> GetContentSummaryResponse
- data NotifyRecommendationsReceived = NotifyRecommendationsReceived' Text [Text] Text
- newNotifyRecommendationsReceived :: Text -> Text -> NotifyRecommendationsReceived
- data NotifyRecommendationsReceivedResponse = NotifyRecommendationsReceivedResponse' (Maybe [Text]) (Maybe [NotifyRecommendationsReceivedError]) Int
- newNotifyRecommendationsReceivedResponse :: Int -> NotifyRecommendationsReceivedResponse
- data DeleteAssistantAssociation = DeleteAssistantAssociation' Text Text
- newDeleteAssistantAssociation :: Text -> Text -> DeleteAssistantAssociation
- data DeleteAssistantAssociationResponse = DeleteAssistantAssociationResponse' Int
- newDeleteAssistantAssociationResponse :: Int -> DeleteAssistantAssociationResponse
- data GetContent = GetContent' Text Text
- newGetContent :: Text -> Text -> GetContent
- data GetContentResponse = GetContentResponse' (Maybe ContentData) Int
- newGetContentResponse :: Int -> GetContentResponse
- data StartContentUpload = StartContentUpload' Text Text
- newStartContentUpload :: Text -> Text -> StartContentUpload
- data StartContentUploadResponse = StartContentUploadResponse' Int (HashMap Text Text) Text (Sensitive Text) POSIX
- newStartContentUploadResponse :: Int -> Text -> Text -> UTCTime -> StartContentUploadResponse
- data CreateSession = CreateSession' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateSession :: Text -> Text -> CreateSession
- data CreateSessionResponse = CreateSessionResponse' (Maybe SessionData) Int
- newCreateSessionResponse :: Int -> CreateSessionResponse
- data CreateContent = CreateContent' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text
- newCreateContent :: Text -> Text -> Text -> CreateContent
- data CreateContentResponse = CreateContentResponse' (Maybe ContentData) Int
- newCreateContentResponse :: Int -> CreateContentResponse
- data DeleteAssistant = DeleteAssistant' Text
- newDeleteAssistant :: Text -> DeleteAssistant
- data DeleteAssistantResponse = DeleteAssistantResponse' Int
- newDeleteAssistantResponse :: Int -> DeleteAssistantResponse
- data GetSession = GetSession' Text Text
- newGetSession :: Text -> Text -> GetSession
- data GetSessionResponse = GetSessionResponse' (Maybe SessionData) Int
- newGetSessionResponse :: Int -> GetSessionResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data CreateKnowledgeBase = CreateKnowledgeBase' (Maybe Text) (Maybe RenderingConfiguration) (Maybe SourceConfiguration) (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) KnowledgeBaseType Text
- newCreateKnowledgeBase :: KnowledgeBaseType -> Text -> CreateKnowledgeBase
- data CreateKnowledgeBaseResponse = CreateKnowledgeBaseResponse' (Maybe KnowledgeBaseData) Int
- newCreateKnowledgeBaseResponse :: Int -> CreateKnowledgeBaseResponse
- data GetAssistantAssociation = GetAssistantAssociation' Text Text
- newGetAssistantAssociation :: Text -> Text -> GetAssistantAssociation
- data GetAssistantAssociationResponse = GetAssistantAssociationResponse' (Maybe AssistantAssociationData) Int
- newGetAssistantAssociationResponse :: Int -> GetAssistantAssociationResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data SearchSessions = SearchSessions' (Maybe Text) (Maybe Natural) Text SearchExpression
- newSearchSessions :: Text -> SearchExpression -> SearchSessions
- data SearchSessionsResponse = SearchSessionsResponse' (Maybe Text) Int [SessionSummary]
- newSearchSessionsResponse :: Int -> SearchSessionsResponse
- data ListKnowledgeBases = ListKnowledgeBases' (Maybe Text) (Maybe Natural)
- newListKnowledgeBases :: ListKnowledgeBases
- data ListKnowledgeBasesResponse = ListKnowledgeBasesResponse' (Maybe Text) Int [KnowledgeBaseSummary]
- newListKnowledgeBasesResponse :: Int -> ListKnowledgeBasesResponse
- data QueryAssistant = QueryAssistant' (Maybe Text) (Maybe Natural) Text (Sensitive Text)
- newQueryAssistant :: Text -> Text -> QueryAssistant
- data QueryAssistantResponse = QueryAssistantResponse' (Maybe Text) Int [ResultData]
- newQueryAssistantResponse :: Int -> QueryAssistantResponse
- data DeleteKnowledgeBase = DeleteKnowledgeBase' Text
- newDeleteKnowledgeBase :: Text -> DeleteKnowledgeBase
- data DeleteKnowledgeBaseResponse = DeleteKnowledgeBaseResponse' Int
- newDeleteKnowledgeBaseResponse :: Int -> DeleteKnowledgeBaseResponse
- data CreateAssistantAssociation = CreateAssistantAssociation' (Maybe Text) (Maybe (HashMap Text Text)) Text AssistantAssociationInputData AssociationType
- newCreateAssistantAssociation :: Text -> AssistantAssociationInputData -> AssociationType -> CreateAssistantAssociation
- data CreateAssistantAssociationResponse = CreateAssistantAssociationResponse' (Maybe AssistantAssociationData) Int
- newCreateAssistantAssociationResponse :: Int -> CreateAssistantAssociationResponse
- data GetKnowledgeBase = GetKnowledgeBase' Text
- newGetKnowledgeBase :: Text -> GetKnowledgeBase
- data GetKnowledgeBaseResponse = GetKnowledgeBaseResponse' (Maybe KnowledgeBaseData) Int
- newGetKnowledgeBaseResponse :: Int -> GetKnowledgeBaseResponse
- 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' Text (NonEmpty Text)
- newAppIntegrationsConfiguration :: Text -> NonEmpty Text -> AppIntegrationsConfiguration
- data AssistantAssociationData = AssistantAssociationData' (Maybe (HashMap Text Text)) Text Text Text Text AssistantAssociationOutputData AssociationType
- newAssistantAssociationData :: Text -> Text -> Text -> Text -> AssistantAssociationOutputData -> AssociationType -> AssistantAssociationData
- data AssistantAssociationInputData = AssistantAssociationInputData' (Maybe Text)
- newAssistantAssociationInputData :: AssistantAssociationInputData
- data AssistantAssociationOutputData = AssistantAssociationOutputData' (Maybe KnowledgeBaseAssociationData)
- newAssistantAssociationOutputData :: AssistantAssociationOutputData
- data AssistantAssociationSummary = AssistantAssociationSummary' (Maybe (HashMap Text Text)) Text Text Text Text AssistantAssociationOutputData AssociationType
- newAssistantAssociationSummary :: Text -> Text -> Text -> Text -> AssistantAssociationOutputData -> AssociationType -> AssistantAssociationSummary
- data AssistantData = AssistantData' (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text Text Text AssistantStatus AssistantType
- newAssistantData :: Text -> Text -> Text -> AssistantStatus -> AssistantType -> AssistantData
- data AssistantSummary = AssistantSummary' (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text Text Text AssistantStatus AssistantType
- newAssistantSummary :: Text -> Text -> Text -> AssistantStatus -> AssistantType -> AssistantSummary
- data ContentData = ContentData' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text Text Text (HashMap Text Text) Text Text ContentStatus Text (Sensitive Text) POSIX
- newContentData :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> ContentStatus -> Text -> Text -> UTCTime -> ContentData
- data ContentReference = ContentReference' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newContentReference :: ContentReference
- data ContentSummary = ContentSummary' (Maybe (HashMap Text Text)) Text Text Text Text Text (HashMap Text Text) Text Text ContentStatus Text
- newContentSummary :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> ContentStatus -> Text -> ContentSummary
- data Document = Document' (Maybe DocumentText) (Maybe DocumentText) ContentReference
- newDocument :: ContentReference -> Document
- data DocumentText = DocumentText' (Maybe (Sensitive Text)) (Maybe [Highlight])
- newDocumentText :: DocumentText
- data Filter = Filter' FilterField FilterOperator Text
- newFilter :: FilterField -> FilterOperator -> Text -> Filter
- data Highlight = Highlight' (Maybe Int) (Maybe Int)
- newHighlight :: Highlight
- data KnowledgeBaseAssociationData = KnowledgeBaseAssociationData' (Maybe Text) (Maybe Text)
- newKnowledgeBaseAssociationData :: KnowledgeBaseAssociationData
- data KnowledgeBaseData = KnowledgeBaseData' (Maybe RenderingConfiguration) (Maybe SourceConfiguration) (Maybe POSIX) (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text Text KnowledgeBaseType Text KnowledgeBaseStatus
- newKnowledgeBaseData :: Text -> Text -> KnowledgeBaseType -> Text -> KnowledgeBaseStatus -> KnowledgeBaseData
- data KnowledgeBaseSummary = KnowledgeBaseSummary' (Maybe RenderingConfiguration) (Maybe SourceConfiguration) (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text Text KnowledgeBaseType Text KnowledgeBaseStatus
- newKnowledgeBaseSummary :: Text -> Text -> KnowledgeBaseType -> Text -> KnowledgeBaseStatus -> KnowledgeBaseSummary
- data NotifyRecommendationsReceivedError = NotifyRecommendationsReceivedError' (Maybe Text) (Maybe Text)
- newNotifyRecommendationsReceivedError :: NotifyRecommendationsReceivedError
- data RecommendationData = RecommendationData' (Maybe RelevanceLevel) (Maybe Double) Document Text
- newRecommendationData :: Document -> Text -> RecommendationData
- data RenderingConfiguration = RenderingConfiguration' (Maybe Text)
- newRenderingConfiguration :: RenderingConfiguration
- data ResultData = ResultData' (Maybe Double) Document Text
- newResultData :: Document -> Text -> ResultData
- data SearchExpression = SearchExpression' [Filter]
- newSearchExpression :: SearchExpression
- data ServerSideEncryptionConfiguration = ServerSideEncryptionConfiguration' (Maybe Text)
- newServerSideEncryptionConfiguration :: ServerSideEncryptionConfiguration
- data SessionData = SessionData' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text
- newSessionData :: Text -> Text -> Text -> SessionData
- data SessionSummary = SessionSummary' Text Text Text Text
- newSessionSummary :: Text -> Text -> Text -> Text -> SessionSummary
- data SourceConfiguration = SourceConfiguration' (Maybe AppIntegrationsConfiguration)
- newSourceConfiguration :: SourceConfiguration
Service Configuration
defaultService :: Service Source #
API version 2020-10-19
of the Amazon Connect Wisdom Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Wisdom
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
PreconditionFailedException
_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
_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
_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
_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
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource does not exist.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListAssistantAssociations (Paginated)
data ListAssistantAssociations Source #
See: newListAssistantAssociations
smart constructor.
Instances
newListAssistantAssociations Source #
Create a value of ListAssistantAssociations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAssistantAssociations'
, listAssistantAssociations_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:maxResults:ListAssistantAssociations'
, listAssistantAssociations_maxResults
- The maximum number of results to return per page.
$sel:assistantId:ListAssistantAssociations'
, listAssistantAssociations_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
data ListAssistantAssociationsResponse Source #
See: newListAssistantAssociationsResponse
smart constructor.
Instances
newListAssistantAssociationsResponse Source #
Create a value of ListAssistantAssociationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAssistantAssociations'
, listAssistantAssociationsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:ListAssistantAssociationsResponse'
, listAssistantAssociationsResponse_httpStatus
- The response's http status code.
$sel:assistantAssociationSummaries:ListAssistantAssociationsResponse'
, listAssistantAssociationsResponse_assistantAssociationSummaries
- Summary information about assistant associations.
GetRecommendations
data GetRecommendations Source #
See: newGetRecommendations
smart constructor.
Instances
newGetRecommendations Source #
:: Text | |
-> Text | |
-> GetRecommendations |
Create a value of GetRecommendations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:waitTimeSeconds:GetRecommendations'
, getRecommendations_waitTimeSeconds
- The duration (in seconds) for which the call waits for a recommendation
to be made available before returning. If a recommendation is available,
the call returns sooner than WaitTimeSeconds
. If no messages are
available and the wait time expires, the call returns successfully with
an empty list.
$sel:maxResults:GetRecommendations'
, getRecommendations_maxResults
- The maximum number of results to return per page.
$sel:assistantId:GetRecommendations'
, getRecommendations_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
$sel:sessionId:GetRecommendations'
, getRecommendations_sessionId
- The identifier of the session. Can be either the ID or the ARN. URLs
cannot contain the ARN.
data GetRecommendationsResponse Source #
See: newGetRecommendationsResponse
smart constructor.
Instances
newGetRecommendationsResponse Source #
Create a value of GetRecommendationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetRecommendationsResponse'
, getRecommendationsResponse_httpStatus
- The response's http status code.
$sel:recommendations:GetRecommendationsResponse'
, getRecommendationsResponse_recommendations
- The recommendations.
SearchContent (Paginated)
data SearchContent Source #
See: newSearchContent
smart constructor.
Instances
:: Text | |
-> SearchExpression | |
-> SearchContent |
Create a value of SearchContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:SearchContent'
, searchContent_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:maxResults:SearchContent'
, searchContent_maxResults
- The maximum number of results to return per page.
$sel:knowledgeBaseId:SearchContent'
, searchContent_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
$sel:searchExpression:SearchContent'
, searchContent_searchExpression
- The search expression to filter results.
data SearchContentResponse Source #
See: newSearchContentResponse
smart constructor.
Instances
newSearchContentResponse Source #
Create a value of SearchContentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:SearchContent'
, searchContentResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:SearchContentResponse'
, searchContentResponse_httpStatus
- The response's http status code.
$sel:contentSummaries:SearchContentResponse'
, searchContentResponse_contentSummaries
- Summary information about the content.
RemoveKnowledgeBaseTemplateUri
data RemoveKnowledgeBaseTemplateUri Source #
See: newRemoveKnowledgeBaseTemplateUri
smart constructor.
Instances
newRemoveKnowledgeBaseTemplateUri Source #
Create a value of RemoveKnowledgeBaseTemplateUri
with all optional fields omitted.
Use 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:RemoveKnowledgeBaseTemplateUri'
, removeKnowledgeBaseTemplateUri_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
data RemoveKnowledgeBaseTemplateUriResponse Source #
See: newRemoveKnowledgeBaseTemplateUriResponse
smart constructor.
Instances
newRemoveKnowledgeBaseTemplateUriResponse Source #
Create a value of RemoveKnowledgeBaseTemplateUriResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RemoveKnowledgeBaseTemplateUriResponse'
, removeKnowledgeBaseTemplateUriResponse_httpStatus
- The response's http status code.
GetAssistant
data GetAssistant Source #
See: newGetAssistant
smart constructor.
Instances
Create a value of GetAssistant
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantId:GetAssistant'
, getAssistant_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
data GetAssistantResponse Source #
See: newGetAssistantResponse
smart constructor.
Instances
newGetAssistantResponse Source #
Create a value of GetAssistantResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistant:GetAssistantResponse'
, getAssistantResponse_assistant
- Information about the assistant.
$sel:httpStatus:GetAssistantResponse'
, getAssistantResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListAssistants (Paginated)
data ListAssistants Source #
See: newListAssistants
smart constructor.
Instances
newListAssistants :: ListAssistants Source #
Create a value of ListAssistants
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAssistants'
, listAssistants_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:maxResults:ListAssistants'
, listAssistants_maxResults
- The maximum number of results to return per page.
data ListAssistantsResponse Source #
See: newListAssistantsResponse
smart constructor.
Instances
newListAssistantsResponse Source #
Create a value of ListAssistantsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAssistants'
, listAssistantsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:ListAssistantsResponse'
, listAssistantsResponse_httpStatus
- The response's http status code.
$sel:assistantSummaries:ListAssistantsResponse'
, listAssistantsResponse_assistantSummaries
- Information about the assistants.
UpdateKnowledgeBaseTemplateUri
data UpdateKnowledgeBaseTemplateUri Source #
See: newUpdateKnowledgeBaseTemplateUri
smart constructor.
Instances
newUpdateKnowledgeBaseTemplateUri Source #
Create a value of UpdateKnowledgeBaseTemplateUri
with all optional fields omitted.
Use 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:UpdateKnowledgeBaseTemplateUri'
, updateKnowledgeBaseTemplateUri_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
$sel:templateUri:UpdateKnowledgeBaseTemplateUri'
, updateKnowledgeBaseTemplateUri_templateUri
- The template URI to update.
data UpdateKnowledgeBaseTemplateUriResponse Source #
See: newUpdateKnowledgeBaseTemplateUriResponse
smart constructor.
Instances
newUpdateKnowledgeBaseTemplateUriResponse Source #
Create a value of UpdateKnowledgeBaseTemplateUriResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:knowledgeBase:UpdateKnowledgeBaseTemplateUriResponse'
, updateKnowledgeBaseTemplateUriResponse_knowledgeBase
- The knowledge base to update.
$sel:httpStatus:UpdateKnowledgeBaseTemplateUriResponse'
, updateKnowledgeBaseTemplateUriResponse_httpStatus
- The response's http status code.
ListContents (Paginated)
data ListContents Source #
See: newListContents
smart constructor.
Instances
Create a value of ListContents
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListContents'
, listContents_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:maxResults:ListContents'
, listContents_maxResults
- The maximum number of results to return per page.
$sel:knowledgeBaseId:ListContents'
, listContents_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
data ListContentsResponse Source #
See: newListContentsResponse
smart constructor.
Instances
newListContentsResponse Source #
Create a value of ListContentsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListContents'
, listContentsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:ListContentsResponse'
, listContentsResponse_httpStatus
- The response's http status code.
$sel:contentSummaries:ListContentsResponse'
, listContentsResponse_contentSummaries
- Information about the content.
DeleteContent
data DeleteContent Source #
See: newDeleteContent
smart constructor.
Instances
Create a value of DeleteContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentId:DeleteContent'
, deleteContent_contentId
- The identifier of the content. Can be either the ID or the ARN. URLs
cannot contain the ARN.
$sel:knowledgeBaseId:DeleteContent'
, deleteContent_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
data DeleteContentResponse Source #
See: newDeleteContentResponse
smart constructor.
Instances
newDeleteContentResponse Source #
Create a value of DeleteContentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteContentResponse'
, deleteContentResponse_httpStatus
- The response's http status code.
UpdateContent
data UpdateContent Source #
See: newUpdateContent
smart constructor.
UpdateContent' (Maybe Text) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text |
Instances
Create a value of UpdateContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:overrideLinkOutUri:UpdateContent'
, updateContent_overrideLinkOutUri
- The URI for the article. If the knowledge base has a templateUri,
setting this argument overrides it for this piece of content. To remove
an existing overrideLinkOurUri
, exclude this argument and set
removeOverrideLinkOutUri
to true.
$sel:removeOverrideLinkOutUri:UpdateContent'
, updateContent_removeOverrideLinkOutUri
- Unset the existing overrideLinkOutUri
if it exists.
$sel:metadata:UpdateContent'
, updateContent_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:title:UpdateContent'
, updateContent_title
- The title of the content.
$sel:revisionId:UpdateContent'
, updateContent_revisionId
- The revisionId
of the content resource to update, taken from an
earlier call to GetContent
, GetContentSummary
, SearchContent
, or
ListContents
. If included, this argument acts as an optimistic lock to
ensure content was not modified since it was last read. If it has been
modified, this API throws a PreconditionFailedException
.
$sel:uploadId:UpdateContent'
, updateContent_uploadId
- A pointer to the uploaded asset. This value is returned by
StartContentUpload.
$sel:contentId:UpdateContent'
, updateContent_contentId
- The identifier of the content. Can be either the ID or the ARN. URLs
cannot contain the ARN.
$sel:knowledgeBaseId:UpdateContent'
, updateContent_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN
data UpdateContentResponse Source #
See: newUpdateContentResponse
smart constructor.
Instances
newUpdateContentResponse Source #
Create a value of UpdateContentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:UpdateContentResponse'
, updateContentResponse_content
- The content.
$sel:httpStatus:UpdateContentResponse'
, updateContentResponse_httpStatus
- The response's http status code.
CreateAssistant
data CreateAssistant Source #
See: newCreateAssistant
smart constructor.
CreateAssistant' (Maybe Text) (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text AssistantType |
Instances
Create a value of CreateAssistant
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateAssistant'
, createAssistant_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:description:CreateAssistant'
, createAssistant_description
- The description of the assistant.
$sel:serverSideEncryptionConfiguration:CreateAssistant'
, createAssistant_serverSideEncryptionConfiguration
- The KMS key used for encryption.
$sel:tags:CreateAssistant'
, createAssistant_tags
- The tags used to organize, track, or control access for this resource.
$sel:name:CreateAssistant'
, createAssistant_name
- The name of the assistant.
$sel:type':CreateAssistant'
, createAssistant_type
- The type of assistant.
data CreateAssistantResponse Source #
See: newCreateAssistantResponse
smart constructor.
Instances
newCreateAssistantResponse Source #
Create a value of CreateAssistantResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistant:CreateAssistantResponse'
, createAssistantResponse_assistant
- Information about the assistant.
$sel:httpStatus:CreateAssistantResponse'
, createAssistantResponse_httpStatus
- The response's http status code.
GetContentSummary
data GetContentSummary Source #
See: newGetContentSummary
smart constructor.
Instances
:: Text | |
-> Text | |
-> GetContentSummary |
Create a value of GetContentSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentId:GetContentSummary'
, getContentSummary_contentId
- The identifier of the content. Can be either the ID or the ARN. URLs
cannot contain the ARN.
$sel:knowledgeBaseId:GetContentSummary'
, getContentSummary_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
data GetContentSummaryResponse Source #
See: newGetContentSummaryResponse
smart constructor.
Instances
newGetContentSummaryResponse Source #
Create a value of GetContentSummaryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentSummary:GetContentSummaryResponse'
, getContentSummaryResponse_contentSummary
- The content summary.
$sel:httpStatus:GetContentSummaryResponse'
, getContentSummaryResponse_httpStatus
- The response's http status code.
NotifyRecommendationsReceived
data NotifyRecommendationsReceived Source #
See: newNotifyRecommendationsReceived
smart constructor.
Instances
newNotifyRecommendationsReceived Source #
Create a value of NotifyRecommendationsReceived
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantId:NotifyRecommendationsReceived'
, notifyRecommendationsReceived_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
$sel:recommendationIds:NotifyRecommendationsReceived'
, notifyRecommendationsReceived_recommendationIds
- The identifiers of the recommendations.
$sel:sessionId:NotifyRecommendationsReceived'
, notifyRecommendationsReceived_sessionId
- The identifier of the session. Can be either the ID or the ARN. URLs
cannot contain the ARN.
data NotifyRecommendationsReceivedResponse Source #
See: newNotifyRecommendationsReceivedResponse
smart constructor.
NotifyRecommendationsReceivedResponse' (Maybe [Text]) (Maybe [NotifyRecommendationsReceivedError]) Int |
Instances
newNotifyRecommendationsReceivedResponse Source #
Create a value of NotifyRecommendationsReceivedResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recommendationIds:NotifyRecommendationsReceived'
, notifyRecommendationsReceivedResponse_recommendationIds
- The identifiers of the recommendations.
$sel:errors:NotifyRecommendationsReceivedResponse'
, notifyRecommendationsReceivedResponse_errors
- The identifiers of recommendations that are causing errors.
$sel:httpStatus:NotifyRecommendationsReceivedResponse'
, notifyRecommendationsReceivedResponse_httpStatus
- The response's http status code.
DeleteAssistantAssociation
data DeleteAssistantAssociation Source #
See: newDeleteAssistantAssociation
smart constructor.
Instances
newDeleteAssistantAssociation Source #
:: Text | |
-> Text | |
-> DeleteAssistantAssociation |
Create a value of DeleteAssistantAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantAssociationId:DeleteAssistantAssociation'
, deleteAssistantAssociation_assistantAssociationId
- The identifier of the assistant association. Can be either the ID or the
ARN. URLs cannot contain the ARN.
$sel:assistantId:DeleteAssistantAssociation'
, deleteAssistantAssociation_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
data DeleteAssistantAssociationResponse Source #
See: newDeleteAssistantAssociationResponse
smart constructor.
Instances
Eq DeleteAssistantAssociationResponse Source # | |
Read DeleteAssistantAssociationResponse Source # | |
Show DeleteAssistantAssociationResponse Source # | |
Generic DeleteAssistantAssociationResponse Source # | |
NFData DeleteAssistantAssociationResponse Source # | |
Defined in Amazonka.Wisdom.DeleteAssistantAssociation rnf :: DeleteAssistantAssociationResponse -> () # | |
type Rep DeleteAssistantAssociationResponse Source # | |
Defined in Amazonka.Wisdom.DeleteAssistantAssociation type Rep DeleteAssistantAssociationResponse = D1 ('MetaData "DeleteAssistantAssociationResponse" "Amazonka.Wisdom.DeleteAssistantAssociation" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "DeleteAssistantAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteAssistantAssociationResponse Source #
Create a value of DeleteAssistantAssociationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAssistantAssociationResponse'
, deleteAssistantAssociationResponse_httpStatus
- The response's http status code.
GetContent
data GetContent Source #
See: newGetContent
smart constructor.
Instances
Create a value of GetContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentId:GetContent'
, getContent_contentId
- The identifier of the content. Can be either the ID or the ARN. URLs
cannot contain the ARN.
$sel:knowledgeBaseId:GetContent'
, getContent_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
data GetContentResponse Source #
See: newGetContentResponse
smart constructor.
Instances
newGetContentResponse Source #
Create a value of GetContentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:GetContentResponse'
, getContentResponse_content
- The content.
$sel:httpStatus:GetContentResponse'
, getContentResponse_httpStatus
- The response's http status code.
StartContentUpload
data StartContentUpload Source #
See: newStartContentUpload
smart constructor.
Instances
newStartContentUpload Source #
:: Text | |
-> Text | |
-> StartContentUpload |
Create a value of StartContentUpload
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentType:StartContentUpload'
, startContentUpload_contentType
- The type of content to upload.
$sel:knowledgeBaseId:StartContentUpload'
, startContentUpload_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
data StartContentUploadResponse Source #
See: newStartContentUploadResponse
smart constructor.
Instances
newStartContentUploadResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> StartContentUploadResponse |
Create a value of StartContentUploadResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartContentUploadResponse'
, startContentUploadResponse_httpStatus
- The response's http status code.
$sel:headersToInclude:StartContentUploadResponse'
, startContentUploadResponse_headersToInclude
- The headers to include in the upload.
$sel:uploadId:StartContentUploadResponse'
, startContentUploadResponse_uploadId
- The identifier of the upload.
$sel:url:StartContentUploadResponse'
, startContentUploadResponse_url
- The URL of the upload.
$sel:urlExpiry:StartContentUploadResponse'
, startContentUploadResponse_urlExpiry
- The expiration time of the URL as an epoch timestamp.
CreateSession
data CreateSession Source #
See: newCreateSession
smart constructor.
Instances
Create a value of CreateSession
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateSession'
, createSession_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:description:CreateSession'
, createSession_description
- The description.
$sel:tags:CreateSession'
, createSession_tags
- The tags used to organize, track, or control access for this resource.
$sel:assistantId:CreateSession'
, createSession_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
$sel:name:CreateSession'
, createSession_name
- The name of the session.
data CreateSessionResponse Source #
See: newCreateSessionResponse
smart constructor.
Instances
newCreateSessionResponse Source #
Create a value of CreateSessionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:session:CreateSessionResponse'
, createSessionResponse_session
- The session.
$sel:httpStatus:CreateSessionResponse'
, createSessionResponse_httpStatus
- The response's http status code.
CreateContent
data CreateContent Source #
See: newCreateContent
smart constructor.
CreateContent' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text |
Instances
:: Text | |
-> Text | |
-> Text | |
-> CreateContent |
Create a value of CreateContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:overrideLinkOutUri:CreateContent'
, createContent_overrideLinkOutUri
- The URI you want to use for the article. If the knowledge base has a
templateUri, setting this argument overrides it for this piece of
content.
$sel:clientToken:CreateContent'
, createContent_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:metadata:CreateContent'
, createContent_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:title:CreateContent'
, createContent_title
- The title of the content. If not set, the title is equal to the name.
$sel:tags:CreateContent'
, createContent_tags
- The tags used to organize, track, or control access for this resource.
$sel:knowledgeBaseId:CreateContent'
, createContent_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
$sel:name:CreateContent'
, createContent_name
- The name of the content. Each piece of content in a knowledge base must
have a unique name. You can retrieve a piece of content using only its
knowledge base and its name with the
SearchContent
API.
$sel:uploadId:CreateContent'
, createContent_uploadId
- A pointer to the uploaded asset. This value is returned by
StartContentUpload.
data CreateContentResponse Source #
See: newCreateContentResponse
smart constructor.
Instances
newCreateContentResponse Source #
Create a value of CreateContentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:CreateContentResponse'
, createContentResponse_content
- The content.
$sel:httpStatus:CreateContentResponse'
, createContentResponse_httpStatus
- The response's http status code.
DeleteAssistant
data DeleteAssistant Source #
See: newDeleteAssistant
smart constructor.
Instances
Create a value of DeleteAssistant
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantId:DeleteAssistant'
, deleteAssistant_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
data DeleteAssistantResponse Source #
See: newDeleteAssistantResponse
smart constructor.
Instances
newDeleteAssistantResponse Source #
Create a value of DeleteAssistantResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAssistantResponse'
, deleteAssistantResponse_httpStatus
- The response's http status code.
GetSession
data GetSession Source #
See: newGetSession
smart constructor.
Instances
Create a value of GetSession
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantId:GetSession'
, getSession_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
$sel:sessionId:GetSession'
, getSession_sessionId
- The identifier of the session. Can be either the ID or the ARN. URLs
cannot contain the ARN.
data GetSessionResponse Source #
See: newGetSessionResponse
smart constructor.
Instances
newGetSessionResponse Source #
Create a value of GetSessionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:session:GetSessionResponse'
, getSessionResponse_session
- The session.
$sel:httpStatus:GetSessionResponse'
, getSessionResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource.
$sel:tags:TagResource'
, tagResource_tags
- The tags used to organize, track, or control access for this resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
CreateKnowledgeBase
data CreateKnowledgeBase Source #
See: newCreateKnowledgeBase
smart constructor.
CreateKnowledgeBase' (Maybe Text) (Maybe RenderingConfiguration) (Maybe SourceConfiguration) (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) KnowledgeBaseType Text |
Instances
newCreateKnowledgeBase Source #
Create a value of CreateKnowledgeBase
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateKnowledgeBase'
, createKnowledgeBase_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:renderingConfiguration:CreateKnowledgeBase'
, createKnowledgeBase_renderingConfiguration
- Information about how to render the content.
$sel:sourceConfiguration:CreateKnowledgeBase'
, createKnowledgeBase_sourceConfiguration
- The source of the knowledge base content. Only set this argument for
EXTERNAL knowledge bases.
$sel:description:CreateKnowledgeBase'
, createKnowledgeBase_description
- The description.
$sel:serverSideEncryptionConfiguration:CreateKnowledgeBase'
, createKnowledgeBase_serverSideEncryptionConfiguration
- The KMS key used for encryption.
$sel:tags:CreateKnowledgeBase'
, createKnowledgeBase_tags
- The tags used to organize, track, or control access for this resource.
$sel:knowledgeBaseType:CreateKnowledgeBase'
, createKnowledgeBase_knowledgeBaseType
- The type of knowledge base. Only CUSTOM knowledge bases allow you to
upload your own content. EXTERNAL knowledge bases support integrations
with third-party systems whose content is synchronized automatically.
$sel:name:CreateKnowledgeBase'
, createKnowledgeBase_name
- The name of the knowledge base.
data CreateKnowledgeBaseResponse Source #
See: newCreateKnowledgeBaseResponse
smart constructor.
Instances
newCreateKnowledgeBaseResponse Source #
Create a value of CreateKnowledgeBaseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:knowledgeBase:CreateKnowledgeBaseResponse'
, createKnowledgeBaseResponse_knowledgeBase
- The knowledge base.
$sel:httpStatus:CreateKnowledgeBaseResponse'
, createKnowledgeBaseResponse_httpStatus
- The response's http status code.
GetAssistantAssociation
data GetAssistantAssociation Source #
See: newGetAssistantAssociation
smart constructor.
Instances
newGetAssistantAssociation Source #
:: Text | |
-> Text | |
-> GetAssistantAssociation |
Create a value of GetAssistantAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantAssociationId:GetAssistantAssociation'
, getAssistantAssociation_assistantAssociationId
- The identifier of the assistant association. Can be either the ID or the
ARN. URLs cannot contain the ARN.
$sel:assistantId:GetAssistantAssociation'
, getAssistantAssociation_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
data GetAssistantAssociationResponse Source #
See: newGetAssistantAssociationResponse
smart constructor.
Instances
Eq GetAssistantAssociationResponse Source # | |
Read GetAssistantAssociationResponse Source # | |
Show GetAssistantAssociationResponse Source # | |
Defined in Amazonka.Wisdom.GetAssistantAssociation | |
Generic GetAssistantAssociationResponse Source # | |
NFData GetAssistantAssociationResponse Source # | |
Defined in Amazonka.Wisdom.GetAssistantAssociation rnf :: GetAssistantAssociationResponse -> () # | |
type Rep GetAssistantAssociationResponse Source # | |
Defined in Amazonka.Wisdom.GetAssistantAssociation type Rep GetAssistantAssociationResponse = D1 ('MetaData "GetAssistantAssociationResponse" "Amazonka.Wisdom.GetAssistantAssociation" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "GetAssistantAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assistantAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssistantAssociationData)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetAssistantAssociationResponse Source #
Create a value of GetAssistantAssociationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantAssociation:GetAssistantAssociationResponse'
, getAssistantAssociationResponse_assistantAssociation
- The assistant association.
$sel:httpStatus:GetAssistantAssociationResponse'
, getAssistantAssociationResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag keys.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
SearchSessions (Paginated)
data SearchSessions Source #
See: newSearchSessions
smart constructor.
Instances
:: Text | |
-> SearchExpression | |
-> SearchSessions |
Create a value of SearchSessions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:SearchSessions'
, searchSessions_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:maxResults:SearchSessions'
, searchSessions_maxResults
- The maximum number of results to return per page.
$sel:assistantId:SearchSessions'
, searchSessions_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
$sel:searchExpression:SearchSessions'
, searchSessions_searchExpression
- The search expression to filter results.
data SearchSessionsResponse Source #
See: newSearchSessionsResponse
smart constructor.
Instances
newSearchSessionsResponse Source #
Create a value of SearchSessionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:SearchSessions'
, searchSessionsResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:SearchSessionsResponse'
, searchSessionsResponse_httpStatus
- The response's http status code.
$sel:sessionSummaries:SearchSessionsResponse'
, searchSessionsResponse_sessionSummaries
- Summary information about the sessions.
ListKnowledgeBases (Paginated)
data ListKnowledgeBases Source #
See: newListKnowledgeBases
smart constructor.
Instances
newListKnowledgeBases :: ListKnowledgeBases Source #
Create a value of ListKnowledgeBases
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListKnowledgeBases'
, listKnowledgeBases_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:maxResults:ListKnowledgeBases'
, listKnowledgeBases_maxResults
- The maximum number of results to return per page.
data ListKnowledgeBasesResponse Source #
See: newListKnowledgeBasesResponse
smart constructor.
Instances
newListKnowledgeBasesResponse Source #
Create a value of ListKnowledgeBasesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListKnowledgeBases'
, listKnowledgeBasesResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:ListKnowledgeBasesResponse'
, listKnowledgeBasesResponse_httpStatus
- The response's http status code.
$sel:knowledgeBaseSummaries:ListKnowledgeBasesResponse'
, listKnowledgeBasesResponse_knowledgeBaseSummaries
- Information about the knowledge bases.
QueryAssistant (Paginated)
data QueryAssistant Source #
See: newQueryAssistant
smart constructor.
Instances
Create a value of QueryAssistant
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:QueryAssistant'
, queryAssistant_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:maxResults:QueryAssistant'
, queryAssistant_maxResults
- The maximum number of results to return per page.
$sel:assistantId:QueryAssistant'
, queryAssistant_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
$sel:queryText:QueryAssistant'
, queryAssistant_queryText
- The text to search for.
data QueryAssistantResponse Source #
See: newQueryAssistantResponse
smart constructor.
Instances
newQueryAssistantResponse Source #
Create a value of QueryAssistantResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:QueryAssistant'
, queryAssistantResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:httpStatus:QueryAssistantResponse'
, queryAssistantResponse_httpStatus
- The response's http status code.
$sel:results:QueryAssistantResponse'
, queryAssistantResponse_results
- The results of the query.
DeleteKnowledgeBase
data DeleteKnowledgeBase Source #
See: newDeleteKnowledgeBase
smart constructor.
Instances
newDeleteKnowledgeBase Source #
Create a value of DeleteKnowledgeBase
with all optional fields omitted.
Use 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:DeleteKnowledgeBase'
, deleteKnowledgeBase_knowledgeBaseId
- The knowledge base to delete content from. Can be either the ID or the
ARN. URLs cannot contain the ARN.
data DeleteKnowledgeBaseResponse Source #
See: newDeleteKnowledgeBaseResponse
smart constructor.
Instances
newDeleteKnowledgeBaseResponse Source #
Create a value of DeleteKnowledgeBaseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteKnowledgeBaseResponse'
, deleteKnowledgeBaseResponse_httpStatus
- The response's http status code.
CreateAssistantAssociation
data CreateAssistantAssociation Source #
See: newCreateAssistantAssociation
smart constructor.
CreateAssistantAssociation' (Maybe Text) (Maybe (HashMap Text Text)) Text AssistantAssociationInputData AssociationType |
Instances
newCreateAssistantAssociation Source #
Create a value of CreateAssistantAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateAssistantAssociation'
, createAssistantAssociation_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:tags:CreateAssistantAssociation'
, createAssistantAssociation_tags
- The tags used to organize, track, or control access for this resource.
$sel:assistantId:CreateAssistantAssociation'
, createAssistantAssociation_assistantId
- The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
$sel:association:CreateAssistantAssociation'
, createAssistantAssociation_association
- The identifier of the associated resource.
$sel:associationType:CreateAssistantAssociation'
, createAssistantAssociation_associationType
- The type of association.
data CreateAssistantAssociationResponse Source #
See: newCreateAssistantAssociationResponse
smart constructor.
Instances
Eq CreateAssistantAssociationResponse Source # | |
Read CreateAssistantAssociationResponse Source # | |
Show CreateAssistantAssociationResponse Source # | |
Generic CreateAssistantAssociationResponse Source # | |
NFData CreateAssistantAssociationResponse Source # | |
Defined in Amazonka.Wisdom.CreateAssistantAssociation rnf :: CreateAssistantAssociationResponse -> () # | |
type Rep CreateAssistantAssociationResponse Source # | |
Defined in Amazonka.Wisdom.CreateAssistantAssociation type Rep CreateAssistantAssociationResponse = D1 ('MetaData "CreateAssistantAssociationResponse" "Amazonka.Wisdom.CreateAssistantAssociation" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "CreateAssistantAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assistantAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssistantAssociationData)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateAssistantAssociationResponse Source #
Create a value of CreateAssistantAssociationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantAssociation:CreateAssistantAssociationResponse'
, createAssistantAssociationResponse_assistantAssociation
- The assistant association.
$sel:httpStatus:CreateAssistantAssociationResponse'
, createAssistantAssociationResponse_httpStatus
- The response's http status code.
GetKnowledgeBase
data GetKnowledgeBase Source #
See: newGetKnowledgeBase
smart constructor.
Instances
Create a value of GetKnowledgeBase
with all optional fields omitted.
Use 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:GetKnowledgeBase'
, getKnowledgeBase_knowledgeBaseId
- The the identifier of the knowledge base. Can be either the ID or the
ARN. URLs cannot contain the ARN.
data GetKnowledgeBaseResponse Source #
See: newGetKnowledgeBaseResponse
smart constructor.
Instances
newGetKnowledgeBaseResponse Source #
Create a value of GetKnowledgeBaseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:knowledgeBase:GetKnowledgeBaseResponse'
, getKnowledgeBaseResponse_knowledgeBase
- The knowledge base.
$sel:httpStatus:GetKnowledgeBaseResponse'
, getKnowledgeBaseResponse_httpStatus
- The response's http status code.
Types
AssistantStatus
newtype AssistantStatus Source #
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 #
pattern AssistantType_AGENT :: AssistantType |
Instances
AssociationType
newtype AssociationType Source #
pattern AssociationType_KNOWLEDGE_BASE :: AssociationType |
Instances
ContentStatus
newtype ContentStatus Source #
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 #
pattern FilterField_NAME :: FilterField |
Instances
FilterOperator
newtype FilterOperator Source #
pattern FilterOperator_EQUALS :: FilterOperator |
Instances
KnowledgeBaseStatus
newtype KnowledgeBaseStatus Source #
Instances
KnowledgeBaseType
newtype KnowledgeBaseType Source #
pattern KnowledgeBaseType_CUSTOM :: KnowledgeBaseType | |
pattern KnowledgeBaseType_EXTERNAL :: KnowledgeBaseType |
Instances
RelevanceLevel
newtype RelevanceLevel Source #
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.
Instances
newAppIntegrationsConfiguration Source #
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.
AssistantAssociationData
data AssistantAssociationData Source #
Information about the assistant association.
See: newAssistantAssociationData
smart constructor.
AssistantAssociationData' (Maybe (HashMap Text Text)) Text Text Text Text AssistantAssociationOutputData AssociationType |
Instances
newAssistantAssociationData Source #
:: 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.
AssistantAssociationInputData
data AssistantAssociationInputData Source #
The data that is input into Wisdom as a result of the assistant association.
See: newAssistantAssociationInputData
smart constructor.
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.
AssistantAssociationOutputData
data AssistantAssociationOutputData Source #
The data that is output as a result of the assistant association.
See: newAssistantAssociationOutputData
smart constructor.
Instances
Eq AssistantAssociationOutputData Source # | |
Read AssistantAssociationOutputData Source # | |
Show AssistantAssociationOutputData Source # | |
Generic AssistantAssociationOutputData Source # | |
NFData AssistantAssociationOutputData Source # | |
Defined in Amazonka.Wisdom.Types.AssistantAssociationOutputData rnf :: AssistantAssociationOutputData -> () # | |
Hashable AssistantAssociationOutputData Source # | |
FromJSON AssistantAssociationOutputData Source # | |
type Rep AssistantAssociationOutputData Source # | |
Defined in Amazonka.Wisdom.Types.AssistantAssociationOutputData type Rep AssistantAssociationOutputData = D1 ('MetaData "AssistantAssociationOutputData" "Amazonka.Wisdom.Types.AssistantAssociationOutputData" "libZSservicesZSamazonka-wisdomZSamazonka-wisdom" 'False) (C1 ('MetaCons "AssistantAssociationOutputData'" 'PrefixI 'True) (S1 ('MetaSel ('Just "knowledgeBaseAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KnowledgeBaseAssociationData)))) |
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.
AssistantAssociationSummary
data AssistantAssociationSummary Source #
Summary information about the assistant association.
See: newAssistantAssociationSummary
smart constructor.
AssistantAssociationSummary' (Maybe (HashMap Text Text)) Text Text Text Text AssistantAssociationOutputData AssociationType |
Instances
newAssistantAssociationSummary Source #
:: 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.
AssistantData
data AssistantData Source #
The assistant data.
See: newAssistantData
smart constructor.
AssistantData' (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text Text Text AssistantStatus AssistantType |
Instances
:: 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.
AssistantSummary
data AssistantSummary Source #
Summary information about the assistant.
See: newAssistantSummary
smart constructor.
AssistantSummary' (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text Text Text AssistantStatus AssistantType |
Instances
:: 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.
ContentData
data ContentData Source #
Information about the content.
See: newContentData
smart constructor.
ContentData' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text Text Text (HashMap Text Text) Text Text ContentStatus Text (Sensitive Text) POSIX |
Instances
:: 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.
ContentReference
data ContentReference Source #
Reference information about the content.
See: newContentReference
smart constructor.
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.
ContentSummary
data ContentSummary Source #
Summary information about the content.
See: newContentSummary
smart constructor.
ContentSummary' (Maybe (HashMap Text Text)) Text Text Text Text Text (HashMap Text Text) Text Text ContentStatus Text |
Instances
:: 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.
Document
The document.
See: newDocument
smart constructor.
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)))) |
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.
DocumentText
data DocumentText Source #
The text of the document.
See: newDocumentText
smart constructor.
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.
Filter
A search filter.
See: newFilter
smart constructor.
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)))) |
:: 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.
Highlight
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
See: newHighlight
smart constructor.
Highlight' (Maybe Int) (Maybe Int) |
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.
KnowledgeBaseAssociationData
data KnowledgeBaseAssociationData Source #
Association information about the knowledge base.
See: newKnowledgeBaseAssociationData
smart constructor.
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.
KnowledgeBaseData
data KnowledgeBaseData Source #
Information about the knowledge base.
See: newKnowledgeBaseData
smart constructor.
Instances
:: 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.
KnowledgeBaseSummary
data KnowledgeBaseSummary Source #
Summary information about the knowledge base.
See: newKnowledgeBaseSummary
smart constructor.
Instances
newKnowledgeBaseSummary Source #
:: 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.
NotifyRecommendationsReceivedError
data NotifyRecommendationsReceivedError Source #
An error occurred when creating a recommendation.
See: newNotifyRecommendationsReceivedError
smart constructor.
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.
RecommendationData
data RecommendationData Source #
Information about the recommendation.
See: newRecommendationData
smart constructor.
Instances
newRecommendationData Source #
:: 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.
RenderingConfiguration
data RenderingConfiguration Source #
Information about how to render the content.
See: newRenderingConfiguration
smart constructor.
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>
ResultData
data ResultData Source #
Information about the result.
See: newResultData
smart constructor.
Instances
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.
SearchExpression
data SearchExpression Source #
The search expression.
See: newSearchExpression
smart constructor.
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.
ServerSideEncryptionConfiguration
data ServerSideEncryptionConfiguration Source #
The KMS key used for encryption.
See: newServerSideEncryptionConfiguration
smart constructor.
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.
SessionData
data SessionData Source #
Information about the session.
See: newSessionData
smart constructor.
Instances
:: 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.
SessionSummary
data SessionSummary Source #
Summary information about the session.
See: newSessionSummary
smart constructor.
Instances
:: 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.
SourceConfiguration
data SourceConfiguration Source #
Configuration information about the external data source.
See: newSourceConfiguration
smart constructor.
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.