describe_place_index
(**kwargs)¶Retrieves the place index resource details.
See also: AWS API Documentation
Request Syntax
response = client.describe_place_index(
IndexName='string'
)
[REQUIRED]
The name of the place index resource.
{
'CreateTime': datetime(2015, 1, 1),
'DataSource': 'string',
'DataSourceConfiguration': {
'IntendedUse': 'SingleUse'|'Storage'
},
'Description': 'string',
'IndexArn': 'string',
'IndexName': 'string',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'Tags': {
'string': 'string'
},
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
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.
The specified data storage option for requesting Places.
Specifies how the results of an operation will be stored by the caller.
Valid values include:
SingleUse
specifies that the results won't be stored.Storage
specifies that the result can be cached or stored in a database.Default value: SingleUse
The optional description for the place index resource.
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
The name of the place index resource being described.
No longer used. Always returns RequestBasedUsage
.
Tags associated with place index resource.
The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
Exceptions
LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.ResourceNotFoundException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException