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.CodeCommit.UpdateComment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Replaces the contents of a comment.

Synopsis

Creating a Request

data UpdateComment Source #

See: newUpdateComment smart constructor.

Constructors

UpdateComment'
Fields commentId :: Text The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest. content :: Text The updated content to replace the existing content of the comment.

Instances

Instances details

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

newUpdateComment Source #

Arguments

:: Text	`UpdateComment`
-> Text	`UpdateComment`
-> UpdateComment

Create a value of UpdateComment 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:

UpdateComment, updateComment_commentId - The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

UpdateComment, updateComment_content - The updated content to replace the existing content of the comment.

Request Lenses

updateComment_commentId :: Lens' UpdateComment Text Source #

The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

updateComment_content :: Lens' UpdateComment Text Source #

The updated content to replace the existing content of the comment.

Destructuring the Response

data UpdateCommentResponse Source #

See: newUpdateCommentResponse smart constructor.

Constructors

UpdateCommentResponse'
Fields comment :: Maybe Comment Information about the updated comment. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateCommentResponse Source #

Arguments

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

Create a value of UpdateCommentResponse 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:comment:UpdateCommentResponse', updateCommentResponse_comment - Information about the updated comment.

$sel:httpStatus:UpdateCommentResponse', updateCommentResponse_httpStatus - The response's http status code.

Response Lenses

updateCommentResponse_comment :: Lens' UpdateCommentResponse (Maybe Comment) Source #

Information about the updated comment.

updateCommentResponse_httpStatus :: Lens' UpdateCommentResponse Int Source #

The response's http status code.