Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListGeofences

Lists geofences stored in a given geofence collection.

Request Syntax


POST /geofencing/v0/collections/CollectionName/list-geofences HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

CollectionName

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

MaxResults

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

Default value: 100

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60000.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Entries": [ 
      { 
         "CreateTime": "string",
         "GeofenceId": "string",
         "GeofenceProperties": { 
            "string" : "string" 
         },
         "Geometry": { 
            "Circle": { 
               "Center": [ number ],
               "Radius": number
            },
            "Geobuf": blob,
            "Polygon": [ 
               [ 
                  [ number ]
               ]
            ]
         },
         "Status": "string",
         "UpdateTime": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Entries

Contains a list of geofences stored in the geofence collection.

Type: Array of ListGeofenceResponseEntry objects

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60000.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400