AWS Kinesis Amazon Kinesis Analytics API
The Amazon Kinesis Analytics API from AWS Kinesis — 31 operation(s) for amazon kinesis analytics.
AWS Kinesis Amazon Kinesis Analytics API is one of 32 APIs that AWS Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Amazon Kinesis Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.
This API exposes 31 operations across 31 paths, and defines 296 schemas. It is described by OpenAPI 3.2.0, at version 2018-05-23.
Requests are made against 4 base URLs: http://kinesisanalytics.{region}.amazonaws.com, https://kinesisanalytics.{region}.amazonaws.com, http://kinesisanalytics.{region}.amazonaws.com.cn, https://kinesisanalytics.{region}.amazonaws.com.cn.
31 operations
31 paths
296 schemas
31 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS Kinesis Amazon Kinesis Analytics 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 31
Across 31 paths, the API surfaces 31 operations — 31 POST. Each is listed below with its method, path, parameters, and response codes.
Amazon Kinesis Analytics 31
POST
/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationCloudWatchLoggingOption
Add application cloud watch logging option
POST
/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInput
Add application input
POST
/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInputProcessingConfiguration
Add application input processing configuration
POST
/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationOutput
Add application output
POST
/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationReferenceDataSource
Add application reference data source
POST
/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationVpcConfiguration
Add application vpc configuration
POST
/#X-Amz-Target=KinesisAnalytics_20180523.CreateApplication
Create application
POST
/#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationPresignedUrl
Create application presigned url
POST
/#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationSnapshot
Create application snapshot
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplication
Delete application
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationCloudWatchLoggingOption
Delete application cloud watch logging option
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationInputProcessingConfiguration
Delete application input processing configuration
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationOutput
Delete application output
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationReferenceDataSource
Delete application reference data source
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationSnapshot
Delete application snapshot
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationVpcConfiguration
Delete application vpc configuration
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplication
Describe application
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationSnapshot
Describe application snapshot
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationVersion
Describe application version
POST
/#X-Amz-Target=KinesisAnalytics_20180523.DiscoverInputSchema
Discover input schema
POST
/#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationSnapshots
List application snapshots
POST
/#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationVersions
List application versions
POST
/#X-Amz-Target=KinesisAnalytics_20180523.ListApplications
List applications
POST
/#X-Amz-Target=KinesisAnalytics_20180523.ListTagsForResource
List tags for resource
POST
/#X-Amz-Target=KinesisAnalytics_20180523.RollbackApplication
Rollback application
POST
/#X-Amz-Target=KinesisAnalytics_20180523.StartApplication
Start application
POST
/#X-Amz-Target=KinesisAnalytics_20180523.StopApplication
Stop application
POST
/#X-Amz-Target=KinesisAnalytics_20180523.TagResource
Tag resource
POST
/#X-Amz-Target=KinesisAnalytics_20180523.UntagResource
Untag resource
POST
/#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplication
Update application
POST
/#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguration
Update application maintenance configuration
Schemas 296
The contract defines 296 schemas that model the data the API accepts and returns. The most detailed are ApplicationDetail (17 properties), InputDescription (9 properties), ApplicationConfigurationDescription (8 properties), CreateApplicationRequest (8 properties). Each schema is shown below with its type and property counts.
MonitoringConfigurationDescription
object
Describes configuration parameters for CloudWatch logging for an application.
3 properties
FlinkApplicationConfigurationDescription
object
Describes configuration parameters for a Flink-based Kinesis Data Analytics application.
4 properties
FlinkApplicationConfigurationUpdate
object
Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application.
3 properties
ApplicationConfigurationUpdate
object
Describes updates to an application's configuration.
7 properties
GlueDataCatalogConfigurationUpdate
object
Updates to the configuration of the Glue Data Catalog that you use for SQL queries that you write in a Kinesis Data Analytics Studio notebook.
1 property
1 required
ReferenceDataSourceUpdates
array
CodeContentDescription
object
Describes details about the code of a Kinesis Data Analytics application.
4 properties
ApplicationDescription
string
UpdateApplicationRequest
object
7 properties
1 required
ApplicationVersionId
integer
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
GlueDataCatalogConfiguration
object
The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.
1 property
1 required
DeleteApplicationReferenceDataSourceResponse
object
2 properties
InputLambdaProcessorUpdate
object
For a SQL-based Kinesis Data Analytics application, represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.
1 property
1 required
ListApplicationsResponse
object
2 properties
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
UpdateApplicationResponse
object
1 property
1 required
ParsedInputRecords
array
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
ApplicationVersionSummary
object
The summary of the application version.
2 properties
2 required
ZeppelinMonitoringConfigurationUpdate
object
Updates to the monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
1 property
1 required
PropertyGroups
array
DescribeApplicationVersionRequest
object
2 properties
2 required
AddApplicationCloudWatchLoggingOptionResponse
object
3 properties
DeleteApplicationResponse
object
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
DeleteApplicationCloudWatchLoggingOptionResponse
object
3 properties
ResourceInUseException
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
TagResourceRequest
object
2 properties
2 required
KinesisStreamsOutputUpdate
object
When you update a SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about a Kines…
1 property
1 required
LambdaOutputUpdate
object
When you update an SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about an Ama…
1 property
1 required
S3ContentBaseLocation
object
The S3 bucket that holds the application information.
2 properties
1 required
ListApplicationsInputLimit
integer
AddApplicationReferenceDataSourceRequest
object
3 properties
3 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 property
1 required
Tag
object
A key-value pair (the value is optional) that you can define and assign to Amazon resources. If you specify a tag that already exists, the tag value is replace…
2 properties
1 required
UnsupportedOperationException
CustomArtifactConfigurationDescription
object
Specifies a dependency JAR or a JAR of user-defined functions.
3 properties
InvalidApplicationConfigurationException
S3ContentBaseLocationUpdate
object
The information required to update the S3 base location that holds the application.
2 properties
RecordRowDelimiter
string
AddApplicationInputRequest
object
3 properties
3 required
Inputs
array
DescribeApplicationVersionResponse
object
1 property
AddApplicationVpcConfigurationResponse
object
3 properties
BasePath
string
RecordRowPath
string
FileKey
string
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 properties
1 required
CreateApplicationRequest
object
8 properties
3 required
MonitoringConfigurationUpdate
object
Describes updates to configuration parameters for Amazon CloudWatch logging for an application.
3 properties
ConfigurationType
string
ListTagsForResourceRequest
object
1 property
1 required
ListApplicationsRequest
object
2 properties
DeleteApplicationVpcConfigurationResponse
object
2 properties
ApplicationMaintenanceConfigurationDescription
object
The details of the maintenance configuration for the application.
2 properties
2 required
SecurityGroupId
string
ApplicationStatus
string
DeployAsApplicationConfigurationDescription
object
The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
1 property
1 required
SnapshotStatus
string
ParsedInputRecordField
string
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
AddApplicationVpcConfigurationRequest
object
4 properties
2 required
RuntimeEnvironment
string
FlinkApplicationConfiguration
object
Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.
3 properties
UrlType
string
DeployAsApplicationConfiguration
object
The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.
1 property
1 required
SubnetIds
array
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
Tags
array
TagKeys
array
SessionExpirationDurationInSeconds
integer
AddApplicationInputProcessingConfigurationResponse
object
4 properties
CodeContent
object
Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.
3 properties
DeleteApplicationOutputResponse
object
2 properties
DeployAsApplicationConfigurationUpdate
object
Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
1 property
RecordColumnName
string
SnapshotName
string
CheckpointConfigurationUpdate
object
Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application.
4 properties
TagValue
string
SubnetId
string
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 properties
2 required
CatalogConfigurationUpdate
object
Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics…
1 property
1 required
KinesisAnalyticsARN
string
CloudWatchLoggingOption
object
Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).
1 property
1 required
DiscoverInputSchemaResponse
object
4 properties
ApplicationCodeConfiguration
object
Describes code configuration for an application.
2 properties
1 required
ApplicationMaintenanceConfigurationUpdate
object
Describes the updated maintenance configuration for the application.
1 property
1 required
DescribeApplicationResponse
object
1 property
1 required
ApplicationSnapshotConfiguration
object
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property
1 required
CreateApplicationPresignedUrlRequest
object
3 properties
2 required
CustomArtifactConfiguration
object
Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
3 properties
1 required
ApplicationSummary
object
Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
6 properties
5 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
CreateApplicationResponse
object
1 property
1 required
VpcConfigurationDescription
object
Describes the parameters of a VPC used by the application.
4 properties
4 required
SqlRunConfiguration
object
Describes the starting parameters for a SQL-based Kinesis Data Analytics application.
2 properties
2 required
ApplicationSnapshotConfigurationDescription
object
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property
1 required
MinPauseBetweenCheckpoints
integer
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
AddApplicationInputResponse
object
3 properties
ApplicationMaintenanceWindowStartTime
string
ArtifactType
string
UntagResourceRequest
object
2 properties
2 required
InputStartingPosition
string
MavenReference
object
The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.
3 properties
3 required
RecordColumns
array
ApplicationRestoreConfiguration
object
Specifies the method and snapshot to use when restarting an application using previously saved application state.
2 properties
1 required
ObjectVersion
string
ApplicationMode
string
SqlRunConfigurations
array
KinesisFirehoseInputDescription
object
Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.
2 properties
1 required
ApplicationConfigurationDescription
object
Describes details about the application code and starting parameters for a Kinesis Data Analytics application.
8 properties
ReferenceDataSourceDescriptions
array
DeleteApplicationInputProcessingConfigurationResponse
object
2 properties
CreateApplicationPresignedUrlResponse
object
1 property
NextToken
string
Outputs
array
ReferenceDataSourceDescription
object
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
4 properties
3 required
BucketARN
string
MavenVersion
string
DescribeApplicationSnapshotRequest
object
2 properties
2 required
AddApplicationCloudWatchLoggingOptionRequest
object
4 properties
2 required
DiscoverInputSchemaRequest
object
5 properties
1 required
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
DescribeApplicationSnapshotResponse
object
1 property
1 required
PropertyMap
object
DeleteApplicationOutputRequest
object
3 properties
3 required
DescribeApplicationRequest
object
2 properties
1 required
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 property
1 required
DeleteApplicationSnapshotResponse
object
ListApplicationVersionsResponse
object
2 properties
RecordColumnDelimiter
string
ParallelismConfigurationUpdate
object
Describes updates to parameters for how an application executes multiple tasks simultaneously.
4 properties
TooManyTagsException
FlinkRunConfiguration
object
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
1 property
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
RawInputRecords
array
CloudWatchLoggingOptionDescriptions
array
BooleanObject
boolean
VpcConfigurationUpdates
array
MavenGroupId
string
MonitoringConfiguration
object
Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring .
3 properties
1 required
S3ContentLocation
object
For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of…
3 properties
2 required
InvalidArgumentException
SqlApplicationConfigurationUpdate
object
Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
ApplicationRestoreType
string
DeleteApplicationReferenceDataSourceRequest
object
3 properties
3 required
InputUpdate
object
For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId of an application).
7 properties
1 required
RunConfigurationUpdate
object
Describes the updates to the starting parameters for a Kinesis Data Analytics application.
2 properties
SnapshotSummaries
array
CodeMD5
string
CloudWatchLoggingOptionDescription
object
Describes the Amazon CloudWatch logging option.
3 properties
1 required
S3ContentBaseLocationDescription
object
The description of the S3 base location that holds the application.
2 properties
1 required
ApplicationConfiguration
object
Specifies the creation parameters for a Kinesis Data Analytics application.
7 properties
DeleteApplicationSnapshotRequest
object
3 properties
3 required
ListApplicationSnapshotsResponse
object
2 properties
ConditionalToken
string
CreateApplicationSnapshotResponse
object
MavenArtifactId
string
CreateApplicationSnapshotRequest
object
2 properties
2 required
ParsedInputRecord
array
AddApplicationReferenceDataSourceResponse
object
3 properties
CatalogConfiguration
object
The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio note…
1 property
1 required
ApplicationSummaries
array
ApplicationDetail
object
Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
17 properties
5 required
ListApplicationVersionsRequest
object
3 properties
1 required
ZeppelinApplicationConfigurationUpdate
object
Updates to the configuration of Kinesis Data Analytics Studio notebook.
4 properties
KinesisFirehoseInputUpdate
object
For a SQL-based Kinesis Data Analytics application, when updating application input configuration, provides information about a Kinesis Data Firehose delivery…
1 property
1 required
GlueDataCatalogConfigurationDescription
object
The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.
1 property
1 required
InAppTableName
string
UnableToDetectSchemaException
TagKey
string
ApplicationName
string
RunConfiguration
object
Describes the starting parameters for an Kinesis Data Analytics application.
3 properties
VpcConfiguration
object
Describes the parameters of a VPC used by the application.
2 properties
2 required
InputSchemaUpdate
object
Describes updates for an SQL-based Kinesis Data Analytics application's input schema.
3 properties
ListTagsForResourceResponse
object
1 property
DeleteApplicationVpcConfigurationRequest
object
4 properties
2 required
InputUpdates
array
ApplicationSnapshotConfigurationUpdate
object
Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property
1 required
InputParallelismCount
integer
ZipFileContent
string
ParallelismPerKPU
integer
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
VpcConfigurationUpdate
object
Describes updates to the VPC configuration used by the application.
3 properties
1 required
DeleteApplicationCloudWatchLoggingOptionRequest
object
4 properties
2 required
SqlApplicationConfigurationDescription
object
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
ProcessedInputRecords
array
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
S3ApplicationCodeLocationDescription
object
Describes the location of an application's code stored in an S3 bucket.
3 properties
2 required
CatalogConfigurationDescription
object
The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write i…
1 property
1 required
PropertyValue
string
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
KinesisStreamsInput
object
Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).
1 property
1 required
KinesisStreamsInputUpdate
object
When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a Kinesis stream as the streaming source.
1 property
1 required
AddApplicationOutputResponse
object
3 properties
RecordFormatType
string
MetricsLevel
string
S3ReferenceDataSourceUpdate
object
For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.
2 properties
TagResourceResponse
object
OutputUpdates
array
ZeppelinMonitoringConfigurationDescription
object
The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
1 property
ConcurrentModificationException
ZeppelinApplicationConfiguration
object
The configuration of a Kinesis Data Analytics Studio notebook.
4 properties
Timestamp
string
ListApplicationVersionsInputLimit
integer
AuthorizedUrl
string
CodeContentType
string
JobPlanDescription
string
LimitExceededException
RollbackApplicationResponse
object
1 property
1 required
ServiceUnavailableException
RawInputRecord
string
SqlApplicationConfiguration
object
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
S3ReferenceDataSource
object
For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data. A Kinesis Data Analytics appli…
2 properties
UntagResourceResponse
object
CloudWatchLoggingOptionUpdates
array
CheckpointConfiguration
object
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information,…
4 properties
1 required
SecurityGroupIds
array
DeleteApplicationInputProcessingConfigurationRequest
object
3 properties
3 required
S3ReferenceDataSourceDescription
object
For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.
3 properties
2 required
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
RollbackApplicationRequest
object
2 properties
2 required
InputParallelismUpdate
object
For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.
1 property
1 required
CustomArtifactsConfigurationDescriptionList
array
CodeSize
integer
ResourceNotFoundException
VpcConfigurationDescriptions
array
TextContent
string
StopApplicationResponse
object
ListSnapshotsInputLimit
integer
RunConfigurationDescription
object
Describes the starting properties for a Kinesis Data Analytics application.
2 properties
CustomArtifactsConfigurationList
array
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 properties
1 required
EnvironmentProperties
object
Describes execution properties for a Flink-based Kinesis Data Analytics application.
1 property
1 required
CodeContentUpdate
object
Describes an update to the code of an application. Not supported for Apache Zeppelin.
3 properties
S3ContentLocationUpdate
object
Describes an update for the Amazon S3 code content location for an application.
3 properties
InputProcessingConfigurationUpdate
object
For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration .
1 property
1 required
InAppStreamNames
array
ApplicationMaintenanceWindowEndTime
string
InvalidRequestException
LogStreamARN
string
ProcessedInputRecord
string
StartApplicationRequest
object
2 properties
1 required
InputDescription
object
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
9 properties
PropertyGroup
object
Property key-value pairs passed into an application.
2 properties
2 required
StopApplicationRequest
object
2 properties
1 required
StartApplicationResponse
object
VpcId
string
RecordColumnSqlType
string
InputDescriptions
array
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
CheckpointInterval
integer
ZeppelinMonitoringConfiguration
object
Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, s…
1 property
1 required
SnapshotDetails
object
Provides details about a snapshot of application state.
4 properties
3 required
ParallelismConfiguration
object
Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, s…
4 properties
1 required
RoleARN
string
LogLevel
string
OutputUpdate
object
For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId .
6 properties
1 required
Id
string
ResourceProvisionedThroughputExceededException
UpdateApplicationMaintenanceConfigurationResponse
object
2 properties
ZeppelinApplicationConfigurationDescription
object
The configuration of a Kinesis Data Analytics Studio notebook.
4 properties
1 required
ReferenceDataSource
object
For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object k…
3 properties
2 required
VpcConfigurations
array
CloudWatchLoggingOptions
array
KinesisFirehoseOutputUpdate
object
For a SQL-based Kinesis Data Analytics application, when updating an output configuration using the UpdateApplication operation, provides information about a K…
1 property
1 required
ApplicationCodeConfigurationDescription
object
Describes code configuration for an application.
2 properties
1 required
RecordEncoding
string
AddApplicationOutputRequest
object
3 properties
3 required
Parallelism
integer
EnvironmentPropertyUpdates
object
Describes updates to the execution property groups for a Flink-based Kinesis Data Analytics application or a Studio notebook.
1 property
1 required
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
RecordColumnMapping
string
DeleteApplicationRequest
object
2 properties
2 required
CodeValidationException
ResourceARN
string
ListApplicationSnapshotsRequest
object
3 properties
1 required
EnvironmentPropertyDescriptions
object
Describes the execution properties for an Apache Flink runtime.
1 property
DatabaseARN
string
OutputDescriptions
array
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
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
ReferenceDataSources
array
ApplicationVersionSummaries
array
CloudWatchLoggingOptionUpdate
object
Describes the Amazon CloudWatch logging option updates.
2 properties
1 required
ReferenceDataSourceUpdate
object
When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as…
4 properties
1 required
AddApplicationInputProcessingConfigurationRequest
object
4 properties
4 required
InputStartingPositionConfiguration
object
Describes the point at which the application reads from the streaming source.
1 property
UpdateApplicationMaintenanceConfigurationRequest
object
2 properties
2 required
ParallelismConfigurationDescription
object
Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.
5 properties
InAppStreamName
string
CheckpointConfigurationDescription
object
Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.
4 properties
ApplicationCodeConfigurationUpdate
object
Describes code configuration updates for an application. This is supported for a Flink-based Kinesis Data Analytics application or a SQL-based Kinesis Data Ana…
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AWS Kinesis 12
Other APIs AWS Kinesis publishes across the network.
Amazon Managed Service for Apache Flink API
AWS Kinesis ListStreams API
AWS Kinesis Amazon Kinesis API
AWS Kinesis Amazon Kinesis Firehose API
AWS Kinesis Create Signaling Channel API
AWS Kinesis Create Stream API
AWS Kinesis Delete Signaling Channel API
AWS Kinesis Delete Stream API
AWS Kinesis Describe Edge Configuration API
AWS Kinesis Describe Image Generation Configuration API
AWS Kinesis Describe Mapped Resource Configuration API
AWS Kinesis Describe Media Storage Configuration API
#Amazon Kinesis Analytics
Where this information came from
This is an independent, third-party profile of AWS Kinesis Amazon Kinesis Analytics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.