CreateGeofenceCollection - Amazon Location Service Geofences

CreateGeofenceCollection

Creates a geofence collection, which manages and stores geofences.

Request Syntax

POST /geofencing/v0/collections HTTP/1.1 Content-type: application/json { "CollectionName": "string", "Description": "string", "PricingPlan": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

CollectionName

A custom name for the geofence collection.

Requirements:

  • Contain only alphanumeric characters (A–Z, a–z, 0-9), hyphens (-), and underscores (_).

  • Must be a unique geofence collection name.

  • No spaces allowed. For example, ExampleGeofenceCollection.

Type: String

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

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

Required: Yes

Description

An optional description for the geofence collection.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: No

PricingPlan

Specifies the pricing plan for your geofence collection. There's three pricing plan options:

  • RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

  • MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

  • MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Type: String

Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CollectionArn": "string", "CollectionName": "string", "CreateTime": 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.

CollectionArn

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$

CollectionName

The name for the geofence collection.

Type: String

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

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

CreateTime

The timestamp for when the geofence collection was created 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

ConflictException

The request was unsuccessful due to a conflict.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

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: