[ aws . kinesisanalytics ]

add-application-input-processing-configuration

Description

Note

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  add-application-input-processing-configuration
--application-name <value>
--current-application-version-id <value>
--input-id <value>
--input-processing-configuration <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-name (string)

Name of the application to which you want to add the input processing configuration.

--current-application-version-id (long)

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 ConcurrentModificationException is returned.

--input-id (string)

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.

--input-processing-configuration (structure)

The InputProcessingConfiguration to add to the application.

InputLambdaProcessor -> (structure)

The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

ResourceARN -> (string)

The ARN of the AWS Lambda function that operates on records in the stream.

Note

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

RoleARN -> (string)

The ARN of the IAM role that is used to access the AWS Lambda function.

Shorthand Syntax:

InputLambdaProcessor={ResourceARN=string,RoleARN=string}

JSON Syntax:

{
  "InputLambdaProcessor": {
    "ResourceARN": "string",
    "RoleARN": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

None