Skip to content

/AWS1/IF_CNT=>DESCRIBEDATATABLEATTRIBUTE()

About DescribeDataTableAttribute

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Method Signature

METHODS /AWS1/IF_CNT~DESCRIBEDATATABLEATTRIBUTE
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_DATATABLEID TYPE /AWS1/CNTDATATABLEID OPTIONAL
    !IV_ATTRIBUTENAME TYPE /AWS1/CNTDATATABLENAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntdscdatatblattrrsp
  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.

iv_attributename TYPE /AWS1/CNTDATATABLENAME /AWS1/CNTDATATABLENAME

The name of the attribute to retrieve detailed information for.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntdscdatatblattrrsp /AWS1/CL_CNTDSCDATATBLATTRRSP

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->describedatatableattribute(
  iv_attributename = |string|
  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_datatableattribute = lo_result->get_attribute( ).
  IF lo_datatableattribute IS NOT INITIAL.
    lv_datatableid = lo_datatableattribute->get_attributeid( ).
    lv_datatablename = lo_datatableattribute->get_name( ).
    lv_datatableattributevalue = lo_datatableattribute->get_valuetype( ).
    lv_datatabledescription = lo_datatableattribute->get_description( ).
    lv_datatableid = lo_datatableattribute->get_datatableid( ).
    lv_arn = lo_datatableattribute->get_datatablearn( ).
    lv_boolean = lo_datatableattribute->get_primary( ).
    lv_datatableversion = lo_datatableattribute->get_version( ).
    lo_datatablelockversion = lo_datatableattribute->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_timestamp = lo_datatableattribute->get_lastmodifiedtime( ).
    lv_regionname = lo_datatableattribute->get_lastmodifiedregion( ).
    lo_validation = lo_datatableattribute->get_validation( ).
    IF lo_validation IS NOT INITIAL.
      lv_lengthboundary = lo_validation->get_minlength( ).
      lv_lengthboundary = lo_validation->get_maxlength( ).
      lv_valueboundary = lo_validation->get_minvalues( ).
      lv_valueboundary = lo_validation->get_maxvalues( ).
      lv_boolean = lo_validation->get_ignorecase( ).
      lv_positiveandnegativedoub = lo_validation->get_minimum( ).
      lv_positiveandnegativedoub = lo_validation->get_maximum( ).
      lv_positiveandnegativedoub = lo_validation->get_exclusiveminimum( ).
      lv_positiveandnegativedoub = lo_validation->get_exclusivemaximum( ).
      lv_positivedouble = lo_validation->get_multipleof( ).
      lo_validationenum = lo_validation->get_enum( ).
      IF lo_validationenum IS NOT INITIAL.
        lv_boolean = lo_validationenum->get_strict( ).
        LOOP AT lo_validationenum->get_values( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_string = lo_row_1->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.