Amazonka.Location.ListGeofences

Lists geofences stored in a given geofence collection.

This operation returns paginated results.

Creating a Request

data ListGeofences

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

ToJSON ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

toJSON :: ListGeofences -> Value

toEncoding :: ListGeofences -> Encoding

toJSONList :: [ListGeofences] -> Value

toEncodingList :: [ListGeofences] -> Encoding

ToHeaders ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

toHeaders :: ListGeofences -> [Header]

ToPath ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

toPath :: ListGeofences -> ByteString

ToQuery ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

toQuery :: ListGeofences -> QueryString

AWSPager ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

page :: ListGeofences -> AWSResponse ListGeofences -> Maybe ListGeofences

AWSRequest ListGeofences

Defined in Amazonka.Location.ListGeofences

Associated Types

type AWSResponse ListGeofences

Methods

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

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

Generic ListGeofences

Defined in Amazonka.Location.ListGeofences

Associated Types

type Rep ListGeofences :: Type -> Type

Methods

from :: ListGeofences -> Rep ListGeofences x

to :: Rep ListGeofences x -> ListGeofences

Read ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

readsPrec :: Int -> ReadS ListGeofences

readList :: ReadS [ListGeofences]

readPrec :: ReadPrec ListGeofences

readListPrec :: ReadPrec [ListGeofences]

Show ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

showsPrec :: Int -> ListGeofences -> ShowS

show :: ListGeofences -> String

showList :: [ListGeofences] -> ShowS

NFData ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

rnf :: ListGeofences -> ()

Eq ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

(==) :: ListGeofences -> ListGeofences -> Bool

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

Hashable ListGeofences

Defined in Amazonka.Location.ListGeofences

Methods

hashWithSalt :: Int -> ListGeofences -> Int

hash :: ListGeofences -> Int

type AWSResponse ListGeofences

Defined in Amazonka.Location.ListGeofences

type AWSResponse ListGeofences = ListGeofencesResponse

type Rep ListGeofences

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

Arguments

:: Text

ListGeofences

-> 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)

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

Default value: 100

listGeofences_nextToken :: Lens' ListGeofences (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

listGeofences_collectionName :: Lens' ListGeofences Text

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

Destructuring the Response

data ListGeofencesResponse

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

Generic ListGeofencesResponse

Defined in Amazonka.Location.ListGeofences

Associated Types

type Rep ListGeofencesResponse :: Type -> Type

Methods

from :: ListGeofencesResponse -> Rep ListGeofencesResponse x

to :: Rep ListGeofencesResponse x -> ListGeofencesResponse

Show ListGeofencesResponse

Defined in Amazonka.Location.ListGeofences

Methods

showsPrec :: Int -> ListGeofencesResponse -> ShowS

show :: ListGeofencesResponse -> String

showList :: [ListGeofencesResponse] -> ShowS

NFData ListGeofencesResponse

Defined in Amazonka.Location.ListGeofences

Methods

rnf :: ListGeofencesResponse -> ()

Eq ListGeofencesResponse

Defined in Amazonka.Location.ListGeofences

Methods

(==) :: ListGeofencesResponse -> ListGeofencesResponse -> Bool

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

type Rep ListGeofencesResponse

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

Arguments

:: Int

$sel:httpStatus:ListGeofencesResponse'

-> ListGeofencesResponse

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)

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

The response's http status code.

listGeofencesResponse_entries :: Lens' ListGeofencesResponse [ListGeofenceResponseEntry]

Contains a list of geofences stored in the geofence collection.