DataZone / Client / search_user_profiles

search_user_profiles#

DataZone.Client.search_user_profiles(**kwargs)#

Searches user profiles in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.search_user_profiles(
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    searchText='string',
    userType='SSO_USER'|'DATAZONE_USER'|'DATAZONE_SSO_USER'|'DATAZONE_IAM_USER'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

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

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

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

  • userType (string) –

    [REQUIRED]

    Specifies the user type for the SearchUserProfiles action.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'details': {
                'iam': {
                    'arn': 'string'
                },
                'sso': {
                    'firstName': 'string',
                    'lastName': 'string',
                    'username': 'string'
                }
            },
            'domainId': 'string',
            'id': 'string',
            'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
            'type': 'IAM'|'SSO'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The results of the SearchUserProfiles action.

      • (dict) –

        The details of the user profile.

        • details (dict) –

          The details of the user profile.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: iam, sso. 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'}

          • iam (dict) –

            The IAM details included in the user profile details.

            • arn (string) –

              The ARN of an IAM user profile in Amazon DataZone.

          • sso (dict) –

            The single sign-on details included in the user profile details.

            • firstName (string) –

              The first name included in the single sign-on details of the user profile.

            • lastName (string) –

              The last name included in the single sign-on details of the user profile.

            • username (string) –

              The username included in the single sign-on details of the user profile.

        • domainId (string) –

          The ID of the Amazon DataZone domain of the user profile.

        • id (string) –

          The ID of the user profile.

        • status (string) –

          The status of the user profile.

        • type (string) –

          The type of the user 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 SearchUserProfiles to list the next set of results.

Exceptions