Search User Profiles

datazone_search_user_profiles

R Documentation

Searches user profiles in Amazon DataZone

Description

Searches user profiles in Amazon DataZone.

Usage

datazone_search_user_profiles(domainIdentifier, userType, searchText,
  maxResults, nextToken)

Arguments

domainIdentifier	[required] The identifier of the Amazon DataZone domain in which you want to search user profiles.
userType	[required] Specifies the user type for the search_user_profiles action.
searchText	Specifies the text for which to search.
maxResults	The maximum number of results to return in a single call to search_user_profiles. 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 search_user_profiles to list the next set of results.
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 search_user_profiles to list the next set of results.

Value

A list with the following syntax:

list(
  items = list(
    list(
      domainId = "string",
      id = "string",
      type = "IAM"|"SSO",
      status = "ASSIGNED"|"NOT_ASSIGNED"|"ACTIVATED"|"DEACTIVATED",
      details = list(
        iam = list(
          arn = "string",
          principalId = "string",
          sessionName = "string",
          groupProfileId = "string"
        ),
        sso = list(
          username = "string",
          firstName = "string",
          lastName = "string"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$search_user_profiles(
  domainIdentifier = "string",
  userType = "SSO_USER"|"DATAZONE_USER"|"DATAZONE_SSO_USER"|"DATAZONE_IAM_USER",
  searchText = "string",
  maxResults = 123,
  nextToken = "string"
)