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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates information about the content.

Synopsis

data UpdateContent = UpdateContent' {
- metadata :: Maybe (HashMap Text Text)
- overrideLinkOutUri :: Maybe Text
- removeOverrideLinkOutUri :: Maybe Bool
- revisionId :: Maybe Text
- title :: Maybe Text
- uploadId :: Maybe Text
- contentId :: Text
- knowledgeBaseId :: Text
}
newUpdateContent :: Text -> Text -> UpdateContent
updateContent_metadata :: Lens' UpdateContent (Maybe (HashMap Text Text))
updateContent_overrideLinkOutUri :: Lens' UpdateContent (Maybe Text)
updateContent_removeOverrideLinkOutUri :: Lens' UpdateContent (Maybe Bool)
updateContent_revisionId :: Lens' UpdateContent (Maybe Text)
updateContent_title :: 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

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 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.
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.
title :: Maybe Text
The title of the content.
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 identifier of the knowledge base. Can be either the ID or the ARN

Instances

Instances details

ToJSON UpdateContent Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent Methods toJSON :: UpdateContent -> Value # toEncoding :: UpdateContent -> Encoding # toJSONList :: [UpdateContent] -> Value # toEncodingList :: [UpdateContent] -> Encoding #
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 #
AWSRequest UpdateContent Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent Associated Types type AWSResponse UpdateContent # Methods request :: (Service -> Service) -> UpdateContent -> Request UpdateContent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateContent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateContent))) #
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 #
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 #
NFData UpdateContent Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent Methods rnf :: UpdateContent -> () #
Eq UpdateContent Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent Methods (==) :: UpdateContent -> UpdateContent -> Bool # (/=) :: UpdateContent -> UpdateContent -> Bool #
Hashable UpdateContent Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent Methods hashWithSalt :: Int -> UpdateContent -> Int # hash :: UpdateContent -> Int #
type AWSResponse UpdateContent Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent type AWSResponse UpdateContent = UpdateContentResponse
type Rep UpdateContent Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent type Rep UpdateContent = D1 ('MetaData "UpdateContent" "Amazonka.Wisdom.UpdateContent" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "UpdateContent'" 'PrefixI 'True) (((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 "removeOverrideLinkOutUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "title") '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)))))

newUpdateContent Source #

Arguments

:: Text	`UpdateContent`
-> Text	`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:

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

Request Lenses

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

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

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 #
Show UpdateContentResponse Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent Methods showsPrec :: Int -> UpdateContentResponse -> ShowS # show :: UpdateContentResponse -> String # showList :: [UpdateContentResponse] -> ShowS #
NFData UpdateContentResponse Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent Methods rnf :: UpdateContentResponse -> () #
Eq UpdateContentResponse Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent Methods (==) :: UpdateContentResponse -> UpdateContentResponse -> Bool # (/=) :: UpdateContentResponse -> UpdateContentResponse -> Bool #
type Rep UpdateContentResponse Source #
Instance details Defined in Amazonka.Wisdom.UpdateContent type Rep UpdateContentResponse = D1 ('MetaData "UpdateContentResponse" "Amazonka.Wisdom.UpdateContent" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" '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.