DataZone / Client / list_domain_units_for_parent

list_domain_units_for_parent#

DataZone.Client.list_domain_units_for_parent(**kwargs)#

Lists child domain units for the specified parent domain unit.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_units_for_parent(
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    parentDomainUnitIdentifier='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the domain in which you want to list domain units for a parent domain unit.

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

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

  • parentDomainUnitIdentifier (string) –

    [REQUIRED]

    The ID of the parent domain unit.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The results returned by this action.

      • (dict) –

        The summary of the domain unit.

        • id (string) –

          The ID of the domain unit summary.

        • name (string) –

          The name of the domain unit summary.

    • nextToken (string) –

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

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException