:doc:`LocationService <../../location>` / Client / describe_geofence_collection

****************************
describe_geofence_collection
****************************



.. py:method:: LocationService.Client.describe_geofence_collection(**kwargs)

  

  Retrieves the geofence collection details.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollection>`_  


  **Request Syntax**
  ::

    response = client.describe_geofence_collection(
        CollectionName='string'
    )
    
  :type CollectionName: string
  :param CollectionName: **[REQUIRED]** 

    The name of the geofence collection.

    

  
  
  :rtype: 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 <https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html>`__ 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 <https://www.iso.org/iso-8601-date-and-time-format.html>`__ format: ``YYYY-MM-DDThh:mm:ss.sssZ``

        
      

      - **UpdateTime** *(datetime) --* 

        The timestamp for when the geofence collection was last updated in `ISO 8601 <https://www.iso.org/iso-8601-date-and-time-format.html>`__ format: ``YYYY-MM-DDThh:mm:ss.sssZ``

        
      

      - **GeofenceCount** *(integer) --* 

        The number of geofences in the geofence collection.

        
  
  **Exceptions**
  
  *   :py:class:`LocationService.Client.exceptions.InternalServerException`

  
  *   :py:class:`LocationService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`LocationService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`LocationService.Client.exceptions.ValidationException`

  
  *   :py:class:`LocationService.Client.exceptions.ThrottlingException`

  