feat(client-location): Amazon Location Service adds categories to pla…

…ces, including filtering on those categories in searches. Also, you can now add metadata properties to your geofences.
aws · Jun 15, 2023 · a7c47ab · a7c47ab
1 parent 13d4dc2
commit a7c47ab
Show file tree

Hide file tree

Showing 12 changed files with 315 additions and 29 deletions.
diff --git a/clients/client-location/src/commands/BatchPutGeofenceCommand.ts b/clients/client-location/src/commands/BatchPutGeofenceCommand.ts
@@ -68,6 +68,9 @@ export interface BatchPutGeofenceCommandOutput extends BatchPutGeofenceResponse,
  *           Radius: Number("double"), // required
  *         },
  *       },
+ *       GeofenceProperties: { // PropertyMap
+ *         "<keys>": "STRING_VALUE",
+ *       },
  *     },
  *   ],
  * };

diff --git a/clients/client-location/src/commands/BatchUpdateDevicePositionCommand.ts b/clients/client-location/src/commands/BatchUpdateDevicePositionCommand.ts
@@ -40,24 +40,28 @@ export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevic
 
 /**
  * @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>
+ * <p>Uploads position update data for one or more devices to a tracker resource (up to
+ *            10 devices per batch). 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>
  *          <note>
- *             <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker.
- *                When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections,
- *                and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than
- *                every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>
- *             <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence
+ *             <p>Position updates are handled based on the <code>PositionFiltering</code>
+ *                property of the tracker. When <code>PositionFiltering</code> is set to
+ *                <code>TimeBased</code>, updates are evaluated against linked geofence collections,
+ *                and location data is stored at a maximum of one position per 30 second interval.
+ *                If your update frequency is more often than every 30 seconds, only one update per
+ *                30 seconds is stored for each unique device ID.</p>
+ *             <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code>
+ *                 filtering, location data is stored and evaluated against linked geofence
  *                 collections only if the device has moved more than 30 m (98.4 ft).</p>
- *             <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering,
- *                 location data is stored and evaluated against linked geofence collections only if the
- *                 device has moved more than the measured accuracy. For example, if two consecutive
- *                 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
- *                 a <code>DevicePositionUpdate</code>.</p>
+ *             <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code>
+ *                 filtering, location data is stored and evaluated against linked geofence
+ *                 collections only if the device has moved more than the measured accuracy. For
+ *                 example, if two consecutive 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 a
+ *                 <code>DevicePositionUpdate</code>.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-location/src/commands/GetGeofenceCommand.ts b/clients/client-location/src/commands/GetGeofenceCommand.ts
@@ -69,6 +69,9 @@ export interface GetGeofenceCommandOutput extends GetGeofenceResponse, __Metadat
  * //   Status: "STRING_VALUE", // required
  * //   CreateTime: new Date("TIMESTAMP"), // required
  * //   UpdateTime: new Date("TIMESTAMP"), // required
+ * //   GeofenceProperties: { // PropertyMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
  * // };
  *
  * ```

diff --git a/clients/client-location/src/commands/GetPlaceCommand.ts b/clients/client-location/src/commands/GetPlaceCommand.ts
@@ -89,6 +89,12 @@ export interface GetPlaceCommandOutput extends GetPlaceResponse, __MetadataBeare
  * //     },
  * //     UnitType: "STRING_VALUE",
  * //     UnitNumber: "STRING_VALUE",
+ * //     Categories: [ // PlaceCategoryList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     SupplementalCategories: [ // PlaceSupplementalCategoryList
+ * //       "STRING_VALUE",
+ * //     ],
  * //   },
  * // };
  *

diff --git a/clients/client-location/src/commands/ListGeofencesCommand.ts b/clients/client-location/src/commands/ListGeofencesCommand.ts
@@ -76,6 +76,9 @@ export interface ListGeofencesCommandOutput extends ListGeofencesResponse, __Met
  * //       Status: "STRING_VALUE", // required
  * //       CreateTime: new Date("TIMESTAMP"), // required
  * //       UpdateTime: new Date("TIMESTAMP"), // required
+ * //       GeofenceProperties: { // PropertyMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

diff --git a/clients/client-location/src/commands/PutGeofenceCommand.ts b/clients/client-location/src/commands/PutGeofenceCommand.ts
@@ -62,6 +62,9 @@ export interface PutGeofenceCommandOutput extends PutGeofenceResponse, __Metadat
  *       Radius: Number("double"), // required
  *     },
  *   },
+ *   GeofenceProperties: { // PropertyMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
  * };
  * const command = new PutGeofenceCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-location/src/commands/SearchPlaceIndexForPositionCommand.ts b/clients/client-location/src/commands/SearchPlaceIndexForPositionCommand.ts
@@ -97,6 +97,12 @@ export interface SearchPlaceIndexForPositionCommandOutput
  * //         },
  * //         UnitType: "STRING_VALUE",
  * //         UnitNumber: "STRING_VALUE",
+ * //         Categories: [ // PlaceCategoryList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         SupplementalCategories: [ // PlaceSupplementalCategoryList
+ * //           "STRING_VALUE",
+ * //         ],
  * //       },
  * //       Distance: Number("double"), // required
  * //       PlaceId: "STRING_VALUE",

diff --git a/clients/client-location/src/commands/SearchPlaceIndexForSuggestionsCommand.ts b/clients/client-location/src/commands/SearchPlaceIndexForSuggestionsCommand.ts
@@ -78,6 +78,9 @@ export interface SearchPlaceIndexForSuggestionsCommandOutput
  *   ],
  *   MaxResults: Number("int"),
  *   Language: "STRING_VALUE",
+ *   FilterCategories: [ // FilterPlaceCategoryList
+ *     "STRING_VALUE",
+ *   ],
  * };
  * const command = new SearchPlaceIndexForSuggestionsCommand(input);
  * const response = await client.send(command);
@@ -96,11 +99,20 @@ export interface SearchPlaceIndexForSuggestionsCommandOutput
  * //     MaxResults: Number("int"),
  * //     DataSource: "STRING_VALUE", // required
  * //     Language: "STRING_VALUE",
+ * //     FilterCategories: [ // FilterPlaceCategoryList
+ * //       "STRING_VALUE",
+ * //     ],
  * //   },
  * //   Results: [ // SearchForSuggestionsResultList // required
  * //     { // SearchForSuggestionsResult
  * //       Text: "STRING_VALUE", // required
  * //       PlaceId: "STRING_VALUE",
+ * //       Categories: [ // PlaceCategoryList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       SupplementalCategories: [ // PlaceSupplementalCategoryList
+ * //         "STRING_VALUE",
+ * //       ],
  * //     },
  * //   ],
  * // };

diff --git a/clients/client-location/src/commands/SearchPlaceIndexForTextCommand.ts b/clients/client-location/src/commands/SearchPlaceIndexForTextCommand.ts
@@ -71,6 +71,9 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
  *   ],
  *   MaxResults: Number("int"),
  *   Language: "STRING_VALUE",
+ *   FilterCategories: [ // FilterPlaceCategoryList
+ *     "STRING_VALUE",
+ *   ],
  * };
  * const command = new SearchPlaceIndexForTextCommand(input);
  * const response = await client.send(command);
@@ -92,6 +95,9 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
  * //     ],
  * //     DataSource: "STRING_VALUE", // required
  * //     Language: "STRING_VALUE",
+ * //     FilterCategories: [ // FilterPlaceCategoryList
+ * //       "STRING_VALUE",
+ * //     ],
  * //   },
  * //   Results: [ // SearchForTextResultList // required
  * //     { // SearchForTextResult
@@ -117,6 +123,12 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
  * //         },
  * //         UnitType: "STRING_VALUE",
  * //         UnitNumber: "STRING_VALUE",
+ * //         Categories: [ // PlaceCategoryList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         SupplementalCategories: [ // PlaceSupplementalCategoryList
+ * //           "STRING_VALUE",
+ * //         ],
  * //       },
  * //       Distance: Number("double"),
  * //       Relevance: Number("double"),