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.AddApplicationOutput API

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

AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.AddApplicationOutput 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.AddApplicationOutput. 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 24 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 24 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.AddApplicationOutput 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.AddApplicationOutput 1
POST
/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationOutput
Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an exter…
AddApplicationOutput 8 params body → 200480481482483484

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are OutputDescription (6 properties), Output (5 properties), AddApplicationOutputRequest (3 properties), AddApplicationOutputResponse (3 properties). Each schema is shown below with its type and property counts.

KinesisFirehoseOutputDescription
object
For a SQL-based Kinesis Data Analytics application's output, describes the Kinesis Data Firehose delivery stream that is configured as its destination.
2 properties 1 required
ApplicationName
string
ApplicationVersionId
integer
ResourceARN
string
LambdaOutput
object
When you configure a SQL-based Kinesis Data Analytics application's output, identifies an Amazon Lambda function as the destination. You provide the function A…
1 property 1 required
OutputDescription
object
For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the desti…
6 properties
LambdaOutputDescription
object
For a SQL-based Kinesis Data Analytics application's output, describes the Amazon Lambda function that is configured as its destination.
2 properties 1 required
AddApplicationOutputRequest
object
3 properties 3 required
RoleARN
string
InvalidArgumentException
DestinationSchema
object
Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.
1 property 1 required
ConcurrentModificationException
AddApplicationOutputResponse
object
3 properties
Output
object
Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you wan…
5 properties 2 required
KinesisStreamsOutputDescription
object
For an SQL-based Kinesis Data Analytics application's output, describes the Kinesis data stream that is configured as its destination.
2 properties 1 required
OutputDescriptions
array
Id
string
ResourceNotFoundException
ResourceInUseException
KinesisFirehoseOutput
object
For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination.…
1 property 1 required
RecordFormatType
string
InAppStreamName
string
InvalidRequestException
KinesisStreamsOutput
object
When you configure a SQL-based Kinesis Data Analytics application's output, identifies a Kinesis data stream as the destination. You provide the stream Amazon…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-x-amz-target-kinesisanalytics-20180523-addapplicationoutput-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