Table of Contents
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:
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 AWS.
[REQUIRED]
The name of the tracker resource to be associated with a geofence collection.
dict
Response Syntax
{}
Response Structure
Exceptions
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.
[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
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
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:
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 .
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
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.
[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
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': {
'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 polygon details to specify the position of the geofence.
Note
Each geofence polygon can have a maximum of 1,000 vertices.
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
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
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
Calculates a route given the following required parameters: DeparturePostiton and DestinationPosition . 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:
Note
You can't specify both DepartureTime and DepartureNow in a single request. Specifying both parameters returns a validation error.
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',
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 WGS 84 format: [longitude, latitude] .
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.
[REQUIRED]
The finish position for the route. Defined in WGS 84 format: [longitude, latitude] .
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.
The TravelMode you specify determines how you specify route preferences:
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 ferries 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.
The length of the truck.
Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
The width of the truck.
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.
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.
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 :
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
(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 :
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Distance (float) --
The distance between the leg's StartPosition and EndPosition along a calculated route.
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.
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:
For 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:
The next 2 bbox parameters describe the upper northeast corner:
Exceptions
Check if an operation can be paginated.
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:
[REQUIRED]
Specifies the pricing plan for the geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
Specifies the data provider for the geofence collection.
For more information about Data Providers , and Pricing plans , see the Amazon Location Service product page.
Note
Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account or Region unless you move it.
Valid Values: Esri | Here
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 AWS.
CollectionName (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
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
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 map style selected from an available data provider.
Specifies the map style selected from an available data provider.
Valid Esri map styles :
Valid HERE Technologies map styles :
Note
When using HERE as your data provider, and selecting the Style VectorHereBerlin , you may not use HERE Technologies maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
[REQUIRED]
The name for the map resource.
Requirements:
[REQUIRED]
Specifies the pricing plan for your map resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
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 AWS.
MapName (string) --
The name of the map resource.
Exceptions
Creates a place index resource in your AWS 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.
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:
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 AWS 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:
Default value: SingleUse
[REQUIRED]
The name of the place index resource.
Requirements:
[REQUIRED]
Specifies the pricing plan for your place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
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 AWS.
IndexName (string) --
The name for the place index resource.
Exceptions
Creates a route calculator resource in your AWS 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.
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:
[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. Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.
Valid values include:
For additional information , see Data providers on the Amazon Location Service Developer Guide .
[REQUIRED]
Specifies the pricing plan for your route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
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.
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 AWS.
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 .
Exceptions
Creates a tracker resource in your AWS 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:
This field is optional. If not specified, the default value is TimeBased .
[REQUIRED]
Specifies the pricing plan for the tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
Specifies the data provider for the tracker resource.
For more information about Data Providers , and Pricing plans , see the Amazon Location Service product page.
Note
Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.
Valid values: Esri | Here
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:
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 AWS.
TrackerName (string) --
The name of the tracker resource.
Exceptions
Deletes a geofence collection from your AWS 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
Deletes a map resource from your AWS 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
Deletes a place index resource from your AWS 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
Deletes a route calculator resource from your AWS 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
Deletes a tracker resource from your AWS 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
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 AWS.
The 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 AWS KMS customer managed key assigned to the Amazon Location resource
The pricing plan selected for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
The specified data provider for the geofence collection.
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
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 :
Valid HERE Technologies map styles :
Note
When using HERE as your data provider, and selecting the Style VectorHereBerlin , you may not use HERE Technologies maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
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 AWS.
The map style selected from an available provider.
The pricing plan selected for the specified map resource.
<p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
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
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:
For 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:
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 AWS.
The name of the place index resource being described.
The pricing plan selected for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
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
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 AWS.
The 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 .
The data provider of traffic and road network data. Indicates one of the available providers:
For more information about data providers, see Amazon Location Service data providers .
The optional description of the route calculator resource.
The pricing plan selected for the specified route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
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 .
Exceptions
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 AWS KMS customer managed key assigned to the Amazon Location resource.
The position filtering method of the tracker resource.
The pricing plan selected for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
The specified data provider for the tracker resource.
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 AWS.
The 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
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 AWS.
[REQUIRED]
The name of the tracker resource to be dissociated from the consumer.
dict
Response Syntax
{}
Response Structure
Exceptions
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
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),
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:
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:
[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
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': {
'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.
Polygon (list) --
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
Status (string) --
Identifies the state of the geofence. A geofence will hold one of the following states:
UpdateTime (datetime) --
The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Exceptions
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',
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:
Valid font stacks for HERE Technologies styles:
[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(),
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (StreamingBody) --
The blob's content type.
ContentType (string) --
The map glyph content type. For example, application/octet-stream .
Exceptions
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',
MapName='string'
)
[REQUIRED]
The name of the sprite file. Use the following file names for the sprite sheet:
For the JSON document contain image offsets. Use the following file names:
[REQUIRED]
The map resource associated with the sprite file.
dict
Response Syntax
{
'Blob': StreamingBody(),
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (StreamingBody) --
Contains the body of the sprite sheet or JSON offset file.
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
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(
MapName='string'
)
[REQUIRED]
The map resource to retrieve the style descriptor from.
{
'Blob': StreamingBody(),
'ContentType': 'string'
}
Response Structure
Contains the body of the style descriptor.
The style descriptor's content type. For example, application/json .
Exceptions
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(
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(),
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (StreamingBody) --
Contains Mapbox Vector Tile (MVT) data.
ContentType (string) --
The map tile's content type. For example, application/vnd.mapbox-vector-tile .
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
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
Lists geofence collections in your AWS 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 AWS 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) --
The pricing plan for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
PricingPlanDataSource (string) --
The specified data provider for the geofence collection.
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
Lists geofences stored in a given geofence collection.
See also: AWS API Documentation
Request Syntax
response = client.list_geofences(
CollectionName='string',
NextToken='string'
)
[REQUIRED]
The name of the geofence collection storing the list of geofences.
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': {
'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.
Polygon (list) --
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
Status (string) --
Identifies the state of the geofence. A geofence will hold one of the following states:
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
Lists map resources in your AWS 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 AWS account
(dict) --
Contains details of an existing map resource in your AWS 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) --
The pricing plan for the specified map resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
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
Lists place index resources in your AWS 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 AWS account
(dict) --
A place index resource listed in your AWS 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:
For 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) --
The pricing plan for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
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
Lists route calculator resources in your AWS 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 AWS account
(dict) --
A route calculator resource listed in your AWS 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 .
DataSource (string) --
The data provider of traffic and road network data. Indicates one of the available providers:
For more information about data providers, see Amazon Location Service data providers .
Description (string) --
The optional description of the route calculator resource.
PricingPlan (string) --
The pricing plan for the specified route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
UpdateTime (datetime) --
The timestamp when the route calculator 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 subsequent request to fetch the next set of results.
Exceptions
Returns 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.
{
'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" .
Exceptions
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
Lists tracker resources in your AWS 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 AWS 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) --
The pricing plan for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
PricingPlanDataSource (string) --
The specified data provider for the tracker resource.
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
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={
'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 polygon details to specify the position of the geofence.
Note
Each geofence polygon can have a maximum of 1,000 vertices.
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
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
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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.
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
}
}
},
],
'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) --
True if the result is interpolated from other known places.
False if 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 country, 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.
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
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.
[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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.
Used only when the partner selected is Here.
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': [
{
'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.
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
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.
[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. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.
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
}
},
'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.
(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) --
True if the result is interpolated from other known places.
False if 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 country, 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.
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.
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
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
<p>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.</p> <p>You can use the <code>TagResource</code> 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. </p> <p>You can associate up to 50 tags with a resource.</p>
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.
[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
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.
[REQUIRED]
The list of tag keys to remove from the specified resource.
dict
Response Syntax
{}
Response Structure
Exceptions
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.
Updates the pricing plan for the geofence collection.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing .
Updates the data provider for the geofence collection.
A required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement
For more information about data providers and pricing plans , see the Amazon Location Service product page.
Note
This can only be updated when updating the PricingPlan in the same request.
Amazon Location Service uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.
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 AWS.
CollectionName (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
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.
Updates the pricing plan for the map resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing .
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.
MapName (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
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:
Default value: SingleUse
[REQUIRED]
The name of the place index resource to update.
Updates the pricing plan for the place index resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing .
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 AWS.
IndexName (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
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.
Updates the pricing plan for the route calculator resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing .
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.
CalculatorName (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
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:
Updates the pricing plan for the tracker resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing .
Updates the data provider for the tracker resource.
A required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement
For more information about data providers and pricing plans , see the Amazon Location Service product page
Note
This can only be updated when updating the PricingPlan in the same request.
Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.
[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.
TrackerName (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
The available paginators are:
paginator = client.get_paginator('get_device_position_history')
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,
'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:
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:
[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.
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 .
paginator = client.get_paginator('list_device_positions')
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 .
paginator = client.get_paginator('list_geofence_collections')
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 AWS 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
The pricing plan for the specified geofence collection.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .
The specified data provider for the geofence collection.
Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
paginator = client.get_paginator('list_geofences')
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,
'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.
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': {
'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.
Polygon (list) --
An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .
The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.
Status (string) --
Identifies the state of the geofence. A geofence will hold one of the following states:
UpdateTime (datetime) --
The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
paginator = client.get_paginator('list_maps')
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 AWS account
Contains details of an existing map resource in your AWS 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.
The pricing plan for the specified map resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
paginator = client.get_paginator('list_place_indexes')
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 AWS account
A place index resource listed in your AWS 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:
For 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.
The pricing plan for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
paginator = client.get_paginator('list_route_calculators')
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 AWS account
A route calculator resource listed in your AWS 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 .
The data provider of traffic and road network data. Indicates one of the available providers:
For more information about data providers, see Amazon Location Service data providers .
The optional description of the route calculator resource.
The pricing plan for the specified route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
paginator = client.get_paginator('list_tracker_consumers')
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.
paginator = client.get_paginator('list_trackers')
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 AWS 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.
The pricing plan for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing .
The specified data provider for the tracker resource.
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 .