| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisAnalyticsV2.DiscoverInputSchema
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.
Synopsis
- data DiscoverInputSchema = DiscoverInputSchema' {}
- newDiscoverInputSchema :: Text -> DiscoverInputSchema
- discoverInputSchema_inputStartingPositionConfiguration :: Lens' DiscoverInputSchema (Maybe InputStartingPositionConfiguration)
- discoverInputSchema_inputProcessingConfiguration :: Lens' DiscoverInputSchema (Maybe InputProcessingConfiguration)
- discoverInputSchema_s3Configuration :: Lens' DiscoverInputSchema (Maybe S3Configuration)
- discoverInputSchema_resourceARN :: Lens' DiscoverInputSchema (Maybe Text)
- discoverInputSchema_serviceExecutionRole :: Lens' DiscoverInputSchema Text
- data DiscoverInputSchemaResponse = DiscoverInputSchemaResponse' {
- rawInputRecords :: Maybe [Text]
- inputSchema :: Maybe SourceSchema
- processedInputRecords :: Maybe [Text]
- parsedInputRecords :: Maybe [[Text]]
- httpStatus :: Int
- newDiscoverInputSchemaResponse :: Int -> DiscoverInputSchemaResponse
- discoverInputSchemaResponse_rawInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [Text])
- discoverInputSchemaResponse_inputSchema :: Lens' DiscoverInputSchemaResponse (Maybe SourceSchema)
- discoverInputSchemaResponse_processedInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [Text])
- discoverInputSchemaResponse_parsedInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [[Text]])
- discoverInputSchemaResponse_httpStatus :: Lens' DiscoverInputSchemaResponse Int
Creating a Request
data DiscoverInputSchema Source #
See: newDiscoverInputSchema smart constructor.
Constructors
| DiscoverInputSchema' | |
Fields
| |
Instances
newDiscoverInputSchema Source #
Create a value of DiscoverInputSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputStartingPositionConfiguration:DiscoverInputSchema', discoverInputSchema_inputStartingPositionConfiguration - The point at which you want Kinesis Data Analytics to start reading
records from the specified streaming source discovery purposes.
$sel:inputProcessingConfiguration:DiscoverInputSchema', discoverInputSchema_inputProcessingConfiguration - The InputProcessingConfiguration to use to preprocess the records before
discovering the schema of the records.
$sel:s3Configuration:DiscoverInputSchema', discoverInputSchema_s3Configuration - Specify this parameter to discover a schema from data in an Amazon S3
object.
$sel:resourceARN:DiscoverInputSchema', discoverInputSchema_resourceARN - The Amazon Resource Name (ARN) of the streaming source.
$sel:serviceExecutionRole:DiscoverInputSchema', discoverInputSchema_serviceExecutionRole - The ARN of the role that is used to access the streaming source.
Request Lenses
discoverInputSchema_inputStartingPositionConfiguration :: Lens' DiscoverInputSchema (Maybe InputStartingPositionConfiguration) Source #
The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes.
discoverInputSchema_inputProcessingConfiguration :: Lens' DiscoverInputSchema (Maybe InputProcessingConfiguration) Source #
The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
discoverInputSchema_s3Configuration :: Lens' DiscoverInputSchema (Maybe S3Configuration) Source #
Specify this parameter to discover a schema from data in an Amazon S3 object.
discoverInputSchema_resourceARN :: Lens' DiscoverInputSchema (Maybe Text) Source #
The Amazon Resource Name (ARN) of the streaming source.
discoverInputSchema_serviceExecutionRole :: Lens' DiscoverInputSchema Text Source #
The ARN of the role that is used to access the streaming source.
Destructuring the Response
data DiscoverInputSchemaResponse Source #
See: newDiscoverInputSchemaResponse smart constructor.
Constructors
| DiscoverInputSchemaResponse' | |
Fields
| |
Instances
newDiscoverInputSchemaResponse Source #
Create a value of DiscoverInputSchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rawInputRecords:DiscoverInputSchemaResponse', discoverInputSchemaResponse_rawInputRecords - The raw stream data that was sampled to infer the schema.
$sel:inputSchema:DiscoverInputSchemaResponse', discoverInputSchemaResponse_inputSchema - The schema inferred from the streaming source. It identifies the format
of the data in the streaming source and how each data element maps to
corresponding columns in the in-application stream that you can create.
$sel:processedInputRecords:DiscoverInputSchemaResponse', discoverInputSchemaResponse_processedInputRecords - The stream data that was modified by the processor specified in the
InputProcessingConfiguration parameter.
$sel:parsedInputRecords:DiscoverInputSchemaResponse', discoverInputSchemaResponse_parsedInputRecords - An array of elements, where each element corresponds to a row in a
stream record (a stream record can have more than one row).
$sel:httpStatus:DiscoverInputSchemaResponse', discoverInputSchemaResponse_httpStatus - The response's http status code.
Response Lenses
discoverInputSchemaResponse_rawInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [Text]) Source #
The raw stream data that was sampled to infer the schema.
discoverInputSchemaResponse_inputSchema :: Lens' DiscoverInputSchemaResponse (Maybe SourceSchema) Source #
The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.
discoverInputSchemaResponse_processedInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [Text]) Source #
The stream data that was modified by the processor specified in the
InputProcessingConfiguration parameter.
discoverInputSchemaResponse_parsedInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [[Text]]) Source #
An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).
discoverInputSchemaResponse_httpStatus :: Lens' DiscoverInputSchemaResponse Int Source #
The response's http status code.