Discover Input Schema

kinesisanalyticsv2_discover_input_schema

R Documentation

Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object

Description

Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

Usage

kinesisanalyticsv2_discover_input_schema(ResourceARN,
  ServiceExecutionRole, InputStartingPositionConfiguration,
  S3Configuration, InputProcessingConfiguration)

Arguments

ResourceARN

The Amazon Resource Name (ARN) of the streaming source.

ServiceExecutionRole

[required] The ARN of the role that is used to access the streaming source.

InputStartingPositionConfiguration

The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source for discovery purposes.

S3Configuration

Specify this parameter to discover a schema from data in an Amazon S3 object.

InputProcessingConfiguration

The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

Value

A list with the following syntax:

list(
  InputSchema = list(
    RecordFormat = list(
      RecordFormatType = "JSON"|"CSV",
      MappingParameters = list(
        JSONMappingParameters = list(
          RecordRowPath = "string"
        ),
        CSVMappingParameters = list(
          RecordRowDelimiter = "string",
          RecordColumnDelimiter = "string"
        )
      )
    ),
    RecordEncoding = "string",
    RecordColumns = list(
      list(
        Name = "string",
        Mapping = "string",
        SqlType = "string"
      )
    )
  ),
  ParsedInputRecords = list(
    list(
      "string"
    )
  ),
  ProcessedInputRecords = list(
    "string"
  ),
  RawInputRecords = list(
    "string"
  )
)

Request syntax

svc$discover_input_schema(
  ResourceARN = "string",
  ServiceExecutionRole = "string",
  InputStartingPositionConfiguration = list(
    InputStartingPosition = "NOW"|"TRIM_HORIZON"|"LAST_STOPPED_POINT"
  ),
  S3Configuration = list(
    BucketARN = "string",
    FileKey = "string"
  ),
  InputProcessingConfiguration = list(
    InputLambdaProcessor = list(
      ResourceARN = "string"
    )
  )
)