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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a pull request in the specified repository.

Creating a Request

data CreatePullRequest Source #

See: newCreatePullRequest smart constructor.

Constructors

CreatePullRequest'

Fields

clientRequestToken :: Maybe Text
A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.
description :: Maybe Text
A description of the pull request.
title :: Text
The title of the pull request. This title is used to identify the pull request to other users in the repository.
targets :: [Target]
The targets for the pull request, including the source of the code to be reviewed (the source branch) and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

Instances

Instances details

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

newCreatePullRequest Source #

Arguments

:: Text	`CreatePullRequest`
-> CreatePullRequest

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

CreatePullRequest, createPullRequest_clientRequestToken - A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.

The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.

CreatePullRequest, createPullRequest_description - A description of the pull request.

CreatePullRequest, createPullRequest_title - The title of the pull request. This title is used to identify the pull request to other users in the repository.

$sel:targets:CreatePullRequest', createPullRequest_targets - The targets for the pull request, including the source of the code to be reviewed (the source branch) and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

Request Lenses

createPullRequest_clientRequestToken :: Lens' CreatePullRequest (Maybe Text) Source #

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.

The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.

createPullRequest_description :: Lens' CreatePullRequest (Maybe Text) Source #

A description of the pull request.

createPullRequest_title :: Lens' CreatePullRequest Text Source #

The title of the pull request. This title is used to identify the pull request to other users in the repository.

createPullRequest_targets :: Lens' CreatePullRequest [Target] Source #

The targets for the pull request, including the source of the code to be reviewed (the source branch) and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

Destructuring the Response

data CreatePullRequestResponse Source #

See: newCreatePullRequestResponse smart constructor.

Constructors

CreatePullRequestResponse'
Fields httpStatus :: Int The response's http status code. pullRequest :: PullRequest Information about the newly created pull request.

Instances

Instances details

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

newCreatePullRequestResponse Source #

Arguments

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

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

$sel:pullRequest:CreatePullRequestResponse', createPullRequestResponse_pullRequest - Information about the newly created pull request.

Response Lenses

createPullRequestResponse_httpStatus :: Lens' CreatePullRequestResponse Int Source #

The response's http status code.

createPullRequestResponse_pullRequest :: Lens' CreatePullRequestResponse PullRequest Source #

Information about the newly created pull request.