feat(client-location): This release adds support for authenticating w…

…ith Amazon Location Service's Places & Routes APIs with an API Key. Also, with this release developers can publish tracked device position updates to Amazon EventBridge.
aws · Jul 6, 2023 · 9e9ef3f · 9e9ef3f
1 parent 18a5919
commit 9e9ef3f
Show file tree

Hide file tree

Showing 16 changed files with 289 additions and 79 deletions.
diff --git a/clients/client-location/src/commands/CalculateRouteCommand.ts b/clients/client-location/src/commands/CalculateRouteCommand.ts
@@ -117,6 +117,7 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
  *       Unit: "STRING_VALUE",
  *     },
  *   },
+ *   Key: "STRING_VALUE",
  * };
  * const command = new CalculateRouteCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-location/src/commands/CalculateRouteMatrixCommand.ts b/clients/client-location/src/commands/CalculateRouteMatrixCommand.ts
@@ -123,6 +123,7 @@ export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixR
  *       Unit: "STRING_VALUE",
  *     },
  *   },
+ *   Key: "STRING_VALUE",
  * };
  * const command = new CalculateRouteMatrixCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-location/src/commands/CreateKeyCommand.ts b/clients/client-location/src/commands/CreateKeyCommand.ts
@@ -37,13 +37,10 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea
 /**
  * @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>
- *          <important>
- *             <p>The API keys feature is in preview. We may add, change, or remove
- *             features before announcing general availability. For more information, see
- *             <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
- *          </important>
+ *             actions for Amazon Location resources to the API key bearer.</p>
+ *          <note>
+ *             <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-location/src/commands/CreateTrackerCommand.ts b/clients/client-location/src/commands/CreateTrackerCommand.ts
@@ -54,6 +54,7 @@ export interface CreateTrackerCommandOutput extends CreateTrackerResponse, __Met
  *     "<keys>": "STRING_VALUE",
  *   },
  *   PositionFiltering: "STRING_VALUE",
+ *   EventBridgeEnabled: true || false,
  * };
  * const command = new CreateTrackerCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-location/src/commands/DescribeKeyCommand.ts b/clients/client-location/src/commands/DescribeKeyCommand.ts
@@ -37,11 +37,6 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat
 /**
  * @public
  * <p>Retrieves the API key resource details.</p>
- *          <important>
- *             <p>The API keys feature is in preview. We may add, change, or remove
- *             features before announcing general availability. For more information, see
- *             <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
- *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-location/src/commands/DescribeTrackerCommand.ts b/clients/client-location/src/commands/DescribeTrackerCommand.ts
@@ -61,6 +61,7 @@ export interface DescribeTrackerCommandOutput extends DescribeTrackerResponse, _
  * //   UpdateTime: new Date("TIMESTAMP"), // required
  * //   KmsKeyId: "STRING_VALUE",
  * //   PositionFiltering: "STRING_VALUE",
+ * //   EventBridgeEnabled: true || false,
  * // };
  *
  * ```

diff --git a/clients/client-location/src/commands/GetPlaceCommand.ts b/clients/client-location/src/commands/GetPlaceCommand.ts
@@ -14,7 +14,12 @@ import {
 } from "@smithy/types";
 
 import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
-import { GetPlaceRequest, GetPlaceResponse, GetPlaceResponseFilterSensitiveLog } from "../models/models_0";
+import {
+  GetPlaceRequest,
+  GetPlaceRequestFilterSensitiveLog,
+  GetPlaceResponse,
+  GetPlaceResponseFilterSensitiveLog,
+} from "../models/models_0";
 import { de_GetPlaceCommand, se_GetPlaceCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -63,6 +68,7 @@ export interface GetPlaceCommandOutput extends GetPlaceResponse, __MetadataBeare
  *   IndexName: "STRING_VALUE", // required
  *   PlaceId: "STRING_VALUE", // required
  *   Language: "STRING_VALUE",
+ *   Key: "STRING_VALUE",
  * };
  * const command = new GetPlaceCommand(input);
  * const response = await client.send(command);
@@ -172,7 +178,7 @@ export class GetPlaceCommand extends $Command<
       logger,
       clientName,
       commandName,
-      inputFilterSensitiveLog: (_: any) => _,
+      inputFilterSensitiveLog: GetPlaceRequestFilterSensitiveLog,
       outputFilterSensitiveLog: GetPlaceResponseFilterSensitiveLog,
     };
     const { requestHandler } = configuration;

diff --git a/clients/client-location/src/commands/ListKeysCommand.ts b/clients/client-location/src/commands/ListKeysCommand.ts
@@ -37,11 +37,6 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare
 /**
  * @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
- *             features before announcing general availability. For more information, see
- *             <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
- *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-location/src/commands/SearchPlaceIndexForPositionCommand.ts b/clients/client-location/src/commands/SearchPlaceIndexForPositionCommand.ts
@@ -61,6 +61,7 @@ export interface SearchPlaceIndexForPositionCommandOutput
  *   ],
  *   MaxResults: Number("int"),
  *   Language: "STRING_VALUE",
+ *   Key: "STRING_VALUE",
  * };
  * const command = new SearchPlaceIndexForPositionCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-location/src/commands/SearchPlaceIndexForSuggestionsCommand.ts b/clients/client-location/src/commands/SearchPlaceIndexForSuggestionsCommand.ts
@@ -81,6 +81,7 @@ export interface SearchPlaceIndexForSuggestionsCommandOutput
  *   FilterCategories: [ // FilterPlaceCategoryList
  *     "STRING_VALUE",
  *   ],
+ *   Key: "STRING_VALUE",
  * };
  * const command = new SearchPlaceIndexForSuggestionsCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-location/src/commands/SearchPlaceIndexForTextCommand.ts b/clients/client-location/src/commands/SearchPlaceIndexForTextCommand.ts
@@ -74,6 +74,7 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
  *   FilterCategories: [ // FilterPlaceCategoryList
  *     "STRING_VALUE",
  *   ],
+ *   Key: "STRING_VALUE",
  * };
  * const command = new SearchPlaceIndexForTextCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-location/src/commands/UpdateKeyCommand.ts b/clients/client-location/src/commands/UpdateKeyCommand.ts
@@ -37,11 +37,6 @@ export interface UpdateKeyCommandOutput extends UpdateKeyResponse, __MetadataBea
 /**
  * @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
- *             features before announcing general availability. For more information, see
- *             <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
- *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-location/src/commands/UpdateTrackerCommand.ts b/clients/client-location/src/commands/UpdateTrackerCommand.ts
@@ -49,6 +49,7 @@ export interface UpdateTrackerCommandOutput extends UpdateTrackerResponse, __Met
  *   PricingPlanDataSource: "STRING_VALUE",
  *   Description: "STRING_VALUE",
  *   PositionFiltering: "STRING_VALUE",
+ *   EventBridgeEnabled: true || false,
  * };
  * const command = new UpdateTrackerCommand(input);
  * const response = await client.send(command);