/AWS1/IF_ATH=>GETWORKGROUP()

About GetWorkGroup

Returns information about the workgroup with the specified name.

Method Signature

METHODS /AWS1/IF_ATH~GETWORKGROUP
  IMPORTING
    !IV_WORKGROUP TYPE /AWS1/ATHWORKGROUPNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_athgetworkgroupoutput
  RAISING
    /AWS1/CX_ATHINTERNALSERVEREX
    /AWS1/CX_ATHINVALIDREQUESTEX
    /AWS1/CX_ATHCLIENTEXC
    /AWS1/CX_ATHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_workgroup TYPE /AWS1/ATHWORKGROUPNAME /AWS1/ATHWORKGROUPNAME

The name of the workgroup.

RETURNING

oo_output TYPE REF TO /aws1/cl_athgetworkgroupoutput /AWS1/CL_ATHGETWORKGROUPOUTPUT

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->getworkgroup( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_workgroup = lo_result->get_workgroup( ).
  IF lo_workgroup IS NOT INITIAL.
    lv_workgroupname = lo_workgroup->get_name( ).
    lv_workgroupstate = lo_workgroup->get_state( ).
    lo_workgroupconfiguration = lo_workgroup->get_configuration( ).
    IF lo_workgroupconfiguration IS NOT INITIAL.
      lo_resultconfiguration = lo_workgroupconfiguration->get_resultconfiguration( ).
      IF lo_resultconfiguration IS NOT INITIAL.
        lv_resultoutputlocation = lo_resultconfiguration->get_outputlocation( ).
        lo_encryptionconfiguration = lo_resultconfiguration->get_encryptionconfiguration( ).
        IF lo_encryptionconfiguration IS NOT INITIAL.
          lv_encryptionoption = lo_encryptionconfiguration->get_encryptionoption( ).
          lv_string = lo_encryptionconfiguration->get_kmskey( ).
        ENDIF.
        lv_awsaccountid = lo_resultconfiguration->get_expectedbucketowner( ).
        lo_aclconfiguration = lo_resultconfiguration->get_aclconfiguration( ).
        IF lo_aclconfiguration IS NOT INITIAL.
          lv_s3acloption = lo_aclconfiguration->get_s3acloption( ).
        ENDIF.
      ENDIF.
      lo_managedqueryresultsconf = lo_workgroupconfiguration->get_managedqueryresultsconf( ).
      IF lo_managedqueryresultsconf IS NOT INITIAL.
        lv_boolean = lo_managedqueryresultsconf->get_enabled( ).
        lo_managedqueryresultsencr = lo_managedqueryresultsconf->get_encryptionconfiguration( ).
        IF lo_managedqueryresultsencr IS NOT INITIAL.
          lv_kmskey = lo_managedqueryresultsencr->get_kmskey( ).
        ENDIF.
      ENDIF.
      lv_boxedboolean = lo_workgroupconfiguration->get_enforceworkgroupconf( ).
      lv_boxedboolean = lo_workgroupconfiguration->get_pubcloudwatchmetenabled( ).
      lv_bytesscannedcutoffvalue = lo_workgroupconfiguration->get_bytesscndcutoffperquery( ).
      lv_boxedboolean = lo_workgroupconfiguration->get_requesterpaysenabled( ).
      lo_engineversion = lo_workgroupconfiguration->get_engineversion( ).
      IF lo_engineversion IS NOT INITIAL.
        lv_namestring = lo_engineversion->get_selectedengineversion( ).
        lv_namestring = lo_engineversion->get_effectiveengineversion( ).
      ENDIF.
      lv_namestring = lo_workgroupconfiguration->get_additionalconfiguration( ).
      lv_rolearn = lo_workgroupconfiguration->get_executionrole( ).
      lo_monitoringconfiguration = lo_workgroupconfiguration->get_monitoringconfiguration( ).
      IF lo_monitoringconfiguration IS NOT INITIAL.
        lo_cloudwatchloggingconfig = lo_monitoringconfiguration->get_cloudwatchloggingconf( ).
        IF lo_cloudwatchloggingconfig IS NOT INITIAL.
          lv_boxedboolean = lo_cloudwatchloggingconfig->get_enabled( ).
          lv_loggroupname = lo_cloudwatchloggingconfig->get_loggroup( ).
          lv_logstreamnameprefix = lo_cloudwatchloggingconfig->get_logstreamnameprefix( ).
          LOOP AT lo_cloudwatchloggingconfig->get_logtypes( ) into ls_row.
            lv_key = ls_row-key.
            LOOP AT ls_row-value into lo_row_1.
              lo_row_2 = lo_row_1.
              IF lo_row_2 IS NOT INITIAL.
                lv_logtypevalue = lo_row_2->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDLOOP.
        ENDIF.
        lo_managedloggingconfigura = lo_monitoringconfiguration->get_managedloggingconf( ).
        IF lo_managedloggingconfigura IS NOT INITIAL.
          lv_boxedboolean = lo_managedloggingconfigura->get_enabled( ).
          lv_kmskey = lo_managedloggingconfigura->get_kmskey( ).
        ENDIF.
        lo_s3loggingconfiguration = lo_monitoringconfiguration->get_s3loggingconfiguration( ).
        IF lo_s3loggingconfiguration IS NOT INITIAL.
          lv_boxedboolean = lo_s3loggingconfiguration->get_enabled( ).
          lv_kmskey = lo_s3loggingconfiguration->get_kmskey( ).
          lv_s3outputlocation = lo_s3loggingconfiguration->get_loglocation( ).
        ENDIF.
      ENDIF.
      lo_engineconfiguration = lo_workgroupconfiguration->get_engineconfiguration( ).
      IF lo_engineconfiguration IS NOT INITIAL.
        lv_coordinatordpusize = lo_engineconfiguration->get_coordinatordpusize( ).
        lv_maxconcurrentdpus = lo_engineconfiguration->get_maxconcurrentdpus( ).
        lv_defaultexecutordpusize = lo_engineconfiguration->get_defaultexecutordpusize( ).
        LOOP AT lo_engineconfiguration->get_additionalconfigs( ) into ls_row_3.
          lv_key_1 = ls_row_3-key.
          lo_value = ls_row_3-value.
          IF lo_value IS NOT INITIAL.
            lv_parametersmapvalue = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_engineconfiguration->get_sparkproperties( ) into ls_row_3.
          lv_key_1 = ls_row_3-key.
          lo_value = ls_row_3-value.
          IF lo_value IS NOT INITIAL.
            lv_parametersmapvalue = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_engineconfiguration->get_classifications( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_namestring = lo_row_5->get_name( ).
            LOOP AT lo_row_5->get_properties( ) into ls_row_3.
              lv_key_1 = ls_row_3-key.
              lo_value = ls_row_3-value.
              IF lo_value IS NOT INITIAL.
                lv_parametersmapvalue = lo_value->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_customercontentencrypti = lo_workgroupconfiguration->get_customercontentencconf( ).
      IF lo_customercontentencrypti IS NOT INITIAL.
        lv_kmskey = lo_customercontentencrypti->get_kmskey( ).
      ENDIF.
      lv_boxedboolean = lo_workgroupconfiguration->get_enableminimumencconf( ).
      lo_identitycenterconfigura = lo_workgroupconfiguration->get_identitycenterconf( ).
      IF lo_identitycenterconfigura IS NOT INITIAL.
        lv_boxedboolean = lo_identitycenterconfigura->get_enableidentitycenter( ).
        lv_identitycenterinstancea = lo_identitycenterconfigura->get_idcenterinstancearn( ).
      ENDIF.
      lo_queryresultss3accessgra = lo_workgroupconfiguration->get_queryrsss3accgrantsconf( ).
      IF lo_queryresultss3accessgra IS NOT INITIAL.
        lv_boxedboolean = lo_queryresultss3accessgra->get_enables3accessgrants( ).
        lv_boxedboolean = lo_queryresultss3accessgra->get_createuserlevelprefix( ).
        lv_authenticationtype = lo_queryresultss3accessgra->get_authenticationtype( ).
      ENDIF.
    ENDIF.
    lv_workgroupdescriptionstr = lo_workgroup->get_description( ).
    lv_date = lo_workgroup->get_creationtime( ).
    lv_identitycenterapplicati = lo_workgroup->get_idcenterapplicationarn( ).
  ENDIF.
ENDIF.