DataZone / Paginator / ListProjectMemberships

ListProjectMemberships

class DataZone.Paginator.ListProjectMemberships

paginator = client.get_paginator('list_project_memberships')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataZone.Client.list_project_memberships().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    projectIdentifier='string',
    sortBy='NAME',
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain in which you want to list project 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.

• PaginationConfig (dict) –

  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.

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) –

    A token to resume pagination.