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

Contents

Operations
Types

Description

Synopsis

Operations

CreateAssistant

createAssistant_clientToken :: Lens' CreateAssistant (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createAssistant_description :: Lens' CreateAssistant (Maybe Text) Source #

The description of the assistant.

createAssistant_serverSideEncryptionConfiguration :: Lens' CreateAssistant (Maybe ServerSideEncryptionConfiguration) Source #

The KMS key used for encryption.

createAssistant_tags :: Lens' CreateAssistant (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createAssistant_name :: Lens' CreateAssistant Text Source #

The name of the assistant.

createAssistant_type :: Lens' CreateAssistant AssistantType Source #

The type of assistant.

createAssistantResponse_assistant :: Lens' CreateAssistantResponse (Maybe AssistantData) Source #

Information about the assistant.

createAssistantResponse_httpStatus :: Lens' CreateAssistantResponse Int Source #

The response's http status code.

CreateAssistantAssociation

createAssistantAssociation_clientToken :: Lens' CreateAssistantAssociation (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createAssistantAssociation_tags :: Lens' CreateAssistantAssociation (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createAssistantAssociation_assistantId :: Lens' CreateAssistantAssociation Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

createAssistantAssociation_association :: Lens' CreateAssistantAssociation AssistantAssociationInputData Source #

The identifier of the associated resource.

createAssistantAssociation_associationType :: Lens' CreateAssistantAssociation AssociationType Source #

The type of association.

createAssistantAssociationResponse_assistantAssociation :: Lens' CreateAssistantAssociationResponse (Maybe AssistantAssociationData) Source #

The assistant association.

createAssistantAssociationResponse_httpStatus :: Lens' CreateAssistantAssociationResponse Int Source #

The response's http status code.

CreateContent

createContent_clientToken :: Lens' CreateContent (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createContent_metadata :: Lens' CreateContent (Maybe (HashMap Text Text)) Source #

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.

createContent_overrideLinkOutUri :: Lens' CreateContent (Maybe Text) Source #

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_tags :: Lens' CreateContent (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createContent_title :: Lens' CreateContent (Maybe Text) Source #

The title of the content. If not set, the title is equal to the name.

createContent_knowledgeBaseId :: Lens' CreateContent Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

createContent_name :: Lens' CreateContent Text Source #

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.

createContent_uploadId :: Lens' CreateContent Text Source #

A pointer to the uploaded asset. This value is returned by StartContentUpload.

createContentResponse_content :: Lens' CreateContentResponse (Maybe ContentData) Source #

The content.

createContentResponse_httpStatus :: Lens' CreateContentResponse Int Source #

The response's http status code.

CreateKnowledgeBase

createKnowledgeBase_clientToken :: Lens' CreateKnowledgeBase (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createKnowledgeBase_description :: Lens' CreateKnowledgeBase (Maybe Text) Source #

The description.

createKnowledgeBase_renderingConfiguration :: Lens' CreateKnowledgeBase (Maybe RenderingConfiguration) Source #

Information about how to render the content.

createKnowledgeBase_serverSideEncryptionConfiguration :: Lens' CreateKnowledgeBase (Maybe ServerSideEncryptionConfiguration) Source #

The KMS key used for encryption.

createKnowledgeBase_sourceConfiguration :: Lens' CreateKnowledgeBase (Maybe SourceConfiguration) Source #

The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

createKnowledgeBase_tags :: Lens' CreateKnowledgeBase (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createKnowledgeBase_knowledgeBaseType :: Lens' CreateKnowledgeBase KnowledgeBaseType Source #

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_name :: Lens' CreateKnowledgeBase Text Source #

The name of the knowledge base.

createKnowledgeBaseResponse_knowledgeBase :: Lens' CreateKnowledgeBaseResponse (Maybe KnowledgeBaseData) Source #

The knowledge base.

createKnowledgeBaseResponse_httpStatus :: Lens' CreateKnowledgeBaseResponse Int Source #

The response's http status code.

CreateSession

createSession_clientToken :: Lens' CreateSession (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createSession_description :: Lens' CreateSession (Maybe Text) Source #

The description.

createSession_tags :: Lens' CreateSession (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

createSession_assistantId :: Lens' CreateSession Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

createSession_name :: Lens' CreateSession Text Source #

The name of the session.

createSessionResponse_session :: Lens' CreateSessionResponse (Maybe SessionData) Source #

The session.

createSessionResponse_httpStatus :: Lens' CreateSessionResponse Int Source #

The response's http status code.

DeleteAssistant

deleteAssistant_assistantId :: Lens' DeleteAssistant Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

deleteAssistantResponse_httpStatus :: Lens' DeleteAssistantResponse Int Source #

The response's http status code.

DeleteAssistantAssociation

deleteAssistantAssociation_assistantAssociationId :: Lens' DeleteAssistantAssociation Text Source #

The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

deleteAssistantAssociation_assistantId :: Lens' DeleteAssistantAssociation Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

deleteAssistantAssociationResponse_httpStatus :: Lens' DeleteAssistantAssociationResponse Int Source #

The response's http status code.

DeleteContent

deleteContent_contentId :: Lens' DeleteContent Text Source #

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

deleteContent_knowledgeBaseId :: Lens' DeleteContent Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

deleteContentResponse_httpStatus :: Lens' DeleteContentResponse Int Source #

The response's http status code.

DeleteKnowledgeBase

deleteKnowledgeBase_knowledgeBaseId :: Lens' DeleteKnowledgeBase Text Source #

The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

deleteKnowledgeBaseResponse_httpStatus :: Lens' DeleteKnowledgeBaseResponse Int Source #

The response's http status code.

GetAssistant

getAssistant_assistantId :: Lens' GetAssistant Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

getAssistantResponse_assistant :: Lens' GetAssistantResponse (Maybe AssistantData) Source #

Information about the assistant.

getAssistantResponse_httpStatus :: Lens' GetAssistantResponse Int Source #

The response's http status code.

GetAssistantAssociation

getAssistantAssociation_assistantAssociationId :: Lens' GetAssistantAssociation Text Source #

The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

getAssistantAssociation_assistantId :: Lens' GetAssistantAssociation Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

getAssistantAssociationResponse_assistantAssociation :: Lens' GetAssistantAssociationResponse (Maybe AssistantAssociationData) Source #

The assistant association.

getAssistantAssociationResponse_httpStatus :: Lens' GetAssistantAssociationResponse Int Source #

The response's http status code.

GetContent

getContent_contentId :: Lens' GetContent Text Source #

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

getContent_knowledgeBaseId :: Lens' GetContent Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

getContentResponse_content :: Lens' GetContentResponse (Maybe ContentData) Source #

The content.

getContentResponse_httpStatus :: Lens' GetContentResponse Int Source #

The response's http status code.

GetContentSummary

getContentSummary_contentId :: Lens' GetContentSummary Text Source #

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

getContentSummary_knowledgeBaseId :: Lens' GetContentSummary Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

getContentSummaryResponse_contentSummary :: Lens' GetContentSummaryResponse (Maybe ContentSummary) Source #

The content summary.

getContentSummaryResponse_httpStatus :: Lens' GetContentSummaryResponse Int Source #

The response's http status code.

GetKnowledgeBase

getKnowledgeBase_knowledgeBaseId :: Lens' GetKnowledgeBase Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

getKnowledgeBaseResponse_knowledgeBase :: Lens' GetKnowledgeBaseResponse (Maybe KnowledgeBaseData) Source #

The knowledge base.

getKnowledgeBaseResponse_httpStatus :: Lens' GetKnowledgeBaseResponse Int Source #

The response's http status code.

GetRecommendations

getRecommendations_maxResults :: Lens' GetRecommendations (Maybe Natural) Source #

The maximum number of results to return per page.

getRecommendations_waitTimeSeconds :: Lens' GetRecommendations (Maybe Natural) Source #

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_assistantId :: Lens' GetRecommendations Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

getRecommendations_sessionId :: Lens' GetRecommendations Text Source #

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

getRecommendationsResponse_triggers :: Lens' GetRecommendationsResponse (Maybe [RecommendationTrigger]) Source #

The triggers corresponding to recommendations.

getRecommendationsResponse_httpStatus :: Lens' GetRecommendationsResponse Int Source #

The response's http status code.

getRecommendationsResponse_recommendations :: Lens' GetRecommendationsResponse [RecommendationData] Source #

The recommendations.

GetSession

getSession_assistantId :: Lens' GetSession Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

getSession_sessionId :: Lens' GetSession Text Source #

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

getSessionResponse_session :: Lens' GetSessionResponse (Maybe SessionData) Source #

The session.

getSessionResponse_httpStatus :: Lens' GetSessionResponse Int Source #

The response's http status code.

ListAssistantAssociations

listAssistantAssociations_maxResults :: Lens' ListAssistantAssociations (Maybe Natural) Source #

The maximum number of results to return per page.

listAssistantAssociations_nextToken :: Lens' ListAssistantAssociations (Maybe Text) Source #

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_assistantId :: Lens' ListAssistantAssociations Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

listAssistantAssociationsResponse_nextToken :: Lens' ListAssistantAssociationsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listAssistantAssociationsResponse_httpStatus :: Lens' ListAssistantAssociationsResponse Int Source #

The response's http status code.

listAssistantAssociationsResponse_assistantAssociationSummaries :: Lens' ListAssistantAssociationsResponse [AssistantAssociationSummary] Source #

Summary information about assistant associations.

ListAssistants

listAssistants_maxResults :: Lens' ListAssistants (Maybe Natural) Source #

The maximum number of results to return per page.

listAssistants_nextToken :: Lens' ListAssistants (Maybe Text) Source #

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.

listAssistantsResponse_nextToken :: Lens' ListAssistantsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listAssistantsResponse_httpStatus :: Lens' ListAssistantsResponse Int Source #

The response's http status code.

listAssistantsResponse_assistantSummaries :: Lens' ListAssistantsResponse [AssistantSummary] Source #

Information about the assistants.

ListContents

listContents_maxResults :: Lens' ListContents (Maybe Natural) Source #

The maximum number of results to return per page.

listContents_nextToken :: Lens' ListContents (Maybe Text) Source #

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_knowledgeBaseId :: Lens' ListContents Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

listContentsResponse_nextToken :: Lens' ListContentsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listContentsResponse_httpStatus :: Lens' ListContentsResponse Int Source #

The response's http status code.

listContentsResponse_contentSummaries :: Lens' ListContentsResponse [ContentSummary] Source #

Information about the content.

ListKnowledgeBases

listKnowledgeBases_maxResults :: Lens' ListKnowledgeBases (Maybe Natural) Source #

The maximum number of results to return per page.

listKnowledgeBases_nextToken :: Lens' ListKnowledgeBases (Maybe Text) Source #

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.

listKnowledgeBasesResponse_nextToken :: Lens' ListKnowledgeBasesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listKnowledgeBasesResponse_httpStatus :: Lens' ListKnowledgeBasesResponse Int Source #

The response's http status code.

listKnowledgeBasesResponse_knowledgeBaseSummaries :: Lens' ListKnowledgeBasesResponse [KnowledgeBaseSummary] Source #

Information about the knowledge bases.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

NotifyRecommendationsReceived

notifyRecommendationsReceived_assistantId :: Lens' NotifyRecommendationsReceived Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

notifyRecommendationsReceived_recommendationIds :: Lens' NotifyRecommendationsReceived [Text] Source #

The identifiers of the recommendations.

notifyRecommendationsReceived_sessionId :: Lens' NotifyRecommendationsReceived Text Source #

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

notifyRecommendationsReceivedResponse_errors :: Lens' NotifyRecommendationsReceivedResponse (Maybe [NotifyRecommendationsReceivedError]) Source #

The identifiers of recommendations that are causing errors.

notifyRecommendationsReceivedResponse_recommendationIds :: Lens' NotifyRecommendationsReceivedResponse (Maybe [Text]) Source #

The identifiers of the recommendations.

notifyRecommendationsReceivedResponse_httpStatus :: Lens' NotifyRecommendationsReceivedResponse Int Source #

The response's http status code.

QueryAssistant

queryAssistant_maxResults :: Lens' QueryAssistant (Maybe Natural) Source #

The maximum number of results to return per page.

queryAssistant_nextToken :: Lens' QueryAssistant (Maybe Text) Source #

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_assistantId :: Lens' QueryAssistant Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

queryAssistant_queryText :: Lens' QueryAssistant Text Source #

The text to search for.

queryAssistantResponse_nextToken :: Lens' QueryAssistantResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

queryAssistantResponse_httpStatus :: Lens' QueryAssistantResponse Int Source #

The response's http status code.

queryAssistantResponse_results :: Lens' QueryAssistantResponse [ResultData] Source #

The results of the query.

RemoveKnowledgeBaseTemplateUri

removeKnowledgeBaseTemplateUri_knowledgeBaseId :: Lens' RemoveKnowledgeBaseTemplateUri Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

removeKnowledgeBaseTemplateUriResponse_httpStatus :: Lens' RemoveKnowledgeBaseTemplateUriResponse Int Source #

The response's http status code.

SearchContent

searchContent_maxResults :: Lens' SearchContent (Maybe Natural) Source #

The maximum number of results to return per page.

searchContent_nextToken :: Lens' SearchContent (Maybe Text) Source #

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_knowledgeBaseId :: Lens' SearchContent Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

searchContent_searchExpression :: Lens' SearchContent SearchExpression Source #

The search expression to filter results.

searchContentResponse_nextToken :: Lens' SearchContentResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

searchContentResponse_httpStatus :: Lens' SearchContentResponse Int Source #

The response's http status code.

searchContentResponse_contentSummaries :: Lens' SearchContentResponse [ContentSummary] Source #

Summary information about the content.

SearchSessions

searchSessions_maxResults :: Lens' SearchSessions (Maybe Natural) Source #

The maximum number of results to return per page.

searchSessions_nextToken :: Lens' SearchSessions (Maybe Text) Source #

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_assistantId :: Lens' SearchSessions Text Source #

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

searchSessions_searchExpression :: Lens' SearchSessions SearchExpression Source #

The search expression to filter results.

searchSessionsResponse_nextToken :: Lens' SearchSessionsResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

searchSessionsResponse_httpStatus :: Lens' SearchSessionsResponse Int Source #

The response's http status code.

searchSessionsResponse_sessionSummaries :: Lens' SearchSessionsResponse [SessionSummary] Source #

Summary information about the sessions.

StartContentUpload

startContentUpload_contentType :: Lens' StartContentUpload Text Source #

The type of content to upload.

startContentUpload_knowledgeBaseId :: Lens' StartContentUpload Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

startContentUploadResponse_httpStatus :: Lens' StartContentUploadResponse Int Source #

The response's http status code.

startContentUploadResponse_headersToInclude :: Lens' StartContentUploadResponse (HashMap Text Text) Source #

The headers to include in the upload.

startContentUploadResponse_uploadId :: Lens' StartContentUploadResponse Text Source #

The identifier of the upload.

startContentUploadResponse_url :: Lens' StartContentUploadResponse Text Source #

The URL of the upload.

startContentUploadResponse_urlExpiry :: Lens' StartContentUploadResponse UTCTime Source #

The expiration time of the URL as an epoch timestamp.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags used to organize, track, or control access for this resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The tag keys.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateContent

updateContent_metadata :: Lens' UpdateContent (Maybe (HashMap Text Text)) Source #

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.

updateContent_overrideLinkOutUri :: Lens' UpdateContent (Maybe Text) Source #

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.

updateContent_removeOverrideLinkOutUri :: Lens' UpdateContent (Maybe Bool) Source #

Unset the existing overrideLinkOutUri if it exists.

updateContent_revisionId :: Lens' UpdateContent (Maybe Text) Source #

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_title :: Lens' UpdateContent (Maybe Text) Source #

The title of the content.

updateContent_uploadId :: Lens' UpdateContent (Maybe Text) Source #

A pointer to the uploaded asset. This value is returned by StartContentUpload.

updateContent_contentId :: Lens' UpdateContent Text Source #

The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

updateContent_knowledgeBaseId :: Lens' UpdateContent Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN

updateContentResponse_content :: Lens' UpdateContentResponse (Maybe ContentData) Source #

The content.

updateContentResponse_httpStatus :: Lens' UpdateContentResponse Int Source #

The response's http status code.

UpdateKnowledgeBaseTemplateUri

updateKnowledgeBaseTemplateUri_knowledgeBaseId :: Lens' UpdateKnowledgeBaseTemplateUri Text Source #

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

updateKnowledgeBaseTemplateUri_templateUri :: Lens' UpdateKnowledgeBaseTemplateUri Text Source #

The template URI to update.

updateKnowledgeBaseTemplateUriResponse_knowledgeBase :: Lens' UpdateKnowledgeBaseTemplateUriResponse (Maybe KnowledgeBaseData) Source #

The knowledge base to update.

updateKnowledgeBaseTemplateUriResponse_httpStatus :: Lens' UpdateKnowledgeBaseTemplateUriResponse Int Source #

The response's http status code.

Types

AppIntegrationsConfiguration

appIntegrationsConfiguration_appIntegrationArn :: Lens' AppIntegrationsConfiguration Text Source #

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

appIntegrationsConfiguration_objectFields :: Lens' AppIntegrationsConfiguration (NonEmpty Text) Source #

The fields from the source that are made available to your agents in Wisdom.

For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.
For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

Make sure to include additional fields. These fields are indexed and used to source recommendations.

AssistantAssociationData

assistantAssociationData_tags :: Lens' AssistantAssociationData (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

assistantAssociationData_assistantArn :: Lens' AssistantAssociationData Text Source #

The Amazon Resource Name (ARN) of the Wisdom assistant.

assistantAssociationData_assistantAssociationArn :: Lens' AssistantAssociationData Text Source #

The Amazon Resource Name (ARN) of the assistant association.

assistantAssociationData_assistantAssociationId :: Lens' AssistantAssociationData Text Source #

The identifier of the assistant association.

assistantAssociationData_assistantId :: Lens' AssistantAssociationData Text Source #

The identifier of the Wisdom assistant.

assistantAssociationData_associationData :: Lens' AssistantAssociationData AssistantAssociationOutputData Source #

A union type that currently has a single argument, the knowledge base ID.

assistantAssociationData_associationType :: Lens' AssistantAssociationData AssociationType Source #

The type of association.

AssistantAssociationInputData

assistantAssociationInputData_knowledgeBaseId :: Lens' AssistantAssociationInputData (Maybe Text) Source #

The identifier of the knowledge base.

AssistantAssociationOutputData

assistantAssociationOutputData_knowledgeBaseAssociation :: Lens' AssistantAssociationOutputData (Maybe KnowledgeBaseAssociationData) Source #

The knowledge base where output data is sent.

AssistantAssociationSummary

assistantAssociationSummary_tags :: Lens' AssistantAssociationSummary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

assistantAssociationSummary_assistantArn :: Lens' AssistantAssociationSummary Text Source #

The Amazon Resource Name (ARN) of the Wisdom assistant.

assistantAssociationSummary_assistantAssociationArn :: Lens' AssistantAssociationSummary Text Source #

The Amazon Resource Name (ARN) of the assistant association.

assistantAssociationSummary_assistantAssociationId :: Lens' AssistantAssociationSummary Text Source #

The identifier of the assistant association.

assistantAssociationSummary_assistantId :: Lens' AssistantAssociationSummary Text Source #

The identifier of the Wisdom assistant.

assistantAssociationSummary_associationData :: Lens' AssistantAssociationSummary AssistantAssociationOutputData Source #

The association data.

assistantAssociationSummary_associationType :: Lens' AssistantAssociationSummary AssociationType Source #

The type of association.

AssistantData

assistantData_description :: Lens' AssistantData (Maybe Text) Source #

The description.

assistantData_serverSideEncryptionConfiguration :: Lens' AssistantData (Maybe ServerSideEncryptionConfiguration) Source #

The KMS key used for encryption.

assistantData_tags :: Lens' AssistantData (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

assistantData_assistantArn :: Lens' AssistantData Text Source #

The Amazon Resource Name (ARN) of the Wisdom assistant.

assistantData_assistantId :: Lens' AssistantData Text Source #

The identifier of the Wisdom assistant.

assistantData_name :: Lens' AssistantData Text Source #

The name.

assistantData_status :: Lens' AssistantData AssistantStatus Source #

The status of the assistant.

assistantData_type :: Lens' AssistantData AssistantType Source #

The type of assistant.

AssistantSummary

assistantSummary_description :: Lens' AssistantSummary (Maybe Text) Source #

The description of the assistant.

assistantSummary_serverSideEncryptionConfiguration :: Lens' AssistantSummary (Maybe ServerSideEncryptionConfiguration) Source #

The KMS key used for encryption.

assistantSummary_tags :: Lens' AssistantSummary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

assistantSummary_assistantArn :: Lens' AssistantSummary Text Source #

The Amazon Resource Name (ARN) of the Wisdom assistant.

assistantSummary_assistantId :: Lens' AssistantSummary Text Source #

The identifier of the Wisdom assistant.

assistantSummary_name :: Lens' AssistantSummary Text Source #

The name of the assistant.

assistantSummary_status :: Lens' AssistantSummary AssistantStatus Source #

The status of the assistant.

assistantSummary_type :: Lens' AssistantSummary AssistantType Source #

The type of the assistant.

ContentData

contentData_linkOutUri :: Lens' ContentData (Maybe Text) Source #

The URI of the content.

contentData_tags :: Lens' ContentData (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

contentData_contentArn :: Lens' ContentData Text Source #

The Amazon Resource Name (ARN) of the content.

contentData_contentId :: Lens' ContentData Text Source #

The identifier of the content.

contentData_contentType :: Lens' ContentData Text Source #

The media type of the content.

contentData_knowledgeBaseArn :: Lens' ContentData Text Source #

The Amazon Resource Name (ARN) of the knowledge base.

contentData_knowledgeBaseId :: Lens' ContentData Text Source #

The identifier of the knowledge base.

contentData_metadata :: Lens' ContentData (HashMap Text Text) Source #

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.

contentData_name :: Lens' ContentData Text Source #

The name of the content.

contentData_revisionId :: Lens' ContentData Text Source #

The identifier of the content revision.

contentData_status :: Lens' ContentData ContentStatus Source #

The status of the content.

contentData_title :: Lens' ContentData Text Source #

The title of the content.

contentData_url :: Lens' ContentData Text Source #

The URL of the content.

contentData_urlExpiry :: Lens' ContentData UTCTime Source #

The expiration time of the URL as an epoch timestamp.

ContentReference

contentReference_contentArn :: Lens' ContentReference (Maybe Text) Source #

The Amazon Resource Name (ARN) of the content.

contentReference_contentId :: Lens' ContentReference (Maybe Text) Source #

The identifier of the content.

contentReference_knowledgeBaseArn :: Lens' ContentReference (Maybe Text) Source #

The Amazon Resource Name (ARN) of the knowledge base.

contentReference_knowledgeBaseId :: Lens' ContentReference (Maybe Text) Source #

The identifier of the knowledge base.

ContentSummary

contentSummary_tags :: Lens' ContentSummary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

contentSummary_contentArn :: Lens' ContentSummary Text Source #

The Amazon Resource Name (ARN) of the content.

contentSummary_contentId :: Lens' ContentSummary Text Source #

The identifier of the content.

contentSummary_contentType :: Lens' ContentSummary Text Source #

The media type of the content.

contentSummary_knowledgeBaseArn :: Lens' ContentSummary Text Source #

The Amazon Resource Name (ARN) of the knowledge base.

contentSummary_knowledgeBaseId :: Lens' ContentSummary Text Source #

The identifier of the knowledge base.

contentSummary_metadata :: Lens' ContentSummary (HashMap Text Text) Source #

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.

contentSummary_name :: Lens' ContentSummary Text Source #

The name of the content.

contentSummary_revisionId :: Lens' ContentSummary Text Source #

The identifier of the revision of the content.

contentSummary_status :: Lens' ContentSummary ContentStatus Source #

The status of the content.

contentSummary_title :: Lens' ContentSummary Text Source #

The title of the content.

Document

document_excerpt :: Lens' Document (Maybe DocumentText) Source #

The excerpt from the document.

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

The title of the document.

document_contentReference :: Lens' Document ContentReference Source #

A reference to the content resource.

DocumentText

documentText_highlights :: Lens' DocumentText (Maybe [Highlight]) Source #

Highlights in the document text.

documentText_text :: Lens' DocumentText (Maybe Text) Source #

Text in the document.

Filter

filter_field :: Lens' Filter FilterField Source #

The field on which to filter.

filter_operator :: Lens' Filter FilterOperator Source #

The operator to use for comparing the field’s value with the provided value.

filter_value :: Lens' Filter Text Source #

The desired field value on which to filter.

Highlight

highlight_beginOffsetInclusive :: Lens' Highlight (Maybe Int) Source #

The offset for the start of the highlight.

highlight_endOffsetExclusive :: Lens' Highlight (Maybe Int) Source #

The offset for the end of the highlight.

KnowledgeBaseAssociationData

knowledgeBaseAssociationData_knowledgeBaseArn :: Lens' KnowledgeBaseAssociationData (Maybe Text) Source #

The Amazon Resource Name (ARN) of the knowledge base.

knowledgeBaseAssociationData_knowledgeBaseId :: Lens' KnowledgeBaseAssociationData (Maybe Text) Source #

The identifier of the knowledge base.

KnowledgeBaseData

knowledgeBaseData_description :: Lens' KnowledgeBaseData (Maybe Text) Source #

The description.

knowledgeBaseData_lastContentModificationTime :: Lens' KnowledgeBaseData (Maybe UTCTime) Source #

An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

knowledgeBaseData_renderingConfiguration :: Lens' KnowledgeBaseData (Maybe RenderingConfiguration) Source #

Information about how to render the content.

knowledgeBaseData_serverSideEncryptionConfiguration :: Lens' KnowledgeBaseData (Maybe ServerSideEncryptionConfiguration) Source #

The KMS key used for encryption.

knowledgeBaseData_sourceConfiguration :: Lens' KnowledgeBaseData (Maybe SourceConfiguration) Source #

Source configuration information about the knowledge base.

knowledgeBaseData_tags :: Lens' KnowledgeBaseData (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

knowledgeBaseData_knowledgeBaseArn :: Lens' KnowledgeBaseData Text Source #

The Amazon Resource Name (ARN) of the knowledge base.

knowledgeBaseData_knowledgeBaseId :: Lens' KnowledgeBaseData Text Source #

The identifier of the knowledge base.

knowledgeBaseData_knowledgeBaseType :: Lens' KnowledgeBaseData KnowledgeBaseType Source #

The type of knowledge base.

knowledgeBaseData_name :: Lens' KnowledgeBaseData Text Source #

The name of the knowledge base.

knowledgeBaseData_status :: Lens' KnowledgeBaseData KnowledgeBaseStatus Source #

The status of the knowledge base.

KnowledgeBaseSummary

knowledgeBaseSummary_description :: Lens' KnowledgeBaseSummary (Maybe Text) Source #

The description of the knowledge base.

knowledgeBaseSummary_renderingConfiguration :: Lens' KnowledgeBaseSummary (Maybe RenderingConfiguration) Source #

Information about how to render the content.

knowledgeBaseSummary_serverSideEncryptionConfiguration :: Lens' KnowledgeBaseSummary (Maybe ServerSideEncryptionConfiguration) Source #

The KMS key used for encryption.

knowledgeBaseSummary_sourceConfiguration :: Lens' KnowledgeBaseSummary (Maybe SourceConfiguration) Source #

Configuration information about the external data source.

knowledgeBaseSummary_tags :: Lens' KnowledgeBaseSummary (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for this resource.

knowledgeBaseSummary_knowledgeBaseArn :: Lens' KnowledgeBaseSummary Text Source #

The Amazon Resource Name (ARN) of the knowledge base.

knowledgeBaseSummary_knowledgeBaseId :: Lens' KnowledgeBaseSummary Text Source #

The identifier of the knowledge base.

knowledgeBaseSummary_knowledgeBaseType :: Lens' KnowledgeBaseSummary KnowledgeBaseType Source #

The type of knowledge base.

knowledgeBaseSummary_name :: Lens' KnowledgeBaseSummary Text Source #

The name of the knowledge base.

knowledgeBaseSummary_status :: Lens' KnowledgeBaseSummary KnowledgeBaseStatus Source #

The status of the knowledge base summary.

NotifyRecommendationsReceivedError

notifyRecommendationsReceivedError_message :: Lens' NotifyRecommendationsReceivedError (Maybe Text) Source #

A recommendation is causing an error.

notifyRecommendationsReceivedError_recommendationId :: Lens' NotifyRecommendationsReceivedError (Maybe Text) Source #

The identifier of the recommendation that is in error.

QueryRecommendationTriggerData

queryRecommendationTriggerData_text :: Lens' QueryRecommendationTriggerData (Maybe Text) Source #

The text associated with the recommendation trigger.

RecommendationData

recommendationData_relevanceLevel :: Lens' RecommendationData (Maybe RelevanceLevel) Source #

The relevance level of the recommendation.

recommendationData_relevanceScore :: Lens' RecommendationData (Maybe Double) Source #

The relevance score of the recommendation.

recommendationData_type :: Lens' RecommendationData (Maybe RecommendationType) Source #

The type of recommendation.

recommendationData_document :: Lens' RecommendationData Document Source #

The recommended document.

recommendationData_recommendationId :: Lens' RecommendationData Text Source #

The identifier of the recommendation.

RecommendationTrigger

recommendationTrigger_data :: Lens' RecommendationTrigger RecommendationTriggerData Source #

A union type containing information related to the trigger.

recommendationTrigger_id :: Lens' RecommendationTrigger Text Source #

The identifier of the recommendation trigger.

recommendationTrigger_recommendationIds :: Lens' RecommendationTrigger [Text] Source #

The identifiers of the recommendations.

recommendationTrigger_source :: Lens' RecommendationTrigger RecommendationSourceType 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.

recommendationTrigger_type :: Lens' RecommendationTrigger RecommendationTriggerType Source #

The type of recommendation trigger.

RecommendationTriggerData

recommendationTriggerData_query :: Lens' RecommendationTriggerData (Maybe QueryRecommendationTriggerData) Source #

Data associated with the QUERY RecommendationTriggerType.

RenderingConfiguration

renderingConfiguration_templateUri :: Lens' RenderingConfiguration (Maybe Text) Source #

A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:

Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted
ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

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