:doc:`Glue <../../glue>` / Client / list_entities

*************
list_entities
*************



.. py:method:: Glue.Client.list_entities(**kwargs)

  

  Returns the available entities supported by the connection type.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/ListEntities>`_  


  **Request Syntax**
  ::

    response = client.list_entities(
        ConnectionName='string',
        CatalogId='string',
        ParentEntityName='string',
        NextToken='string',
        DataStoreApiVersion='string'
    )
    
  :type ConnectionName: string
  :param ConnectionName: 

    A name for the connection that has required credentials to query any connection type.

    

  
  :type CatalogId: string
  :param CatalogId: 

    The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

    

  
  :type ParentEntityName: string
  :param ParentEntityName: 

    Name of the parent entity for which you want to list the children. This parameter takes a fully-qualified path of the entity in order to list the child entities.

    

  
  :type NextToken: string
  :param NextToken: 

    A continuation token, included if this is a continuation call.

    

  
  :type DataStoreApiVersion: string
  :param DataStoreApiVersion: 

    The API version of the SaaS connector.

    

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

    
    ::

      {
          'Entities': [
              {
                  'EntityName': 'string',
                  'Label': 'string',
                  'IsParentEntity': True|False,
                  'Description': 'string',
                  'Category': 'string',
                  'CustomProperties': {
                      'string': 'string'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Entities** *(list) --* 

        A list of ``Entity`` objects.

        
        

        - *(dict) --* 

          An entity supported by a given ``ConnectionType``.

          
          

          - **EntityName** *(string) --* 

            The name of the entity.

            
          

          - **Label** *(string) --* 

            Label used for the entity.

            
          

          - **IsParentEntity** *(boolean) --* 

            A Boolean value which helps to determine whether there are sub objects that can be listed.

            
          

          - **Description** *(string) --* 

            A description of the entity.

            
          

          - **Category** *(string) --* 

            The type of entities that are present in the response. This value depends on the source connection. For example this is ``SObjects`` for Salesforce and ``databases`` or ``schemas`` or ``tables`` for sources like Amazon Redshift.

            
          

          - **CustomProperties** *(dict) --* 

            An optional map of keys which may be returned for an entity by a connector.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

      - **NextToken** *(string) --* 

        A continuation token, present if the current segment is not the last.

        
  
  **Exceptions**
  
  *   :py:class:`Glue.Client.exceptions.EntityNotFoundException`

  
  *   :py:class:`Glue.Client.exceptions.OperationTimeoutException`

  
  *   :py:class:`Glue.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Glue.Client.exceptions.GlueEncryptionException`

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

  
  *   :py:class:`Glue.Client.exceptions.FederationSourceException`

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

  