- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteGeofenceCollectionCommand
Deletes a geofence collection from your Amazon Web Services account.
This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LocationClient, DeleteGeofenceCollectionCommand } from "@aws-sdk/client-location"; // ES Modules import
// const { LocationClient, DeleteGeofenceCollectionCommand } = require("@aws-sdk/client-location"); // CommonJS import
const client = new LocationClient(config);
const input = { // DeleteGeofenceCollectionRequest
CollectionName: "STRING_VALUE", // required
};
const command = new DeleteGeofenceCollectionCommand(input);
const response = await client.send(command);
// {};
DeleteGeofenceCollectionCommand Input
See DeleteGeofenceCollectionCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
CollectionNameRequired | string | undefined | The name of the geofence collection to be deleted. |
DeleteGeofenceCollectionCommand Output
See DeleteGeofenceCollectionCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions. |
| InternalServerException | server | The request has failed to process because of an unknown server error, exception, or failure. |
| ResourceNotFoundException | client | The resource that you've entered was not found in your AWS account. |
| ThrottlingException | client | The request was denied because of request throttling. |
| ValidationException | client | The input failed to meet the constraints specified by the AWS service. |
| LocationServiceException | Base exception class for all service exceptions from Location service. |