DataZone / Paginator / ListEntityOwners

ListEntityOwners

class DataZone.Paginator.ListEntityOwners

paginator = client.get_paginator('list_entity_owners')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    entityIdentifier='string',
    entityType='DOMAIN_UNIT',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• entityIdentifier (string) –

  [REQUIRED]

  The ID of the entity that you want to list.

• entityType (string) –

  [REQUIRED]

  The type of the entity that you want to list.

• 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

{
    'owners': [
        {
            'group': {
                'groupId': 'string'
            },
            'user': {
                'userId': '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: 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) –

        Specifies that the domain unit owner is a group.

        • groupId (string) –

          The ID of the domain unit owners group.

      • user (dict) –

        Specifies that the domain unit owner is a user.

        • userId (string) –

          The ID of the owner user.

  • NextToken (string) –

    A token to resume pagination.