DataZone / Paginator / ListDomainUnitsForParent

ListDomainUnitsForParent

class DataZone.Paginator.ListDomainUnitsForParent

paginator = client.get_paginator('list_domain_units_for_parent')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• parentDomainUnitIdentifier (string) –

  [REQUIRED]

  The ID of the parent domain unit.

• 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

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

    A token to resume pagination.