create_geofence_collection

LocationService.Client.create_geofence_collection(**kwargs)

Creates a geofence collection, which manages and stores geofences.

See also: AWS API Documentation

Request Syntax

response = client.create_geofence_collection(
    CollectionName='string',
    Description='string',
    KmsKeyId='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string',
    Tags={
        'string': 'string'
    }
)

Parameters

• CollectionName (string) --

  [REQUIRED]

  A custom name for the geofence collection.

  Requirements:

  • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
  • Must be a unique geofence collection name.
  • No spaces allowed. For example, ExampleGeofenceCollection .
• Description (string) -- An optional description for the geofence collection.
• KmsKeyId (string) -- A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
• PricingPlan (string) -- No longer used. If included, the only allowed value is RequestBasedUsage .
• PricingPlanDataSource (string) -- This parameter is no longer used.
• Tags (dict) --

  Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

  Format: "key" : "value"

  Restrictions:

  • Maximum 50 tags per resource
  • Each resource tag must be unique with a maximum of one value.
  • Maximum key length: 128 Unicode characters in UTF-8
  • Maximum value length: 256 Unicode characters in UTF-8
  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
  • Cannot use "aws:" as a prefix for a key.
  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • CollectionArn (string) --

    The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.

    • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

  • CollectionName (string) --

    The name for the geofence collection.

  • CreateTime (datetime) --

    The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Exceptions

• LocationService.Client.exceptions.InternalServerException
• LocationService.Client.exceptions.ConflictException
• LocationService.Client.exceptions.AccessDeniedException
• LocationService.Client.exceptions.ValidationException
• LocationService.Client.exceptions.ServiceQuotaExceededException
• LocationService.Client.exceptions.ThrottlingException