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

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

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

newPostCommentForPullRequest Source #

Arguments

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

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.

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.

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

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

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.

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.

PostCommentForPullRequest, postCommentForPullRequest_content - The content of your comment on the change.

Request Lenses

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_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_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

afterBlobId :: Maybe Text
In the directionality of the pull request, the blob ID of the after blob.
afterCommitId :: Maybe Text
The full commit ID of the commit in the destination branch where the pull request is merged.
beforeBlobId :: Maybe Text
In the directionality of the pull request, the blob ID of the before 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.
comment :: Maybe Comment
The content of the comment you posted.
location :: Maybe Location
The location of the change where you posted your comment.
pullRequestId :: Maybe Text
The system-generated ID of the pull request.
repositoryName :: Maybe Text
The name of the repository where you posted a comment on a pull request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest Methods rnf :: PostCommentForPullRequestResponse -> () #
Eq PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest Methods (==) :: PostCommentForPullRequestResponse -> PostCommentForPullRequestResponse -> Bool # (/=) :: PostCommentForPullRequestResponse -> PostCommentForPullRequestResponse -> Bool #
type Rep PostCommentForPullRequestResponse Source #
Instance details Defined in Amazonka.CodeCommit.PostCommentForPullRequest type Rep PostCommentForPullRequestResponse = D1 ('MetaData "PostCommentForPullRequestResponse" "Amazonka.CodeCommit.PostCommentForPullRequest" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "PostCommentForPullRequestResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "afterBlobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "afterCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "beforeBlobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "beforeCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Comment)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Location))) :: (S1 ('MetaSel ('Just "pullRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:

PostCommentForPullRequestResponse, postCommentForPullRequestResponse_afterBlobId - In the directionality of the pull request, the blob ID of the after blob.

PostCommentForPullRequest, postCommentForPullRequestResponse_afterCommitId - The full commit ID of the commit in the destination branch where the pull request is merged.

PostCommentForPullRequestResponse, postCommentForPullRequestResponse_beforeBlobId - In the directionality of the pull request, the blob ID of the before blob.

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:comment:PostCommentForPullRequestResponse', postCommentForPullRequestResponse_comment - The content of the comment you posted.

PostCommentForPullRequest, postCommentForPullRequestResponse_location - The location of the change where you posted your comment.

PostCommentForPullRequest, postCommentForPullRequestResponse_pullRequestId - The system-generated ID of the pull request.

PostCommentForPullRequest, postCommentForPullRequestResponse_repositoryName - The name of the repository where you posted a comment on a pull request.

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

Response Lenses

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

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

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_beforeBlobId :: Lens' PostCommentForPullRequestResponse (Maybe Text) Source #

In the directionality of the pull request, the blob ID of the before 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_comment :: Lens' PostCommentForPullRequestResponse (Maybe Comment) Source #

The content of the comment you posted.

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

The location of the change where you posted your comment.

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

The system-generated ID of 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_httpStatus :: Lens' PostCommentForPullRequestResponse Int Source #

The response's http status code.