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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Replaces the contents of the description of a pull request.

Creating a Request

data UpdatePullRequestDescription Source #

See: newUpdatePullRequestDescription smart constructor.

Constructors

UpdatePullRequestDescription'
Fields pullRequestId :: Text The system-generated ID of the pull request. To get this ID, use ListPullRequests. description :: Text The updated content of the description for the pull request. This content replaces the existing description.

Instances

Instances details

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

newUpdatePullRequestDescription Source #

Arguments

:: Text	`UpdatePullRequestDescription`
-> Text	`UpdatePullRequestDescription`
-> UpdatePullRequestDescription

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

UpdatePullRequestDescription, updatePullRequestDescription_pullRequestId - The system-generated ID of the pull request. To get this ID, use ListPullRequests.

UpdatePullRequestDescription, updatePullRequestDescription_description - The updated content of the description for the pull request. This content replaces the existing description.

Request Lenses

updatePullRequestDescription_pullRequestId :: Lens' UpdatePullRequestDescription Text Source #

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

updatePullRequestDescription_description :: Lens' UpdatePullRequestDescription Text Source #

The updated content of the description for the pull request. This content replaces the existing description.

Destructuring the Response

data UpdatePullRequestDescriptionResponse Source #

See: newUpdatePullRequestDescriptionResponse smart constructor.

Constructors

UpdatePullRequestDescriptionResponse'
Fields httpStatus :: Int The response's http status code. pullRequest :: PullRequest Information about the updated pull request.

Instances

Instances details

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

newUpdatePullRequestDescriptionResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdatePullRequestDescriptionResponse'`
-> PullRequest	`$sel:pullRequest:UpdatePullRequestDescriptionResponse'`
-> UpdatePullRequestDescriptionResponse

Create a value of UpdatePullRequestDescriptionResponse 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:httpStatus:UpdatePullRequestDescriptionResponse', updatePullRequestDescriptionResponse_httpStatus - The response's http status code.

$sel:pullRequest:UpdatePullRequestDescriptionResponse', updatePullRequestDescriptionResponse_pullRequest - Information about the updated pull request.

Response Lenses

updatePullRequestDescriptionResponse_httpStatus :: Lens' UpdatePullRequestDescriptionResponse Int Source #

The response's http status code.

updatePullRequestDescriptionResponse_pullRequest :: Lens' UpdatePullRequestDescriptionResponse PullRequest Source #

Information about the updated pull request.