AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDiscoverInputSchema and EndDiscoverInputSchema.

Namespace: Amazon.KinesisAnalytics
Assembly: AWSSDK.KinesisAnalytics.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DiscoverInputSchemaResponse> DiscoverInputSchemaAsync(
         DiscoverInputSchemaRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.KinesisAnalytics.Model.DiscoverInputSchemaRequest

Container for the necessary parameters to execute the DiscoverInputSchema service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DiscoverInputSchema service method, as returned by KinesisAnalytics.

Exceptions

ExceptionCondition
InvalidArgumentException Specified input parameter value is invalid.
ResourceProvisionedThroughputExceededException Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.
ServiceUnavailableException The service is unavailable. Back off and retry the operation.
UnableToDetectSchemaException Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for the given streaming source.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also