LocationService / Client / describe_geofence_collection

describe_geofence_collection#

LocationService.Client.describe_geofence_collection(**kwargs)#

Retrieves the geofence collection details.

See also: AWS API Documentation

Request Syntax

response = client.describe_geofence_collection(
    CollectionName='string'
)
Parameters:

CollectionName (string) –

[REQUIRED]

The name of the geofence collection.

Return type:

dict

Returns:

Response Syntax

{
    'CollectionName': 'string',
    'CollectionArn': 'string',
    'Description': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'PricingPlanDataSource': 'string',
    'KmsKeyId': 'string',
    'Tags': {
        'string': 'string'
    },
    'CreateTime': datetime(2015, 1, 1),
    'UpdateTime': datetime(2015, 1, 1),
    'GeofenceCount': 123
}

Response Structure

  • (dict) –

    • CollectionName (string) –

      The name of the geofence collection.

    • 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

    • Description (string) –

      The optional description for the geofence collection.

    • PricingPlan (string) –

      No longer used. Always returns RequestBasedUsage.

    • PricingPlanDataSource (string) –

      No longer used. Always returns an empty string.

    • KmsKeyId (string) –

      A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource

    • Tags (dict) –

      Displays the key, value pairs of tags associated with this resource.

      • (string) –

        • (string) –

    • CreateTime (datetime) –

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

    • UpdateTime (datetime) –

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

    • GeofenceCount (integer) –

      The number of geofences in the geofence collection.

Exceptions

  • LocationService.Client.exceptions.InternalServerException

  • LocationService.Client.exceptions.ResourceNotFoundException

  • LocationService.Client.exceptions.AccessDeniedException

  • LocationService.Client.exceptions.ValidationException

  • LocationService.Client.exceptions.ThrottlingException