@aws-sdk/client-location 3.295.0 → 3.297.0

package/dist-types/Location.d.ts

@@ -59,10 +59,12 @@ import { UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput }
 import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./commands/UpdateTrackerCommand";
 import { LocationClient } from "./LocationClient";
 /**
+ * @public
  * <p>"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"</p>
  */
 export declare class Location extends LocationClient {
     /**
+     * @public
      * <p>Creates an association between a geofence collection and a tracker resource. This
      *             allows the tracker resource to communicate location data to the linked geofence
      *             collection. </p>
@@ -75,12 +77,14 @@ export declare class Location extends LocationClient {
     associateTrackerConsumer(args: AssociateTrackerConsumerCommandInput, cb: (err: any, data?: AssociateTrackerConsumerCommandOutput) => void): void;
     associateTrackerConsumer(args: AssociateTrackerConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTrackerConsumerCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the position history of one or more devices from a tracker resource.</p>
      */
     batchDeleteDevicePositionHistory(args: BatchDeleteDevicePositionHistoryCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteDevicePositionHistoryCommandOutput>;
     batchDeleteDevicePositionHistory(args: BatchDeleteDevicePositionHistoryCommandInput, cb: (err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void): void;
     batchDeleteDevicePositionHistory(args: BatchDeleteDevicePositionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a batch of geofences from a geofence collection.</p>
      *          <note>
      *             <p>This operation deletes the resource permanently.</p>
@@ -90,6 +94,7 @@ export declare class Location extends LocationClient {
     batchDeleteGeofence(args: BatchDeleteGeofenceCommandInput, cb: (err: any, data?: BatchDeleteGeofenceCommandOutput) => void): void;
     batchDeleteGeofence(args: BatchDeleteGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteGeofenceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Evaluates device positions against the geofence geometries from a given geofence
      *             collection.</p>
      *          <p>This operation always returns an empty response because geofences are asynchronously
@@ -124,12 +129,14 @@ export declare class Location extends LocationClient {
     batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void): void;
     batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the latest device positions for requested devices.</p>
      */
     batchGetDevicePosition(args: BatchGetDevicePositionCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetDevicePositionCommandOutput>;
     batchGetDevicePosition(args: BatchGetDevicePositionCommandInput, cb: (err: any, data?: BatchGetDevicePositionCommandOutput) => void): void;
     batchGetDevicePosition(args: BatchGetDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDevicePositionCommandOutput) => void): void;
     /**
+     * @public
      * <p>A batch request for storing geofence geometries into a given geofence collection, or
      *             updates the geometry of an existing geofence if a geofence ID is included in the request.</p>
      */
@@ -137,6 +144,7 @@ export declare class Location extends LocationClient {
     batchPutGeofence(args: BatchPutGeofenceCommandInput, cb: (err: any, data?: BatchPutGeofenceCommandOutput) => void): void;
     batchPutGeofence(args: BatchPutGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutGeofenceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Uploads position update data for one or more devices to a tracker resource. Amazon Location
      *            uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30
      *            days.</p>
@@ -153,7 +161,7 @@ export declare class Location extends LocationClient {
      *                 updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
      *                 is neither stored or evaluated if the device has moved less than 15 m. If
      *                 <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location
-     *                 uses the default value <code>{ "Horizontal": 0}</code> when accuracy is not provided on
+     *                 uses the default value <code>\{ "Horizontal": 0\}</code> when accuracy is not provided on
      *                 a <code>DevicePositionUpdate</code>.</p>
      *          </note>
      */
@@ -161,6 +169,7 @@ export declare class Location extends LocationClient {
     batchUpdateDevicePosition(args: BatchUpdateDevicePositionCommandInput, cb: (err: any, data?: BatchUpdateDevicePositionCommandOutput) => void): void;
     batchUpdateDevicePosition(args: BatchUpdateDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateDevicePositionCommandOutput) => void): void;
     /**
+     * @public
      * <p>
      *             <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters:
      *                 <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that
@@ -200,6 +209,7 @@ export declare class Location extends LocationClient {
     calculateRoute(args: CalculateRouteCommandInput, cb: (err: any, data?: CalculateRouteCommandOutput) => void): void;
     calculateRoute(args: CalculateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteCommandOutput) => void): void;
     /**
+     * @public
      * <p>
      *             <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a route
      *                 matrix</a> given the following required parameters:
@@ -247,12 +257,14 @@ export declare class Location extends LocationClient {
     calculateRouteMatrix(args: CalculateRouteMatrixCommandInput, cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void): void;
     calculateRouteMatrix(args: CalculateRouteMatrixCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a geofence collection, which manages and stores geofences.</p>
      */
     createGeofenceCollection(args: CreateGeofenceCollectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateGeofenceCollectionCommandOutput>;
     createGeofenceCollection(args: CreateGeofenceCollectionCommandInput, cb: (err: any, data?: CreateGeofenceCollectionCommandOutput) => void): void;
     createGeofenceCollection(args: CreateGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGeofenceCollectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates an API key resource in your Amazon Web Services account, which lets you grant
      *                 <code>geo:GetMap*</code> actions for Amazon Location Map resources to the API key
      *             bearer.</p>
@@ -266,6 +278,7 @@ export declare class Location extends LocationClient {
     createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
     createKey(args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a map resource in your Amazon Web Services account, which provides map tiles of different
      *             styles sourced from global location data providers.</p>
      *          <note>
@@ -279,6 +292,7 @@ export declare class Location extends LocationClient {
     createMap(args: CreateMapCommandInput, cb: (err: any, data?: CreateMapCommandOutput) => void): void;
     createMap(args: CreateMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMapCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a place index resource in your Amazon Web Services account. Use a place index resource to
      *             geocode addresses and other text queries by using the
      *                 <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by
@@ -295,6 +309,7 @@ export declare class Location extends LocationClient {
     createPlaceIndex(args: CreatePlaceIndexCommandInput, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
     createPlaceIndex(args: CreatePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a route calculator resource in your Amazon Web Services account.</p>
      *          <p>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
@@ -310,6 +325,7 @@ export declare class Location extends LocationClient {
     createRouteCalculator(args: CreateRouteCalculatorCommandInput, cb: (err: any, data?: CreateRouteCalculatorCommandOutput) => void): void;
     createRouteCalculator(args: CreateRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteCalculatorCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and
      *             historical location of devices.</p>
      */
@@ -317,6 +333,7 @@ export declare class Location extends LocationClient {
     createTracker(args: CreateTrackerCommandInput, cb: (err: any, data?: CreateTrackerCommandOutput) => void): void;
     createTracker(args: CreateTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrackerCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a geofence collection from your Amazon Web Services account.</p>
      *          <note>
      *             <p>This operation deletes the resource permanently. If the geofence collection is the
@@ -327,6 +344,7 @@ export declare class Location extends LocationClient {
     deleteGeofenceCollection(args: DeleteGeofenceCollectionCommandInput, cb: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void): void;
     deleteGeofenceCollection(args: DeleteGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified API key. The API key must have been deactivated more than
      *             90 days previously.</p>
      */
@@ -334,6 +352,7 @@ export declare class Location extends LocationClient {
     deleteKey(args: DeleteKeyCommandInput, cb: (err: any, data?: DeleteKeyCommandOutput) => void): void;
     deleteKey(args: DeleteKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a map resource from your Amazon Web Services account.</p>
      *          <note>
      *             <p>This operation deletes the resource permanently. If the map is being used in an application,
@@ -344,6 +363,7 @@ export declare class Location extends LocationClient {
     deleteMap(args: DeleteMapCommandInput, cb: (err: any, data?: DeleteMapCommandOutput) => void): void;
     deleteMap(args: DeleteMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMapCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a place index resource from your Amazon Web Services account.</p>
      *          <note>
      *             <p>This operation deletes the resource permanently.</p>
@@ -353,6 +373,7 @@ export declare class Location extends LocationClient {
     deletePlaceIndex(args: DeletePlaceIndexCommandInput, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void): void;
     deletePlaceIndex(args: DeletePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a route calculator resource from your Amazon Web Services account.</p>
      *          <note>
      *             <p>This operation deletes the resource permanently.</p>
@@ -362,6 +383,7 @@ export declare class Location extends LocationClient {
     deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, cb: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void): void;
     deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a tracker resource from your Amazon Web Services account.</p>
      *          <note>
      *             <p>This operation deletes the resource permanently. If the tracker resource is in use, you may
@@ -373,12 +395,14 @@ export declare class Location extends LocationClient {
     deleteTracker(args: DeleteTrackerCommandInput, cb: (err: any, data?: DeleteTrackerCommandOutput) => void): void;
     deleteTracker(args: DeleteTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrackerCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the geofence collection details.</p>
      */
     describeGeofenceCollection(args: DescribeGeofenceCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGeofenceCollectionCommandOutput>;
     describeGeofenceCollection(args: DescribeGeofenceCollectionCommandInput, cb: (err: any, data?: DescribeGeofenceCollectionCommandOutput) => void): void;
     describeGeofenceCollection(args: DescribeGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGeofenceCollectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the API key resource details.</p>
      *          <important>
      *             <p>The API keys feature is in preview. We may add, change, or remove
@@ -390,30 +414,35 @@ export declare class Location extends LocationClient {
     describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
     describeKey(args: DescribeKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the map resource details.</p>
      */
     describeMap(args: DescribeMapCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMapCommandOutput>;
     describeMap(args: DescribeMapCommandInput, cb: (err: any, data?: DescribeMapCommandOutput) => void): void;
     describeMap(args: DescribeMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMapCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the place index resource details.</p>
      */
     describePlaceIndex(args: DescribePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<DescribePlaceIndexCommandOutput>;
     describePlaceIndex(args: DescribePlaceIndexCommandInput, cb: (err: any, data?: DescribePlaceIndexCommandOutput) => void): void;
     describePlaceIndex(args: DescribePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePlaceIndexCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the route calculator resource details.</p>
      */
     describeRouteCalculator(args: DescribeRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRouteCalculatorCommandOutput>;
     describeRouteCalculator(args: DescribeRouteCalculatorCommandInput, cb: (err: any, data?: DescribeRouteCalculatorCommandOutput) => void): void;
     describeRouteCalculator(args: DescribeRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRouteCalculatorCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the tracker resource details.</p>
      */
     describeTracker(args: DescribeTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTrackerCommandOutput>;
     describeTracker(args: DescribeTrackerCommandInput, cb: (err: any, data?: DescribeTrackerCommandOutput) => void): void;
     describeTracker(args: DescribeTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrackerCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes the association between a tracker resource and a geofence collection.</p>
      *          <note>
      *             <p>Once you unlink a tracker resource from a geofence collection, the tracker
@@ -424,6 +453,7 @@ export declare class Location extends LocationClient {
     disassociateTrackerConsumer(args: DisassociateTrackerConsumerCommandInput, cb: (err: any, data?: DisassociateTrackerConsumerCommandOutput) => void): void;
     disassociateTrackerConsumer(args: DisassociateTrackerConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTrackerConsumerCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves a device's most recent position according to its sample time.</p>
      *          <note>
      *             <p>Device positions are deleted after 30 days.</p>
@@ -433,6 +463,7 @@ export declare class Location extends LocationClient {
     getDevicePosition(args: GetDevicePositionCommandInput, cb: (err: any, data?: GetDevicePositionCommandOutput) => void): void;
     getDevicePosition(args: GetDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicePositionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the device position history from a tracker resource within a specified range
      *             of time.</p>
      *          <note>
@@ -443,18 +474,21 @@ export declare class Location extends LocationClient {
     getDevicePositionHistory(args: GetDevicePositionHistoryCommandInput, cb: (err: any, data?: GetDevicePositionHistoryCommandOutput) => void): void;
     getDevicePositionHistory(args: GetDevicePositionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicePositionHistoryCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the geofence details from a geofence collection.</p>
      */
     getGeofence(args: GetGeofenceCommandInput, options?: __HttpHandlerOptions): Promise<GetGeofenceCommandOutput>;
     getGeofence(args: GetGeofenceCommandInput, cb: (err: any, data?: GetGeofenceCommandOutput) => void): void;
     getGeofence(args: GetGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGeofenceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves glyphs used to display labels on a map.</p>
      */
     getMapGlyphs(args: GetMapGlyphsCommandInput, options?: __HttpHandlerOptions): Promise<GetMapGlyphsCommandOutput>;
     getMapGlyphs(args: GetMapGlyphsCommandInput, cb: (err: any, data?: GetMapGlyphsCommandOutput) => void): void;
     getMapGlyphs(args: GetMapGlyphsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapGlyphsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG
      *             image paired with a JSON document describing the offsets of individual icons that will
      *             be displayed on a rendered map.</p>
@@ -463,6 +497,7 @@ export declare class Location extends LocationClient {
     getMapSprites(args: GetMapSpritesCommandInput, cb: (err: any, data?: GetMapSpritesCommandOutput) => void): void;
     getMapSprites(args: GetMapSpritesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapSpritesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the map style descriptor from a map resource. </p>
      *          <p>The style descriptor contains specifications on how features render on a map. For
      *             example, what data to display, what order to display the data in, and the style for the
@@ -472,6 +507,7 @@ export declare class Location extends LocationClient {
     getMapStyleDescriptor(args: GetMapStyleDescriptorCommandInput, cb: (err: any, data?: GetMapStyleDescriptorCommandOutput) => void): void;
     getMapStyleDescriptor(args: GetMapStyleDescriptorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapStyleDescriptorCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves a vector data tile from the map resource. Map tiles are used by clients to
      *             render a map. they're addressed using a grid arrangement with an X coordinate, Y
      *             coordinate, and Z (zoom) level. </p>
@@ -483,6 +519,7 @@ export declare class Location extends LocationClient {
     getMapTile(args: GetMapTileCommandInput, cb: (err: any, data?: GetMapTileCommandOutput) => void): void;
     getMapTile(args: GetMapTileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapTileCommandOutput) => void): void;
     /**
+     * @public
      * <p>Finds a place by its unique ID. A <code>PlaceId</code> is returned by other search
      *             operations.</p>
      *          <note>
@@ -505,24 +542,28 @@ export declare class Location extends LocationClient {
     getPlace(args: GetPlaceCommandInput, cb: (err: any, data?: GetPlaceCommandOutput) => void): void;
     getPlace(args: GetPlaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlaceCommandOutput) => void): void;
     /**
+     * @public
      * <p>A batch request to retrieve all device positions.</p>
      */
     listDevicePositions(args: ListDevicePositionsCommandInput, options?: __HttpHandlerOptions): Promise<ListDevicePositionsCommandOutput>;
     listDevicePositions(args: ListDevicePositionsCommandInput, cb: (err: any, data?: ListDevicePositionsCommandOutput) => void): void;
     listDevicePositions(args: ListDevicePositionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicePositionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists geofence collections in your Amazon Web Services account.</p>
      */
     listGeofenceCollections(args: ListGeofenceCollectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListGeofenceCollectionsCommandOutput>;
     listGeofenceCollections(args: ListGeofenceCollectionsCommandInput, cb: (err: any, data?: ListGeofenceCollectionsCommandOutput) => void): void;
     listGeofenceCollections(args: ListGeofenceCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeofenceCollectionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists geofences stored in a given geofence collection.</p>
      */
     listGeofences(args: ListGeofencesCommandInput, options?: __HttpHandlerOptions): Promise<ListGeofencesCommandOutput>;
     listGeofences(args: ListGeofencesCommandInput, cb: (err: any, data?: ListGeofencesCommandOutput) => void): void;
     listGeofences(args: ListGeofencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeofencesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists API key resources in your Amazon Web Services account.</p>
      *          <important>
      *             <p>The API keys feature is in preview. We may add, change, or remove
@@ -534,42 +575,49 @@ export declare class Location extends LocationClient {
     listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
     listKeys(args: ListKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists map resources in your Amazon Web Services account.</p>
      */
     listMaps(args: ListMapsCommandInput, options?: __HttpHandlerOptions): Promise<ListMapsCommandOutput>;
     listMaps(args: ListMapsCommandInput, cb: (err: any, data?: ListMapsCommandOutput) => void): void;
     listMaps(args: ListMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMapsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists place index resources in your Amazon Web Services account.</p>
      */
     listPlaceIndexes(args: ListPlaceIndexesCommandInput, options?: __HttpHandlerOptions): Promise<ListPlaceIndexesCommandOutput>;
     listPlaceIndexes(args: ListPlaceIndexesCommandInput, cb: (err: any, data?: ListPlaceIndexesCommandOutput) => void): void;
     listPlaceIndexes(args: ListPlaceIndexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlaceIndexesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists route calculator resources in your Amazon Web Services account.</p>
      */
     listRouteCalculators(args: ListRouteCalculatorsCommandInput, options?: __HttpHandlerOptions): Promise<ListRouteCalculatorsCommandOutput>;
     listRouteCalculators(args: ListRouteCalculatorsCommandInput, cb: (err: any, data?: ListRouteCalculatorsCommandOutput) => void): void;
     listRouteCalculators(args: ListRouteCalculatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRouteCalculatorsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of tags that are applied to the specified Amazon Location resource.</p>
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists geofence collections currently associated to the given tracker resource.</p>
      */
     listTrackerConsumers(args: ListTrackerConsumersCommandInput, options?: __HttpHandlerOptions): Promise<ListTrackerConsumersCommandOutput>;
     listTrackerConsumers(args: ListTrackerConsumersCommandInput, cb: (err: any, data?: ListTrackerConsumersCommandOutput) => void): void;
     listTrackerConsumers(args: ListTrackerConsumersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrackerConsumersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists tracker resources in your Amazon Web Services account.</p>
      */
     listTrackers(args: ListTrackersCommandInput, options?: __HttpHandlerOptions): Promise<ListTrackersCommandOutput>;
     listTrackers(args: ListTrackersCommandInput, cb: (err: any, data?: ListTrackersCommandOutput) => void): void;
     listTrackers(args: ListTrackersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrackersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Stores a geofence geometry in a given geofence collection, or updates the geometry of
      *             an existing geofence if a geofence ID is included in the request. </p>
      */
@@ -577,6 +625,7 @@ export declare class Location extends LocationClient {
     putGeofence(args: PutGeofenceCommandInput, cb: (err: any, data?: PutGeofenceCommandOutput) => void): void;
     putGeofence(args: PutGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutGeofenceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Reverse geocodes a given coordinate and returns a legible address. Allows you to
      *             search for Places or points of interest near a given position.</p>
      */
@@ -584,6 +633,7 @@ export declare class Location extends LocationClient {
     searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
     searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Generates suggestions for addresses and points of interest based on partial or
      *             misspelled free-form text. This operation is also known as autocomplete, autosuggest, or
      *             fuzzy matching.</p>
@@ -601,6 +651,7 @@ export declare class Location extends LocationClient {
     searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
     searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
      *             search for Places or points of interest. </p>
      *          <p>Optional parameters let you narrow your search results by bounding box or country, or
@@ -616,6 +667,7 @@ export declare class Location extends LocationClient {
     searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void): void;
     searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void): void;
     /**
+     * @public
      * <p>Assigns one or more tags (key-value pairs) to the specified Amazon Location Service
      *             resource.</p>
      *          <p>Tags can help you organize and categorize your resources. You can also use them to
@@ -632,18 +684,21 @@ export declare class Location extends LocationClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes one or more tags from the specified Amazon Location resource.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the specified properties of a given geofence collection.</p>
      */
     updateGeofenceCollection(args: UpdateGeofenceCollectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGeofenceCollectionCommandOutput>;
     updateGeofenceCollection(args: UpdateGeofenceCollectionCommandInput, cb: (err: any, data?: UpdateGeofenceCollectionCommandOutput) => void): void;
     updateGeofenceCollection(args: UpdateGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGeofenceCollectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the specified properties of a given API key resource.</p>
      *          <important>
      *             <p>The API keys feature is in preview. We may add, change, or remove
@@ -655,24 +710,28 @@ export declare class Location extends LocationClient {
     updateKey(args: UpdateKeyCommandInput, cb: (err: any, data?: UpdateKeyCommandOutput) => void): void;
     updateKey(args: UpdateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the specified properties of a given map resource.</p>
      */
     updateMap(args: UpdateMapCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMapCommandOutput>;
     updateMap(args: UpdateMapCommandInput, cb: (err: any, data?: UpdateMapCommandOutput) => void): void;
     updateMap(args: UpdateMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMapCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the specified properties of a given place index resource.</p>
      */
     updatePlaceIndex(args: UpdatePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePlaceIndexCommandOutput>;
     updatePlaceIndex(args: UpdatePlaceIndexCommandInput, cb: (err: any, data?: UpdatePlaceIndexCommandOutput) => void): void;
     updatePlaceIndex(args: UpdatePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePlaceIndexCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the specified properties for a given route calculator resource.</p>
      */
     updateRouteCalculator(args: UpdateRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRouteCalculatorCommandOutput>;
     updateRouteCalculator(args: UpdateRouteCalculatorCommandInput, cb: (err: any, data?: UpdateRouteCalculatorCommandOutput) => void): void;
     updateRouteCalculator(args: UpdateRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRouteCalculatorCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the specified properties of a given tracker resource.</p>
      */
     updateTracker(args: UpdateTrackerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTrackerCommandOutput>;

package/dist-types/LocationClient.d.ts

@@ -66,15 +66,24 @@ import { UpdatePlaceIndexCommandInput, UpdatePlaceIndexCommandOutput } from "./c
 import { UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput } from "./commands/UpdateRouteCalculatorCommand";
 import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./commands/UpdateTrackerCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CalculateRouteMatrixCommandInput | CreateGeofenceCollectionCommandInput | CreateKeyCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteKeyCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeKeyCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | GetPlaceCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListKeysCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForSuggestionsCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateKeyCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CalculateRouteMatrixCommandOutput | CreateGeofenceCollectionCommandOutput | CreateKeyCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteKeyCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeKeyCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | GetPlaceCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListKeysCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForSuggestionsCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateKeyCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -164,23 +173,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type LocationClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of LocationClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of LocationClient class constructor that set the region, credentials and other options.
  */
 export interface LocationClientConfig extends LocationClientConfigType {
 }
+/**
+ * @public
+ */
 type LocationClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of LocationClient class. This is resolved and normalized from the {@link LocationClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of LocationClient class. This is resolved and normalized from the {@link LocationClientConfig | constructor configuration interface}.
  */
 export interface LocationClientResolvedConfig extends LocationClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"</p>
  */
 export declare class LocationClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, LocationClientResolvedConfig> {

package/dist-types/commands/AssociateTrackerConsumerCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
 import { AssociateTrackerConsumerRequest, AssociateTrackerConsumerResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link AssociateTrackerConsumerCommand}.
  */
 export interface AssociateTrackerConsumerCommandInput extends AssociateTrackerConsumerRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link AssociateTrackerConsumerCommand}.
  */
 export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerConsumerResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates an association between a geofence collection and a tracker resource. This
  *             allows the tracker resource to communicate location data to the linked geofence
  *             collection. </p>
@@ -31,6 +36,8 @@ export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerC
  * const response = await client.send(command);
  * ```
  *
+ * @param AssociateTrackerConsumerCommandInput - {@link AssociateTrackerConsumerCommandInput}
+ * @returns {@link AssociateTrackerConsumerCommandOutput}
  * @see {@link AssociateTrackerConsumerCommandInput} for command's `input` shape.
  * @see {@link AssociateTrackerConsumerCommandOutput} for command's `response` shape.
  * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
@@ -63,11 +70,20 @@ export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerC
 export declare class AssociateTrackerConsumerCommand extends $Command<AssociateTrackerConsumerCommandInput, AssociateTrackerConsumerCommandOutput, LocationClientResolvedConfig> {
     readonly input: AssociateTrackerConsumerCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AssociateTrackerConsumerCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateTrackerConsumerCommandInput, AssociateTrackerConsumerCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/BatchDeleteDevicePositionHistoryCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
 import { BatchDeleteDevicePositionHistoryRequest, BatchDeleteDevicePositionHistoryResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchDeleteDevicePositionHistoryCommand}.
  */
 export interface BatchDeleteDevicePositionHistoryCommandInput extends BatchDeleteDevicePositionHistoryRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchDeleteDevicePositionHistoryCommand}.
  */
 export interface BatchDeleteDevicePositionHistoryCommandOutput extends BatchDeleteDevicePositionHistoryResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes the position history of one or more devices from a tracker resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchDeleteDevicePositionHistoryCommandOutput extends BatchDele
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchDeleteDevicePositionHistoryCommandInput - {@link BatchDeleteDevicePositionHistoryCommandInput}
+ * @returns {@link BatchDeleteDevicePositionHistoryCommandOutput}
  * @see {@link BatchDeleteDevicePositionHistoryCommandInput} for command's `input` shape.
  * @see {@link BatchDeleteDevicePositionHistoryCommandOutput} for command's `response` shape.
  * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
@@ -50,11 +57,20 @@ export interface BatchDeleteDevicePositionHistoryCommandOutput extends BatchDele
 export declare class BatchDeleteDevicePositionHistoryCommand extends $Command<BatchDeleteDevicePositionHistoryCommandInput, BatchDeleteDevicePositionHistoryCommandOutput, LocationClientResolvedConfig> {
     readonly input: BatchDeleteDevicePositionHistoryCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchDeleteDevicePositionHistoryCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteDevicePositionHistoryCommandInput, BatchDeleteDevicePositionHistoryCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }