Amazonka.Amplify.ListBranches

Lists the branches of an Amplify app.

This operation returns paginated results.

Creating a Request

data ListBranches

The request structure for the list branches request.

See: newListBranches smart constructor.

Constructors

ListBranches'

Fields

• maxResults :: Maybe Natural

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

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

• appId :: Text

  The unique ID for an Amplify app.

Instances

ToHeaders ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

toHeaders :: ListBranches -> [Header]

ToPath ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

toPath :: ListBranches -> ByteString

ToQuery ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

toQuery :: ListBranches -> QueryString

AWSPager ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

page :: ListBranches -> AWSResponse ListBranches -> Maybe ListBranches

AWSRequest ListBranches

Defined in Amazonka.Amplify.ListBranches

Associated Types

type AWSResponse ListBranches

Methods

request :: (Service -> Service) -> ListBranches -> Request ListBranches

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBranches -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBranches)))

Generic ListBranches

Defined in Amazonka.Amplify.ListBranches

Associated Types

type Rep ListBranches :: Type -> Type

Methods

from :: ListBranches -> Rep ListBranches x

to :: Rep ListBranches x -> ListBranches

Read ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

readsPrec :: Int -> ReadS ListBranches

readList :: ReadS [ListBranches]

readPrec :: ReadPrec ListBranches

readListPrec :: ReadPrec [ListBranches]

Show ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

showsPrec :: Int -> ListBranches -> ShowS

show :: ListBranches -> String

showList :: [ListBranches] -> ShowS

NFData ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

rnf :: ListBranches -> ()

Eq ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

(==) :: ListBranches -> ListBranches -> Bool

(/=) :: ListBranches -> ListBranches -> Bool

Hashable ListBranches

Defined in Amazonka.Amplify.ListBranches

Methods

hashWithSalt :: Int -> ListBranches -> Int

hash :: ListBranches -> Int

type AWSResponse ListBranches

Defined in Amazonka.Amplify.ListBranches

type AWSResponse ListBranches = ListBranchesResponse

type Rep ListBranches

Defined in Amazonka.Amplify.ListBranches

type Rep ListBranches = D1 ('MetaData "ListBranches" "Amazonka.Amplify.ListBranches" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "ListBranches'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListBranches

Arguments

:: Text

ListBranches

-> ListBranches

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:maxResults:ListBranches', listBranches_maxResults - The maximum number of records to list in a single response.

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.

ListBranches, listBranches_appId - The unique ID for an Amplify app.

Request Lenses

listBranches_maxResults :: Lens' ListBranches (Maybe Natural)

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

listBranches_nextToken :: Lens' ListBranches (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.

listBranches_appId :: Lens' ListBranches Text

The unique ID for an Amplify app.

Destructuring the Response

data ListBranchesResponse

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

Generic ListBranchesResponse

Defined in Amazonka.Amplify.ListBranches

Associated Types

type Rep ListBranchesResponse :: Type -> Type

Methods

from :: ListBranchesResponse -> Rep ListBranchesResponse x

to :: Rep ListBranchesResponse x -> ListBranchesResponse

Show ListBranchesResponse

Defined in Amazonka.Amplify.ListBranches

Methods

showsPrec :: Int -> ListBranchesResponse -> ShowS

show :: ListBranchesResponse -> String

showList :: [ListBranchesResponse] -> ShowS

NFData ListBranchesResponse

Defined in Amazonka.Amplify.ListBranches

Methods

rnf :: ListBranchesResponse -> ()

Eq ListBranchesResponse

Defined in Amazonka.Amplify.ListBranches

Methods

(==) :: ListBranchesResponse -> ListBranchesResponse -> Bool

(/=) :: ListBranchesResponse -> ListBranchesResponse -> Bool

type Rep ListBranchesResponse

Defined in Amazonka.Amplify.ListBranches

type Rep ListBranchesResponse = D1 ('MetaData "ListBranchesResponse" "Amazonka.Amplify.ListBranches" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" '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

Arguments

:: Int

$sel:httpStatus:ListBranchesResponse'

-> ListBranchesResponse

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:

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)

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_httpStatus :: Lens' ListBranchesResponse Int

The response's http status code.

listBranchesResponse_branches :: Lens' ListBranchesResponse [Branch]

A list of branches for an Amplify app.