Skip to content

/AWS1/IF_QST=>DESCRIBESPACE()

About DescribeSpace

Describes an Amazon QuickSight space.

Method Signature

METHODS /AWS1/IF_QST~DESCRIBESPACE
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_SPACEID TYPE /AWS1/QSTPUBLICSPACEID OPTIONAL
    !IV_MAXCONTRIBUTORS TYPE /AWS1/QSTMAXCONTRIBUTORS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstdescrspaceresponse
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The ID of the Amazon Web Services account that contains the space.

iv_spaceid TYPE /AWS1/QSTPUBLICSPACEID /AWS1/QSTPUBLICSPACEID

The ID of the space that you want to describe.

Optional arguments:

iv_maxcontributors TYPE /AWS1/QSTMAXCONTRIBUTORS /AWS1/QSTMAXCONTRIBUTORS

The maximum number of contributors to include in the response.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstdescrspaceresponse /AWS1/CL_QSTDESCRSPACERESPONSE

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->describespace(
  iv_awsaccountid = |string|
  iv_maxcontributors = 123
  iv_spaceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_publicspaceid = lo_result->get_spaceid( ).
  lv_publicspacearn = lo_result->get_spacearn( ).
  lo_spacedetails = lo_result->get_space00( ).
  IF lo_spacedetails IS NOT INITIAL.
    lv_spacename = lo_spacedetails->get_name( ).
    lv_spacedescription = lo_spacedetails->get_description( ).
    LOOP AT lo_spacedetails->get_resources( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_spacequicksightresource = lo_row_1->get_resourcetype( ).
        lo_spacequicksightresource_1 = lo_row_1->get_resourcedetails( ).
        IF lo_spacequicksightresource_1 IS NOT INITIAL.
          lv_arn = lo_spacequicksightresource_1->get_resourcearn( ).
        ENDIF.
      ENDIF.
    ENDLOOP.
    lv_timestamp = lo_spacedetails->get_createdat( ).
    lv_timestamp = lo_spacedetails->get_updatedat( ).
    lv_long = lo_spacedetails->get_consumedsourcesize( ).
    lv_integer = lo_spacedetails->get_consumedsourcedoccount( ).
    lv_string = lo_spacedetails->get_createdby( ).
    lv_string = lo_spacedetails->get_createdbyarn( ).
  ENDIF.
  LOOP AT lo_result->get_contributors( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_string = lo_row_3->get_username( ).
      lv_long = lo_row_3->get_rawfilesizebytes( ).
      lv_double = lo_row_3->get_percentage( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_requestid( ).
ENDIF.