| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.KinesisAnalytics.DiscoverInputSchema
Description
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
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
- data DiscoverInputSchema = DiscoverInputSchema' {}
- newDiscoverInputSchema :: DiscoverInputSchema
- discoverInputSchema_inputProcessingConfiguration :: Lens' DiscoverInputSchema (Maybe InputProcessingConfiguration)
- discoverInputSchema_inputStartingPositionConfiguration :: Lens' DiscoverInputSchema (Maybe InputStartingPositionConfiguration)
- discoverInputSchema_resourceARN :: Lens' DiscoverInputSchema (Maybe Text)
- discoverInputSchema_roleARN :: Lens' DiscoverInputSchema (Maybe Text)
- discoverInputSchema_s3Configuration :: Lens' DiscoverInputSchema (Maybe S3Configuration)
- data DiscoverInputSchemaResponse = DiscoverInputSchemaResponse' {
- inputSchema :: Maybe SourceSchema
- parsedInputRecords :: Maybe [[Text]]
- processedInputRecords :: Maybe [Text]
- rawInputRecords :: Maybe [Text]
- httpStatus :: Int
- newDiscoverInputSchemaResponse :: Int -> DiscoverInputSchemaResponse
- discoverInputSchemaResponse_inputSchema :: Lens' DiscoverInputSchemaResponse (Maybe SourceSchema)
- discoverInputSchemaResponse_parsedInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [[Text]])
- discoverInputSchemaResponse_processedInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [Text])
- discoverInputSchemaResponse_rawInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [Text])
- discoverInputSchemaResponse_httpStatus :: Lens' DiscoverInputSchemaResponse Int
Creating a Request
data DiscoverInputSchema Source #
See: newDiscoverInputSchema smart constructor.
Constructors
| DiscoverInputSchema' | |
Fields
| |
Instances
newDiscoverInputSchema :: DiscoverInputSchema 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:
DiscoverInputSchema, discoverInputSchema_inputProcessingConfiguration - The
InputProcessingConfiguration
to use to preprocess the records before discovering the schema of the
records.
DiscoverInputSchema, discoverInputSchema_inputStartingPositionConfiguration - Point at which you want Amazon Kinesis Analytics to start reading
records from the specified streaming source discovery purposes.
DiscoverInputSchema, discoverInputSchema_resourceARN - Amazon Resource Name (ARN) of the streaming source.
DiscoverInputSchema, discoverInputSchema_roleARN - ARN of the IAM role that Amazon Kinesis Analytics can assume to access
the stream on your behalf.
$sel:s3Configuration:DiscoverInputSchema', discoverInputSchema_s3Configuration - Specify this parameter to discover a schema from data in an Amazon S3
object.
Request Lenses
discoverInputSchema_inputProcessingConfiguration :: Lens' DiscoverInputSchema (Maybe InputProcessingConfiguration) Source #
The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
discoverInputSchema_inputStartingPositionConfiguration :: Lens' DiscoverInputSchema (Maybe InputStartingPositionConfiguration) Source #
Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.
discoverInputSchema_resourceARN :: Lens' DiscoverInputSchema (Maybe Text) Source #
Amazon Resource Name (ARN) of the streaming source.
discoverInputSchema_roleARN :: Lens' DiscoverInputSchema (Maybe Text) Source #
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.
discoverInputSchema_s3Configuration :: Lens' DiscoverInputSchema (Maybe S3Configuration) Source #
Specify this parameter to discover a schema from data in an Amazon S3 object.
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:
DiscoverInputSchemaResponse, discoverInputSchemaResponse_inputSchema - 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: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:processedInputRecords:DiscoverInputSchemaResponse', discoverInputSchemaResponse_processedInputRecords - Stream data that was modified by the processor specified in the
InputProcessingConfiguration parameter.
$sel:rawInputRecords:DiscoverInputSchemaResponse', discoverInputSchemaResponse_rawInputRecords - Raw stream data that was sampled to infer the schema.
$sel:httpStatus:DiscoverInputSchemaResponse', discoverInputSchemaResponse_httpStatus - The response's http status code.
Response Lenses
discoverInputSchemaResponse_inputSchema :: 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.
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_processedInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [Text]) Source #
Stream data that was modified by the processor specified in the
InputProcessingConfiguration parameter.
discoverInputSchemaResponse_rawInputRecords :: Lens' DiscoverInputSchemaResponse (Maybe [Text]) Source #
Raw stream data that was sampled to infer the schema.
discoverInputSchemaResponse_httpStatus :: Lens' DiscoverInputSchemaResponse Int Source #
The response's http status code.