DESCRIBECHANNEL()`¶

About DescribeChannel¶

Retrieves information about a channel.

Method Signature¶

METHODS /AWS1/IF_IOA~DESCRIBECHANNEL
  IMPORTING
    !IV_CHANNELNAME TYPE /AWS1/IOACHANNELNAME OPTIONAL
    !IV_INCLUDESTATISTICS TYPE /AWS1/IOAINCLUDESTATISTICSFLAG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioadescrchannelrsp
  RAISING
    /AWS1/CX_IOAINTERNALFAILUREEX
    /AWS1/CX_IOAINVALIDREQUESTEX
    /AWS1/CX_IOARESOURCENOTFOUNDEX
    /AWS1/CX_IOASERVICEUNAVAILEX
    /AWS1/CX_IOATHROTTLINGEX
    /AWS1/CX_IOACLIENTEXC
    /AWS1/CX_IOASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_channelname` `TYPE /AWS1/IOACHANNELNAME` `/AWS1/IOACHANNELNAME`¶

The name of the channel whose information is retrieved.

Optional arguments:¶

`iv_includestatistics` `TYPE /AWS1/IOAINCLUDESTATISTICSFLAG` `/AWS1/IOAINCLUDESTATISTICSFLAG`¶

If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioadescrchannelrsp` `/AWS1/CL_IOADESCRCHANNELRSP`¶

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->describechannel(
  iv_channelname = |string|
  iv_includestatistics = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_channel = lo_result->get_channel( ).
  IF lo_channel IS NOT INITIAL.
    lv_channelname = lo_channel->get_name( ).
    lo_channelstorage = lo_channel->get_storage( ).
    IF lo_channelstorage IS NOT INITIAL.
      lo_servicemanagedchannels3 = lo_channelstorage->get_servicemanageds3( ).
      IF lo_servicemanagedchannels3 IS NOT INITIAL.
      ENDIF.
      lo_customermanagedchannels = lo_channelstorage->get_customermanageds3( ).
      IF lo_customermanagedchannels IS NOT INITIAL.
        lv_bucketname = lo_customermanagedchannels->get_bucket( ).
        lv_s3keyprefix = lo_customermanagedchannels->get_keyprefix( ).
        lv_rolearn = lo_customermanagedchannels->get_rolearn( ).
      ENDIF.
    ENDIF.
    lv_channelarn = lo_channel->get_arn( ).
    lv_channelstatus = lo_channel->get_status( ).
    lo_retentionperiod = lo_channel->get_retentionperiod( ).
    IF lo_retentionperiod IS NOT INITIAL.
      lv_unlimitedretentionperio = lo_retentionperiod->get_unlimited( ).
      lv_retentionperiodindays = lo_retentionperiod->get_numberofdays( ).
    ENDIF.
    lv_timestamp = lo_channel->get_creationtime( ).
    lv_timestamp = lo_channel->get_lastupdatetime( ).
    lv_timestamp = lo_channel->get_lastmessagearrivaltime( ).
  ENDIF.
  lo_channelstatistics = lo_result->get_statistics( ).
  IF lo_channelstatistics IS NOT INITIAL.
    lo_estimatedresourcesize = lo_channelstatistics->get_size( ).
    IF lo_estimatedresourcesize IS NOT INITIAL.
      lv_sizeinbytes = lo_estimatedresourcesize->get_estimatedsizeinbytes( ).
      lv_timestamp = lo_estimatedresourcesize->get_estimatedon( ).
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_IOA=>DESCRIBECHANNEL()¶