LocationService / Client / create_route_calculator

create_route_calculator

LocationService.Client.create_route_calculator(**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.

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

Creates a route calculator resource in your Amazon Web Services account.

You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

Note

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

See also: AWS API Documentation

Request Syntax

response = client.create_route_calculator(
    CalculatorName='string',
    DataSource='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    Description='string',
    Tags={
        'string': 'string'
    }
)

Parameters:

• CalculatorName (string) –

  [REQUIRED]

  The name of the route calculator resource.

  Requirements:

  • Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).

  • Must be a unique Route calculator resource name.

  • No spaces allowed. For example, ExampleRouteCalculator.

• DataSource (string) –

  [REQUIRED]

  Specifies the data provider of traffic and road network data.

  Note

  This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

  Valid values include:

  • Esri – For additional information about Esri’s coverage in your region of interest, see Esri details on street networks and traffic coverage. Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

  • Grab – Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps’ coverage, see GrabMaps countries and areas covered.

  • Here – For additional information about HERE Technologies’ coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.

  For additional information , see Data providers on the Amazon Location Service Developer Guide.

• PricingPlan (string) – No longer used. If included, the only allowed value is RequestBasedUsage.

• Description (string) – The optional description for the route calculator resource.

• Tags (dict) –

  Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

  • For example: { "tag1" : "value1", "tag2" : "value2"}

  Format: "key" : "value"

  Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

  • Cannot use “aws:” as a prefix for a key.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CalculatorName': 'string',
    'CalculatorArn': 'string',
    'CreateTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • CalculatorName (string) –

    The name of the route calculator resource.

    • For example, ExampleRouteCalculator.

  • CalculatorArn (string) –

    The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

  • 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

Exceptions

• LocationService.Client.exceptions.InternalServerException

• LocationService.Client.exceptions.ConflictException

• LocationService.Client.exceptions.AccessDeniedException

• LocationService.Client.exceptions.ValidationException

• LocationService.Client.exceptions.ServiceQuotaExceededException

• LocationService.Client.exceptions.ThrottlingException