/AWS1/IF_QLD=>DESCRIBEJOURNALKINESISSTREAM()

About DescribeJournalKinesisStream

Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.

This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.

Method Signature

METHODS /AWS1/IF_QLD~DESCRIBEJOURNALKINESISSTREAM
  IMPORTING
    !IV_LEDGERNAME TYPE /AWS1/QLDLEDGERNAME OPTIONAL
    !IV_STREAMID TYPE /AWS1/QLDUNIQUEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qlddscjourkinesisst01
  RAISING
    /AWS1/CX_QLDINVALIDPARAMETEREX
    /AWS1/CX_QLDRESOURCENOTFOUNDEX
    /AWS1/CX_QLDRESRCPRECONDNOTM00
    /AWS1/CX_QLDCLIENTEXC
    /AWS1/CX_QLDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_ledgername TYPE /AWS1/QLDLEDGERNAME /AWS1/QLDLEDGERNAME

The name of the ledger.

iv_streamid TYPE /AWS1/QLDUNIQUEID /AWS1/QLDUNIQUEID

The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe.

RETURNING

oo_output TYPE REF TO /aws1/cl_qlddscjourkinesisst01 /AWS1/CL_QLDDSCJOURKINESISST01

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->describejournalkinesisstream(
  iv_ledgername = |string|
  iv_streamid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_journalkinesisstreamdes = lo_result->get_stream( ).
  IF lo_journalkinesisstreamdes IS NOT INITIAL.
    lv_ledgername = lo_journalkinesisstreamdes->get_ledgername( ).
    lv_timestamp = lo_journalkinesisstreamdes->get_creationtime( ).
    lv_timestamp = lo_journalkinesisstreamdes->get_inclusivestarttime( ).
    lv_timestamp = lo_journalkinesisstreamdes->get_exclusiveendtime( ).
    lv_arn = lo_journalkinesisstreamdes->get_rolearn( ).
    lv_uniqueid = lo_journalkinesisstreamdes->get_streamid( ).
    lv_arn = lo_journalkinesisstreamdes->get_arn( ).
    lv_streamstatus = lo_journalkinesisstreamdes->get_status( ).
    lo_kinesisconfiguration = lo_journalkinesisstreamdes->get_kinesisconfiguration( ).
    IF lo_kinesisconfiguration IS NOT INITIAL.
      lv_arn = lo_kinesisconfiguration->get_streamarn( ).
      lv_boolean = lo_kinesisconfiguration->get_aggregationenabled( ).
    ENDIF.
    lv_errorcause = lo_journalkinesisstreamdes->get_errorcause( ).
    lv_streamname = lo_journalkinesisstreamdes->get_streamname( ).
  ENDIF.
ENDIF.