DataZone / Client / list_entity_owners

list_entity_owners#

DataZone.Client.list_entity_owners(**kwargs)#

Lists the entity (domain units) owners.

See also: AWS API Documentation

Request Syntax

response = client.list_entity_owners(
    domainIdentifier='string',
    entityIdentifier='string',
    entityType='DOMAIN_UNIT',
    maxResults=123,
    nextToken='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.

  • maxResults (integer) – The maximum number of entities to return in a single call to ListEntityOwners. When the number of entities 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 ListEntityOwners to list the next set of entities.

  • nextToken (string) – When the number of entities 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 entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'owners': [
        {
            'group': {
                'groupId': 'string'
            },
            'user': {
                'userId': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      When the number of entities 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 entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

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

Exceptions