:doc:`DataZone <../../datazone>` / Paginator / ListEntityOwners

****************
ListEntityOwners
****************



.. py:class:: DataZone.Paginator.ListEntityOwners

  ::

    
    paginator = client.get_paginator('list_entity_owners')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DataZone.Client.list_entity_owners`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListEntityOwners>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domainIdentifier='string',
          entityType='DOMAIN_UNIT',
          entityIdentifier='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domainIdentifier: string
    :param domainIdentifier: **[REQUIRED]** 

      The ID of the domain where you want to list entity owners.

      

    
    :type entityType: string
    :param entityType: **[REQUIRED]** 

      The type of the entity that you want to list.

      

    
    :type entityIdentifier: string
    :param entityIdentifier: **[REQUIRED]** 

      The ID of the entity that you want to list.

      

    
    :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.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

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

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

        

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

      
      ::

        {
            'owners': [
                {
                    'user': {
                        'userId': 'string'
                    },
                    'group': {
                        'groupId': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **owners** *(list) --* 

          The owners of the entity.

          
          

          - *(dict) --* 

            The ID of the domain unit owners group.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``user``, ``group``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **user** *(dict) --* 

              Specifies that the domain unit owner is a user.

              
              

              - **userId** *(string) --* 

                The ID of the owner user.

                
          
            

            - **group** *(dict) --* 

              Specifies that the domain unit owner is a group.

              
              

              - **groupId** *(string) --* 

                The ID of the domain unit owners group.

                
          
        
      
        

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

          A token to resume pagination.

          
    