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.

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

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

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

Requirements: TravelMode must be specified as Car.

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 desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

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

Set the unit system to specify the distance.

Default Value: Kilometers

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

Default Value: false

Valid Values: false | true

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also 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 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]

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

The start position for the route. Defined in World Geodetic System (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 World Geodetic System (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.

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

Requirements: TravelMode must be specified as Car.

Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

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

Set the unit system to specify the distance.

Default Value: Kilometers

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify also determines how you specify route preferences:

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

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

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

Valid Values: [-180 to 180,-90 to 90]

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

Valid Values: [-180 to 180,-90 to 90]

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

The response's http status code.

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

An optional description for the geofence collection.

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

No longer used. If included, the only allowed value is RequestBasedUsage.

This parameter is no longer used.

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: + - = . _ : / @.
• Cannot use "aws:" as a prefix for a key.

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.

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

An optional description for the map resource.

No longer used. If included, the only allowed value is RequestBasedUsage.

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

Format: "key" : "value"

Restrictions:

• 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: + - = . _ : / @.
• Cannot use "aws:" as a prefix for a key.

Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

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.

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:map/ExampleMap

The name of the map resource.

Specifies the data storage option requesting Places.

The optional description for the place index resource.

No longer used. If included, the only allowed value is RequestBasedUsage.

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

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.
• Each tag key must be unique and must have exactly one associated 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: + - = . _ : / @
• Cannot use "aws:" as a prefix for a key.

Specifies the geospatial data provider for the new place index.

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.

  If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

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

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.

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.

The optional description for the route calculator resource.

No longer used. If included, the only allowed value is RequestBasedUsage.

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

• 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: + - = . _ : / @.
• Cannot use "aws:" as a prefix for a key.

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.

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

An optional description for the tracker resource.

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

Specifies the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

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

No longer used. If included, the only allowed value is RequestBasedUsage.

This parameter is no longer used.

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: + - = . _ : / @.
• Cannot use "aws:" as a prefix for a key.

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 name of the geofence collection to be deleted.

The response's http status code.

The name of the map resource to be deleted.

The response's http status code.

The name of the place index resource to be deleted.

The response's http status code.

The name of the route calculator resource to be deleted.

The response's http status code.

The name of the tracker resource to be deleted.

The response's http status code.

The name of the geofence collection.

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

No longer used. Always returns RequestBasedUsage.

No longer used. Always returns an empty string.

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

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

The name of the map resource.

No longer used. Always returns RequestBasedUsage.

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:map/ExampleMap

The map style selected from an available provider.

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

The name of the place index resource.

No longer used. Always returns RequestBasedUsage.

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. Values can be one of the following:

• Esri

• Here

For more information about 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 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.

Always returns RequestBasedUsage.

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 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 name of the tracker resource.

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

The position filtering method of the tracker resource.

Always returns RequestBasedUsage.

No longer used. Always returns an empty string.

The tags associated with 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 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 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 device whose position you want to retrieve.

The tracker resource receiving the position update.

The accuracy of the device position.

The device whose position you retrieved.

The properties associated with the position.

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.

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.

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

Default value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

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

Requirement:

• 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 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 or a circle.

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

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:

• VectorHereContrast – Fira GO Regular | Fira GO Bold
• VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – Fira GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

Valid font stacks for Open Data (Preview) styles:

• VectorOpenDataStandardLight – Amazon Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon Ember Medium,Noto Sans Medium | Amazon Ember Regular Italic,Noto Sans Italic | Amazon Ember Condensed RC Regular,Noto Sans Regular | Amazon Ember Condensed RC Bold,Noto Sans Bold

The fonts used by VectorOpenDataStandardLight are combined fonts that use Amazon Ember for most glyphs but Noto Sans for glyphs unsupported by Amazon Ember.

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

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 preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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

The identifier of the place to find.

The response's http status code.

Details about the result, such as its address and position.

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

Default value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

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.

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

Default value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

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.

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

Default value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

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.

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

Default value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

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

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

Default value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.

The response's http status code.

Lists the place index resources that exist in your AWS account

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

Default Value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default Value: null

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

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.

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

Default value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

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.

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

Default value: 100

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

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 geofence collection to store the geofence in.

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

Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

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 preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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

Default value: 50

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

Specifies the longitude and latitude of the position to query.

This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

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. Echoes the input values for Position, Language, MaxResults, and the DataSource of the place index.

An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for Athens, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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

The default: 5

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

The free-form partial text to use to generate place suggestions. For example, eiffel tow.

The response's http status code.

A list of place suggestions that best match the search text.

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index.

An optional parameter that indicates a preference for places that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

• Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

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

The default: 50

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 matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

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

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

Applies one or more tags to specific resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.
• Each tag key must be unique and must have exactly one associated 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: + - = . _ : / @
• Cannot use "aws:" as a prefix for a key.

The response's http status code.

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.

Updates the description for the geofence collection.

No longer used. If included, the only allowed value is RequestBasedUsage.

This parameter is no longer used.

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

Updates the description for the map resource.

No longer used. If included, the only allowed value is RequestBasedUsage.

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:map/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.

Updates the data storage option for the place index resource.

Updates the description for the place index resource.

No longer used. If included, the only allowed value is RequestBasedUsage.

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.

Updates the description for the route calculator resource.

No longer used. If included, the only allowed value is RequestBasedUsage.

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.

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 historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

No longer used. If included, the only allowed value is RequestBasedUsage.

This parameter is no longer used.

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 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 details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

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 ferries when calculating routes.

Default Value: false

Valid Values: false | true

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

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

• Esri

• Here

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

The unit of measurement for route distances.

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

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.