feat(aws-android-sdk-location): update models to latest (#2405)

Co-authored-by: Richard McClellan <[email protected]>
aws-amplify · Mar 29, 2021 · 8de4879 · 8de4879
1 parent ba13ebd
commit 8de4879
Show file tree

Hide file tree

Showing 45 changed files with 3,296 additions and 1,244 deletions.
diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/AmazonLocation.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/AmazonLocation.java
@@ -91,6 +91,13 @@ public interface AmazonLocation {
      * resource. This allows the tracker resource to communicate location data
      * to the linked geofence collection.
      * </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>
      * 
      * @param associateTrackerConsumerRequest
      * @return associateTrackerConsumerResult The response from the
@@ -147,9 +154,17 @@ BatchDeleteGeofenceResult batchDeleteGeofence(
 
     /**
      * <p>
-     * Used in geofence monitoring. Evaluates device positions against the
-     * position of geofences in a given geofence collection.
+     * Evaluates device positions against the geofence geometries from a given
+     * geofence collection. The evaluation determines if the device has entered
+     * or exited a geofenced area, which publishes ENTER or EXIT geofence events
+     * to Amazon EventBridge.
+     * </p>
+     * <note>
+     * <p>
+     * The last geofence that a device was observed within, if any, is tracked
+     * for 30 days after the most recent device position update
      * </p>
+     * </note>
      * 
      * @param batchEvaluateGeofencesRequest
      * @return batchEvaluateGeofencesResult The response from the
@@ -174,13 +189,8 @@ BatchEvaluateGeofencesResult batchEvaluateGeofences(
 
     /**
      * <p>
-     * A batch request to retrieve device positions.
-     * </p>
-     * <note>
-     * <p>
-     * The response will return the device positions from the last 24 hours.
+     * A batch request to retrieve all device positions.
      * </p>
-     * </note>
      * 
      * @param batchGetDevicePositionRequest
      * @return batchGetDevicePositionResult The response from the
@@ -205,7 +215,8 @@ BatchGetDevicePositionResult batchGetDevicePosition(
 
     /**
      * <p>
-     * A batch request for storing geofences into a given geofence collection.
+     * A batch request for storing geofence geometries into a given geofence
+     * collection.
      * </p>
      * 
      * @param batchPutGeofenceRequest
@@ -229,14 +240,15 @@ BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutGeofence
 
     /**
      * <p>
-     * Uploads a position update for one or more devices to a tracker resource.
-     * The data is used for API queries requesting the device position and
-     * position history.
+     * Uploads position update data for one or more devices to a tracker
+     * resource. Amazon Location uses the data when reporting the last known
+     * device position and position history.
      * </p>
      * <note>
      * <p>
-     * Limitation — Location data is sampled at a fixed rate of 1 position per
-     * 30 second interval, and retained for 1 year before it is deleted.
+     * Only one position update is stored per sample time. Location data is
+     * sampled at a fixed rate of one position per 30-second interval, and
+     * retained for one year before it is deleted.
      * </p>
      * </note>
      * 
@@ -609,7 +621,7 @@ DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrackerRequ
 
     /**
      * <p>
-     * Removes the association bewteen a tracker resource and a geofence
+     * Removes the association between a tracker resource and a geofence
      * collection.
      * </p>
      * <note>
@@ -643,11 +655,11 @@ DisassociateTrackerConsumerResult disassociateTrackerConsumer(
 
     /**
      * <p>
-     * Retrieves the latest device position.
+     * Retrieves a device's most recent position according to its sample time.
      * </p>
      * <note>
      * <p>
-     * Limitation — Device positions are deleted after one year.
+     * Device positions are deleted after one year.
      * </p>
      * </note>
      * 
@@ -677,7 +689,7 @@ GetDevicePositionResult getDevicePosition(GetDevicePositionRequest getDevicePosi
      * </p>
      * <note>
      * <p>
-     * Limitation — Device positions are deleted after one year.
+     * Device positions are deleted after 1 year.
      * </p>
      * </note>
      * 
@@ -987,8 +999,9 @@ ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest)
 
     /**
      * <p>
-     * Stores a geofence to a given geofence collection, or updates the geometry
-     * of an existing geofence if a geofence ID is included in the request.
+     * 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>
      * 
      * @param putGeofenceRequest

diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/AmazonLocationClient.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/AmazonLocationClient.java
@@ -355,6 +355,13 @@ private static ClientConfiguration adjustClientConfiguration(ClientConfiguration
      * resource. This allows the tracker resource to communicate location data
      * to the linked geofence collection.
      * </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>
      * 
      * @param associateTrackerConsumerRequest
      * @return associateTrackerConsumerResult The response from the
@@ -465,9 +472,17 @@ public BatchDeleteGeofenceResult batchDeleteGeofence(
 
     /**
      * <p>
-     * Used in geofence monitoring. Evaluates device positions against the
-     * position of geofences in a given geofence collection.
+     * Evaluates device positions against the geofence geometries from a given
+     * geofence collection. The evaluation determines if the device has entered
+     * or exited a geofenced area, which publishes ENTER or EXIT geofence events
+     * to Amazon EventBridge.
+     * </p>
+     * <note>
+     * <p>
+     * The last geofence that a device was observed within, if any, is tracked
+     * for 30 days after the most recent device position update
      * </p>
+     * </note>
      * 
      * @param batchEvaluateGeofencesRequest
      * @return batchEvaluateGeofencesResult The response from the
@@ -519,13 +534,8 @@ public BatchEvaluateGeofencesResult batchEvaluateGeofences(
 
     /**
      * <p>
-     * A batch request to retrieve device positions.
-     * </p>
-     * <note>
-     * <p>
-     * The response will return the device positions from the last 24 hours.
+     * A batch request to retrieve all device positions.
      * </p>
-     * </note>
      * 
      * @param batchGetDevicePositionRequest
      * @return batchGetDevicePositionResult The response from the
@@ -577,7 +587,8 @@ public BatchGetDevicePositionResult batchGetDevicePosition(
 
     /**
      * <p>
-     * A batch request for storing geofences into a given geofence collection.
+     * A batch request for storing geofence geometries into a given geofence
+     * collection.
      * </p>
      * 
      * @param batchPutGeofenceRequest
@@ -627,14 +638,15 @@ public BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutG
 
     /**
      * <p>
-     * Uploads a position update for one or more devices to a tracker resource.
-     * The data is used for API queries requesting the device position and
-     * position history.
+     * Uploads position update data for one or more devices to a tracker
+     * resource. Amazon Location uses the data when reporting the last known
+     * device position and position history.
      * </p>
      * <note>
      * <p>
-     * Limitation — Location data is sampled at a fixed rate of 1 position per
-     * 30 second interval, and retained for 1 year before it is deleted.
+     * Only one position update is stored per sample time. Location data is
+     * sampled at a fixed rate of one position per 30-second interval, and
+     * retained for one year before it is deleted.
      * </p>
      * </note>
      * 
@@ -1351,7 +1363,7 @@ public DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrac
 
     /**
      * <p>
-     * Removes the association bewteen a tracker resource and a geofence
+     * Removes the association between a tracker resource and a geofence
      * collection.
      * </p>
      * <note>
@@ -1412,11 +1424,11 @@ public DisassociateTrackerConsumerResult disassociateTrackerConsumer(
 
     /**
      * <p>
-     * Retrieves the latest device position.
+     * Retrieves a device's most recent position according to its sample time.
      * </p>
      * <note>
      * <p>
-     * Limitation — Device positions are deleted after one year.
+     * Device positions are deleted after one year.
      * </p>
      * </note>
      * 
@@ -1474,7 +1486,7 @@ public GetDevicePositionResult getDevicePosition(
      * </p>
      * <note>
      * <p>
-     * Limitation — Device positions are deleted after one year.
+     * Device positions are deleted after 1 year.
      * </p>
      * </note>
      * 
@@ -2100,8 +2112,9 @@ public ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest)
 
     /**
      * <p>
-     * Stores a geofence to a given geofence collection, or updates the geometry
-     * of an existing geofence if a geofence ID is included in the request.
+     * 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>
      * 
      * @param putGeofenceRequest

diff --git a/...ation/src/main/java/com/amazonaws/services/geo/model/AssociateTrackerConsumerRequest.java b/...ation/src/main/java/com/amazonaws/services/geo/model/AssociateTrackerConsumerRequest.java
@@ -25,6 +25,13 @@
  * This allows the tracker resource to communicate location data to the linked
  * geofence collection.
  * </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>
  */
 public class AssociateTrackerConsumerRequest extends AmazonWebServiceRequest implements
         Serializable {

diff --git a/...ocation/src/main/java/com/amazonaws/services/geo/model/BatchEvaluateGeofencesRequest.java b/...ocation/src/main/java/com/amazonaws/services/geo/model/BatchEvaluateGeofencesRequest.java
@@ -21,9 +21,17 @@
 
 /**
  * <p>
- * Used in geofence monitoring. Evaluates device positions against the position
- * of geofences in a given geofence collection.
+ * Evaluates device positions against the geofence geometries from a given
+ * geofence collection. The evaluation determines if the device has entered or
+ * exited a geofenced area, which publishes ENTER or EXIT geofence events to
+ * Amazon EventBridge.
  * </p>
+ * <note>
+ * <p>
+ * The last geofence that a device was observed within, if any, is tracked for
+ * 30 days after the most recent device position update
+ * </p>
+ * </note>
  */
 public class BatchEvaluateGeofencesRequest extends AmazonWebServiceRequest implements Serializable {
     /**

diff --git a/...ocation/src/main/java/com/amazonaws/services/geo/model/BatchGetDevicePositionRequest.java b/...ocation/src/main/java/com/amazonaws/services/geo/model/BatchGetDevicePositionRequest.java
@@ -21,13 +21,8 @@
 
 /**
  * <p>
- * A batch request to retrieve device positions.
+ * A batch request to retrieve all device positions.
  * </p>
- * <note>
- * <p>
- * The response will return the device positions from the last 24 hours.
- * </p>
- * </note>
  */
 public class BatchGetDevicePositionRequest extends AmazonWebServiceRequest implements Serializable {
     /**

diff --git a/...-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequest.java b/...-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequest.java
@@ -21,7 +21,8 @@
 
 /**
  * <p>
- * A batch request for storing geofences into a given geofence collection.
+ * A batch request for storing geofence geometries into a given geofence
+ * collection.
  * </p>
  */
 public class BatchPutGeofenceRequest extends AmazonWebServiceRequest implements Serializable {