Skip to content

/AWS1/IF_FNS=>UPDATEKXUSER()

About UpdateKxUser

Updates the user details. You can only update the IAM role associated with a user.

Method Signature

METHODS /AWS1/IF_FNS~UPDATEKXUSER
  IMPORTING
    !IV_ENVIRONMENTID TYPE /AWS1/FNSIDTYPE OPTIONAL
    !IV_USERNAME TYPE /AWS1/FNSKXUSERNAMESTRING OPTIONAL
    !IV_IAMROLE TYPE /AWS1/FNSROLEARN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/FNSCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fnsupdatekxuserrsp
  RAISING
    /AWS1/CX_FNSACCESSDENIEDEX
    /AWS1/CX_FNSCONFLICTEXCEPTION
    /AWS1/CX_FNSINTERNALSERVEREX
    /AWS1/CX_FNSLIMITEXCEEDEDEX
    /AWS1/CX_FNSRESOURCENOTFOUNDEX
    /AWS1/CX_FNSTHROTTLINGEX
    /AWS1/CX_FNSVALIDATIONEX
    /AWS1/CX_FNSCLIENTEXC
    /AWS1/CX_FNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_environmentid TYPE /AWS1/FNSIDTYPE /AWS1/FNSIDTYPE

A unique identifier for the kdb environment.

iv_username TYPE /AWS1/FNSKXUSERNAMESTRING /AWS1/FNSKXUSERNAMESTRING

A unique identifier for the user.

iv_iamrole TYPE /AWS1/FNSROLEARN /AWS1/FNSROLEARN

The IAM role ARN that is associated with the user.

Optional arguments:

iv_clienttoken TYPE /AWS1/FNSCLIENTTOKEN /AWS1/FNSCLIENTTOKEN

A token that ensures idempotency. This token expires in 10 minutes.

RETURNING

oo_output TYPE REF TO /aws1/cl_fnsupdatekxuserrsp /AWS1/CL_FNSUPDATEKXUSERRSP

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->updatekxuser(
  iv_clienttoken = |string|
  iv_environmentid = |string|
  iv_iamrole = |string|
  iv_username = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_kxusernamestring = lo_result->get_username( ).
  lv_kxuserarn = lo_result->get_userarn( ).
  lv_idtype = lo_result->get_environmentid( ).
  lv_rolearn = lo_result->get_iamrole( ).
ENDIF.