DESCRIBEGROUP()`¶

About DescribeGroup¶

Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).

Method Signature¶

METHODS /AWS1/IF_QST~DESCRIBEGROUP
  IMPORTING
    !IV_GROUPNAME TYPE /AWS1/QSTGROUPNAME OPTIONAL
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/QSTNAMESPACE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdescrgroupresponse
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTRESOURCEUNAVAILEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_groupname` `TYPE /AWS1/QSTGROUPNAME` `/AWS1/QSTGROUPNAME`¶

The name of the group that you want to describe.

`iv_awsaccountid` `TYPE /AWS1/QSTAWSACCOUNTID` `/AWS1/QSTAWSACCOUNTID`¶

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.

`iv_namespace` `TYPE /AWS1/QSTNAMESPACE` `/AWS1/QSTNAMESPACE`¶

The namespace of the group that you want described.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstdescrgroupresponse` `/AWS1/CL_QSTDESCRGROUPRESPONSE`¶

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->describegroup(
  iv_awsaccountid = |string|
  iv_groupname = |string|
  iv_namespace = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_group = lo_result->get_group( ).
  IF lo_group IS NOT INITIAL.
    lv_arn = lo_group->get_arn( ).
    lv_groupname = lo_group->get_groupname( ).
    lv_groupdescription = lo_group->get_description( ).
    lv_string = lo_group->get_principalid( ).
  ENDIF.
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.

/AWS1/IF_QST=>DESCRIBEGROUP()¶