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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

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

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
            'GeofenceProperties' => ['<string>', ...],
            'Geometry' => [ // REQUIRED
                'Circle' => [
                    'Center' => [<float>, ...], // REQUIRED
                    'Radius' => <float>, // REQUIRED
                ],
                'Geobuf' => <string || resource || Psr\Http\Message\StreamInterface>,
                'Polygon' => [
                    [
                        [<float>, ...],
                        // ...
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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 (up to 10 devices per batch). Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.

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

Result Syntax

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

Result Details

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.

  If you specify walking for the travel mode and your data provider is Esri, the start and destination must be within 40km.

Parameter Syntax

$result = $client->calculateRoute([
    'ArrivalTime' => <integer || string || DateTime>,
    '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,
    'Key' => '<string>',
    'OptimizeFor' => 'FastestRoute|ShortestRoute',
    'TravelMode' => 'Car|Truck|Walking|Bicycle|Motorcycle',
    '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

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

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.

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',
    'Key' => '<string>',
    'TravelMode' => 'Car|Truck|Walking|Bicycle|Motorcycle',
    '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

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

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

Result Syntax

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

Result Details

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.

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.

CreateKey

$result = $client->createKey([/* ... */]);
$promise = $client->createKeyAsync([/* ... */]);

Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.

Parameter Syntax

$result = $client->createKey([
    'Description' => '<string>',
    'ExpireTime' => <integer || string || DateTime>,
    'KeyName' => '<string>', // REQUIRED
    'NoExpiry' => true || false,
    'Restrictions' => [ // REQUIRED
        'AllowActions' => ['<string>', ...], // REQUIRED
        'AllowReferers' => ['<string>', ...],
        'AllowResources' => ['<string>', ...], // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'CreateTime' => <DateTime>,
    'Key' => '<string>',
    'KeyArn' => '<string>',
    'KeyName' => '<string>',
]

Result Details

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.

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.

CreateMap

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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.

CreatePlaceIndex

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

Creates a place index resource in your Amazon Web Services 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

Result Syntax

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

Result Details

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.

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.

CreateRouteCalculator

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

Creates a route calculator resource in your Amazon Web Services 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

Result Syntax

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

Result Details

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.

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.

CreateTracker

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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.

DeleteGeofenceCollection

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

Deletes a geofence collection from your Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

DeleteKey

$result = $client->deleteKey([/* ... */]);
$promise = $client->deleteKeyAsync([/* ... */]);

Deletes the specified API key. The API key must have been deactivated more than 90 days previously.

Parameter Syntax

$result = $client->deleteKey([
    'ForceDelete' => true || false,
    'KeyName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

DescribeKey

$result = $client->describeKey([/* ... */]);
$promise = $client->describeKeyAsync([/* ... */]);

Retrieves the API key resource details.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreateTime' => <DateTime>,
    'Description' => '<string>',
    'ExpireTime' => <DateTime>,
    'Key' => '<string>',
    'KeyArn' => '<string>',
    'KeyName' => '<string>',
    'Restrictions' => [
        'AllowActions' => ['<string>', ...],
        'AllowReferers' => ['<string>', ...],
        'AllowResources' => ['<string>', ...],
    ],
    'Tags' => ['<string>', ...],
    'UpdateTime' => <DateTime>,
]

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

ForecastGeofenceEvents

$result = $client->forecastGeofenceEvents([/* ... */]);
$promise = $client->forecastGeofenceEventsAsync([/* ... */]);

Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts three states for which a device can be in relative to a geofence:

ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE: If a device is inside of a geofence, and the device is not moving.

Parameter Syntax

$result = $client->forecastGeofenceEvents([
    'CollectionName' => '<string>', // REQUIRED
    'DeviceState' => [ // REQUIRED
        'Position' => [<float>, ...], // REQUIRED
        'Speed' => <float>,
    ],
    'DistanceUnit' => 'Kilometers|Miles',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SpeedUnit' => 'KilometersPerHour|MilesPerHour',
    'TimeHorizonMinutes' => <float>,
]);

Parameter Details

Result Syntax

[
    'DistanceUnit' => 'Kilometers|Miles',
    'ForecastedEvents' => [
        [
            'EventId' => '<string>',
            'EventType' => 'ENTER|EXIT|IDLE',
            'ForecastedBreachTime' => <DateTime>,
            'GeofenceId' => '<string>',
            'GeofenceProperties' => ['<string>', ...],
            'IsDeviceInGeofence' => true || false,
            'NearestDistance' => <float>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'SpeedUnit' => 'KilometersPerHour|MilesPerHour',
]

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

[
    'CreateTime' => <DateTime>,
    'GeofenceId' => '<string>',
    'GeofenceProperties' => ['<string>', ...],
    'Geometry' => [
        'Circle' => [
            'Center' => [<float>, ...],
            'Radius' => <float>,
        ],
        'Geobuf' => <string || resource || Psr\Http\Message\StreamInterface>,
        'Polygon' => [
            [
                [<float>, ...],
                // ...
            ],
            // ...
        ],
    ],
    'Status' => '<string>',
    'UpdateTime' => <DateTime>,
]

Result Details

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
    'Key' => '<string>',
    'MapName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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
    'Key' => '<string>',
    'MapName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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 specifications 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([
    'Key' => '<string>',
    'MapName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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([
    'Key' => '<string>',
    'MapName' => '<string>', // REQUIRED
    'X' => '<string>', // REQUIRED
    'Y' => '<string>', // REQUIRED
    'Z' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.

GetPlace

$result = $client->getPlace([/* ... */]);
$promise = $client->getPlaceAsync([/* ... */]);

Finds a place by its unique ID. A PlaceId is returned by other search operations.

Parameter Syntax

$result = $client->getPlace([
    'IndexName' => '<string>', // REQUIRED
    'Key' => '<string>',
    'Language' => '<string>',
    'PlaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Place' => [
        'AddressNumber' => '<string>',
        'Categories' => ['<string>', ...],
        'Country' => '<string>',
        'Geometry' => [
            'Point' => [<float>, ...],
        ],
        'Interpolated' => true || false,
        'Label' => '<string>',
        'Municipality' => '<string>',
        'Neighborhood' => '<string>',
        'PostalCode' => '<string>',
        'Region' => '<string>',
        'Street' => '<string>',
        'SubMunicipality' => '<string>',
        'SubRegion' => '<string>',
        'SupplementalCategories' => ['<string>', ...],
        'TimeZone' => [
            'Name' => '<string>',
            'Offset' => <integer>,
        ],
        'UnitNumber' => '<string>',
        'UnitType' => '<string>',
    ],
]

Result Details

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([
    'FilterGeometry' => [
        'Polygon' => [
            [
                [<float>, ...],
                // ...
            ],
            // ...
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TrackerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[
    'Entries' => [
        [
            'CreateTime' => <DateTime>,
            'GeofenceId' => '<string>',
            'GeofenceProperties' => ['<string>', ...],
            'Geometry' => [
                'Circle' => [
                    'Center' => [<float>, ...],
                    'Radius' => <float>,
                ],
                'Geobuf' => <string || resource || Psr\Http\Message\StreamInterface>,
                'Polygon' => [
                    [
                        [<float>, ...],
                        // ...
                    ],
                    // ...
                ],
            ],
            'Status' => '<string>',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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.

ListKeys

$result = $client->listKeys([/* ... */]);
$promise = $client->listKeysAsync([/* ... */]);

Lists API key resources in your Amazon Web Services account.

Parameter Syntax

$result = $client->listKeys([
    'Filter' => [
        'KeyStatus' => 'Active|Expired',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Entries' => [
        [
            'CreateTime' => <DateTime>,
            'Description' => '<string>',
            'ExpireTime' => <DateTime>,
            'KeyName' => '<string>',
            'Restrictions' => [
                'AllowActions' => ['<string>', ...],
                'AllowReferers' => ['<string>', ...],
                'AllowResources' => ['<string>', ...],
            ],
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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.

ListMaps

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

Lists map resources in your Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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
    'GeofenceProperties' => ['<string>', ...],
    'Geometry' => [ // REQUIRED
        'Circle' => [
            'Center' => [<float>, ...], // REQUIRED
            'Radius' => <float>, // REQUIRED
        ],
        'Geobuf' => <string || resource || Psr\Http\Message\StreamInterface>,
        'Polygon' => [
            [
                [<float>, ...],
                // ...
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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
    'Key' => '<string>',
    'Language' => '<string>',
    'MaxResults' => <integer>,
    'Position' => [<float>, ...], // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details