AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.AddApplicationInput API
The #X Amz Target=KinesisAnalytics 20180523.AddApplicationInput API from AWS Kinesis — 1 operation(s) for #x amz target=kinesisanalytics 20180523.addapplicationinput.
AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.AddApplicationInput 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.AddApplicationInput. 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 45 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 operations1 paths45 schemas1 POST
Metadata
The identity and technical contract details declared by the specification.
AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.AddApplicationInput 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.
Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source af…
The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are InputDescription (9 properties), Input (6 properties), RecordColumn (3 properties), AddApplicationInputResponse (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 properties1 required
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 property1 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
KinesisFirehoseInput
object
For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream…
1 property1 required
RecordColumns
array
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 property1 required
AddApplicationInputResponse
object
3 properties
ApplicationName
string
ApplicationVersionId
integer
InputStartingPosition
string
RecordRowPath
string
ResourceARN
string
RecordColumnName
string
RecordColumnDelimiter
string
KinesisFirehoseInputDescription
object
Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.
2 properties1 required
InputProcessingConfigurationDescription
object
For a SQL-based Kinesis Data Analytics application, provides the configuration information about an input processor. Currently, the only input processor availa…
1 property
RoleARN
string
InvalidArgumentException
ConcurrentModificationException
RecordEncoding
string
RecordColumnMapping
string
InputDescriptions
array
InAppStreamNames
array
InputStartingPositionConfiguration
object
Describes the point at which the application reads from the streaming source.
1 property
Id
string
ResourceNotFoundException
InputLambdaProcessorDescription
object
For a SQL-based Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to prepro…
2 properties1 required
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 property1 required
AddApplicationInputRequest
object
3 properties3 required
InputDescription
object
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
9 properties
ResourceInUseException
KinesisStreamsInput
object
Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).
1 property1 required
Input
object
When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name t…
6 properties2 required
CodeValidationException
RecordFormatType
string
InputParallelismCount
integer
InAppStreamName
string
KinesisStreamsInputDescription
object
For a SQL-based Kinesis Data Analytics application, describes the Kinesis data stream that is configured as the streaming source in the application input confi…
2 properties1 required
InvalidRequestException
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 properties2 required
InputParallelism
object
For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.
1 property
RecordColumnSqlType
string
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 properties2 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 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
