Skip to content

Input

Source code in docs_src/capo_kinesis_analytics/types/input.py
class Input(TypedDict, closed=True):
    name_prefix: "capo_kinesis_analytics.types.in_app_stream_name.InAppStreamName"
    """<p>Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the <code>InputParallelism</code> count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on. </p>"""
    input_processing_configuration: NotRequired[
        "capo_kinesis_analytics.types.input_processing_configuration.InputProcessingConfiguration"
    ]
    """<p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a>.</p>"""
    kinesis_streams_input: NotRequired[
        "capo_kinesis_analytics.types.kinesis_streams_input.KinesisStreamsInput"
    ]
    """<p>If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p> <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>"""
    kinesis_firehose_input: NotRequired[
        "capo_kinesis_analytics.types.kinesis_firehose_input.KinesisFirehoseInput"
    ]
    """<p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p> <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>"""
    input_parallelism: NotRequired[
        "capo_kinesis_analytics.types.input_parallelism.InputParallelism"
    ]
    """<p>Describes the number of in-application streams to create. </p> <p>Data from your source is routed to these in-application input streams.</p> <p> (see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.</p>"""
    input_schema: "capo_kinesis_analytics.types.source_schema.SourceSchema"
    """<p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.</p> <p>Also used to describe the format of the reference data source.</p>"""

input_parallelism instance-attribute

input_parallelism: NotRequired[InputParallelism]

Describes the number of in-application streams to create.

Data from your source is routed to these in-application input streams.

(see Configuring Application Input.

input_processing_configuration instance-attribute

input_processing_configuration: NotRequired[InputProcessingConfiguration]

The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

input_schema instance-attribute

input_schema: SourceSchema

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

Also used to describe the format of the reference data source.

kinesis_firehose_input instance-attribute

kinesis_firehose_input: NotRequired[KinesisFirehoseInput]

If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

kinesis_streams_input instance-attribute

kinesis_streams_input: NotRequired[KinesisStreamsInput]

If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

name_prefix instance-attribute

name_prefix: InAppStreamName

Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.