DESCRIBEDATATABLE()`¶

About DescribeDataTable¶

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Method Signature¶

METHODS /AWS1/IF_CNT~DESCRIBEDATATABLE
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_DATATABLEID TYPE /AWS1/CNTDATATABLEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntdescrdatatablersp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instanceid` `TYPE /AWS1/CNTINSTANCEID` `/AWS1/CNTINSTANCEID`¶

The unique identifier for the Amazon Connect instance.

`iv_datatableid` `TYPE /AWS1/CNTDATATABLEID` `/AWS1/CNTDATATABLEID`¶

The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the $LATEST alias.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntdescrdatatablersp` `/AWS1/CL_CNTDESCRDATATABLERSP`¶

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->describedatatable(
  iv_datatableid = |string|
  iv_instanceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_datatable = lo_result->get_datatable( ).
  IF lo_datatable IS NOT INITIAL.
    lv_datatablename = lo_datatable->get_name( ).
    lv_datatableid = lo_datatable->get_id( ).
    lv_arn = lo_datatable->get_arn( ).
    lv_timezone = lo_datatable->get_timezone( ).
    lv_datatabledescription = lo_datatable->get_description( ).
    lv_datatablelocklevel = lo_datatable->get_valuelocklevel( ).
    lo_datatablelockversion = lo_datatable->get_lockversion( ).
    IF lo_datatablelockversion IS NOT INITIAL.
      lv_string = lo_datatablelockversion->get_datatable( ).
      lv_string = lo_datatablelockversion->get_attribute( ).
      lv_string = lo_datatablelockversion->get_primaryvalues( ).
      lv_string = lo_datatablelockversion->get_value( ).
    ENDIF.
    lv_datatableversion = lo_datatable->get_version( ).
    lv_datatabledescription = lo_datatable->get_versiondescription( ).
    lv_datatablestatus = lo_datatable->get_status( ).
    lv_timestamp = lo_datatable->get_createdtime( ).
    lv_timestamp = lo_datatable->get_lastmodifiedtime( ).
    lv_regionname = lo_datatable->get_lastmodifiedregion( ).
    LOOP AT lo_datatable->get_tags( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_CNT=>DESCRIBEDATATABLE()¶