- 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.
UpdateGeofenceCollectionCommand
Updates the specified properties of a given geofence collection.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LocationClient, UpdateGeofenceCollectionCommand } from "@aws-sdk/client-location"; // ES Modules import
// const { LocationClient, UpdateGeofenceCollectionCommand } = require("@aws-sdk/client-location"); // CommonJS import
const client = new LocationClient(config);
const input = { // UpdateGeofenceCollectionRequest
CollectionName: "STRING_VALUE", // required
PricingPlan: "STRING_VALUE",
PricingPlanDataSource: "STRING_VALUE",
Description: "STRING_VALUE",
};
const command = new UpdateGeofenceCollectionCommand(input);
const response = await client.send(command);
// { // UpdateGeofenceCollectionResponse
// CollectionName: "STRING_VALUE", // required
// CollectionArn: "STRING_VALUE", // required
// UpdateTime: new Date("TIMESTAMP"), // required
// };
UpdateGeofenceCollectionCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
CollectionNameRequired | string | undefined | The name of the geofence collection to update. |
Description | string | undefined | Updates the description for the geofence collection. |
PricingPlan | PricingPlan | undefined | No longer used. If included, the only allowed value is |
PricingPlanDataSource | string | undefined | This parameter is no longer used. |
UpdateGeofenceCollectionCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
CollectionArnRequired | string | undefined | The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across Amazon Web Services.
|
CollectionNameRequired | string | undefined | The name of the updated geofence collection. |
UpdateTimeRequired | Date | undefined | The time when the geofence collection was last updated in ISO 8601 format: |
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. |