LocationService / Client / update_route_calculator

update_route_calculator

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

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

Updates the specified properties for a given route calculator resource.

See also: AWS API Documentation

Request Syntax

response = client.update_route_calculator(
    CalculatorName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    Description='string'
)
Parameters:

  • CalculatorName (string) –

    [REQUIRED]

    The name of the route calculator resource to update.

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

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • CalculatorName (string) –

      The name of the updated route calculator resource.

    • CalculatorArn (string) –

      The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.

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

    • UpdateTime (datetime) –

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

Exceptions