Network.AWS.KinesisAnalytics.DiscoverInputSchema

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream). 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.

Creating a Request

discoverInputSchema

Arguments

:: Text

disResourceARN

-> Text

disRoleARN

-> InputStartingPositionConfiguration

disInputStartingPositionConfiguration

-> 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:

• 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.
• disInputStartingPositionConfiguration - Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.

data DiscoverInputSchema

See: discoverInputSchema smart constructor.

Instances

Eq DiscoverInputSchema

Methods

(==) :: DiscoverInputSchema -> DiscoverInputSchema -> Bool

(/=) :: DiscoverInputSchema -> DiscoverInputSchema -> Bool

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

Methods

readsPrec :: Int -> ReadS DiscoverInputSchema

readList :: ReadS [DiscoverInputSchema]

readPrec :: ReadPrec DiscoverInputSchema

readListPrec :: ReadPrec [DiscoverInputSchema]

Show DiscoverInputSchema

Methods

showsPrec :: Int -> DiscoverInputSchema -> ShowS

show :: DiscoverInputSchema -> String

showList :: [DiscoverInputSchema] -> ShowS

Generic DiscoverInputSchema

Associated Types

type Rep DiscoverInputSchema :: * -> *

Methods

from :: DiscoverInputSchema -> Rep DiscoverInputSchema x

to :: Rep DiscoverInputSchema x -> DiscoverInputSchema

Hashable DiscoverInputSchema

Methods

hashWithSalt :: Int -> DiscoverInputSchema -> Int

hash :: DiscoverInputSchema -> Int

ToJSON DiscoverInputSchema

Methods

toJSON :: DiscoverInputSchema -> Value

toEncoding :: DiscoverInputSchema -> Encoding

toJSONList :: [DiscoverInputSchema] -> Value

toEncodingList :: [DiscoverInputSchema] -> Encoding

NFData DiscoverInputSchema

Methods

rnf :: DiscoverInputSchema -> ()

AWSRequest DiscoverInputSchema

Associated Types

type Rs DiscoverInputSchema :: *

Methods

request :: DiscoverInputSchema -> Request DiscoverInputSchema

response :: MonadResource m => Logger -> Service -> Proxy * DiscoverInputSchema -> ClientResponse -> m (Response DiscoverInputSchema)

ToPath DiscoverInputSchema

Methods

toPath :: DiscoverInputSchema -> ByteString

ToHeaders DiscoverInputSchema

Methods

toHeaders :: DiscoverInputSchema -> [Header]

ToQuery DiscoverInputSchema

Methods

toQuery :: DiscoverInputSchema -> QueryString

type Rep DiscoverInputSchema

type Rep DiscoverInputSchema = D1 (MetaData "DiscoverInputSchema" "Network.AWS.KinesisAnalytics.DiscoverInputSchema" "amazonka-kinesis-analytics-1.4.5-DpDyCtiVBNX33lFwhhmzva" False) (C1 (MetaCons "DiscoverInputSchema'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_disResourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_disRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_disInputStartingPositionConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 InputStartingPositionConfiguration)))))

type Rs DiscoverInputSchema

type Rs DiscoverInputSchema = DiscoverInputSchemaResponse

Request Lenses

disResourceARN :: Lens' DiscoverInputSchema Text

Amazon Resource Name (ARN) of the streaming source.

disRoleARN :: Lens' DiscoverInputSchema Text

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

disInputStartingPositionConfiguration :: Lens' DiscoverInputSchema InputStartingPositionConfiguration

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

Destructuring the Response

discoverInputSchemaResponse

Arguments

:: Int

disrsResponseStatus

-> 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.
• 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

Methods

(==) :: DiscoverInputSchemaResponse -> DiscoverInputSchemaResponse -> Bool

(/=) :: DiscoverInputSchemaResponse -> DiscoverInputSchemaResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS DiscoverInputSchemaResponse

readList :: ReadS [DiscoverInputSchemaResponse]

readPrec :: ReadPrec DiscoverInputSchemaResponse

readListPrec :: ReadPrec [DiscoverInputSchemaResponse]

Show DiscoverInputSchemaResponse

Methods

showsPrec :: Int -> DiscoverInputSchemaResponse -> ShowS

show :: DiscoverInputSchemaResponse -> String

showList :: [DiscoverInputSchemaResponse] -> ShowS

Generic DiscoverInputSchemaResponse

Associated Types

type Rep DiscoverInputSchemaResponse :: * -> *

Methods

from :: DiscoverInputSchemaResponse -> Rep DiscoverInputSchemaResponse x

to :: Rep DiscoverInputSchemaResponse x -> DiscoverInputSchemaResponse

NFData DiscoverInputSchemaResponse

Methods

rnf :: DiscoverInputSchemaResponse -> ()

type Rep DiscoverInputSchemaResponse

type Rep DiscoverInputSchemaResponse = D1 (MetaData "DiscoverInputSchemaResponse" "Network.AWS.KinesisAnalytics.DiscoverInputSchema" "amazonka-kinesis-analytics-1.4.5-DpDyCtiVBNX33lFwhhmzva" 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 "_disrsParsedInputRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [[Text]]))) (S1 (MetaSel (Just Symbol "_disrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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.

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).

disrsResponseStatus :: Lens' DiscoverInputSchemaResponse Int

• - | The response status code.