Skip to content

InputDescription

Source code in docs_src/capo_kinesis_analytics_v2/types/input_description.py
class InputDescription(TypedDict, closed=True):
    input_id: NotRequired["capo_kinesis_analytics_v2.types.id.Id"]
    """<p>The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application. </p>"""
    name_prefix: NotRequired[
        "capo_kinesis_analytics_v2.types.in_app_stream_name.InAppStreamName"
    ]
    """<p>The in-application name prefix.</p>"""
    in_app_stream_names: NotRequired[
        "capo_kinesis_analytics_v2.types.in_app_stream_names.InAppStreamNames"
    ]
    """<p>Returns the in-application stream names that are mapped to the stream source. </p>"""
    input_processing_configuration_description: NotRequired[
        "capo_kinesis_analytics_v2.types.input_processing_configuration_description.InputProcessingConfigurationDescription"
    ]
    """<p>The description of the preprocessor that executes on records in this input before the application's code is run. </p>"""
    kinesis_streams_input_description: NotRequired[
        "capo_kinesis_analytics_v2.types.kinesis_streams_input_description.KinesisStreamsInputDescription"
    ]
    """<p>If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN). </p>"""
    kinesis_firehose_input_description: NotRequired[
        "capo_kinesis_analytics_v2.types.kinesis_firehose_input_description.KinesisFirehoseInputDescription"
    ]
    """<p>If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN. </p>"""
    input_schema: NotRequired[
        "capo_kinesis_analytics_v2.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>"""
    input_parallelism: NotRequired[
        "capo_kinesis_analytics_v2.types.input_parallelism.InputParallelism"
    ]
    """<p>Describes the configured parallelism (number of in-application streams mapped to the streaming source). </p>"""
    input_starting_position_configuration: NotRequired[
        "capo_kinesis_analytics_v2.types.input_starting_position_configuration.InputStartingPositionConfiguration"
    ]
    """<p>The point at which the application is configured to read from the input stream.</p>"""

in_app_stream_names instance-attribute

in_app_stream_names: NotRequired[InAppStreamNames]

Returns the in-application stream names that are mapped to the stream source.

input_id instance-attribute

input_id: NotRequired[Id]

The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

input_parallelism instance-attribute

input_parallelism: NotRequired[InputParallelism]

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

input_processing_configuration_description instance-attribute

input_processing_configuration_description: NotRequired[
    InputProcessingConfigurationDescription
]

The description of the preprocessor that executes on records in this input before the application's code is run.

input_schema instance-attribute

input_schema: NotRequired[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.

input_starting_position_configuration instance-attribute

input_starting_position_configuration: NotRequired[InputStartingPositionConfiguration]

The point at which the application is configured to read from the input stream.

kinesis_firehose_input_description instance-attribute

kinesis_firehose_input_description: NotRequired[KinesisFirehoseInputDescription]

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

kinesis_streams_input_description instance-attribute

kinesis_streams_input_description: NotRequired[KinesisStreamsInputDescription]

If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

name_prefix instance-attribute

name_prefix: NotRequired[InAppStreamName]

The in-application name prefix.