| 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.GameLift.ListLocations
Description
Lists all custom and Amazon Web Services locations.
This operation returns paginated results.
Synopsis
- data ListLocations = ListLocations' {}
- newListLocations :: ListLocations
- listLocations_filters :: Lens' ListLocations (Maybe (NonEmpty LocationFilter))
- listLocations_limit :: Lens' ListLocations (Maybe Natural)
- listLocations_nextToken :: Lens' ListLocations (Maybe Text)
- data ListLocationsResponse = ListLocationsResponse' {
- locations :: Maybe [LocationModel]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListLocationsResponse :: Int -> ListLocationsResponse
- listLocationsResponse_locations :: Lens' ListLocationsResponse (Maybe [LocationModel])
- listLocationsResponse_nextToken :: Lens' ListLocationsResponse (Maybe Text)
- listLocationsResponse_httpStatus :: Lens' ListLocationsResponse Int
Creating a Request
data ListLocations Source #
See: newListLocations smart constructor.
Constructors
| ListLocations' | |
Fields
| |
Instances
newListLocations :: ListLocations Source #
Create a value of ListLocations 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:filters:ListLocations', listLocations_filters - Filters the list for AWS or CUSTOM locations.
$sel:limit:ListLocations', listLocations_limit - The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
ListLocations, listLocations_nextToken - A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation.
To start at the beginning of the result set, do not specify a value.
Request Lenses
listLocations_filters :: Lens' ListLocations (Maybe (NonEmpty LocationFilter)) Source #
Filters the list for AWS or CUSTOM locations.
listLocations_limit :: Lens' ListLocations (Maybe Natural) Source #
The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
listLocations_nextToken :: Lens' ListLocations (Maybe Text) Source #
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
Destructuring the Response
data ListLocationsResponse Source #
See: newListLocationsResponse smart constructor.
Constructors
| ListLocationsResponse' | |
Fields
| |
Instances
newListLocationsResponse Source #
Create a value of ListLocationsResponse 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:locations:ListLocationsResponse', listLocationsResponse_locations - A collection of locations.
ListLocations, listLocationsResponse_nextToken - A token that indicates where to resume retrieving results on the next
call to this operation. If no token is returned, these results represent
the end of the list.
$sel:httpStatus:ListLocationsResponse', listLocationsResponse_httpStatus - The response's http status code.
Response Lenses
listLocationsResponse_locations :: Lens' ListLocationsResponse (Maybe [LocationModel]) Source #
A collection of locations.
listLocationsResponse_nextToken :: Lens' ListLocationsResponse (Maybe Text) Source #
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
listLocationsResponse_httpStatus :: Lens' ListLocationsResponse Int Source #
The response's http status code.