# DescribeRouteCalculator
<a name="API_DescribeRouteCalculator"></a>

**Important**  
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 AWS SDK or the AWS 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](/location/latest/APIReference/API_Operations_Amazon_Location_Service_Routes_V2.html) or the [Developer Guide](/location/latest/developerguide/routes.html).

Retrieves the route calculator resource details.

## Request Syntax
<a name="API_DescribeRouteCalculator_RequestSyntax"></a>

```
GET /routes/v0/calculators/{{CalculatorName}} HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeRouteCalculator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CalculatorName](#API_DescribeRouteCalculator_RequestSyntax) **   <a name="location-DescribeRouteCalculator-request-uri-CalculatorName"></a>
The name of the route calculator resource.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[-._\w]+`   
Required: Yes

## Request Body
<a name="API_DescribeRouteCalculator_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeRouteCalculator_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CalculatorArn": "string",
   "CalculatorName": "string",
   "CreateTime": "string",
   "DataSource": "string",
   "Description": "string",
   "PricingPlan": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UpdateTime": "string"
}
```

## Response Elements
<a name="API_DescribeRouteCalculator_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CalculatorArn](#API_DescribeRouteCalculator_ResponseSyntax) **   <a name="location-DescribeRouteCalculator-response-CalculatorArn"></a>
The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.  
+ Format example: `arn:aws:geo:region:account-id:route-calculator/ExampleCalculator` 
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1600.  
Pattern: `arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))` 

 ** [CalculatorName](#API_DescribeRouteCalculator_ResponseSyntax) **   <a name="location-DescribeRouteCalculator-response-CalculatorName"></a>
The name of the route calculator resource being described.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[-._\w]+` 

 ** [CreateTime](#API_DescribeRouteCalculator_ResponseSyntax) **   <a name="location-DescribeRouteCalculator-response-CreateTime"></a>
The timestamp when the route calculator resource was created in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ`.   
+ For example, `2020–07-2T12:15:20.000Z+01:00` 
Type: Timestamp

 ** [DataSource](#API_DescribeRouteCalculator_ResponseSyntax) **   <a name="location-DescribeRouteCalculator-response-DataSource"></a>
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](https://docs.aws.amazon.com/location/previous/developerguide/what-is-data-provider.html).  
Type: String

 ** [Description](#API_DescribeRouteCalculator_ResponseSyntax) **   <a name="location-DescribeRouteCalculator-response-Description"></a>
The optional description of the route calculator resource.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

 ** [PricingPlan](#API_DescribeRouteCalculator_ResponseSyntax) **   <a name="location-DescribeRouteCalculator-response-PricingPlan"></a>
 *This parameter has been deprecated.*   
Always returns `RequestBasedUsage`.  
Type: String  
Valid Values: `RequestBasedUsage | MobileAssetTracking | MobileAssetManagement` 

 ** [Tags](#API_DescribeRouteCalculator_ResponseSyntax) **   <a name="location-DescribeRouteCalculator-response-Tags"></a>
Tags associated with route calculator resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)` 

 ** [UpdateTime](#API_DescribeRouteCalculator_ResponseSyntax) **   <a name="location-DescribeRouteCalculator-response-UpdateTime"></a>
The timestamp when the route calculator resource was last updated in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ`.   
+ For example, `2020–07-2T12:15:20.000Z+01:00` 
Type: Timestamp

## Errors
<a name="API_DescribeRouteCalculator_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed to process because of an unknown server error, exception, or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource that you've entered was not found in your AWS account.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied because of request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input failed to meet the constraints specified by the AWS service.     
 ** FieldList **   
The field where the invalid entry was detected.  
 ** Reason **   
A message with the reason for the validation exception error.
HTTP Status Code: 400

## See Also
<a name="API_DescribeRouteCalculator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/location-2020-11-19/DescribeRouteCalculator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/location-2020-11-19/DescribeRouteCalculator)