ListGeofenceResponseEntry
Contains a list of geofences stored in a given geofence collection.
Note
The returned geometry will always match the geometry format used when the geofence was created.
Contents
- CreateTime
-
The timestamp for when the geofence was stored in a geofence collection in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssType: Timestamp
Required: Yes
- GeofenceId
-
The geofence identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-._\p{L}\p{N}]+Required: Yes
- Geometry
-
Contains the geofence geometry details describing a polygon or a circle.
Type: GeofenceGeometry object
Required: Yes
- Status
-
Identifies the state of the geofence. A geofence will hold one of the following states:
-
ACTIVE— The geofence has been indexed by the system. -
PENDING— The geofence is being processed by the system. -
FAILED— The geofence failed to be indexed by the system. -
DELETED— The geofence has been deleted from the system index. -
DELETING— The geofence is being deleted from the system index.
Type: String
Required: Yes
-
- UpdateTime
-
The timestamp for when the geofence was last updated in ISO 8601
format: YYYY-MM-DDThh:mm:ss.sssType: Timestamp
Required: Yes
- GeofenceProperties
-
User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.
Format:
"key" : "value"Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 3 items.
Key Length Constraints: Minimum length of 1. Maximum length of 20.
Value Length Constraints: Minimum length of 1. Maximum length of 40.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
