GetGeofence - Amazon Location Service Geofences

GetGeofence

Retrieves the geofence details from a geofence collection.

Request Syntax

GET /geofencing/v0/collections/CollectionName/geofences/GeofenceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CollectionName

The geofence collection storing the target geofence.

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

Pattern: ^[-._\w]+$

Required: Yes

GeofenceId

The geofence you're retrieving details for.

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

Pattern: ^[-._\p{L}\p{N}]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CreateTime": number, "GeofenceId": "string", "Geometry": { "Polygon": [ [ [ number ] ] ] }, "Status": "string", "UpdateTime": number }

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.

CreateTime

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

Type: Timestamp

GeofenceId

The geofence identifier.

Type: String

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

Pattern: ^[-._\p{L}\p{N}]+$

Geometry

Contains the geofence geometry details describing a polygon.

Type: GeofenceGeometry object

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

UpdateTime

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

Type: Timestamp

Errors

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

AccessDeniedException

The request was denied due to insufficient access or permission. 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 due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: