KinesisAnalyticsV2 / Client / add_application_reference_data_source

add_application_reference_data_source#

KinesisAnalyticsV2.Client.add_application_reference_data_source(**kwargs)#

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.

Request Syntax

response = client.add_application_reference_data_source(
    ApplicationName='string',
    CurrentApplicationVersionId=123,
    ReferenceDataSource={
        'TableName': 'string',
        'S3ReferenceDataSource': {
            'BucketARN': 'string',
            'FileKey': 'string'
        },
        'ReferenceSchema': {
            '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 an existing application.
CurrentApplicationVersionId (integer) –
[REQUIRED]

The version of the application for which you are adding the reference data source. 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.
ReferenceDataSource (dict) –
[REQUIRED]

The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.
- TableName (string) – [REQUIRED]
  
  The name of the in-application table to create.
- S3ReferenceDataSource (dict) –
  
  Identifies the S3 bucket and object that contains the reference data. A SQL-based Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
  - BucketARN (string) –
    
    The Amazon Resource Name (ARN) of the S3 bucket.
  - FileKey (string) –
    
    The object key name containing the reference data.
- ReferenceSchema (dict) – [REQUIRED]
  
  Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
  - 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,
    'ReferenceDataSourceDescriptions': [
        {
            'ReferenceId': 'string',
            'TableName': 'string',
            'S3ReferenceDataSourceDescription': {
                'BucketARN': 'string',
                'FileKey': 'string',
                'ReferenceRoleARN': 'string'
            },
            'ReferenceSchema': {
                'RecordFormat': {
                    'RecordFormatType': 'JSON'|'CSV',
                    'MappingParameters': {
                        'JSONMappingParameters': {
                            'RecordRowPath': 'string'
                        },
                        'CSVMappingParameters': {
                            'RecordRowDelimiter': 'string',
                            'RecordColumnDelimiter': 'string'
                        }
                    }
                },
                'RecordEncoding': 'string',
                'RecordColumns': [
                    {
                        'Name': 'string',
                        'Mapping': 'string',
                        'SqlType': 'string'
                    },
                ]
            }
        },
    ]
}

Response Structure

(dict) –
- ApplicationARN (string) –
  
  The application Amazon Resource Name (ARN).
- ApplicationVersionId (integer) –
  
  The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
- ReferenceDataSourceDescriptions (list) –
  
  Describes reference data sources configured for the application.
  - (dict) –
    
    For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
    - ReferenceId (string) –
      
      The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
    - TableName (string) –
      
      The in-application table name created by the specific reference data source configuration.
    - S3ReferenceDataSourceDescription (dict) –
      
      Provides the Amazon S3 bucket name, the object key name that contains the reference data.
      - BucketARN (string) –
        
        The Amazon Resource Name (ARN) of the S3 bucket.
      - FileKey (string) –
        
        Amazon S3 object key name.
      - ReferenceRoleARN (string) –
        
        The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
        
        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.
    - ReferenceSchema (dict) –
      
      Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
      - 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.

add_application_reference_data_source#

Request Syntax

Response Syntax

Response Structure

Note

Exceptions