DESCRIBEREGION()`¶

About DescribeRegion¶

Retrieves details about a specific Region enabled in an IAM Identity Center instance. Details include the Region name, current status (ACTIVE, ADDING, or REMOVING), the date when the Region was added, and whether it is the primary Region. The request must be made from one of the enabled Regions of the IAM Identity Center instance.

The following actions are related to DescribeRegion:

Method Signature¶

METHODS /AWS1/IF_SSA~DESCRIBEREGION
  IMPORTING
    !IV_INSTANCEARN TYPE /AWS1/SSAINSTANCEARN OPTIONAL
    !IV_REGIONNAME TYPE /AWS1/SSAREGIONNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssadescrregionrsp
  RAISING
    /AWS1/CX_SSAACCESSDENIEDEX
    /AWS1/CX_SSAINTERNALSERVEREX
    /AWS1/CX_SSARESOURCENOTFOUNDEX
    /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.

`iv_regionname` `TYPE /AWS1/SSAREGIONNAME` `/AWS1/SSAREGIONNAME`¶

The name of the Amazon Web Services Region to retrieve information about. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1).

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssadescrregionrsp` `/AWS1/CL_SSADESCRREGIONRSP`¶

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->describeregion(
  iv_instancearn = |string|
  iv_regionname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_regionname = lo_result->get_regionname( ).
  lv_regionstatus = lo_result->get_status( ).
  lv_date = lo_result->get_addeddate( ).
  lv_isprimaryregion = lo_result->get_isprimaryregion( ).
ENDIF.

/AWS1/IF_SSA=>DESCRIBEREGION()¶