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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.

Synopsis

data CreateContent = CreateContent' {
- clientToken :: Maybe Text
- metadata :: Maybe (HashMap Text Text)
- overrideLinkOutUri :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- title :: Maybe Text
- knowledgeBaseId :: Text
- name :: Text
- uploadId :: Text
}
newCreateContent :: Text -> Text -> Text -> CreateContent
createContent_clientToken :: Lens' CreateContent (Maybe Text)
createContent_metadata :: Lens' CreateContent (Maybe (HashMap Text Text))
createContent_overrideLinkOutUri :: Lens' CreateContent (Maybe Text)
createContent_tags :: Lens' CreateContent (Maybe (HashMap Text Text))
createContent_title :: Lens' CreateContent (Maybe Text)
createContent_knowledgeBaseId :: Lens' CreateContent Text
createContent_name :: Lens' CreateContent Text
createContent_uploadId :: Lens' CreateContent Text
data CreateContentResponse = CreateContentResponse' {
- content :: Maybe ContentData
- httpStatus :: Int
}
newCreateContentResponse :: Int -> CreateContentResponse
createContentResponse_content :: Lens' CreateContentResponse (Maybe ContentData)
createContentResponse_httpStatus :: Lens' CreateContentResponse Int

Creating a Request

data CreateContent Source #

See: newCreateContent smart constructor.

Constructors

CreateContent'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
metadata :: Maybe (HashMap Text Text)
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.
overrideLinkOutUri :: Maybe Text
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.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource.
title :: Maybe Text
The title of the content. If not set, the title is equal to the name.
knowledgeBaseId :: Text
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
name :: Text
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.
uploadId :: Text
A pointer to the uploaded asset. This value is returned by StartContentUpload.

Instances

Instances details

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

newCreateContent Source #

Arguments

:: Text	`CreateContent`
-> Text	`CreateContent`
-> Text	`$sel:uploadId:CreateContent'`
-> 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.

Request Lenses

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.

Destructuring the Response

data CreateContentResponse Source #

See: newCreateContentResponse smart constructor.

Constructors

CreateContentResponse'
Fields content :: Maybe ContentData The content. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateContentResponse Source #

Arguments

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

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.

Response Lenses

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

The content.

createContentResponse_httpStatus :: Lens' CreateContentResponse Int Source #

The response's http status code.