LISTREGIONS()`¶

About ListRegions¶

Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status.

The following actions are related to ListRegions:

Method Signature¶

METHODS /AWS1/IF_SSA~LISTREGIONS
  IMPORTING
    !IV_INSTANCEARN TYPE /AWS1/SSAINSTANCEARN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SSAMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SSATOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssalistregionsrsp
  RAISING
    /AWS1/CX_SSAACCESSDENIEDEX
    /AWS1/CX_SSAINTERNALSERVEREX
    /AWS1/CX_SSATHROTTLINGEX
    /AWS1/CX_SSAVALIDATIONEX
    /AWS1/CX_SSACLIENTEXC
    /AWS1/CX_SSASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instancearn` `TYPE /AWS1/SSAINSTANCEARN` `/AWS1/SSAINSTANCEARN`¶

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/SSAMAXRESULTS` `/AWS1/SSAMAXRESULTS`¶

The maximum number of results to return in a single call. Default is 100.

`iv_nexttoken` `TYPE /AWS1/SSATOKEN` `/AWS1/SSATOKEN`¶

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssalistregionsrsp` `/AWS1/CL_SSALISTREGIONSRSP`¶

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->listregions(
  iv_instancearn = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_regions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_regionname = lo_row_1->get_regionname( ).
      lv_regionstatus = lo_row_1->get_status( ).
      lv_date = lo_row_1->get_addeddate( ).
      lv_isprimaryregion = lo_row_1->get_isprimaryregion( ).
    ENDIF.
  ENDLOOP.
  lv_token = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_SSA=>LISTREGIONS()¶