DataZone / Client / search_group_profiles

search_group_profiles#

DataZone.Client.search_group_profiles(**kwargs)#

Searches group profiles in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.search_group_profiles(
    domainIdentifier='string',
    groupType='SSO_GROUP'|'DATAZONE_SSO_GROUP',
    maxResults=123,
    nextToken='string',
    searchText='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.

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

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

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

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

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

Exceptions