CreateRouteCalculatorCommand

Suggest an Edit

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.

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LocationClient, CreateRouteCalculatorCommand } from "@aws-sdk/client-location"; // ES Modules import
// const { LocationClient, CreateRouteCalculatorCommand } = require("@aws-sdk/client-location"); // CommonJS import
const client = new LocationClient(config);
const input = { // CreateRouteCalculatorRequest
  CalculatorName: "STRING_VALUE", // required
  DataSource: "STRING_VALUE", // required
  PricingPlan: "STRING_VALUE",
  Description: "STRING_VALUE",
  Tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateRouteCalculatorCommand(input);
const response = await client.send(command);
// { // CreateRouteCalculatorResponse
//   CalculatorName: "STRING_VALUE", // required
//   CalculatorArn: "STRING_VALUE", // required
//   CreateTime: new Date("TIMESTAMP"), // required
// };

CreateRouteCalculatorCommand Input

See CreateRouteCalculatorCommandInput for more details

Parameter
Type
Description
CalculatorName
Required
string | undefined

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
Required
string | undefined

Specifies the data provider of traffic and road network data.

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

Valid values include:

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

Description
string | undefined

The optional description for the route calculator resource.

PricingPlan
PricingPlan | undefined

No longer used. If included, the only allowed value is RequestBasedUsage.

Tags
Record<string, string> | undefined

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.

CreateRouteCalculatorCommand Output

See CreateRouteCalculatorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CalculatorArn
Required
string | undefined

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

CalculatorName
Required
string | undefined

The name of the route calculator resource.

  • For example, ExampleRouteCalculator.

CreateTime
Required
Date | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

ConflictException
client

The request was unsuccessful because of a conflict.

InternalServerException
server

The request has failed to process because of an unknown server error, exception, or failure.

ServiceQuotaExceededException
client

The operation was denied because the request would exceed the maximum quota  set for Amazon Location Service.

ThrottlingException
client

The request was denied because of request throttling.

ValidationException
client

The input failed to meet the constraints specified by the AWS service.

LocationServiceException
Base exception class for all service exceptions from Location service.