Amazon Location Service 2020-11-19
- 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.
- BatchDeleteGeofence ( array $params = [] )
Deletes a batch of geofences from a geofence collection.
- BatchEvaluateGeofences ( array $params = [] )
Used in geofence monitoring.
- BatchGetDevicePosition ( array $params = [] )
A batch request to retrieve device positions.
- BatchPutGeofence ( array $params = [] )
A batch request for storing geofences into a given geofence collection.
- BatchUpdateDevicePosition ( array $params = [] )
Uploads a position update for one or more devices to a tracker resource.
- 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, which supports Places functions with geospatial data sourced from your chosen data provider.
- 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.
- 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.
- DescribeTracker ( array $params = [] )
Retrieves the tracker resource details.
- DisassociateTrackerConsumer ( array $params = [] )
Removes the association bewteen a tracker resource and a geofence collection.
- GetDevicePosition ( array $params = [] )
Retrieves the latest device position.
- 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.
- 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.
- 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 to 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.
- 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.
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:
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.
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:partition:service:region:account-id:resource-type:resource-id
- TrackerName
-
- Required: Yes
- Type: string
The name of the tracker resource to be associated with a geofence collection.
Result Syntax
[]
Result Details
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was unsuccessful due to a conflict.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
BatchDeleteGeofence
$result = $client->batchDeleteGeofence
([/* ... */]); $promise = $client->batchDeleteGeofenceAsync
([/* ... */]);
Deletes a batch of geofences from a geofence collection.
This action deletes the resource permanently. You can't undo this action.
Parameter Syntax
$result = $client->batchDeleteGeofence([ 'CollectionName' => '<string>', // REQUIRED 'GeofenceIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
BatchEvaluateGeofences
$result = $client->batchEvaluateGeofences
([/* ... */]); $promise = $client->batchEvaluateGeofencesAsync
([/* ... */]);
Used in geofence monitoring. Evaluates device positions against the position of geofences in a given geofence collection.
Parameter Syntax
$result = $client->batchEvaluateGeofences([ 'CollectionName' => '<string>', // REQUIRED 'DevicePositionUpdates' => [ // REQUIRED [ 'DeviceId' => '<string>', // REQUIRED 'Position' => [<float>, ...], // REQUIRED '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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
BatchGetDevicePosition
$result = $client->batchGetDevicePosition
([/* ... */]); $promise = $client->batchGetDevicePositionAsync
([/* ... */]);
A batch request to retrieve device positions.
The response will return the device positions from the last 24 hours.
Parameter Syntax
$result = $client->batchGetDevicePosition([ 'DeviceIds' => ['<string>', ...], // REQUIRED 'TrackerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'DevicePositions' => [ [ 'DeviceId' => '<string>', 'Position' => [<float>, ...], '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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
BatchPutGeofence
$result = $client->batchPutGeofence
([/* ... */]); $promise = $client->batchPutGeofenceAsync
([/* ... */]);
A batch request for storing geofences into a given geofence collection.
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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
BatchUpdateDevicePosition
$result = $client->batchUpdateDevicePosition
([/* ... */]); $promise = $client->batchUpdateDevicePositionAsync
([/* ... */]);
Uploads a position update for one or more devices to a tracker resource. The data is used for API queries requesting the device position and position history.
Limitation — Location data is sampled at a fixed rate of 1 position per 30 second interval, and retained for 1 year before it is deleted.
Parameter Syntax
$result = $client->batchUpdateDevicePosition([ 'TrackerName' => '<string>', // REQUIRED 'Updates' => [ // REQUIRED [ 'DeviceId' => '<string>', // REQUIRED 'Position' => [<float>, ...], // REQUIRED '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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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>', 'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement', // REQUIRED ]);
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 (-), 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.
- PricingPlan
-
- Required: Yes
- Type: string
Specifies the pricing plan for your geofence collection. There's three pricing plan options:
-
RequestBasedUsage
— Selects the "Request-Based Usage" pricing plan. -
MobileAssetTracking
— Selects the "Mobile Asset Tracking" pricing plan. -
MobileAssetManagement
— Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
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.
- 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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The request was unsuccessful due to a conflict.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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.
By using Maps, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using. For more information, see the AWS Service Terms for Amazon Location Service.
Parameter Syntax
$result = $client->createMap([ 'Configuration' => [ // REQUIRED 'Style' => '<string>', // REQUIRED ], 'Description' => '<string>', 'MapName' => '<string>', // REQUIRED 'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement', // REQUIRED ]);
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 (-), and underscores (_).
-
Must be a unique map resource name.
-
No spaces allowed. For example,
ExampleMap
.
- PricingPlan
-
- Required: Yes
- Type: string
Specifies the pricing plan for your map resource. There's three pricing plan options:
-
RequestBasedUsage
— Selects the "Request-Based Usage" pricing plan. -
MobileAssetTracking
— Selects the "Mobile Asset Tracking" pricing plan. -
MobileAssetManagement
— Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
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 when you need to specify a resource across all AWS.
-
Format example:
arn:partition:service:region:account-id:resource-type:resource-id
- MapName
-
- Required: Yes
- Type: string
The name of the map resource.
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The request was unsuccessful due to a conflict.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
CreatePlaceIndex
$result = $client->createPlaceIndex
([/* ... */]); $promise = $client->createPlaceIndexAsync
([/* ... */]);
Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
Parameter Syntax
$result = $client->createPlaceIndex([ 'DataSource' => '<string>', // REQUIRED 'DataSourceConfiguration' => [ 'IntendedUse' => 'SingleUse|Storage', ], 'Description' => '<string>', 'IndexName' => '<string>', // REQUIRED 'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement', // REQUIRED ]);
Parameter Details
Members
- DataSource
-
- Required: Yes
- Type: string
Specifies the data provider of geospatial data.
- DataSourceConfiguration
-
- Type: DataSourceConfiguration structure
Specifies the data storage option for 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 (-) and underscores (_) ).
-
Must be a unique Place index resource name.
-
No spaces allowed. For example,
ExamplePlaceIndex
.
- PricingPlan
-
- Required: Yes
- Type: string
Specifies the pricing plan for your Place index resource. There's three pricing plan options:
-
RequestBasedUsage
— Selects the "Request-Based Usage" pricing plan. -
MobileAssetTracking
— Selects the "Mobile Asset Tracking" pricing plan. -
MobileAssetManagement
— Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
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 when you need to specify a resource across all AWS.
- IndexName
-
- Required: Yes
- Type: string
The name for the Place index resource.
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The request was unsuccessful due to a conflict.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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>', 'PricingPlan' => 'RequestBasedUsage|MobileAssetTracking|MobileAssetManagement', // REQUIRED 'TrackerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Description
-
- Type: string
An optional description for the tracker resource.
- PricingPlan
-
- Required: Yes
- Type: string
Specifies the pricing plan for your tracker resource. There's three pricing plan options:
-
RequestBasedUsage
— Selects the "Request-Based Usage" pricing plan. -
MobileAssetTracking
— Selects the "Mobile Asset Tracking" pricing plan. -
MobileAssetManagement
— Selects the "Mobile Asset Management" pricing plan.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.
- TrackerName
-
- Required: Yes
- Type: string
The name for the tracker resource.
Requirements:
-
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-) 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.
- TrackerName
-
- Required: Yes
- Type: string
The name of the tracker resource.
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The request was unsuccessful due to a conflict.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
DeleteGeofenceCollection
$result = $client->deleteGeofenceCollection
([/* ... */]); $promise = $client->deleteGeofenceCollectionAsync
([/* ... */]);
Deletes a geofence collection from your AWS account.
This action deletes the resource permanently. You can't undo this action. 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
Result Syntax
[]
Result Details
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
DeleteMap
$result = $client->deleteMap
([/* ... */]); $promise = $client->deleteMapAsync
([/* ... */]);
Deletes a map resource from your AWS account.
This action deletes the resource permanently. You cannot undo this action. If the map is being used in an application, the map may not render.
Parameter Syntax
$result = $client->deleteMap([ 'MapName' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
DeletePlaceIndex
$result = $client->deletePlaceIndex
([/* ... */]); $promise = $client->deletePlaceIndexAsync
([/* ... */]);
Deletes a Place index resource from your AWS account.
This action deletes the resource permanently. You cannot undo this action.
Parameter Syntax
$result = $client->deletePlaceIndex([ 'IndexName' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
DeleteTracker
$result = $client->deleteTracker
([/* ... */]); $promise = $client->deleteTrackerAsync
([/* ... */]);
Deletes a tracker resource from your AWS account.
This action deletes the resource permanently. You can't undo this action. If the tracker resource is in use, you may encounter an error. Make sure that the target resource is not a dependency for your applications.
Parameter Syntax
$result = $client->deleteTracker([ 'TrackerName' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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>', '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.
- 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.
- 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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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' => [ 'Style' => '<string>', ], 'CreateTime' => <DateTime>, 'DataSource' => '<string>', 'Description' => '<string>', 'MapArn' => '<string>', 'MapName' => '<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 when you need to specify a resource across all AWS.
- MapName
-
- Required: Yes
- Type: string
The map style selected from an available provider.
- 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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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>', '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.
- 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 when you need to specify a resource across all AWS.
- IndexName
-
- Required: Yes
- Type: string
The name of the Place index resource being described.
- 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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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>', '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.
- 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.
- 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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
DisassociateTrackerConsumer
$result = $client->disassociateTrackerConsumer
([/* ... */]); $promise = $client->disassociateTrackerConsumerAsync
([/* ... */]);
Removes the association bewteen 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:partition:service:region:account-id:resource-type:resource-id
- TrackerName
-
- Required: Yes
- Type: string
The name of the tracker resource to be dissociated from the consumer.
Result Syntax
[]
Result Details
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
GetDevicePosition
$result = $client->getDevicePosition
([/* ... */]); $promise = $client->getDevicePositionAsync
([/* ... */]);
Retrieves the latest device position.
Limitation — Device positions are deleted after one year.
Parameter Syntax
$result = $client->getDevicePosition([ 'DeviceId' => '<string>', // REQUIRED 'TrackerName' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'DeviceId' => '<string>', 'Position' => [<float>, ...], 'ReceivedTime' => <DateTime>, 'SampleTime' => <DateTime>, ]
Result Details
Members
- DeviceId
-
- Type: string
The device whose position you retrieved.
- Position
-
- Required: Yes
- Type: Array of doubles
The last known device position.
- ReceivedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the tracker resource recieved the 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 for when the position was detected and sampled in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
.
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
GetDevicePositionHistory
$result = $client->getDevicePositionHistory
([/* ... */]); $promise = $client->getDevicePositionHistoryAsync
([/* ... */]);
Retrieves the device position history from a tracker resource within a specified range of time.
Limitation — Device positions are deleted after one year.
Parameter Syntax
$result = $client->getDevicePositionHistory([ 'DeviceId' => '<string>', // REQUIRED 'EndTimeExclusive' => <integer || string || DateTime>, '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
.-
The given time for
EndTimeExclusive
must be after the time forStartTimeInclusive
.
- 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
.-
The given time for
EndTimeExclusive
must be after the time forStartTimeInclusive
.
- TrackerName
-
- Required: Yes
- Type: string
The tracker resource receiving the request for the device position history.
Result Syntax
[ 'DevicePositions' => [ [ 'DeviceId' => '<string>', 'Position' => [<float>, ...], '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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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
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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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, Arial Unicode
. - 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
to00FF
. Must be aligned to multiples of 256. - MapName
-
- Required: Yes
- Type: string
The map resource associated with the glyph file.
Result Syntax
[ 'Blob' => <string || resource || Psr\Http\Message\StreamInterface>, 'ContentType' => '<string>', ]
Result Details
Members
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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 file. Use the following file names for the sprite sheet:
-
sprites.png
-
sprites@2x.png
for high pixel density displays
For the JSON document contain image offsets. Use the following file names:
-
sprites.json
-
sprites@2x.json
for high pixel density displays
- MapName
-
- Required: Yes
- Type: string
The map resource associated with the sprite file.
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 file.
- 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 isapplication/json
.
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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([ 'MapName' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[ 'Blob' => <string || resource || Psr\Http\Message\StreamInterface>, 'ContentType' => '<string>', ]
Result Details
Members
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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 are 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
Result Syntax
[ 'Blob' => <string || resource || Psr\Http\Message\StreamInterface>, 'ContentType' => '<string>', ]
Result Details
Members
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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
Result Syntax
[ 'Entries' => [ [ 'CollectionName' => '<string>', 'CreateTime' => <DateTime>, 'Description' => '<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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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 'NextToken' => '<string>', ]);
Parameter Details
Members
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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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
Result Syntax
[ 'Entries' => [ [ 'CreateTime' => <DateTime>, 'DataSource' => '<string>', 'Description' => '<string>', 'MapName' => '<string>', '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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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>', '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 there are additional pages available. You can use the token in a following request to fetch the next set of results.
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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
Result Syntax
[ 'Entries' => [ [ 'CreateTime' => <DateTime>, 'Description' => '<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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
PutGeofence
$result = $client->putGeofence
([/* ... */]); $promise = $client->putGeofenceAsync
([/* ... */]);
Stores a geofence to 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.
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
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was unsuccessful due to a conflict.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
Parameter Syntax
$result = $client->searchPlaceIndexForPosition([ 'IndexName' => '<string>', // REQUIRED '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.
- MaxResults
-
- Type: int
An optional paramer. The maximum number of results returned per request.
Default value:
50
- Position
-
- Required: Yes
- Type: Array of doubles
Specifies a coordinate for the query defined by a longitude, and latitude.
-
The first position is the X coordinate, or longitude.
-
The second position is the Y coordinate, or latitude.
For example,
position=xLongitude&position=yLatitude
.
Result Syntax
[ 'Results' => [ [ 'Place' => [ 'AddressNumber' => '<string>', 'Country' => '<string>', 'Geometry' => [ 'Point' => [<float>, ...], ], 'Label' => '<string>', 'Municipality' => '<string>', 'Neighborhood' => '<string>', 'PostalCode' => '<string>', 'Region' => '<string>', 'Street' => '<string>', 'SubRegion' => '<string>', ], ], // ... ], 'Summary' => [ 'DataSource' => '<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.
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to 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.
Includes the option to apply additional parameters to narrow your list of results.
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.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage
option for the IntendedUse
parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
Parameter Syntax
$result = $client->searchPlaceIndexForText([ 'BiasPosition' => [<float>, ...], 'FilterBBox' => [<float>, ...], 'FilterCountries' => ['<string>', ...], 'IndexName' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'Text' => '<string>', // REQUIRED ]);
Parameter Details
Members
- BiasPosition
-
- Type: Array of doubles
Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.
-
The first
bias
position is the X coordinate, or longitude. -
The second
bias
position is the Y coordinate, or latitude.
For example,
bias=xLongitude&bias=yLatitude
. - FilterBBox
-
- Type: Array of doubles
Filters the results by returning only Places within the provided bounding box. An optional parameter.
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.
For example,
bbox=xLongitudeSW&bbox=yLatitudeSW
.The next
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 longitude of the upper northeast corner.
For example,
bbox=xLongitudeNE&bbox=yLatitudeNE
- FilterCountries
-
- Type: Array of strings
Limits the search to the given a list of countries/regions. An optional parameter.
-
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.
- 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' => [ [ 'Place' => [ 'AddressNumber' => '<string>', 'Country' => '<string>', 'Geometry' => [ 'Point' => [<float>, ...], ], 'Label' => '<string>', 'Municipality' => '<string>', 'Neighborhood' => '<string>', 'PostalCode' => '<string>', 'Region' => '<string>', 'Street' => '<string>', 'SubRegion' => '<string>', ], ], // ... ], 'Summary' => [ 'BiasPosition' => [<float>, ...], 'DataSource' => '<string>', 'FilterBBox' => [<float>, ...], 'FilterCountries' => ['<string>', ...], 'MaxResults' => <integer>, 'ResultBBox' => [<float>, ...], 'Text' => '<string>', ], ]
Result Details
Members
- Results
-
- Required: Yes
- Type: Array of SearchForTextResult structures
A list of Places closest to the specified position. Each result contains additional information about the specific point of interest.
- Summary
-
- Required: Yes
- Type: SearchPlaceIndexForTextSummary structure
Contains a summary of the request. Contains the
BiasPosition
,DataSource
,FilterBBox
,FilterCountries
,MaxResults
,ResultBBox
, andText
.
Errors
-
The request has failed to process because of an unknown server error, exception, or failure.
-
The resource that you've entered was not found in your AWS account.
-
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
-
The input failed to meet the constraints specified by the AWS service.
-
The request was denied due to request throttling.
Shapes
AccessDeniedException
Description
The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.
Members
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
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 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
The geometry details for the geofence.
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 for when a position sample was attempted in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
.
ConflictException
Description
The request was unsuccessful due to a conflict.
Members
DataSourceConfiguration
Description
Specifies the data storage option chosen for requesting Places.
By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.
Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage
option for the IntendedUse
parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.
Members
DevicePosition
Description
Contains the device position details.
Members
- DeviceId
-
- Type: string
The device whose position you retrieved.
- Position
-
- Required: Yes
- Type: Array of doubles
The last known device position.
- ReceivedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the tracker resource recieved the 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 for when the position was detected and sampled in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
.
DevicePositionUpdate
Description
Contains the position update details for a device.
Members
- 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:
[Xlongitude, Ylatitude]
. - SampleTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp for when the position update was received in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
GeofenceGeometry
Description
Contains the geofence geometry details.
Limitation — Amazon Location does not 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
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
- 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.
- 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.
- 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.
- 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
.
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.
- 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 position was detected and sampled in 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 styles:
VectorEsriStreets
,VectorEsriTopographic
,VectorEsriNavigation
,VectorEsriDarkGrayCanvas
,VectorEsriLightGrayCanvas
,VectorHereBerlin
.When using HERE as your data provider, and selecting the Style
VectorHereBerlin
, you may not use HERE Maps for Asset Management. See the AWS Service Terms for Amazon Location Service.
Place
Description
Contains details about addresses or points of interest that match the search criteria.
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.
- 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
.
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.
ResourceNotFoundException
Description
The resource that you've entered was not found in your AWS account.
Members
SearchForPositionResult
Description
Specifies a single point of interest, or Place as a result of a search query obtained from a dataset configured in the Place index Resource.
Members
- Place
-
- Required: Yes
- Type: Place structure
Contains details about the relevant point of interest.
SearchForTextResult
Description
Contains relevant Places returned by calling SearchPlaceIndexForText
.
Members
- Place
-
- Required: Yes
- Type: Place structure
Contains details about the relevant point of interest.
SearchPlaceIndexForPositionSummary
Description
A summary of the reverse geocoding request sent using SearchPlaceIndexForPosition
.
Members
- DataSource
-
- Required: Yes
- Type: string
The data provider of geospatial data for the Place index resource.
- MaxResults
-
- Type: int
An optional parameter. The maximum number of results returned per request.
Default value:
50
- Position
-
- Required: Yes
- Type: Array of doubles
The position given in the reverse geocoding request.
SearchPlaceIndexForTextSummary
Description
A summary of the geocoding request sent using SearchPlaceIndexForText
.
Members
- BiasPosition
-
- Type: Array of doubles
Contains the coordinates for the bias position entered in the geocoding request.
- DataSource
-
- Required: Yes
- Type: string
The data provider of geospatial data for the Place index resource.
- FilterBBox
-
- Type: Array of doubles
Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
- FilterCountries
-
- Type: Array of strings
Contains the country filter entered in the geocoding request.
- MaxResults
-
- Type: int
Contains the maximum number of results indicated for the request.
- ResultBBox
-
- Type: Array of doubles
A bounding box that contains the search results within the specified area indicated by
FilterBBox
. A subset of bounding box specified usingFilterBBox
. - Text
-
- Required: Yes
- Type: string
The address, name, city or region to be used in the geocoding request. In free-form text format. For example,
Vancouver
.
ThrottlingException
Description
The request was denied due to request throttling.
Members
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.