LocationService / Paginator / ListPlaceIndexes

ListPlaceIndexes#

class LocationService.Paginator.ListPlaceIndexes#
paginator = client.get_paginator('list_place_indexes')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from LocationService.Client.list_place_indexes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.

        • CreateTime (datetime) –

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

        • 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.

        • Description (string) –

          The optional description for the place index resource.

        • IndexName (string) –

          The name of the place index resource.

        • PricingPlan (string) –

          No longer used. Always returns RequestBasedUsage.

        • UpdateTime (datetime) –

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