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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Posts a comment on a pull request.

Synopsis

Creating a Request

data PostCommentForPullRequest Source #

See: newPostCommentForPullRequest smart constructor.

Constructors

PostCommentForPullRequest'

Fields

location :: Maybe Location
The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.
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.
pullRequestId :: Text
The system-generated ID of the pull request. To get this ID, use ListPullRequests.
repositoryName :: Text
The name of the repository where you want to post a comment on a pull request.
beforeCommitId :: Text
The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.
afterCommitId :: Text
The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.
content :: Text
The content of your comment on the change.

Instances

Instances details

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

newPostCommentForPullRequest Source #

Arguments

:: Text	`$sel:pullRequestId:PostCommentForPullRequest'`
-> Text	`$sel:repositoryName:PostCommentForPullRequest'`
-> Text	`$sel:beforeCommitId:PostCommentForPullRequest'`
-> Text	`$sel:afterCommitId:PostCommentForPullRequest'`
-> Text	`$sel:content:PostCommentForPullRequest'`
-> PostCommentForPullRequest

Create a value of PostCommentForPullRequest 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:location:PostCommentForPullRequest', postCommentForPullRequest_location - The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

$sel:clientRequestToken:PostCommentForPullRequest', postCommentForPullRequest_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.

$sel:pullRequestId:PostCommentForPullRequest', postCommentForPullRequest_pullRequestId - The system-generated ID of the pull request. To get this ID, use ListPullRequests.

$sel:repositoryName:PostCommentForPullRequest', postCommentForPullRequest_repositoryName - The name of the repository where you want to post a comment on a pull request.

$sel:beforeCommitId:PostCommentForPullRequest', postCommentForPullRequest_beforeCommitId - The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

$sel:afterCommitId:PostCommentForPullRequest', postCommentForPullRequest_afterCommitId - The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

$sel:content:PostCommentForPullRequest', postCommentForPullRequest_content - The content of your comment on the change.

Request Lenses

postCommentForPullRequest_location :: Lens' PostCommentForPullRequest (Maybe Location) Source #

The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

postCommentForPullRequest_clientRequestToken :: Lens' PostCommentForPullRequest (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.

postCommentForPullRequest_pullRequestId :: Lens' PostCommentForPullRequest Text Source #

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

postCommentForPullRequest_repositoryName :: Lens' PostCommentForPullRequest Text Source #

The name of the repository where you want to post a comment on a pull request.

postCommentForPullRequest_beforeCommitId :: Lens' PostCommentForPullRequest Text Source #

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

postCommentForPullRequest_afterCommitId :: Lens' PostCommentForPullRequest Text Source #

The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

postCommentForPullRequest_content :: Lens' PostCommentForPullRequest Text Source #

The content of your comment on the change.

Destructuring the Response

data PostCommentForPullRequestResponse Source #

See: newPostCommentForPullRequestResponse smart constructor.

Constructors

PostCommentForPullRequestResponse'

Fields

beforeBlobId :: Maybe Text
In the directionality of the pull request, the blob ID of the before blob.
location :: Maybe Location
The location of the change where you posted your comment.
afterCommitId :: Maybe Text
The full commit ID of the commit in the destination branch where the pull request is merged.
pullRequestId :: Maybe Text
The system-generated ID of the pull request.
afterBlobId :: Maybe Text
In the directionality of the pull request, the blob ID of the after blob.
beforeCommitId :: Maybe Text
The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.
repositoryName :: Maybe Text
The name of the repository where you posted a comment on a pull request.
comment :: Maybe Comment
The content of the comment you posted.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest Methods (==) :: PostCommentForPullRequestResponse -> PostCommentForPullRequestResponse -> Bool # (/=) :: PostCommentForPullRequestResponse -> PostCommentForPullRequestResponse -> Bool #
Read PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest Methods readsPrec :: Int -> ReadS PostCommentForPullRequestResponse # readList :: ReadS [PostCommentForPullRequestResponse] # readPrec :: ReadPrec PostCommentForPullRequestResponse # readListPrec :: ReadPrec [PostCommentForPullRequestResponse] #
Show PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest Methods showsPrec :: Int -> PostCommentForPullRequestResponse -> ShowS # show :: PostCommentForPullRequestResponse -> String # showList :: [PostCommentForPullRequestResponse] -> ShowS #
Generic PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest Associated Types type Rep PostCommentForPullRequestResponse :: Type -> Type # Methods from :: PostCommentForPullRequestResponse -> Rep PostCommentForPullRequestResponse x # to :: Rep PostCommentForPullRequestResponse x -> PostCommentForPullRequestResponse #
NFData PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest Methods rnf :: PostCommentForPullRequestResponse -> () #
type Rep PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest type Rep PostCommentForPullRequestResponse = D1 ('MetaData "PostCommentForPullRequestResponse" "Amazonka.CodeCommit.PostCommentForPullRequest" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "PostCommentForPullRequestResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "beforeBlobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Location))) :: (S1 ('MetaSel ('Just "afterCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pullRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "afterBlobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "beforeCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Comment)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newPostCommentForPullRequestResponse Source #

Arguments

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

Create a value of PostCommentForPullRequestResponse 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:beforeBlobId:PostCommentForPullRequestResponse', postCommentForPullRequestResponse_beforeBlobId - In the directionality of the pull request, the blob ID of the before blob.

$sel:location:PostCommentForPullRequest', postCommentForPullRequestResponse_location - The location of the change where you posted your comment.

$sel:afterCommitId:PostCommentForPullRequest', postCommentForPullRequestResponse_afterCommitId - The full commit ID of the commit in the destination branch where the pull request is merged.

$sel:pullRequestId:PostCommentForPullRequest', postCommentForPullRequestResponse_pullRequestId - The system-generated ID of the pull request.

$sel:afterBlobId:PostCommentForPullRequestResponse', postCommentForPullRequestResponse_afterBlobId - In the directionality of the pull request, the blob ID of the after blob.

$sel:beforeCommitId:PostCommentForPullRequest', postCommentForPullRequestResponse_beforeCommitId - The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.

$sel:repositoryName:PostCommentForPullRequest', postCommentForPullRequestResponse_repositoryName - The name of the repository where you posted a comment on a pull request.

$sel:comment:PostCommentForPullRequestResponse', postCommentForPullRequestResponse_comment - The content of the comment you posted.

$sel:httpStatus:PostCommentForPullRequestResponse', postCommentForPullRequestResponse_httpStatus - The response's http status code.

Response Lenses

postCommentForPullRequestResponse_beforeBlobId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #

In the directionality of the pull request, the blob ID of the before blob.

postCommentForPullRequestResponse_location :: Lens' PostCommentForPullRequestResponse (Maybe Location) Source #

The location of the change where you posted your comment.

postCommentForPullRequestResponse_afterCommitId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #

The full commit ID of the commit in the destination branch where the pull request is merged.

postCommentForPullRequestResponse_pullRequestId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #

The system-generated ID of the pull request.

postCommentForPullRequestResponse_afterBlobId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #

In the directionality of the pull request, the blob ID of the after blob.

postCommentForPullRequestResponse_beforeCommitId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #

The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.

postCommentForPullRequestResponse_repositoryName :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #

The name of the repository where you posted a comment on a pull request.

postCommentForPullRequestResponse_comment :: Lens' PostCommentForPullRequestResponse (Maybe Comment) Source #

The content of the comment you posted.

postCommentForPullRequestResponse_httpStatus :: Lens' PostCommentForPullRequestResponse Int Source #

The response's http status code.