| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Wisdom
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CreateAssistant
- CreateAssistantAssociation
- CreateContent
- CreateKnowledgeBase
- CreateSession
- DeleteAssistant
- DeleteAssistantAssociation
- DeleteContent
- DeleteKnowledgeBase
- GetAssistant
- GetAssistantAssociation
- GetContent
- GetContentSummary
- GetKnowledgeBase
- GetRecommendations
- GetSession
- ListAssistantAssociations (Paginated)
- ListAssistants (Paginated)
- ListContents (Paginated)
- ListKnowledgeBases (Paginated)
- ListTagsForResource
- NotifyRecommendationsReceived
- QueryAssistant (Paginated)
- RemoveKnowledgeBaseTemplateUri
- SearchContent (Paginated)
- SearchSessions (Paginated)
- StartContentUpload
- TagResource
- UntagResource
- UpdateContent
- UpdateKnowledgeBaseTemplateUri
- Types
- AssistantStatus
- AssistantType
- AssociationType
- ContentStatus
- FilterField
- FilterOperator
- KnowledgeBaseStatus
- KnowledgeBaseType
- RecommendationSourceType
- RecommendationTriggerType
- RecommendationType
- RelevanceLevel
- AppIntegrationsConfiguration
- AssistantAssociationData
- AssistantAssociationInputData
- AssistantAssociationOutputData
- AssistantAssociationSummary
- AssistantData
- AssistantSummary
- ContentData
- ContentReference
- ContentSummary
- Document
- DocumentText
- Filter
- Highlight
- KnowledgeBaseAssociationData
- KnowledgeBaseData
- KnowledgeBaseSummary
- NotifyRecommendationsReceivedError
- QueryRecommendationTriggerData
- RecommendationData
- RecommendationTrigger
- RecommendationTriggerData
- RenderingConfiguration
- ResultData
- SearchExpression
- ServerSideEncryptionConfiguration
- SessionData
- SessionSummary
- SourceConfiguration
Description
Derived from API version 2020-10-19 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use the Amazon Connect Wisdom APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _PreconditionFailedException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- 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 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 CreateContent = CreateContent' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text
- newCreateContent :: Text -> Text -> Text -> CreateContent
- data CreateContentResponse = CreateContentResponse' (Maybe ContentData) Int
- newCreateContentResponse :: Int -> CreateContentResponse
- data CreateKnowledgeBase = CreateKnowledgeBase' (Maybe Text) (Maybe Text) (Maybe RenderingConfiguration) (Maybe ServerSideEncryptionConfiguration) (Maybe SourceConfiguration) (Maybe (HashMap Text Text)) KnowledgeBaseType Text
- newCreateKnowledgeBase :: KnowledgeBaseType -> Text -> CreateKnowledgeBase
- data CreateKnowledgeBaseResponse = CreateKnowledgeBaseResponse' (Maybe KnowledgeBaseData) Int
- newCreateKnowledgeBaseResponse :: Int -> CreateKnowledgeBaseResponse
- 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 DeleteAssistant = DeleteAssistant' Text
- newDeleteAssistant :: Text -> DeleteAssistant
- data DeleteAssistantResponse = DeleteAssistantResponse' Int
- newDeleteAssistantResponse :: Int -> DeleteAssistantResponse
- data DeleteAssistantAssociation = DeleteAssistantAssociation' Text Text
- newDeleteAssistantAssociation :: Text -> Text -> DeleteAssistantAssociation
- data DeleteAssistantAssociationResponse = DeleteAssistantAssociationResponse' Int
- newDeleteAssistantAssociationResponse :: Int -> DeleteAssistantAssociationResponse
- data DeleteContent = DeleteContent' Text Text
- newDeleteContent :: Text -> Text -> DeleteContent
- data DeleteContentResponse = DeleteContentResponse' Int
- newDeleteContentResponse :: Int -> DeleteContentResponse
- data DeleteKnowledgeBase = DeleteKnowledgeBase' Text
- newDeleteKnowledgeBase :: Text -> DeleteKnowledgeBase
- data DeleteKnowledgeBaseResponse = DeleteKnowledgeBaseResponse' Int
- newDeleteKnowledgeBaseResponse :: Int -> DeleteKnowledgeBaseResponse
- data GetAssistant = GetAssistant' Text
- newGetAssistant :: Text -> GetAssistant
- data GetAssistantResponse = GetAssistantResponse' (Maybe AssistantData) Int
- newGetAssistantResponse :: Int -> GetAssistantResponse
- data GetAssistantAssociation = GetAssistantAssociation' Text Text
- newGetAssistantAssociation :: Text -> Text -> GetAssistantAssociation
- data GetAssistantAssociationResponse = GetAssistantAssociationResponse' (Maybe AssistantAssociationData) Int
- newGetAssistantAssociationResponse :: Int -> GetAssistantAssociationResponse
- data GetContent = GetContent' Text Text
- newGetContent :: Text -> Text -> GetContent
- data GetContentResponse = GetContentResponse' (Maybe ContentData) Int
- newGetContentResponse :: Int -> GetContentResponse
- data GetContentSummary = GetContentSummary' Text Text
- newGetContentSummary :: Text -> Text -> GetContentSummary
- data GetContentSummaryResponse = GetContentSummaryResponse' (Maybe ContentSummary) Int
- newGetContentSummaryResponse :: Int -> GetContentSummaryResponse
- data GetKnowledgeBase = GetKnowledgeBase' Text
- newGetKnowledgeBase :: Text -> GetKnowledgeBase
- data GetKnowledgeBaseResponse = GetKnowledgeBaseResponse' (Maybe KnowledgeBaseData) Int
- newGetKnowledgeBaseResponse :: Int -> GetKnowledgeBaseResponse
- data GetRecommendations = GetRecommendations' (Maybe Natural) (Maybe Natural) Text Text
- newGetRecommendations :: Text -> Text -> GetRecommendations
- data GetRecommendationsResponse = GetRecommendationsResponse' (Maybe [RecommendationTrigger]) Int [RecommendationData]
- newGetRecommendationsResponse :: Int -> GetRecommendationsResponse
- data GetSession = GetSession' Text Text
- newGetSession :: Text -> Text -> GetSession
- data GetSessionResponse = GetSessionResponse' (Maybe SessionData) Int
- newGetSessionResponse :: Int -> GetSessionResponse
- data ListAssistantAssociations = ListAssistantAssociations' (Maybe Natural) (Maybe Text) Text
- newListAssistantAssociations :: Text -> ListAssistantAssociations
- data ListAssistantAssociationsResponse = ListAssistantAssociationsResponse' (Maybe Text) Int [AssistantAssociationSummary]
- newListAssistantAssociationsResponse :: Int -> ListAssistantAssociationsResponse
- data ListAssistants = ListAssistants' (Maybe Natural) (Maybe Text)
- newListAssistants :: ListAssistants
- data ListAssistantsResponse = ListAssistantsResponse' (Maybe Text) Int [AssistantSummary]
- newListAssistantsResponse :: Int -> ListAssistantsResponse
- data ListContents = ListContents' (Maybe Natural) (Maybe Text) Text
- newListContents :: Text -> ListContents
- data ListContentsResponse = ListContentsResponse' (Maybe Text) Int [ContentSummary]
- newListContentsResponse :: Int -> ListContentsResponse
- data ListKnowledgeBases = ListKnowledgeBases' (Maybe Natural) (Maybe Text)
- newListKnowledgeBases :: ListKnowledgeBases
- data ListKnowledgeBasesResponse = ListKnowledgeBasesResponse' (Maybe Text) Int [KnowledgeBaseSummary]
- newListKnowledgeBasesResponse :: Int -> ListKnowledgeBasesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data NotifyRecommendationsReceived = NotifyRecommendationsReceived' Text [Text] Text
- newNotifyRecommendationsReceived :: Text -> Text -> NotifyRecommendationsReceived
- data NotifyRecommendationsReceivedResponse = NotifyRecommendationsReceivedResponse' (Maybe [NotifyRecommendationsReceivedError]) (Maybe [Text]) Int
- newNotifyRecommendationsReceivedResponse :: Int -> NotifyRecommendationsReceivedResponse
- data QueryAssistant = QueryAssistant' (Maybe Natural) (Maybe Text) Text (Sensitive Text)
- newQueryAssistant :: Text -> Text -> QueryAssistant
- data QueryAssistantResponse = QueryAssistantResponse' (Maybe Text) Int [ResultData]
- newQueryAssistantResponse :: Int -> QueryAssistantResponse
- data RemoveKnowledgeBaseTemplateUri = RemoveKnowledgeBaseTemplateUri' Text
- newRemoveKnowledgeBaseTemplateUri :: Text -> RemoveKnowledgeBaseTemplateUri
- data RemoveKnowledgeBaseTemplateUriResponse = RemoveKnowledgeBaseTemplateUriResponse' Int
- newRemoveKnowledgeBaseTemplateUriResponse :: Int -> RemoveKnowledgeBaseTemplateUriResponse
- data SearchContent = SearchContent' (Maybe Natural) (Maybe Text) Text SearchExpression
- newSearchContent :: Text -> SearchExpression -> SearchContent
- data SearchContentResponse = SearchContentResponse' (Maybe Text) Int [ContentSummary]
- newSearchContentResponse :: Int -> SearchContentResponse
- data SearchSessions = SearchSessions' (Maybe Natural) (Maybe Text) Text SearchExpression
- newSearchSessions :: Text -> SearchExpression -> SearchSessions
- data SearchSessionsResponse = SearchSessionsResponse' (Maybe Text) Int [SessionSummary]
- newSearchSessionsResponse :: Int -> SearchSessionsResponse
- 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 TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateContent = UpdateContent' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newUpdateContent :: Text -> Text -> UpdateContent
- data UpdateContentResponse = UpdateContentResponse' (Maybe ContentData) Int
- newUpdateContentResponse :: Int -> UpdateContentResponse
- data UpdateKnowledgeBaseTemplateUri = UpdateKnowledgeBaseTemplateUri' Text Text
- newUpdateKnowledgeBaseTemplateUri :: Text -> Text -> UpdateKnowledgeBaseTemplateUri
- data UpdateKnowledgeBaseTemplateUriResponse = UpdateKnowledgeBaseTemplateUriResponse' (Maybe KnowledgeBaseData) Int
- newUpdateKnowledgeBaseTemplateUriResponse :: Int -> UpdateKnowledgeBaseTemplateUriResponse
- 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 RecommendationSourceType where
- newtype RecommendationTriggerType where
- newtype RecommendationType where
- 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 [Highlight]) (Maybe (Sensitive Text))
- 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 Text) (Maybe POSIX) (Maybe RenderingConfiguration) (Maybe ServerSideEncryptionConfiguration) (Maybe SourceConfiguration) (Maybe (HashMap Text Text)) Text Text KnowledgeBaseType Text KnowledgeBaseStatus
- newKnowledgeBaseData :: Text -> Text -> KnowledgeBaseType -> Text -> KnowledgeBaseStatus -> KnowledgeBaseData
- data KnowledgeBaseSummary = KnowledgeBaseSummary' (Maybe Text) (Maybe RenderingConfiguration) (Maybe ServerSideEncryptionConfiguration) (Maybe SourceConfiguration) (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 QueryRecommendationTriggerData = QueryRecommendationTriggerData' (Maybe (Sensitive Text))
- newQueryRecommendationTriggerData :: QueryRecommendationTriggerData
- data RecommendationData = RecommendationData' (Maybe RelevanceLevel) (Maybe Double) (Maybe RecommendationType) Document Text
- newRecommendationData :: Document -> Text -> RecommendationData
- data RecommendationTrigger = RecommendationTrigger' RecommendationTriggerData Text [Text] RecommendationSourceType RecommendationTriggerType
- newRecommendationTrigger :: RecommendationTriggerData -> Text -> RecommendationSourceType -> RecommendationTriggerType -> RecommendationTrigger
- data RecommendationTriggerData = RecommendationTriggerData' (Maybe QueryRecommendationTriggerData)
- newRecommendationTriggerData :: RecommendationTriggerData
- 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.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold 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.
PreconditionFailedException
_PreconditionFailedException :: AsError a => Fold a ServiceError Source #
The provided revisionId does not match, indicating the content has
been modified since it was last read.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource does not exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold 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.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by a service.
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.
CreateAssistant
data CreateAssistant Source #
See: newCreateAssistant smart constructor.
Constructors
| CreateAssistant' (Maybe Text) (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text AssistantType |
Instances
Arguments
| :: Text | |
| -> AssistantType | |
| -> CreateAssistant |
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.
CreateAssistant, createAssistant_description - The description of the assistant.
CreateAssistant, createAssistant_serverSideEncryptionConfiguration - The KMS key used for encryption.
CreateAssistant, createAssistant_tags - The tags used to organize, track, or control access for this resource.
CreateAssistant, createAssistant_name - The name of the assistant.
CreateAssistant, createAssistant_type - The type of assistant.
data CreateAssistantResponse Source #
See: newCreateAssistantResponse smart constructor.
Constructors
| CreateAssistantResponse' (Maybe AssistantData) Int |
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.
CreateAssistantAssociation
data CreateAssistantAssociation Source #
See: newCreateAssistantAssociation smart constructor.
Constructors
| CreateAssistantAssociation' (Maybe Text) (Maybe (HashMap Text Text)) Text AssistantAssociationInputData AssociationType |
Instances
newCreateAssistantAssociation Source #
Arguments
| :: Text | |
| -> AssistantAssociationInputData | |
| -> AssociationType | |
| -> CreateAssistantAssociation |
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.
CreateAssistantAssociation, createAssistantAssociation_tags - The tags used to organize, track, or control access for this resource.
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.
CreateAssistantAssociation, createAssistantAssociation_associationType - The type of association.
data CreateAssistantAssociationResponse Source #
See: newCreateAssistantAssociationResponse smart constructor.
Constructors
| CreateAssistantAssociationResponse' (Maybe AssistantAssociationData) Int |
Instances
newCreateAssistantAssociationResponse Source #
Arguments
| :: Int | |
| -> CreateAssistantAssociationResponse |
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.
CreateContent
data CreateContent Source #
See: newCreateContent smart constructor.
Constructors
| CreateContent' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text |
Instances
Arguments
| :: 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:clientToken:CreateContent', createContent_clientToken - A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
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: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.
CreateContent, createContent_tags - The tags used to organize, track, or control access for this resource.
CreateContent, createContent_title - The title of the content. If not set, the title is equal to the name.
CreateContent, createContent_knowledgeBaseId - The identifier of the knowledge base. Can be either the ID or the ARN.
URLs cannot contain the ARN.
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.
Constructors
| CreateContentResponse' (Maybe ContentData) Int |
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.
CreateKnowledgeBase
data CreateKnowledgeBase Source #
See: newCreateKnowledgeBase smart constructor.
Constructors
| CreateKnowledgeBase' (Maybe Text) (Maybe Text) (Maybe RenderingConfiguration) (Maybe ServerSideEncryptionConfiguration) (Maybe SourceConfiguration) (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.
CreateKnowledgeBase, createKnowledgeBase_description - The description.
CreateKnowledgeBase, createKnowledgeBase_renderingConfiguration - Information about how to render the content.
CreateKnowledgeBase, createKnowledgeBase_serverSideEncryptionConfiguration - The KMS key used for encryption.
CreateKnowledgeBase, createKnowledgeBase_sourceConfiguration - The source of the knowledge base content. Only set this argument for
EXTERNAL knowledge bases.
CreateKnowledgeBase, createKnowledgeBase_tags - The tags used to organize, track, or control access for this resource.
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.
CreateKnowledgeBase, createKnowledgeBase_name - The name of the knowledge base.
data CreateKnowledgeBaseResponse Source #
See: newCreateKnowledgeBaseResponse smart constructor.
Constructors
| CreateKnowledgeBaseResponse' (Maybe KnowledgeBaseData) Int |
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.
CreateSession
data CreateSession Source #
See: newCreateSession smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateSession |
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.
CreateSession, createSession_description - The description.
CreateSession, createSession_tags - The tags used to organize, track, or control access for this resource.
CreateSession, createSession_assistantId - The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
CreateSession, createSession_name - The name of the session.
data CreateSessionResponse Source #
See: newCreateSessionResponse smart constructor.
Constructors
| CreateSessionResponse' (Maybe SessionData) Int |
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.
DeleteAssistant
data DeleteAssistant Source #
See: newDeleteAssistant smart constructor.
Constructors
| DeleteAssistant' Text |
Instances
Arguments
| :: Text | |
| -> DeleteAssistant |
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:
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.
Constructors
| DeleteAssistantResponse' Int |
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.
DeleteAssistantAssociation
data DeleteAssistantAssociation Source #
See: newDeleteAssistantAssociation smart constructor.
Constructors
| DeleteAssistantAssociation' Text Text |
Instances
newDeleteAssistantAssociation Source #
Arguments
| :: 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:
DeleteAssistantAssociation, deleteAssistantAssociation_assistantAssociationId - The identifier of the assistant association. Can be either the ID or the
ARN. URLs cannot contain the ARN.
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.
Constructors
| DeleteAssistantAssociationResponse' Int |
Instances
newDeleteAssistantAssociationResponse Source #
Arguments
| :: Int | |
| -> DeleteAssistantAssociationResponse |
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.
DeleteContent
data DeleteContent Source #
See: newDeleteContent smart constructor.
Constructors
| DeleteContent' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteContent |
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:
DeleteContent, deleteContent_contentId - The identifier of the content. Can be either the ID or the ARN. URLs
cannot contain the ARN.
DeleteContent, deleteContent_knowledgeBaseId - 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.
Constructors
| DeleteContentResponse' Int |
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.
DeleteKnowledgeBase
data DeleteKnowledgeBase Source #
See: newDeleteKnowledgeBase smart constructor.
Constructors
| DeleteKnowledgeBase' Text |
Instances
newDeleteKnowledgeBase Source #
Arguments
| :: Text | |
| -> DeleteKnowledgeBase |
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:
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.
Constructors
| DeleteKnowledgeBaseResponse' Int |
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.
GetAssistant
data GetAssistant Source #
See: newGetAssistant smart constructor.
Constructors
| GetAssistant' Text |
Instances
Arguments
| :: Text | |
| -> GetAssistant |
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:
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.
Constructors
| GetAssistantResponse' (Maybe AssistantData) Int |
Instances
newGetAssistantResponse Source #
Arguments
| :: Int | |
| -> GetAssistantResponse |
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.
GetAssistantAssociation
data GetAssistantAssociation Source #
See: newGetAssistantAssociation smart constructor.
Constructors
| GetAssistantAssociation' Text Text |
Instances
newGetAssistantAssociation Source #
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:
GetAssistantAssociation, getAssistantAssociation_assistantAssociationId - The identifier of the assistant association. Can be either the ID or the
ARN. URLs cannot contain the ARN.
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.
Constructors
| GetAssistantAssociationResponse' (Maybe AssistantAssociationData) Int |
Instances
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.
GetContent
data GetContent Source #
See: newGetContent smart constructor.
Constructors
| GetContent' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetContent |
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:
GetContent, getContent_contentId - The identifier of the content. Can be either the ID or the ARN. URLs
cannot contain the ARN.
GetContent, getContent_knowledgeBaseId - 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.
Constructors
| GetContentResponse' (Maybe ContentData) Int |
Instances
newGetContentResponse Source #
Arguments
| :: Int | |
| -> GetContentResponse |
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.
GetContentSummary
data GetContentSummary Source #
See: newGetContentSummary smart constructor.
Constructors
| GetContentSummary' Text Text |
Instances
Arguments
| :: 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:
GetContentSummary, getContentSummary_contentId - The identifier of the content. Can be either the ID or the ARN. URLs
cannot contain the ARN.
GetContentSummary, getContentSummary_knowledgeBaseId - 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.
Constructors
| GetContentSummaryResponse' (Maybe ContentSummary) Int |
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.
GetKnowledgeBase
data GetKnowledgeBase Source #
See: newGetKnowledgeBase smart constructor.
Constructors
| GetKnowledgeBase' Text |
Instances
Arguments
| :: Text | |
| -> GetKnowledgeBase |
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:
GetKnowledgeBase, getKnowledgeBase_knowledgeBaseId - 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.
Constructors
| GetKnowledgeBaseResponse' (Maybe KnowledgeBaseData) Int |
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.
GetRecommendations
data GetRecommendations Source #
See: newGetRecommendations smart constructor.
Instances
newGetRecommendations Source #
Arguments
| :: 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:maxResults:GetRecommendations', getRecommendations_maxResults - The maximum number of results to return per page.
$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.
GetRecommendations, getRecommendations_assistantId - The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
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.
Constructors
| GetRecommendationsResponse' (Maybe [RecommendationTrigger]) Int [RecommendationData] |
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:triggers:GetRecommendationsResponse', getRecommendationsResponse_triggers - The triggers corresponding to recommendations.
$sel:httpStatus:GetRecommendationsResponse', getRecommendationsResponse_httpStatus - The response's http status code.
$sel:recommendations:GetRecommendationsResponse', getRecommendationsResponse_recommendations - The recommendations.
GetSession
data GetSession Source #
See: newGetSession smart constructor.
Constructors
| GetSession' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetSession |
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:
GetSession, getSession_assistantId - The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
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.
Constructors
| GetSessionResponse' (Maybe SessionData) Int |
Instances
newGetSessionResponse Source #
Arguments
| :: Int | |
| -> GetSessionResponse |
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.
ListAssistantAssociations (Paginated)
data ListAssistantAssociations Source #
See: newListAssistantAssociations smart constructor.
Instances
newListAssistantAssociations Source #
Arguments
| :: Text | |
| -> ListAssistantAssociations |
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:maxResults:ListAssistantAssociations', listAssistantAssociations_maxResults - The maximum number of results to return per page.
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.
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.
Constructors
| ListAssistantAssociationsResponse' (Maybe Text) Int [AssistantAssociationSummary] |
Instances
newListAssistantAssociationsResponse Source #
Arguments
| :: Int | |
| -> ListAssistantAssociationsResponse |
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:
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.
ListAssistants (Paginated)
data ListAssistants Source #
See: newListAssistants smart constructor.
Constructors
| ListAssistants' (Maybe Natural) (Maybe Text) |
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:maxResults:ListAssistants', listAssistants_maxResults - The maximum number of results to return per page.
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.
data ListAssistantsResponse Source #
See: newListAssistantsResponse smart constructor.
Constructors
| ListAssistantsResponse' (Maybe Text) Int [AssistantSummary] |
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:
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.
ListContents (Paginated)
data ListContents Source #
See: newListContents smart constructor.
Instances
Arguments
| :: Text | |
| -> ListContents |
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:maxResults:ListContents', listContents_maxResults - The maximum number of results to return per page.
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.
ListContents, listContents_knowledgeBaseId - 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.
Constructors
| ListContentsResponse' (Maybe Text) Int [ContentSummary] |
Instances
newListContentsResponse Source #
Arguments
| :: Int | |
| -> ListContentsResponse |
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:
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.
ListKnowledgeBases (Paginated)
data ListKnowledgeBases Source #
See: newListKnowledgeBases smart constructor.
Constructors
| ListKnowledgeBases' (Maybe Natural) (Maybe Text) |
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:maxResults:ListKnowledgeBases', listKnowledgeBases_maxResults - The maximum number of results to return per page.
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.
data ListKnowledgeBasesResponse Source #
See: newListKnowledgeBasesResponse smart constructor.
Constructors
| ListKnowledgeBasesResponse' (Maybe Text) Int [KnowledgeBaseSummary] |
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:
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.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
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:
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.
NotifyRecommendationsReceived
data NotifyRecommendationsReceived Source #
See: newNotifyRecommendationsReceived smart constructor.
Constructors
| NotifyRecommendationsReceived' Text [Text] Text |
Instances
newNotifyRecommendationsReceived Source #
Arguments
| :: Text | |
| -> Text | |
| -> NotifyRecommendationsReceived |
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:
NotifyRecommendationsReceived, notifyRecommendationsReceived_assistantId - The identifier of the Wisdom assistant. Can be either the ID or the ARN.
URLs cannot contain the ARN.
NotifyRecommendationsReceived, notifyRecommendationsReceived_recommendationIds - The identifiers of the recommendations.
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.
Constructors
| NotifyRecommendationsReceivedResponse' (Maybe [NotifyRecommendationsReceivedError]) (Maybe [Text]) Int |
Instances
newNotifyRecommendationsReceivedResponse Source #
Arguments
| :: Int | |
| -> NotifyRecommendationsReceivedResponse |
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:errors:NotifyRecommendationsReceivedResponse', notifyRecommendationsReceivedResponse_errors - The identifiers of recommendations that are causing errors.
NotifyRecommendationsReceived, notifyRecommendationsReceivedResponse_recommendationIds - The identifiers of the recommendations.
$sel:httpStatus:NotifyRecommendationsReceivedResponse', notifyRecommendationsReceivedResponse_httpStatus - The response's http status code.
QueryAssistant (Paginated)
data QueryAssistant Source #
See: newQueryAssistant smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> QueryAssistant |
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:maxResults:QueryAssistant', queryAssistant_maxResults - The maximum number of results to return per page.
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.
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.
Constructors
| QueryAssistantResponse' (Maybe Text) Int [ResultData] |
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:
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.
RemoveKnowledgeBaseTemplateUri
data RemoveKnowledgeBaseTemplateUri Source #
See: newRemoveKnowledgeBaseTemplateUri smart constructor.
Constructors
| RemoveKnowledgeBaseTemplateUri' Text |
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:
RemoveKnowledgeBaseTemplateUri, removeKnowledgeBaseTemplateUri_knowledgeBaseId - 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.
Constructors
| RemoveKnowledgeBaseTemplateUriResponse' Int |
Instances
newRemoveKnowledgeBaseTemplateUriResponse Source #
Arguments
| :: Int | |
| -> RemoveKnowledgeBaseTemplateUriResponse |
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.
SearchContent (Paginated)
data SearchContent Source #
See: newSearchContent smart constructor.
Constructors
| SearchContent' (Maybe Natural) (Maybe Text) Text SearchExpression |
Instances
Arguments
| :: 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:maxResults:SearchContent', searchContent_maxResults - The maximum number of results to return per page.
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.
SearchContent, searchContent_knowledgeBaseId - 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.
Constructors
| SearchContentResponse' (Maybe Text) Int [ContentSummary] |
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:
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.
SearchSessions (Paginated)
data SearchSessions Source #
See: newSearchSessions smart constructor.
Constructors
| SearchSessions' (Maybe Natural) (Maybe Text) Text SearchExpression |
Instances
Arguments
| :: 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:maxResults:SearchSessions', searchSessions_maxResults - The maximum number of results to return per page.
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.
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.
Constructors
| SearchSessionsResponse' (Maybe Text) Int [SessionSummary] |
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:
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.
StartContentUpload
data StartContentUpload Source #
See: newStartContentUpload smart constructor.
Constructors
| StartContentUpload' Text Text |
Instances
newStartContentUpload Source #
Arguments
| :: 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:
StartContentUpload, startContentUpload_contentType - The type of content to upload.
StartContentUpload, startContentUpload_knowledgeBaseId - 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 #
Arguments
| :: 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.
StartContentUploadResponse, startContentUploadResponse_url - The URL of the upload.
StartContentUploadResponse, startContentUploadResponse_urlExpiry - The expiration time of the URL as an epoch timestamp.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
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.
TagResource, tagResource_tags - The tags used to organize, track, or control access for this resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
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.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
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.
Constructors
| UntagResourceResponse' Int |
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.
UpdateContent
data UpdateContent Source #
See: newUpdateContent smart constructor.
Constructors
| UpdateContent' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateContent |
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:
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: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.
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.
UpdateContent, updateContent_title - The title of the content.
$sel:uploadId:UpdateContent', updateContent_uploadId - A pointer to the uploaded asset. This value is returned by
StartContentUpload.
UpdateContent, updateContent_contentId - The identifier of the content. Can be either the ID or the ARN. URLs
cannot contain the ARN.
UpdateContent, updateContent_knowledgeBaseId - The identifier of the knowledge base. Can be either the ID or the ARN
data UpdateContentResponse Source #
See: newUpdateContentResponse smart constructor.
Constructors
| UpdateContentResponse' (Maybe ContentData) Int |
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.
UpdateKnowledgeBaseTemplateUri
data UpdateKnowledgeBaseTemplateUri Source #
See: newUpdateKnowledgeBaseTemplateUri smart constructor.
Constructors
| UpdateKnowledgeBaseTemplateUri' Text Text |
Instances
newUpdateKnowledgeBaseTemplateUri Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateKnowledgeBaseTemplateUri |
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:
UpdateKnowledgeBaseTemplateUri, updateKnowledgeBaseTemplateUri_knowledgeBaseId - The identifier of the knowledge base. Can be either the ID or the ARN.
URLs cannot contain the ARN.
UpdateKnowledgeBaseTemplateUri, updateKnowledgeBaseTemplateUri_templateUri - The template URI to update.
data UpdateKnowledgeBaseTemplateUriResponse Source #
See: newUpdateKnowledgeBaseTemplateUriResponse smart constructor.
Constructors
| UpdateKnowledgeBaseTemplateUriResponse' (Maybe KnowledgeBaseData) Int |
Instances
newUpdateKnowledgeBaseTemplateUriResponse Source #
Arguments
| :: Int | |
| -> UpdateKnowledgeBaseTemplateUriResponse |
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.
Types
AssistantStatus
newtype AssistantStatus Source #
Constructors
| AssistantStatus' | |
Fields | |
Bundled Patterns
| pattern AssistantStatus_ACTIVE :: AssistantStatus | |
| pattern AssistantStatus_CREATE_FAILED :: AssistantStatus | |
| pattern AssistantStatus_CREATE_IN_PROGRESS :: AssistantStatus | |
| pattern AssistantStatus_DELETED :: AssistantStatus | |
| pattern AssistantStatus_DELETE_FAILED :: AssistantStatus | |
| pattern AssistantStatus_DELETE_IN_PROGRESS :: AssistantStatus |
Instances
AssistantType
newtype AssistantType Source #
Constructors
| AssistantType' | |
Fields | |
Bundled Patterns
| pattern AssistantType_AGENT :: AssistantType |
Instances
AssociationType
newtype AssociationType Source #
Constructors
| AssociationType' | |
Fields | |
Bundled Patterns
| pattern AssociationType_KNOWLEDGE_BASE :: AssociationType |
Instances
ContentStatus
newtype ContentStatus Source #
Constructors
| ContentStatus' | |
Fields | |
Bundled Patterns
| pattern ContentStatus_ACTIVE :: ContentStatus | |
| pattern ContentStatus_CREATE_FAILED :: ContentStatus | |
| pattern ContentStatus_CREATE_IN_PROGRESS :: ContentStatus | |
| pattern ContentStatus_DELETED :: ContentStatus | |
| pattern ContentStatus_DELETE_FAILED :: ContentStatus | |
| pattern ContentStatus_DELETE_IN_PROGRESS :: ContentStatus | |
| pattern ContentStatus_UPDATE_FAILED :: ContentStatus |
Instances
FilterField
newtype FilterField Source #
Constructors
| FilterField' | |
Fields | |
Bundled Patterns
| pattern FilterField_NAME :: FilterField |
Instances
FilterOperator
newtype FilterOperator Source #
Constructors
| FilterOperator' | |
Fields | |
Bundled Patterns
| pattern FilterOperator_EQUALS :: FilterOperator |
Instances
KnowledgeBaseStatus
newtype KnowledgeBaseStatus Source #
Constructors
| KnowledgeBaseStatus' | |
Fields | |
Bundled Patterns
Instances
KnowledgeBaseType
newtype KnowledgeBaseType Source #
Constructors
| KnowledgeBaseType' | |
Fields | |
Bundled Patterns
| pattern KnowledgeBaseType_CUSTOM :: KnowledgeBaseType | |
| pattern KnowledgeBaseType_EXTERNAL :: KnowledgeBaseType |
Instances
RecommendationSourceType
newtype RecommendationSourceType Source #
Constructors
| RecommendationSourceType' | |
Fields | |
Bundled Patterns
Instances
RecommendationTriggerType
newtype RecommendationTriggerType Source #
Constructors
| RecommendationTriggerType' | |
Fields | |
Bundled Patterns
| pattern RecommendationTriggerType_QUERY :: RecommendationTriggerType |
Instances
RecommendationType
newtype RecommendationType Source #
Constructors
| RecommendationType' | |
Fields | |
Bundled Patterns
| pattern RecommendationType_KNOWLEDGE_CONTENT :: RecommendationType |
Instances
RelevanceLevel
newtype RelevanceLevel Source #
Constructors
| RelevanceLevel' | |
Fields | |
Bundled Patterns
| pattern RelevanceLevel_HIGH :: RelevanceLevel | |
| pattern RelevanceLevel_LOW :: RelevanceLevel | |
| pattern RelevanceLevel_MEDIUM :: RelevanceLevel |
Instances
AppIntegrationsConfiguration
data AppIntegrationsConfiguration Source #
Configuration information for Amazon AppIntegrations to automatically ingest content.
See: newAppIntegrationsConfiguration smart constructor.
Constructors
| AppIntegrationsConfiguration' Text (NonEmpty Text) |
Instances
newAppIntegrationsConfiguration Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> AppIntegrationsConfiguration |
Create a value of AppIntegrationsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appIntegrationArn:AppIntegrationsConfiguration', appIntegrationsConfiguration_appIntegrationArn - The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to
use for ingesting content.
$sel:objectFields:AppIntegrationsConfiguration', appIntegrationsConfiguration_objectFields - The fields from the source that are made available to your agents in
Wisdom.
- For
Salesforce,
you must include at least
Id,ArticleNumber,VersionNumber,Title,PublishStatus, andIsDeleted. - For
ServiceNow,
you must include at least
number,short_description,sys_mod_count,workflow_state, andactive.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
AssistantAssociationData
data AssistantAssociationData Source #
Information about the assistant association.
See: newAssistantAssociationData smart constructor.
Constructors
| AssistantAssociationData' (Maybe (HashMap Text Text)) Text Text Text Text AssistantAssociationOutputData AssociationType |
Instances
newAssistantAssociationData Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> AssistantAssociationOutputData | |
| -> AssociationType | |
| -> AssistantAssociationData |
Create a value of AssistantAssociationData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:AssistantAssociationData', assistantAssociationData_tags - The tags used to organize, track, or control access for this resource.
$sel:assistantArn:AssistantAssociationData', assistantAssociationData_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant.
$sel:assistantAssociationArn:AssistantAssociationData', assistantAssociationData_assistantAssociationArn - The Amazon Resource Name (ARN) of the assistant association.
$sel:assistantAssociationId:AssistantAssociationData', assistantAssociationData_assistantAssociationId - The identifier of the assistant association.
$sel:assistantId:AssistantAssociationData', assistantAssociationData_assistantId - The identifier of the Wisdom assistant.
$sel:associationData:AssistantAssociationData', assistantAssociationData_associationData - A union type that currently has a single argument, the knowledge base
ID.
$sel:associationType:AssistantAssociationData', assistantAssociationData_associationType - The type of association.
AssistantAssociationInputData
data AssistantAssociationInputData Source #
The data that is input into Wisdom as a result of the assistant association.
See: newAssistantAssociationInputData smart constructor.
Constructors
| AssistantAssociationInputData' (Maybe Text) |
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 identifier of the knowledge base.
AssistantAssociationOutputData
data AssistantAssociationOutputData Source #
The data that is output as a result of the assistant association.
See: newAssistantAssociationOutputData smart constructor.
Constructors
| AssistantAssociationOutputData' (Maybe KnowledgeBaseAssociationData) |
Instances
newAssistantAssociationOutputData :: AssistantAssociationOutputData Source #
Create a value of AssistantAssociationOutputData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:knowledgeBaseAssociation:AssistantAssociationOutputData', assistantAssociationOutputData_knowledgeBaseAssociation - The knowledge base where output data is sent.
AssistantAssociationSummary
data AssistantAssociationSummary Source #
Summary information about the assistant association.
See: newAssistantAssociationSummary smart constructor.
Constructors
| AssistantAssociationSummary' (Maybe (HashMap Text Text)) Text Text Text Text AssistantAssociationOutputData AssociationType |
Instances
newAssistantAssociationSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> AssistantAssociationOutputData | |
| -> AssociationType | |
| -> AssistantAssociationSummary |
Create a value of AssistantAssociationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:AssistantAssociationSummary', assistantAssociationSummary_tags - The tags used to organize, track, or control access for this resource.
$sel:assistantArn:AssistantAssociationSummary', assistantAssociationSummary_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant.
$sel:assistantAssociationArn:AssistantAssociationSummary', assistantAssociationSummary_assistantAssociationArn - The Amazon Resource Name (ARN) of the assistant association.
$sel:assistantAssociationId:AssistantAssociationSummary', assistantAssociationSummary_assistantAssociationId - The identifier of the assistant association.
$sel:assistantId:AssistantAssociationSummary', assistantAssociationSummary_assistantId - The identifier of the Wisdom assistant.
$sel:associationData:AssistantAssociationSummary', assistantAssociationSummary_associationData - The association data.
$sel:associationType:AssistantAssociationSummary', assistantAssociationSummary_associationType - The type of association.
AssistantData
data AssistantData Source #
The assistant data.
See: newAssistantData smart constructor.
Constructors
| AssistantData' (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text Text Text AssistantStatus AssistantType |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssistantStatus | |
| -> AssistantType | |
| -> AssistantData |
Create a value of AssistantData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:AssistantData', assistantData_description - The description.
$sel:serverSideEncryptionConfiguration:AssistantData', assistantData_serverSideEncryptionConfiguration - The KMS key used for encryption.
$sel:tags:AssistantData', assistantData_tags - The tags used to organize, track, or control access for this resource.
$sel:assistantArn:AssistantData', assistantData_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant.
$sel:assistantId:AssistantData', assistantData_assistantId - The identifier of the Wisdom assistant.
$sel:name:AssistantData', assistantData_name - The name.
$sel:status:AssistantData', assistantData_status - The status of the assistant.
$sel:type':AssistantData', assistantData_type - The type of assistant.
AssistantSummary
data AssistantSummary Source #
Summary information about the assistant.
See: newAssistantSummary smart constructor.
Constructors
| AssistantSummary' (Maybe Text) (Maybe ServerSideEncryptionConfiguration) (Maybe (HashMap Text Text)) Text Text Text AssistantStatus AssistantType |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssistantStatus | |
| -> AssistantType | |
| -> AssistantSummary |
Create a value of AssistantSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:AssistantSummary', assistantSummary_description - The description of the assistant.
$sel:serverSideEncryptionConfiguration:AssistantSummary', assistantSummary_serverSideEncryptionConfiguration - The KMS key used for encryption.
$sel:tags:AssistantSummary', assistantSummary_tags - The tags used to organize, track, or control access for this resource.
$sel:assistantArn:AssistantSummary', assistantSummary_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant.
$sel:assistantId:AssistantSummary', assistantSummary_assistantId - The identifier of the Wisdom assistant.
$sel:name:AssistantSummary', assistantSummary_name - The name of the assistant.
$sel:status:AssistantSummary', assistantSummary_status - The status of the assistant.
$sel:type':AssistantSummary', assistantSummary_type - The type of the assistant.
ContentData
data ContentData Source #
Information about the content.
See: newContentData smart constructor.
Constructors
| ContentData' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text Text Text (HashMap Text Text) Text Text ContentStatus Text (Sensitive Text) POSIX |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ContentStatus | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> ContentData |
Create a value of ContentData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:linkOutUri:ContentData', contentData_linkOutUri - The URI of the content.
$sel:tags:ContentData', contentData_tags - The tags used to organize, track, or control access for this resource.
$sel:contentArn:ContentData', contentData_contentArn - The Amazon Resource Name (ARN) of the content.
$sel:contentId:ContentData', contentData_contentId - The identifier of the content.
$sel:contentType:ContentData', contentData_contentType - The media type of the content.
$sel:knowledgeBaseArn:ContentData', contentData_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
$sel:knowledgeBaseId:ContentData', contentData_knowledgeBaseId - The 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 identifier of the knowledge base.
ContentSummary
data ContentSummary Source #
Summary information about the content.
See: newContentSummary smart constructor.
Constructors
| ContentSummary' (Maybe (HashMap Text Text)) Text Text Text Text Text (HashMap Text Text) Text Text ContentStatus Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ContentStatus | |
| -> Text | |
| -> ContentSummary |
Create a value of ContentSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ContentSummary', contentSummary_tags - The tags used to organize, track, or control access for this resource.
$sel:contentArn:ContentSummary', contentSummary_contentArn - The Amazon Resource Name (ARN) of the content.
$sel:contentId:ContentSummary', contentSummary_contentId - The identifier of the content.
$sel:contentType:ContentSummary', contentSummary_contentType - The media type of the content.
$sel:knowledgeBaseArn:ContentSummary', contentSummary_knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
$sel:knowledgeBaseId:ContentSummary', contentSummary_knowledgeBaseId - The 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.
Constructors
| Document' (Maybe DocumentText) (Maybe DocumentText) ContentReference |
Instances
| FromJSON Document Source # | |
| Generic Document Source # | |
| Show Document Source # | |
| NFData Document Source # | |
Defined in Amazonka.Wisdom.Types.Document | |
| Eq Document Source # | |
| Hashable Document Source # | |
Defined in Amazonka.Wisdom.Types.Document | |
| type Rep Document Source # | |
Defined in Amazonka.Wisdom.Types.Document type Rep Document = D1 ('MetaData "Document" "Amazonka.Wisdom.Types.Document" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "Document'" 'PrefixI 'True) (S1 ('MetaSel ('Just "excerpt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentText)) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentText)) :*: S1 ('MetaSel ('Just "contentReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContentReference)))) | |
Arguments
| :: ContentReference | |
| -> Document |
Create a value of Document with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:excerpt:Document', document_excerpt - The excerpt from the document.
$sel:title:Document', document_title - The title of the document.
$sel:contentReference:Document', document_contentReference - A reference to the content resource.
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:highlights:DocumentText', documentText_highlights - Highlights in the document text.
$sel:text:DocumentText', documentText_text - Text in the document.
Filter
A search filter.
See: newFilter smart constructor.
Constructors
| Filter' FilterField FilterOperator Text |
Instances
| ToJSON Filter Source # | |
Defined in Amazonka.Wisdom.Types.Filter | |
| Generic Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.Wisdom.Types.Filter | |
| Eq Filter Source # | |
| Hashable 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" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "field") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterField) :*: (S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterOperator) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Arguments
| :: FilterField | |
| -> FilterOperator | |
| -> Text | |
| -> Filter |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:field:Filter', filter_field - The field on which to filter.
$sel:operator:Filter', filter_operator - The operator to use for comparing the field’s value with the provided
value.
$sel:value:Filter', filter_value - The desired field value on which to filter.
Highlight
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
See: newHighlight smart constructor.
Constructors
| Highlight' (Maybe Int) (Maybe Int) |
Instances
| FromJSON Highlight Source # | |
| Generic Highlight Source # | |
| Read Highlight Source # | |
| Show Highlight Source # | |
| NFData Highlight Source # | |
Defined in Amazonka.Wisdom.Types.Highlight | |
| Eq Highlight Source # | |
| Hashable Highlight Source # | |
Defined in Amazonka.Wisdom.Types.Highlight | |
| type Rep Highlight Source # | |
Defined in Amazonka.Wisdom.Types.Highlight type Rep Highlight = D1 ('MetaData "Highlight" "Amazonka.Wisdom.Types.Highlight" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "Highlight'" 'PrefixI 'True) (S1 ('MetaSel ('Just "beginOffsetInclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endOffsetExclusive") '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:beginOffsetInclusive:Highlight', highlight_beginOffsetInclusive - The offset for the start of the highlight.
$sel:endOffsetExclusive:Highlight', highlight_endOffsetExclusive - The offset for the end of the highlight.
KnowledgeBaseAssociationData
data KnowledgeBaseAssociationData Source #
Association information about the knowledge base.
See: newKnowledgeBaseAssociationData smart constructor.
Constructors
| KnowledgeBaseAssociationData' (Maybe Text) (Maybe Text) |
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 identifier of the knowledge base.
KnowledgeBaseData
data KnowledgeBaseData Source #
Information about the knowledge base.
See: newKnowledgeBaseData smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> KnowledgeBaseType | |
| -> Text | |
| -> KnowledgeBaseStatus | |
| -> KnowledgeBaseData |
Create a value of KnowledgeBaseData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:KnowledgeBaseData', knowledgeBaseData_description - The description.
$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:renderingConfiguration:KnowledgeBaseData', knowledgeBaseData_renderingConfiguration - Information about how to render the content.
$sel:serverSideEncryptionConfiguration:KnowledgeBaseData', knowledgeBaseData_serverSideEncryptionConfiguration - The KMS key used for encryption.
$sel:sourceConfiguration:KnowledgeBaseData', knowledgeBaseData_sourceConfiguration - Source configuration information about the knowledge base.
$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 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.
Constructors
Instances
newKnowledgeBaseSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> KnowledgeBaseType | |
| -> Text | |
| -> KnowledgeBaseStatus | |
| -> KnowledgeBaseSummary |
Create a value of KnowledgeBaseSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:KnowledgeBaseSummary', knowledgeBaseSummary_description - The description of the knowledge base.
$sel:renderingConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_renderingConfiguration - Information about how to render the content.
$sel:serverSideEncryptionConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_serverSideEncryptionConfiguration - The KMS key used for encryption.
$sel:sourceConfiguration:KnowledgeBaseSummary', knowledgeBaseSummary_sourceConfiguration - Configuration information about the external data source.
$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 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.
Constructors
| NotifyRecommendationsReceivedError' (Maybe Text) (Maybe Text) |
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:message:NotifyRecommendationsReceivedError', notifyRecommendationsReceivedError_message - A recommendation is causing an error.
$sel:recommendationId:NotifyRecommendationsReceivedError', notifyRecommendationsReceivedError_recommendationId - The identifier of the recommendation that is in error.
QueryRecommendationTriggerData
data QueryRecommendationTriggerData Source #
Data associated with the QUERY RecommendationTriggerType.
See: newQueryRecommendationTriggerData smart constructor.
Constructors
| QueryRecommendationTriggerData' (Maybe (Sensitive Text)) |
Instances
newQueryRecommendationTriggerData :: QueryRecommendationTriggerData Source #
Create a value of QueryRecommendationTriggerData with all optional fields omitted.
Use 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:QueryRecommendationTriggerData', queryRecommendationTriggerData_text - The text associated with the recommendation trigger.
RecommendationData
data RecommendationData Source #
Information about the recommendation.
See: newRecommendationData smart constructor.
Constructors
| RecommendationData' (Maybe RelevanceLevel) (Maybe Double) (Maybe RecommendationType) Document Text |
Instances
newRecommendationData Source #
Arguments
| :: Document | |
| -> Text | |
| -> RecommendationData |
Create a value of RecommendationData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relevanceLevel:RecommendationData', recommendationData_relevanceLevel - The relevance level of the recommendation.
$sel:relevanceScore:RecommendationData', recommendationData_relevanceScore - The relevance score of the recommendation.
$sel:type':RecommendationData', recommendationData_type - The type of recommendation.
$sel:document:RecommendationData', recommendationData_document - The recommended document.
$sel:recommendationId:RecommendationData', recommendationData_recommendationId - The identifier of the recommendation.
RecommendationTrigger
data RecommendationTrigger Source #
A recommendation trigger provides context on the event that produced the
referenced recommendations. Recommendations are only referenced in
recommendationIds by a single RecommendationTrigger.
See: newRecommendationTrigger smart constructor.
Constructors
| RecommendationTrigger' RecommendationTriggerData Text [Text] RecommendationSourceType RecommendationTriggerType |
Instances
newRecommendationTrigger Source #
Arguments
| :: RecommendationTriggerData | |
| -> Text | |
| -> RecommendationSourceType | |
| -> RecommendationTriggerType | |
| -> RecommendationTrigger |
Create a value of RecommendationTrigger with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':RecommendationTrigger', recommendationTrigger_data - A union type containing information related to the trigger.
$sel:id:RecommendationTrigger', recommendationTrigger_id - The identifier of the recommendation trigger.
$sel:recommendationIds:RecommendationTrigger', recommendationTrigger_recommendationIds - The identifiers of the recommendations.
$sel:source:RecommendationTrigger', recommendationTrigger_source - The source of the recommendation trigger.
- ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
- RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
$sel:type':RecommendationTrigger', recommendationTrigger_type - The type of recommendation trigger.
RecommendationTriggerData
data RecommendationTriggerData Source #
A union type containing information related to the trigger.
See: newRecommendationTriggerData smart constructor.
Constructors
| RecommendationTriggerData' (Maybe QueryRecommendationTriggerData) |
Instances
newRecommendationTriggerData :: RecommendationTriggerData Source #
Create a value of RecommendationTriggerData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:query:RecommendationTriggerData', recommendationTriggerData_query - Data associated with the QUERY RecommendationTriggerType.
RenderingConfiguration
data RenderingConfiguration Source #
Information about how to render the content.
See: newRenderingConfiguration smart constructor.
Constructors
| RenderingConfiguration' (Maybe Text) |
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.
Constructors
| ResultData' (Maybe Double) Document Text |
Instances
Arguments
| :: Document | |
| -> Text | |
| -> ResultData |
Create a value of ResultData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relevanceScore:ResultData', resultData_relevanceScore - The relevance score of the results.
$sel:document:ResultData', resultData_document - The document.
$sel:resultId:ResultData', resultData_resultId - The identifier of the result data.
SearchExpression
data SearchExpression Source #
The search expression.
See: newSearchExpression smart constructor.
Constructors
| SearchExpression' [Filter] |
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.
Constructors
| ServerSideEncryptionConfiguration' (Maybe Text) |
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).
SessionData
data SessionData Source #
Information about the session.
See: newSessionData smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> SessionData |
Create a value of SessionData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:SessionData', sessionData_description - The description of the session.
$sel:tags:SessionData', sessionData_tags - The tags used to organize, track, or control access for this resource.
$sel:name:SessionData', sessionData_name - The name of the session.
$sel:sessionArn:SessionData', sessionData_sessionArn - The Amazon Resource Name (ARN) of the session.
$sel:sessionId:SessionData', sessionData_sessionId - The identifier of the session.
SessionSummary
data SessionSummary Source #
Summary information about the session.
See: newSessionSummary smart constructor.
Constructors
| SessionSummary' Text Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> SessionSummary |
Create a value of SessionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assistantArn:SessionSummary', sessionSummary_assistantArn - The Amazon Resource Name (ARN) of the Wisdom assistant.
$sel:assistantId:SessionSummary', sessionSummary_assistantId - The identifier of the Wisdom assistant.
$sel:sessionArn:SessionSummary', sessionSummary_sessionArn - The Amazon Resource Name (ARN) of the session.
$sel:sessionId:SessionSummary', sessionSummary_sessionId - The identifier of the session.
SourceConfiguration
data SourceConfiguration Source #
Configuration information about the external data source.
See: newSourceConfiguration smart constructor.
Constructors
| SourceConfiguration' (Maybe AppIntegrationsConfiguration) |
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.