/AWS1/CL_KNY=>LISTAPPLICATIONS()

About ListApplications

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 a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

If you want detailed information about a specific application, use DescribeApplication.

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

Method Signature

IMPORTING

Optional arguments:

iv_limit TYPE /AWS1/KNYLSTAPPLICATIONSINPLMT /AWS1/KNYLSTAPPLICATIONSINPLMT

Maximum number of applications to list.

iv_exclusivestrtapplicatio00 TYPE /AWS1/KNYAPPLICATIONNAME /AWS1/KNYAPPLICATIONNAME

Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

RETURNING

oo_output TYPE REF TO /aws1/cl_knylstapplicationsrsp /AWS1/CL_KNYLSTAPPLICATIONSRSP

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~listapplications(
  iv_exclusivestrtapplicatio00 = |string|
  iv_limit = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_applicationsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_applicationname = lo_row_1->get_applicationname( ).
      lv_resourcearn = lo_row_1->get_applicationarn( ).
      lv_applicationstatus = lo_row_1->get_applicationstatus( ).
    ENDIF.
  ENDLOOP.
  lv_booleanobject = lo_result->get_hasmoreapplications( ).
ENDIF.