- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
AddApplicationInputProcessingConfigurationCommand
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 InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KinesisAnalyticsClient, AddApplicationInputProcessingConfigurationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import
// const { KinesisAnalyticsClient, AddApplicationInputProcessingConfigurationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import
const client = new KinesisAnalyticsClient(config);
const input = { // AddApplicationInputProcessingConfigurationRequest
ApplicationName: "STRING_VALUE", // required
CurrentApplicationVersionId: Number("long"), // required
InputId: "STRING_VALUE", // required
InputProcessingConfiguration: { // InputProcessingConfiguration
InputLambdaProcessor: { // InputLambdaProcessor
ResourceARN: "STRING_VALUE", // required
RoleARN: "STRING_VALUE", // required
},
},
};
const command = new AddApplicationInputProcessingConfigurationCommand(input);
const response = await client.send(command);
// {};
AddApplicationInputProcessingConfigurationCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ApplicationNameRequired | string | undefined | Name of the application to which you want to add the input processing configuration. |
CurrentApplicationVersionIdRequired | number | undefined | Version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the |
InputIdRequired | string | undefined | The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation. |
InputProcessingConfigurationRequired | InputProcessingConfiguration | undefined | The InputProcessingConfiguration to add to the application. |
AddApplicationInputProcessingConfigurationCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| ConcurrentModificationException | client | Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time. |
| InvalidArgumentException | client | Specified input parameter value is invalid. |
| ResourceInUseException | client | Application is not available for this operation. |
| ResourceNotFoundException | client | Specified application can't be found. |
| UnsupportedOperationException | client | The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. |
| KinesisAnalyticsServiceException | Base exception class for all service exceptions from KinesisAnalytics service. |