LocationService / Client / get_geofence

get_geofence#

LocationService.Client.get_geofence(**kwargs)#

Retrieves the geofence details from a geofence collection.

Request Syntax

response = client.get_geofence(
    CollectionName='string',
    GeofenceId='string'
)

Parameters:

CollectionName (string) –
[REQUIRED]

The geofence collection storing the target geofence.
GeofenceId (string) –
[REQUIRED]

The geofence you’re retrieving details for.

Return type:

dict

Returns:

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'GeofenceId': 'string',
    'GeofenceProperties': {
        'string': 'string'
    },
    'Geometry': {
        'Circle': {
            'Center': [
                123.0,
            ],
            'Radius': 123.0
        },
        'Polygon': [
            [
                [
                    123.0,
                ],
            ],
        ]
    },
    'Status': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- CreateTime (datetime) –
  
  The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
- GeofenceId (string) –
  
  The geofence identifier.
- GeofenceProperties (dict) –
  
  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"
  - (string) –
    - (string) –
- Geometry (dict) –
  
  Contains the geofence geometry details describing a polygon or a circle.
  - Circle (dict) –
    
    A circle on the earth, as defined by a center point and a radius.
    - Center (list) –
      
      A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude].
      - (float) –
    - Radius (float) –
      
      The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).
  - Polygon (list) –
    
    A polygon is a list of linear rings which are each made up of a list of vertices.
    
    Each vertex is a 2-dimensional point of the form: [longitude, latitude]. This is represented as an array of doubles of length 2 (so [double, double]).
    
    An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ( [[double, double], ...]).
    
    A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ( [[[double, double], ...], ...]).
    
    A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
    - (list) –
      - (list) –
        
        (float) –
- Status (string) –
  
  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.
- UpdateTime (datetime) –
  
  The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.ResourceNotFoundException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException