Skip to content

/AWS1/CL_KNY=>DESCRIBEAPPLICATION()

About DescribeApplication

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Returns information about a specific Amazon Kinesis Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.

Method Signature

IMPORTING

Required arguments:

iv_applicationname TYPE /AWS1/KNYAPPLICATIONNAME /AWS1/KNYAPPLICATIONNAME

Name of the application.

RETURNING

oo_output TYPE REF TO /aws1/cl_knydscapplicationrsp /AWS1/CL_KNYDSCAPPLICATIONRSP

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->/aws1/if_kny~describeapplication( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_applicationdetail = lo_result->get_applicationdetail( ).
  IF lo_applicationdetail IS NOT INITIAL.
    lv_applicationname = lo_applicationdetail->get_applicationname( ).
    lv_applicationdescription = lo_applicationdetail->get_applicationdescription( ).
    lv_resourcearn = lo_applicationdetail->get_applicationarn( ).
    lv_applicationstatus = lo_applicationdetail->get_applicationstatus( ).
    lv_timestamp = lo_applicationdetail->get_createtimestamp( ).
    lv_timestamp = lo_applicationdetail->get_lastupdatetimestamp( ).
    LOOP AT lo_applicationdetail->get_inputdescriptions( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_id = lo_row_1->get_inputid( ).
        lv_inappstreamname = lo_row_1->get_nameprefix( ).
        LOOP AT lo_row_1->get_inappstreamnames( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_inappstreamname = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lo_inputprocessingconfigur = lo_row_1->get_inputprocessingconfdesc( ).
        IF lo_inputprocessingconfigur IS NOT INITIAL.
          lo_inputlambdaprocessordes = lo_inputprocessingconfigur->get_inputlambdaprocessordesc( ).
          IF lo_inputlambdaprocessordes IS NOT INITIAL.
            lv_resourcearn = lo_inputlambdaprocessordes->get_resourcearn( ).
            lv_rolearn = lo_inputlambdaprocessordes->get_rolearn( ).
          ENDIF.
        ENDIF.
        lo_kinesisstreamsinputdesc = lo_row_1->get_kinesisstreamsinputdesc( ).
        IF lo_kinesisstreamsinputdesc IS NOT INITIAL.
          lv_resourcearn = lo_kinesisstreamsinputdesc->get_resourcearn( ).
          lv_rolearn = lo_kinesisstreamsinputdesc->get_rolearn( ).
        ENDIF.
        lo_kinesisfirehoseinputdes = lo_row_1->get_kinesisfirehoseinputdesc( ).
        IF lo_kinesisfirehoseinputdes IS NOT INITIAL.
          lv_resourcearn = lo_kinesisfirehoseinputdes->get_resourcearn( ).
          lv_rolearn = lo_kinesisfirehoseinputdes->get_rolearn( ).
        ENDIF.
        lo_sourceschema = lo_row_1->get_inputschema( ).
        IF lo_sourceschema IS NOT INITIAL.
          lo_recordformat = lo_sourceschema->get_recordformat( ).
          IF lo_recordformat IS NOT INITIAL.
            lv_recordformattype = lo_recordformat->get_recordformattype( ).
            lo_mappingparameters = lo_recordformat->get_mappingparameters( ).
            IF lo_mappingparameters IS NOT INITIAL.
              lo_jsonmappingparameters = lo_mappingparameters->get_jsonmappingparameters( ).
              IF lo_jsonmappingparameters IS NOT INITIAL.
                lv_recordrowpath = lo_jsonmappingparameters->get_recordrowpath( ).
              ENDIF.
              lo_csvmappingparameters = lo_mappingparameters->get_csvmappingparameters( ).
              IF lo_csvmappingparameters IS NOT INITIAL.
                lv_recordrowdelimiter = lo_csvmappingparameters->get_recordrowdelimiter( ).
                lv_recordcolumndelimiter = lo_csvmappingparameters->get_recordcolumndelimiter( ).
              ENDIF.
            ENDIF.
          ENDIF.
          lv_recordencoding = lo_sourceschema->get_recordencoding( ).
          LOOP AT lo_sourceschema->get_recordcolumns( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_recordcolumnname = lo_row_5->get_name( ).
              lv_recordcolumnmapping = lo_row_5->get_mapping( ).
              lv_recordcolumnsqltype = lo_row_5->get_sqltype( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
        lo_inputparallelism = lo_row_1->get_inputparallelism( ).
        IF lo_inputparallelism IS NOT INITIAL.
          lv_inputparallelismcount = lo_inputparallelism->get_count( ).
        ENDIF.
        lo_inputstartingpositionco = lo_row_1->get_inpstartingpositionconf( ).
        IF lo_inputstartingpositionco IS NOT INITIAL.
          lv_inputstartingposition = lo_inputstartingpositionco->get_inputstartingposition( ).
        ENDIF.
      ENDIF.
    ENDLOOP.
    LOOP AT lo_applicationdetail->get_outputdescriptions( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_id = lo_row_7->get_outputid( ).
        lv_inappstreamname = lo_row_7->get_name( ).
        lo_kinesisstreamsoutputdes = lo_row_7->get_kinesisstreamsoutputdesc( ).
        IF lo_kinesisstreamsoutputdes IS NOT INITIAL.
          lv_resourcearn = lo_kinesisstreamsoutputdes->get_resourcearn( ).
          lv_rolearn = lo_kinesisstreamsoutputdes->get_rolearn( ).
        ENDIF.
        lo_kinesisfirehoseoutputde = lo_row_7->get_kinesisfirehoseoutdesc( ).
        IF lo_kinesisfirehoseoutputde IS NOT INITIAL.
          lv_resourcearn = lo_kinesisfirehoseoutputde->get_resourcearn( ).
          lv_rolearn = lo_kinesisfirehoseoutputde->get_rolearn( ).
        ENDIF.
        lo_lambdaoutputdescription = lo_row_7->get_lambdaoutputdescription( ).
        IF lo_lambdaoutputdescription IS NOT INITIAL.
          lv_resourcearn = lo_lambdaoutputdescription->get_resourcearn( ).
          lv_rolearn = lo_lambdaoutputdescription->get_rolearn( ).
        ENDIF.
        lo_destinationschema = lo_row_7->get_destinationschema( ).
        IF lo_destinationschema IS NOT INITIAL.
          lv_recordformattype = lo_destinationschema->get_recordformattype( ).
        ENDIF.
      ENDIF.
    ENDLOOP.
    LOOP AT lo_applicationdetail->get_referencedatasourcedescs( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_id = lo_row_9->get_referenceid( ).
        lv_inapptablename = lo_row_9->get_tablename( ).
        lo_s3referencedatasourcede = lo_row_9->get_s3referencedatasrcdesc( ).
        IF lo_s3referencedatasourcede IS NOT INITIAL.
          lv_bucketarn = lo_s3referencedatasourcede->get_bucketarn( ).
          lv_filekey = lo_s3referencedatasourcede->get_filekey( ).
          lv_rolearn = lo_s3referencedatasourcede->get_referencerolearn( ).
        ENDIF.
        lo_sourceschema = lo_row_9->get_referenceschema( ).
        IF lo_sourceschema IS NOT INITIAL.
          lo_recordformat = lo_sourceschema->get_recordformat( ).
          IF lo_recordformat IS NOT INITIAL.
            lv_recordformattype = lo_recordformat->get_recordformattype( ).
            lo_mappingparameters = lo_recordformat->get_mappingparameters( ).
            IF lo_mappingparameters IS NOT INITIAL.
              lo_jsonmappingparameters = lo_mappingparameters->get_jsonmappingparameters( ).
              IF lo_jsonmappingparameters IS NOT INITIAL.
                lv_recordrowpath = lo_jsonmappingparameters->get_recordrowpath( ).
              ENDIF.
              lo_csvmappingparameters = lo_mappingparameters->get_csvmappingparameters( ).
              IF lo_csvmappingparameters IS NOT INITIAL.
                lv_recordrowdelimiter = lo_csvmappingparameters->get_recordrowdelimiter( ).
                lv_recordcolumndelimiter = lo_csvmappingparameters->get_recordcolumndelimiter( ).
              ENDIF.
            ENDIF.
          ENDIF.
          lv_recordencoding = lo_sourceschema->get_recordencoding( ).
          LOOP AT lo_sourceschema->get_recordcolumns( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_recordcolumnname = lo_row_5->get_name( ).
              lv_recordcolumnmapping = lo_row_5->get_mapping( ).
              lv_recordcolumnsqltype = lo_row_5->get_sqltype( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
    ENDLOOP.
    LOOP AT lo_applicationdetail->get_cloudwatchlogoptiondescs( ) into lo_row_10.
      lo_row_11 = lo_row_10.
      IF lo_row_11 IS NOT INITIAL.
        lv_id = lo_row_11->get_cloudwatchlogoptionid( ).
        lv_logstreamarn = lo_row_11->get_logstreamarn( ).
        lv_rolearn = lo_row_11->get_rolearn( ).
      ENDIF.
    ENDLOOP.
    lv_applicationcode = lo_applicationdetail->get_applicationcode( ).
    lv_applicationversionid = lo_applicationdetail->get_applicationversionid( ).
  ENDIF.
ENDIF.