KinesisAnalyticsV2 / Client / add_application_input

add_application_input#

KinesisAnalyticsV2.Client.add_application_input(**kwargs)#

Adds a streaming source to your SQL-based Kinesis Data Analytics application.

You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

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

response = client.add_application_input(
    ApplicationName='string',
    CurrentApplicationVersionId=123,
    Input={
        'NamePrefix': 'string',
        'InputProcessingConfiguration': {
            'InputLambdaProcessor': {
                'ResourceARN': 'string'
            }
        },
        'KinesisStreamsInput': {
            'ResourceARN': 'string'
        },
        'KinesisFirehoseInput': {
            'ResourceARN': 'string'
        },
        'InputParallelism': {
            'Count': 123
        },
        'InputSchema': {
            'RecordFormat': {
                'RecordFormatType': 'JSON'|'CSV',
                'MappingParameters': {
                    'JSONMappingParameters': {
                        'RecordRowPath': 'string'
                    },
                    'CSVMappingParameters': {
                        'RecordRowDelimiter': 'string',
                        'RecordColumnDelimiter': 'string'
                    }
                }
            },
            'RecordEncoding': 'string',
            'RecordColumns': [
                {
                    'Name': 'string',
                    'Mapping': 'string',
                    'SqlType': 'string'
                },
            ]
        }
    }
)

Parameters:

ApplicationName (string) –
[REQUIRED]

The name of your existing application to which you want to add the streaming source.
CurrentApplicationVersionId (integer) –
[REQUIRED]

The current version of your application. You must provide the ApplicationVersionID or the ConditionalToken.You can use the DescribeApplication operation to find the current application version.
Input (dict) –
[REQUIRED]

The Input to add.
- NamePrefix (string) – [REQUIRED]
  
  The name prefix to use when creating an in-application stream. Suppose that you specify a prefix “ MyInApplicationStream.” Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names “ MyInApplicationStream_001,” “ MyInApplicationStream_002,” and so on.
- InputProcessingConfiguration (dict) –
  
  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.
  - InputLambdaProcessor (dict) – [REQUIRED]
    
    The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
    - ResourceARN (string) – [REQUIRED]
      
      The ARN of the Amazon 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: Amazon Lambda
- KinesisStreamsInput (dict) –
  
  If the streaming source is an Amazon Kinesis data stream, identifies the stream’s Amazon Resource Name (ARN).
  - ResourceARN (string) – [REQUIRED]
    
    The ARN of the input Kinesis data stream to read.
- KinesisFirehoseInput (dict) –
  
  If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream’s ARN.
  - ResourceARN (string) – [REQUIRED]
    
    The Amazon Resource Name (ARN) of the delivery stream.
- InputParallelism (dict) –
  
  Describes the number of in-application streams to create.
  - Count (integer) –
    
    The number of in-application streams to create.
- InputSchema (dict) – [REQUIRED]
  
  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.
  - RecordFormat (dict) – [REQUIRED]
    
    Specifies the format of the records on the streaming source.
    - RecordFormatType (string) – [REQUIRED]
      
      The type of record format.
    - MappingParameters (dict) –
      
      When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
      - JSONMappingParameters (dict) –
        
        Provides additional mapping information when JSON is the record format on the streaming source.
        
        RecordRowPath (string) – [REQUIRED]
        
        The path to the top-level parent that contains the records.
      - CSVMappingParameters (dict) –
        
        Provides additional mapping information when the record format uses delimiters (for example, CSV).
        
        RecordRowDelimiter (string) – [REQUIRED]
        
        The row delimiter. For example, in a CSV format, ‘n’ is the typical row delimiter.
        
        RecordColumnDelimiter (string) – [REQUIRED]
        
        The column delimiter. For example, in a CSV format, a comma (“,”) is the typical column delimiter.
  - RecordEncoding (string) –
    
    Specifies the encoding of the records in the streaming source. For example, UTF-8.
  - RecordColumns (list) – [REQUIRED]
    
    A list of RecordColumn objects.
    - (dict) –
      
      For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
      
      Also used to describe the format of the reference data source.
      - Name (string) – [REQUIRED]
        
        The name of the column that is created in the in-application input stream or reference table.
      - Mapping (string) –
        
        A reference to the data element in the streaming input or the reference data source.
      - SqlType (string) – [REQUIRED]
        
        The type of column created in the in-application input stream or reference table.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationARN': 'string',
    'ApplicationVersionId': 123,
    'InputDescriptions': [
        {
            'InputId': 'string',
            'NamePrefix': 'string',
            'InAppStreamNames': [
                'string',
            ],
            'InputProcessingConfigurationDescription': {
                'InputLambdaProcessorDescription': {
                    'ResourceARN': 'string',
                    'RoleARN': 'string'
                }
            },
            'KinesisStreamsInputDescription': {
                'ResourceARN': 'string',
                'RoleARN': 'string'
            },
            'KinesisFirehoseInputDescription': {
                'ResourceARN': 'string',
                'RoleARN': 'string'
            },
            'InputSchema': {
                'RecordFormat': {
                    'RecordFormatType': 'JSON'|'CSV',
                    'MappingParameters': {
                        'JSONMappingParameters': {
                            'RecordRowPath': 'string'
                        },
                        'CSVMappingParameters': {
                            'RecordRowDelimiter': 'string',
                            'RecordColumnDelimiter': 'string'
                        }
                    }
                },
                'RecordEncoding': 'string',
                'RecordColumns': [
                    {
                        'Name': 'string',
                        'Mapping': 'string',
                        'SqlType': 'string'
                    },
                ]
            },
            'InputParallelism': {
                'Count': 123
            },
            'InputStartingPositionConfiguration': {
                'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
            }
        },
    ]
}

Response Structure

(dict) –
- ApplicationARN (string) –
  
  The Amazon Resource Name (ARN) of the application.
- ApplicationVersionId (integer) –
  
  Provides the current application version.
- InputDescriptions (list) –
  
  Describes the application input configuration.
  - (dict) –
    
    Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
    - InputId (string) –
      
      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.
    - NamePrefix (string) –
      
      The in-application name prefix.
    - InAppStreamNames (list) –
      
      Returns the in-application stream names that are mapped to the stream source.
      - (string) –
    - InputProcessingConfigurationDescription (dict) –
      
      The description of the preprocessor that executes on records in this input before the application’s code is run.
      - InputLambdaProcessorDescription (dict) –
        
        Provides configuration information about the associated InputLambdaProcessorDescription
        
        ResourceARN (string) –
        
        The ARN of the Amazon Lambda function that is used to preprocess the 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: Amazon Lambda
        
        RoleARN (string) –
        
        The ARN of the IAM role that is used to access the Amazon Lambda function.
        
        Note
        Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
    - KinesisStreamsInputDescription (dict) –
      
      If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream’s Amazon Resource Name (ARN).
      - ResourceARN (string) –
        
        The Amazon Resource Name (ARN) of the Kinesis data stream.
      - RoleARN (string) –
        
        The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
        
        Note
        Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
    - KinesisFirehoseInputDescription (dict) –
      
      If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream’s ARN.
      - ResourceARN (string) –
        
        The Amazon Resource Name (ARN) of the delivery stream.
      - RoleARN (string) –
        
        The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
        
        Note
        Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
    - InputSchema (dict) –
      
      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.
      - RecordFormat (dict) –
        
        Specifies the format of the records on the streaming source.
        
        RecordFormatType (string) –
        
        The type of record format.
        
        MappingParameters (dict) –
        
        When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
        
        JSONMappingParameters (dict) –
        
        Provides additional mapping information when JSON is the record format on the streaming source.
        
        RecordRowPath (string) –
        
        The path to the top-level parent that contains the records.
        
        CSVMappingParameters (dict) –
        
        Provides additional mapping information when the record format uses delimiters (for example, CSV).
        
        RecordRowDelimiter (string) –
        
        The row delimiter. For example, in a CSV format, ‘n’ is the typical row delimiter.
        
        RecordColumnDelimiter (string) –
        
        The column delimiter. For example, in a CSV format, a comma (“,”) is the typical column delimiter.
      - RecordEncoding (string) –
        
        Specifies the encoding of the records in the streaming source. For example, UTF-8.
      - RecordColumns (list) –
        
        A list of RecordColumn objects.
        
        (dict) –
        
        For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
        
        Also used to describe the format of the reference data source.
        
        Name (string) –
        
        The name of the column that is created in the in-application input stream or reference table.
        
        Mapping (string) –
        
        A reference to the data element in the streaming input or the reference data source.
        
        SqlType (string) –
        
        The type of column created in the in-application input stream or reference table.
    - InputParallelism (dict) –
      
      Describes the configured parallelism (number of in-application streams mapped to the streaming source).
      - Count (integer) –
        
        The number of in-application streams to create.
    - InputStartingPositionConfiguration (dict) –
      
      The point at which the application is configured to read from the input stream.
      - InputStartingPosition (string) –
        
        The starting position on the stream.
        
        NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.
        
        TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
        
        LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

Exceptions

KinesisAnalyticsV2.Client.exceptions.ResourceNotFoundException
KinesisAnalyticsV2.Client.exceptions.ResourceInUseException
KinesisAnalyticsV2.Client.exceptions.InvalidArgumentException
KinesisAnalyticsV2.Client.exceptions.ConcurrentModificationException
KinesisAnalyticsV2.Client.exceptions.CodeValidationException
KinesisAnalyticsV2.Client.exceptions.InvalidRequestException