AWS SDK for PHP 3.x

Client: Aws\LocationService\LocationServiceClient

Service ID: location

Version: 2020-11-19

This page describes the parameters and results for the operations of the Amazon Location Service (2020-11-19), and shows how to use the Aws\LocationService\LocationServiceClient object to call the described operations. This documentation is specific to the 2020-11-19 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateTrackerConsumer ( array $params = [] )
Creates an association between a geofence collection and a tracker resource.
BatchDeleteDevicePositionHistory ( array $params = [] )
Deletes the position history of one or more devices from a tracker resource.
BatchDeleteGeofence ( array $params = [] )
Deletes a batch of geofences from a geofence collection.
BatchEvaluateGeofences ( array $params = [] )
Evaluates device positions against the geofence geometries from a given geofence collection.
BatchGetDevicePosition ( array $params = [] )
Lists the latest device positions for requested devices.
BatchPutGeofence ( array $params = [] )
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
BatchUpdateDevicePosition ( array $params = [] )
Uploads position update data for one or more devices to a tracker resource.
CalculateRoute ( array $params = [] )
Calculates a route given the following required parameters: DeparturePosition and DestinationPosition.
CalculateRouteMatrix ( array $params = [] )
Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions.
CreateGeofenceCollection ( array $params = [] )
Creates a geofence collection, which manages and stores geofences.
CreateMap ( array $params = [] )
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
CreatePlaceIndex ( array $params = [] )
Creates a place index resource in your AWS account.
CreateRouteCalculator ( array $params = [] )
Creates a route calculator resource in your AWS account.
CreateTracker ( array $params = [] )
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
DeleteGeofenceCollection ( array $params = [] )
Deletes a geofence collection from your AWS account.
DeleteMap ( array $params = [] )
Deletes a map resource from your AWS account.
DeletePlaceIndex ( array $params = [] )
Deletes a place index resource from your AWS account.
DeleteRouteCalculator ( array $params = [] )
Deletes a route calculator resource from your AWS account.
DeleteTracker ( array $params = [] )
Deletes a tracker resource from your AWS account.
DescribeGeofenceCollection ( array $params = [] )
Retrieves the geofence collection details.
DescribeMap ( array $params = [] )
Retrieves the map resource details.
DescribePlaceIndex ( array $params = [] )
Retrieves the place index resource details.
DescribeRouteCalculator ( array $params = [] )
Retrieves the route calculator resource details.
DescribeTracker ( array $params = [] )
Retrieves the tracker resource details.
DisassociateTrackerConsumer ( array $params = [] )
Removes the association between a tracker resource and a geofence collection.
GetDevicePosition ( array $params = [] )
Retrieves a device's most recent position according to its sample time.
GetDevicePositionHistory ( array $params = [] )
Retrieves the device position history from a tracker resource within a specified range of time.
GetGeofence ( array $params = [] )
Retrieves the geofence details from a geofence collection.
GetMapGlyphs ( array $params = [] )
Retrieves glyphs used to display labels on a map.
GetMapSprites ( array $params = [] )
Retrieves the sprite sheet corresponding to a map resource.
GetMapStyleDescriptor ( array $params = [] )
Retrieves the map style descriptor from a map resource.
GetMapTile ( array $params = [] )
Retrieves a vector data tile from the map resource.
ListDevicePositions ( array $params = [] )
A batch request to retrieve all device positions.
ListGeofenceCollections ( array $params = [] )
Lists geofence collections in your AWS account.
ListGeofences ( array $params = [] )
Lists geofences stored in a given geofence collection.
ListMaps ( array $params = [] )
Lists map resources in your AWS account.
ListPlaceIndexes ( array $params = [] )
Lists place index resources in your AWS account.
ListRouteCalculators ( array $params = [] )
Lists route calculator resources in your AWS account.
ListTagsForResource ( array $params = [] )
Returns a list of tags that are applied to the specified Amazon Location resource.
ListTrackerConsumers ( array $params = [] )
Lists geofence collections currently associated to the given tracker resource.
ListTrackers ( array $params = [] )
Lists tracker resources in your AWS account.
PutGeofence ( array $params = [] )
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
SearchPlaceIndexForPosition ( array $params = [] )
Reverse geocodes a given coordinate and returns a legible address.
SearchPlaceIndexForSuggestions ( array $params = [] )
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.
SearchPlaceIndexForText ( array $params = [] )
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
TagResource ( array $params = [] )
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
UntagResource ( array $params = [] )
Removes one or more tags from the specified Amazon Location resource.
UpdateGeofenceCollection ( array $params = [] )
Updates the specified properties of a given geofence collection.
UpdateMap ( array $params = [] )
Updates the specified properties of a given map resource.
UpdatePlaceIndex ( array $params = [] )
Updates the specified properties of a given place index resource.
UpdateRouteCalculator ( array $params = [] )
Updates the specified properties for a given route calculator resource.
UpdateTracker ( array $params = [] )
Updates the specified properties of a given tracker resource.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetDevicePositionHistory
ListDevicePositions
ListGeofenceCollections
ListGeofences
ListMaps
ListPlaceIndexes
ListRouteCalculators
ListTrackerConsumers
ListTrackers

Operations

AssociateTrackerConsumer

$result = $client->associateTrackerConsumer([/* ... */]);
$promise = $client->associateTrackerConsumerAsync([/* ... */]);

Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.

You can associate up to five geofence collections to each tracker resource.

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

Parameter Syntax

$result = $client->associateTrackerConsumer([
    'ConsumerArn' => '<string>', // REQUIRED
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ConsumerArn

Required: Yes
Type: string

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

TrackerName

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
ConflictException:
The request was unsuccessful because of a conflict.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ServiceQuotaExceededException:
The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.
ThrottlingException:
The request was denied because of request throttling.

BatchDeleteDevicePositionHistory

$result = $client->batchDeleteDevicePositionHistory([/* ... */]);
$promise = $client->batchDeleteDevicePositionHistoryAsync([/* ... */]);

Deletes the position history of one or more devices from a tracker resource.

Parameter Syntax

$result = $client->batchDeleteDevicePositionHistory([
    'DeviceIds' => ['<string>', ...], // REQUIRED
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceIds

Required: Yes
Type: Array of strings

Devices whose position history you want to delete.

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

TrackerName

Required: Yes
Type: string

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

Result Syntax

[
    'Errors' => [
        [
            'DeviceId' => '<string>',
            'Error' => [
                'Code' => 'AccessDeniedError|ConflictError|InternalServerError|ResourceNotFoundError|ThrottlingError|ValidationError',
                'Message' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

Errors

Required: Yes
Type: Array of BatchDeleteDevicePositionHistoryError structures

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

BatchDeleteGeofence

$result = $client->batchDeleteGeofence([/* ... */]);
$promise = $client->batchDeleteGeofenceAsync([/* ... */]);

Deletes a batch of geofences from a geofence collection.

This operation deletes the resource permanently.

Parameter Syntax

$result = $client->batchDeleteGeofence([
    'CollectionName' => '<string>', // REQUIRED
    'GeofenceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

The geofence collection storing the geofences to be deleted.

GeofenceIds

Required: Yes
Type: Array of strings

The batch of geofences to be deleted.

Result Syntax

[
    'Errors' => [
        [
            'Error' => [
                'Code' => 'AccessDeniedError|ConflictError|InternalServerError|ResourceNotFoundError|ThrottlingError|ValidationError',
                'Message' => '<string>',
            ],
            'GeofenceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Errors

Required: Yes
Type: Array of BatchDeleteGeofenceError structures

Contains error details for each geofence that failed to delete.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

BatchEvaluateGeofences

$result = $client->batchEvaluateGeofences([/* ... */]);
$promise = $client->batchEvaluateGeofencesAsync([/* ... */]);

Evaluates device positions against the geofence geometries from a given geofence collection.

This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:

ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
EXIT if Amazon Location determines that the tracked device has exited a geofenced area.

The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.

Geofence evaluation uses the given device position. It does not account for the optional Accuracy of a DevicePositionUpdate.

The DeviceID is used as a string to represent the device. You do not need to have a Tracker associated with the DeviceID.

Parameter Syntax

$result = $client->batchEvaluateGeofences([
    'CollectionName' => '<string>', // REQUIRED
    'DevicePositionUpdates' => [ // REQUIRED
        [
            'Accuracy' => [
                'Horizontal' => <float>, // REQUIRED
            ],
            'DeviceId' => '<string>', // REQUIRED
            'Position' => [<float>, ...], // REQUIRED
            'PositionProperties' => ['<string>', ...],
            'SampleTime' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

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

DevicePositionUpdates

Required: Yes
Type: Array of DevicePositionUpdate structures

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

Result Syntax

[
    'Errors' => [
        [
            'DeviceId' => '<string>',
            'Error' => [
                'Code' => 'AccessDeniedError|ConflictError|InternalServerError|ResourceNotFoundError|ThrottlingError|ValidationError',
                'Message' => '<string>',
            ],
            'SampleTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

Errors

Required: Yes
Type: Array of BatchEvaluateGeofencesError structures

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

BatchGetDevicePosition

$result = $client->batchGetDevicePosition([/* ... */]);
$promise = $client->batchGetDevicePositionAsync([/* ... */]);

Lists the latest device positions for requested devices.

Parameter Syntax

$result = $client->batchGetDevicePosition([
    'DeviceIds' => ['<string>', ...], // REQUIRED
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceIds

Required: Yes
Type: Array of strings

Devices whose position you want to retrieve.

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

TrackerName

Required: Yes
Type: string

The tracker resource retrieving the device position.

Result Syntax

[
    'DevicePositions' => [
        [
            'Accuracy' => [
                'Horizontal' => <float>,
            ],
            'DeviceId' => '<string>',
            'Position' => [<float>, ...],
            'PositionProperties' => ['<string>', ...],
            'ReceivedTime' => <DateTime>,
            'SampleTime' => <DateTime>,
        ],
        // ...
    ],
    'Errors' => [
        [
            'DeviceId' => '<string>',
            'Error' => [
                'Code' => 'AccessDeniedError|ConflictError|InternalServerError|ResourceNotFoundError|ThrottlingError|ValidationError',
                'Message' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

DevicePositions

Required: Yes
Type: Array of DevicePosition structures

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

Errors

Required: Yes
Type: Array of BatchGetDevicePositionError structures

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

BatchPutGeofence

$result = $client->batchPutGeofence([/* ... */]);
$promise = $client->batchPutGeofenceAsync([/* ... */]);

A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

Parameter Syntax

$result = $client->batchPutGeofence([
    'CollectionName' => '<string>', // REQUIRED
    'Entries' => [ // REQUIRED
        [
            'GeofenceId' => '<string>', // REQUIRED
            'Geometry' => [ // REQUIRED
                'Polygon' => [
                    [
                        [<float>, ...],
                        // ...
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

The geofence collection storing the geofences.

Entries

Required: Yes
Type: Array of BatchPutGeofenceRequestEntry structures

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

Result Syntax

[
    'Errors' => [
        [
            'Error' => [
                'Code' => 'AccessDeniedError|ConflictError|InternalServerError|ResourceNotFoundError|ThrottlingError|ValidationError',
                'Message' => '<string>',
            ],
            'GeofenceId' => '<string>',
        ],
        // ...
    ],
    'Successes' => [
        [
            'CreateTime' => <DateTime>,
            'GeofenceId' => '<string>',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

Errors

Required: Yes
Type: Array of BatchPutGeofenceError structures

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

Successes

Required: Yes
Type: Array of BatchPutGeofenceSuccess structures

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

BatchUpdateDevicePosition

$result = $client->batchUpdateDevicePosition([/* ... */]);
$promise = $client->batchUpdateDevicePositionAsync([/* ... */]);

Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.

Position updates are handled based on the PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.

When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).

When PositionFiltering is set to AccuracyBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0} when accuracy is not provided on a DevicePositionUpdate.

Parameter Syntax

$result = $client->batchUpdateDevicePosition([
    'TrackerName' => '<string>', // REQUIRED
    'Updates' => [ // REQUIRED
        [
            'Accuracy' => [
                'Horizontal' => <float>, // REQUIRED
            ],
            'DeviceId' => '<string>', // REQUIRED
            'Position' => [<float>, ...], // REQUIRED
            'PositionProperties' => ['<string>', ...],
            'SampleTime' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

TrackerName

Required: Yes
Type: string

The name of the tracker resource to update.

Updates

Required: Yes
Type: Array of DevicePositionUpdate structures

Contains the position update details for each device.

Result Syntax

[
    'Errors' => [
        [
            'DeviceId' => '<string>',
            'Error' => [
                'Code' => 'AccessDeniedError|ConflictError|InternalServerError|ResourceNotFoundError|ThrottlingError|ValidationError',
                'Message' => '<string>',
            ],
            'SampleTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

Errors

Required: Yes
Type: Array of BatchUpdateDevicePositionError structures

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

CalculateRoute

$result = $client->calculateRoute([/* ... */]);
$promise = $client->calculateRouteAsync([/* ... */]);

Calculates a route given the following required parameters: DeparturePosition and DestinationPosition. Requires that you first create a route calculator resource.

By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.

Additional options include:

Specifying a departure time using either DepartureTime or DepartNow. This calculates a route based on predictive traffic data at the given time.

You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.
Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.

Parameter Syntax

$result = $client->calculateRoute([
    'CalculatorName' => '<string>', // REQUIRED
    'CarModeOptions' => [
        'AvoidFerries' => true || false,
        'AvoidTolls' => true || false,
    ],
    'DepartNow' => true || false,
    'DeparturePosition' => [<float>, ...], // REQUIRED
    'DepartureTime' => <integer || string || DateTime>,
    'DestinationPosition' => [<float>, ...], // REQUIRED
    'DistanceUnit' => 'Kilometers|Miles',
    'IncludeLegGeometry' => true || false,
    'TravelMode' => 'Car|Truck|Walking',
    'TruckModeOptions' => [
        'AvoidFerries' => true || false,
        'AvoidTolls' => true || false,
        'Dimensions' => [
            'Height' => <float>,
            'Length' => <float>,
            'Unit' => 'Meters|Feet',
            'Width' => <float>,
        ],
        'Weight' => [
            'Total' => <float>,
            'Unit' => 'Kilograms|Pounds',
        ],
    ],
    'WaypointPositions' => [
        [<float>, ...],
        // ...
    ],
]);

Parameter Details

Members

CalculatorName

Required: Yes
Type: string

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

CarModeOptions

Type: CalculateRouteCarModeOptions structure

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

Requirements: TravelMode must be specified as Car.

DepartNow

Type: boolean

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

DeparturePosition

Required: Yes
Type: Array of doubles

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]

DepartureTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DestinationPosition

Required: Yes
Type: Array of doubles

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]

DistanceUnit

Type: string

Set the unit system to specify the distance.

Default Value: Kilometers

IncludeLegGeometry

Type: boolean

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

Default Value: false

Valid Values: false | true

TravelMode

Type: string

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

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

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

Default Value: Car

TruckModeOptions

Type: CalculateRouteTruckModeOptions structure

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.

WaypointPositions

Type: Array of floatss

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]

Result Syntax

[
    'Legs' => [
        [
            'Distance' => <float>,
            'DurationSeconds' => <float>,
            'EndPosition' => [<float>, ...],
            'Geometry' => [
                'LineString' => [
                    [<float>, ...],
                    // ...
                ],
            ],
            'StartPosition' => [<float>, ...],
            'Steps' => [
                [
                    'Distance' => <float>,
                    'DurationSeconds' => <float>,
                    'EndPosition' => [<float>, ...],
                    'GeometryOffset' => <integer>,
                    'StartPosition' => [<float>, ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Summary' => [
        'DataSource' => '<string>',
        'Distance' => <float>,
        'DistanceUnit' => 'Kilometers|Miles',
        'DurationSeconds' => <float>,
        'RouteBBox' => [<float>, ...],
    ],
]

Result Details

Members

Legs

Required: Yes
Type: Array of Leg structures

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.

Summary

Required: Yes
Type: CalculateRouteSummary structure

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

CalculateRouteMatrix

$result = $client->calculateRouteMatrix([/* ... */]);
$promise = $client->calculateRouteMatrixAsync([/* ... */]);

Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of DeparturePositions times the number of DestinationPositions.

Your account is charged for each route calculated, not the number of requests.

Requires that you first create a route calculator resource.

By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.

Additional options include:

Specifying a departure time using either DepartureTime or DepartNow. This calculates routes based on predictive traffic data at the given time.

You can't specify both DepartureTime and DepartNow in a single request. Specifying both parameters returns a validation error.
Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.

Parameter Syntax

$result = $client->calculateRouteMatrix([
    'CalculatorName' => '<string>', // REQUIRED
    'CarModeOptions' => [
        'AvoidFerries' => true || false,
        'AvoidTolls' => true || false,
    ],
    'DepartNow' => true || false,
    'DeparturePositions' => [ // REQUIRED
        [<float>, ...],
        // ...
    ],
    'DepartureTime' => <integer || string || DateTime>,
    'DestinationPositions' => [ // REQUIRED
        [<float>, ...],
        // ...
    ],
    'DistanceUnit' => 'Kilometers|Miles',
    'TravelMode' => 'Car|Truck|Walking',
    'TruckModeOptions' => [
        'AvoidFerries' => true || false,
        'AvoidTolls' => true || false,
        'Dimensions' => [
            'Height' => <float>,
            'Length' => <float>,
            'Unit' => 'Meters|Feet',
            'Width' => <float>,
        ],
        'Weight' => [
            'Total' => <float>,
            'Unit' => 'Kilograms|Pounds',
        ],
    ],
]);

Parameter Details

Members

CalculatorName

Required: Yes
Type: string

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

CarModeOptions

Type: CalculateRouteCarModeOptions structure

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

Requirements: TravelMode must be specified as Car.

DepartNow

Type: boolean

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

DeparturePositions

Required: Yes
Type: Array of floatss

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]

DepartureTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DestinationPositions

Required: Yes
Type: Array of floatss

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]

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]

DistanceUnit

Type: string

Set the unit system to specify the distance.

Default Value: Kilometers

TravelMode

Type: string

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

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

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

Default Value: Car

TruckModeOptions

Type: CalculateRouteTruckModeOptions structure

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.

Result Syntax

[
    'RouteMatrix' => [
        [
            [
                'Distance' => <float>,
                'DurationSeconds' => <float>,
                'Error' => [
                    'Code' => 'RouteNotFound|RouteTooLong|PositionsNotFound|DestinationPositionNotFound|DeparturePositionNotFound|OtherValidationError',
                    'Message' => '<string>',
                ],
            ],
            // ...
        ],
        // ...
    ],
    'SnappedDeparturePositions' => [
        [<float>, ...],
        // ...
    ],
    'SnappedDestinationPositions' => [
        [<float>, ...],
        // ...
    ],
    'Summary' => [
        'DataSource' => '<string>',
        'DistanceUnit' => 'Kilometers|Miles',
        'ErrorCount' => <integer>,
        'RouteCount' => <integer>,
    ],
]

Result Details

Members

RouteMatrix

Required: Yes
Type: Array of RouteMatrixEntry structuress

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.

SnappedDeparturePositions

Type: Array of floatss

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.

SnappedDestinationPositions

Type: Array of floatss

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

Summary

Required: Yes
Type: CalculateRouteMatrixSummary structure

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

CreateGeofenceCollection

$result = $client->createGeofenceCollection([/* ... */]);
$promise = $client->createGeofenceCollectionAsync([/* ... */]);

Creates a geofence collection, which manages and stores geofences.

Parameter Syntax

$result = $client->createGeofenceCollection([
    'CollectionName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'PricingPlanDataSource' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

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.

Description

Type: string

An optional description for the geofence collection.

KmsKeyId

Type: string

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

PricingPlan

Type: string

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

PricingPlanDataSource

Type: string

This parameter is no longer used.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'CollectionArn' => '<string>',
    'CollectionName' => '<string>',
    'CreateTime' => <DateTime>,
]

Result Details

Members

CollectionArn

Required: Yes
Type: string

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

CollectionName

Required: Yes
Type: string

The name for the geofence collection.

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ConflictException:
The request was unsuccessful because of a conflict.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

CreateMap

$result = $client->createMap([/* ... */]);
$promise = $client->createMapAsync([/* ... */]);

Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.

Parameter Syntax

$result = $client->createMap([
    'Configuration' => [ // REQUIRED
        'Style' => '<string>', // REQUIRED
    ],
    'Description' => '<string>',
    'MapName' => '<string>', // REQUIRED
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Configuration

Required: Yes
Type: MapConfiguration structure

Specifies the map style selected from an available data provider.

Description

Type: string

An optional description for the map resource.

MapName

Required: Yes
Type: string

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.

PricingPlan

Type: string

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

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'CreateTime' => <DateTime>,
    'MapArn' => '<string>',
    'MapName' => '<string>',
]

Result Details

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

MapArn

Required: Yes
Type: string

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

MapName

Required: Yes
Type: string

The name of the map resource.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ConflictException:
The request was unsuccessful because of a conflict.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

CreatePlaceIndex

$result = $client->createPlaceIndex([/* ... */]);
$promise = $client->createPlaceIndexAsync([/* ... */]);

Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

Parameter Syntax

$result = $client->createPlaceIndex([
    'DataSource' => '<string>', // REQUIRED
    'DataSourceConfiguration' => [
        'IntendedUse' => 'SingleUse|Storage',
    ],
    'Description' => '<string>',
    'IndexName' => '<string>', // REQUIRED
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

DataSource

Required: Yes
Type: string

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

Type: DataSourceConfiguration structure

Specifies the data storage option requesting Places.

Description

Type: string

The optional description for the place index resource.

IndexName

Required: Yes
Type: string

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.

PricingPlan

Type: string

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

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'CreateTime' => <DateTime>,
    'IndexArn' => '<string>',
    'IndexName' => '<string>',
]

Result Details

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

IndexArn

Required: Yes
Type: string

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

IndexName

Required: Yes
Type: string

The name for the place index resource.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ConflictException:
The request was unsuccessful because of a conflict.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

CreateRouteCalculator

$result = $client->createRouteCalculator([/* ... */]);
$promise = $client->createRouteCalculatorAsync([/* ... */]);

Creates a route calculator resource in your AWS account.

You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

Parameter Syntax

$result = $client->createRouteCalculator([
    'CalculatorName' => '<string>', // REQUIRED
    'DataSource' => '<string>', // REQUIRED
    'Description' => '<string>',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

CalculatorName

Required: Yes
Type: string

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.

DataSource

Required: Yes
Type: string

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.

Description

Type: string

The optional description for the route calculator resource.

PricingPlan

Type: string

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

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'CalculatorArn' => '<string>',
    'CalculatorName' => '<string>',
    'CreateTime' => <DateTime>,
]

Result Details

Members

CalculatorArn

Required: Yes
Type: string

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

CalculatorName

Required: Yes
Type: string

The name of the route calculator resource.

For example, ExampleRouteCalculator.

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ConflictException:
The request was unsuccessful because of a conflict.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

CreateTracker

$result = $client->createTracker([/* ... */]);
$promise = $client->createTrackerAsync([/* ... */]);

Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.

Parameter Syntax

$result = $client->createTracker([
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'PositionFiltering' => 'TimeBased|DistanceBased|AccuracyBased',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'PricingPlanDataSource' => '<string>',
    'Tags' => ['<string>', ...],
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

Type: string

An optional description for the tracker resource.

KmsKeyId

Type: string

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

PositionFiltering

Type: string

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.

PricingPlan

Type: string

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

PricingPlanDataSource

Type: string

This parameter is no longer used.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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.

TrackerName

Required: Yes
Type: string

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.

Result Syntax

[
    'CreateTime' => <DateTime>,
    'TrackerArn' => '<string>',
    'TrackerName' => '<string>',
]

Result Details

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

TrackerArn

Required: Yes
Type: string

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

TrackerName

Required: Yes
Type: string

The name of the tracker resource.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ConflictException:
The request was unsuccessful because of a conflict.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DeleteGeofenceCollection

$result = $client->deleteGeofenceCollection([/* ... */]);
$promise = $client->deleteGeofenceCollectionAsync([/* ... */]);

Deletes a geofence collection from your AWS account.

This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

Parameter Syntax

$result = $client->deleteGeofenceCollection([
    'CollectionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

The name of the geofence collection to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DeleteMap

$result = $client->deleteMap([/* ... */]);
$promise = $client->deleteMapAsync([/* ... */]);

Deletes a map resource from your AWS account.

This operation deletes the resource permanently. If the map is being used in an application, the map may not render.

Parameter Syntax

$result = $client->deleteMap([
    'MapName' => '<string>', // REQUIRED
]);

Parameter Details

Members

MapName

Required: Yes
Type: string

The name of the map resource to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DeletePlaceIndex

$result = $client->deletePlaceIndex([/* ... */]);
$promise = $client->deletePlaceIndexAsync([/* ... */]);

Deletes a place index resource from your AWS account.

This operation deletes the resource permanently.

Parameter Syntax

$result = $client->deletePlaceIndex([
    'IndexName' => '<string>', // REQUIRED
]);

Parameter Details

Members

IndexName

Required: Yes
Type: string

The name of the place index resource to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DeleteRouteCalculator

$result = $client->deleteRouteCalculator([/* ... */]);
$promise = $client->deleteRouteCalculatorAsync([/* ... */]);

Deletes a route calculator resource from your AWS account.

This operation deletes the resource permanently.

Parameter Syntax

$result = $client->deleteRouteCalculator([
    'CalculatorName' => '<string>', // REQUIRED
]);

Parameter Details

Members

CalculatorName

Required: Yes
Type: string

The name of the route calculator resource to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DeleteTracker

$result = $client->deleteTracker([/* ... */]);
$promise = $client->deleteTrackerAsync([/* ... */]);

Deletes a tracker resource from your AWS account.

This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.

Parameter Syntax

$result = $client->deleteTracker([
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

TrackerName

Required: Yes
Type: string

The name of the tracker resource to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DescribeGeofenceCollection

$result = $client->describeGeofenceCollection([/* ... */]);
$promise = $client->describeGeofenceCollectionAsync([/* ... */]);

Retrieves the geofence collection details.

Parameter Syntax

$result = $client->describeGeofenceCollection([
    'CollectionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

The name of the geofence collection.

Result Syntax

[
    'CollectionArn' => '<string>',
    'CollectionName' => '<string>',
    'CreateTime' => <DateTime>,
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'PricingPlanDataSource' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CollectionArn

Required: Yes
Type: string

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

CollectionName

Required: Yes
Type: string

The name of the geofence collection.

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Description

Required: Yes
Type: string

The optional description for the geofence collection.

KmsKeyId

Type: string

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

PricingPlan

Type: string

No longer used. Always returns RequestBasedUsage.

PricingPlanDataSource

Type: string

No longer used. Always returns an empty string.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DescribeMap

$result = $client->describeMap([/* ... */]);
$promise = $client->describeMapAsync([/* ... */]);

Retrieves the map resource details.

Parameter Syntax

$result = $client->describeMap([
    'MapName' => '<string>', // REQUIRED
]);

Parameter Details

Members

MapName

Required: Yes
Type: string

The name of the map resource.

Result Syntax

[
    'Configuration' => [
        'Style' => '<string>',
    ],
    'CreateTime' => <DateTime>,
    'DataSource' => '<string>',
    'Description' => '<string>',
    'MapArn' => '<string>',
    'MapName' => '<string>',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'Tags' => ['<string>', ...],
    'UpdateTime' => <DateTime>,
]

Result Details

Members

Configuration

Required: Yes
Type: MapConfiguration structure

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

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DataSource

Required: Yes
Type: string

Specifies the data provider for the associated map tiles.

Description

Required: Yes
Type: string

The optional description for the map resource.

MapArn

Required: Yes
Type: string

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

MapName

Required: Yes
Type: string

The map style selected from an available provider.

PricingPlan

Type: string

No longer used. Always returns RequestBasedUsage.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags associated with the map resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DescribePlaceIndex

$result = $client->describePlaceIndex([/* ... */]);
$promise = $client->describePlaceIndexAsync([/* ... */]);

Retrieves the place index resource details.

Parameter Syntax

$result = $client->describePlaceIndex([
    'IndexName' => '<string>', // REQUIRED
]);

Parameter Details

Members

IndexName

Required: Yes
Type: string

The name of the place index resource.

Result Syntax

[
    'CreateTime' => <DateTime>,
    'DataSource' => '<string>',
    'DataSourceConfiguration' => [
        'IntendedUse' => 'SingleUse|Storage',
    ],
    'Description' => '<string>',
    'IndexArn' => '<string>',
    'IndexName' => '<string>',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'Tags' => ['<string>', ...],
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DataSource

Required: Yes
Type: string

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

Required: Yes
Type: DataSourceConfiguration structure

The specified data storage option for requesting Places.

Description

Required: Yes
Type: string

The optional description for the place index resource.

IndexArn

Required: Yes
Type: string

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

IndexName

Required: Yes
Type: string

The name of the place index resource being described.

PricingPlan

Type: string

No longer used. Always returns RequestBasedUsage.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags associated with place index resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DescribeRouteCalculator

$result = $client->describeRouteCalculator([/* ... */]);
$promise = $client->describeRouteCalculatorAsync([/* ... */]);

Retrieves the route calculator resource details.

Parameter Syntax

$result = $client->describeRouteCalculator([
    'CalculatorName' => '<string>', // REQUIRED
]);

Parameter Details

Members

CalculatorName

Required: Yes
Type: string

The name of the route calculator resource.

Result Syntax

[
    'CalculatorArn' => '<string>',
    'CalculatorName' => '<string>',
    'CreateTime' => <DateTime>,
    'DataSource' => '<string>',
    'Description' => '<string>',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'Tags' => ['<string>', ...],
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CalculatorArn

Required: Yes
Type: string

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

CalculatorName

Required: Yes
Type: string

The name of the route calculator resource being described.

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DataSource

Required: Yes
Type: string

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.

Description

Required: Yes
Type: string

The optional description of the route calculator resource.

PricingPlan

Type: string

Always returns RequestBasedUsage.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags associated with route calculator resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DescribeTracker

$result = $client->describeTracker([/* ... */]);
$promise = $client->describeTrackerAsync([/* ... */]);

Retrieves the tracker resource details.

Parameter Syntax

$result = $client->describeTracker([
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

TrackerName

Required: Yes
Type: string

The name of the tracker resource.

Result Syntax

[
    'CreateTime' => <DateTime>,
    'Description' => '<string>',
    'KmsKeyId' => '<string>',
    'PositionFiltering' => 'TimeBased|DistanceBased|AccuracyBased',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'PricingPlanDataSource' => '<string>',
    'Tags' => ['<string>', ...],
    'TrackerArn' => '<string>',
    'TrackerName' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Description

Required: Yes
Type: string

The optional description for the tracker resource.

KmsKeyId

Type: string

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

PositionFiltering

Type: string

The position filtering method of the tracker resource.

PricingPlan

Type: string

Always returns RequestBasedUsage.

PricingPlanDataSource

Type: string

No longer used. Always returns an empty string.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags associated with the tracker resource.

TrackerArn

Required: Yes
Type: string

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

TrackerName

Required: Yes
Type: string

The name of the tracker resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

DisassociateTrackerConsumer

$result = $client->disassociateTrackerConsumer([/* ... */]);
$promise = $client->disassociateTrackerConsumerAsync([/* ... */]);

Removes the association between a tracker resource and a geofence collection.

Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.

Parameter Syntax

$result = $client->disassociateTrackerConsumer([
    'ConsumerArn' => '<string>', // REQUIRED
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ConsumerArn

Required: Yes
Type: string

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

TrackerName

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

GetDevicePosition

$result = $client->getDevicePosition([/* ... */]);
$promise = $client->getDevicePositionAsync([/* ... */]);

Retrieves a device's most recent position according to its sample time.

Device positions are deleted after 30 days.

Parameter Syntax

$result = $client->getDevicePosition([
    'DeviceId' => '<string>', // REQUIRED
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceId

Required: Yes
Type: string

The device whose position you want to retrieve.

TrackerName

Required: Yes
Type: string

The tracker resource receiving the position update.

Result Syntax

[
    'Accuracy' => [
        'Horizontal' => <float>,
    ],
    'DeviceId' => '<string>',
    'Position' => [<float>, ...],
    'PositionProperties' => ['<string>', ...],
    'ReceivedTime' => <DateTime>,
    'SampleTime' => <DateTime>,
]

Result Details

Members

Accuracy

Type: PositionalAccuracy structure

The accuracy of the device position.

DeviceId

Type: string

The device whose position you retrieved.

Position

Required: Yes
Type: Array of doubles

The last known device position.

PositionProperties

Type: Associative array of custom strings keys (PropertyMapKeyString) to strings

The properties associated with the position.

ReceivedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

SampleTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

GetDevicePositionHistory

$result = $client->getDevicePositionHistory([/* ... */]);
$promise = $client->getDevicePositionHistoryAsync([/* ... */]);

Retrieves the device position history from a tracker resource within a specified range of time.

Device positions are deleted after 30 days.

Parameter Syntax

$result = $client->getDevicePositionHistory([
    'DeviceId' => '<string>', // REQUIRED
    'EndTimeExclusive' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTimeInclusive' => <integer || string || DateTime>,
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceId

Required: Yes
Type: string

The device whose position history you want to retrieve.

EndTimeExclusive

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

MaxResults

Type: int

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

Default value: 100

NextToken

Type: string

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

Default value: null

StartTimeInclusive

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

TrackerName

Required: Yes
Type: string

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

Result Syntax

[
    'DevicePositions' => [
        [
            'Accuracy' => [
                'Horizontal' => <float>,
            ],
            'DeviceId' => '<string>',
            'Position' => [<float>, ...],
            'PositionProperties' => ['<string>', ...],
            'ReceivedTime' => <DateTime>,
            'SampleTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DevicePositions

Required: Yes
Type: Array of DevicePosition structures

Contains the position history details for the requested device.

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

GetGeofence

$result = $client->getGeofence([/* ... */]);
$promise = $client->getGeofenceAsync([/* ... */]);

Retrieves the geofence details from a geofence collection.

Parameter Syntax

$result = $client->getGeofence([
    'CollectionName' => '<string>', // REQUIRED
    'GeofenceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

The geofence collection storing the target geofence.

GeofenceId

Required: Yes
Type: string

The geofence you're retrieving details for.

Result Syntax

[
    'CreateTime' => <DateTime>,
    'GeofenceId' => '<string>',
    'Geometry' => [
        'Polygon' => [
            [
                [<float>, ...],
                // ...
            ],
            // ...
        ],
    ],
    'Status' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

GeofenceId

Required: Yes
Type: string

The geofence identifier.

Geometry

Required: Yes
Type: GeofenceGeometry structure

Contains the geofence geometry details describing a polygon.

Status

Required: Yes
Type: string

Identifies the state of the geofence. A geofence will hold one of the following states:

ACTIVE — The geofence has been indexed by the system.
PENDING — The geofence is being processed by the system.
FAILED — The geofence failed to be indexed by the system.
DELETED — The geofence has been deleted from the system index.
DELETING — The geofence is being deleted from the system index.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

GetMapGlyphs

$result = $client->getMapGlyphs([/* ... */]);
$promise = $client->getMapGlyphsAsync([/* ... */]);

Retrieves glyphs used to display labels on a map.

Parameter Syntax

$result = $client->getMapGlyphs([
    'FontStack' => '<string>', // REQUIRED
    'FontUnicodeRange' => '<string>', // REQUIRED
    'MapName' => '<string>', // REQUIRED
]);

Parameter Details

Members

FontStack

Required: Yes
Type: string

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
VectorHereExplore, VectorHereExploreTruck – Firo GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

FontUnicodeRange

Required: Yes
Type: string

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.

MapName

Required: Yes
Type: string

The map resource associated with the glyph ﬁle.

Result Syntax

[
    'Blob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ContentType' => '<string>',
]

Result Details

Members

Blob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The blob's content type.

ContentType

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

GetMapSprites

$result = $client->getMapSprites([/* ... */]);
$promise = $client->getMapSpritesAsync([/* ... */]);

Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.

Parameter Syntax

$result = $client->getMapSprites([
    'FileName' => '<string>', // REQUIRED
    'MapName' => '<string>', // REQUIRED
]);

Parameter Details

Members

FileName

Required: Yes
Type: string

The name of the sprite ﬁle. Use the following ﬁle 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 ﬁle names:

sprites.json
sprites@2x.json for high pixel density displays

MapName

Required: Yes
Type: string

The map resource associated with the sprite ﬁle.

Result Syntax

[
    'Blob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ContentType' => '<string>',
]

Result Details

Members

Blob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Contains the body of the sprite sheet or JSON offset ﬁle.

ContentType

Type: string

The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

GetMapStyleDescriptor

$result = $client->getMapStyleDescriptor([/* ... */]);
$promise = $client->getMapStyleDescriptorAsync([/* ... */]);

Retrieves the map style descriptor from a map resource.

The style descriptor contains speciﬁcations on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.

Parameter Syntax

$result = $client->getMapStyleDescriptor([
    'MapName' => '<string>', // REQUIRED
]);

Parameter Details

Members

MapName

Required: Yes
Type: string

The map resource to retrieve the style descriptor from.

Result Syntax

[
    'Blob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ContentType' => '<string>',
]

Result Details

Members

Blob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Contains the body of the style descriptor.

ContentType

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

GetMapTile

$result = $client->getMapTile([/* ... */]);
$promise = $client->getMapTileAsync([/* ... */]);

Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

Parameter Syntax

$result = $client->getMapTile([
    'MapName' => '<string>', // REQUIRED
    'X' => '<string>', // REQUIRED
    'Y' => '<string>', // REQUIRED
    'Z' => '<string>', // REQUIRED
]);

Parameter Details

Members

MapName

Required: Yes
Type: string

The map resource to retrieve the map tiles from.

X

Required: Yes
Type: string

The X axis value for the map tile.

Y

Required: Yes
Type: string

The Y axis value for the map tile.

Z

Required: Yes
Type: string

The zoom value for the map tile.

Result Syntax

[
    'Blob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'ContentType' => '<string>',
]

Result Details

Members

Blob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Contains Mapbox Vector Tile (MVT) data.

ContentType

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListDevicePositions

$result = $client->listDevicePositions([/* ... */]);
$promise = $client->listDevicePositionsAsync([/* ... */]);

A batch request to retrieve all device positions.

Parameter Syntax

$result = $client->listDevicePositions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

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

Default value: 100

NextToken

Type: string

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

Default value: null

TrackerName

Required: Yes
Type: string

The tracker resource containing the requested devices.

Result Syntax

[
    'Entries' => [
        [
            'Accuracy' => [
                'Horizontal' => <float>,
            ],
            'DeviceId' => '<string>',
            'Position' => [<float>, ...],
            'PositionProperties' => ['<string>', ...],
            'SampleTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entries

Required: Yes
Type: Array of ListDevicePositionsResponseEntry structures

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.

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListGeofenceCollections

$result = $client->listGeofenceCollections([/* ... */]);
$promise = $client->listGeofenceCollectionsAsync([/* ... */]);

Lists geofence collections in your AWS account.

Parameter Syntax

$result = $client->listGeofenceCollections([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

Default value: 100

NextToken

Type: string

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

Default value: null

Result Syntax

[
    'Entries' => [
        [
            'CollectionName' => '<string>',
            'CreateTime' => <DateTime>,
            'Description' => '<string>',
            'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
            'PricingPlanDataSource' => '<string>',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entries

Required: Yes
Type: Array of ListGeofenceCollectionsResponseEntry structures

Lists the geofence collections that exist in your AWS account.

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListGeofences

$result = $client->listGeofences([/* ... */]);
$promise = $client->listGeofencesAsync([/* ... */]);

Lists geofences stored in a given geofence collection.

Parameter Syntax

$result = $client->listGeofences([
    'CollectionName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

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

MaxResults

Type: int

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

Default value: 100

NextToken

Type: string

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

Default value: null

Result Syntax

[
    'Entries' => [
        [
            'CreateTime' => <DateTime>,
            'GeofenceId' => '<string>',
            'Geometry' => [
                'Polygon' => [
                    [
                        [<float>, ...],
                        // ...
                    ],
                    // ...
                ],
            ],
            'Status' => '<string>',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entries

Required: Yes
Type: Array of ListGeofenceResponseEntry structures

Contains a list of geofences stored in the geofence collection.

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListMaps

$result = $client->listMaps([/* ... */]);
$promise = $client->listMapsAsync([/* ... */]);

Lists map resources in your AWS account.

Parameter Syntax

$result = $client->listMaps([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

Default value: 100

NextToken

Type: string

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

Default value: null

Result Syntax

[
    'Entries' => [
        [
            'CreateTime' => <DateTime>,
            'DataSource' => '<string>',
            'Description' => '<string>',
            'MapName' => '<string>',
            'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entries

Required: Yes
Type: Array of ListMapsResponseEntry structures

Contains a list of maps in your AWS account

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListPlaceIndexes

$result = $client->listPlaceIndexes([/* ... */]);
$promise = $client->listPlaceIndexesAsync([/* ... */]);

Lists place index resources in your AWS account.

Parameter Syntax

$result = $client->listPlaceIndexes([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

Default value: 100

NextToken

Type: string

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

Default value: null

Result Syntax

[
    'Entries' => [
        [
            'CreateTime' => <DateTime>,
            'DataSource' => '<string>',
            'Description' => '<string>',
            'IndexName' => '<string>',
            'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entries

Required: Yes
Type: Array of ListPlaceIndexesResponseEntry structures

Lists the place index resources that exist in your AWS account

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListRouteCalculators

$result = $client->listRouteCalculators([/* ... */]);
$promise = $client->listRouteCalculatorsAsync([/* ... */]);

Lists route calculator resources in your AWS account.

Parameter Syntax

$result = $client->listRouteCalculators([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

Default Value: 100

NextToken

Type: string

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

Default Value: null

Result Syntax

[
    'Entries' => [
        [
            'CalculatorName' => '<string>',
            'CreateTime' => <DateTime>,
            'DataSource' => '<string>',
            'Description' => '<string>',
            'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entries

Required: Yes
Type: Array of ListRouteCalculatorsResponseEntry structures

Lists the route calculator resources that exist in your AWS account

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags that are applied to the specified Amazon Location resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

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

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListTrackerConsumers

$result = $client->listTrackerConsumers([/* ... */]);
$promise = $client->listTrackerConsumersAsync([/* ... */]);

Lists geofence collections currently associated to the given tracker resource.

Parameter Syntax

$result = $client->listTrackerConsumers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

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

Default value: 100

NextToken

Type: string

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

Default value: null

TrackerName

Required: Yes
Type: string

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

Result Syntax

[
    'ConsumerArns' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members

ConsumerArns

Required: Yes
Type: Array of strings

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

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

ListTrackers

$result = $client->listTrackers([/* ... */]);
$promise = $client->listTrackersAsync([/* ... */]);

Lists tracker resources in your AWS account.

Parameter Syntax

$result = $client->listTrackers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

Default value: 100

NextToken

Type: string

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

Default value: null

Result Syntax

[
    'Entries' => [
        [
            'CreateTime' => <DateTime>,
            'Description' => '<string>',
            'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
            'PricingPlanDataSource' => '<string>',
            'TrackerName' => '<string>',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Entries

Required: Yes
Type: Array of ListTrackersResponseEntry structures

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

NextToken

Type: string

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

PutGeofence

$result = $client->putGeofence([/* ... */]);
$promise = $client->putGeofenceAsync([/* ... */]);

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

Parameter Syntax

$result = $client->putGeofence([
    'CollectionName' => '<string>', // REQUIRED
    'GeofenceId' => '<string>', // REQUIRED
    'Geometry' => [ // REQUIRED
        'Polygon' => [
            [
                [<float>, ...],
                // ...
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

The geofence collection to store the geofence in.

GeofenceId

Required: Yes
Type: string

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

Geometry

Required: Yes
Type: GeofenceGeometry structure

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

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

Result Syntax

[
    'CreateTime' => <DateTime>,
    'GeofenceId' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

GeofenceId

Required: Yes
Type: string

The geofence identifier entered in the request.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
ConflictException:
The request was unsuccessful because of a conflict.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

SearchPlaceIndexForPosition

$result = $client->searchPlaceIndexForPosition([/* ... */]);
$promise = $client->searchPlaceIndexForPositionAsync([/* ... */]);

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

Parameter Syntax

$result = $client->searchPlaceIndexForPosition([
    'IndexName' => '<string>', // REQUIRED
    'Language' => '<string>',
    'MaxResults' => <integer>,
    'Position' => [<float>, ...], // REQUIRED
]);

Parameter Details

Members

IndexName

Required: Yes
Type: string

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

Language

Type: string

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.

MaxResults

Type: int

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

Default value: 50

Position

Required: Yes
Type: Array of doubles

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.

Result Syntax

[
    'Results' => [
        [
            'Distance' => <float>,
            'Place' => [
                'AddressNumber' => '<string>',
                'Country' => '<string>',
                'Geometry' => [
                    'Point' => [<float>, ...],
                ],
                'Interpolated' => true || false,
                'Label' => '<string>',
                'Municipality' => '<string>',
                'Neighborhood' => '<string>',
                'PostalCode' => '<string>',
                'Region' => '<string>',
                'Street' => '<string>',
                'SubRegion' => '<string>',
                'TimeZone' => [
                    'Name' => '<string>',
                    'Offset' => <integer>,
                ],
            ],
        ],
        // ...
    ],
    'Summary' => [
        'DataSource' => '<string>',
        'Language' => '<string>',
        'MaxResults' => <integer>,
        'Position' => [<float>, ...],
    ],
]

Result Details

Members

Results

Required: Yes
Type: Array of SearchForPositionResult structures

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

Summary

Required: Yes
Type: SearchPlaceIndexForPositionSummary structure

Contains a summary of the request. Echoes the input values for Position, Language, MaxResults, and the DataSource of the place index.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

SearchPlaceIndexForSuggestions

$result = $client->searchPlaceIndexForSuggestions([/* ... */]);
$promise = $client->searchPlaceIndexForSuggestionsAsync([/* ... */]);

Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.

Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.

You can search for suggested place names near a specified position by using BiasPosition, or filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using both BiasPosition and FilterBBox in the same command returns an error.

Parameter Syntax

$result = $client->searchPlaceIndexForSuggestions([
    'BiasPosition' => [<float>, ...],
    'FilterBBox' => [<float>, ...],
    'FilterCountries' => ['<string>', ...],
    'IndexName' => '<string>', // REQUIRED
    'Language' => '<string>',
    'MaxResults' => <integer>,
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

BiasPosition

Type: Array of doubles

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.

FilterBBox

Type: Array of doubles

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.

FilterCountries

Type: Array of strings

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.

IndexName

Required: Yes
Type: string

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

Language

Type: string

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.

MaxResults

Type: int

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

The default: 5

Text

Required: Yes
Type: string

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

Result Syntax

[
    'Results' => [
        [
            'Text' => '<string>',
        ],
        // ...
    ],
    'Summary' => [
        'BiasPosition' => [<float>, ...],
        'DataSource' => '<string>',
        'FilterBBox' => [<float>, ...],
        'FilterCountries' => ['<string>', ...],
        'Language' => '<string>',
        'MaxResults' => <integer>,
        'Text' => '<string>',
    ],
]

Result Details

Members

Results

Required: Yes
Type: Array of SearchForSuggestionsResult structures

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

Summary

Required: Yes
Type: SearchPlaceIndexForSuggestionsSummary structure

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.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

SearchPlaceIndexForText

$result = $client->searchPlaceIndexForText([/* ... */]);
$promise = $client->searchPlaceIndexForTextAsync([/* ... */]);

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.

You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.

Search results are returned in order of highest to lowest relevance.

Parameter Syntax

$result = $client->searchPlaceIndexForText([
    'BiasPosition' => [<float>, ...],
    'FilterBBox' => [<float>, ...],
    'FilterCountries' => ['<string>', ...],
    'IndexName' => '<string>', // REQUIRED
    'Language' => '<string>',
    'MaxResults' => <integer>,
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

BiasPosition

Type: Array of doubles

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.

FilterBBox

Type: Array of doubles

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

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

FilterCountries

Type: Array of strings

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.

IndexName

Required: Yes
Type: string

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

Language

Type: string

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

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.

MaxResults

Type: int

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

The default: 50

Text

Required: Yes
Type: string

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

Result Syntax

[
    'Results' => [
        [
            'Distance' => <float>,
            'Place' => [
                'AddressNumber' => '<string>',
                'Country' => '<string>',
                'Geometry' => [
                    'Point' => [<float>, ...],
                ],
                'Interpolated' => true || false,
                'Label' => '<string>',
                'Municipality' => '<string>',
                'Neighborhood' => '<string>',
                'PostalCode' => '<string>',
                'Region' => '<string>',
                'Street' => '<string>',
                'SubRegion' => '<string>',
                'TimeZone' => [
                    'Name' => '<string>',
                    'Offset' => <integer>,
                ],
            ],
            'Relevance' => <float>,
        ],
        // ...
    ],
    'Summary' => [
        'BiasPosition' => [<float>, ...],
        'DataSource' => '<string>',
        'FilterBBox' => [<float>, ...],
        'FilterCountries' => ['<string>', ...],
        'Language' => '<string>',
        'MaxResults' => <integer>,
        'ResultBBox' => [<float>, ...],
        'Text' => '<string>',
    ],
]

Result Details

Members

Results

Required: Yes
Type: Array of SearchForTextResult structures

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.

Summary

Required: Yes
Type: SearchPlaceIndexForTextSummary structure

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.

 <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p>

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

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

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified Amazon Location resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

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

TagKeys

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

UpdateGeofenceCollection

$result = $client->updateGeofenceCollection([/* ... */]);
$promise = $client->updateGeofenceCollectionAsync([/* ... */]);

Updates the specified properties of a given geofence collection.

Parameter Syntax

$result = $client->updateGeofenceCollection([
    'CollectionName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'PricingPlanDataSource' => '<string>',
]);

Parameter Details

Members

CollectionName

Required: Yes
Type: string

The name of the geofence collection to update.

Description

Type: string

Updates the description for the geofence collection.

PricingPlan

Type: string

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

PricingPlanDataSource

Type: string

This parameter is no longer used.

Result Syntax

[
    'CollectionArn' => '<string>',
    'CollectionName' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CollectionArn

Required: Yes
Type: string

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

CollectionName

Required: Yes
Type: string

The name of the updated geofence collection.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

UpdateMap

$result = $client->updateMap([/* ... */]);
$promise = $client->updateMapAsync([/* ... */]);

Updates the specified properties of a given map resource.

Parameter Syntax

$result = $client->updateMap([
    'Description' => '<string>',
    'MapName' => '<string>', // REQUIRED
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
]);

Parameter Details

Members

Description

Type: string

Updates the description for the map resource.

MapName

Required: Yes
Type: string

The name of the map resource to update.

PricingPlan

Type: string

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

Result Syntax

[
    'MapArn' => '<string>',
    'MapName' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

MapArn

Required: Yes
Type: string

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

MapName

Required: Yes
Type: string

The name of the updated map resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

UpdatePlaceIndex

$result = $client->updatePlaceIndex([/* ... */]);
$promise = $client->updatePlaceIndexAsync([/* ... */]);

Updates the specified properties of a given place index resource.

Parameter Syntax

$result = $client->updatePlaceIndex([
    'DataSourceConfiguration' => [
        'IntendedUse' => 'SingleUse|Storage',
    ],
    'Description' => '<string>',
    'IndexName' => '<string>', // REQUIRED
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
]);

Parameter Details

Members

DataSourceConfiguration

Type: DataSourceConfiguration structure

Updates the data storage option for the place index resource.

Description

Type: string

Updates the description for the place index resource.

IndexName

Required: Yes
Type: string

The name of the place index resource to update.

PricingPlan

Type: string

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

Result Syntax

[
    'IndexArn' => '<string>',
    'IndexName' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

IndexArn

Required: Yes
Type: string

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

IndexName

Required: Yes
Type: string

The name of the updated place index resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

UpdateRouteCalculator

$result = $client->updateRouteCalculator([/* ... */]);
$promise = $client->updateRouteCalculatorAsync([/* ... */]);

Updates the specified properties for a given route calculator resource.

Parameter Syntax

$result = $client->updateRouteCalculator([
    'CalculatorName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
]);

Parameter Details

Members

CalculatorName

Required: Yes
Type: string

The name of the route calculator resource to update.

Description

Type: string

Updates the description for the route calculator resource.

PricingPlan

Type: string

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

Result Syntax

[
    'CalculatorArn' => '<string>',
    'CalculatorName' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

CalculatorArn

Required: Yes
Type: string

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

CalculatorName

Required: Yes
Type: string

The name of the updated route calculator resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

UpdateTracker

$result = $client->updateTracker([/* ... */]);
$promise = $client->updateTrackerAsync([/* ... */]);

Updates the specified properties of a given tracker resource.

Parameter Syntax

$result = $client->updateTracker([
    'Description' => '<string>',
    'PositionFiltering' => 'TimeBased|DistanceBased|AccuracyBased',
    'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement',
    'PricingPlanDataSource' => '<string>',
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

Type: string

Updates the description for the tracker resource.

PositionFiltering

Type: string

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.

PricingPlan

Type: string

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

PricingPlanDataSource

Type: string

This parameter is no longer used.

TrackerName

Required: Yes
Type: string

The name of the tracker resource to update.

Result Syntax

[
    'TrackerArn' => '<string>',
    'TrackerName' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

Members

TrackerArn

Required: Yes
Type: string

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

TrackerName

Required: Yes
Type: string

The name of the updated tracker resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Errors

InternalServerException:
The request has failed to process because of an unknown server error, exception, or failure.
ResourceNotFoundException:
The resource that you've entered was not found in your AWS account.
AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
ValidationException:
The input failed to meet the constraints specified by the AWS service.
ThrottlingException:
The request was denied because of request throttling.

Shapes

AccessDeniedException

Description

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

Members

Message

Required: Yes
Type: string

BatchDeleteDevicePositionHistoryError

Description

Contains the tracker resource details.

Members

DeviceId

Required: Yes
Type: string

The ID of the device for this position.

Error

Required: Yes
Type: BatchItemError structure

Contains the batch request error details associated with the request.

BatchDeleteGeofenceError

Description

Contains error details for each geofence that failed to delete from the geofence collection.

Members

Error

Required: Yes
Type: BatchItemError structure

Contains details associated to the batch error.

GeofenceId

Required: Yes
Type: string

The geofence associated with the error message.

BatchEvaluateGeofencesError

Description

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

Members

DeviceId

Required: Yes
Type: string

The device associated with the position evaluation error.

Error

Required: Yes
Type: BatchItemError structure

Contains details associated to the batch error.

SampleTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

BatchGetDevicePositionError

Description

Contains error details for each device that didn't return a position.

Members

DeviceId

Required: Yes
Type: string

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

Error

Required: Yes
Type: BatchItemError structure

Contains details related to the error code.

BatchItemError

Description

Contains the batch request error details associated with the request.

Members

Code

Type: string

The error code associated with the batch request error.

Message

Type: string

A message with the reason for the batch request error.

BatchPutGeofenceError

Description

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

Members

Error

Required: Yes
Type: BatchItemError structure

Contains details associated to the batch error.

GeofenceId

Required: Yes
Type: string

The geofence associated with the error message.

BatchPutGeofenceRequestEntry

Description

Contains geofence geometry details.

Members

GeofenceId

Required: Yes
Type: string

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

Geometry

Required: Yes
Type: GeofenceGeometry structure

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

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

BatchPutGeofenceSuccess

Description

Contains a summary of each geofence that was successfully stored in a given geofence collection.

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

GeofenceId

Required: Yes
Type: string

The geofence successfully stored in a geofence collection.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

BatchUpdateDevicePositionError

Description

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

Members

DeviceId

Required: Yes
Type: string

The device associated with the failed location update.

Error

Required: Yes
Type: BatchItemError structure

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

SampleTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

CalculateRouteCarModeOptions

Description

Contains details about additional route preferences for requests that specify TravelMode as Car.

Members

AvoidFerries

Type: boolean

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

AvoidTolls

Type: boolean

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

CalculateRouteMatrixSummary

Description

A summary of the calculated route matrix.

Members

DataSource

Required: Yes
Type: string

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

Esri
Here

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

DistanceUnit

Required: Yes
Type: string

The unit of measurement for route distances.

ErrorCount

Required: Yes
Type: int

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

RouteCount

Required: Yes
Type: int

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

CalculateRouteSummary

Description

A summary of the calculated route.

Members

DataSource

Required: Yes
Type: string

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.

Distance

Required: Yes
Type: double

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.

DistanceUnit

Required: Yes
Type: string

The unit of measurement for route distances.

DurationSeconds

Required: Yes
Type: double

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

RouteBBox

Required: Yes
Type: Array of doubles

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.

CalculateRouteTruckModeOptions

Description

Contains details about additional route preferences for requests that specify TravelMode as Truck.

Members

AvoidFerries

Type: boolean

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

AvoidTolls

Type: boolean

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

Dimensions

Type: TruckDimensions structure

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.

Weight

Type: TruckWeight structure

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.

ConflictException

Description

The request was unsuccessful because of a conflict.

Members

Message

Required: Yes
Type: string

DataSourceConfiguration

Description

Specifies the data storage option chosen for requesting Places.

When using Amazon Location Places:

If using HERE Technologies as a data provider, you can't store results for locations in Japan by setting IntendedUse to Storage. parameter.
Under the MobileAssetTracking or MobilAssetManagement pricing plan, you can't store results from your place index resources by setting IntendedUse to Storage. This returns a validation exception error.

For more information, see the AWS Service Terms for Amazon Location Service.

Members

IntendedUse

Type: string

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

Valid values include:

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

Default value: SingleUse

DevicePosition

Description

Contains the device position details.

Members

Accuracy

Type: PositionalAccuracy structure

The accuracy of the device position.

DeviceId

Type: string

The device whose position you retrieved.

Position

Required: Yes
Type: Array of doubles

The last known device position.

PositionProperties

Type: Associative array of custom strings keys (PropertyMapKeyString) to strings

The properties associated with the position.

ReceivedTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

SampleTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DevicePositionUpdate

Description

Contains the position update details for a device.

Members

Accuracy

Type: PositionalAccuracy structure

The accuracy of the device position.

DeviceId

Required: Yes
Type: string

The device associated to the position update.

Position

Required: Yes
Type: Array of doubles

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

PositionProperties

Type: Associative array of custom strings keys (PropertyMapKeyString) to strings

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"

SampleTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

GeofenceGeometry

Description

Contains the geofence geometry details.

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.

Members

Polygon

Type: Array of lists

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.

InternalServerException

Description

The request has failed to process because of an unknown server error, exception, or failure.

Members

Message

Required: Yes
Type: string

Leg

Description

Contains the calculated route's details for each path between a pair of positions. 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.

Members

Distance

Required: Yes
Type: double

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.

DurationSeconds

Required: Yes
Type: double

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.

EndPosition

Required: Yes
Type: Array of doubles

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.

Geometry

Type: LegGeometry structure

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

StartPosition

Required: Yes
Type: Array of doubles

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.

Steps

Required: Yes
Type: Array of Step structures

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.

LegGeometry

Description

Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.

Members

LineString

Type: Array of floatss

An ordered list of positions used to plot a route on a map.

The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.

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

ListDevicePositionsResponseEntry

Description

Contains the tracker resource details.

Members

Accuracy

Type: PositionalAccuracy structure

The accuracy of the device position.

DeviceId

Required: Yes
Type: string

The ID of the device for this position.

Position

Required: Yes
Type: Array of doubles

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

PositionProperties

Type: Associative array of custom strings keys (PropertyMapKeyString) to strings

The properties associated with the position.

SampleTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ListGeofenceCollectionsResponseEntry

Description

Contains the geofence collection details.

Members

CollectionName

Required: Yes
Type: string

The name of the geofence collection.

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Description

Required: Yes
Type: string

The description for the geofence collection

PricingPlan

Type: string

No longer used. Always returns RequestBasedUsage.

PricingPlanDataSource

Type: string

No longer used. Always returns an empty string.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ListGeofenceResponseEntry

Description

Contains a list of geofences stored in a given geofence collection.

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

GeofenceId

Required: Yes
Type: string

The geofence identifier.

Geometry

Required: Yes
Type: GeofenceGeometry structure

Contains the geofence geometry details describing a polygon.

Status

Required: Yes
Type: string

Identifies the state of the geofence. A geofence will hold one of the following states:

ACTIVE — The geofence has been indexed by the system.
PENDING — The geofence is being processed by the system.
FAILED — The geofence failed to be indexed by the system.
DELETED — The geofence has been deleted from the system index.
DELETING — The geofence is being deleted from the system index.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ListMapsResponseEntry

Description

Contains details of an existing map resource in your AWS account.

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DataSource

Required: Yes
Type: string

Specifies the data provider for the associated map tiles.

Description

Required: Yes
Type: string

The description for the map resource.

MapName

Required: Yes
Type: string

The name of the associated map resource.

PricingPlan

Type: string

No longer used. Always returns RequestBasedUsage.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ListPlaceIndexesResponseEntry

Description

A place index resource listed in your AWS account.

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DataSource

Required: Yes
Type: string

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.

Description

Required: Yes
Type: string

The optional description for the place index resource.

IndexName

Required: Yes
Type: string

The name of the place index resource.

PricingPlan

Type: string

No longer used. Always returns RequestBasedUsage.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ListRouteCalculatorsResponseEntry

Description

A route calculator resource listed in your AWS account.

Members

CalculatorName

Required: Yes
Type: string

The name of the route calculator resource.

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

DataSource

Required: Yes
Type: string

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.

Description

Required: Yes
Type: string

The optional description of the route calculator resource.

PricingPlan

Type: string

Always returns RequestBasedUsage.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ListTrackersResponseEntry

Description

Contains the tracker resource details.

Members

CreateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Description

Required: Yes
Type: string

The description for the tracker resource.

PricingPlan

Type: string

Always returns RequestBasedUsage.

PricingPlanDataSource

Type: string

No longer used. Always returns an empty string.

TrackerName

Required: Yes
Type: string

The name of the tracker resource.

UpdateTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

MapConfiguration

Description

Specifies the map tile style selected from an available provider.

Members

Style

Required: Yes
Type: string

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

Place

Description

Contains details about addresses or points of interest that match the search criteria.

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

Members

AddressNumber

Type: string

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

Country

Type: string

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

Geometry

Required: Yes
Type: PlaceGeometry structure

Places uses a point geometry to specify a location or a Place.

Interpolated

Type: boolean

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.

Label

Type: string

The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.

Municipality

Type: string

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

Neighborhood

Type: string

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

PostalCode

Type: string

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

Region

Type: string

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

Street

Type: string

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

SubRegion

Type: string

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

TimeZone

Type: TimeZone structure

The time zone in which the Place is located. Returned only when using Here as the selected partner.

PlaceGeometry

Description

Places uses a point geometry to specify a location or a Place.

Members

Point

Type: Array of doubles

A single point geometry specifies a location for a Place using WGS 84 coordinates:

x — Specifies the x coordinate or longitude.
y — Specifies the y coordinate or latitude.

PositionalAccuracy

Description

Defines the level of certainty of the position.

Members

Horizontal

Required: Yes
Type: double

Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.

ResourceNotFoundException

Description

The resource that you've entered was not found in your AWS account.

Members

Message

Required: Yes
Type: string

RouteMatrixEntry

Description

The result for the calculated route of one DeparturePosition DestinationPosition pair.

Members

Distance

Type: double

The total distance of travel for the route.

DurationSeconds

Type: double

The expected duration of travel for the route.

Error

Type: RouteMatrixEntryError structure

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

RouteMatrixEntryError

Description

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

The error code can be one of the following:

RouteNotFound - Unable to find a valid route with the given parameters.

RouteTooLong - Route calculation went beyond the maximum size of a route and was terminated before completion.

PositionsNotFound - One or more of the input positions were not found on the route network.

DestinationPositionNotFound - The destination position was not found on the route network.

DeparturePositionNotFound - The departure position was not found on the route network.

OtherValidationError - The given inputs were not valid or a route was not found. More information is given in the error Message

Members

Code

Required: Yes
Type: string

The type of error which occurred for the route calculation.

Message

Type: string

A message about the error that occurred for the route calculation.

SearchForPositionResult

Description

Contains a search result from a position search query that is run on a place index resource.

Members

Distance

Required: Yes
Type: double

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

Required: Yes
Type: Place structure

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

SearchForSuggestionsResult

Description

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

Members

Text

Required: Yes
Type: string

The text of the place suggestion, typically formatted as an address string.

SearchForTextResult

Description

Contains a search result from a text search query that is run on a place index resource.

Members

Distance

Type: double

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

Required: Yes
Type: Place structure

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

Relevance

Type: double

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.

SearchPlaceIndexForPositionSummary

Description

A summary of the request sent by using SearchPlaceIndexForPosition.

Members

DataSource

Required: Yes
Type: string

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.

Language

Type: string

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.

MaxResults

Type: int

Contains the optional result count limit that is specified in the request.

Default value: 50

Position

Required: Yes
Type: Array of doubles

The position specified in the request.

SearchPlaceIndexForSuggestionsSummary

Description

A summary of the request sent by using SearchPlaceIndexForSuggestions.

Members

BiasPosition

Type: Array of doubles

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.

DataSource

Required: Yes
Type: string

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.

FilterBBox

Type: Array of doubles

Contains the coordinates for the optional bounding box specified in the request.

FilterCountries

Type: Array of strings

Contains the optional country filter specified in the request.

Language

Type: string

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.

MaxResults

Type: int

Contains the optional result count limit specified in the request.

Text

Required: Yes
Type: string

The free-form partial text input specified in the request.

SearchPlaceIndexForTextSummary

Description

A summary of the request sent by using SearchPlaceIndexForText.

Members

BiasPosition

Type: Array of doubles

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.

DataSource

Required: Yes
Type: string

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.

FilterBBox

Type: Array of doubles

Contains the coordinates for the optional bounding box specified in the request.

FilterCountries

Type: Array of strings

Contains the optional country filter specified in the request.

Language

Type: string

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.

MaxResults

Type: int

Contains the optional result count limit specified in the request.

ResultBBox

Type: Array of doubles

The bounding box that fully contains all search results.

If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

Text

Required: Yes
Type: string

The search text specified in the request.

ServiceQuotaExceededException

Description

The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.

Members

Message

Required: Yes
Type: string

A message with the reason for the service quota exceeded exception error.

Step

Description

Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.

Members

Distance

Required: Yes
Type: double

The travel distance between the step's StartPosition and EndPosition.

DurationSeconds

Required: Yes
Type: double

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.

EndPosition

Required: Yes
Type: Array of doubles

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.

GeometryOffset

Type: int

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.

StartPosition

Required: Yes
Type: Array of doubles

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.

ThrottlingException

Description

The request was denied because of request throttling.

Members

Message

Required: Yes
Type: string

TimeZone

Description

Information about a time zone. Includes the name of the time zone and the offset from UTC in seconds.

Members

Name

Required: Yes
Type: string

The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles.

Offset

Type: int

The time zone's offset, in seconds, from UTC.

TruckDimensions

Description

Contains details about the truck dimensions in the unit of measurement that you specify. Used to filter out roads that can't support or allow the specified dimensions for requests that specify TravelMode as Truck.

Members

Height

Type: double

The height of the truck.

For example, 4.5.

Length

Type: double

The length of the truck.

For example, 15.5.

Unit

Type: string

Specifies the unit of measurement for the truck dimensions.

Default Value: Meters

Width

Type: double

The width of the truck.

For example, 4.5.

TruckWeight

Description

Contains details about the truck's weight specifications. Used to avoid roads that can't support or allow the total weight for requests that specify TravelMode as Truck.

Members

Total

Type: double

The total weight of the truck.

For example, 3500.

Unit

Type: string

The unit of measurement to use for the truck weight.

Default Value: Kilograms

ValidationException

Description

The input failed to meet the constraints specified by the AWS service.

Members

FieldList

Required: Yes
Type: Array of ValidationExceptionField structures

The field where the invalid entry was detected.

Message

Required: Yes
Type: string

Reason

Required: Yes
Type: string

A message with the reason for the validation exception error.

ValidationExceptionField

Description

The input failed to meet the constraints specified by the AWS service in a specified field.

Members

Message

Required: Yes
Type: string

A message with the reason for the validation exception error.

Name

Required: Yes
Type: string

The field name where the invalid entry was detected.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Location Service 2020-11-19

Operation Summary

Paginators

Operations

AssociateTrackerConsumer

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

BatchDeleteDevicePositionHistory

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchDeleteGeofence

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchEvaluateGeofences

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchGetDevicePosition

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchPutGeofence

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchUpdateDevicePosition

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CalculateRoute

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CalculateRouteMatrix

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members