Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Searches user profiles in Amazon DataZone.

post/v2/domains/{domainIdentifier}/search-user-profiles

Path parameters

domainIdentifierstring required

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

Request body

userType'SSO_USER' | 'DATAZONE_USER' | 'DATAZONE_SSO_USER' | 'DATAZONE_IAM_USER' required

Specifies the user type for the <code>SearchUserProfiles</code> action.

searchTextstring password

Specifies the text for which to search.

maxResultsinteger

The maximum number of results to return in a single call to <code>SearchUserProfiles</code>. When the number of results to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.

nextTokenstring

When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.

Response

Success

nextTokenstring

When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchUserProfiles</code> to list the next set of results.