SearchUserProfilesCommand

Suggest an Edit

Searches user profiles in Amazon DataZone.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, SearchUserProfilesCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, SearchUserProfilesCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // SearchUserProfilesInput
  domainIdentifier: "STRING_VALUE", // required
  userType: "SSO_USER" || "DATAZONE_USER" || "DATAZONE_SSO_USER" || "DATAZONE_IAM_USER", // required
  searchText: "STRING_VALUE",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new SearchUserProfilesCommand(input);
const response = await client.send(command);
// { // SearchUserProfilesOutput
//   items: [ // UserProfileSummaries
//     { // UserProfileSummary
//       domainId: "STRING_VALUE",
//       id: "STRING_VALUE",
//       type: "IAM" || "SSO",
//       status: "ASSIGNED" || "NOT_ASSIGNED" || "ACTIVATED" || "DEACTIVATED",
//       details: { // UserProfileDetails Union: only one key present
//         iam: { // IamUserProfileDetails
//           arn: "STRING_VALUE",
//         },
//         sso: { // SsoUserProfileDetails
//           username: "STRING_VALUE",
//           firstName: "STRING_VALUE",
//           lastName: "STRING_VALUE",
//         },
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

SearchUserProfilesCommand Input

See SearchUserProfilesCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

userType
Required
UserSearchType | undefined

Specifies the user type for the SearchUserProfiles action.

maxResults
number | undefined

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 | undefined

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 | undefined

Specifies the text for which to search.

SearchUserProfilesCommand Output

See SearchUserProfilesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
UserProfileSummary[] | undefined

The results of the SearchUserProfiles action.

nextToken
string | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

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

ResourceNotFoundException
client

The specified resource cannot be found.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

ThrottlingException
client

The request was denied due to request throttling.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.