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.ListDevicePositions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

A batch request to retrieve all device positions.

This operation returns paginated results.

Synopsis

data ListDevicePositions = ListDevicePositions' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- trackerName :: Text
}
newListDevicePositions :: Text -> ListDevicePositions
listDevicePositions_maxResults :: Lens' ListDevicePositions (Maybe Natural)
listDevicePositions_nextToken :: Lens' ListDevicePositions (Maybe Text)
listDevicePositions_trackerName :: Lens' ListDevicePositions Text
data ListDevicePositionsResponse = ListDevicePositionsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- entries :: [ListDevicePositionsResponseEntry]
}
newListDevicePositionsResponse :: Int -> ListDevicePositionsResponse
listDevicePositionsResponse_nextToken :: Lens' ListDevicePositionsResponse (Maybe Text)
listDevicePositionsResponse_httpStatus :: Lens' ListDevicePositionsResponse Int
listDevicePositionsResponse_entries :: Lens' ListDevicePositionsResponse [ListDevicePositionsResponseEntry]

Creating a Request

data ListDevicePositions Source #

See: newListDevicePositions smart constructor.

Constructors

ListDevicePositions'
Fields maxResults :: Maybe Natural An optional limit for the number of entries 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` trackerName :: Text The tracker resource containing the requested devices.

Instances

Instances details

ToJSON ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods toJSON :: ListDevicePositions -> Value # toEncoding :: ListDevicePositions -> Encoding # toJSONList :: [ListDevicePositions] -> Value # toEncodingList :: [ListDevicePositions] -> Encoding #
ToHeaders ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods toHeaders :: ListDevicePositions -> [Header] #
ToPath ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods toPath :: ListDevicePositions -> ByteString #
ToQuery ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods toQuery :: ListDevicePositions -> QueryString #
AWSPager ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods page :: ListDevicePositions -> AWSResponse ListDevicePositions -> Maybe ListDevicePositions #
AWSRequest ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Associated Types type AWSResponse ListDevicePositions # Methods request :: (Service -> Service) -> ListDevicePositions -> Request ListDevicePositions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDevicePositions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDevicePositions))) #
Generic ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Associated Types type Rep ListDevicePositions :: Type -> Type # Methods from :: ListDevicePositions -> Rep ListDevicePositions x # to :: Rep ListDevicePositions x -> ListDevicePositions #
Read ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods readsPrec :: Int -> ReadS ListDevicePositions # readList :: ReadS [ListDevicePositions] # readPrec :: ReadPrec ListDevicePositions # readListPrec :: ReadPrec [ListDevicePositions] #
Show ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods showsPrec :: Int -> ListDevicePositions -> ShowS # show :: ListDevicePositions -> String # showList :: [ListDevicePositions] -> ShowS #
NFData ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods rnf :: ListDevicePositions -> () #
Eq ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods (==) :: ListDevicePositions -> ListDevicePositions -> Bool # (/=) :: ListDevicePositions -> ListDevicePositions -> Bool #
Hashable ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods hashWithSalt :: Int -> ListDevicePositions -> Int # hash :: ListDevicePositions -> Int #
type AWSResponse ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions type AWSResponse ListDevicePositions = ListDevicePositionsResponse
type Rep ListDevicePositions Source #
Instance details Defined in Amazonka.Location.ListDevicePositions type Rep ListDevicePositions = D1 ('MetaData "ListDevicePositions" "Amazonka.Location.ListDevicePositions" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "ListDevicePositions'" '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 "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListDevicePositions Source #

Arguments

:: Text	`ListDevicePositions`
-> ListDevicePositions

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:

ListDevicePositions, listDevicePositions_maxResults - An optional limit for the number of entries returned in a single call.

Default value: 100

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

ListDevicePositions, listDevicePositions_trackerName - The tracker resource containing the requested devices.

Request Lenses

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

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

Default value: 100

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

Generic ListDevicePositionsResponse Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Associated Types type Rep ListDevicePositionsResponse :: Type -> Type # Methods from :: ListDevicePositionsResponse -> Rep ListDevicePositionsResponse x # to :: Rep ListDevicePositionsResponse x -> ListDevicePositionsResponse #
Show ListDevicePositionsResponse Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods showsPrec :: Int -> ListDevicePositionsResponse -> ShowS # show :: ListDevicePositionsResponse -> String # showList :: [ListDevicePositionsResponse] -> ShowS #
NFData ListDevicePositionsResponse Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods rnf :: ListDevicePositionsResponse -> () #
Eq ListDevicePositionsResponse Source #
Instance details Defined in Amazonka.Location.ListDevicePositions Methods (==) :: ListDevicePositionsResponse -> ListDevicePositionsResponse -> Bool # (/=) :: ListDevicePositionsResponse -> ListDevicePositionsResponse -> Bool #
type Rep ListDevicePositionsResponse Source #
Instance details Defined in Amazonka.Location.ListDevicePositions type Rep ListDevicePositionsResponse = D1 ('MetaData "ListDevicePositionsResponse" "Amazonka.Location.ListDevicePositions" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" '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 #

Arguments

:: Int	`$sel:httpStatus:ListDevicePositionsResponse'`
-> ListDevicePositionsResponse

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:

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_httpStatus :: Lens' ListDevicePositionsResponse Int Source #

The response's http status code.

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.