| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Amplify.ListBranches
Description
Lists the branches of an Amplify app.
This operation returns paginated results.
Synopsis
- data ListBranches = ListBranches' {}
- newListBranches :: Text -> ListBranches
- listBranches_maxResults :: Lens' ListBranches (Maybe Natural)
- listBranches_nextToken :: Lens' ListBranches (Maybe Text)
- listBranches_appId :: Lens' ListBranches Text
- data ListBranchesResponse = ListBranchesResponse' {}
- newListBranchesResponse :: Int -> ListBranchesResponse
- listBranchesResponse_nextToken :: Lens' ListBranchesResponse (Maybe Text)
- listBranchesResponse_httpStatus :: Lens' ListBranchesResponse Int
- listBranchesResponse_branches :: Lens' ListBranchesResponse [Branch]
Creating a Request
data ListBranches Source #
The request structure for the list branches request.
See: newListBranches smart constructor.
Constructors
| ListBranches' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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) Source #
The maximum number of records to list in a single response.
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_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' | |
Instances
newListBranchesResponse Source #
Arguments
| :: Int | |
| -> 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) 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_httpStatus :: Lens' ListBranchesResponse Int Source #
The response's http status code.
listBranchesResponse_branches :: Lens' ListBranchesResponse [Branch] Source #
A list of branches for an Amplify app.