DataZone / Client / get_domain_unit

get_domain_unit

DataZone.Client.get_domain_unit(**kwargs)

Gets the details of the specified domain unit.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_unit(
    domainIdentifier='string',
    identifier='string'
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain where you want to get a domain unit.

• identifier (string) –

  [REQUIRED]

  The identifier of the domain unit that you want to get.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'lastUpdatedBy': 'string',
    'name': 'string',
    'owners': [
        {
            'group': {
                'groupId': 'string'
            },
            'user': {
                'userId': 'string'
            }
        },
    ],
    'parentDomainUnitId': 'string'
}

Response Structure

• (dict) –

  • createdAt (datetime) –

    The time stamp at which the domain unit was created.

  • createdBy (string) –

    The user who created the domain unit.

  • description (string) –

    The description of the domain unit.

  • domainId (string) –

    The ID of the domain in which the domain unit lives.

  • id (string) –

    The ID of the domain unit.

  • lastUpdatedAt (datetime) –

    The timestamp at which the domain unit was last updated.

  • lastUpdatedBy (string) –

    The user who last updated the domain unit.

  • name (string) –

    The name of the domain unit.

  • owners (list) –

    The owners of the domain unit.

    • (dict) –

      The properties of the domain unit owner.

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

        Indicates that the domain unit owner is a group.

        • groupId (string) –

          The ID of the domain unit group.

      • user (dict) –

        Indicates that the domain unit owner is a user.

        • userId (string) –

          The ID of teh domain unit user.

  • parentDomainUnitId (string) –

    The ID of the parent domain unit.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException