String keyStatus
Filter on Active or Expired API keys.
List<E> allowActions
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap* - Allows all actions needed for map rendering.
Place actions
geo:SearchPlaceIndexForText - Allows geocoding.
geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
GetPlace - Allows finding a place by place ID.
Route actions
geo:CalculateRoute - Allows point to point routing.
geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
You must use these strings exactly. For example, to provide access to map rendering, the only valid action is
geo:GetMap* as an input to the list. ["geo:GetMap*"] is valid but
["geo:GetMapTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you
must list each of the Place actions separately.
List<E> allowReferers
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list
$\-._+!*`(),;/?:@=&
May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
May contain wildcard characters question mark (?) and asterisk (*).
Question mark (?) will replace any single character (including hexadecimal digits).
Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
No spaces allowed. For example, https://example.com.
List<E> allowResources
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition, region, and account-id as the
key that is being created.
Other than wildcards, you must include the full ARN, including the arn, partition,
service, region, account-id and resource-id, delimited by
colons (:).
No spaces allowed, even with wildcards. For example,
arn:aws:geo:region:account-id:map/ExampleMap*.
For more information about ARN format, see Amazon Resource Names (ARNs).
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 Amazon Web Services.
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.
Map<K,V> geofenceProperties
Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.
Format: "key" : "value"
GeofenceGeometry geometry
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.
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 matrix.
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 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
List<E> departurePositions
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]
Date departureTime
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
List<E> destinationPositions
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]
String distanceUnit
Set the unit system to specify the distance.
Default Value: Kilometers
String key
The optional API key to authorize the request.
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 also determines how you specify route preferences:
If traveling by Car use the CarModeOptions parameter.
If traveling by Truck use the TruckModeOptions parameter.
Bicycle or Motorcycle are only valid when using Grab as a data provider,
and only within Southeast Asia.
Truck is not available for Grab.
For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.
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> routeMatrix
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.
List<E> snappedDeparturePositions
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.
List<E> snappedDestinationPositions
The list of destination positions for the route matrix used for calculation of the RouteMatrix.
CalculateRouteMatrixSummary summary
Contains information about the route matrix, DataSource, DistanceUnit,
RouteCount and ErrorCount.
String dataSource
The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
String distanceUnit
The unit of measurement for route distances.
Integer errorCount
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
Integer routeCount
The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the
number of DestinationPositions.
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 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]
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 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]
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 key
The optional API key to authorize the request.
String travelMode
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road
compatibility. You can choose Car, Truck, Walking, Bicycle or
Motorcycle as options for the TravelMode.
Bicycle and Motorcycle are only valid when using Grab as a data provider, and only
within Southeast Asia.
Truck is not available for Grab.
For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.
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
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
Grab
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 tolls 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 Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
String pricingPlan
No longer used. If included, the only allowed value is RequestBasedUsage.
String pricingPlanDataSource
This parameter is no longer used.
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 Amazon Web Services.
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
String description
An optional description for the API key resource.
Date expireTime
The optional timestamp for when the API key resource will expire in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.
String keyName
A custom name for the API key resource.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique API key name.
No spaces allowed. For example, ExampleAPIKey.
Boolean noExpiry
Optionally set to true to set no expiration time for the API key. One of NoExpiry or
ExpireTime must be set.
ApiKeyRestrictions restrictions
The API key restrictions for the API key resource.
Map<K,V> tags
Applies one or more tags to the map resource. A tag is a key-value pair that 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 API key resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String key
The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see GetMapGlyphs.
String keyArn
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:key/ExampleKey
String keyName
The name of the API key resource.
MapConfiguration configuration
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.
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
No longer used. If included, the only allowed value is RequestBasedUsage.
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 Amazon Web Services.
Format example: arn:aws:geo:region:account-id:map/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.
Grab – Grab provides place index functionality for Southeast Asia. For additional information about
GrabMaps' coverage, see GrabMaps countries
and areas covered.
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 Amazon Web Services 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
No longer used. If included, the only allowed value is RequestBasedUsage.
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 Amazon Web Services.
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.
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.
Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.
Grab – Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries
and areas covered.
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
No longer used. If included, the only allowed value is RequestBasedUsage.
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 Amazon Web Services.
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.
Boolean eventBridgeEnabled
Whether to enable position UPDATE events from this tracker to be sent to EventBridge.
You do not need enable this feature to get ENTER and EXIT events for geofences with
this tracker. Those events are always sent to EventBridge.
Boolean kmsKeyEnableGeospatialQueries
Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer
managed key.
This parameter is only used if you are using a KMS customer managed key.
If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.
You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the
KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.
String kmsKeyId
A key identifier for an Amazon Web Services 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.
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.
String pricingPlan
No longer used. If included, the only allowed value is RequestBasedUsage.
String pricingPlanDataSource
This parameter is no longer used.
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 Amazon Web Services.
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 keyName
The name of the API key to delete.
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 Amazon Web Services.
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.
Integer geofenceCount
The number of geofences in the geofence collection.
String kmsKeyId
A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource
String pricingPlan
No longer used. Always returns RequestBasedUsage.
String pricingPlanDataSource
No longer used. Always returns an empty string.
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 keyName
The name of the API key resource.
Date createTime
The timestamp for when the API key resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String description
The optional description for the API key resource.
Date expireTime
The timestamp for when the API key resource will expire in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String key
The key value/string of an API key.
String keyArn
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:key/ExampleKey
String keyName
The name of the API key resource.
ApiKeyRestrictions restrictions
Map<K,V> tags
Tags associated with the API key resource.
Date updateTime
The timestamp for when the API key resource 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 Amazon Web Services.
Format example: arn:aws:geo:region:account-id:map/ExampleMap
String mapName
The map style selected from an available provider.
String pricingPlan
No longer used. Always returns RequestBasedUsage.
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
Grab
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 Amazon Web Services.
Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
String indexName
The name of the place index resource being described.
String pricingPlan
No longer used. Always returns RequestBasedUsage.
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 Amazon Web Services.
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
Grab
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
Always returns RequestBasedUsage.
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.
Boolean eventBridgeEnabled
Whether UPDATE events from this tracker in EventBridge are enabled. If set to true
these events will be sent to EventBridge.
Boolean kmsKeyEnableGeospatialQueries
Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer
managed key.
This parameter is only used if you are using a KMS customer managed key.
If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.
You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the
KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.
String kmsKeyId
A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.
String positionFiltering
The position filtering method of the tracker resource.
String pricingPlan
Always returns RequestBasedUsage.
String pricingPlanDataSource
No longer used. Always returns an empty string.
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 Amazon Web Services.
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.
PositionalAccuracy accuracy
The accuracy of the device position.
String deviceId
The device whose position you retrieved.
List<E> position
The last known device position.
Map<K,V> positionProperties
The properties associated with the 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.
PositionalAccuracy accuracy
The accuracy of the device position.
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].
Map<K,V> positionProperties
Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.
Format: "key" : "value"
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 Amazon Web Services.
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.
Circle circle
A circle on the earth, as defined by a center point and a radius.
List<E> polygon
A polygon is a list of linear rings which are each made up of a list of vertices.
Each vertex is a 2-dimensional point of the form: [longitude, latitude]. This is represented as an
array of doubles of length 2 (so [double, double]).
An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is
called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s
interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles (
[[double, double], ...]).
A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array
of linear rings, which is represented as an array of arrays of arrays of doubles (
[[[double, double], ...], ...]).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
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.
Integer maxResults
An optional limit for the number of device positions 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 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.
PositionalAccuracy accuracy
The accuracy of the device position.
String deviceId
The device whose position you retrieved.
List<E> position
The last known device position.
Map<K,V> positionProperties
The properties associated with the 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.
Map<K,V> geofenceProperties
User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.
Format: "key" : "value"
GeofenceGeometry geometry
Contains the geofence geometry details describing a polygon or a circle.
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 font 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 GrabMaps styles:
VectorGrabStandardLight, VectorGrabStandardDark – Noto Sans Regular | Noto Sans Medium
| Noto Sans Bold
Valid font stacks for Open Data styles:
VectorOpenDataStandardLight, VectorOpenDataStandardDark, VectorOpenDataVisualizationLight,
VectorOpenDataVisualizationDark – 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 |
Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular |
Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold |
Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold |
Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular |
Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular |
Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
The fonts used by the Open Data map styles are combined fonts that use Amazon Ember for most glyphs
but Noto Sans for glyphs unsupported by Amazon Ember.
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 key
The optional API key to authorize the request.
String mapName
The map resource associated with the glyph file.
ByteBuffer blob
The glyph, as binary blob.
String cacheControl
The HTTP Cache-Control directive for the value.
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 containing image offsets. Use the following file names:
sprites.json
sprites@2x.json for high pixel density displays
String key
The optional API key to authorize the request.
String mapName
The map resource associated with the sprite file.
ByteBuffer blob
Contains the body of the sprite sheet or JSON offset file.
String cacheControl
The HTTP Cache-Control directive for the value.
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.
ByteBuffer blob
Contains the body of the style descriptor.
String cacheControl
The HTTP Cache-Control directive for the value.
String contentType
The style descriptor's content type. For example, application/json.
ByteBuffer blob
Contains Mapbox Vector Tile (MVT) data.
String cacheControl
The HTTP Cache-Control directive for the value.
String contentType
The map tile's content type. For example, application/vnd.mapbox-vector-tile.
String indexName
The name of the place index resource that you want to use for the search.
String key
The optional API key to authorize the request.
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, 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.
String placeId
The identifier of the place to find.
Place place
Details about the result, such as its address and position.
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.
TrackingFilterGeometry filterGeometry
The geomerty used to filter device positions.
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.
PositionalAccuracy accuracy
The accuracy of the device position.
String deviceId
The ID of the device for this position.
List<E> position
The last known device position. Empty if no positions currently stored.
Map<K,V> positionProperties
The properties associated with the position.
Date sampleTime
The timestamp at which the device position was determined. Uses 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
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
No longer used. Always returns RequestBasedUsage.
String pricingPlanDataSource
No longer used. Always returns an empty string.
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.
Map<K,V> geofenceProperties
User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.
Format: "key" : "value"
GeofenceGeometry geometry
Contains the geofence geometry details describing a polygon or a circle.
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
String collectionName
The name of the geofence collection storing the list of geofences.
Integer maxResults
An optional limit for the number of geofences 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
ApiKeyFilter filter
Optionally filter the list to only Active or Expired API keys.
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 of when the API key was created, in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String description
The optional description for the API key resource.
Date expireTime
The timestamp for when the API key resource will expire, in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
String keyName
The name of the API key resource.
ApiKeyRestrictions restrictions
Date updateTime
The timestamp of when the API key was last updated, in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
List<E> entries
Contains API key resources in your Amazon Web Services account. Details include API key name, allowed referers and timestamp for when the API key will expire.
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
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
No longer used. Always returns RequestBasedUsage.
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
Grab
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
No longer used. Always returns RequestBasedUsage.
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
Grab
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
Always returns RequestBasedUsage.
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
Always returns RequestBasedUsage.
String pricingPlanDataSource
No longer used. Always returns an empty string.
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 Amazon Web Services 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 politicalView
Specifies the political view for the style. Leave unset to not use a political view, or, for styles that support
specific political views, you can choose a view, such as IND for the Indian view.
Default is unset.
Not all map resources or styles support political view styles. See Political views for more information.
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 Street 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 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:
VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of
the world that blends 3D and 2D rendering.
The VectorHereContrast style has been renamed from VectorHereBerlin.
VectorHereBerlin has been deprecated, but will continue to work in applications that use it.
VectorHereExplore – A default HERE map style containing a neutral, global map and its features
including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.
VectorHereExploreTruck – A global map containing truck restrictions and attributes (e.g. width /
height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases
within transport and logistics.
RasterHereExploreSatellite – A global map containing high resolution satellite imagery.
HybridHereExploreSatellite – A global map displaying the road network, street names, and city labels
over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges
will be based on total tiles retrieved.
Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.
Valid GrabMaps map styles:
VectorGrabStandardLight – The Grab Standard Light map style provides a basemap with detailed land
use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.
VectorGrabStandardDark – The Grab Standard Dark map style provides a dark variation of the standard
basemap covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore)
Region (ap-southeast-1). For more information, see GrabMaps countries
and area covered.
Valid Open Data map styles:
VectorOpenDataStandardLight – The Open Data Standard Light map style provides a detailed basemap for
the world suitable for website and mobile application use. The map includes highways major roads, minor roads,
railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.
VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed map style that provides a
detailed basemap for the world suitable for website and mobile application use. The map includes highways major
roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative
boundaries.
VectorOpenDataVisualizationLight – The Open Data Visualization Light map style is a light-themed
style with muted colors and fewer features that aids in understanding overlaid data.
VectorOpenDataVisualizationDark – The Open Data Visualization Dark map style is a dark-themed style
with muted colors and fewer features that aids in understanding overlaid data.
String politicalView
Specifies the political view for the style. Set to an empty string to not use a political view, or, for styles
that support specific political views, you can choose a view, such as IND for the Indian view.
Not all map resources or styles support political view styles. See Political views for more information.
String addressNumber
The numerical portion of an address, such as a building number.
List<E> categories
The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
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 county, or an area that's part of a larger region. For example, Metro Vancouver.
List<E> supplementalCategories
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
TimeZone timeZone
The time zone in which the Place is located. Returned only when using HERE or Grab as the selected
partner.
String unitNumber
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
3B or Unit 123.
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for
SearchPlaceIndexForPosition.
String unitType
For addresses with a UnitNumber, the type of unit. For example, Apartment.
Returned only for a place index that uses Esri as a data provider.
Double horizontal
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.
String collectionName
The geofence collection to store the geofence in.
String geofenceId
An identifier for the geofence. For example, ExampleGeofence-1.
Map<K,V> geofenceProperties
Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.
Format: "key" : "value"
GeofenceGeometry geometry
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.
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 total distance of travel for the route.
Double durationSeconds
The expected duration of travel for the route.
RouteMatrixEntryError error
An error corresponding to the calculation of a route between the DeparturePosition and
DestinationPosition.
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.
String placeId
The unique identifier of the place. You can use this with the GetPlace operation to find the place
again later.
For SearchPlaceIndexForPosition operations, the PlaceId is returned only by place
indexes that use HERE or Grab as a data provider.
List<E> categories
The Amazon Location categories that describe the Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
String placeId
The unique identifier of the Place. You can use this with the GetPlace operation to find the place
again later, or to get full information for the Place.
The GetPlace request must use the same PlaceIndex resource as the
SearchPlaceIndexForSuggestions that generated the Place ID.
For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes
that use Esri, Grab, or HERE as data providers.
List<E> supplementalCategories
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
String text
The text of the place suggestion, typically formatted as an address string.
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.
String placeId
The unique identifier of the place. You can use this with the GetPlace operation to find the place
again later.
For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes
that use HERE or Grab as a data provider.
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 or Grab.
String indexName
The name of the place index resource you want to use for the search.
String key
The optional API key to authorize the request.
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, 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.
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
Grab
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 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.
List<E> filterBBox
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.
List<E> filterCategories
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
List<E> filterCountries
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.
String indexName
The name of the place index resource you want to use for the search.
String key
The optional API key to authorize the request.
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. 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.
Integer maxResults
An optional parameter. The maximum number of results returned per request.
The default: 5
String text
The free-form partial text to use to generate place suggestions. For example, eiffel tow.
List<E> results
A list of place suggestions that best match the search text.
SearchPlaceIndexForSuggestionsSummary 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.
List<E> biasPosition
Contains the coordinates for the optional bias position specified in the request.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and
latitude 49.2847.
String dataSource
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Grab
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> filterCategories
The optional category filter 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.
String text
The free-form partial text input 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> filterCategories
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
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 key
The optional API key to authorize the request.
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, 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.
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.
Not all response properties are included with all responses. Some properties may only be returned by specific data partners.
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.
This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.
For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and
latitude 49.2847.
String dataSource
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
Esri
Grab
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> filterCategories
The optional category filter 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.
Double height
The height of the truck.
For example, 4.5.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
Double length
The length of the truck.
For example, 15.5.
For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
String unit
Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
Double width
The width of the truck.
For example, 4.5.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
String collectionName
The name of the geofence collection to update.
String description
Updates the description for the geofence collection.
String pricingPlan
No longer used. If included, the only allowed value is RequestBasedUsage.
String pricingPlanDataSource
This parameter is no longer used.
String collectionArn
The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across Amazon Web Services.
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 API key resource.
Date expireTime
Updates the timestamp for when the API key resource will expire in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Boolean forceUpdate
The boolean flag to be included for updating ExpireTime or Restrictions details.
Must be set to true to update an API key resource that has been used in the past 7 days.
False if force update is not preferred
Default value: False
String keyName
The name of the API key resource to update.
Boolean noExpiry
Whether the API key should expire. Set to true to set the API key to have no expiration time.
ApiKeyRestrictions restrictions
Updates the API key restrictions for the API key resource.
String keyArn
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:key/ExampleKey
String keyName
The name of the API key resource.
Date updateTime
The timestamp for when the API key resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
MapConfigurationUpdate configurationUpdate
Updates the parts of the map configuration that can be updated, including the political view.
String description
Updates the description for the map resource.
String mapName
The name of the map resource to update.
String pricingPlan
No longer used. If included, the only allowed value is RequestBasedUsage.
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:map/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
No longer used. If included, the only allowed value is RequestBasedUsage.
String indexArn
The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across Amazon Web Services.
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 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.
Boolean eventBridgeEnabled
Whether to enable position UPDATE events from this tracker to be sent to EventBridge.
You do not need enable this feature to get ENTER and EXIT events for geofences with
this tracker. Those events are always sent to EventBridge.
Boolean kmsKeyEnableGeospatialQueries
Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer
managed key.
This parameter is only used if you are using a KMS customer managed key.
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 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.
String pricingPlan
No longer used. If included, the only allowed value is RequestBasedUsage.
String pricingPlanDataSource
This parameter is no longer used.
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 © 2023. All rights reserved.