amazonka-kinesis-analytics-1.6.0: Amazon Kinesis Analytics SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.KinesisAnalytics.DiscoverInputSchema

Contents

Description

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

Creating a Request

discoverInputSchema :: DiscoverInputSchema #

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:

data DiscoverInputSchema #

See: discoverInputSchema smart constructor.

Instances

Eq DiscoverInputSchema # 
Data DiscoverInputSchema # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DiscoverInputSchema -> c DiscoverInputSchema #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DiscoverInputSchema #

toConstr :: DiscoverInputSchema -> Constr #

dataTypeOf :: DiscoverInputSchema -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DiscoverInputSchema) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DiscoverInputSchema) #

gmapT :: (forall b. Data b => b -> b) -> DiscoverInputSchema -> DiscoverInputSchema #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DiscoverInputSchema -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DiscoverInputSchema -> r #

gmapQ :: (forall d. Data d => d -> u) -> DiscoverInputSchema -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DiscoverInputSchema -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DiscoverInputSchema -> m DiscoverInputSchema #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DiscoverInputSchema -> m DiscoverInputSchema #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DiscoverInputSchema -> m DiscoverInputSchema #

Read DiscoverInputSchema # 
Show DiscoverInputSchema # 
Generic DiscoverInputSchema # 
Hashable DiscoverInputSchema # 
ToJSON DiscoverInputSchema # 
NFData DiscoverInputSchema # 

Methods

rnf :: DiscoverInputSchema -> () #

AWSRequest DiscoverInputSchema # 
ToHeaders DiscoverInputSchema # 
ToPath DiscoverInputSchema # 
ToQuery DiscoverInputSchema # 
type Rep DiscoverInputSchema # 
type Rep DiscoverInputSchema = D1 * (MetaData "DiscoverInputSchema" "Network.AWS.KinesisAnalytics.DiscoverInputSchema" "amazonka-kinesis-analytics-1.6.0-CdiLxSMgN2H9NTRoTSSuux" False) (C1 * (MetaCons "DiscoverInputSchema'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_disInputStartingPositionConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe InputStartingPositionConfiguration))) (S1 * (MetaSel (Just Symbol "_disInputProcessingConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe InputProcessingConfiguration)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_disS3Configuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe S3Configuration))) ((:*:) * (S1 * (MetaSel (Just Symbol "_disResourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_disRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))
type Rs DiscoverInputSchema # 

Request Lenses

disInputStartingPositionConfiguration :: Lens' DiscoverInputSchema (Maybe InputStartingPositionConfiguration) #

Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.

disInputProcessingConfiguration :: Lens' DiscoverInputSchema (Maybe InputProcessingConfiguration) #

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

disS3Configuration :: Lens' DiscoverInputSchema (Maybe S3Configuration) #

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

disResourceARN :: Lens' DiscoverInputSchema (Maybe Text) #

Amazon Resource Name (ARN) of the streaming source.

disRoleARN :: Lens' DiscoverInputSchema (Maybe Text) #

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.

Destructuring the Response

discoverInputSchemaResponse #

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 the InputProcessingConfiguration 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 #

See: discoverInputSchemaResponse smart constructor.

Instances

Eq DiscoverInputSchemaResponse # 
Data DiscoverInputSchemaResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DiscoverInputSchemaResponse -> c DiscoverInputSchemaResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DiscoverInputSchemaResponse #

toConstr :: DiscoverInputSchemaResponse -> Constr #

dataTypeOf :: DiscoverInputSchemaResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DiscoverInputSchemaResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DiscoverInputSchemaResponse) #

gmapT :: (forall b. Data b => b -> b) -> DiscoverInputSchemaResponse -> DiscoverInputSchemaResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DiscoverInputSchemaResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DiscoverInputSchemaResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DiscoverInputSchemaResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DiscoverInputSchemaResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DiscoverInputSchemaResponse -> m DiscoverInputSchemaResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DiscoverInputSchemaResponse -> m DiscoverInputSchemaResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DiscoverInputSchemaResponse -> m DiscoverInputSchemaResponse #

Read DiscoverInputSchemaResponse # 
Show DiscoverInputSchemaResponse # 
Generic DiscoverInputSchemaResponse # 
NFData DiscoverInputSchemaResponse # 
type Rep DiscoverInputSchemaResponse # 
type Rep DiscoverInputSchemaResponse = D1 * (MetaData "DiscoverInputSchemaResponse" "Network.AWS.KinesisAnalytics.DiscoverInputSchema" "amazonka-kinesis-analytics-1.6.0-CdiLxSMgN2H9NTRoTSSuux" False) (C1 * (MetaCons "DiscoverInputSchemaResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_disrsRawInputRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_disrsInputSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SourceSchema)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_disrsProcessedInputRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_disrsParsedInputRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [[Text]]))) (S1 * (MetaSel (Just Symbol "_disrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

disrsRawInputRecords :: Lens' DiscoverInputSchemaResponse [Text] #

Raw stream data that was sampled to infer the schema.

disrsInputSchema :: Lens' DiscoverInputSchemaResponse (Maybe SourceSchema) #

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] #

Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

disrsParsedInputRecords :: Lens' DiscoverInputSchemaResponse [[Text]] #

An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).