DataZone / Paginator / SearchGroupProfiles

SearchGroupProfiles

class DataZone.Paginator.SearchGroupProfiles

paginator = client.get_paginator('search_group_profiles')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    groupType='SSO_GROUP'|'DATAZONE_SSO_GROUP',
    searchText='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain in which you want to search group profiles.

• groupType (string) –

  [REQUIRED]

  The group type for which to search.

• searchText (string) – Specifies the text for which to search.

• 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': [
        {
            'domainId': 'string',
            'groupName': 'string',
            'id': 'string',
            'status': 'ASSIGNED'|'NOT_ASSIGNED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the SearchGroupProfiles action.

    • (dict) –

      The details of a group profile.

      • domainId (string) –

        The ID of the Amazon DataZone domain of a group profile.

      • groupName (string) –

        The group name of a group profile.

      • id (string) –

        The ID of a group profile.

      • status (string) –

        The status of a group profile.

  • NextToken (string) –

    A token to resume pagination.