The name of the tracker resource to update.

Contains the position update details for each device.

The response's http status code.

Contains error details for each device that failed to update its position.

The name of the route calculator resource to be deleted.

The response's http status code.

Updates the pricing plan for the route calculator resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

Updates the description for the route calculator resource.

The name of the route calculator resource to update.

The response's http status code.

The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator

The name of the updated route calculator resource.

The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Specifies the data provider for the geofence collection.

• 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.

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

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

An optional description for the geofence collection.

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:

• Maximum 50 tags per resource
• Each resource tag must be unique with a maximum of one value.
• Maximum key length: 128 Unicode characters in UTF-8
• Maximum value length: 256 Unicode characters in UTF-8
• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

A custom name for the geofence collection.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
• Must be a unique geofence collection name.
• No spaces allowed. For example, ExampleGeofenceCollection.

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.

The response's http status code.

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

The name for the geofence collection.

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

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

An optional maximum number of results returned in a single call.

Default Value: 100

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.

The response's http status code.

Lists the route calculator resources that exist in your AWS account

Specifies the data provider for the tracker resource.

• 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.

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

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

An optional description for the tracker resource.

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:

• Maximum 50 tags per resource
• Each resource tag must be unique with a maximum of one value.
• Maximum key length: 128 Unicode characters in UTF-8
• Maximum value length: 256 Unicode characters in UTF-8
• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

Specifies the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.

This field is optional. If not specified, the default value is TimeBased.

Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

The name for the tracker resource.

Requirements:

• Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
• Must be a unique tracker resource name.
• No spaces allowed. For example, ExampleTracker.

The response's http status code.

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

The name of the tracker resource.

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

An optional limit for the number of resources returned in a single call.

Default value: 100

The tracker resource whose associated geofence collections you want to list.

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.

The response's http status code.

Contains the list of geofence collection ARNs associated to the tracker resource.

The device whose position you want to retrieve.

The tracker resource receiving the position update.

The device whose position you retrieved.

The response's http status code.

The last known device position.

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: "TagKey" : "TagValue".

• Format example: {"tag1" : "value1", "tag2" : "value2"}

The response's http status code.

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

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.

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.

An optional parameter. The maximum number of results returned per request.

The default: 50

The name of the place index resource you want to use for the search.

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

The response's http status code.

A list of Places closest to the specified position. Each result contains additional information about the specific point of interest.

Contains a summary of the request. Contains the BiasPosition, DataSource, FilterBBox, FilterCountries, MaxResults, ResultBBox, and Text.

The name of the geofence collection.

The specified data provider for the geofence collection.

A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource

Displays the key, value pairs of tags associated with this resource.

The response's http status code.

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

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.

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 timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

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

An optional limit for the number of resources returned in a single call.

Default value: 100

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.

The response's http status code.

Contains a list of maps in your AWS account

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

The map resource associated with the sprite file.

Contains the body of the sprite sheet or JSON offset file.

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.

The response's http status code.

An optional description for the map resource.

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:

• Maximum 50 tags per resource
• Each resource tag must be unique with a maximum of one value.
• Maximum key length: 128 Unicode characters in UTF-8
• Maximum value length: 256 Unicode characters in UTF-8
• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

Specifies the map style selected from an available data provider.

The name for the map resource.

Requirements:

• Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
• Must be a unique map resource name.
• No spaces allowed. For example, ExampleMap.

Specifies the pricing plan for your map resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

The response's http status code.

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:maps/ExampleMap

The name of the map resource.

The name of the route calculator resource.

Tags associated with route calculator resource.

The response's http status code.

The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

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.

• For example, 2020–07-2T12:15:20.000Z+01:00

The data provider of traffic and road network data. Indicates one of the available providers:

• Esri

• Here

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.

The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• For example, 2020–07-2T12:15:20.000Z+01:00

Devices whose position you want to retrieve.

• For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

The tracker resource retrieving the device position.

The response's http status code.

Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

Contains error details for each device that failed to send its position to the tracker resource.

The map resource to retrieve the style descriptor from.

Contains the body of the style descriptor.

The style descriptor's content type. For example, application/json.

The response's http status code.

The map resource to retrieve the map tiles from.

The X axis value for the map tile.

The Y axis value for the map tile.

The zoom value for the map tile.

Contains Mapbox Vector Tile (MVT) data.

The map tile's content type. For example, application/vnd.mapbox-vector-tile.

The response's http status code.

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

An optional limit for the number of resources returned in a single call.

Default value: 100

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.

The response's http status code.

Lists the geofence collections that exist in your AWS account.

The name of the geofence collection to be deleted.

The response's http status code.

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.

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.

Updates the description for the geofence collection.

The name of the geofence collection to update.

The response's http status code.

The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

The name of the updated geofence collection.

The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

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

An optional limit for the number of resources returned in a single call.

Default value: 100

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.

The response's http status code.

Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated.

The name of the place index resource to be deleted.

The response's http status code.

Updates the pricing plan for the place index resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

Updates the data storage option for the place index resource.

Updates the description for the place index resource.

The name of the place index resource to update.

The response's http status code.

The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex

The name of the updated place index resource.

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

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:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

The name of the tracker resource to be dissociated from the consumer.

The response's http status code.

The geofence collection to store the geofence in.

An identifier for the geofence. For example, ExampleGeofence-1.

Contains the polygon details to specify the position of the geofence.

Each geofence polygon can have a maximum of 1,000 vertices.

The response's http status code.

The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

The geofence identifier entered in the request.

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

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

The name of the geofence collection storing the list of geofences.

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.

The response's http status code.

Contains a list of geofences stored in the geofence collection.

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:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

The name of the tracker resource to be associated with a geofence collection.

The response's http status code.

The geofence collection used in evaluating the position of devices against its geofences.

Contains device details for each device to be evaluated against the given geofence collection.

The response's http status code.

Contains error details for each device that failed to evaluate its position against the given geofence collection.

Set the unit system to specify the distance.

Default Value: Kilometers

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.

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

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]

Set to include the geometry details in the result for each path between a pair of positions.

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

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:

• If traveling by Car use the CarModeOptions parameter.
• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

The name of the route calculator resource that you want to use to calculate a route.

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

• For example, [-123.115, 49.285]

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]

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

• For example, [-122.339, 47.615]

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]

The response's http status code.

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:

• The StartPosition is the departure position.
• The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

• Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
• Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

The name of the map resource to be deleted.

The response's http status code.

Updates the pricing plan for the map resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

Updates the description for the map resource.

The name of the map resource to update.

The response's http status code.

The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:maps/ExampleMap

The name of the updated map resource.

The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

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 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 time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

• The time specified for StartTimeInclusive must be before EndTimeExclusive.

The device whose position history you want to retrieve.

The tracker resource receiving the request for the device position history.

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.

The response's http status code.

Contains the position history details for the requested device.

The name of the tracker resource.

The specified data provider for the tracker resource.

A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.

The tags associated with the tracker resource.

The position filtering method of the tracker resource.

The response's http status code.

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.

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 Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

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.

The name of the place index resource.

Tags associated with place index resource.

The response's http status code.

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. Indicates one of the available providers:

• Esri

• Here

For additional details on data providers, see Amazon Location Service data providers.

The specified data storage option for requesting Places.

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.

• Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

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.

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The geofence collection storing the target geofence.

The geofence you're retrieving details for.

The response's http status code.

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

The geofence identifier.

Contains the geofence geometry details describing a polygon.

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.

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

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

An optional limit for the number of entries returned in a single call.

Default value: 100

The tracker resource containing the requested devices.

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.

The response's http status code.

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.

The Amazon Resource Name (ARN) of the resource whose tags you want to update.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: "TagKey" : "TagValue".

• Format example: {"tag1" : "value1", "tag2" : "value2"}

The response's http status code.

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:

• VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold
• VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold
• VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic
• VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold
• VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

Valid font stacks for HERE Technologies styles:

• VectorHereBerlin – Fira GO Regular | Fira GO Bold

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.

The map resource associated with the glyph file.

The blob's content type.

The map glyph content type. For example, application/octet-stream.

The response's http status code.

The geofence collection storing the geofences.

The batch of geofences to be stored in a geofence collection.

The response's http status code.

Contains additional error details for each geofence that failed to be stored in a geofence collection.

Contains each geofence that was successfully stored in a geofence collection.

The geofence collection storing the geofences to be deleted.

The batch of geofences to be deleted.

The response's http status code.

Contains error details for each geofence that failed to delete.

The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

The list of tag keys to remove from the specified resource.

The response's http status code.

Devices whose position history you want to delete.

• For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]

The name of the tracker resource to delete the device position history from.

The response's http status code.

Contains error details for each device history that failed to delete.

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

An optional limit for the maximum number of results returned in a single call.

Default value: 100

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.

The response's http status code.

Lists the place index resources that exist in your AWS account

An optional paramer. The maximum number of results returned per request.

Default value: 50

The name of the place index resource you want to use for the search.

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 .

The response's http status code.

Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

Contains a summary of the request.

The name of the tracker resource to be deleted.

The response's http status code.

Specifies the data storage option requesting Places.

The optional description for the place index resource.

Applies one or more tags to the place index resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource
• Each resource tag must be unique with a maximum of one value.
• Maximum key length: 128 Unicode characters in UTF-8
• Maximum value length: 256 Unicode characters in UTF-8
• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

Specifies the data provider of geospatial data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.

• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.

  Place index resources using HERE Technologies as a data provider can't 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.

The name of the place index resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
• Must be a unique place index resource name.
• No spaces allowed. For example, ExamplePlaceIndex.

Specifies the pricing plan for your place index resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

The response's http status code.

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

The name for the place index resource.

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

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.

Updates the description for the tracker resource.

Updates the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.

The name of the tracker resource to update.

The response's http status code.

The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

The name of the updated tracker resource.

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The optional description for the route calculator resource.

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.

• For example: { "tag1" : "value1", "tag2" : "value2"}

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource
• Each resource tag must be unique with a maximum of one value.
• Maximum key length: 128 Unicode characters in UTF-8
• Maximum value length: 256 Unicode characters in UTF-8
• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

The name of the route calculator resource.

Requirements:

• Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
• Must be a unique Route calculator resource name.
• No spaces allowed. For example, ExampleRouteCalculator.

Specifies the data provider of traffic and road network data.

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:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.
• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

Specifies the pricing plan for your route calculator resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

The response's http status code.

The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

The name of the route calculator resource.

• For example, ExampleRouteCalculator.

The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• For example, 2020–07-2T12:15:20.000Z+01:00

The name of the map resource.

Tags associated with the map resource.

The response's http status code.

Specifies the map tile style selected from a partner data provider.

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.

• Format example: arn:aws:geo:region:account-id:maps/ExampleMap

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>

The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The ID of the device for this position.

Undocumented member.

Contains details associated to the batch error.

The geofence associated with the error message.

The device associated with the position evaluation error.

Contains details associated to the batch error.

Specifies a timestamp for when the error occurred in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

The ID of the device that didn't return a position.

Contains details related to the error code.

The error code associated with the batch request error.

A message with the reason for the batch request error.

Contains details associated to the batch error.

The geofence associated with the error message.

The identifier for the geofence to be stored in a given geofence collection.

Contains the polygon details to specify the position of the geofence.

Each geofence polygon can have a maximum of 1,000 vertices.

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

The geofence successfully stored in a geofence collection.

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

The device associated with the failed location update.

Contains details related to the error code such as the error code and error message.

The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

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.

The unit of measurement for the distance.

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

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 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.

The next 2 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 latitude of the upper northeast corner.

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.

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.

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

Specifies how the results of an operation will be stored by the caller.

Valid values include:

• SingleUse specifies that the results won't be stored.
• Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

The device whose position you retrieved.

The last known device position.

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The device associated to the position update.

The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

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.

Contains the calculated route's path as a linestring geometry.

The distance between the leg's StartPosition and EndPosition along a calculated route.

• The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.

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.

The terminating position of the leg. Follows the format [longitude,latitude].

If the EndPosition isn't located on a road, it's snapped to a nearby road.

The starting position of the leg. Follows the format [longitude,latitude].

If the StartPosition isn't located on a road, it's snapped to a nearby road.

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.

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.

• For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]

The ID of the device for this position.

The last known device position. Empty if no positions currently stored.

The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

The specified data provider for the geofence collection.

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.

Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

The geofence identifier.

Contains the geofence geometry details describing a polygon.

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.

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

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.

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. Indicates one of the available providers:

• Esri

• Here

For additional details on 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.

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.

• For example, 2020–07-2T12:15:20.000Z+01:00

The data provider of traffic and road network data. Indicates one of the available providers:

• Esri

• Here

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.

• For example, 2020–07-2T12:15:20.000Z+01:00

The specified data provider for the tracker resource.

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 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.

Specifies the map style selected from an available data provider.

Valid Esri map styles:

• VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.
• RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.
• VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.
• VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.
• VectorEsriStreets – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.
• VectorEsriNavigation – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.

Valid HERE Technologies map styles:

• VectorHereBerlin – The HERE Berlin map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.

  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.

A name for a local area, such as a city or town name. For example, Toronto.

The numerical portion of an address, such as a building number.

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

The name for a street or a road to identify a location. For example, Main Street.

A country, or an area that's part of a larger region . For example, Metro Vancouver.

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

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.

The name of a community district. For example, Downtown.

Undocumented member.

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.

Contains details about the relevant point of interest.

Contains details about the relevant point of interest.

An optional parameter. The maximum number of results returned per request.

Default value: 50

The data provider of geospatial data. Indicates one of the available providers:

• Esri
• HERE

For additional details on data providers, see Amazon Location Service data providers.

The position given in the reverse geocoding request.

Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.

Contains the coordinates for the bias position entered in the geocoding request.

Contains the country filter entered in the geocoding request.