Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.DiscoverInputSchema API

The #X Amz Target=KinesisAnalytics 20180523.DiscoverInputSchema API from AWS Kinesis — 1 operation(s) for #x amz target=kinesisanalytics 20180523.discoverinputschema.

AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.DiscoverInputSchema API is one of 100 APIs that AWS Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=KinesisAnalytics 20180523.DiscoverInputSchema. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.

This API exposes 1 operation across 1 path, and defines 39 schemas. It is described by OpenAPI 3.0.0, at version 2015-08-04.

Requests are made against 4 base URLs: http://firehose.{region}.amazonaws.com, https://firehose.{region}.amazonaws.com, http://firehose.{region}.amazonaws.com.cn, https://firehose.{region}.amazonaws.com.cn.

1 operations 1 paths 39 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-08-04
Base URL
https://kinesis.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.DiscoverInputSchema API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=KinesisAnalytics 20180523.DiscoverInputSchema 1
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DiscoverInputSchema
Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Ama…
DiscoverInputSchema 8 params body → 200480481482483484485

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are DiscoverInputSchemaRequest (5 properties), DiscoverInputSchemaResponse (4 properties), RecordColumn (3 properties), SourceSchema (3 properties). Each schema is shown below with its type and property counts.

RecordFormat
object
For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the recor…
2 properties 1 required
ParsedInputRecordField
string
JSONMappingParameters
object
For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.
1 property 1 required
MappingParameters
object
When you configure a SQL-based Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping infor…
2 properties
RecordColumns
array
InputStartingPosition
string
S3Configuration
object
For a SQL-based Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 buck…
2 properties 2 required
ResourceARN
string
RecordRowPath
string
RawInputRecord
string
RecordColumnName
string
UnsupportedOperationException
BucketARN
string
RecordColumnDelimiter
string
ResourceProvisionedThroughputExceededException
RoleARN
string
InvalidArgumentException
RawInputRecords
array
RecordEncoding
string
RecordColumnMapping
string
InputStartingPositionConfiguration
object
Describes the point at which the application reads from the streaming source.
1 property
UnableToDetectSchemaException
ParsedInputRecords
array
InputProcessingConfiguration
object
For a SQL-based Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your a…
1 property 1 required
SourceSchema
object
For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding c…
3 properties 2 required
ParsedInputRecord
array
DiscoverInputSchemaRequest
object
5 properties 1 required
FileKey
string
RecordFormatType
string
ProcessedInputRecord
string
InvalidRequestException
ServiceUnavailableException
DiscoverInputSchemaResponse
object
4 properties
ProcessedInputRecords
array
CSVMappingParameters
object
For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, t…
2 properties 2 required
RecordColumnSqlType
string
InputLambdaProcessor
object
An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Da…
1 property 1 required
RecordRowDelimiter
string
RecordColumn
object
For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-ap…
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-x-amz-target-kinesisanalytics-20180523-discoverinputschema-api-openapi.yml Raw ↑

Other APIs AWS Kinesis publishes across the network.

Amazon Managed Service for Apache Flink API
AWS Kinesis CreateSignalingChannel API
AWS Kinesis CreateStream API
AWS Kinesis DeleteSignalingChannel API
AWS Kinesis DeleteStream API
AWS Kinesis DescribeEdgeConfiguration API
AWS Kinesis DescribeImageGenerationConfiguration API
AWS Kinesis DescribeMappedResourceConfiguration API
AWS Kinesis DescribeMediaStorageConfiguration API
AWS Kinesis DescribeNotificationConfiguration API
AWS Kinesis DescribeSignalingChannel API
AWS Kinesis DescribeStream API