:doc:`Rekognition <../../rekognition>` / Client / describe_collection

*******************
describe_collection
*******************



.. py:method:: Rekognition.Client.describe_collection(**kwargs)

  

  Describes the specified collection. You can use ``DescribeCollection`` to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.

   

  For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rekognition-2016-06-27/DescribeCollection>`_  


  **Request Syntax**
  ::

    response = client.describe_collection(
        CollectionId='string'
    )
    
  :type CollectionId: string
  :param CollectionId: **[REQUIRED]** 

    The ID of the collection to describe.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'FaceCount': 123,
          'FaceModelVersion': 'string',
          'CollectionARN': 'string',
          'CreationTimestamp': datetime(2015, 1, 1),
          'UserCount': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **FaceCount** *(integer) --* 

        The number of faces that are indexed into the collection. To index faces into a collection, use  IndexFaces.

        
      

      - **FaceModelVersion** *(string) --* 

        The version of the face model that's used by the collection for face detection.

         

        For more information, see Model versioning in the Amazon Rekognition Developer Guide.

        
      

      - **CollectionARN** *(string) --* 

        The Amazon Resource Name (ARN) of the collection.

        
      

      - **CreationTimestamp** *(datetime) --* 

        The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

        
      

      - **UserCount** *(integer) --* 

        The number of UserIDs assigned to the specified colleciton.

        
  
  **Exceptions**
  
  *   :py:class:`Rekognition.Client.exceptions.InvalidParameterException`

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

  
  *   :py:class:`Rekognition.Client.exceptions.InternalServerError`

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

  
  *   :py:class:`Rekognition.Client.exceptions.ProvisionedThroughputExceededException`

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

  