:doc:`Glue <../../glue>` / Paginator / ListEntities

************
ListEntities
************



.. py:class:: Glue.Paginator.ListEntities

  ::

    
    paginator = client.get_paginator('list_entities')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Glue.Client.list_entities`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ConnectionName='string',
          CatalogId='string',
          ParentEntityName='string',
          DataStoreApiVersion='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': '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 DataStoreApiVersion: string
    :param DataStoreApiVersion: 

      The API version of the SaaS connector.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Entities': [
                {
                    'EntityName': 'string',
                    'Label': 'string',
                    'IsParentEntity': True|False,
                    'Description': 'string',
                    'Category': 'string',
                    'CustomProperties': {
                        'string': '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) --* 
          
        
        
      
    