locationservice_get_device_position_history: Retrieves the device position history from a tracker resource...

View source: R/locationservice_operations.R

locationservice_get_device_position_historyR Documentation

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

Description

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

See https://www.paws-r-sdk.com/docs/locationservice_get_device_position_history/ for full documentation.

Usage

locationservice_get_device_position_history(
  DeviceId,
  EndTimeExclusive = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  StartTimeInclusive = NULL,
  TrackerName
)

Arguments

DeviceId

[required] The device whose position history you want to retrieve.

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.

MaxResults

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

Default value: 100

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

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.

TrackerName

[required] The tracker resource receiving the request for the device position history.


paws.application.integration documentation built on Sept. 12, 2023, 1:18 a.m.