update_geofence_collection

LocationService.Client.update_geofence_collection(**kwargs)

Updates the specified properties of a given geofence collection.

See also: AWS API Documentation

Request Syntax

response = client.update_geofence_collection(
    CollectionName='string',
    Description='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string'
)
Parameters
  • CollectionName (string) --

    [REQUIRED]

    The name of the geofence collection to update.

  • Description (string) -- Updates the description for the geofence collection.
  • PricingPlan (string) -- No longer used. If included, the only allowed value is RequestBasedUsage .
  • PricingPlanDataSource (string) -- This parameter is no longer used.
Return type

dict

Returns

Response Syntax

{
    'CollectionArn': 'string',
    'CollectionName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • CollectionArn (string) --

      The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across Amazon Web Services.

      • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection
    • CollectionName (string) --

      The name of the updated geofence collection.

    • UpdateTime (datetime) --

      The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

  • LocationService.Client.exceptions.InternalServerException
  • LocationService.Client.exceptions.ResourceNotFoundException
  • LocationService.Client.exceptions.AccessDeniedException
  • LocationService.Client.exceptions.ValidationException
  • LocationService.Client.exceptions.ThrottlingException