BATCHSUSPENDUSER()`¶

About BatchSuspendUser¶

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

Method Signature¶

METHODS /AWS1/IF_CHE~BATCHSUSPENDUSER
  IMPORTING
    !IV_ACCOUNTID TYPE /AWS1/CHENONEMPTYSTRING OPTIONAL
    !IT_USERIDLIST TYPE /AWS1/CL_CHEUSERIDLIST_W=>TT_USERIDLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chebtcsuspenduserrsp
  RAISING
    /AWS1/CX_CHEBADREQUESTEX
    /AWS1/CX_CHEFORBIDDENEXCEPTION
    /AWS1/CX_CHENOTFOUNDEXCEPTION
    /AWS1/CX_CHESERVICEFAILUREEX
    /AWS1/CX_CHESERVICEUNAVAILEX
    /AWS1/CX_CHETHROTTLEDCLIENTEX
    /AWS1/CX_CHEUNAUTHDCLIENTEX
    /AWS1/CX_CHECLIENTEXC
    /AWS1/CX_CHESERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_accountid` `TYPE /AWS1/CHENONEMPTYSTRING` `/AWS1/CHENONEMPTYSTRING`¶

The Amazon Chime account ID.

`it_useridlist` `TYPE /AWS1/CL_CHEUSERIDLIST_W=>TT_USERIDLIST` `TT_USERIDLIST`¶

The request containing the user IDs to suspend.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_chebtcsuspenduserrsp` `/AWS1/CL_CHEBTCSUSPENDUSERRSP`¶

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->batchsuspenduser(
  it_useridlist = VALUE /aws1/cl_cheuseridlist_w=>tt_useridlist(
    ( new /aws1/cl_cheuseridlist_w( |string| ) )
  )
  iv_accountid = |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_usererrors( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptystring = lo_row_1->get_userid( ).
      lv_errorcode = lo_row_1->get_errorcode( ).
      lv_string = lo_row_1->get_errormessage( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_CHE=>BATCHSUSPENDUSER()¶