DescribeRouteCalculator - Amazon Location Service Routes

DescribeRouteCalculator

Retrieves the route calculator resource details.

Request Syntax

GET /routes/v0/calculators/CalculatorName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CalculatorName

The name of the route calculator resource.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\w]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CalculatorArn": "string", "CalculatorName": "string", "CreateTime": number, "DataSource": "string", "Description": "string", "PricingPlan": "string", "Tags": { "string" : "string" }, "UpdateTime": number }

Response Elements

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

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]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$

CalculatorName

The name of the route calculator resource being described.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\w]+$

CreateTime

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

Type: Timestamp

DataSource

The data provider of traffic and road network data. Indicates one of the available providers:

  • Esri

  • Here

For more information about data providers, see Amazon Location Service data providers.

Type: String

Description

The optional description of the route calculator resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

PricingPlan

The pricing plan selected for the specified route calculator resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Type: String

Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement

Tags

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: ^[a-zA-Z+-=._:/]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[A-Za-z0-9 _=@:.+-/]*$

UpdateTime

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

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.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: