| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Location.BatchGetDevicePosition
Description
Lists the latest device positions for requested devices.
Synopsis
- data BatchGetDevicePosition = BatchGetDevicePosition' {
- deviceIds :: NonEmpty Text
- trackerName :: Text
- newBatchGetDevicePosition :: NonEmpty Text -> Text -> BatchGetDevicePosition
- batchGetDevicePosition_deviceIds :: Lens' BatchGetDevicePosition (NonEmpty Text)
- batchGetDevicePosition_trackerName :: Lens' BatchGetDevicePosition Text
- data BatchGetDevicePositionResponse = BatchGetDevicePositionResponse' {}
- newBatchGetDevicePositionResponse :: Int -> BatchGetDevicePositionResponse
- batchGetDevicePositionResponse_httpStatus :: Lens' BatchGetDevicePositionResponse Int
- batchGetDevicePositionResponse_devicePositions :: Lens' BatchGetDevicePositionResponse [DevicePosition]
- batchGetDevicePositionResponse_errors :: Lens' BatchGetDevicePositionResponse [BatchGetDevicePositionError]
Creating a Request
data BatchGetDevicePosition Source #
See: newBatchGetDevicePosition smart constructor.
Constructors
| BatchGetDevicePosition' | |
Fields
| |
Instances
newBatchGetDevicePosition Source #
Arguments
| :: NonEmpty Text | |
| -> Text | |
| -> BatchGetDevicePosition |
Create a value of BatchGetDevicePosition 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:deviceIds:BatchGetDevicePosition', batchGetDevicePosition_deviceIds - Devices whose position you want to retrieve.
- For example, for two devices:
device-ids=DeviceId1&device-ids=DeviceId2
$sel:trackerName:BatchGetDevicePosition', batchGetDevicePosition_trackerName - The tracker resource retrieving the device position.
Request Lenses
batchGetDevicePosition_deviceIds :: Lens' BatchGetDevicePosition (NonEmpty Text) Source #
Devices whose position you want to retrieve.
- For example, for two devices:
device-ids=DeviceId1&device-ids=DeviceId2
batchGetDevicePosition_trackerName :: Lens' BatchGetDevicePosition Text Source #
The tracker resource retrieving the device position.
Destructuring the Response
data BatchGetDevicePositionResponse Source #
See: newBatchGetDevicePositionResponse smart constructor.
Constructors
| BatchGetDevicePositionResponse' | |
Fields
| |
Instances
newBatchGetDevicePositionResponse Source #
Create a value of BatchGetDevicePositionResponse 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:httpStatus:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_httpStatus - The response's http status code.
$sel:devicePositions:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_devicePositions - Contains device position details such as the device ID, position, and
timestamps for when the position was received and sampled.
$sel:errors:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_errors - Contains error details for each device that failed to send its position
to the tracker resource.
Response Lenses
batchGetDevicePositionResponse_httpStatus :: Lens' BatchGetDevicePositionResponse Int Source #
The response's http status code.
batchGetDevicePositionResponse_devicePositions :: Lens' BatchGetDevicePositionResponse [DevicePosition] Source #
Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.
batchGetDevicePositionResponse_errors :: Lens' BatchGetDevicePositionResponse [BatchGetDevicePositionError] Source #
Contains error details for each device that failed to send its position to the tracker resource.