Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchUserProfiles

Searches user profiles in Amazon DataZone.

Request Syntax


POST /v2/domains/domainIdentifier/search-user-profiles HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string",
   "searchText": "string",
   "userType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

nextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Required: No

searchText

Specifies the text for which to search.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

userType

Specifies the user type for the SearchUserProfiles action.

Type: String

Valid Values: SSO_USER | DATAZONE_USER | DATAZONE_SSO_USER | DATAZONE_IAM_USER

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "details": { ... },
         "domainId": "string",
         "id": "string",
         "status": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

The results of the SearchUserProfiles action.

Type: Array of UserProfileSummary objects

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400