SEARCHUSERPROFILES()`¶

About SearchUserProfiles¶

Searches user profiles in Amazon DataZone.

Method Signature¶

METHODS /AWS1/IF_DZN~SEARCHUSERPROFILES
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_USERTYPE TYPE /AWS1/DZNUSERSEARCHTYPE OPTIONAL
    !IV_SEARCHTEXT TYPE /AWS1/DZNUSERSEARCHTEXT OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznsrchuserpflsoutput
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domainidentifier` `TYPE /AWS1/DZNDOMAINID` `/AWS1/DZNDOMAINID`¶

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

`iv_usertype` `TYPE /AWS1/DZNUSERSEARCHTYPE` `/AWS1/DZNUSERSEARCHTYPE`¶

Specifies the user type for the SearchUserProfiles action.

Optional arguments:¶

`iv_searchtext` `TYPE /AWS1/DZNUSERSEARCHTEXT` `/AWS1/DZNUSERSEARCHTEXT`¶

Specifies the text for which to search.

`iv_maxresults` `TYPE /AWS1/DZNMAXRESULTS` `/AWS1/DZNMAXRESULTS`¶

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.

`iv_nexttoken` `TYPE /AWS1/DZNPAGINATIONTOKEN` `/AWS1/DZNPAGINATIONTOKEN`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dznsrchuserpflsoutput` `/AWS1/CL_DZNSRCHUSERPFLSOUTPUT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->searchuserprofiles(
  iv_domainidentifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_searchtext = |string|
  iv_usertype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_domainid = lo_row_1->get_domainid( ).
      lv_userprofileid = lo_row_1->get_id( ).
      lv_userprofiletype = lo_row_1->get_type( ).
      lv_userprofilestatus = lo_row_1->get_status( ).
      lo_userprofiledetails = lo_row_1->get_details( ).
      IF lo_userprofiledetails IS NOT INITIAL.
        lo_iamuserprofiledetails = lo_userprofiledetails->get_iam( ).
        IF lo_iamuserprofiledetails IS NOT INITIAL.
          lv_string = lo_iamuserprofiledetails->get_arn( ).
          lv_string = lo_iamuserprofiledetails->get_principalid( ).
        ENDIF.
        lo_ssouserprofiledetails = lo_userprofiledetails->get_sso( ).
        IF lo_ssouserprofiledetails IS NOT INITIAL.
          lv_userprofilename = lo_ssouserprofiledetails->get_username( ).
          lv_firstname = lo_ssouserprofiledetails->get_firstname( ).
          lv_lastname = lo_ssouserprofiledetails->get_lastname( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_DZN=>SEARCHUSERPROFILES()¶