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

UpdateGeofenceCollection

Updates the specified properties of a given geofence collection.

Request Syntax


PATCH /geofencing/v0/collections/CollectionName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "PricingPlan": "string",
   "PricingPlanDataSource": "string"
}

URI Request Parameters

The request uses the following URI parameters.

CollectionName

The name of the geofence collection to update.

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

Pattern: [-._\w]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

Updates the description for the geofence collection.

Type: String

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

Required: No

PricingPlan

This parameter has been deprecated.

No longer used. If included, the only allowed value is RequestBasedUsage.

Type: String

Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement

Required: No

PricingPlanDataSource

This parameter has been deprecated.

This parameter is no longer used.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CollectionArn": "string",
   "CollectionName": "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) of the updated geofence collection. Used to specify a resource across 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 updated geofence collection.

Type: String

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

Pattern: [-._\w]+

UpdateTime

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