LocationService / Client / list_route_calculators

list_route_calculators¶

LocationService.Client.list_route_calculators(**kwargs)¶

Warning

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data.

ListRouteCalculators is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).
The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources.
If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under geo-routes or geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide.

Lists route calculator resources in your Amazon Web Services account.

Request Syntax

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

Parameters:

MaxResults (integer) –
An optional 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': [
        {
            'CalculatorName': '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 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
- NextToken (string) –
  
  A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.

Exceptions

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