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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

 <p>For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:</p> <ol> <li> <p>Call <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note>

Synopsis

Creating a Request

data CreateKnowledgeBase Source #

See: newCreateKnowledgeBase smart constructor.

Constructors

CreateKnowledgeBase'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
description :: Maybe Text
The description.
renderingConfiguration :: Maybe RenderingConfiguration
Information about how to render the content.
serverSideEncryptionConfiguration :: Maybe ServerSideEncryptionConfiguration
The KMS key used for encryption.
sourceConfiguration :: Maybe SourceConfiguration
The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource.
knowledgeBaseType :: 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.
name :: Text
The name of the knowledge base.

Instances

Instances details

ToJSON CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods toJSON :: CreateKnowledgeBase -> Value # toEncoding :: CreateKnowledgeBase -> Encoding # toJSONList :: [CreateKnowledgeBase] -> Value # toEncodingList :: [CreateKnowledgeBase] -> Encoding #
ToHeaders CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods toHeaders :: CreateKnowledgeBase -> [Header] #
ToPath CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods toPath :: CreateKnowledgeBase -> ByteString #
ToQuery CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods toQuery :: CreateKnowledgeBase -> QueryString #
AWSRequest CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Associated Types type AWSResponse CreateKnowledgeBase # Methods request :: (Service -> Service) -> CreateKnowledgeBase -> Request CreateKnowledgeBase # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateKnowledgeBase -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateKnowledgeBase))) #
Generic CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Associated Types type Rep CreateKnowledgeBase :: Type -> Type # Methods from :: CreateKnowledgeBase -> Rep CreateKnowledgeBase x # to :: Rep CreateKnowledgeBase x -> CreateKnowledgeBase #
Read CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods readsPrec :: Int -> ReadS CreateKnowledgeBase # readList :: ReadS [CreateKnowledgeBase] # readPrec :: ReadPrec CreateKnowledgeBase # readListPrec :: ReadPrec [CreateKnowledgeBase] #
Show CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods showsPrec :: Int -> CreateKnowledgeBase -> ShowS # show :: CreateKnowledgeBase -> String # showList :: [CreateKnowledgeBase] -> ShowS #
NFData CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods rnf :: CreateKnowledgeBase -> () #
Eq CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods (==) :: CreateKnowledgeBase -> CreateKnowledgeBase -> Bool # (/=) :: CreateKnowledgeBase -> CreateKnowledgeBase -> Bool #
Hashable CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods hashWithSalt :: Int -> CreateKnowledgeBase -> Int # hash :: CreateKnowledgeBase -> Int #
type AWSResponse CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase type AWSResponse CreateKnowledgeBase = CreateKnowledgeBaseResponse
type Rep CreateKnowledgeBase Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase type Rep CreateKnowledgeBase = D1 ('MetaData "CreateKnowledgeBase" "Amazonka.Wisdom.CreateKnowledgeBase" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "CreateKnowledgeBase'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "renderingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RenderingConfiguration)) :: S1 ('MetaSel ('Just "serverSideEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerSideEncryptionConfiguration)))) :: ((S1 ('MetaSel ('Just "sourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceConfiguration)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "knowledgeBaseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KnowledgeBaseType) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateKnowledgeBase Source #

Arguments

:: KnowledgeBaseType	`CreateKnowledgeBase`
-> Text	`CreateKnowledgeBase`
-> CreateKnowledgeBase

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.

Request Lenses

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.

Destructuring the Response

data CreateKnowledgeBaseResponse Source #

See: newCreateKnowledgeBaseResponse smart constructor.

Constructors

CreateKnowledgeBaseResponse'
Fields knowledgeBase :: Maybe KnowledgeBaseData The knowledge base. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateKnowledgeBaseResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Associated Types type Rep CreateKnowledgeBaseResponse :: Type -> Type # Methods from :: CreateKnowledgeBaseResponse -> Rep CreateKnowledgeBaseResponse x # to :: Rep CreateKnowledgeBaseResponse x -> CreateKnowledgeBaseResponse #
Read CreateKnowledgeBaseResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods readsPrec :: Int -> ReadS CreateKnowledgeBaseResponse # readList :: ReadS [CreateKnowledgeBaseResponse] # readPrec :: ReadPrec CreateKnowledgeBaseResponse # readListPrec :: ReadPrec [CreateKnowledgeBaseResponse] #
Show CreateKnowledgeBaseResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods showsPrec :: Int -> CreateKnowledgeBaseResponse -> ShowS # show :: CreateKnowledgeBaseResponse -> String # showList :: [CreateKnowledgeBaseResponse] -> ShowS #
NFData CreateKnowledgeBaseResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods rnf :: CreateKnowledgeBaseResponse -> () #
Eq CreateKnowledgeBaseResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase Methods (==) :: CreateKnowledgeBaseResponse -> CreateKnowledgeBaseResponse -> Bool # (/=) :: CreateKnowledgeBaseResponse -> CreateKnowledgeBaseResponse -> Bool #
type Rep CreateKnowledgeBaseResponse Source #
Instance details Defined in Amazonka.Wisdom.CreateKnowledgeBase type Rep CreateKnowledgeBaseResponse = D1 ('MetaData "CreateKnowledgeBaseResponse" "Amazonka.Wisdom.CreateKnowledgeBase" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "CreateKnowledgeBaseResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "knowledgeBase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KnowledgeBaseData)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateKnowledgeBaseResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateKnowledgeBaseResponse'`
-> CreateKnowledgeBaseResponse

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.

Response Lenses

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

The knowledge base.

createKnowledgeBaseResponse_httpStatus :: Lens' CreateKnowledgeBaseResponse Int Source #

The response's http status code.