2020/12/16 - Amazon Location Service - 35 new api methods
Changes Update location client to latest version
Deletes a tracker resource from your AWS account.
See also: AWS API Documentation
Request Syntax
client.delete_tracker(
TrackerName='string'
)
string
[REQUIRED]
The name of the tracker resource to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists tracker resources in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_trackers(
MaxResults=123,
NextToken='string'
)
integer
An optional limit for the number of resources returned in a single call.
Default value: 100
string
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',
'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.
TrackerName (string) --
The name of the tracker resource.
UpdateTime (datetime) --
The timestamp for when the position was detected and sampled 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.
A batch request to retrieve device positions.
See also: AWS API Documentation
Request Syntax
client.batch_get_device_position(
DeviceIds=[
'string',
],
TrackerName='string'
)
list
[REQUIRED]
Devices whose position you want to retrieve.
For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2
(string) --
string
[REQUIRED]
The tracker resource retrieving the device position.
dict
Response Syntax
{
'DevicePositions': [
{
'DeviceId': 'string',
'Position': [
123.0,
],
'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.
DeviceId (string) --
The device whose position you retrieved.
Position (list) --
The last known device position.
(float) --
ReceivedTime (datetime) --
The timestamp for when the tracker resource recieved the position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
SampleTime (datetime) --
The timestamp for when the position was detected and sampled in 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.
Retrieves the geofence collection details.
See also: AWS API Documentation
Request Syntax
client.describe_geofence_collection(
CollectionName='string'
)
string
[REQUIRED]
The name of the geofence collection.
dict
Response Syntax
{
'CollectionArn': 'string',
'CollectionName': 'string',
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'UpdateTime': 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 of the geofence collection.
CreateTime (datetime) --
The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Description (string) --
The optional description for the geofence collection.
UpdateTime (datetime) --
The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Uploads a position update for one or more devices to a tracker resource. The data is used for API queries requesting the device position and position history.
See also: AWS API Documentation
Request Syntax
client.batch_update_device_position(
TrackerName='string',
Updates=[
{
'DeviceId': 'string',
'Position': [
123.0,
],
'SampleTime': datetime(2015, 1, 1)
},
]
)
string
[REQUIRED]
The name of the tracker resource to update.
list
[REQUIRED]
Contains the position update details for each device.
(dict) --
Contains the position update details for a device.
DeviceId (string) -- [REQUIRED]
The device associated to the position update.
Position (list) -- [REQUIRED]
The latest device position defined in WGS 84 format: [Xlongitude, Ylatitude].
(float) --
SampleTime (datetime) -- [REQUIRED]
The timestamp for when the position update was received in 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 for when a position sample was attempted in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Retrieves the Place index resource details.
See also: AWS API Documentation
Request Syntax
client.describe_place_index(
IndexName='string'
)
string
[REQUIRED]
The name of the Place index resource.
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'DataSourceConfiguration': {
'IntendedUse': 'SingleUse'|'Storage'
},
'Description': 'string',
'IndexArn': 'string',
'IndexName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
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.
DataSource (string) --
The data provider of geospatial data.
DataSourceConfiguration (dict) --
The specified data storage option for requesting Places.
IntendedUse (string) --
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.
Default value: SingleUse
Description (string) --
The optional description for the Place index resource.
IndexArn (string) --
The Amazon Resource Name (ARN) for the Place index resource. Used when you need to specify a resource across all AWS.
IndexName (string) --
The name of the Place index resource being described.
UpdateTime (datetime) --
The timestamp for when the Place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Deletes a map resource from your AWS account.
See also: AWS API Documentation
Request Syntax
client.delete_map(
MapName='string'
)
string
[REQUIRED]
The name of the map resource to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a geofence collection, which manages and stores geofences.
See also: AWS API Documentation
Request Syntax
client.create_geofence_collection(
CollectionName='string',
Description='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
string
[REQUIRED]
A custom name for the geofence collection.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), and underscores (_).
Must be a unique geofence collection name.
No spaces allowed. For example, ExampleGeofenceCollection.
string
An optional description for the geofence collection.
string
[REQUIRED]
Specifies the pricing plan for your geofence collection. There's three pricing plan options:
RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.
MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.
MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
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
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.
See also: AWS API Documentation
Request Syntax
client.associate_tracker_consumer(
ConsumerArn='string',
TrackerName='string'
)
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.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
string
[REQUIRED]
The name of the tracker resource to be associated with a geofence collection.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.get_map_sprites(
FileName='string',
MapName='string'
)
string
[REQUIRED]
The name of the sprite file. Use the following file names for the sprite sheet:
sprites.png
sprites@2x.png for high pixel density displays
For the JSON document contain image offsets. Use the following file names:
sprites.json
sprites@2x.json for high pixel density displays
string
[REQUIRED]
The map resource associated with the sprite file.
dict
Response Syntax
{
'Blob': StreamingBody(),
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (:class:`.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.
Lists Place index resources in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_place_indexes(
MaxResults=123,
NextToken='string'
)
integer
An optional limit for the maximum number of results returned in a single call.
Default value: 100
string
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',
'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.
Description (string) --
The optional description for the Place index resource.
IndexName (string) --
The name of the 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.
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.
Retrieves the latest device position.
See also: AWS API Documentation
Request Syntax
client.get_device_position(
DeviceId='string',
TrackerName='string'
)
string
[REQUIRED]
The device whose position you want to retreieve.
string
[REQUIRED]
The tracker resource receiving the position update.
dict
Response Syntax
{
'DeviceId': 'string',
'Position': [
123.0,
],
'ReceivedTime': datetime(2015, 1, 1),
'SampleTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
DeviceId (string) --
The device whose position you retrieved.
Position (list) --
The last known device position.
(float) --
ReceivedTime (datetime) --
The timestamp for when the tracker resource recieved the position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
SampleTime (datetime) --
The timestamp for when the position was detected and sampled in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Lists map resources in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_maps(
MaxResults=123,
NextToken='string'
)
integer
An optional limit for the number of resources returned in a single call.
Default value: 100
string
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',
'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.
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.
Lists geofence collections currently associated to the given tracker resource.
See also: AWS API Documentation
Request Syntax
client.list_tracker_consumers(
MaxResults=123,
NextToken='string',
TrackerName='string'
)
integer
An optional limit for the number of resources returned in a single call.
Default value: 100
string
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
string
[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.
(string) --
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.
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Includes the option to apply additional parameters to narrow your list of results.
See also: AWS API Documentation
Request Syntax
client.search_place_index_for_text(
BiasPosition=[
123.0,
],
FilterBBox=[
123.0,
],
FilterCountries=[
'string',
],
IndexName='string',
MaxResults=123,
Text='string'
)
list
Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.
The first bias position is the X coordinate, or longitude.
The second bias position is the Y coordinate, or latitude.
For example, bias=xLongitude&bias=yLatitude.
(float) --
list
Filters the results by returning only Places within the provided bounding box. An optional parameter.
The first 2 bbox parameters describe the lower southwest corner:
The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.
For example, bbox=xLongitudeSW&bbox=yLatitudeSW.
The next bbox parameters describe the upper northeast corner:
The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
For example, bbox=xLongitudeNE&bbox=yLatitudeNE
(float) --
list
Limits the search to the given a list of countries/regions. An optional parameter.
Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.
(string) --
string
[REQUIRED]
The name of the Place index resource you want to use for the search.
integer
An optional parameter. The maximum number of results returned per request.
The default: 50
string
[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': [
{
'Place': {
'AddressNumber': 'string',
'Country': 'string',
'Geometry': {
'Point': [
123.0,
]
},
'Label': 'string',
'Municipality': 'string',
'Neighborhood': 'string',
'PostalCode': 'string',
'Region': 'string',
'Street': 'string',
'SubRegion': 'string'
}
},
],
'Summary': {
'BiasPosition': [
123.0,
],
'DataSource': 'string',
'FilterBBox': [
123.0,
],
'FilterCountries': [
'string',
],
'MaxResults': 123,
'ResultBBox': [
123.0,
],
'Text': 'string'
}
}
Response Structure
(dict) --
Results (list) --
A list of Places closest to the specified position. Each result contains additional information about the specific point of interest.
(dict) --
Contains relevant Places returned by calling SearchPlaceIndexForText.
Place (dict) --
Contains details about the relevant point of interest.
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:
x — Specifies the x coordinate or longitude.
y — Specifies the y coordinate or latitude.
(float) --
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.
Summary (dict) --
Contains a summary of the request. Contains the BiasPosition, DataSource, FilterBBox, FilterCountries, MaxResults, ResultBBox, and Text.
BiasPosition (list) --
Contains the coordinates for the bias position entered in the geocoding request.
(float) --
DataSource (string) --
The data provider of geospatial data for the Place index resource.
FilterBBox (list) --
Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
(float) --
FilterCountries (list) --
Contains the country filter entered in the geocoding request.
(string) --
MaxResults (integer) --
Contains the maximum number of results indicated for the request.
ResultBBox (list) --
A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.
(float) --
Text (string) --
The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.
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
client.create_map(
Configuration={
'Style': 'string'
},
Description='string',
MapName='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
dict
[REQUIRED]
Specifies the map style selected from an available data provider.
Style (string) -- [REQUIRED]
Specifies the map style selected from an available data provider.
Valid styles: VectorEsriLightGrayCanvas, VectorEsriLight, VectorEsriStreets, VectorEsriNavigation, VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas, VectorHereBerlin
string
An optional description for the map resource.
string
[REQUIRED]
The name for the map resource.
Requirements:
Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), and underscores (_).
Must be a unique map resource name.
No spaces allowed. For example, ExampleMap.
string
[REQUIRED]
Specifies the pricing plan for your map resource. There's three pricing plan options:
RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.
MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.
MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
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 when you need to specify a resource across all AWS.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
MapName (string) --
The name of the map resource.
Retrieves the device position history from a tracker resource within a specified range of time.
See also: AWS API Documentation
Request Syntax
client.get_device_position_history(
DeviceId='string',
EndTimeExclusive=datetime(2015, 1, 1),
NextToken='string',
StartTimeInclusive=datetime(2015, 1, 1),
TrackerName='string'
)
string
[REQUIRED]
The device whose position history you want to retrieve.
datetime
Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The given time for EndTimeExclusive must be after the time for StartTimeInclusive.
string
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
datetime
Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
The given time for EndTimeExclusive must be after the time for StartTimeInclusive.
string
[REQUIRED]
The tracker resource receiving the request for the device position history.
dict
Response Syntax
{
'DevicePositions': [
{
'DeviceId': 'string',
'Position': [
123.0,
],
'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.
DeviceId (string) --
The device whose position you retrieved.
Position (list) --
The last known device position.
(float) --
ReceivedTime (datetime) --
The timestamp for when the tracker resource recieved the position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
SampleTime (datetime) --
The timestamp for when the position was detected and sampled 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.
Retrieves the tracker resource details.
See also: AWS API Documentation
Request Syntax
client.describe_tracker(
TrackerName='string'
)
string
[REQUIRED]
The name of the tracker resource.
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'TrackerArn': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Description (string) --
The optional description for the tracker resource.
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.
UpdateTime (datetime) --
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Deletes a batch of geofences from a geofence collection.
See also: AWS API Documentation
Request Syntax
client.batch_delete_geofence(
CollectionName='string',
GeofenceIds=[
'string',
]
)
string
[REQUIRED]
The geofence collection storing the geofences to be deleted.
list
[REQUIRED]
The batch of geofences to be deleted.
(string) --
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.
Lists geofence collections in your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_geofence_collections(
MaxResults=123,
NextToken='string'
)
integer
An optional limit for the number of resources returned in a single call.
Default value: 100
string
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',
'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
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.
A batch request for storing geofences into a given geofence collection.
See also: AWS API Documentation
Request Syntax
client.batch_put_geofence(
CollectionName='string',
Entries=[
{
'GeofenceId': 'string',
'Geometry': {
'Polygon': [
[
[
123.0,
],
],
]
}
},
]
)
string
[REQUIRED]
The geofence collection storing the geofences.
list
[REQUIRED]
The batch of geofences to be stored in a geofence collection.
(dict) --
Contains geofence details.
GeofenceId (string) -- [REQUIRED]
The identifier for the geofence to be stored in a given geofence collection.
Geometry (dict) -- [REQUIRED]
The geometry details for the geofence.
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.
(list) --
(list) --
(float) --
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
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
client.search_place_index_for_position(
IndexName='string',
MaxResults=123,
Position=[
123.0,
]
)
string
[REQUIRED]
The name of the Place index resource you want to use for the search.
integer
An optional paramer. The maximum number of results returned per request.
Default value: 50
list
[REQUIRED]
Specifies a coordinate for the query defined by a longitude, and latitude.
The first position is the X coordinate, or longitude.
The second position is the Y coordinate, or latitude.
For example, position=xLongitude&position=yLatitude .
(float) --
dict
Response Syntax
{
'Results': [
{
'Place': {
'AddressNumber': 'string',
'Country': 'string',
'Geometry': {
'Point': [
123.0,
]
},
'Label': 'string',
'Municipality': 'string',
'Neighborhood': 'string',
'PostalCode': 'string',
'Region': 'string',
'Street': 'string',
'SubRegion': 'string'
}
},
],
'Summary': {
'DataSource': '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) --
Specifies a single point of interest, or Place as a result of a search query obtained from a dataset configured in the Place index Resource.
Place (dict) --
Contains details about the relevant point of interest.
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:
x — Specifies the x coordinate or longitude.
y — Specifies the y coordinate or latitude.
(float) --
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.
Summary (dict) --
Contains a summary of the request.
DataSource (string) --
The data provider of geospatial data for the Place index resource.
MaxResults (integer) --
An optional parameter. The maximum number of results returned per request.
Default value: 50
Position (list) --
The position given in the reverse geocoding request.
(float) --
Deletes a Place index resource from your AWS account.
See also: AWS API Documentation
Request Syntax
client.delete_place_index(
IndexName='string'
)
string
[REQUIRED]
The name of the Place index resource to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves the geofence details from a geofence collection.
See also: AWS API Documentation
Request Syntax
client.get_geofence(
CollectionName='string',
GeofenceId='string'
)
string
[REQUIRED]
The geofence collection storing the target geofence.
string
[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.
(list) --
(list) --
(float) --
Status (string) --
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.
PENDING — The geofence is being processed by the system.
FAILED — The geofence failed to be indexed by the system.
DELETED — The geofence has been deleted from the system index.
DELETING — The geofence is being deleted from the system index.
UpdateTime (datetime) --
The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
Stores a geofence to 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
client.put_geofence(
CollectionName='string',
GeofenceId='string',
Geometry={
'Polygon': [
[
[
123.0,
],
],
]
}
)
string
[REQUIRED]
The geofence collection to store the geofence in.
string
[REQUIRED]
An identifier for the geofence. For example, ExampleGeofence-1.
dict
[REQUIRED]
Contains the polygon details to specify the position of the geofence.
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.
(list) --
(list) --
(float) --
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
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. They are 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
client.get_map_tile(
MapName='string',
X='string',
Y='string',
Z='string'
)
string
[REQUIRED]
The map resource to retrieve the map tiles from.
string
[REQUIRED]
The X axis value for the map tile.
string
[REQUIRED]
The Y axis value for the map tile.
string
[REQUIRED]
The zoom value for the map tile.
dict
Response Syntax
{
'Blob': StreamingBody(),
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (:class:`.StreamingBody`) --
Contains Mapbox Vector Tile (MVT) data.
ContentType (string) --
The map tile's content type. For example, application/vnd.mapbox-vector-tile.
Retrieves the map resource details.
See also: AWS API Documentation
Request Syntax
client.describe_map(
MapName='string'
)
string
[REQUIRED]
The name of the map resource.
dict
Response Syntax
{
'Configuration': {
'Style': 'string'
},
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'Description': 'string',
'MapArn': 'string',
'MapName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Configuration (dict) --
Specifies the map tile style selected from a partner data provider.
Style (string) --
Specifies the map style selected from an available data provider.
Valid styles: VectorEsriLightGrayCanvas, VectorEsriLight, VectorEsriStreets, VectorEsriNavigation, VectorEsriDarkGrayCanvas, VectorEsriLightGrayCanvas, VectorHereBerlin
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 optional description for the map resource.
MapArn (string) --
The Amazon Resource Name (ARN) for the map resource. Used when you need to specify a resource across all AWS.
MapName (string) --
The map style selected from an available provider.
UpdateTime (datetime) --
The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
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
client.create_tracker(
Description='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
TrackerName='string'
)
string
An optional description for the tracker resource.
string
[REQUIRED]
Specifies the pricing plan for your tracker resource. There's three pricing plan options:
RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.
MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.
MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
string
[REQUIRED]
The name for the tracker resource.
Requirements:
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-) and underscores (_).
Must be a unique tracker resource name.
No spaces allowed. For example, ExampleTracker.
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'TrackerArn': 'string',
'TrackerName': 'string'
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
TrackerArn (string) --
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.
TrackerName (string) --
The name of the tracker resource.
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
client.get_map_style_descriptor(
MapName='string'
)
string
[REQUIRED]
The map resource to retrieve the style descriptor from.
dict
Response Syntax
{
'Blob': StreamingBody(),
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (:class:`.StreamingBody`) --
Contains the body of the style descriptor.
ContentType (string) --
The style descriptor's content type. For example, application/json.
Used in geofence monitoring. Evaluates device positions against the position of geofences in a given geofence collection.
See also: AWS API Documentation
Request Syntax
client.batch_evaluate_geofences(
CollectionName='string',
DevicePositionUpdates=[
{
'DeviceId': 'string',
'Position': [
123.0,
],
'SampleTime': datetime(2015, 1, 1)
},
]
)
string
[REQUIRED]
The geofence collection used in evaluating the position of devices against its geofences.
list
[REQUIRED]
Contains device details for each device to be evaluated against the given geofence collection.
(dict) --
Contains the position update details for a device.
DeviceId (string) -- [REQUIRED]
The device associated to the position update.
Position (list) -- [REQUIRED]
The latest device position defined in WGS 84 format: [Xlongitude, Ylatitude].
(float) --
SampleTime (datetime) -- [REQUIRED]
The timestamp for when the position update was received in 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
Deletes a geofence collection from your AWS account.
See also: AWS API Documentation
Request Syntax
client.delete_geofence_collection(
CollectionName='string'
)
string
[REQUIRED]
The name of the geofence collection to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
See also: AWS API Documentation
Request Syntax
client.create_place_index(
DataSource='string',
DataSourceConfiguration={
'IntendedUse': 'SingleUse'|'Storage'
},
Description='string',
IndexName='string',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
string
[REQUIRED]
Specifies the data provider of geospatial data.
dict
Specifies the data storage option for requesting Places.
IntendedUse (string) --
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.
Default value: SingleUse
string
The optional description for the Place index resource.
string
[REQUIRED]
The name of the Place index resource.
Requirements:
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-) and underscores (_) ).
Must be a unique Place index resource name.
No spaces allowed. For example, ExamplePlaceIndex.
string
[REQUIRED]
Specifies the pricing plan for your Place index resource. There's three pricing plan options:
RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.
MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.
MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
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 when you need to specify a resource across all AWS.
IndexName (string) --
The name for the Place index resource.
Lists geofences stored in a given geofence collection.
See also: AWS API Documentation
Request Syntax
client.list_geofences(
CollectionName='string',
NextToken='string'
)
string
[REQUIRED]
The name of the geofence collection storing the list of geofences.
string
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.
(list) --
(list) --
(float) --
Status (string) --
Identifies the state of the geofence. A geofence will hold one of the following states:
ACTIVE — The geofence has been indexed by the system.
PENDING — The geofence is being processed by the system.
FAILED — The geofence failed to be indexed by the system.
DELETED — The geofence has been deleted from the system index.
DELETING — The geofence is being deleted from the system index.
UpdateTime (datetime) --
The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
NextToken (string) --
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
Removes the association bewteen a tracker resource and a geofence collection.
See also: AWS API Documentation
Request Syntax
client.disassociate_tracker_consumer(
ConsumerArn='string',
TrackerName='string'
)
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.
Format example: arn:partition:service:region:account-id:resource-type:resource-id
string
[REQUIRED]
The name of the tracker resource to be dissociated from the consumer.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves glyphs used to display labels on a map.
See also: AWS API Documentation
Request Syntax
client.get_map_glyphs(
FontStack='string',
FontUnicodeRange='string',
MapName='string'
)
string
[REQUIRED]
A comma-separated list of fonts to load glyphs from in order of preference.. For example, Noto Sans, Arial Unicode.
string
[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.
string
[REQUIRED]
The map resource associated with the glyph file.
dict
Response Syntax
{
'Blob': StreamingBody(),
'ContentType': 'string'
}
Response Structure
(dict) --
Blob (:class:`.StreamingBody`) --
The blob's content type.
ContentType (string) --
The map glyph content type. For example, application/octet-stream.