Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.DescribeApplication API is one of 31 APIs that Amazon Managed Service for Apache Flink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include #X Amz Target=KinesisAnalytics 20180523.DescribeApplication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, a JSON-LD context, and 1 JSON Schema.
This API exposes
1 operation
across 1 path,
and defines 119 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
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.
The identity and technical contract details declared by the specification.
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
RuntimeEnvironment
string
RecordRowDelimiter
string
ParallelismConfigurationDescription
object
Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.
5 properties
RunConfigurationDescription
object
Describes the starting properties for a Kinesis Data Analytics application.
2 properties
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
ResourceNotFoundException
S3ApplicationCodeLocationDescription
object
Describes the location of an application's code stored in an S3 bucket.
3 properties
2 required
MinPauseBetweenCheckpoints
integer
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
InputParallelismCount
integer
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
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
ZeppelinMonitoringConfigurationDescription
object
The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
1 property
PropertyGroup
object
Property key-value pairs passed into an application.
2 properties
2 required
ApplicationDetail
object
Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
17 properties
5 required
ApplicationConfigurationDescription
object
Describes details about the application code and starting parameters for a Kinesis Data Analytics application.
8 properties
DeployAsApplicationConfigurationDescription
object
The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
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
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
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
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
DescribeApplicationRequest
object
2 properties
1 required
CheckpointInterval
integer
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
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
ApplicationSnapshotConfigurationDescription
object
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property
1 required
CustomArtifactsConfigurationDescriptionList
array
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
VpcConfigurationDescriptions
array
ApplicationRestoreConfiguration
object
Specifies the method and snapshot to use when restarting an application using previously saved application state.
2 properties
1 required
ApplicationCodeConfigurationDescription
object
Describes code configuration for an application.
2 properties
1 required
JobPlanDescription
string
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
ApplicationMaintenanceWindowStartTime
string
CloudWatchLoggingOptionDescription
object
Describes the Amazon CloudWatch logging option.
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
ParallelismPerKPU
integer
ApplicationMaintenanceWindowEndTime
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 properties
1 required
MavenReference
object
The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.
3 properties
3 required
RecordColumnDelimiter
string
EnvironmentPropertyDescriptions
object
Describes the execution properties for an Apache Flink runtime.
1 property
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
InputStartingPosition
string
InputStartingPositionConfiguration
object
Describes the point at which the application reads from the streaming source.
1 property
ZeppelinApplicationConfigurationDescription
object
The configuration of a Kinesis Data Analytics Studio notebook.
4 properties
1 required
FlinkRunConfiguration
object
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
1 property
CustomArtifactConfigurationDescription
object
Specifies a dependency JAR or a JAR of user-defined functions.
3 properties
ApplicationRestoreType
string
ApplicationVersionId
integer
S3ContentBaseLocationDescription
object
The description of the S3 base location that holds the application.
2 properties
1 required
ReferenceDataSourceDescriptions
array
CheckpointConfigurationDescription
object
Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.
4 properties
InputDescription
object
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
9 properties
RecordColumnMapping
string
RecordColumnSqlType
string
VpcConfigurationDescription
object
Describes the parameters of a VPC used by the application.
4 properties
4 required
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
CloudWatchLoggingOptionDescriptions
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
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
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
ReferenceDataSourceDescription
object
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
4 properties
3 required
DescribeApplicationResponse
object
1 property
1 required
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
ApplicationDescription
string
CodeContentDescription
object
Describes details about the code of a Kinesis Data Analytics application.
4 properties
ApplicationMaintenanceConfigurationDescription
object
The details of the maintenance configuration for the application.
2 properties
2 required
SqlApplicationConfigurationDescription
object
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon Managed Service for Apache Flink publishes across the network.
