Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Wisdom.UpdateContent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates information about the content.

Synopsis

data UpdateContent = UpdateContent' {
- overrideLinkOutUri :: Maybe Text
- removeOverrideLinkOutUri :: Maybe Bool
- metadata :: Maybe (HashMap Text Text)
- title :: Maybe Text
- revisionId :: Maybe Text
- uploadId :: Maybe Text
- contentId :: Text
- knowledgeBaseId :: Text
}
newUpdateContent :: Text -> Text -> UpdateContent
updateContent_overrideLinkOutUri :: Lens' UpdateContent (Maybe Text)
updateContent_removeOverrideLinkOutUri :: Lens' UpdateContent (Maybe Bool)
updateContent_metadata :: Lens' UpdateContent (Maybe (HashMap Text Text))
updateContent_title :: Lens' UpdateContent (Maybe Text)
updateContent_revisionId :: Lens' UpdateContent (Maybe Text)
updateContent_uploadId :: Lens' UpdateContent (Maybe Text)
updateContent_contentId :: Lens' UpdateContent Text
updateContent_knowledgeBaseId :: Lens' UpdateContent Text
data UpdateContentResponse = UpdateContentResponse' {
- content :: Maybe ContentData
- httpStatus :: Int
}
newUpdateContentResponse :: Int -> UpdateContentResponse
updateContentResponse_content :: Lens' UpdateContentResponse (Maybe ContentData)
updateContentResponse_httpStatus :: Lens' UpdateContentResponse Int

Creating a Request

data UpdateContent Source #

See: newUpdateContent smart constructor.

Constructors

UpdateContent'

Fields

overrideLinkOutUri :: Maybe Text
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.
removeOverrideLinkOutUri :: Maybe Bool
Unset the existing overrideLinkOutUri if it exists.
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.
title :: Maybe Text
The title of the content.
revisionId :: Maybe Text
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.
uploadId :: Maybe Text
A pointer to the uploaded asset. This value is returned by StartContentUpload.
contentId :: Text
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
knowledgeBaseId :: Text
The the identifier of the knowledge base. Can be either the ID or the ARN

Instances

Instances details

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

newUpdateContent Source #

Arguments

:: Text	`$sel:contentId:UpdateContent'`
-> Text	`$sel:knowledgeBaseId:UpdateContent'`
-> 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:

$sel:overrideLinkOutUri:UpdateContent', updateContent_overrideLinkOutUri - The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.

$sel:removeOverrideLinkOutUri:UpdateContent', updateContent_removeOverrideLinkOutUri - Unset the existing overrideLinkOutUri if it exists.

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

$sel:title:UpdateContent', updateContent_title - The title of the content.

$sel:revisionId:UpdateContent', updateContent_revisionId - The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.

$sel:uploadId:UpdateContent', updateContent_uploadId - A pointer to the uploaded asset. This value is returned by StartContentUpload.

$sel:contentId:UpdateContent', updateContent_contentId - The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

$sel:knowledgeBaseId:UpdateContent', updateContent_knowledgeBaseId - The the identifier of the knowledge base. Can be either the ID or the ARN

Request Lenses

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

The title of the content.

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_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 the identifier of the knowledge base. Can be either the ID or the ARN

Destructuring the Response

data UpdateContentResponse Source #

See: newUpdateContentResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateContentResponse Source #

Arguments

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

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.

Response Lenses

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

The content.

updateContentResponse_httpStatus :: Lens' UpdateContentResponse Int Source #

The response's http status code.