LocationService / Paginator / ListRouteCalculators

ListRouteCalculators#

class LocationService.Paginator.ListRouteCalculators#

paginator = client.get_paginator('list_route_calculators')

paginate(**kwargs)#

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

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': [
        {
            'CalculatorName': 'string',
            'Description': 'string',
            'DataSource': 'string',
            'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
            'CreateTime': datetime(2015, 1, 1),
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

(dict) –
- Entries (list) –
  
  Lists the route calculator resources that exist in your Amazon Web Services account
  - (dict) –
    
    A route calculator resource listed in your Amazon Web Services account.
    - CalculatorName (string) –
      
      The name of the route calculator resource.
    - Description (string) –
      
      The optional description of the route calculator resource.
    - DataSource (string) –
      
      The data provider of traffic and road network data. Indicates one of the available providers:
      - Esri
      - Grab
      - Here
      For more information about data providers, see Amazon Location Service data providers.
    - PricingPlan (string) –
      
      Always returns RequestBasedUsage.
    - CreateTime (datetime) –
      
      The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
      - For example, 2020–07-2T12:15:20.000Z+01:00
    - UpdateTime (datetime) –
      
      The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
      - For example, 2020–07-2T12:15:20.000Z+01:00