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

Description

Retrieves the device position history from a tracker resource within a specified range of time.

Device positions are deleted after 30 days.

This operation returns paginated results.

Synopsis

Creating a Request

data GetDevicePositionHistory Source #

See: newGetDevicePositionHistory smart constructor.

Constructors

GetDevicePositionHistory' 

Fields

  • endTimeExclusive :: Maybe ISO8601

    Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

    Requirement:

    • The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.
  • maxResults :: Maybe Natural

    An optional limit for the number of device positions 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

  • startTimeInclusive :: Maybe ISO8601

    Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

    Requirement:

    • The time specified for StartTimeInclusive must be before EndTimeExclusive.
  • deviceId :: Text

    The device whose position history you want to retrieve.

  • trackerName :: Text

    The tracker resource receiving the request for the device position history.

Instances

Instances details
ToJSON GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

toJSON :: GetDevicePositionHistory -> Value #

toEncoding :: GetDevicePositionHistory -> Encoding #

toJSONList :: [GetDevicePositionHistory] -> Value #

toEncodingList :: [GetDevicePositionHistory] -> Encoding #

ToHeaders GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

toHeaders :: GetDevicePositionHistory -> [Header] #

ToPath GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

toPath :: GetDevicePositionHistory -> ByteString #

ToQuery GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

toQuery :: GetDevicePositionHistory -> QueryString #

AWSPager GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

page :: GetDevicePositionHistory -> AWSResponse GetDevicePositionHistory -> Maybe GetDevicePositionHistory #

AWSRequest GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Associated Types

type AWSResponse GetDevicePositionHistory #

Methods

request :: (Service -> Service) -> GetDevicePositionHistory -> Request GetDevicePositionHistory #

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

Generic GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Associated Types

type Rep GetDevicePositionHistory :: Type -> Type #

Methods

from :: GetDevicePositionHistory -> Rep GetDevicePositionHistory x #

to :: Rep GetDevicePositionHistory x -> GetDevicePositionHistory #

Read GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

readsPrec :: Int -> ReadS GetDevicePositionHistory #

readList :: ReadS [GetDevicePositionHistory] #

readPrec :: ReadPrec GetDevicePositionHistory #

readListPrec :: ReadPrec [GetDevicePositionHistory] #

Show GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

showsPrec :: Int -> GetDevicePositionHistory -> ShowS #

show :: GetDevicePositionHistory -> String #

showList :: [GetDevicePositionHistory] -> ShowS #

NFData GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

rnf :: GetDevicePositionHistory -> () #

Eq GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

(==) :: GetDevicePositionHistory -> GetDevicePositionHistory -> Bool #

(/=) :: GetDevicePositionHistory -> GetDevicePositionHistory -> Bool #

Hashable GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

hashWithSalt :: Int -> GetDevicePositionHistory -> Int #

hash :: GetDevicePositionHistory -> Int #

type AWSResponse GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

type AWSResponse GetDevicePositionHistory = GetDevicePositionHistoryResponse
type Rep GetDevicePositionHistory Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

type Rep GetDevicePositionHistory = D1 ('MetaData "GetDevicePositionHistory" "Amazonka.Location.GetDevicePositionHistory" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GetDevicePositionHistory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endTimeExclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "startTimeInclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetDevicePositionHistory Source #

Arguments

:: Text

GetDevicePositionHistory

-> Text

GetDevicePositionHistory

-> GetDevicePositionHistory 

Create a value of GetDevicePositionHistory 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:endTimeExclusive:GetDevicePositionHistory', getDevicePositionHistory_endTimeExclusive - Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

Requirement:

  • The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

GetDevicePositionHistory, getDevicePositionHistory_maxResults - An optional limit for the number of device positions returned in a single call.

Default value: 100

GetDevicePositionHistory, getDevicePositionHistory_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:startTimeInclusive:GetDevicePositionHistory', getDevicePositionHistory_startTimeInclusive - Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

  • The time specified for StartTimeInclusive must be before EndTimeExclusive.

GetDevicePositionHistory, getDevicePositionHistory_deviceId - The device whose position history you want to retrieve.

GetDevicePositionHistory, getDevicePositionHistory_trackerName - The tracker resource receiving the request for the device position history.

Request Lenses

getDevicePositionHistory_endTimeExclusive :: Lens' GetDevicePositionHistory (Maybe UTCTime) Source #

Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

Requirement:

  • The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

getDevicePositionHistory_maxResults :: Lens' GetDevicePositionHistory (Maybe Natural) Source #

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

Default value: 100

getDevicePositionHistory_nextToken :: Lens' GetDevicePositionHistory (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

getDevicePositionHistory_startTimeInclusive :: Lens' GetDevicePositionHistory (Maybe UTCTime) Source #

Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

  • The time specified for StartTimeInclusive must be before EndTimeExclusive.

getDevicePositionHistory_deviceId :: Lens' GetDevicePositionHistory Text Source #

The device whose position history you want to retrieve.

getDevicePositionHistory_trackerName :: Lens' GetDevicePositionHistory Text Source #

The tracker resource receiving the request for the device position history.

Destructuring the Response

data GetDevicePositionHistoryResponse Source #

See: newGetDevicePositionHistoryResponse smart constructor.

Constructors

GetDevicePositionHistoryResponse' 

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.

  • devicePositions :: [DevicePosition]

    Contains the position history details for the requested device.

Instances

Instances details
Generic GetDevicePositionHistoryResponse Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Associated Types

type Rep GetDevicePositionHistoryResponse :: Type -> Type #

Methods

from :: GetDevicePositionHistoryResponse -> Rep GetDevicePositionHistoryResponse x #

to :: Rep GetDevicePositionHistoryResponse x -> GetDevicePositionHistoryResponse #

Show GetDevicePositionHistoryResponse Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

showsPrec :: Int -> GetDevicePositionHistoryResponse -> ShowS #

show :: GetDevicePositionHistoryResponse -> String #

showList :: [GetDevicePositionHistoryResponse] -> ShowS #

NFData GetDevicePositionHistoryResponse Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

rnf :: GetDevicePositionHistoryResponse -> () #

Eq GetDevicePositionHistoryResponse Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

Methods

(==) :: GetDevicePositionHistoryResponse -> GetDevicePositionHistoryResponse -> Bool #

(/=) :: GetDevicePositionHistoryResponse -> GetDevicePositionHistoryResponse -> Bool #

type Rep GetDevicePositionHistoryResponse Source # 
Instance details

Defined in Amazonka.Location.GetDevicePositionHistory

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

newGetDevicePositionHistoryResponse Source #

Arguments

:: Int

$sel:httpStatus:GetDevicePositionHistoryResponse'

-> GetDevicePositionHistoryResponse 

Create a value of GetDevicePositionHistoryResponse 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:

GetDevicePositionHistory, getDevicePositionHistoryResponse_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:GetDevicePositionHistoryResponse', getDevicePositionHistoryResponse_httpStatus - The response's http status code.

$sel:devicePositions:GetDevicePositionHistoryResponse', getDevicePositionHistoryResponse_devicePositions - Contains the position history details for the requested device.

Response Lenses

getDevicePositionHistoryResponse_nextToken :: Lens' GetDevicePositionHistoryResponse (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.

getDevicePositionHistoryResponse_httpStatus :: Lens' GetDevicePositionHistoryResponse Int Source #

The response's http status code.

getDevicePositionHistoryResponse_devicePositions :: Lens' GetDevicePositionHistoryResponse [DevicePosition] Source #

Contains the position history details for the requested device.