Table of Contents
LocationService.Client¶A low-level client representing Amazon Location Service
"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
import boto3
client = boto3.client('location')
These are the available methods:
associate_tracker_consumer()batch_delete_device_position_history()batch_delete_geofence()batch_evaluate_geofences()batch_get_device_position()batch_put_geofence()batch_update_device_position()calculate_route()calculate_route_matrix()can_paginate()close()create_geofence_collection()create_key()create_map()create_place_index()create_route_calculator()create_tracker()delete_geofence_collection()delete_key()delete_map()delete_place_index()delete_route_calculator()delete_tracker()describe_geofence_collection()describe_key()describe_map()describe_place_index()describe_route_calculator()describe_tracker()disassociate_tracker_consumer()get_device_position()get_device_position_history()get_geofence()get_map_glyphs()get_map_sprites()get_map_style_descriptor()get_map_tile()get_paginator()get_place()get_waiter()list_device_positions()list_geofence_collections()list_geofences()list_keys()list_maps()list_place_indexes()list_route_calculators()list_tags_for_resource()list_tracker_consumers()list_trackers()put_geofence()search_place_index_for_position()search_place_index_for_suggestions()search_place_index_for_text()tag_resource()untag_resource()update_geofence_collection()update_key()update_map()update_place_index()update_route_calculator()update_tracker()associate_tracker_consumer(**kwargs)¶Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
You can associate up to five geofence collections to each tracker resource.
Note
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
See also: AWS API Documentation
Request Syntax
response = client.associate_tracker_consumer(
ConsumerArn='string',
TrackerName='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer[REQUIRED]
The name of the tracker resource to be associated with a geofence collection.
dict
Response Syntax
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.ConflictExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ServiceQuotaExceededExceptionLocationService.Client.exceptions.ThrottlingExceptionbatch_delete_device_position_history(**kwargs)¶Deletes the position history of one or more devices from a tracker resource.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_device_position_history(
DeviceIds=[
'string',
],
TrackerName='string'
)
[REQUIRED]
Devices whose position history you want to delete.
“DeviceIds” : [DeviceId1,DeviceId2][REQUIRED]
The name of the tracker resource to delete the device position history from.
dict
Response Syntax
{
'Errors': [
{
'DeviceId': 'string',
'Error': {
'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
'Message': 'string'
}
},
]
}
Response Structure
(dict) --
Errors (list) --
Contains error details for each device history that failed to delete.
(dict) --
Contains the tracker resource details.
DeviceId (string) --
The ID of the device for this position.
Error (dict) --
Contains the batch request error details associated with the request.
Code (string) --
The error code associated with the batch request error.
Message (string) --
A message with the reason for the batch request error.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionbatch_delete_geofence(**kwargs)¶Deletes a batch of geofences from a geofence collection.
Note
This operation deletes the resource permanently.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_geofence(
CollectionName='string',
GeofenceIds=[
'string',
]
)
[REQUIRED]
The geofence collection storing the geofences to be deleted.
[REQUIRED]
The batch of geofences to be deleted.
dict
Response Syntax
{
'Errors': [
{
'Error': {
'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
'Message': 'string'
},
'GeofenceId': 'string'
},
]
}
Response Structure
(dict) --
Errors (list) --
Contains error details for each geofence that failed to delete.
(dict) --
Contains error details for each geofence that failed to delete from the geofence collection.
Error (dict) --
Contains details associated to the batch error.
Code (string) --
The error code associated with the batch request error.
Message (string) --
A message with the reason for the batch request error.
GeofenceId (string) --
The geofence associated with the error message.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionbatch_evaluate_geofences(**kwargs)¶Evaluates device positions against the geofence geometries from a given geofence collection.
This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:
ENTER if Amazon Location determines that the tracked device has entered a geofenced area.EXIT if Amazon Location determines that the tracked device has exited a geofenced area.Note
The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.
Note
Geofence evaluation uses the given device position. It does not account for the optional Accuracy of a DevicePositionUpdate .
Note
The DeviceID is used as a string to represent the device. You do not need to have a Tracker associated with the DeviceID .
See also: AWS API Documentation
Request Syntax
response = client.batch_evaluate_geofences(
CollectionName='string',
DevicePositionUpdates=[
{
'Accuracy': {
'Horizontal': 123.0
},
'DeviceId': 'string',
'Position': [
123.0,
],
'PositionProperties': {
'string': 'string'
},
'SampleTime': datetime(2015, 1, 1)
},
]
)
[REQUIRED]
The geofence collection used in evaluating the position of devices against its geofences.
[REQUIRED]
Contains device details for each device to be evaluated against the given geofence collection.
Contains the position update details for a device.
The accuracy of the device position.
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
The device associated to the position update.
The latest device position defined in WGS 84 format: [X or longitude, Y or latitude] .
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"
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
dict
Response Syntax
{
'Errors': [
{
'DeviceId': 'string',
'Error': {
'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
'Message': 'string'
},
'SampleTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Errors (list) --
Contains error details for each device that failed to evaluate its position against the given geofence collection.
(dict) --
Contains error details for each device that failed to evaluate its position against the geofences in a given geofence collection.
DeviceId (string) --
The device associated with the position evaluation error.
Error (dict) --
Contains details associated to the batch error.
Code (string) --
The error code associated with the batch request error.
Message (string) --
A message with the reason for the batch request error.
SampleTime (datetime) --
Specifies a timestamp for when the error occurred in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionbatch_get_device_position(**kwargs)¶Lists the latest device positions for requested devices.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_device_position(
DeviceIds=[
'string',
],
TrackerName='string'
)
[REQUIRED]
Devices whose position you want to retrieve.
device-ids=DeviceId1&device-ids=DeviceId2[REQUIRED]
The tracker resource retrieving the device position.
dict
Response Syntax
{
'DevicePositions': [
{
'Accuracy': {
'Horizontal': 123.0
},
'DeviceId': 'string',
'Position': [
123.0,
],
'PositionProperties': {
'string': 'string'
},
'ReceivedTime': datetime(2015, 1, 1),
'SampleTime': datetime(2015, 1, 1)
},
],
'Errors': [
{
'DeviceId': 'string',
'Error': {
'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
'Message': 'string'
}
},
]
}
Response Structure
(dict) --
DevicePositions (list) --
Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.
(dict) --
Contains the device position details.
Accuracy (dict) --
The accuracy of the device position.
Horizontal (float) --
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
DeviceId (string) --
The device whose position you retrieved.
Position (list) --
The last known device position.
PositionProperties (dict) --
The properties associated with the position.
ReceivedTime (datetime) --
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
SampleTime (datetime) --
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Errors (list) --
Contains error details for each device that failed to send its position to the tracker resource.
(dict) --
Contains error details for each device that didn't return a position.
DeviceId (string) --
The ID of the device that didn't return a position.
Error (dict) --
Contains details related to the error code.
Code (string) --
The error code associated with the batch request error.
Message (string) --
A message with the reason for the batch request error.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionbatch_put_geofence(**kwargs)¶A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
See also: AWS API Documentation
Request Syntax
response = client.batch_put_geofence(
CollectionName='string',
Entries=[
{
'GeofenceId': 'string',
'Geometry': {
'Circle': {
'Center': [
123.0,
],
'Radius': 123.0
},
'Polygon': [
[
[
123.0,
],
],
]
}
},
]
)
[REQUIRED]
The geofence collection storing the geofences.
[REQUIRED]
The batch of geofences to be stored in a geofence collection.
Contains geofence geometry details.
The identifier for the geofence to be stored in a given geofence collection.
Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.
Note
Each geofence polygon can have a maximum of 1,000 vertices.
A circle on the earth, as defined by a center point and a radius.
A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude] .
The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
A polygon is a list of linear rings which are each made up of a list of vertices.
Each vertex is a 2-dimensional point of the form: [longitude, latitude] . This is represented as an array of doubles of length 2 (so [double, double] ).
An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( [[double, double], ...] ).
A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( [[[double, double], ...], ...] ).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
dict
Response Syntax
{
'Errors': [
{
'Error': {
'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
'Message': 'string'
},
'GeofenceId': 'string'
},
],
'Successes': [
{
'CreateTime': datetime(2015, 1, 1),
'GeofenceId': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Errors (list) --
Contains additional error details for each geofence that failed to be stored in a geofence collection.
(dict) --
Contains error details for each geofence that failed to be stored in a given geofence collection.
Error (dict) --
Contains details associated to the batch error.
Code (string) --
The error code associated with the batch request error.
Message (string) --
A message with the reason for the batch request error.
GeofenceId (string) --
The geofence associated with the error message.
Successes (list) --
Contains each geofence that was successfully stored in a geofence collection.
(dict) --
Contains a summary of each geofence that was successfully stored in a given geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
GeofenceId (string) --
The geofence successfully stored in a geofence collection.
UpdateTime (datetime) --
The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionbatch_update_device_position(**kwargs)¶Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.
Note
Position updates are handled based on the PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased , updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.
When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).
When PositionFiltering is set to AccuracyBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0} when accuracy is not provided on a DevicePositionUpdate .
See also: AWS API Documentation
Request Syntax
response = client.batch_update_device_position(
TrackerName='string',
Updates=[
{
'Accuracy': {
'Horizontal': 123.0
},
'DeviceId': 'string',
'Position': [
123.0,
],
'PositionProperties': {
'string': 'string'
},
'SampleTime': datetime(2015, 1, 1)
},
]
)
[REQUIRED]
The name of the tracker resource to update.
[REQUIRED]
Contains the position update details for each device.
Contains the position update details for a device.
The accuracy of the device position.
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
The device associated to the position update.
The latest device position defined in WGS 84 format: [X or longitude, Y or latitude] .
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"
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
dict
Response Syntax
{
'Errors': [
{
'DeviceId': 'string',
'Error': {
'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
'Message': 'string'
},
'SampleTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Errors (list) --
Contains error details for each device that failed to update its position.
(dict) --
Contains error details for each device that failed to update its position.
DeviceId (string) --
The device associated with the failed location update.
Error (dict) --
Contains details related to the error code such as the error code and error message.
Code (string) --
The error code associated with the batch request error.
Message (string) --
A message with the reason for the batch request error.
SampleTime (datetime) --
The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptioncalculate_route(**kwargs)¶Calculates a route given the following required parameters:DeparturePositionandDestinationPosition. Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include:
DepartureTime or DepartNow . This calculates a route based on predictive traffic data at the given time.Note
You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.
CarModeOptions if traveling by Car , or TruckModeOptions if traveling by Truck .Note
If you specify walking for the travel mode and your data provider is Esri, the start and destination must be within 40km.
See also: AWS API Documentation
Request Syntax
response = client.calculate_route(
CalculatorName='string',
CarModeOptions={
'AvoidFerries': True|False,
'AvoidTolls': True|False
},
DepartNow=True|False,
DeparturePosition=[
123.0,
],
DepartureTime=datetime(2015, 1, 1),
DestinationPosition=[
123.0,
],
DistanceUnit='Kilometers'|'Miles',
IncludeLegGeometry=True|False,
TravelMode='Car'|'Truck'|'Walking'|'Bicycle'|'Motorcycle',
TruckModeOptions={
'AvoidFerries': True|False,
'AvoidTolls': True|False,
'Dimensions': {
'Height': 123.0,
'Length': 123.0,
'Unit': 'Meters'|'Feet',
'Width': 123.0
},
'Weight': {
'Total': 123.0,
'Unit': 'Kilograms'|'Pounds'
}
},
WaypointPositions=[
[
123.0,
],
]
)
[REQUIRED]
The name of the route calculator resource that you want to use to calculate the route.
Specifies route preferences when traveling by Car , such as avoiding routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car .
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
Default Value: false
Valid Values: false | true
[REQUIRED]
The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude] .
[-123.115, 49.285]Note
If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]
Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
Note
Setting a departure time in the past returns a 400 ValidationException error.
YYYY-MM-DDThh:mm:ss.sssZ . For example, 2020–07-2T12:15:20.000Z+01:00[REQUIRED]
The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude] .
[-122.339, 47.615]Note
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
Valid Values: [-180 to 180,-90 to 90]
Set the unit system to specify the distance.
Default Value: Kilometers
Set to include the geometry details in the result for each path between a pair of positions.
Default Value: false
Valid Values: false | true
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car , Truck , Walking , Bicycle or Motorcycle as options for the TravelMode .
Note
BicycleandMotorcycleare only valid when using Grab as a data provider, and only within Southeast Asia.
Truckis not available for Grab.
For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide .
The TravelMode you specify also determines how you specify route preferences:
Car use the CarModeOptions parameter.Truck use the TruckModeOptions parameter.Default Value: Car
Specifies route preferences when traveling by Truck , such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
Requirements: TravelMode must be specified as Truck .
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
The height of the truck.
4.5 .Note
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
The length of the truck.
15.5 .Note
For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
The width of the truck.
4.5 .Note
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
The total weight of the truck.
3500 .The unit of measurement to use for the truck weight.
Default Value: Kilograms
Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
DeparturePosition [-123.115, 49.285] , the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]Note
If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
Specifying more than 23 waypoints returns a 400 ValidationException error.
If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]
dict
Response Syntax
{
'Legs': [
{
'Distance': 123.0,
'DurationSeconds': 123.0,
'EndPosition': [
123.0,
],
'Geometry': {
'LineString': [
[
123.0,
],
]
},
'StartPosition': [
123.0,
],
'Steps': [
{
'Distance': 123.0,
'DurationSeconds': 123.0,
'EndPosition': [
123.0,
],
'GeometryOffset': 123,
'StartPosition': [
123.0,
]
},
]
},
],
'Summary': {
'DataSource': 'string',
'Distance': 123.0,
'DistanceUnit': 'Kilometers'|'Miles',
'DurationSeconds': 123.0,
'RouteBBox': [
123.0,
]
}
}
Response Structure
(dict) --
Returns the result of the route calculation. Metadata includes legs and route summary.
Legs (list) --
Contains details about each path between a pair of positions included along a route such as: StartPosition , EndPosition , Distance , DurationSeconds , Geometry , and Steps . The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
StartPosition is the departure position.EndPosition is the destination position.A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
StartPosition is the departure position . The EndPosition is the waypoint positon.StartPosition is the waypoint position. The EndPosition is the destination position.(dict) --
Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
StartPosition is the departure position.EndPosition is the destination position.A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
StartPosition is the departure position . The EndPosition is the waypoint positon.StartPosition is the waypoint position. The EndPosition is the destination position.Distance (float) --
The distance between the leg's StartPosition and EndPosition along a calculated route.
Kilometers unless the request specifies a DistanceUnit of Miles .DurationSeconds (float) --
The estimated travel time between the leg's StartPosition and EndPosition . The travel mode and departure time that you specify in the request determines the calculated time.
EndPosition (list) --
The terminating position of the leg. Follows the format [longitude,latitude] .
Note
If the EndPosition isn't located on a road, it's snapped to a nearby road.
Geometry (dict) --
Contains the calculated route's path as a linestring geometry.
LineString (list) --
An ordered list of positions used to plot a route on a map.
The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.
[[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]StartPosition (list) --
The starting position of the leg. Follows the format [longitude,latitude] .
Note
If the StartPosition isn't located on a road, it's snapped to a nearby road.
Steps (list) --
Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
(dict) --
Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.
Distance (float) --
The travel distance between the step's StartPosition and EndPosition .
DurationSeconds (float) --
The estimated travel time, in seconds, from the step's StartPosition to the EndPosition . . The travel mode and departure time that you specify in the request determines the calculated time.
EndPosition (list) --
The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.
GeometryOffset (integer) --
Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0 .
Included in the response for queries that set IncludeLegGeometry to True .
StartPosition (list) --
The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.
Summary (dict) --
Contains information about the whole route, such as: RouteBBox , DataSource , Distance , DistanceUnit , and DurationSeconds .
DataSource (string) --
The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:
EsriGrabHereFor more information about data providers, see Amazon Location Service data providers.
Distance (float) --
The total distance covered by the route. The sum of the distance travelled between every stop on the route.
Note
If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.
DistanceUnit (string) --
The unit of measurement for route distances.
DurationSeconds (float) --
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
RouteBBox (list) --
Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y] .
The first 2 bbox parameters describe the lower southwest corner:
bbox position is the X coordinate or longitude of the lower southwest corner.bbox position is the Y coordinate or latitude of the lower southwest corner.The next 2 bbox parameters describe the upper northeast corner:
bbox position is the X coordinate, or longitude of the upper northeast corner.bbox position is the Y coordinate, or latitude of the upper northeast corner.Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptioncalculate_route_matrix(**kwargs)¶Calculates a route matrix given the following required parameters:DeparturePositionsandDestinationPositions.CalculateRouteMatrixcalculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y,CalculateRouteMatrixwill return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number ofDeparturePositionstimes the number ofDestinationPositions.
Note
Your account is charged for each route calculated, not the number of requests.
Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.
Additional options include:
DepartureTime or DepartNow . This calculates routes based on predictive traffic data at the given time.Note
You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.
CarModeOptions if traveling by Car , or TruckModeOptions if traveling by Truck .See also: AWS API Documentation
Request Syntax
response = client.calculate_route_matrix(
CalculatorName='string',
CarModeOptions={
'AvoidFerries': True|False,
'AvoidTolls': True|False
},
DepartNow=True|False,
DeparturePositions=[
[
123.0,
],
],
DepartureTime=datetime(2015, 1, 1),
DestinationPositions=[
[
123.0,
],
],
DistanceUnit='Kilometers'|'Miles',
TravelMode='Car'|'Truck'|'Walking'|'Bicycle'|'Motorcycle',
TruckModeOptions={
'AvoidFerries': True|False,
'AvoidTolls': True|False,
'Dimensions': {
'Height': 123.0,
'Length': 123.0,
'Unit': 'Meters'|'Feet',
'Width': 123.0
},
'Weight': {
'Total': 123.0,
'Unit': 'Kilograms'|'Pounds'
}
}
)
[REQUIRED]
The name of the route calculator resource that you want to use to calculate the route matrix.
Specifies route preferences when traveling by Car , such as avoiding routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car .
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow . If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.
Default Value: false
Valid Values: false | true
[REQUIRED]
The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude] . For example, [-123.115, 49.285] .
Warning
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide .
Note
For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions .
Valid Values: [-180 to 180,-90 to 90]
Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow . If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.
Note
Setting a departure time in the past returns a 400 ValidationException error.
YYYY-MM-DDThh:mm:ss.sssZ . For example, 2020–07-2T12:15:20.000Z+01:00[REQUIRED]
The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude] . For example, [-122.339, 47.615]
Warning
Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide .
Note
For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions .
Valid Values: [-180 to 180,-90 to 90]
Set the unit system to specify the distance.
Default Value: Kilometers
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The TravelMode you specify also determines how you specify route preferences:
Car use the CarModeOptions parameter.Truck use the TruckModeOptions parameter.Note
BicycleorMotorcycleare only valid when usingGrabas a data provider, and only within Southeast Asia.
Truckis not available for Grab.
For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide .
Default Value: Car
Specifies route preferences when traveling by Truck , such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
Requirements: TravelMode must be specified as Truck .
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
The height of the truck.
4.5 .Note
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
The length of the truck.
15.5 .Note
For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
The width of the truck.
4.5 .Note
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
The total weight of the truck.
3500 .The unit of measurement to use for the truck weight.
Default Value: Kilograms
dict
Response Syntax
{
'RouteMatrix': [
[
{
'Distance': 123.0,
'DurationSeconds': 123.0,
'Error': {
'Code': 'RouteNotFound'|'RouteTooLong'|'PositionsNotFound'|'DestinationPositionNotFound'|'DeparturePositionNotFound'|'OtherValidationError',
'Message': 'string'
}
},
],
],
'SnappedDeparturePositions': [
[
123.0,
],
],
'SnappedDestinationPositions': [
[
123.0,
],
],
'Summary': {
'DataSource': 'string',
'DistanceUnit': 'Kilometers'|'Miles',
'ErrorCount': 123,
'RouteCount': 123
}
}
Response Structure
(dict) --
Returns the result of the route matrix calculation.
RouteMatrix (list) --
The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions . Each row corresponds to one entry in DeparturePositions . Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions .
(list) --
(dict) --
The result for the calculated route of one DeparturePosition DestinationPosition pair.
Distance (float) --
The total distance of travel for the route.
DurationSeconds (float) --
The expected duration of travel for the route.
Error (dict) --
An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition .
Code (string) --
The type of error which occurred for the route calculation.
Message (string) --
A message about the error that occurred for the route calculation.
SnappedDeparturePositions (list) --
For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix .
SnappedDestinationPositions (list) --
The list of destination positions for the route matrix used for calculation of the RouteMatrix .
Summary (dict) --
Contains information about the route matrix, DataSource , DistanceUnit , RouteCount and ErrorCount .
DataSource (string) --
The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:
EsriGrabHereFor more information about data providers, see Amazon Location Service data providers.
DistanceUnit (string) --
The unit of measurement for route distances.
ErrorCount (integer) --
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
RouteCount (integer) --
The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_geofence_collection(**kwargs)¶Creates a geofence collection, which manages and stores geofences.
See also: AWS API Documentation
Request Syntax
response = client.create_geofence_collection(
CollectionName='string',
Description='string',
KmsKeyId='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
PricingPlanDataSource='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
A custom name for the geofence collection.
Requirements:
ExampleGeofenceCollection .RequestBasedUsage .Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
dict
Response Syntax
{
'CollectionArn': 'string',
'CollectionName': 'string',
'CreateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CollectionArn (string) --
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionCollectionName (string) --
The name for the geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ConflictExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ServiceQuotaExceededExceptionLocationService.Client.exceptions.ThrottlingExceptioncreate_key(**kwargs)¶Creates an API key resource in your Amazon Web Services account, which lets you grant geo:GetMap* actions for Amazon Location Map resources to the API key bearer.
Warning
The API keys feature is in preview. We may add, change, or remove features before announcing general availability. For more information, see Using API keys.
See also: AWS API Documentation
Request Syntax
response = client.create_key(
Description='string',
ExpireTime=datetime(2015, 1, 1),
KeyName='string',
NoExpiry=True|False,
Restrictions={
'AllowActions': [
'string',
],
'AllowReferers': [
'string',
],
'AllowResources': [
'string',
]
},
Tags={
'string': 'string'
}
)
YYYY-MM-DDThh:mm:ss.sssZ . One of NoExpiry or ExpireTime must be set.[REQUIRED]
A custom name for the API key resource.
Requirements:
ExampleAPIKey .true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.[REQUIRED]
The API key restrictions for the API key resource.
A list of allowed actions that an API key resource grants permissions to perform
Note
Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
$\-._+!*`(),;/?:@=&https://example.com .A list of allowed resource ARNs that a API key bearer can perform actions on
For more information about ARN format, see Amazon Resource Names (ARNs).
Note
In this preview, you can allow only map resources.
Requirements:
arn .partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path. resource-id can also include wildcard characters, denoted by an asterisk (*).arn , partition , service , region , account-id and resource-id must be delimited by a colon (:).arn:aws:geo:region:account-id:map/ExampleMap* .Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'Key': 'string',
'KeyArn': 'string',
'KeyName': 'string'
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Key (string) --
The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see GetMapGlyphs.
KeyArn (string) --
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:key/ExampleKeyKeyName (string) --
The name of the API key resource.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ConflictExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ServiceQuotaExceededExceptionLocationService.Client.exceptions.ThrottlingExceptioncreate_map(**kwargs)¶Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.
Note
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
See also: AWS API Documentation
Request Syntax
response = client.create_map(
Configuration={
'Style': 'string'
},
Description='string',
MapName='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
Tags={
'string': 'string'
}
)
[REQUIRED]
Specifies the MapConfiguration , including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.
Specifies the map style selected from an available data provider.
Valid Esri map styles:
VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.VectorEsriStreets – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.VectorEsriNavigation – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.Valid HERE Technologies map styles:
VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.Note
The VectorHereContrast style has been renamed from VectorHereBerlin . VectorHereBerlin has been deprecated, but will continue to work in applications that use it.
VectorHereExplore – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.VectorHereExploreTruck – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.RasterHereExploreSatellite – A global map containing high resolution satellite imagery.HybridHereExploreSatellite – A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.Note
Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid GrabMaps map styles:
VectorGrabStandardLight – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.VectorGrabStandardDark – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.Note
Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region ( ap-southeast-1 ). For more information, see GrabMaps countries and area covered.
Valid Open Data (Preview) map styles:
VectorOpenDataStandardLight – The Open Data Standard Light (preview) map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.Warning
Open Data maps is in preview. We may add, change, or remove features before announcing general availability. For more information, see Open Data is in preview release.
[REQUIRED]
The name for the map resource.
Requirements:
ExampleMap .RequestBasedUsage .Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'MapArn': 'string',
'MapName': 'string'
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
MapArn (string) --
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:map/ExampleMapMapName (string) --
The name of the map resource.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ConflictExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ServiceQuotaExceededExceptionLocationService.Client.exceptions.ThrottlingExceptioncreate_place_index(**kwargs)¶Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.
Note
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
See also: AWS API Documentation
Request Syntax
response = client.create_place_index(
DataSource='string',
DataSourceConfiguration={
'IntendedUse': 'SingleUse'|'Storage'
},
Description='string',
IndexName='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
Tags={
'string': 'string'
}
)
[REQUIRED]
Specifies the geospatial data provider for the new place index.
Note
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
Valid values include:
Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage.Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered.Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage.Warning
If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
For additional information , see Data providers on the Amazon Location Service Developer Guide .
Specifies the data storage option requesting Places.
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse specifies that the results won't be stored.Storage specifies that the result can be cached or stored in a database.Default value: SingleUse
[REQUIRED]
The name of the place index resource.
Requirements:
ExamplePlaceIndex .RequestBasedUsage .Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
Format: "key" : "value"
Restrictions:
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'IndexArn': 'string',
'IndexName': 'string'
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
IndexArn (string) --
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndexIndexName (string) --
The name for the place index resource.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ConflictExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ServiceQuotaExceededExceptionLocationService.Client.exceptions.ThrottlingExceptioncreate_route_calculator(**kwargs)¶Creates a route calculator resource in your Amazon Web Services account.
You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
Note
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
See also: AWS API Documentation
Request Syntax
response = client.create_route_calculator(
CalculatorName='string',
DataSource='string',
Description='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the route calculator resource.
Requirements:
ExampleRouteCalculator .[REQUIRED]
Specifies the data provider of traffic and road network data.
Note
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
Valid values include:
Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on street networks and traffic coverage. Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.Grab – Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered.Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.For additional information , see Data providers on the Amazon Location Service Developer Guide .
RequestBasedUsage .Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
"tag1" : "value1" , "tag2" : "value2" }Format: "key" : "value"
Restrictions:
dict
Response Syntax
{
'CalculatorArn': 'string',
'CalculatorName': 'string',
'CreateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CalculatorArn (string) --
The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:route-calculator/ExampleCalculatorCalculatorName (string) --
The name of the route calculator resource.
ExampleRouteCalculator .CreateTime (datetime) --
The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
2020–07-2T12:15:20.000Z+01:00Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ConflictExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ServiceQuotaExceededExceptionLocationService.Client.exceptions.ThrottlingExceptioncreate_tracker(**kwargs)¶Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
See also: AWS API Documentation
Request Syntax
response = client.create_tracker(
Description='string',
KmsKeyId='string',
PositionFiltering='TimeBased'|'DistanceBased'|'AccuracyBased',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
PricingPlanDataSource='string',
Tags={
'string': 'string'
},
TrackerName='string'
)
Specifies the position filtering for the tracker resource.
Valid values:
TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.This field is optional. If not specified, the default value is TimeBased .
RequestBasedUsage .Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
[REQUIRED]
The name for the tracker resource.
Requirements:
ExampleTracker .dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'TrackerArn': 'string',
'TrackerName': 'string'
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
TrackerArn (string) --
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:tracker/ExampleTrackerTrackerName (string) --
The name of the tracker resource.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ConflictExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondelete_geofence_collection(**kwargs)¶Deletes a geofence collection from your Amazon Web Services account.
Note
This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
See also: AWS API Documentation
Request Syntax
response = client.delete_geofence_collection(
CollectionName='string'
)
[REQUIRED]
The name of the geofence collection to be deleted.
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondelete_key(**kwargs)¶Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
See also: AWS API Documentation
Request Syntax
response = client.delete_key(
KeyName='string'
)
[REQUIRED]
The name of the API key to delete.
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondelete_map(**kwargs)¶Deletes a map resource from your Amazon Web Services account.
Note
This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
See also: AWS API Documentation
Request Syntax
response = client.delete_map(
MapName='string'
)
[REQUIRED]
The name of the map resource to be deleted.
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondelete_place_index(**kwargs)¶Deletes a place index resource from your Amazon Web Services account.
Note
This operation deletes the resource permanently.
See also: AWS API Documentation
Request Syntax
response = client.delete_place_index(
IndexName='string'
)
[REQUIRED]
The name of the place index resource to be deleted.
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondelete_route_calculator(**kwargs)¶Deletes a route calculator resource from your Amazon Web Services account.
Note
This operation deletes the resource permanently.
See also: AWS API Documentation
Request Syntax
response = client.delete_route_calculator(
CalculatorName='string'
)
[REQUIRED]
The name of the route calculator resource to be deleted.
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondelete_tracker(**kwargs)¶Deletes a tracker resource from your Amazon Web Services account.
Note
This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.
See also: AWS API Documentation
Request Syntax
response = client.delete_tracker(
TrackerName='string'
)
[REQUIRED]
The name of the tracker resource to be deleted.
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondescribe_geofence_collection(**kwargs)¶Retrieves the geofence collection details.
See also: AWS API Documentation
Request Syntax
response = client.describe_geofence_collection(
CollectionName='string'
)
[REQUIRED]
The name of the geofence collection.
{
'CollectionArn': 'string',
'CollectionName': 'string',
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'KmsKeyId': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'Tags': {
'string': 'string'
},
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionThe name of the geofence collection.
The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The optional description for the geofence collection.
A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource
No longer used. Always returns RequestBasedUsage .
No longer used. Always returns an empty string.
Displays the key, value pairs of tags associated with this resource.
The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondescribe_key(**kwargs)¶Retrieves the API key resource details.
Warning
The API keys feature is in preview. We may add, change, or remove features before announcing general availability. For more information, see Using API keys.
See also: AWS API Documentation
Request Syntax
response = client.describe_key(
KeyName='string'
)
[REQUIRED]
The name of the API key resource.
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'ExpireTime': datetime(2015, 1, 1),
'Key': 'string',
'KeyArn': 'string',
'KeyName': 'string',
'Restrictions': {
'AllowActions': [
'string',
],
'AllowReferers': [
'string',
],
'AllowResources': [
'string',
]
},
'Tags': {
'string': 'string'
},
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
The optional description for the API key resource.
The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
The key value/string of an API key.
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:key/ExampleKeyThe name of the API key resource.
API Restrictions on the allowed actions, resources, and referers for an API key resource.
A list of allowed actions that an API key resource grants permissions to perform
Note
Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
$\-._+!*`(),;/?:@=&https://example.com .A list of allowed resource ARNs that a API key bearer can perform actions on
For more information about ARN format, see Amazon Resource Names (ARNs).
Note
In this preview, you can allow only map resources.
Requirements:
arn .partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path. resource-id can also include wildcard characters, denoted by an asterisk (*).arn , partition , service , region , account-id and resource-id must be delimited by a colon (:).arn:aws:geo:region:account-id:map/ExampleMap* .Tags associated with the API key resource.
The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondescribe_map(**kwargs)¶Retrieves the map resource details.
See also: AWS API Documentation
Request Syntax
response = client.describe_map(
MapName='string'
)
[REQUIRED]
The name of the map resource.
{
'Configuration': {
'Style': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'MapArn': 'string',
'MapName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'Tags': {
'string': 'string'
},
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
Specifies the map tile style selected from a partner data provider.
Specifies the map style selected from an available data provider.
Valid Esri map styles:
VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.VectorEsriStreets – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.VectorEsriNavigation – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.Valid HERE Technologies map styles:
VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.Note
The VectorHereContrast style has been renamed from VectorHereBerlin . VectorHereBerlin has been deprecated, but will continue to work in applications that use it.
VectorHereExplore – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.VectorHereExploreTruck – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.RasterHereExploreSatellite – A global map containing high resolution satellite imagery.HybridHereExploreSatellite – A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.Note
Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid GrabMaps map styles:
VectorGrabStandardLight – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.VectorGrabStandardDark – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.Note
Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region ( ap-southeast-1 ). For more information, see GrabMaps countries and area covered.
Valid Open Data (Preview) map styles:
VectorOpenDataStandardLight – The Open Data Standard Light (preview) map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.Warning
Open Data maps is in preview. We may add, change, or remove features before announcing general availability. For more information, see Open Data is in preview release.
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Specifies the data provider for the associated map tiles.
The optional description for the map resource.
The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:map/ExampleMapThe map style selected from an available provider.
No longer used. Always returns RequestBasedUsage .
Tags associated with the map resource.
The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondescribe_place_index(**kwargs)¶Retrieves the place index resource details.
See also: AWS API Documentation
Request Syntax
response = client.describe_place_index(
IndexName='string'
)
[REQUIRED]
The name of the place index resource.
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'DataSourceConfiguration': {
'IntendedUse': 'SingleUse'|'Storage'
},
'Description': 'string',
'IndexArn': 'string',
'IndexName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'Tags': {
'string': 'string'
},
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
The data provider of geospatial data. Values can be one of the following:
EsriGrabHereFor more information about data providers, see Amazon Location Service data providers.
The specified data storage option for requesting Places.
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse specifies that the results won't be stored.Storage specifies that the result can be cached or stored in a database.Default value: SingleUse
The optional description for the place index resource.
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndexThe name of the place index resource being described.
No longer used. Always returns RequestBasedUsage .
Tags associated with place index resource.
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondescribe_route_calculator(**kwargs)¶Retrieves the route calculator resource details.
See also: AWS API Documentation
Request Syntax
response = client.describe_route_calculator(
CalculatorName='string'
)
[REQUIRED]
The name of the route calculator resource.
{
'CalculatorArn': 'string',
'CalculatorName': 'string',
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'Tags': {
'string': 'string'
},
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across Amazon Web Services.
arn:aws:geo:region:account-id:route-calculator/ExampleCalculatorThe name of the route calculator resource being described.
The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
2020–07-2T12:15:20.000Z+01:00The data provider of traffic and road network data. Indicates one of the available providers:
EsriGrabHereFor more information about data providers, see Amazon Location Service data providers.
The optional description of the route calculator resource.
Always returns RequestBasedUsage .
Tags associated with route calculator resource.
The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
2020–07-2T12:15:20.000Z+01:00Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondescribe_tracker(**kwargs)¶Retrieves the tracker resource details.
See also: AWS API Documentation
Request Syntax
response = client.describe_tracker(
TrackerName='string'
)
[REQUIRED]
The name of the tracker resource.
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'KmsKeyId': 'string',
'PositionFiltering': 'TimeBased'|'DistanceBased'|'AccuracyBased',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'Tags': {
'string': 'string'
},
'TrackerArn': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
The optional description for the tracker resource.
A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.
The position filtering method of the tracker resource.
Always returns RequestBasedUsage .
No longer used. Always returns an empty string.
The tags associated with the tracker resource.
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:tracker/ExampleTrackerThe name of the tracker resource.
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiondisassociate_tracker_consumer(**kwargs)¶Removes the association between a tracker resource and a geofence collection.
Note
Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_tracker_consumer(
ConsumerArn='string',
TrackerName='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer[REQUIRED]
The name of the tracker resource to be dissociated from the consumer.
dict
Response Syntax
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_device_position(**kwargs)¶Retrieves a device's most recent position according to its sample time.
Note
Device positions are deleted after 30 days.
See also: AWS API Documentation
Request Syntax
response = client.get_device_position(
DeviceId='string',
TrackerName='string'
)
[REQUIRED]
The device whose position you want to retrieve.
[REQUIRED]
The tracker resource receiving the position update.
dict
Response Syntax
{
'Accuracy': {
'Horizontal': 123.0
},
'DeviceId': 'string',
'Position': [
123.0,
],
'PositionProperties': {
'string': 'string'
},
'ReceivedTime': datetime(2015, 1, 1),
'SampleTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Accuracy (dict) --
The accuracy of the device position.
Horizontal (float) --
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
DeviceId (string) --
The device whose position you retrieved.
Position (list) --
The last known device position.
PositionProperties (dict) --
The properties associated with the position.
ReceivedTime (datetime) --
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
SampleTime (datetime) --
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_device_position_history(**kwargs)¶Retrieves the device position history from a tracker resource within a specified range of time.
Note
Device positions are deleted after 30 days.
See also: AWS API Documentation
Request Syntax
response = client.get_device_position_history(
DeviceId='string',
EndTimeExclusive=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
StartTimeInclusive=datetime(2015, 1, 1),
TrackerName='string'
)
[REQUIRED]
The device whose position history you want to retrieve.
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:
EndTimeExclusive must be after the time for StartTimeInclusive .An optional limit for the number of device positions returned in a single call.
Default value: 100
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
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:
StartTimeInclusive must be before EndTimeExclusive .[REQUIRED]
The tracker resource receiving the request for the device position history.
dict
Response Syntax
{
'DevicePositions': [
{
'Accuracy': {
'Horizontal': 123.0
},
'DeviceId': 'string',
'Position': [
123.0,
],
'PositionProperties': {
'string': 'string'
},
'ReceivedTime': datetime(2015, 1, 1),
'SampleTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DevicePositions (list) --
Contains the position history details for the requested device.
(dict) --
Contains the device position details.
Accuracy (dict) --
The accuracy of the device position.
Horizontal (float) --
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
DeviceId (string) --
The device whose position you retrieved.
Position (list) --
The last known device position.
PositionProperties (dict) --
The properties associated with the position.
ReceivedTime (datetime) --
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
SampleTime (datetime) --
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
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.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_geofence(**kwargs)¶Retrieves the geofence details from a geofence collection.
See also: AWS API Documentation
Request Syntax
response = client.get_geofence(
CollectionName='string',
GeofenceId='string'
)
[REQUIRED]
The geofence collection storing the target geofence.
[REQUIRED]
The geofence you're retrieving details for.
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'GeofenceId': 'string',
'Geometry': {
'Circle': {
'Center': [
123.0,
],
'Radius': 123.0
},
'Polygon': [
[
[
123.0,
],
],
]
},
'Status': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
GeofenceId (string) --
The geofence identifier.
Geometry (dict) --
Contains the geofence geometry details describing a polygon or a circle.
Circle (dict) --
A circle on the earth, as defined by a center point and a radius.
Center (list) --
A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude] .
Radius (float) --
The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
Polygon (list) --
A polygon is a list of linear rings which are each made up of a list of vertices.
Each vertex is a 2-dimensional point of the form: [longitude, latitude] . This is represented as an array of doubles of length 2 (so [double, double] ).
An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( [[double, double], ...] ).
A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( [[[double, double], ...], ...] ).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
Status (string) --
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.PENDING — The geofence is being processed by the system.FAILED — The geofence failed to be indexed by the system.DELETED — The geofence has been deleted from the system index.DELETING — The geofence is being deleted from the system index.UpdateTime (datetime) --
The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_map_glyphs(**kwargs)¶Retrieves glyphs used to display labels on a map.
See also: AWS API Documentation
Request Syntax
response = client.get_map_glyphs(
FontStack='string',
FontUnicodeRange='string',
Key='string',
MapName='string'
)
[REQUIRED]
A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode .
Valid fonts stacks for Esri styles:
Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu BoldUbuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu BoldNoto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light ItalicArial Regular | Arial Italic | Arial BoldArial Regular | Arial Italic | Arial BoldValid font stacks for HERE Technologies styles:
Fira GO Regular | Fira GO BoldFira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP RegularValid font stacks for GrabMaps styles:
Noto Sans Regular | Noto Sans Medium | Noto Sans BoldValid font stacks for Open Data (Preview) styles:
Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans BoldNote
The fonts used by VectorOpenDataStandardLight are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember .
[REQUIRED]
A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF . Must be aligned to multiples of 256.
[REQUIRED]
The map resource associated with the glyph file.
dict
Response Syntax
{
'Blob': StreamingBody(),
'CacheControl': 'string',
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (StreamingBody) --
The glyph, as binary blob.
CacheControl (string) --
The HTTP Cache-Control directive for the value.
ContentType (string) --
The map glyph content type. For example, application/octet-stream .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_map_sprites(**kwargs)¶Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
See also: AWS API Documentation
Request Syntax
response = client.get_map_sprites(
FileName='string',
Key='string',
MapName='string'
)
[REQUIRED]
The name of the sprite file. Use the following file names for the sprite sheet:
sprites.pngsprites@2x.png for high pixel density displaysFor the JSON document containing image offsets. Use the following file names:
sprites.jsonsprites@2x.json for high pixel density displays[REQUIRED]
The map resource associated with the sprite file.
dict
Response Syntax
{
'Blob': StreamingBody(),
'CacheControl': 'string',
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (StreamingBody) --
Contains the body of the sprite sheet or JSON offset file.
CacheControl (string) --
The HTTP Cache-Control directive for the value.
ContentType (string) --
The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png , and the sprite offset JSON document is application/json .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_map_style_descriptor(**kwargs)¶Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
See also: AWS API Documentation
Request Syntax
response = client.get_map_style_descriptor(
Key='string',
MapName='string'
)
[REQUIRED]
The map resource to retrieve the style descriptor from.
dict
Response Syntax
{
'Blob': StreamingBody(),
'CacheControl': 'string',
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (StreamingBody) --
Contains the body of the style descriptor.
CacheControl (string) --
The HTTP Cache-Control directive for the value.
ContentType (string) --
The style descriptor's content type. For example, application/json .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_map_tile(**kwargs)¶Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
See also: AWS API Documentation
Request Syntax
response = client.get_map_tile(
Key='string',
MapName='string',
X='string',
Y='string',
Z='string'
)
[REQUIRED]
The map resource to retrieve the map tiles from.
[REQUIRED]
The X axis value for the map tile.
[REQUIRED]
The Y axis value for the map tile.
[REQUIRED]
The zoom value for the map tile.
dict
Response Syntax
{
'Blob': StreamingBody(),
'CacheControl': 'string',
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (StreamingBody) --
Contains Mapbox Vector Tile (MVT) data.
CacheControl (string) --
The HTTP Cache-Control directive for the value.
ContentType (string) --
The map tile's content type. For example, application/vnd.mapbox-vector-tile .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_place(**kwargs)¶Finds a place by its unique ID. A PlaceId is returned by other search operations.
Note
A PlaceId is valid only if all of the following are the same in the original search request and the call to GetPlace .
See also: AWS API Documentation
Request Syntax
response = client.get_place(
IndexName='string',
Language='string',
PlaceId='string'
)
[REQUIRED]
The name of the place index resource that you want to use for the search.
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en . The city in the results will most likely be returned as Athens .
If you set the language parameter to el , for Greek, then the city in the results will more likely be returned as Αθήνα .
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
[REQUIRED]
The identifier of the place to find.
dict
Response Syntax
{
'Place': {
'AddressNumber': 'string',
'Country': 'string',
'Geometry': {
'Point': [
123.0,
]
},
'Interpolated': True|False,
'Label': 'string',
'Municipality': 'string',
'Neighborhood': 'string',
'PostalCode': 'string',
'Region': 'string',
'Street': 'string',
'SubRegion': 'string',
'TimeZone': {
'Name': 'string',
'Offset': 123
},
'UnitNumber': 'string',
'UnitType': 'string'
}
}
Response Structure
(dict) --
Place (dict) --
Details about the result, such as its address and position.
AddressNumber (string) --
The numerical portion of an address, such as a building number.
Country (string) --
A country/region specified using ISO 3166 3-digit country/region code. For example, CAN .
Geometry (dict) --
Places uses a point geometry to specify a location or a Place.
Point (list) --
A single point geometry specifies a location for a Place using WGS 84 coordinates:
Interpolated (boolean) --
Trueif the result is interpolated from other known places.
Falseif the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.
Label (string) --
The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA .
Municipality (string) --
A name for a local area, such as a city or town name. For example, Toronto .
Neighborhood (string) --
The name of a community district. For example, Downtown .
PostalCode (string) --
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
Region (string) --
A name for an area or geographical division, such as a province or state name. For example, British Columbia .
Street (string) --
The name for a street or a road to identify a location. For example, Main Street .
SubRegion (string) --
A county, or an area that's part of a larger region. For example, Metro Vancouver .
TimeZone (dict) --
The time zone in which the Place is located. Returned only when using HERE as the selected partner.
Name (string) --
The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles .
Offset (integer) --
The time zone's offset, in seconds, from UTC.
UnitNumber (string) --
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123 .
Note
Returned only for a place index that uses Esri as a data provider. Is not returned for SearchPlaceIndexForPosition .
UnitType (string) --
For addresses with a UnitNumber , the type of unit. For example, Apartment .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_device_positions(**kwargs)¶A batch request to retrieve all device positions.
See also: AWS API Documentation
Request Syntax
response = client.list_device_positions(
MaxResults=123,
NextToken='string',
TrackerName='string'
)
An optional limit for the number of entries returned in a single call.
Default value: 100
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
[REQUIRED]
The tracker resource containing the requested devices.
dict
Response Syntax
{
'Entries': [
{
'Accuracy': {
'Horizontal': 123.0
},
'DeviceId': 'string',
'Position': [
123.0,
],
'PositionProperties': {
'string': 'string'
},
'SampleTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
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.
(dict) --
Contains the tracker resource details.
Accuracy (dict) --
The accuracy of the device position.
Horizontal (float) --
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
DeviceId (string) --
The ID of the device for this position.
Position (list) --
The last known device position. Empty if no positions currently stored.
PositionProperties (dict) --
The properties associated with the position.
SampleTime (datetime) --
The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
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.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionlist_geofence_collections(**kwargs)¶Lists geofence collections in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_geofence_collections(
MaxResults=123,
NextToken='string'
)
An optional limit for the number of resources returned in a single call.
Default value: 100
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
dict
Response Syntax
{
'Entries': [
{
'CollectionName': 'string',
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Lists the geofence collections that exist in your Amazon Web Services account.
(dict) --
Contains the geofence collection details.
CollectionName (string) --
The name of the geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Description (string) --
The description for the geofence collection
PricingPlan (string) --
No longer used. Always returns RequestBasedUsage .
PricingPlanDataSource (string) --
No longer used. Always returns an empty string.
UpdateTime (datetime) --
Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
NextToken (string) --
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.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionlist_geofences(**kwargs)¶Lists geofences stored in a given geofence collection.
See also: AWS API Documentation
Request Syntax
response = client.list_geofences(
CollectionName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the geofence collection storing the list of geofences.
An optional limit for the number of geofences returned in a single call.
Default value: 100
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
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'GeofenceId': 'string',
'Geometry': {
'Circle': {
'Center': [
123.0,
],
'Radius': 123.0
},
'Polygon': [
[
[
123.0,
],
],
]
},
'Status': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Contains a list of geofences stored in the geofence collection.
(dict) --
Contains a list of geofences stored in a given geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
GeofenceId (string) --
The geofence identifier.
Geometry (dict) --
Contains the geofence geometry details describing a polygon or a circle.
Circle (dict) --
A circle on the earth, as defined by a center point and a radius.
Center (list) --
A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude] .
Radius (float) --
The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
Polygon (list) --
A polygon is a list of linear rings which are each made up of a list of vertices.
Each vertex is a 2-dimensional point of the form: [longitude, latitude] . This is represented as an array of doubles of length 2 (so [double, double] ).
An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( [[double, double], ...] ).
A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( [[[double, double], ...], ...] ).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
Status (string) --
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.PENDING — The geofence is being processed by the system.FAILED — The geofence failed to be indexed by the system.DELETED — The geofence has been deleted from the system index.DELETING — The geofence is being deleted from the system index.UpdateTime (datetime) --
The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
NextToken (string) --
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.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionlist_keys(**kwargs)¶Lists API key resources in your Amazon Web Services account.
Warning
The API keys feature is in preview. We may add, change, or remove features before announcing general availability. For more information, see Using API keys.
See also: AWS API Documentation
Request Syntax
response = client.list_keys(
Filter={
'KeyStatus': 'Active'|'Expired'
},
MaxResults=123,
NextToken='string'
)
Optionally filter the list to only Active or Expired API keys.
Filter on Active or Expired API keys.
An optional limit for the number of resources returned in a single call.
Default value: 100
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
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'ExpireTime': datetime(2015, 1, 1),
'KeyName': 'string',
'Restrictions': {
'AllowActions': [
'string',
],
'AllowReferers': [
'string',
],
'AllowResources': [
'string',
]
},
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Contains API key resources in your Amazon Web Services account. Details include API key name, allowed referers and timestamp for when the API key will expire.
(dict) --
An API key resource listed in your Amazon Web Services account.
CreateTime (datetime) --
The timestamp of when the API key was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Description (string) --
The optional description for the API key resource.
ExpireTime (datetime) --
The timestamp for when the API key resource will expire, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
KeyName (string) --
The name of the API key resource.
Restrictions (dict) --
API Restrictions on the allowed actions, resources, and referers for an API key resource.
AllowActions (list) --
A list of allowed actions that an API key resource grants permissions to perform
Note
Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
AllowReferers (list) --
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
$\-._+!*`(),;/?:@=&https://example.com .AllowResources (list) --
A list of allowed resource ARNs that a API key bearer can perform actions on
For more information about ARN format, see Amazon Resource Names (ARNs).
Note
In this preview, you can allow only map resources.
Requirements:
arn .partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path. resource-id can also include wildcard characters, denoted by an asterisk (*).arn , partition , service , region , account-id and resource-id must be delimited by a colon (:).arn:aws:geo:region:account-id:map/ExampleMap* .UpdateTime (datetime) --
The timestamp of when the API key was last updated, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
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.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionlist_maps(**kwargs)¶Lists map resources in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_maps(
MaxResults=123,
NextToken='string'
)
An optional limit for the number of resources returned in a single call.
Default value: 100
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
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'MapName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Contains a list of maps in your Amazon Web Services account
(dict) --
Contains details of an existing map resource in your Amazon Web Services account.
CreateTime (datetime) --
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
DataSource (string) --
Specifies the data provider for the associated map tiles.
Description (string) --
The description for the map resource.
MapName (string) --
The name of the associated map resource.
PricingPlan (string) --
No longer used. Always returns RequestBasedUsage .
UpdateTime (datetime) --
The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
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.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionlist_place_indexes(**kwargs)¶Lists place index resources in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_place_indexes(
MaxResults=123,
NextToken='string'
)
An optional limit for the maximum number of results returned in a single call.
Default value: 100
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
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'IndexName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Lists the place index resources that exist in your Amazon Web Services account
(dict) --
A place index resource listed in your Amazon Web Services account.
CreateTime (datetime) --
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
DataSource (string) --
The data provider of geospatial data. Values can be one of the following:
EsriGrabHereFor more information about data providers, see Amazon Location Service data providers.
Description (string) --
The optional description for the place index resource.
IndexName (string) --
The name of the place index resource.
PricingPlan (string) --
No longer used. Always returns RequestBasedUsage .
UpdateTime (datetime) --
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionlist_route_calculators(**kwargs)¶Lists route calculator resources in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_route_calculators(
MaxResults=123,
NextToken='string'
)
An optional maximum number of results returned in a single call.
Default Value: 100
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
dict
Response Syntax
{
'Entries': [
{
'CalculatorName': 'string',
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Lists the route calculator resources that exist in your Amazon Web Services account
(dict) --
A route calculator resource listed in your Amazon Web Services account.
CalculatorName (string) --
The name of the route calculator resource.
CreateTime (datetime) --
The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
2020–07-2T12:15:20.000Z+01:00DataSource (string) --
The data provider of traffic and road network data. Indicates one of the available providers:
EsriGrabHereFor more information about data providers, see Amazon Location Service data providers.
Description (string) --
The optional description of the route calculator resource.
PricingPlan (string) --
Always returns RequestBasedUsage .
UpdateTime (datetime) --
The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
2020–07-2T12:15:20.000Z+01:00NextToken (string) --
A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionReturns a list of tags that are applied to the specified Amazon Location resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
arn:aws:geo:region:account-id:resourcetype/ExampleResource{
'Tags': {
'string': 'string'
}
}
Response Structure
Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: "TagKey" : "TagValue" .
{"tag1" : "value1", "tag2" : "value2"}Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionlist_tracker_consumers(**kwargs)¶Lists geofence collections currently associated to the given tracker resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tracker_consumers(
MaxResults=123,
NextToken='string',
TrackerName='string'
)
An optional limit for the number of resources returned in a single call.
Default value: 100
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
[REQUIRED]
The tracker resource whose associated geofence collections you want to list.
dict
Response Syntax
{
'ConsumerArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConsumerArns (list) --
Contains the list of geofence collection ARNs associated to the tracker resource.
NextToken (string) --
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.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionlist_trackers(**kwargs)¶Lists tracker resources in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_trackers(
MaxResults=123,
NextToken='string'
)
An optional limit for the number of resources returned in a single call.
Default value: 100
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
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Contains tracker resources in your Amazon Web Services account. Details include tracker name, description and timestamps for when the tracker was created and last updated.
(dict) --
Contains the tracker resource details.
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Description (string) --
The description for the tracker resource.
PricingPlan (string) --
Always returns RequestBasedUsage .
PricingPlanDataSource (string) --
No longer used. Always returns an empty string.
TrackerName (string) --
The name of the tracker resource.
UpdateTime (datetime) --
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
NextToken (string) --
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.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionput_geofence(**kwargs)¶Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
See also: AWS API Documentation
Request Syntax
response = client.put_geofence(
CollectionName='string',
GeofenceId='string',
Geometry={
'Circle': {
'Center': [
123.0,
],
'Radius': 123.0
},
'Polygon': [
[
[
123.0,
],
],
]
}
)
[REQUIRED]
The geofence collection to store the geofence in.
[REQUIRED]
An identifier for the geofence. For example, ExampleGeofence-1 .
[REQUIRED]
Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.
Note
Each geofence polygon can have a maximum of 1,000 vertices.
A circle on the earth, as defined by a center point and a radius.
A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude] .
The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
A polygon is a list of linear rings which are each made up of a list of vertices.
Each vertex is a 2-dimensional point of the form: [longitude, latitude] . This is represented as an array of doubles of length 2 (so [double, double] ).
An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( [[double, double], ...] ).
A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( [[[double, double], ...], ...] ).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'GeofenceId': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
GeofenceId (string) --
The geofence identifier entered in the request.
UpdateTime (datetime) --
The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.ConflictExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionsearch_place_index_for_position(**kwargs)¶Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
See also: AWS API Documentation
Request Syntax
response = client.search_place_index_for_position(
IndexName='string',
Language='string',
MaxResults=123,
Position=[
123.0,
]
)
[REQUIRED]
The name of the place index resource you want to use for the search.
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en . The city in the results will most likely be returned as Athens .
If you set the language parameter to el , for Greek, then the city in the results will more likely be returned as Αθήνα .
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
An optional parameter. The maximum number of results returned per request.
Default value: 50
[REQUIRED]
Specifies the longitude and latitude of the position to query.
This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847 .
dict
Response Syntax
{
'Results': [
{
'Distance': 123.0,
'Place': {
'AddressNumber': 'string',
'Country': 'string',
'Geometry': {
'Point': [
123.0,
]
},
'Interpolated': True|False,
'Label': 'string',
'Municipality': 'string',
'Neighborhood': 'string',
'PostalCode': 'string',
'Region': 'string',
'Street': 'string',
'SubRegion': 'string',
'TimeZone': {
'Name': 'string',
'Offset': 123
},
'UnitNumber': 'string',
'UnitType': 'string'
},
'PlaceId': 'string'
},
],
'Summary': {
'DataSource': 'string',
'Language': 'string',
'MaxResults': 123,
'Position': [
123.0,
]
}
}
Response Structure
(dict) --
Results (list) --
Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.
(dict) --
Contains a search result from a position search query that is run on a place index resource.
Distance (float) --
The distance in meters of a great-circle arc between the query position and the result.
Note
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
Place (dict) --
Details about the search result, such as its address and position.
AddressNumber (string) --
The numerical portion of an address, such as a building number.
Country (string) --
A country/region specified using ISO 3166 3-digit country/region code. For example, CAN .
Geometry (dict) --
Places uses a point geometry to specify a location or a Place.
Point (list) --
A single point geometry specifies a location for a Place using WGS 84 coordinates:
Interpolated (boolean) --
Trueif the result is interpolated from other known places.
Falseif the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.
Label (string) --
The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA .
Municipality (string) --
A name for a local area, such as a city or town name. For example, Toronto .
Neighborhood (string) --
The name of a community district. For example, Downtown .
PostalCode (string) --
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
Region (string) --
A name for an area or geographical division, such as a province or state name. For example, British Columbia .
Street (string) --
The name for a street or a road to identify a location. For example, Main Street .
SubRegion (string) --
A county, or an area that's part of a larger region. For example, Metro Vancouver .
TimeZone (dict) --
The time zone in which the Place is located. Returned only when using HERE as the selected partner.
Name (string) --
The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles .
Offset (integer) --
The time zone's offset, in seconds, from UTC.
UnitNumber (string) --
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123 .
Note
Returned only for a place index that uses Esri as a data provider. Is not returned for SearchPlaceIndexForPosition .
UnitType (string) --
For addresses with a UnitNumber , the type of unit. For example, Apartment .
PlaceId (string) --
The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.
Note
For SearchPlaceIndexForPosition operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.
Summary (dict) --
Contains a summary of the request. Echoes the input values for Position , Language , MaxResults , and the DataSource of the place index.
DataSource (string) --
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
For more information about data providers, see Amazon Location Service data providers.
Language (string) --
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
MaxResults (integer) --
Contains the optional result count limit that is specified in the request.
Default value: 50
Position (list) --
The position specified in the request.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionsearch_place_index_for_suggestions(**kwargs)¶Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
Note
You can search for suggested place names near a specified position by using BiasPosition , or filter results within a bounding box by using FilterBBox . These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error.
See also: AWS API Documentation
Request Syntax
response = client.search_place_index_for_suggestions(
BiasPosition=[
123.0,
],
FilterBBox=[
123.0,
],
FilterCountries=[
'string',
],
IndexName='string',
Language='string',
MaxResults=123,
Text='string'
)
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847 .
Note
BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
An optional parameter that limits the search results by returning only suggestions within a specified bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835 , and the northeast corner has longitude -12.0684 and latitude -36.9542 .
Note
FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
An optional parameter that limits the search results by returning only suggestions within the provided list of countries.
AUS .[REQUIRED]
The name of the place index resource you want to use for the search.
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for Athens, Gr to get suggestions with the language parameter set to en . The results found will most likely be returned as Athens, Greece .
If you set the language parameter to el , for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα .
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
An optional parameter. The maximum number of results returned per request.
The default: 5
[REQUIRED]
The free-form partial text to use to generate place suggestions. For example, eiffel tow .
dict
Response Syntax
{
'Results': [
{
'PlaceId': 'string',
'Text': 'string'
},
],
'Summary': {
'BiasPosition': [
123.0,
],
'DataSource': 'string',
'FilterBBox': [
123.0,
],
'FilterCountries': [
'string',
],
'Language': 'string',
'MaxResults': 123,
'Text': 'string'
}
}
Response Structure
(dict) --
Results (list) --
A list of place suggestions that best match the search text.
(dict) --
Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.
PlaceId (string) --
The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.
Note
For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.
Text (string) --
The text of the place suggestion, typically formatted as an address string.
Summary (dict) --
Contains a summary of the request. Echoes the input values for BiasPosition , FilterBBox , FilterCountries , Language , MaxResults , and Text . Also includes the DataSource of the place index.
BiasPosition (list) --
Contains the coordinates for the optional bias position specified in the request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847 .
DataSource (string) --
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
For more information about data providers, see Amazon Location Service data providers.
FilterBBox (list) --
Contains the coordinates for the optional bounding box specified in the request.
FilterCountries (list) --
Contains the optional country filter specified in the request.
Language (string) --
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
MaxResults (integer) --
Contains the optional result count limit specified in the request.
Text (string) --
The free-form partial text input specified in the request.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionsearch_place_index_for_text(**kwargs)¶Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
Note
You can search for places near a given position using BiasPosition , or filter results within a bounding box using FilterBBox . Providing both parameters simultaneously returns an error.
Search results are returned in order of highest to lowest relevance.
See also: AWS API Documentation
Request Syntax
response = client.search_place_index_for_text(
BiasPosition=[
123.0,
],
FilterBBox=[
123.0,
],
FilterCountries=[
'string',
],
IndexName='string',
Language='string',
MaxResults=123,
Text='string'
)
An optional parameter that indicates a preference for places that are closer to a specified position.
If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847 .
Note
BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.
An optional parameter that limits the search results by returning only places that are within the provided bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835 , and the northeast corner has longitude -12.0684 and latitude -36.9542 .
Note
FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.
An optional parameter that limits the search results by returning only places that are in a specified list of countries.
AUS .[REQUIRED]
The name of the place index resource you want to use for the search.
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for Athens, Greece , with the language parameter set to en . The result found will most likely be returned as Athens .
If you set the language parameter to el , for Greek, then the result found will more likely be returned as Αθήνα .
If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
An optional parameter. The maximum number of results returned per request.
The default: 50
[REQUIRED]
The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street .
dict
Response Syntax
{
'Results': [
{
'Distance': 123.0,
'Place': {
'AddressNumber': 'string',
'Country': 'string',
'Geometry': {
'Point': [
123.0,
]
},
'Interpolated': True|False,
'Label': 'string',
'Municipality': 'string',
'Neighborhood': 'string',
'PostalCode': 'string',
'Region': 'string',
'Street': 'string',
'SubRegion': 'string',
'TimeZone': {
'Name': 'string',
'Offset': 123
},
'UnitNumber': 'string',
'UnitType': 'string'
},
'PlaceId': 'string',
'Relevance': 123.0
},
],
'Summary': {
'BiasPosition': [
123.0,
],
'DataSource': 'string',
'FilterBBox': [
123.0,
],
'FilterCountries': [
'string',
],
'Language': 'string',
'MaxResults': 123,
'ResultBBox': [
123.0,
],
'Text': 'string'
}
}
Response Structure
(dict) --
Results (list) --
A list of Places matching the input text. Each result contains additional information about the specific point of interest.
Not all response properties are included with all responses. Some properties may only be returned by specific data partners.
(dict) --
Contains a search result from a text search query that is run on a place index resource.
Distance (float) --
The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.
Note
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
Place (dict) --
Details about the search result, such as its address and position.
AddressNumber (string) --
The numerical portion of an address, such as a building number.
Country (string) --
A country/region specified using ISO 3166 3-digit country/region code. For example, CAN .
Geometry (dict) --
Places uses a point geometry to specify a location or a Place.
Point (list) --
A single point geometry specifies a location for a Place using WGS 84 coordinates:
Interpolated (boolean) --
Trueif the result is interpolated from other known places.
Falseif the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.
Label (string) --
The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA .
Municipality (string) --
A name for a local area, such as a city or town name. For example, Toronto .
Neighborhood (string) --
The name of a community district. For example, Downtown .
PostalCode (string) --
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
Region (string) --
A name for an area or geographical division, such as a province or state name. For example, British Columbia .
Street (string) --
The name for a street or a road to identify a location. For example, Main Street .
SubRegion (string) --
A county, or an area that's part of a larger region. For example, Metro Vancouver .
TimeZone (dict) --
The time zone in which the Place is located. Returned only when using HERE as the selected partner.
Name (string) --
The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles .
Offset (integer) --
The time zone's offset, in seconds, from UTC.
UnitNumber (string) --
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123 .
Note
Returned only for a place index that uses Esri as a data provider. Is not returned for SearchPlaceIndexForPosition .
UnitType (string) --
For addresses with a UnitNumber , the type of unit. For example, Apartment .
PlaceId (string) --
The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.
Note
For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider.
Relevance (float) --
The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.
Returned only when the partner selected is Esri or Grab.
Summary (dict) --
Contains a summary of the request. Echoes the input values for BiasPosition , FilterBBox , FilterCountries , Language , MaxResults , and Text . Also includes the DataSource of the place index and the bounding box, ResultBBox , which surrounds the search results.
BiasPosition (list) --
Contains the coordinates for the optional bias position specified in the request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847 .
DataSource (string) --
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
For more information about data providers, see Amazon Location Service data providers.
FilterBBox (list) --
Contains the coordinates for the optional bounding box specified in the request.
FilterCountries (list) --
Contains the optional country filter specified in the request.
Language (string) --
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
MaxResults (integer) --
Contains the optional result count limit specified in the request.
ResultBBox (list) --
The bounding box that fully contains all search results.
Note
If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox .
Text (string) --
The search text specified in the request.
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptiontag_resource(**kwargs)¶Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
You can use the TagResource operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate up to 50 tags with a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource whose tags you want to update.
arn:aws:geo:region:account-id:resourcetype/ExampleResource[REQUIRED]
Applies one or more tags to specific resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
Format: "key" : "value"
Restrictions:
dict
Response Syntax
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionuntag_resource(**kwargs)¶Removes one or more tags from the specified Amazon Location resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource from which you want to remove tags.
arn:aws:geo:region:account-id:resourcetype/ExampleResource[REQUIRED]
The list of tag keys to remove from the specified resource.
dict
Response Syntax
{}
Response Structure
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionupdate_geofence_collection(**kwargs)¶Updates the specified properties of a given geofence collection.
See also: AWS API Documentation
Request Syntax
response = client.update_geofence_collection(
CollectionName='string',
Description='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
PricingPlanDataSource='string'
)
[REQUIRED]
The name of the geofence collection to update.
RequestBasedUsage .dict
Response Syntax
{
'CollectionArn': 'string',
'CollectionName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CollectionArn (string) --
The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across Amazon Web Services.
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionCollectionName (string) --
The name of the updated geofence collection.
UpdateTime (datetime) --
The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionupdate_key(**kwargs)¶Updates the specified properties of a given API key resource.
Warning
The API keys feature is in preview. We may add, change, or remove features before announcing general availability. For more information, see Using API keys.
See also: AWS API Documentation
Request Syntax
response = client.update_key(
Description='string',
ExpireTime=datetime(2015, 1, 1),
ForceUpdate=True|False,
KeyName='string',
NoExpiry=True|False,
Restrictions={
'AllowActions': [
'string',
],
'AllowReferers': [
'string',
],
'AllowResources': [
'string',
]
}
)
YYYY-MM-DDThh:mm:ss.sssZ .The boolean flag to be included for updating ExpireTime or Restrictions details.
Must be set to true to update an API key resource that has been used in the past 7 days.
Falseif force update is not preferred
Default value: False
[REQUIRED]
The name of the API key resource to update.
true to set the API key to have no expiration time.Updates the API key restrictions for the API key resource.
A list of allowed actions that an API key resource grants permissions to perform
Note
Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
$\-._+!*`(),;/?:@=&https://example.com .A list of allowed resource ARNs that a API key bearer can perform actions on
For more information about ARN format, see Amazon Resource Names (ARNs).
Note
In this preview, you can allow only map resources.
Requirements:
arn .partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path. resource-id can also include wildcard characters, denoted by an asterisk (*).arn , partition , service , region , account-id and resource-id must be delimited by a colon (:).arn:aws:geo:region:account-id:map/ExampleMap* .dict
Response Syntax
{
'KeyArn': 'string',
'KeyName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
KeyArn (string) --
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
arn:aws:geo:region:account-id:key/ExampleKeyKeyName (string) --
The name of the API key resource.
UpdateTime (datetime) --
The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionupdate_map(**kwargs)¶Updates the specified properties of a given map resource.
See also: AWS API Documentation
Request Syntax
response = client.update_map(
Description='string',
MapName='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
[REQUIRED]
The name of the map resource to update.
RequestBasedUsage .dict
Response Syntax
{
'MapArn': 'string',
'MapName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
MapArn (string) --
The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.
arn:aws:geo:region:account-id:map/ExampleMapMapName (string) --
The name of the updated map resource.
UpdateTime (datetime) --
The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionupdate_place_index(**kwargs)¶Updates the specified properties of a given place index resource.
See also: AWS API Documentation
Request Syntax
response = client.update_place_index(
DataSourceConfiguration={
'IntendedUse': 'SingleUse'|'Storage'
},
Description='string',
IndexName='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
Updates the data storage option for the place index resource.
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse specifies that the results won't be stored.Storage specifies that the result can be cached or stored in a database.Default value: SingleUse
[REQUIRED]
The name of the place index resource to update.
RequestBasedUsage .dict
Response Syntax
{
'IndexArn': 'string',
'IndexName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
IndexArn (string) --
The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across Amazon Web Services.
arn:aws:geo:region:account-id:place- index/ExamplePlaceIndexIndexName (string) --
The name of the updated place index resource.
UpdateTime (datetime) --
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionupdate_route_calculator(**kwargs)¶Updates the specified properties for a given route calculator resource.
See also: AWS API Documentation
Request Syntax
response = client.update_route_calculator(
CalculatorName='string',
Description='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
[REQUIRED]
The name of the route calculator resource to update.
RequestBasedUsage .dict
Response Syntax
{
'CalculatorArn': 'string',
'CalculatorName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CalculatorArn (string) --
The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.
arn:aws:geo:region:account-id:route- calculator/ExampleCalculatorCalculatorName (string) --
The name of the updated route calculator resource.
UpdateTime (datetime) --
The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionupdate_tracker(**kwargs)¶Updates the specified properties of a given tracker resource.
See also: AWS API Documentation
Request Syntax
response = client.update_tracker(
Description='string',
PositionFiltering='TimeBased'|'DistanceBased'|'AccuracyBased',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
PricingPlanDataSource='string',
TrackerName='string'
)
Updates the position filtering for the tracker resource.
Valid values:
TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.RequestBasedUsage .[REQUIRED]
The name of the tracker resource to update.
dict
Response Syntax
{
'TrackerArn': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
TrackerArn (string) --
The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.
arn:aws:geo:region:account-id:tracker/ExampleTrackerTrackerName (string) --
The name of the updated tracker resource.
UpdateTime (datetime) --
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Exceptions
LocationService.Client.exceptions.InternalServerExceptionLocationService.Client.exceptions.ResourceNotFoundExceptionLocationService.Client.exceptions.AccessDeniedExceptionLocationService.Client.exceptions.ValidationExceptionLocationService.Client.exceptions.ThrottlingExceptionThe available paginators are:
LocationService.Paginator.GetDevicePositionHistoryLocationService.Paginator.ListDevicePositionsLocationService.Paginator.ListGeofenceCollectionsLocationService.Paginator.ListGeofencesLocationService.Paginator.ListKeysLocationService.Paginator.ListMapsLocationService.Paginator.ListPlaceIndexesLocationService.Paginator.ListRouteCalculatorsLocationService.Paginator.ListTrackerConsumersLocationService.Paginator.ListTrackersLocationService.Paginator.GetDevicePositionHistory¶paginator = client.get_paginator('get_device_position_history')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.get_device_position_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DeviceId='string',
EndTimeExclusive=datetime(2015, 1, 1),
StartTimeInclusive=datetime(2015, 1, 1),
TrackerName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The device whose position history you want to retrieve.
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:
EndTimeExclusive must be after the time for 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:
StartTimeInclusive must be before EndTimeExclusive .[REQUIRED]
The tracker resource receiving the request for the device position history.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DevicePositions': [
{
'Accuracy': {
'Horizontal': 123.0
},
'DeviceId': 'string',
'Position': [
123.0,
],
'PositionProperties': {
'string': 'string'
},
'ReceivedTime': datetime(2015, 1, 1),
'SampleTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
DevicePositions (list) --
Contains the position history details for the requested device.
(dict) --
Contains the device position details.
Accuracy (dict) --
The accuracy of the device position.
Horizontal (float) --
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
DeviceId (string) --
The device whose position you retrieved.
Position (list) --
The last known device position.
PositionProperties (dict) --
The properties associated with the position.
ReceivedTime (datetime) --
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
SampleTime (datetime) --
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
LocationService.Paginator.ListDevicePositions¶paginator = client.get_paginator('list_device_positions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_device_positions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TrackerName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The tracker resource containing the requested devices.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Entries': [
{
'Accuracy': {
'Horizontal': 123.0
},
'DeviceId': 'string',
'Position': [
123.0,
],
'PositionProperties': {
'string': 'string'
},
'SampleTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Entries (list) --
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.
(dict) --
Contains the tracker resource details.
Accuracy (dict) --
The accuracy of the device position.
Horizontal (float) --
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
DeviceId (string) --
The ID of the device for this position.
Position (list) --
The last known device position. Empty if no positions currently stored.
PositionProperties (dict) --
The properties associated with the position.
SampleTime (datetime) --
The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
LocationService.Paginator.ListGeofenceCollections¶paginator = client.get_paginator('list_geofence_collections')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_geofence_collections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Entries': [
{
'CollectionName': 'string',
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
Lists the geofence collections that exist in your Amazon Web Services account.
Contains the geofence collection details.
The name of the geofence collection.
The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
The description for the geofence collection
No longer used. Always returns RequestBasedUsage .
No longer used. Always returns an empty string.
Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
LocationService.Paginator.ListGeofences¶paginator = client.get_paginator('list_geofences')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_geofences().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CollectionName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the geofence collection storing the list of geofences.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'GeofenceId': 'string',
'Geometry': {
'Circle': {
'Center': [
123.0,
],
'Radius': 123.0
},
'Polygon': [
[
[
123.0,
],
],
]
},
'Status': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Entries (list) --
Contains a list of geofences stored in the geofence collection.
(dict) --
Contains a list of geofences stored in a given geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
GeofenceId (string) --
The geofence identifier.
Geometry (dict) --
Contains the geofence geometry details describing a polygon or a circle.
Circle (dict) --
A circle on the earth, as defined by a center point and a radius.
Center (list) --
A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude] .
Radius (float) --
The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
Polygon (list) --
A polygon is a list of linear rings which are each made up of a list of vertices.
Each vertex is a 2-dimensional point of the form: [longitude, latitude] . This is represented as an array of doubles of length 2 (so [double, double] ).
An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( [[double, double], ...] ).
A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( [[[double, double], ...], ...] ).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
Status (string) --
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.PENDING — The geofence is being processed by the system.FAILED — The geofence failed to be indexed by the system.DELETED — The geofence has been deleted from the system index.DELETING — The geofence is being deleted from the system index.UpdateTime (datetime) --
The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
LocationService.Paginator.ListKeys¶paginator = client.get_paginator('list_keys')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_keys().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'KeyStatus': 'Active'|'Expired'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optionally filter the list to only Active or Expired API keys.
Filter on Active or Expired API keys.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'ExpireTime': datetime(2015, 1, 1),
'KeyName': 'string',
'Restrictions': {
'AllowActions': [
'string',
],
'AllowReferers': [
'string',
],
'AllowResources': [
'string',
]
},
'UpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Entries (list) --
Contains API key resources in your Amazon Web Services account. Details include API key name, allowed referers and timestamp for when the API key will expire.
(dict) --
An API key resource listed in your Amazon Web Services account.
CreateTime (datetime) --
The timestamp of when the API key was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Description (string) --
The optional description for the API key resource.
ExpireTime (datetime) --
The timestamp for when the API key resource will expire, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
KeyName (string) --
The name of the API key resource.
Restrictions (dict) --
API Restrictions on the allowed actions, resources, and referers for an API key resource.
AllowActions (list) --
A list of allowed actions that an API key resource grants permissions to perform
Note
Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.
AllowReferers (list) --
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
$\-._+!*`(),;/?:@=&https://example.com .AllowResources (list) --
A list of allowed resource ARNs that a API key bearer can perform actions on
For more information about ARN format, see Amazon Resource Names (ARNs).
Note
In this preview, you can allow only map resources.
Requirements:
arn .partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path. resource-id can also include wildcard characters, denoted by an asterisk (*).arn , partition , service , region , account-id and resource-id must be delimited by a colon (:).arn:aws:geo:region:account-id:map/ExampleMap* .UpdateTime (datetime) --
The timestamp of when the API key was last updated, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
LocationService.Paginator.ListMaps¶paginator = client.get_paginator('list_maps')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_maps().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'MapName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
Contains a list of maps in your Amazon Web Services account
Contains details of an existing map resource in your Amazon Web Services account.
The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Specifies the data provider for the associated map tiles.
The description for the map resource.
The name of the associated map resource.
No longer used. Always returns RequestBasedUsage .
The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
LocationService.Paginator.ListPlaceIndexes¶paginator = client.get_paginator('list_place_indexes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_place_indexes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'IndexName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
Lists the place index resources that exist in your Amazon Web Services account
A place index resource listed in your Amazon Web Services account.
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
The data provider of geospatial data. Values can be one of the following:
EsriGrabHereFor more information about data providers, see Amazon Location Service data providers.
The optional description for the place index resource.
The name of the place index resource.
No longer used. Always returns RequestBasedUsage .
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
LocationService.Paginator.ListRouteCalculators¶paginator = client.get_paginator('list_route_calculators')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_route_calculators().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Entries': [
{
'CalculatorName': 'string',
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'UpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
Lists the route calculator resources that exist in your Amazon Web Services account
A route calculator resource listed in your Amazon Web Services account.
The name of the route calculator resource.
The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
2020–07-2T12:15:20.000Z+01:00The data provider of traffic and road network data. Indicates one of the available providers:
EsriGrabHereFor more information about data providers, see Amazon Location Service data providers.
The optional description of the route calculator resource.
Always returns RequestBasedUsage .
The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
2020–07-2T12:15:20.000Z+01:00LocationService.Paginator.ListTrackerConsumers¶paginator = client.get_paginator('list_tracker_consumers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_tracker_consumers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TrackerName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The tracker resource whose associated geofence collections you want to list.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConsumerArns': [
'string',
],
}
Response Structure
(dict) --
ConsumerArns (list) --
Contains the list of geofence collection ARNs associated to the tracker resource.
LocationService.Paginator.ListTrackers¶paginator = client.get_paginator('list_trackers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from LocationService.Client.list_trackers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Entries': [
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
Contains tracker resources in your Amazon Web Services account. Details include tracker name, description and timestamps for when the tracker was created and last updated.
Contains the tracker resource details.
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
The description for the tracker resource.
Always returns RequestBasedUsage .
No longer used. Always returns an empty string.
The name of the tracker resource.
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .