aws kinesisanalytics discover-input-schema
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
Options
| Name | Description |
|---|---|
--resource-arn <string> | Amazon Resource Name (ARN) of the streaming source |
--role-arn <string> | ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf |
--input-starting-position-configuration <structure> | Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes |
--s3-configuration <structure> | Specify this parameter to discover a schema from data in an Amazon S3 object |
--input-processing-configuration <structure> | The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |