@aws-sdk/client-location

What is @aws-sdk/client-location?

@aws-sdk/client-location is an AWS SDK for JavaScript package that allows developers to interact with the Amazon Location Service. This service provides capabilities for adding location-based features to applications, such as geocoding, reverse geocoding, tracking, and routing.

What are @aws-sdk/client-location's main functionalities?

Geocoding

This feature allows you to convert addresses or place names into geographic coordinates. The code sample demonstrates how to search for a place index using a text query.

const { LocationClient, SearchPlaceIndexForTextCommand } = require('@aws-sdk/client-location');

const client = new LocationClient({ region: 'us-west-2' });
const command = new SearchPlaceIndexForTextCommand({
  IndexName: 'ExamplePlaceIndex',
  Text: 'Seattle'
});

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Reverse Geocoding

This feature allows you to convert geographic coordinates into addresses or place names. The code sample demonstrates how to search for a place index using geographic coordinates.

const { LocationClient, SearchPlaceIndexForPositionCommand } = require('@aws-sdk/client-location');

const client = new LocationClient({ region: 'us-west-2' });
const command = new SearchPlaceIndexForPositionCommand({
  IndexName: 'ExamplePlaceIndex',
  Position: [-122.335167, 47.608013]
});

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Tracking

This feature allows you to track the position of devices in real-time. The code sample demonstrates how to update the position of a device in a tracker.

const { LocationClient, BatchUpdateDevicePositionCommand } = require('@aws-sdk/client-location');

const client = new LocationClient({ region: 'us-west-2' });
const command = new BatchUpdateDevicePositionCommand({
  TrackerName: 'ExampleTracker',
  Updates: [
    {
      DeviceId: 'Device1',
      Position: [-122.335167, 47.608013],
      SampleTime: new Date().toISOString()
    }
  ]
});

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Routing

This feature allows you to calculate routes between two geographic locations. The code sample demonstrates how to calculate a route between a departure position and a destination position.

const { LocationClient, CalculateRouteCommand } = require('@aws-sdk/client-location');

const client = new LocationClient({ region: 'us-west-2' });
const command = new CalculateRouteCommand({
  CalculatorName: 'ExampleRouteCalculator',
  DeparturePosition: [-122.335167, 47.608013],
  DestinationPosition: [-122.3321, 47.6062]
});

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Other packages similar to @aws-sdk/client-location

mapbox

Mapbox is a popular location-based service that provides APIs for maps, geocoding, and routing. It offers a wide range of features and is known for its high-quality maps and ease of use. Compared to @aws-sdk/client-location, Mapbox provides more customization options for maps and a broader set of tools for developers.

here

HERE is a location-based service that offers APIs for maps, geocoding, routing, and more. It is known for its accurate and reliable data. Compared to @aws-sdk/client-location, HERE provides more detailed traffic and transit information and is often used in automotive and logistics industries.

README

@aws-sdk/client-location

Description

AWS SDK for JavaScript Location Client for Node.js, Browser and React Native.

"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"

Installing

To install this package, simply type add or install @aws-sdk/client-location using your favorite package manager:

• npm install @aws-sdk/client-location
• yarn add @aws-sdk/client-location
• pnpm add @aws-sdk/client-location

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the LocationClient and the commands you need, for example ListKeysCommand:

// ES5 example
const { LocationClient, ListKeysCommand } = require("@aws-sdk/client-location");

// ES6+ example
import { LocationClient, ListKeysCommand } from "@aws-sdk/client-location";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new LocationClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListKeysCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-location";
const client = new AWS.Location({ region: "REGION" });

// async/await.
try {
  const data = await client.listKeys(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listKeys(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listKeys(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-location package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

AssociateTrackerConsumer

Command API Reference / Input / Output

BatchDeleteDevicePositionHistory

Command API Reference / Input / Output

BatchDeleteGeofence

Command API Reference / Input / Output

BatchEvaluateGeofences

Command API Reference / Input / Output

BatchGetDevicePosition

Command API Reference / Input / Output

BatchPutGeofence

Command API Reference / Input / Output

BatchUpdateDevicePosition

Command API Reference / Input / Output

CalculateRoute

Command API Reference / Input / Output

CalculateRouteMatrix

Command API Reference / Input / Output

CreateGeofenceCollection

Command API Reference / Input / Output

CreateKey

Command API Reference / Input / Output

CreateMap

Command API Reference / Input / Output

CreatePlaceIndex

Command API Reference / Input / Output

CreateRouteCalculator

Command API Reference / Input / Output

CreateTracker

Command API Reference / Input / Output

DeleteGeofenceCollection

Command API Reference / Input / Output

DeleteKey

Command API Reference / Input / Output

DeleteMap

Command API Reference / Input / Output

DeletePlaceIndex

Command API Reference / Input / Output

DeleteRouteCalculator

Command API Reference / Input / Output

DeleteTracker

Command API Reference / Input / Output

DescribeGeofenceCollection

Command API Reference / Input / Output

DescribeKey

Command API Reference / Input / Output

DescribeMap

Command API Reference / Input / Output

DescribePlaceIndex

Command API Reference / Input / Output

DescribeRouteCalculator

Command API Reference / Input / Output

DescribeTracker

Command API Reference / Input / Output

DisassociateTrackerConsumer

Command API Reference / Input / Output

ForecastGeofenceEvents

Command API Reference / Input / Output

GetDevicePosition

Command API Reference / Input / Output

GetDevicePositionHistory

Command API Reference / Input / Output

GetGeofence

Command API Reference / Input / Output

GetMapGlyphs

Command API Reference / Input / Output

GetMapSprites

Command API Reference / Input / Output

GetMapStyleDescriptor

Command API Reference / Input / Output

GetMapTile

Command API Reference / Input / Output

GetPlace

Command API Reference / Input / Output

ListDevicePositions

Command API Reference / Input / Output

ListGeofenceCollections

Command API Reference / Input / Output

ListGeofences

Command API Reference / Input / Output

ListKeys

Command API Reference / Input / Output

ListMaps

Command API Reference / Input / Output

ListPlaceIndexes

Command API Reference / Input / Output

ListRouteCalculators

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTrackerConsumers

Command API Reference / Input / Output

ListTrackers

Command API Reference / Input / Output

PutGeofence

Command API Reference / Input / Output

SearchPlaceIndexForPosition

Command API Reference / Input / Output

SearchPlaceIndexForSuggestions

Command API Reference / Input / Output

SearchPlaceIndexForText

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateGeofenceCollection

Command API Reference / Input / Output

UpdateKey

Command API Reference / Input / Output

UpdateMap

Command API Reference / Input / Output

UpdatePlaceIndex

Command API Reference / Input / Output

UpdateRouteCalculator

Command API Reference / Input / Output

UpdateTracker

Command API Reference / Input / Output

VerifyDevicePosition

Command API Reference / Input / Output

Changelog

3.696.0 (2024-11-19)

Features

• client-b2bi: Add new X12 transactions sets and versions (cb3d07b)
• client-ec2: This release adds VPC Block Public Access (VPC BPA), a new declarative control which blocks resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. (7905a8e)
• client-ecs: This release introduces support for configuring the version consistency feature for individual containers defined within a task definition. The configuration allows to specify whether ECS should resolve the container image tag specified in the container definition to an image digest. (d632c0c)
• client-efs: Add support for the new parameters in EFS replication APIs (1f77893)
• client-glue: AWS Glue Data Catalog now enhances managed table optimizations of Apache Iceberg tables that can be accessed only from a specific Amazon Virtual Private Cloud (VPC) environment. (844a1da)
• client-keyspaces: Amazon Keyspaces Multi-Region Replication: Adds support to add new regions to multi and single-region keyspaces. (9c30b3a)
• client-mwaa: Amazon MWAA now supports a new environment class, mw1.micro, ideal for workloads requiring fewer resources than mw1.small. This class supports a single instance of each Airflow component: Scheduler, Worker, and Webserver. (a64d4bb)
• client-taxsettings: Release Tax Inheritance APIs, Tax Exemption APIs, and functionality update for some existing Tax Registration APIs (da73fe5)
• client-workspaces: Releasing new ErrorCodes for Image Validation failure during CreateWorkspaceImage process (5649e47)
• clients: update client endpoints as of 2024-11-19 (3a63d0b)