| 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.Location.ListGeofences
Description
Lists geofences stored in a given geofence collection.
This operation returns paginated results.
Synopsis
- data ListGeofences = ListGeofences' {}
- newListGeofences :: Text -> ListGeofences
- listGeofences_maxResults :: Lens' ListGeofences (Maybe Natural)
- listGeofences_nextToken :: Lens' ListGeofences (Maybe Text)
- listGeofences_collectionName :: Lens' ListGeofences Text
- data ListGeofencesResponse = ListGeofencesResponse' {}
- newListGeofencesResponse :: Int -> ListGeofencesResponse
- listGeofencesResponse_nextToken :: Lens' ListGeofencesResponse (Maybe Text)
- listGeofencesResponse_httpStatus :: Lens' ListGeofencesResponse Int
- listGeofencesResponse_entries :: Lens' ListGeofencesResponse [ListGeofenceResponseEntry]
Creating a Request
data ListGeofences Source #
See: newListGeofences smart constructor.
Constructors
| ListGeofences' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListGeofences |
Create a value of ListGeofences 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:
ListGeofences, listGeofences_maxResults - An optional limit for the number of geofences returned in a single call.
Default value: 100
ListGeofences, listGeofences_nextToken - The pagination token specifying which page of results to return in the
response. If no token is provided, the default page is the first page.
Default value: null
ListGeofences, listGeofences_collectionName - The name of the geofence collection storing the list of geofences.
Request Lenses
listGeofences_maxResults :: Lens' ListGeofences (Maybe Natural) Source #
An optional limit for the number of geofences returned in a single call.
Default value: 100
listGeofences_nextToken :: Lens' ListGeofences (Maybe Text) Source #
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
listGeofences_collectionName :: Lens' ListGeofences Text Source #
The name of the geofence collection storing the list of geofences.
Destructuring the Response
data ListGeofencesResponse Source #
See: newListGeofencesResponse smart constructor.
Constructors
| ListGeofencesResponse' | |
Fields
| |
Instances
newListGeofencesResponse Source #
Create a value of ListGeofencesResponse 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:
ListGeofences, listGeofencesResponse_nextToken - A pagination token indicating there are additional pages available. You
can use the token in a following request to fetch the next set of
results.
$sel:httpStatus:ListGeofencesResponse', listGeofencesResponse_httpStatus - The response's http status code.
$sel:entries:ListGeofencesResponse', listGeofencesResponse_entries - Contains a list of geofences stored in the geofence collection.
Response Lenses
listGeofencesResponse_nextToken :: Lens' ListGeofencesResponse (Maybe Text) Source #
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
listGeofencesResponse_httpStatus :: Lens' ListGeofencesResponse Int Source #
The response's http status code.
listGeofencesResponse_entries :: Lens' ListGeofencesResponse [ListGeofenceResponseEntry] Source #
Contains a list of geofences stored in the geofence collection.