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 index 1016d34661..42b7c7c1b1 100644 --- 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. *

+ * + *

+ * Currently not supported — Cross-account configurations, such as creating + * associations between a tracker resource in one account and a geofence + * collection in another account. + *

+ *
* * @param associateTrackerConsumerRequest * @return associateTrackerConsumerResult The response from the @@ -147,9 +154,17 @@ BatchDeleteGeofenceResult batchDeleteGeofence( /** *

- * 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. + *

+ * + *

+ * The last geofence that a device was observed within, if any, is tracked + * for 30 days after the most recent device position update *

+ *
* * @param batchEvaluateGeofencesRequest * @return batchEvaluateGeofencesResult The response from the @@ -174,13 +189,8 @@ BatchEvaluateGeofencesResult batchEvaluateGeofences( /** *

- * A batch request to retrieve device positions. - *

- * - *

- * The response will return the device positions from the last 24 hours. + * A batch request to retrieve all device positions. *

- *
* * @param batchGetDevicePositionRequest * @return batchGetDevicePositionResult The response from the @@ -205,7 +215,8 @@ BatchGetDevicePositionResult batchGetDevicePosition( /** *

- * A batch request for storing geofences into a given geofence collection. + * A batch request for storing geofence geometries into a given geofence + * collection. *

* * @param batchPutGeofenceRequest @@ -229,14 +240,15 @@ BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutGeofence /** *

- * 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. *

* *

- * 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. *

*
* @@ -609,7 +621,7 @@ DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrackerRequ /** *

- * Removes the association bewteen a tracker resource and a geofence + * Removes the association between a tracker resource and a geofence * collection. *

* @@ -643,11 +655,11 @@ DisassociateTrackerConsumerResult disassociateTrackerConsumer( /** *

- * Retrieves the latest device position. + * Retrieves a device's most recent position according to its sample time. *

* *

- * Limitation — Device positions are deleted after one year. + * Device positions are deleted after one year. *

*
* @@ -677,7 +689,7 @@ GetDevicePositionResult getDevicePosition(GetDevicePositionRequest getDevicePosi *

* *

- * Limitation — Device positions are deleted after one year. + * Device positions are deleted after 1 year. *

*
* @@ -987,8 +999,9 @@ ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest) /** *

- * 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. *

* * @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 index 95021b1cff..a314bb7a50 100644 --- 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. *

+ * + *

+ * Currently not supported — Cross-account configurations, such as creating + * associations between a tracker resource in one account and a geofence + * collection in another account. + *

+ *
* * @param associateTrackerConsumerRequest * @return associateTrackerConsumerResult The response from the @@ -465,9 +472,17 @@ public BatchDeleteGeofenceResult batchDeleteGeofence( /** *

- * 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. + *

+ * + *

+ * The last geofence that a device was observed within, if any, is tracked + * for 30 days after the most recent device position update *

+ *
* * @param batchEvaluateGeofencesRequest * @return batchEvaluateGeofencesResult The response from the @@ -519,13 +534,8 @@ public BatchEvaluateGeofencesResult batchEvaluateGeofences( /** *

- * A batch request to retrieve device positions. - *

- * - *

- * The response will return the device positions from the last 24 hours. + * A batch request to retrieve all device positions. *

- *
* * @param batchGetDevicePositionRequest * @return batchGetDevicePositionResult The response from the @@ -577,7 +587,8 @@ public BatchGetDevicePositionResult batchGetDevicePosition( /** *

- * A batch request for storing geofences into a given geofence collection. + * A batch request for storing geofence geometries into a given geofence + * collection. *

* * @param batchPutGeofenceRequest @@ -627,14 +638,15 @@ public BatchPutGeofenceResult batchPutGeofence(BatchPutGeofenceRequest batchPutG /** *

- * 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. *

* *

- * 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. *

*
* @@ -1351,7 +1363,7 @@ public DescribeTrackerResult describeTracker(DescribeTrackerRequest describeTrac /** *

- * Removes the association bewteen a tracker resource and a geofence + * Removes the association between a tracker resource and a geofence * collection. *

* @@ -1412,11 +1424,11 @@ public DisassociateTrackerConsumerResult disassociateTrackerConsumer( /** *

- * Retrieves the latest device position. + * Retrieves a device's most recent position according to its sample time. *

* *

- * Limitation — Device positions are deleted after one year. + * Device positions are deleted after one year. *

*
* @@ -1474,7 +1486,7 @@ public GetDevicePositionResult getDevicePosition( *

* *

- * Limitation — Device positions are deleted after one year. + * Device positions are deleted after 1 year. *

*
* @@ -2100,8 +2112,9 @@ public ListTrackersResult listTrackers(ListTrackersRequest listTrackersRequest) /** *

- * 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. *

* * @param putGeofenceRequest diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/AssociateTrackerConsumerRequest.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/AssociateTrackerConsumerRequest.java index ed16f9248a..9fba8c4bcb 100644 --- a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/AssociateTrackerConsumerRequest.java +++ b/aws-android-sdk-location/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. *

+ * + *

+ * Currently not supported — Cross-account configurations, such as creating + * associations between a tracker resource in one account and a geofence + * collection in another account. + *

+ *
*/ public class AssociateTrackerConsumerRequest extends AmazonWebServiceRequest implements Serializable { diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchEvaluateGeofencesRequest.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchEvaluateGeofencesRequest.java index 920c5517e8..d93858d478 100644 --- a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchEvaluateGeofencesRequest.java +++ b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchEvaluateGeofencesRequest.java @@ -21,9 +21,17 @@ /** *

- * 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. *

+ * + *

+ * The last geofence that a device was observed within, if any, is tracked for + * 30 days after the most recent device position update + *

+ *
*/ public class BatchEvaluateGeofencesRequest extends AmazonWebServiceRequest implements Serializable { /** diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchGetDevicePositionRequest.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchGetDevicePositionRequest.java index b4329edad4..79d3dc9dc2 100644 --- a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchGetDevicePositionRequest.java +++ b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchGetDevicePositionRequest.java @@ -21,13 +21,8 @@ /** *

- * A batch request to retrieve device positions. + * A batch request to retrieve all device positions. *

- * - *

- * The response will return the device positions from the last 24 hours. - *

- *
*/ public class BatchGetDevicePositionRequest extends AmazonWebServiceRequest implements Serializable { /** diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequest.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequest.java index 2a5dab2996..9ee09da12b 100644 --- a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequest.java +++ b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequest.java @@ -21,7 +21,8 @@ /** *

- * A batch request for storing geofences into a given geofence collection. + * A batch request for storing geofence geometries into a given geofence + * collection. *

*/ public class BatchPutGeofenceRequest extends AmazonWebServiceRequest implements Serializable { diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequestEntry.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequestEntry.java index 272b8d4399..e599605953 100644 --- a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequestEntry.java +++ b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequestEntry.java @@ -19,7 +19,7 @@ /** *

- * Contains geofence details. + * Contains geofence geometry details. *

*/ public class BatchPutGeofenceRequestEntry implements Serializable { @@ -37,8 +37,15 @@ public class BatchPutGeofenceRequestEntry implements Serializable { /** *

- * The geometry details for the geofence. + * Contains the polygon details to specify the position of the geofence. *

+ * + *

+ * Each geofence polygon can have a maximum of 1,000 vertices. + *

+ *
*/ private GeofenceGeometry geometry; @@ -107,12 +114,27 @@ public BatchPutGeofenceRequestEntry withGeofenceId(String geofenceId) { /** *

- * The geometry details for the geofence. + * Contains the polygon details to specify the position of the geofence. + *

+ * + *

+ * Each geofence polygon can have a maximum of 1,000 vertices. *

+ *
* * @return

- * The geometry details for the geofence. + * Contains the polygon details to specify the position of the + * geofence. + *

+ * + *

+ * Each geofence polygon can have a maximum of 1,000 vertices. *

+ *
*/ public GeofenceGeometry getGeometry() { return geometry; @@ -120,12 +142,27 @@ public GeofenceGeometry getGeometry() { /** *

- * The geometry details for the geofence. + * Contains the polygon details to specify the position of the geofence. *

+ * + *

+ * Each geofence polygon can have a maximum of 1,000 vertices. + *

+ *
* * @param geometry

- * The geometry details for the geofence. + * Contains the polygon details to specify the position of the + * geofence. + *

+ * + *

+ * Each geofence polygon can have a maximum of 1,000 vertices. *

+ *
*/ public void setGeometry(GeofenceGeometry geometry) { this.geometry = geometry; @@ -133,15 +170,30 @@ public void setGeometry(GeofenceGeometry geometry) { /** *

- * The geometry details for the geofence. + * Contains the polygon details to specify the position of the geofence. *

+ * + *

+ * Each geofence polygon can have a maximum of 1,000 vertices. + *

+ *
*

* Returns a reference to this object so that method calls can be chained * together. * * @param geometry

- * The geometry details for the geofence. + * Contains the polygon details to specify the position of the + * geofence. + *

+ * + *

+ * Each geofence polygon can have a maximum of 1,000 vertices. *

+ *
* @return A reference to this updated object so that method calls can be * chained together. */ diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchUpdateDevicePositionError.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchUpdateDevicePositionError.java index cd721d206f..0738e4f63a 100644 --- a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchUpdateDevicePositionError.java +++ b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchUpdateDevicePositionError.java @@ -44,7 +44,7 @@ public class BatchUpdateDevicePositionError implements Serializable { /** *

- * The timestamp for when a position sample was attempted in ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. *

@@ -161,14 +161,14 @@ public BatchUpdateDevicePositionError withError(BatchItemError error) { /** *

- * The timestamp for when a position sample was attempted in ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. *

* * @return

- * The timestamp for when a position sample was attempted in + * The timestamp at which the device position was determined. Uses + * * ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. *

*/ @@ -178,15 +178,16 @@ public java.util.Date getSampleTime() { /** *

- * The timestamp for when a position sample was attempted in ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. *

* * @param sampleTime

- * The timestamp for when a position sample was attempted in - * ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. + * The timestamp at which the device position was determined. + * Uses ISO + * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. *

*/ public void setSampleTime(java.util.Date sampleTime) { @@ -195,7 +196,7 @@ public void setSampleTime(java.util.Date sampleTime) { /** *

- * The timestamp for when a position sample was attempted in ISO * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. *

@@ -204,9 +205,10 @@ public void setSampleTime(java.util.Date sampleTime) { * together. * * @param sampleTime

- * The timestamp for when a position sample was attempted in - * ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. + * The timestamp at which the device position was determined. + * Uses ISO + * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. *

* @return A reference to this updated object so that method calls can be * chained together. diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchUpdateDevicePositionRequest.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchUpdateDevicePositionRequest.java index 5243532e4a..d93edfc76a 100644 --- a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchUpdateDevicePositionRequest.java +++ b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchUpdateDevicePositionRequest.java @@ -21,14 +21,15 @@ /** *

- * 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. *

* *

- * 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. *

*
*/ diff --git a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/CreateGeofenceCollectionRequest.java b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/CreateGeofenceCollectionRequest.java index bbe7044f72..fa6415be2c 100644 --- a/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/CreateGeofenceCollectionRequest.java +++ b/aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/CreateGeofenceCollectionRequest.java @@ -36,8 +36,8 @@ public class CreateGeofenceCollectionRequest extends AmazonWebServiceRequest imp *