The Amazon Location Service Trackers API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• BatchDeleteDevicePositionHistoryError (p. 49)
• BatchGetDevicePositionError (p. 50)
• BatchItemError (p. 51)
• BatchUpdateDevicePositionError (p. 52)
• DevicePosition (p. 53)
• DevicePositionUpdate (p. 55)
• ListDevicePositionsResponseEntry (p. 57)
• ListTrackersResponseEntry (p. 59)
• PositionalAccuracy (p. 61)
• ValidationExceptionField (p. 62)
BatchDeleteDevicePositionHistoryError
BatchDeleteDevicePositionHistoryError
Contains the tracker resource details.
Contents
DeviceId
The ID of the device for this position.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[-._\p{L}\p{N}]+$
Required: Yes Error
Contains the batch request error details associated with the request.
Type: BatchItemError (p. 51) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
BatchGetDevicePositionError
BatchGetDevicePositionError
Contains error details for each device that didn't return a position.
Contents
DeviceId
The ID of the device that didn't return a position.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[-._\p{L}\p{N}]+$
Required: Yes Error
Contains details related to the error code.
Type: BatchItemError (p. 51) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
BatchItemError
BatchItemError
Contains the batch request error details associated with the request.
Contents
Code
The error code associated with the batch request error.
Type: String
Valid Values: AccessDeniedError | ConflictError | InternalServerError | ResourceNotFoundError | ThrottlingError | ValidationError
Required: No Message
A message with the reason for the batch request error.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
BatchUpdateDevicePositionError
BatchUpdateDevicePositionError
Contains error details for each device that failed to update its position.
Contents
DeviceId
The device associated with the failed location update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[-._\p{L}\p{N}]+$
Required: Yes Error
Contains details related to the error code such as the error code and error message.
Type: BatchItemError (p. 51) object Required: Yes
SampleTime
The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DevicePosition
DevicePosition
Contains the device position details.
Contents
Accuracy
The accuracy of the device position.
Type: PositionalAccuracy (p. 61) object Required: No
DeviceId
The device whose position you retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[-._\p{L}\p{N}]+$
Required: No Position
The last known device position.
Type: Array of doubles
Array Members: Fixed number of 2 items.
Required: Yes PositionProperties
The properties associated with the position.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 3 items.
Key Length Constraints: Minimum length of 1. Maximum length of 20.
Value Length Constraints: Minimum length of 1. Maximum length of 40.
Required: No ReceivedTime
The timestamp for when the tracker resource received the device position in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Type: Timestamp Required: Yes SampleTime
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
See Also
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DevicePositionUpdate
DevicePositionUpdate
Contains the position update details for a device.
Contents
Accuracy
The accuracy of the device position.
Type: PositionalAccuracy (p. 61) object Required: No
DeviceId
The device associated to the position update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[-._\p{L}\p{N}]+$
Required: Yes Position
The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].
Type: Array of doubles
Array Members: Fixed number of 2 items.
Required: Yes PositionProperties
Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.
Format: "key" : "value"
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 3 items.
Key Length Constraints: Minimum length of 1. Maximum length of 20.
Value Length Constraints: Minimum length of 1. Maximum length of 40.
Required: No SampleTime
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Type: Timestamp Required: Yes
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ListDevicePositionsResponseEntry
ListDevicePositionsResponseEntry
Contains the tracker resource details.
Contents
Accuracy
The accuracy of the device position.
Type: PositionalAccuracy (p. 61) object Required: No
DeviceId
The ID of the device for this position.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[-._\p{L}\p{N}]+$
Required: Yes Position
The last known device position. Empty if no positions currently stored.
Type: Array of doubles
Array Members: Fixed number of 2 items.
Required: Yes PositionProperties
The properties associated with the position.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 3 items.
Key Length Constraints: Minimum length of 1. Maximum length of 20.
Value Length Constraints: Minimum length of 1. Maximum length of 40.
Required: No SampleTime
The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ListTrackersResponseEntry
ListTrackersResponseEntry
Contains the tracker resource details.
Contents
CreateTime
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Type: Timestamp Required: Yes Description
The description for the tracker resource.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: Yes PricingPlan
This member has been deprecated.
Always returns RequestBasedUsage.
Type: String
Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement Required: No
PricingPlanDataSource
This member has been deprecated.
No longer used. Always returns an empty string.
Type: String Required: No TrackerName
The name of the tracker resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[-._\w]+$
Required: Yes UpdateTime
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
See Also
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PositionalAccuracy
PositionalAccuracy
Defines the level of certainty of the position.
Contents
Horizontal
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 10000.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ValidationExceptionField
ValidationExceptionField
The input failed to meet the constraints specified by the AWS service in a specified field.
Contents
message
A message with the reason for the validation exception error.
Type: String Required: Yes name
The field name where the invalid entry was detected.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3