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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns comments made on a pull request.

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.

This operation returns paginated results.

Synopsis

Creating a Request

data GetCommentsForPullRequest Source #

See: newGetCommentsForPullRequest smart constructor.

Constructors

GetCommentsForPullRequest'

Fields

afterCommitId :: Maybe Text
The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.
beforeCommitId :: Maybe 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.
maxResults :: Maybe Int
A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.
nextToken :: Maybe Text
An enumeration token that, when provided in a request, returns the next batch of the results.
repositoryName :: Maybe Text
The name of the repository that contains the pull request.
pullRequestId :: Text
The system-generated ID of the pull request. To get this ID, use ListPullRequests.

Instances

Instances details

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

newGetCommentsForPullRequest Source #

Arguments

:: Text	`GetCommentsForPullRequest`
-> GetCommentsForPullRequest

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

GetCommentsForPullRequest, getCommentsForPullRequest_afterCommitId - The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.

GetCommentsForPullRequest, getCommentsForPullRequest_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:maxResults:GetCommentsForPullRequest', getCommentsForPullRequest_maxResults - A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.

GetCommentsForPullRequest, getCommentsForPullRequest_nextToken - An enumeration token that, when provided in a request, returns the next batch of the results.

GetCommentsForPullRequest, getCommentsForPullRequest_repositoryName - The name of the repository that contains the pull request.

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

Request Lenses

getCommentsForPullRequest_afterCommitId :: Lens' GetCommentsForPullRequest (Maybe Text) Source #

The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.

getCommentsForPullRequest_beforeCommitId :: Lens' GetCommentsForPullRequest (Maybe 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.

getCommentsForPullRequest_maxResults :: Lens' GetCommentsForPullRequest (Maybe Int) Source #

A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.

getCommentsForPullRequest_nextToken :: Lens' GetCommentsForPullRequest (Maybe Text) Source #

An enumeration token that, when provided in a request, returns the next batch of the results.

getCommentsForPullRequest_repositoryName :: Lens' GetCommentsForPullRequest (Maybe Text) Source #

The name of the repository that contains the pull request.

getCommentsForPullRequest_pullRequestId :: Lens' GetCommentsForPullRequest Text Source #

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

Destructuring the Response

data GetCommentsForPullRequestResponse Source #

See: newGetCommentsForPullRequestResponse smart constructor.

Constructors

GetCommentsForPullRequestResponse'
Fields commentsForPullRequestData :: Maybe [CommentsForPullRequest] An array of comment objects on the pull request. nextToken :: Maybe Text An enumeration token that can be used in a request to return the next batch of the results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetCommentsForPullRequestResponse Source #

Arguments

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

Create a value of GetCommentsForPullRequestResponse 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:commentsForPullRequestData:GetCommentsForPullRequestResponse', getCommentsForPullRequestResponse_commentsForPullRequestData - An array of comment objects on the pull request.

GetCommentsForPullRequest, getCommentsForPullRequestResponse_nextToken - An enumeration token that can be used in a request to return the next batch of the results.

$sel:httpStatus:GetCommentsForPullRequestResponse', getCommentsForPullRequestResponse_httpStatus - The response's http status code.

Response Lenses

getCommentsForPullRequestResponse_commentsForPullRequestData :: Lens' GetCommentsForPullRequestResponse (Maybe [CommentsForPullRequest]) Source #

An array of comment objects on the pull request.

getCommentsForPullRequestResponse_nextToken :: Lens' GetCommentsForPullRequestResponse (Maybe Text) Source #

An enumeration token that can be used in a request to return the next batch of the results.

getCommentsForPullRequestResponse_httpStatus :: Lens' GetCommentsForPullRequestResponse Int Source #

The response's http status code.