LocationService / Client / describe_route_calculator

describe_route_calculator

LocationService.Client.describe_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.

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

Retrieves the route calculator resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_route_calculator(
    CalculatorName='string'
)
Parameters:

CalculatorName (string) –

[REQUIRED]

The name of the route calculator resource.

Return type:

dict

Returns:

Response Syntax

{
    'CalculatorName': 'string',
    'CalculatorArn': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'Description': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'UpdateTime': datetime(2015, 1, 1),
    'DataSource': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • CalculatorName (string) –

      The name of the route calculator resource being described.

    • CalculatorArn (string) –

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

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

    • PricingPlan (string) –

      Always returns RequestBasedUsage.

    • Description (string) –

      The optional description of the route calculator resource.

    • 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

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

    • Tags (dict) –

      Tags associated with route calculator resource.

      • (string) –

        • (string) –

Exceptions