String consumerArn
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
String trackerName
The name of the tracker resource to be associated with a geofence collection.
String deviceId
The ID of the device for this position.
BatchItemError error
BatchItemError error
Contains details associated to the batch error.
String geofenceId
The geofence associated with the error message.
String deviceId
The device associated with the position evaluation error.
BatchItemError error
Contains details associated to the batch error.
Date sampleTime
Specifies a timestamp for when the error occurred in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String deviceId
The ID of the device that didn't return a position.
BatchItemError error
Contains details related to the error code.
BatchItemError error
Contains details associated to the batch error.
String geofenceId
The geofence associated with the error message.
String geofenceId
The identifier for the geofence to be stored in a given geofence collection.
GeofenceGeometry geometry
Contains the polygon details to specify the position of the geofence.
Each geofence polygon can have a maximum of 1,000 vertices.
Date createTime
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String geofenceId
The geofence successfully stored in a geofence collection.
Date updateTime
The timestamp for when the geofence was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String deviceId
The device associated with the failed location update.
BatchItemError error
Contains details related to the error code such as the error code and error message.
Date sampleTime
The timestamp at which the device position was determined. Uses ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String calculatorName
The name of the route calculator resource that you want to use to calculate the route.
CalculateRouteCarModeOptions carModeOptions
Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or
tolls.
Requirements: TravelMode must be specified as Car.
Boolean departNow
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
List<E> departurePosition
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]
Date departureTime
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
List<E> destinationPosition
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]
String distanceUnit
Set the unit system to specify the distance.
Default Value: Kilometers
Boolean includeLegGeometry
Set to include the geometry details in the result for each path between a pair of positions.
Default Value: false
Valid Values: false | true
String travelMode
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
CalculateRouteTruckModeOptions truckModeOptions
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.
List<E> waypointPositions
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]
List<E> legs
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.
CalculateRouteSummary summary
Contains information about the whole route, such as: RouteBBox, DataSource,
Distance, DistanceUnit, and DurationSeconds.
String dataSource
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.
Double distance
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.
String distanceUnit
The unit of measurement for route distances.
Double durationSeconds
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
List<E> routeBBox
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.
Boolean avoidFerries
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Boolean avoidTolls
Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
TruckDimensions dimensions
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.
TruckWeight weight
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.
String collectionName
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.
String description
An optional description for the geofence collection.
String kmsKeyId
A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
String pricingPlan
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.
String pricingPlanDataSource
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
Map<K,V> tags
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.
String collectionArn
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
String collectionName
The name for the geofence collection.
Date createTime
The timestamp for when the geofence collection was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
MapConfiguration configuration
Specifies the map style selected from an available data provider.
String description
An optional description for the map resource.
String mapName
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.
String pricingPlan
Specifies the pricing plan for your map resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
Map<K,V> tags
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.
Date createTime
The timestamp for when the map resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String mapArn
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
String mapName
The name of the map resource.
String dataSource
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.
DataSourceConfiguration dataSourceConfiguration
Specifies the data storage option requesting Places.
String description
The optional description for the place index resource.
String indexName
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.
String pricingPlan
Specifies the pricing plan for your place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
Map<K,V> tags
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.
Date createTime
The timestamp for when the place index resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String indexArn
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
String indexName
The name for the place index resource.
String calculatorName
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.
String dataSource
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.
String description
The optional description for the route calculator resource.
String pricingPlan
Specifies the pricing plan for your route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
Map<K,V> tags
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.
String calculatorArn
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
String calculatorName
The name of the route calculator resource.
For example, ExampleRouteCalculator.
Date createTime
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
String description
An optional description for the tracker resource.
String kmsKeyId
A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
String positionFiltering
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.
This field is optional. If not specified, the default value is TimeBased.
String pricingPlan
Specifies the pricing plan for the tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
String pricingPlanDataSource
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
Map<K,V> tags
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.
String trackerName
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.
Date createTime
The timestamp for when the tracker resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String trackerArn
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
String trackerName
The name of the tracker resource.
String intendedUse
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.
Default value: SingleUse
String collectionName
The name of the geofence collection to be deleted.
String mapName
The name of the map resource to be deleted.
String indexName
The name of the place index resource to be deleted.
String calculatorName
The name of the route calculator resource to be deleted.
String trackerName
The name of the tracker resource to be deleted.
String collectionName
The name of the geofence collection.
String collectionArn
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
String collectionName
The name of the geofence collection.
Date createTime
The timestamp for when the geofence resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String description
The optional description for the geofence collection.
String kmsKeyId
A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource
String pricingPlan
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.
String pricingPlanDataSource
The specified data provider for the geofence collection.
Map<K,V> tags
Displays the key, value pairs of tags associated with this resource.
Date updateTime
The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String mapName
The name of the map resource.
MapConfiguration configuration
Specifies the map tile style selected from a partner data provider.
Date createTime
The timestamp for when the map resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String dataSource
Specifies the data provider for the associated map tiles.
String description
The optional description for the map resource.
String mapArn
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
String mapName
The map style selected from an available provider.
String pricingPlan
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>
Map<K,V> tags
Tags associated with the map resource.
Date updateTime
The timestamp for when the map resource was last update in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String indexName
The name of the place index resource.
Date createTime
The timestamp for when the place index resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String dataSource
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.
DataSourceConfiguration dataSourceConfiguration
The specified data storage option for requesting Places.
String description
The optional description for the place index resource.
String indexArn
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
String indexName
The name of the place index resource being described.
String pricingPlan
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.
Map<K,V> tags
Tags associated with place index resource.
Date updateTime
The timestamp for when the place index resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String calculatorName
The name of the route calculator resource.
String calculatorArn
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
String calculatorName
The name of the route calculator resource being described.
Date createTime
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
String dataSource
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.
String description
The optional description of the route calculator resource.
String pricingPlan
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.
Map<K,V> tags
Tags associated with route calculator resource.
Date updateTime
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
String trackerName
The name of the tracker resource.
Date createTime
The timestamp for when the tracker resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String description
The optional description for the tracker resource.
String kmsKeyId
A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
String positionFiltering
The position filtering method of the tracker resource.
String pricingPlan
The pricing plan selected for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
String pricingPlanDataSource
The specified data provider for the tracker resource.
Map<K,V> tags
The tags associated with the tracker resource.
String trackerArn
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
String trackerName
The name of the tracker resource.
Date updateTime
The timestamp for when the tracker resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String deviceId
The device whose position you retrieved.
List<E> position
The last known device position.
Date receivedTime
The timestamp for when the tracker resource received the device position in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Date sampleTime
The timestamp at which the device's position was determined. Uses ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String deviceId
The device associated to the position update.
List<E> position
The latest device position defined in WGS 84
format: [X or longitude, Y or latitude].
Date sampleTime
The timestamp at which the device's position was determined. Uses ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String consumerArn
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
String trackerName
The name of the tracker resource to be dissociated from the consumer.
List<E> polygon
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.
String deviceId
The device whose position history you want to retrieve.
Date endTimeExclusive
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.
String nextToken
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
Date 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.
String trackerName
The tracker resource receiving the request for the device position history.
String deviceId
The device whose position you retrieved.
List<E> position
The last known device position.
Date receivedTime
The timestamp for when the tracker resource received the device position in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Date sampleTime
The timestamp at which the device's position was determined. Uses ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Date createTime
The timestamp for when the geofence collection was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String geofenceId
The geofence identifier.
GeofenceGeometry geometry
Contains the geofence geometry details describing a polygon.
String status
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.
Date updateTime
The timestamp for when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String fontStack
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
String fontUnicodeRange
A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example,
0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples
of 256.
String mapName
The map resource associated with the glyph file.
ByteBuffer blob
The blob's content type.
String contentType
The map glyph content type. For example, application/octet-stream.
String fileName
The name of the sprite file. Use the following file names for the sprite sheet:
sprites.png
sprites@2x.png for high pixel density displays
For the JSON document contain image offsets. Use the following file names:
sprites.json
sprites@2x.json for high pixel density displays
String mapName
The map resource associated with the sprite file.
ByteBuffer blob
Contains the body of the sprite sheet or JSON offset file.
String contentType
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.
String mapName
The map resource to retrieve the style descriptor from.
ByteBuffer blob
Contains the body of the style descriptor.
String contentType
The style descriptor's content type. For example, application/json.
ByteBuffer blob
Contains Mapbox Vector Tile (MVT) data.
String contentType
The map tile's content type. For example, application/vnd.mapbox-vector-tile.
Double distance
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.
Double durationSeconds
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.
List<E> endPosition
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.
LegGeometry geometry
Contains the calculated route's path as a linestring geometry.
List<E> startPosition
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.
List<E> steps
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.
Integer maxResults
An optional limit for the number of entries returned in a single call.
Default value: 100
String nextToken
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
String trackerName
The tracker resource containing the requested devices.
List<E> entries
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.
String nextToken
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.
Integer maxResults
An optional limit for the number of resources returned in a single call.
Default value: 100
String nextToken
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
String collectionName
The name of the geofence collection.
Date createTime
The timestamp for when the geofence collection was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String description
The description for the geofence collection
String pricingPlan
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.
String pricingPlanDataSource
The specified data provider for the geofence collection.
Date updateTime
Specifies a timestamp for when the resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Date createTime
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String geofenceId
The geofence identifier.
GeofenceGeometry geometry
Contains the geofence geometry details describing a polygon.
String status
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.
Date updateTime
The timestamp for when the geofence was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Integer maxResults
An optional limit for the number of resources returned in a single call.
Default value: 100
String nextToken
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
Date createTime
The timestamp for when the map resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String dataSource
Specifies the data provider for the associated map tiles.
String description
The description for the map resource.
String mapName
The name of the associated map resource.
String pricingPlan
The pricing plan for the specified map resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
Date updateTime
The timestamp for when the map resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Integer maxResults
An optional limit for the maximum number of results returned in a single call.
Default value: 100
String nextToken
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
Date createTime
The timestamp for when the place index resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String dataSource
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.
String description
The optional description for the place index resource.
String indexName
The name of the place index resource.
String pricingPlan
The pricing plan for the specified place index resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
Date updateTime
The timestamp for when the place index resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Integer maxResults
An optional maximum number of results returned in a single call.
Default Value: 100
String nextToken
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default Value: null
String calculatorName
The name of the route calculator resource.
Date createTime
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
String dataSource
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.
String description
The optional description of the route calculator resource.
String pricingPlan
The pricing plan for the specified route calculator resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
Date updateTime
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
String resourceArn
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
Integer maxResults
An optional limit for the number of resources returned in a single call.
Default value: 100
String nextToken
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
String trackerName
The tracker resource whose associated geofence collections you want to list.
Integer maxResults
An optional limit for the number of resources returned in a single call.
Default value: 100
String nextToken
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
Date createTime
The timestamp for when the tracker resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String description
The description for the tracker resource.
String pricingPlan
The pricing plan for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
String pricingPlanDataSource
The specified data provider for the tracker resource.
String trackerName
The name of the tracker resource.
Date updateTime
The timestamp at which the device's position was determined. Uses ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
List<E> entries
Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated.
String nextToken
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.
String style
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.
String addressNumber
The numerical portion of an address, such as a building number.
String country
A country/region specified using ISO 3166 3-digit
country/region code. For example, CAN.
PlaceGeometry geometry
Boolean interpolated
True if the result is interpolated from other known places.
False if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False for an address location that is found in the partner data, but returns
True if an address does not exist in the partner data and its location is calculated by
interpolating between other known addresses.
String label
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.
String municipality
A name for a local area, such as a city or town name. For example, Toronto.
String neighborhood
The name of a community district. For example, Downtown.
String postalCode
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
String region
A name for an area or geographical division, such as a province or state name. For example,
British Columbia.
String street
The name for a street or a road to identify a location. For example, Main Street.
String subRegion
A country, or an area that's part of a larger region. For example, Metro Vancouver.
TimeZone timeZone
The time zone in which the Place is located. Returned only when using Here as the selected partner.
String collectionName
The geofence collection to store the geofence in.
String geofenceId
An identifier for the geofence. For example, ExampleGeofence-1.
GeofenceGeometry geometry
Contains the polygon details to specify the position of the geofence.
Each geofence polygon can have a maximum of 1,000 vertices.
Date createTime
The timestamp for when the geofence was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String geofenceId
The geofence identifier entered in the request.
Date updateTime
The timestamp for when the geofence was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Double distance
The distance in meters of a great-circle arc between the query position and the result.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
Place place
Details about the search result, such as its address and position.
Double distance
The distance in meters of a great-circle arc between the bias position specified and the result.
Distance will be returned only if a bias position was specified in the query.
A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.
Place place
Details about the search result, such as its address and position.
Double relevance
The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.
Returned only when the partner selected is Esri.
String indexName
The name of the place index resource you want to use for the search.
String language
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
This setting affects the languages used in the results. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.
Integer maxResults
An optional parameter. The maximum number of results returned per request.
Default value: 50
List<E> position
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.
List<E> results
Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.
SearchPlaceIndexForPositionSummary summary
Contains a summary of the request. Echoes the input values for Position, Language,
MaxResults, and the DataSource of the place index.
String dataSource
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
String language
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
Integer maxResults
Contains the optional result count limit that is specified in the request.
Default value: 50
List<E> position
The position specified in the request.
List<E> biasPosition
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.
List<E> filterBBox
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.
List<E> filterCountries
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.
String indexName
The name of the place index resource you want to use for the search.
String language
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.
This setting affects the languages used in the results. It does not change which results are returned. If the language is not specified, or not supported for a particular result, the partner automatically chooses a language for the result.
Integer maxResults
An optional parameter. The maximum number of results returned per request.
The default: 50
String text
The address, name, city, or region to be used in the search in free-form text format. For example,
123 Any Street.
List<E> results
A list of Places matching the input text. Each result contains additional information about the specific point of interest.
SearchPlaceIndexForTextSummary summary
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.
List<E> biasPosition
Contains the coordinates for the optional bias position specified in the request.
String dataSource
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Here
For more information about data providers, see Amazon Location Service data providers.
List<E> filterBBox
Contains the coordinates for the optional bounding box specified in the request.
List<E> filterCountries
Contains the optional country filter specified in the request.
String language
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.
Integer maxResults
Contains the optional result count limit specified in the request.
List<E> resultBBox
The bounding box that fully contains all search results.
If you specified the optional FilterBBox parameter in the request, ResultBBox is
contained within FilterBBox.
String text
The search text specified in the request.
Double distance
The travel distance between the step's StartPosition and EndPosition.
Double durationSeconds
The estimated travel time, in seconds, from the step's StartPosition to the EndPosition
. . The travel mode and departure time that you specify in the request determines the calculated time.
List<E> endPosition
The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.
Integer geometryOffset
Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For
example, the index of the first step in a leg geometry is 0.
Included in the response for queries that set IncludeLegGeometry to True.
List<E> startPosition
The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.
String resourceArn
The Amazon Resource Name (ARN) of the resource whose tags you want to update.
Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource
Map<K,V> tags
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.
String name
The name of the time zone, following the IANA time zone standard.
For example, America/Los_Angeles.
Integer offset
The time zone's offset, in seconds, from UTC.
String collectionName
The name of the geofence collection to update.
String description
Updates the description for the geofence collection.
String pricingPlan
Updates the pricing plan for the geofence collection.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
String pricingPlanDataSource
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.
String collectionArn
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
String collectionName
The name of the updated geofence collection.
Date updateTime
The time when the geofence collection was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
String description
Updates the description for the map resource.
String mapName
The name of the map resource to update.
String pricingPlan
Updates the pricing plan for the map resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
String mapArn
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
String mapName
The name of the updated map resource.
Date updateTime
The timestamp for when the map resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
DataSourceConfiguration dataSourceConfiguration
Updates the data storage option for the place index resource.
String description
Updates the description for the place index resource.
String indexName
The name of the place index resource to update.
String pricingPlan
Updates the pricing plan for the place index resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
String indexArn
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
String indexName
The name of the updated place index resource.
Date updateTime
The timestamp for when the place index resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String calculatorName
The name of the route calculator resource to update.
String description
Updates the description for the route calculator resource.
String pricingPlan
Updates the pricing plan for the route calculator resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
String calculatorArn
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
String calculatorName
The name of the updated route calculator resource.
Date updateTime
The timestamp for when the route calculator was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String description
Updates the description for the tracker resource.
String positionFiltering
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.
String pricingPlan
Updates the pricing plan for the tracker resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
String pricingPlanDataSource
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.
String trackerName
The name of the tracker resource to update.
String trackerArn
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
String trackerName
The name of the updated tracker resource.
Date updateTime
The timestamp for when the tracker resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Copyright © 2021. All rights reserved.