libZSservicesZSamazonka-locationZSamazonka-location
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Location.ListDevicePositions

Description

A batch request to retrieve all device positions.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDevicePositions Source #

See: newListDevicePositions smart constructor.

Constructors

ListDevicePositions' 

Fields

  • 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

  • maxResults :: Maybe Natural

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

    Default value: 100

  • trackerName :: Text

    The tracker resource containing the requested devices.

Instances

Instances details
Eq ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Read ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Show ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Generic ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Associated Types

type Rep ListDevicePositions :: Type -> Type #

NFData ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Methods

rnf :: ListDevicePositions -> () #

Hashable ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

ToJSON ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

AWSPager ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

AWSRequest ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Associated Types

type AWSResponse ListDevicePositions #

ToHeaders ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

ToPath ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

ToQuery ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

type Rep ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

type Rep ListDevicePositions = D1 ('MetaData "ListDevicePositions" "Amazonka.Location.ListDevicePositions" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "ListDevicePositions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListDevicePositions Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

newListDevicePositions Source #

Create a value of ListDevicePositions 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:nextToken:ListDevicePositions', listDevicePositions_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

$sel:maxResults:ListDevicePositions', listDevicePositions_maxResults - An optional limit for the number of entries returned in a single call.

Default value: 100

$sel:trackerName:ListDevicePositions', listDevicePositions_trackerName - The tracker resource containing the requested devices.

Request Lenses

listDevicePositions_nextToken :: Lens' ListDevicePositions (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

listDevicePositions_maxResults :: Lens' ListDevicePositions (Maybe Natural) Source #

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

Default value: 100

listDevicePositions_trackerName :: Lens' ListDevicePositions Text Source #

The tracker resource containing the requested devices.

Destructuring the Response

data ListDevicePositionsResponse Source #

See: newListDevicePositionsResponse smart constructor.

Constructors

ListDevicePositionsResponse' 

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 :: [ListDevicePositionsResponseEntry]

    Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.

Instances

Instances details
Eq ListDevicePositionsResponse Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Show ListDevicePositionsResponse Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Generic ListDevicePositionsResponse Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

Associated Types

type Rep ListDevicePositionsResponse :: Type -> Type #

NFData ListDevicePositionsResponse Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

type Rep ListDevicePositionsResponse Source # 
Instance details

Defined in Amazonka.Location.ListDevicePositions

type Rep ListDevicePositionsResponse = D1 ('MetaData "ListDevicePositionsResponse" "Amazonka.Location.ListDevicePositions" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "ListDevicePositionsResponse'" '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 [ListDevicePositionsResponseEntry]))))

newListDevicePositionsResponse Source #

Create a value of ListDevicePositionsResponse 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:nextToken:ListDevicePositions', listDevicePositionsResponse_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:ListDevicePositionsResponse', listDevicePositionsResponse_httpStatus - The response's http status code.

$sel:entries:ListDevicePositionsResponse', listDevicePositionsResponse_entries - Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.

Response Lenses

listDevicePositionsResponse_nextToken :: Lens' ListDevicePositionsResponse (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.

listDevicePositionsResponse_entries :: Lens' ListDevicePositionsResponse [ListDevicePositionsResponseEntry] Source #

Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.