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

Description

Returns information about comments made on the comparison between two commits.

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 GetCommentsForComparedCommit Source #

See: newGetCommentsForComparedCommit smart constructor.

Constructors

GetCommentsForComparedCommit' 

Fields

  • nextToken :: Maybe Text

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

  • beforeCommitId :: Maybe Text

    To establish the directionality of the comparison, the full commit ID of the before commit.

  • maxResults :: Maybe Int

    A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments, but you can configure up to 500.

  • repositoryName :: Text

    The name of the repository where you want to compare commits.

  • afterCommitId :: Text

    To establish the directionality of the comparison, the full commit ID of the after commit.

Instances

Instances details
Eq GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

Read GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

Show GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

Generic GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

Associated Types

type Rep GetCommentsForComparedCommit :: Type -> Type #

NFData GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

Hashable GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

ToJSON GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

AWSPager GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

AWSRequest GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

ToHeaders GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

ToPath GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

ToQuery GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

type Rep GetCommentsForComparedCommit Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

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

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

newGetCommentsForComparedCommit Source #

Create a value of GetCommentsForComparedCommit 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:nextToken:GetCommentsForComparedCommit', getCommentsForComparedCommit_nextToken - An enumeration token that when provided in a request, returns the next batch of the results.

$sel:beforeCommitId:GetCommentsForComparedCommit', getCommentsForComparedCommit_beforeCommitId - To establish the directionality of the comparison, the full commit ID of the before commit.

$sel:maxResults:GetCommentsForComparedCommit', getCommentsForComparedCommit_maxResults - A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments, but you can configure up to 500.

$sel:repositoryName:GetCommentsForComparedCommit', getCommentsForComparedCommit_repositoryName - The name of the repository where you want to compare commits.

$sel:afterCommitId:GetCommentsForComparedCommit', getCommentsForComparedCommit_afterCommitId - To establish the directionality of the comparison, the full commit ID of the after commit.

Request Lenses

getCommentsForComparedCommit_nextToken :: Lens' GetCommentsForComparedCommit (Maybe Text) Source #

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

getCommentsForComparedCommit_beforeCommitId :: Lens' GetCommentsForComparedCommit (Maybe Text) Source #

To establish the directionality of the comparison, the full commit ID of the before commit.

getCommentsForComparedCommit_maxResults :: Lens' GetCommentsForComparedCommit (Maybe Int) Source #

A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments, but you can configure up to 500.

getCommentsForComparedCommit_repositoryName :: Lens' GetCommentsForComparedCommit Text Source #

The name of the repository where you want to compare commits.

getCommentsForComparedCommit_afterCommitId :: Lens' GetCommentsForComparedCommit Text Source #

To establish the directionality of the comparison, the full commit ID of the after commit.

Destructuring the Response

data GetCommentsForComparedCommitResponse Source #

Constructors

GetCommentsForComparedCommitResponse' 

Fields

Instances

Instances details
Eq GetCommentsForComparedCommitResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

Read GetCommentsForComparedCommitResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

Show GetCommentsForComparedCommitResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

Generic GetCommentsForComparedCommitResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

NFData GetCommentsForComparedCommitResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

type Rep GetCommentsForComparedCommitResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.GetCommentsForComparedCommit

type Rep GetCommentsForComparedCommitResponse = D1 ('MetaData "GetCommentsForComparedCommitResponse" "Amazonka.CodeCommit.GetCommentsForComparedCommit" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "GetCommentsForComparedCommitResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commentsForComparedCommitData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CommentsForComparedCommit])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetCommentsForComparedCommitResponse Source #

Create a value of GetCommentsForComparedCommitResponse 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:commentsForComparedCommitData:GetCommentsForComparedCommitResponse', getCommentsForComparedCommitResponse_commentsForComparedCommitData - A list of comment objects on the compared commit.

$sel:nextToken:GetCommentsForComparedCommit', getCommentsForComparedCommitResponse_nextToken - An enumeration token that can be used in a request to return the next batch of the results.

$sel:httpStatus:GetCommentsForComparedCommitResponse', getCommentsForComparedCommitResponse_httpStatus - The response's http status code.

Response Lenses

getCommentsForComparedCommitResponse_nextToken :: Lens' GetCommentsForComparedCommitResponse (Maybe Text) Source #

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