Skip to content

Commit a7c47ab

Browse files
author
awstools
committed
feat(client-location): Amazon Location Service adds categories to places, including filtering on those categories in searches. Also, you can now add metadata properties to your geofences.
1 parent 13d4dc2 commit a7c47ab

12 files changed

+315
-29
lines changed

‎clients/client-location/src/commands/BatchPutGeofenceCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ export interface BatchPutGeofenceCommandOutput extends BatchPutGeofenceResponse,
6868
* Radius: Number("double"), // required
6969
* },
7070
* },
71+
* GeofenceProperties: { // PropertyMap
72+
* "<keys>": "STRING_VALUE",
73+
* },
7174
* },
7275
* ],
7376
* };

‎clients/client-location/src/commands/BatchUpdateDevicePositionCommand.ts

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -40,24 +40,28 @@ export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevic
4040

4141
/**
4242
* @public
43-
* <p>Uploads position update data for one or more devices to a tracker resource. Amazon Location
44-
* uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30
45-
* days.</p>
43+
* <p>Uploads position update data for one or more devices to a tracker resource (up to
44+
* 10 devices per batch). Amazon Location uses the data when it reports the last known device
45+
* position and position history. Amazon Location retains location data for 30 days.</p>
4646
* <note>
47-
* <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker.
48-
* When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections,
49-
* and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than
50-
* every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>
51-
* <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence
47+
* <p>Position updates are handled based on the <code>PositionFiltering</code>
48+
* property of the tracker. When <code>PositionFiltering</code> is set to
49+
* <code>TimeBased</code>, updates are evaluated against linked geofence collections,
50+
* and location data is stored at a maximum of one position per 30 second interval.
51+
* If your update frequency is more often than every 30 seconds, only one update per
52+
* 30 seconds is stored for each unique device ID.</p>
53+
* <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code>
54+
* filtering, location data is stored and evaluated against linked geofence
5255
* collections only if the device has moved more than 30 m (98.4 ft).</p>
53-
* <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering,
54-
* location data is stored and evaluated against linked geofence collections only if the
55-
* device has moved more than the measured accuracy. For example, if two consecutive
56-
* updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
57-
* is neither stored or evaluated if the device has moved less than 15 m. If
58-
* <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location
59-
* uses the default value <code>\{ "Horizontal": 0\}</code> when accuracy is not provided on
60-
* a <code>DevicePositionUpdate</code>.</p>
56+
* <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code>
57+
* filtering, location data is stored and evaluated against linked geofence
58+
* collections only if the device has moved more than the measured accuracy. For
59+
* example, if two consecutive updates from a device have a horizontal accuracy of
60+
* 5 m and 10 m, the second update is neither stored or evaluated if the device has
61+
* moved less than 15 m. If <code>PositionFiltering</code> is set to
62+
* <code>AccuracyBased</code> filtering, Amazon Location uses the default value
63+
* <code>\{ "Horizontal": 0\}</code> when accuracy is not provided on a
64+
* <code>DevicePositionUpdate</code>.</p>
6165
* </note>
6266
* @example
6367
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-location/src/commands/GetGeofenceCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ export interface GetGeofenceCommandOutput extends GetGeofenceResponse, __Metadat
6969
* // Status: "STRING_VALUE", // required
7070
* // CreateTime: new Date("TIMESTAMP"), // required
7171
* // UpdateTime: new Date("TIMESTAMP"), // required
72+
* // GeofenceProperties: { // PropertyMap
73+
* // "<keys>": "STRING_VALUE",
74+
* // },
7275
* // };
7376
*
7477
* ```

‎clients/client-location/src/commands/GetPlaceCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,12 @@ export interface GetPlaceCommandOutput extends GetPlaceResponse, __MetadataBeare
8989
* // },
9090
* // UnitType: "STRING_VALUE",
9191
* // UnitNumber: "STRING_VALUE",
92+
* // Categories: [ // PlaceCategoryList
93+
* // "STRING_VALUE",
94+
* // ],
95+
* // SupplementalCategories: [ // PlaceSupplementalCategoryList
96+
* // "STRING_VALUE",
97+
* // ],
9298
* // },
9399
* // };
94100
*

‎clients/client-location/src/commands/ListGeofencesCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,9 @@ export interface ListGeofencesCommandOutput extends ListGeofencesResponse, __Met
7676
* // Status: "STRING_VALUE", // required
7777
* // CreateTime: new Date("TIMESTAMP"), // required
7878
* // UpdateTime: new Date("TIMESTAMP"), // required
79+
* // GeofenceProperties: { // PropertyMap
80+
* // "<keys>": "STRING_VALUE",
81+
* // },
7982
* // },
8083
* // ],
8184
* // NextToken: "STRING_VALUE",

‎clients/client-location/src/commands/PutGeofenceCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ export interface PutGeofenceCommandOutput extends PutGeofenceResponse, __Metadat
6262
* Radius: Number("double"), // required
6363
* },
6464
* },
65+
* GeofenceProperties: { // PropertyMap
66+
* "<keys>": "STRING_VALUE",
67+
* },
6568
* };
6669
* const command = new PutGeofenceCommand(input);
6770
* const response = await client.send(command);

‎clients/client-location/src/commands/SearchPlaceIndexForPositionCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,12 @@ export interface SearchPlaceIndexForPositionCommandOutput
9797
* // },
9898
* // UnitType: "STRING_VALUE",
9999
* // UnitNumber: "STRING_VALUE",
100+
* // Categories: [ // PlaceCategoryList
101+
* // "STRING_VALUE",
102+
* // ],
103+
* // SupplementalCategories: [ // PlaceSupplementalCategoryList
104+
* // "STRING_VALUE",
105+
* // ],
100106
* // },
101107
* // Distance: Number("double"), // required
102108
* // PlaceId: "STRING_VALUE",

‎clients/client-location/src/commands/SearchPlaceIndexForSuggestionsCommand.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,9 @@ export interface SearchPlaceIndexForSuggestionsCommandOutput
7878
* ],
7979
* MaxResults: Number("int"),
8080
* Language: "STRING_VALUE",
81+
* FilterCategories: [ // FilterPlaceCategoryList
82+
* "STRING_VALUE",
83+
* ],
8184
* };
8285
* const command = new SearchPlaceIndexForSuggestionsCommand(input);
8386
* const response = await client.send(command);
@@ -96,11 +99,20 @@ export interface SearchPlaceIndexForSuggestionsCommandOutput
9699
* // MaxResults: Number("int"),
97100
* // DataSource: "STRING_VALUE", // required
98101
* // Language: "STRING_VALUE",
102+
* // FilterCategories: [ // FilterPlaceCategoryList
103+
* // "STRING_VALUE",
104+
* // ],
99105
* // },
100106
* // Results: [ // SearchForSuggestionsResultList // required
101107
* // { // SearchForSuggestionsResult
102108
* // Text: "STRING_VALUE", // required
103109
* // PlaceId: "STRING_VALUE",
110+
* // Categories: [ // PlaceCategoryList
111+
* // "STRING_VALUE",
112+
* // ],
113+
* // SupplementalCategories: [ // PlaceSupplementalCategoryList
114+
* // "STRING_VALUE",
115+
* // ],
104116
* // },
105117
* // ],
106118
* // };

‎clients/client-location/src/commands/SearchPlaceIndexForTextCommand.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
7171
* ],
7272
* MaxResults: Number("int"),
7373
* Language: "STRING_VALUE",
74+
* FilterCategories: [ // FilterPlaceCategoryList
75+
* "STRING_VALUE",
76+
* ],
7477
* };
7578
* const command = new SearchPlaceIndexForTextCommand(input);
7679
* const response = await client.send(command);
@@ -92,6 +95,9 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
9295
* // ],
9396
* // DataSource: "STRING_VALUE", // required
9497
* // Language: "STRING_VALUE",
98+
* // FilterCategories: [ // FilterPlaceCategoryList
99+
* // "STRING_VALUE",
100+
* // ],
95101
* // },
96102
* // Results: [ // SearchForTextResultList // required
97103
* // { // SearchForTextResult
@@ -117,6 +123,12 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
117123
* // },
118124
* // UnitType: "STRING_VALUE",
119125
* // UnitNumber: "STRING_VALUE",
126+
* // Categories: [ // PlaceCategoryList
127+
* // "STRING_VALUE",
128+
* // ],
129+
* // SupplementalCategories: [ // PlaceSupplementalCategoryList
130+
* // "STRING_VALUE",
131+
* // ],
120132
* // },
121133
* // Distance: Number("double"),
122134
* // Relevance: Number("double"),

0 commit comments

Comments
 (0)