Skip to content

Commit f7e8904

Browse files
author
awstools
committed
feat(client-location): Added support for mobile app restrictions in Amazon Location API keys.
1 parent fd1221d commit f7e8904

File tree

64 files changed

+1319
-3768
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1319
-3768
lines changed

clients/client-location/src/commands/AssociateTrackerConsumerCommand.ts

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface AssociateTrackerConsumerCommandInput extends AssociateTrackerCo
2828
export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerConsumerResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an association between a geofence collection and a tracker resource. This
32-
* allows the tracker resource to communicate location data to the linked geofence
33-
* collection. </p>
34-
* <p>You can associate up to five geofence collections to each tracker resource.</p>
35-
* <note>
36-
* <p>Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.</p>
37-
* </note>
31+
* <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> <p>You can associate up to five geofence collections to each tracker resource.</p> <note> <p>Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.</p> </note>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -60,8 +54,7 @@ export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerC
6054
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
6155
*
6256
* @throws {@link AccessDeniedException} (client fault)
63-
* <p>The request was denied because of insufficient access or permissions. Check with an
64-
* administrator to verify your permissions.</p>
57+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
6558
*
6659
* @throws {@link ConflictException} (client fault)
6760
* <p>The request was unsuccessful because of a conflict.</p>
@@ -73,8 +66,7 @@ export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerC
7366
* <p>The resource that you've entered was not found in your AWS account.</p>
7467
*
7568
* @throws {@link ServiceQuotaExceededException} (client fault)
76-
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a>
77-
* set for Amazon Location Service.</p>
69+
* <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/previous/developerguide/location-quotas.html">quota</a> set for Amazon Location Service.</p>
7870
*
7971
* @throws {@link ThrottlingException} (client fault)
8072
* <p>The request was denied because of request throttling.</p>

clients/client-location/src/commands/BatchDeleteDevicePositionHistoryCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ export interface BatchDeleteDevicePositionHistoryCommandOutput
7171
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
7272
*
7373
* @throws {@link AccessDeniedException} (client fault)
74-
* <p>The request was denied because of insufficient access or permissions. Check with an
75-
* administrator to verify your permissions.</p>
74+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
7675
*
7776
* @throws {@link InternalServerException} (server fault)
7877
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>

clients/client-location/src/commands/BatchDeleteGeofenceCommand.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ export interface BatchDeleteGeofenceCommandInput extends BatchDeleteGeofenceRequ
2828
export interface BatchDeleteGeofenceCommandOutput extends BatchDeleteGeofenceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a batch of geofences from a geofence collection.</p>
32-
* <note>
33-
* <p>This operation deletes the resource permanently.</p>
34-
* </note>
31+
* <p>Deletes a batch of geofences from a geofence collection.</p> <note> <p>This operation deletes the resource permanently.</p> </note>
3532
* @example
3633
* Use a bare-bones client and the command you need to make an API call.
3734
* ```javascript
@@ -69,8 +66,7 @@ export interface BatchDeleteGeofenceCommandOutput extends BatchDeleteGeofenceRes
6966
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
7067
*
7168
* @throws {@link AccessDeniedException} (client fault)
72-
* <p>The request was denied because of insufficient access or permissions. Check with an
73-
* administrator to verify your permissions.</p>
69+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
7470
*
7571
* @throws {@link InternalServerException} (server fault)
7672
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>

clients/client-location/src/commands/BatchEvaluateGeofencesCommand.ts

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -33,36 +33,7 @@ export interface BatchEvaluateGeofencesCommandInput extends BatchEvaluateGeofenc
3333
export interface BatchEvaluateGeofencesCommandOutput extends BatchEvaluateGeofencesResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>Evaluates device positions against the geofence geometries from a given geofence
37-
* collection.</p>
38-
* <p>This operation always returns an empty response because geofences are asynchronously
39-
* evaluated. The evaluation determines if the device has entered or exited a geofenced
40-
* area, and then publishes one of the following events to Amazon EventBridge:</p>
41-
* <ul>
42-
* <li>
43-
* <p>
44-
* <code>ENTER</code> if Amazon Location determines that the tracked device has entered
45-
* a geofenced area.</p>
46-
* </li>
47-
* <li>
48-
* <p>
49-
* <code>EXIT</code> if Amazon Location determines that the tracked device has exited a
50-
* geofenced area.</p>
51-
* </li>
52-
* </ul>
53-
* <note>
54-
* <p>The last geofence that a device was observed within is tracked for 30 days after
55-
* the most recent device position update.</p>
56-
* </note>
57-
* <note>
58-
* <p>Geofence evaluation uses the given device position. It does not account for the
59-
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
60-
* </note>
61-
* <note>
62-
* <p>The <code>DeviceID</code> is used as a string to represent the device. You do not
63-
* need to have a <code>Tracker</code> associated with the
64-
* <code>DeviceID</code>.</p>
65-
* </note>
36+
* <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 evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:</p> <ul> <li> <p> <code>ENTER</code> if Amazon Location determines that the tracked device has entered a geofenced area.</p> </li> <li> <p> <code>EXIT</code> if Amazon Location determines that the tracked device has exited a geofenced area.</p> </li> </ul> <note> <p>The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.</p> </note> <note> <p>Geofence evaluation uses the given device position. It does not account for the optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p> </note> <note> <p>The <code>DeviceID</code> is used as a string to represent the device. You do not need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p> </note>
6637
* @example
6738
* Use a bare-bones client and the command you need to make an API call.
6839
* ```javascript
@@ -113,8 +84,7 @@ export interface BatchEvaluateGeofencesCommandOutput extends BatchEvaluateGeofen
11384
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
11485
*
11586
* @throws {@link AccessDeniedException} (client fault)
116-
* <p>The request was denied because of insufficient access or permissions. Check with an
117-
* administrator to verify your permissions.</p>
87+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
11888
*
11989
* @throws {@link InternalServerException} (server fault)
12090
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>

clients/client-location/src/commands/BatchGetDevicePositionCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,7 @@ export interface BatchGetDevicePositionCommandOutput extends BatchGetDevicePosit
8686
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
8787
*
8888
* @throws {@link AccessDeniedException} (client fault)
89-
* <p>The request was denied because of insufficient access or permissions. Check with an
90-
* administrator to verify your permissions.</p>
89+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
9190
*
9291
* @throws {@link InternalServerException} (server fault)
9392
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,7 @@ export interface BatchPutGeofenceCommandInput extends BatchPutGeofenceRequest {}
3333
export interface BatchPutGeofenceCommandOutput extends BatchPutGeofenceResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>A batch request for storing geofence geometries into a given geofence collection, or
37-
* updates the geometry of an existing geofence if a geofence ID is included in the
38-
* request.</p>
36+
* <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>
3937
* @example
4038
* Use a bare-bones client and the command you need to make an API call.
4139
* ```javascript
@@ -108,8 +106,7 @@ export interface BatchPutGeofenceCommandOutput extends BatchPutGeofenceResponse,
108106
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
109107
*
110108
* @throws {@link AccessDeniedException} (client fault)
111-
* <p>The request was denied because of insufficient access or permissions. Check with an
112-
* administrator to verify your permissions.</p>
109+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
113110
*
114111
* @throws {@link InternalServerException} (server fault)
115112
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>

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

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,7 @@ export interface BatchUpdateDevicePositionCommandInput extends BatchUpdateDevice
3333
export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevicePositionResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>Uploads position update data for one or more devices to a tracker resource (up to
37-
* 10 devices per batch). Amazon Location uses the data when it reports the last known device
38-
* position and position history. Amazon Location retains location data for 30 days.</p>
39-
* <note>
40-
* <p>Position updates are handled based on the <code>PositionFiltering</code>
41-
* property of the tracker. When <code>PositionFiltering</code> is set to
42-
* <code>TimeBased</code>, updates are evaluated against linked geofence collections,
43-
* and location data is stored at a maximum of one position per 30 second interval.
44-
* If your update frequency is more often than every 30 seconds, only one update per
45-
* 30 seconds is stored for each unique device ID.</p>
46-
* <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code>
47-
* filtering, location data is stored and evaluated against linked geofence
48-
* collections only if the device has moved more than 30 m (98.4 ft).</p>
49-
* <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code>
50-
* filtering, location data is stored and evaluated against linked geofence
51-
* collections only if the device has moved more than the measured accuracy. For
52-
* example, if two consecutive updates from a device have a horizontal accuracy of
53-
* 5 m and 10 m, the second update is neither stored or evaluated if the device has
54-
* moved less than 15 m. If <code>PositionFiltering</code> is set to
55-
* <code>AccuracyBased</code> filtering, Amazon Location uses the default value
56-
* <code>\{ "Horizontal": 0\}</code> when accuracy is not provided on a
57-
* <code>DevicePositionUpdate</code>.</p>
58-
* </note>
36+
* <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 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> </note>
5937
* @example
6038
* Use a bare-bones client and the command you need to make an API call.
6139
* ```javascript
@@ -106,8 +84,7 @@ export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevic
10684
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
10785
*
10886
* @throws {@link AccessDeniedException} (client fault)
109-
* <p>The request was denied because of insufficient access or permissions. Check with an
110-
* administrator to verify your permissions.</p>
87+
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
11188
*
11289
* @throws {@link InternalServerException} (server fault)
11390
* <p>The request has failed to process because of an unknown server error, exception, or failure.</p>

0 commit comments

Comments
 (0)