DataZone / Client / list_project_memberships

list_project_memberships#

DataZone.Client.list_project_memberships(**kwargs)#

Lists all members of the specified project.

See also: AWS API Documentation

Request Syntax

response = client.list_project_memberships(
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    projectIdentifier='string',
    sortBy='NAME',
    sortOrder='ASCENDING'|'DESCENDING'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

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

  • maxResults (integer) – 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.

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

  • projectIdentifier (string) –

    [REQUIRED]

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

  • sortBy (string) – The method by which you want to sort the project memberships.

  • sortOrder (string) – The sort order of the project memberships.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • members (list) –

      The members of the project.

      • (dict) –

        The details of a project member.

        • designation (string) –

          The designated role 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: group, user. 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'}

          • group (dict) –

            The group details of a project member.

            • groupId (string) –

              The identifier of the group in Amazon DataZone.

          • user (dict) –

            The user details of a project member.

            • userId (string) –

              The identifier of the Amazon DataZone user.

    • 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