Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AddApplicationOutput

Adds an external destination to your SQL-based Kinesis Data Analytics application.

If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon 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.

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.

Request Syntax


{
   "ApplicationName": "string",
   "CurrentApplicationVersionId": number,
   "Output": { 
      "DestinationSchema": { 
         "RecordFormatType": "string"
      },
      "KinesisFirehoseOutput": { 
         "ResourceARN": "string"
      },
      "KinesisStreamsOutput": { 
         "ResourceARN": "string"
      },
      "LambdaOutput": { 
         "ResourceARN": "string"
      },
      "Name": "string"
   }
}

Request Parameters

The request accepts the following data in JSON format.

ApplicationName

The name of the application to which you want to add the output configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

CurrentApplicationVersionId

The 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.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 999999999.

Required: Yes

Output

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, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.

Type: Output object

Required: Yes

Response Syntax


{
   "ApplicationARN": "string",
   "ApplicationVersionId": number,
   "OutputDescriptions": [ 
      { 
         "DestinationSchema": { 
            "RecordFormatType": "string"
         },
         "KinesisFirehoseOutputDescription": { 
            "ResourceARN": "string",
            "RoleARN": "string"
         },
         "KinesisStreamsOutputDescription": { 
            "ResourceARN": "string",
            "RoleARN": "string"
         },
         "LambdaOutputDescription": { 
            "ResourceARN": "string",
            "RoleARN": "string"
         },
         "Name": "string",
         "OutputId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApplicationARN

The application Amazon Resource Name (ARN).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:.*

ApplicationVersionId

The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 999999999.

OutputDescriptions

Describes the application output configuration. For more information, see Configuring Application Output.

Type: Array of OutputDescription objects

Errors

ConcurrentModificationException

Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

HTTP Status Code: 400

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

InvalidRequestException

The request JSON is not valid for the operation.

HTTP Status Code: 400

ResourceInUseException

The application is not available for this operation.

HTTP Status Code: 400

ResourceNotFoundException

Specified application can't be found.

HTTP Status Code: 400