Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribePlaceIndex

Retrieves the place index resource details.

Request Syntax


GET /places/v0/indexes/IndexName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

IndexName

The name of the place index resource.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreateTime": "string",
   "DataSource": "string",
   "DataSourceConfiguration": { 
      "IntendedUse": "string"
   },
   "Description": "string",
   "IndexArn": "string",
   "IndexName": "string",
   "PricingPlan": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UpdateTime": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreateTime

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

Type: Timestamp

DataSource

The data provider of geospatial data. Values can be one of the following:

Esri
Grab
Here

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

Type: String

DataSourceConfiguration

The specified data storage option for requesting Places.

Type: DataSourceConfiguration object

Description

The optional description for the place index resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

IndexArn

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))

IndexName

The name of the place index resource being described.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

PricingPlan

This parameter has been deprecated.

No longer used. Always returns RequestBasedUsage.

Type: String

Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement

Tags

Tags associated with place index resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

UpdateTime

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400