:doc:`DataZone <../../datazone>` / Client / list_project_memberships

************************
list_project_memberships
************************



.. py:method:: DataZone.Client.list_project_memberships(**kwargs)

  

  Lists all members of the specified project.

  

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


  **Request Syntax**
  ::

    response = client.list_project_memberships(
        domainIdentifier='string',
        projectIdentifier='string',
        sortBy='NAME',
        sortOrder='ASCENDING'|'DESCENDING',
        nextToken='string',
        maxResults=123
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

    The identifier of the Amazon DataZone domain in which you want to list project memberships.

    

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

    The identifier of the project whose memberships you want to list.

    

  
  :type sortBy: string
  :param sortBy: 

    The method by which you want to sort the project memberships.

    

  
  :type sortOrder: string
  :param sortOrder: 

    The sort order of the project memberships.

    

  
  :type nextToken: string
  :param nextToken: 

    When the number of memberships is greater than the default value for the ``MaxResults`` parameter, or if you explicitly specify a value for ``MaxResults`` that is less than the number of memberships, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListProjectMemberships`` to list the next set of memberships.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of memberships to return in a single call to ``ListProjectMemberships``. When the number of memberships to be listed is greater than the value of ``MaxResults``, the response contains a ``NextToken`` value that you can use in a subsequent call to ``ListProjectMemberships`` to list the next set of memberships.

    

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

    
    ::

      {
          'members': [
              {
                  'memberDetails': {
                      'user': {
                          'userId': 'string'
                      },
                      'group': {
                          'groupId': 'string'
                      }
                  },
                  'designation': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_CATALOG_VIEWER'|'PROJECT_CATALOG_CONSUMER'|'PROJECT_CATALOG_STEWARD'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **members** *(list) --* 

        The members of the project.

        
        

        - *(dict) --* 

          The details of a project member.

          
          

          - **memberDetails** *(dict) --* 

            The membership details of a project member.

            .. 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) --* 

              The user details of a project member.

              
              

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

                The identifier of the Amazon DataZone user.

                
          
            

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

              The group details of a project member.

              
              

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

                The identifier of the group in Amazon DataZone.

                
          
        
          

          - **designation** *(string) --* 

            The designated role of a project member.

            
      
    
      

      - **nextToken** *(string) --* 

        When the number of memberships is greater than the default value for the ``MaxResults`` parameter, or if you explicitly specify a value for ``MaxResults`` that is less than the number of memberships, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListProjectMemberships`` to list the next set of memberships.

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

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

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

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

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

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  