/AWS1/IF_QLD=>DESCRIBELEDGER()

About DescribeLedger

Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.

Method Signature

METHODS /AWS1/IF_QLD~DESCRIBELEDGER
  IMPORTING
    !IV_NAME TYPE /AWS1/QLDLEDGERNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qlddescrledgerrsp
  RAISING
    /AWS1/CX_QLDINVALIDPARAMETEREX
    /AWS1/CX_QLDRESOURCENOTFOUNDEX
    /AWS1/CX_QLDCLIENTEXC
    /AWS1/CX_QLDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/QLDLEDGERNAME /AWS1/QLDLEDGERNAME

The name of the ledger that you want to describe.

RETURNING

oo_output TYPE REF TO /aws1/cl_qlddescrledgerrsp /AWS1/CL_QLDDESCRLEDGERRSP

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

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_ledgername = lo_result->get_name( ).
  lv_arn = lo_result->get_arn( ).
  lv_ledgerstate = lo_result->get_state( ).
  lv_timestamp = lo_result->get_creationdatetime( ).
  lv_permissionsmode = lo_result->get_permissionsmode( ).
  lv_deletionprotection = lo_result->get_deletionprotection( ).
  lo_ledgerencryptiondescrip = lo_result->get_encryptiondescription( ).
  IF lo_ledgerencryptiondescrip IS NOT INITIAL.
    lv_arn = lo_ledgerencryptiondescrip->get_kmskeyarn( ).
    lv_encryptionstatus = lo_ledgerencryptiondescrip->get_encryptionstatus( ).
    lv_timestamp = lo_ledgerencryptiondescrip->get_inacciblekmskeydatetime( ).
  ENDIF.
ENDIF.