Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or 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. For conceptual information, see Configuring Application Input . Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema
action.
Synopsis
- discoverInputSchema :: DiscoverInputSchema
- data DiscoverInputSchema
- disInputStartingPositionConfiguration :: Lens' DiscoverInputSchema (Maybe InputStartingPositionConfiguration)
- disInputProcessingConfiguration :: Lens' DiscoverInputSchema (Maybe InputProcessingConfiguration)
- disS3Configuration :: Lens' DiscoverInputSchema (Maybe S3Configuration)
- disResourceARN :: Lens' DiscoverInputSchema (Maybe Text)
- disRoleARN :: Lens' DiscoverInputSchema (Maybe Text)
- discoverInputSchemaResponse :: Int -> DiscoverInputSchemaResponse
- data DiscoverInputSchemaResponse
- disrsRawInputRecords :: Lens' DiscoverInputSchemaResponse [Text]
- disrsInputSchema :: Lens' DiscoverInputSchemaResponse (Maybe SourceSchema)
- disrsProcessedInputRecords :: Lens' DiscoverInputSchemaResponse [Text]
- disrsParsedInputRecords :: Lens' DiscoverInputSchemaResponse [[Text]]
- disrsResponseStatus :: Lens' DiscoverInputSchemaResponse Int
Creating a Request
discoverInputSchema :: DiscoverInputSchema Source #
Creates a value of DiscoverInputSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
disInputStartingPositionConfiguration
- Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.disInputProcessingConfiguration
- TheInputProcessingConfiguration
to use to preprocess the records before discovering the schema of the records.disS3Configuration
- Specify this parameter to discover a schema from data in an S3 object.disResourceARN
- Amazon Resource Name (ARN) of the streaming source.disRoleARN
- ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.
data DiscoverInputSchema Source #
See: discoverInputSchema
smart constructor.
Instances
Request Lenses
disInputStartingPositionConfiguration :: Lens' DiscoverInputSchema (Maybe InputStartingPositionConfiguration) Source #
Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.
disInputProcessingConfiguration :: Lens' DiscoverInputSchema (Maybe InputProcessingConfiguration) Source #
The InputProcessingConfiguration
to use to preprocess the records before discovering the schema of the records.
disS3Configuration :: Lens' DiscoverInputSchema (Maybe S3Configuration) Source #
Specify this parameter to discover a schema from data in an S3 object.
disResourceARN :: Lens' DiscoverInputSchema (Maybe Text) Source #
Amazon Resource Name (ARN) of the streaming source.
disRoleARN :: Lens' DiscoverInputSchema (Maybe Text) Source #
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.
Destructuring the Response
discoverInputSchemaResponse Source #
Creates a value of DiscoverInputSchemaResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
disrsRawInputRecords
- Raw stream data that was sampled to infer the schema.disrsInputSchema
- 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.disrsProcessedInputRecords
- Stream data that was modified by the processor specified in theInputProcessingConfiguration
parameter.disrsParsedInputRecords
- An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).disrsResponseStatus
- -- | The response status code.
data DiscoverInputSchemaResponse Source #
See: discoverInputSchemaResponse
smart constructor.
Instances
Response Lenses
disrsRawInputRecords :: Lens' DiscoverInputSchemaResponse [Text] Source #
Raw stream data that was sampled to infer the schema.
disrsInputSchema :: Lens' DiscoverInputSchemaResponse (Maybe SourceSchema) Source #
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.
disrsProcessedInputRecords :: Lens' DiscoverInputSchemaResponse [Text] Source #
Stream data that was modified by the processor specified in the InputProcessingConfiguration
parameter.
disrsParsedInputRecords :: Lens' DiscoverInputSchemaResponse [[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).
disrsResponseStatus :: Lens' DiscoverInputSchemaResponse Int Source #
- - | The response status code.