Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458290352.8 KB

Retrieves the geofence collection details.

get/geofencing/v0/collections/{CollectionName}

Path parameters

CollectionNamestring required

The name of the geofence collection.

Response

Success

CollectionArnstring required
<p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services. </p> <ul> <li> <p>Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code> </p> </li> </ul>
CollectionNamestring required

The name of the geofence collection.

CreateTimestring date-time required

The timestamp for when the geofence resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>

Descriptionstring required

The optional description for the geofence collection.

KmsKeyIdstring

A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a> assigned to the Amazon Location resource

PricingPlan'RequestBasedUsage' | 'MobileAssetTracking' | 'MobileAssetManagement'

No longer used. Always returns <code>RequestBasedUsage</code>.Deprecated. Always returns RequestBasedUsage.

PricingPlanDataSourcestring

No longer used. Always returns an empty string.Deprecated. Unused.

Tagsobject

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

UpdateTimestring date-time required

The timestamp for when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>