amazonka-location-2.0: Amazon Location Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Location.ListGeofences

Description

Lists geofences stored in a given geofence collection.

This operation returns paginated results.

Synopsis

Creating a Request

data ListGeofences Source #

See: newListGeofences smart constructor.

Constructors

ListGeofences' 

Fields

  • maxResults :: Maybe Natural

    An optional limit for the number of geofences returned in a single call.

    Default value: 100

  • nextToken :: Maybe Text

    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

  • collectionName :: Text

    The name of the geofence collection storing the list of geofences.

Instances

Instances details
ToJSON ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

ToHeaders ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

ToPath ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

ToQuery ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

AWSPager ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

AWSRequest ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

Associated Types

type AWSResponse ListGeofences #

Generic ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

Associated Types

type Rep ListGeofences :: Type -> Type #

Read ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

Show ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

NFData ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

Methods

rnf :: ListGeofences -> () #

Eq ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

Hashable ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

type AWSResponse ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

type Rep ListGeofences Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

type Rep ListGeofences = D1 ('MetaData "ListGeofences" "Amazonka.Location.ListGeofences" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "ListGeofences'" '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 "collectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListGeofences Source #

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

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

  • entries :: [ListGeofenceResponseEntry]

    Contains a list of geofences stored in the geofence collection.

Instances

Instances details
Generic ListGeofencesResponse Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

Associated Types

type Rep ListGeofencesResponse :: Type -> Type #

Show ListGeofencesResponse Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

NFData ListGeofencesResponse Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

Methods

rnf :: ListGeofencesResponse -> () #

Eq ListGeofencesResponse Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

type Rep ListGeofencesResponse Source # 
Instance details

Defined in Amazonka.Location.ListGeofences

type Rep ListGeofencesResponse = D1 ('MetaData "ListGeofencesResponse" "Amazonka.Location.ListGeofences" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "ListGeofencesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListGeofenceResponseEntry]))))

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_entries :: Lens' ListGeofencesResponse [ListGeofenceResponseEntry] Source #

Contains a list of geofences stored in the geofence collection.