LocationService / Client / list_place_indexes

list_place_indexes#

LocationService.Client.list_place_indexes(**kwargs)#

Lists place index resources in your Amazon Web Services account.

Request Syntax

response = client.list_place_indexes(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) –
An optional limit for the maximum number of results returned in a single call.

Default value: 100
NextToken (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

Return type:

dict

Returns:

Response Syntax

{
    'Entries': [
        {
            'IndexName': 'string',
            'Description': 'string',
            'DataSource': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'CreateTime': datetime(2015, 1, 1),
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Entries (list) –
  
  Lists the place index resources that exist in your Amazon Web Services account
  - (dict) –
    
    A place index resource listed in your Amazon Web Services account.
    - IndexName (string) –
      
      The name of the place index resource.
    - Description (string) –
      
      The optional description for the place index resource.
    - DataSource (string) –
      
      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.
    - PricingPlan (string) –
      
      No longer used. Always returns RequestBasedUsage.
    - CreateTime (datetime) –
      
      The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    - UpdateTime (datetime) –
      
      The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
- NextToken (string) –
  
  A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException