Amazon Location Service

{'MaxResults': 'integer'}

Lists geofences stored in a given geofence collection.

See also: AWS API Documentation

Request Syntax

client.list_geofences(
    CollectionName='string',
    MaxResults=123,
    NextToken='string'
)

type CollectionName

string

param CollectionName

[REQUIRED]

The name of the geofence collection storing the list of geofences.

type MaxResults

integer

param MaxResults

An optional limit for the number of geofences returned in a single call.

Default value: 100

type NextToken

string

param NextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

rtype

dict

returns

Response Syntax

{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'GeofenceId': 'string',
            'Geometry': {
                'Polygon': [
                    [
                        [
                            123.0,
                        ],
                    ],
                ]
            },
            'Status': 'string',
            'UpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Entries (list) --

    Contains a list of geofences stored in the geofence collection.

    • (dict) --

      Contains a list of geofences stored in a given geofence collection.

      • CreateTime (datetime) --

        The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

      • GeofenceId (string) --

        The geofence identifier.

      • Geometry (dict) --

        Contains the geofence geometry details describing a polygon.

        • Polygon (list) --

          An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude] .

          The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

          • (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 was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

  • NextToken (string) --

    A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.