libZSservicesZSamazonka-codecommitZSamazonka-codecommit
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeCommit.GetCommentsForPullRequest

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.

  • nextToken :: Maybe Text

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

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

  • repositoryName :: Maybe Text

    The name of the repository that contains the pull request.

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

  • pullRequestId :: Text

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

Instances

Instances details
Eq GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Read GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Show GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Generic GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Associated Types

type Rep GetCommentsForPullRequest :: Type -> Type #

NFData GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Hashable GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

ToJSON GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

AWSPager GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

AWSRequest GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

ToHeaders GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

ToPath GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

ToQuery GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

type Rep GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

type Rep GetCommentsForPullRequest = D1 ('MetaData "GetCommentsForPullRequest" "Amazonka.CodeCommit.GetCommentsForPullRequest" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "GetCommentsForPullRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "afterCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") '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 "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "pullRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse GetCommentsForPullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

newGetCommentsForPullRequest Source #

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:

$sel:afterCommitId: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.

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

$sel:beforeCommitId: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:repositoryName:GetCommentsForPullRequest', getCommentsForPullRequest_repositoryName - The name of the repository that contains the pull request.

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

$sel:pullRequestId: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_nextToken :: Lens' GetCommentsForPullRequest (Maybe Text) Source #

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

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

The name of the repository that contains the pull request.

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

Instances

Instances details
Eq GetCommentsForPullRequestResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Read GetCommentsForPullRequestResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Show GetCommentsForPullRequestResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Generic GetCommentsForPullRequestResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

Associated Types

type Rep GetCommentsForPullRequestResponse :: Type -> Type #

NFData GetCommentsForPullRequestResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

type Rep GetCommentsForPullRequestResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForPullRequest

type Rep GetCommentsForPullRequestResponse = D1 ('MetaData "GetCommentsForPullRequestResponse" "Amazonka.CodeCommit.GetCommentsForPullRequest" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" '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 #

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.

$sel:nextToken: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_nextToken :: Lens' GetCommentsForPullRequestResponse (Maybe Text) Source #

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