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

DescribeGeofenceCollection

Retrieves the geofence collection details.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

CollectionName

The name of the geofence collection.

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

Pattern: [-._\w]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CollectionArn": "string",
   "CollectionName": "string",
   "CreateTime": "string",
   "Description": "string",
   "GeofenceCount": number,
   "KmsKeyId": "string",
   "PricingPlan": "string",
   "PricingPlanDataSource": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UpdateTime": "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.

CollectionArn

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

Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

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 of the geofence collection.

Type: String

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

Pattern: [-._\w]+

CreateTime

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

Type: Timestamp

Description

The optional description for the geofence collection.

Type: String

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

GeofenceCount

The number of geofences in the geofence collection.

Type: Integer

Valid Range: Minimum value of 0.

KmsKeyId

A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource

Type: String

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

PricingPlan

This parameter has been deprecated.

No longer used. Always returns RequestBasedUsage.

Type: String

Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement

PricingPlanDataSource

This parameter has been deprecated.

No longer used. Always returns an empty string.

Type: String

Tags

Displays the key, value pairs of tags associated with this resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

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 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