Skip to content

/AWS1/CL_KNY=>ADDAPPLICATIONOUTPUT()

About AddApplicationOutput

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.

Adds an external destination to your Amazon Kinesis Analytics application.

If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination).

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

For the limits on the number of application inputs and outputs you can configure, see Limits.

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

Method Signature

IMPORTING

Required arguments:

iv_applicationname TYPE /AWS1/KNYAPPLICATIONNAME /AWS1/KNYAPPLICATIONNAME

Name of the application to which you want to add the output configuration.

iv_currentapplicationvrsid TYPE /AWS1/KNYAPPLICATIONVERSIONID /AWS1/KNYAPPLICATIONVERSIONID

Version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

io_output TYPE REF TO /AWS1/CL_KNYOUTPUT /AWS1/CL_KNYOUTPUT

An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.

RETURNING

oo_output TYPE REF TO /aws1/cl_knyaddapplicationou01 /AWS1/CL_KNYADDAPPLICATIONOU01

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~addapplicationoutput(
  io_output = new /aws1/cl_knyoutput(
    io_destinationschema = new /aws1/cl_knydestinationschema( |string| )
    io_kinesisfirehoseoutput = new /aws1/cl_knykinesisfirehoseout(
      iv_resourcearn = |string|
      iv_rolearn = |string|
    )
    io_kinesisstreamsoutput = new /aws1/cl_knykinesisstreamsout(
      iv_resourcearn = |string|
      iv_rolearn = |string|
    )
    io_lambdaoutput = new /aws1/cl_knylambdaoutput(
      iv_resourcearn = |string|
      iv_rolearn = |string|
    )
    iv_name = |string|
  )
  iv_applicationname = |string|
  iv_currentapplicationvrsid = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.