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

Description

Returns information about the contents of one or more commits in a repository.

Synopsis

Creating a Request

data BatchGetCommits Source #

See: newBatchGetCommits smart constructor.

Constructors

BatchGetCommits' 

Fields

  • commitIds :: [Text]

    The full commit IDs of the commits to get information about.

    You must supply the full SHA IDs of each commit. You cannot use shortened SHA IDs.

  • repositoryName :: Text

    The name of the repository that contains the commits.

Instances

Instances details
Eq BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Read BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Show BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Generic BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Associated Types

type Rep BatchGetCommits :: Type -> Type #

NFData BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Methods

rnf :: BatchGetCommits -> () #

Hashable BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

ToJSON BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

AWSRequest BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Associated Types

type AWSResponse BatchGetCommits #

ToHeaders BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

ToPath BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

ToQuery BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

type Rep BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

type Rep BatchGetCommits = D1 ('MetaData "BatchGetCommits" "Amazonka.CodeCommit.BatchGetCommits" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "BatchGetCommits'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commitIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse BatchGetCommits Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

newBatchGetCommits Source #

Create a value of BatchGetCommits 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:commitIds:BatchGetCommits', batchGetCommits_commitIds - The full commit IDs of the commits to get information about.

You must supply the full SHA IDs of each commit. You cannot use shortened SHA IDs.

$sel:repositoryName:BatchGetCommits', batchGetCommits_repositoryName - The name of the repository that contains the commits.

Request Lenses

batchGetCommits_commitIds :: Lens' BatchGetCommits [Text] Source #

The full commit IDs of the commits to get information about.

You must supply the full SHA IDs of each commit. You cannot use shortened SHA IDs.

batchGetCommits_repositoryName :: Lens' BatchGetCommits Text Source #

The name of the repository that contains the commits.

Destructuring the Response

data BatchGetCommitsResponse Source #

See: newBatchGetCommitsResponse smart constructor.

Constructors

BatchGetCommitsResponse' 

Fields

  • commits :: Maybe [Commit]

    An array of commit data type objects, each of which contains information about a specified commit.

  • errors :: Maybe [BatchGetCommitsError]

    Returns any commit IDs for which information could not be found. For example, if one of the commit IDs was a shortened SHA ID or that commit was not found in the specified repository, the ID returns an error object with more information.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq BatchGetCommitsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Read BatchGetCommitsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Show BatchGetCommitsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Generic BatchGetCommitsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Associated Types

type Rep BatchGetCommitsResponse :: Type -> Type #

NFData BatchGetCommitsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

Methods

rnf :: BatchGetCommitsResponse -> () #

type Rep BatchGetCommitsResponse Source # 
Instance details

Defined in Amazonka.CodeCommit.BatchGetCommits

type Rep BatchGetCommitsResponse = D1 ('MetaData "BatchGetCommitsResponse" "Amazonka.CodeCommit.BatchGetCommits" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "BatchGetCommitsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Commit])) :*: (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchGetCommitsError])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchGetCommitsResponse Source #

Create a value of BatchGetCommitsResponse 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:commits:BatchGetCommitsResponse', batchGetCommitsResponse_commits - An array of commit data type objects, each of which contains information about a specified commit.

$sel:errors:BatchGetCommitsResponse', batchGetCommitsResponse_errors - Returns any commit IDs for which information could not be found. For example, if one of the commit IDs was a shortened SHA ID or that commit was not found in the specified repository, the ID returns an error object with more information.

$sel:httpStatus:BatchGetCommitsResponse', batchGetCommitsResponse_httpStatus - The response's http status code.

Response Lenses

batchGetCommitsResponse_commits :: Lens' BatchGetCommitsResponse (Maybe [Commit]) Source #

An array of commit data type objects, each of which contains information about a specified commit.

batchGetCommitsResponse_errors :: Lens' BatchGetCommitsResponse (Maybe [BatchGetCommitsError]) Source #

Returns any commit IDs for which information could not be found. For example, if one of the commit IDs was a shortened SHA ID or that commit was not found in the specified repository, the ID returns an error object with more information.