libZSservicesZSamazonka-amplifyZSamazonka-amplify
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.Amplify.ListBranches

Description

Lists the branches of an Amplify app.

This operation returns paginated results.

Synopsis

Creating a Request

data ListBranches Source #

The request structure for the list branches request.

See: newListBranches smart constructor.

Constructors

ListBranches' 

Fields

  • nextToken :: Maybe Text

    A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.

  • maxResults :: Maybe Natural

    The maximum number of records to list in a single response.

  • appId :: Text

    The unique ID for an Amplify app.

Instances

Instances details
Eq ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Read ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Show ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Generic ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Associated Types

type Rep ListBranches :: Type -> Type #

NFData ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Methods

rnf :: ListBranches -> () #

Hashable ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

AWSPager ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

AWSRequest ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Associated Types

type AWSResponse ListBranches #

ToHeaders ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

ToPath ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

ToQuery ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

type Rep ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

type Rep ListBranches = D1 ('MetaData "ListBranches" "Amazonka.Amplify.ListBranches" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "ListBranches'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListBranches Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

newListBranches Source #

Create a value of ListBranches 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:ListBranches', listBranches_nextToken - A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.

$sel:maxResults:ListBranches', listBranches_maxResults - The maximum number of records to list in a single response.

$sel:appId:ListBranches', listBranches_appId - The unique ID for an Amplify app.

Request Lenses

listBranches_nextToken :: Lens' ListBranches (Maybe Text) Source #

A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.

listBranches_maxResults :: Lens' ListBranches (Maybe Natural) Source #

The maximum number of records to list in a single response.

listBranches_appId :: Lens' ListBranches Text Source #

The unique ID for an Amplify app.

Destructuring the Response

data ListBranchesResponse Source #

The result structure for the list branches request.

See: newListBranchesResponse smart constructor.

Constructors

ListBranchesResponse' 

Fields

  • nextToken :: Maybe Text

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

  • httpStatus :: Int

    The response's http status code.

  • branches :: [Branch]

    A list of branches for an Amplify app.

Instances

Instances details
Eq ListBranchesResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Show ListBranchesResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Generic ListBranchesResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Associated Types

type Rep ListBranchesResponse :: Type -> Type #

NFData ListBranchesResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

Methods

rnf :: ListBranchesResponse -> () #

type Rep ListBranchesResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListBranches

type Rep ListBranchesResponse = D1 ('MetaData "ListBranchesResponse" "Amazonka.Amplify.ListBranches" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "ListBranchesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "branches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Branch]))))

newListBranchesResponse Source #

Create a value of ListBranchesResponse 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:ListBranches', listBranchesResponse_nextToken - A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

$sel:httpStatus:ListBranchesResponse', listBranchesResponse_httpStatus - The response's http status code.

$sel:branches:ListBranchesResponse', listBranchesResponse_branches - A list of branches for an Amplify app.

Response Lenses

listBranchesResponse_nextToken :: Lens' ListBranchesResponse (Maybe Text) Source #

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

listBranchesResponse_branches :: Lens' ListBranchesResponse [Branch] Source #

A list of branches for an Amplify app.