AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.CreateApplication API
The #X Amz Target=KinesisAnalytics 20180523.CreateApplication API from AWS Kinesis — 1 operation(s) for #x amz target=kinesisanalytics 20180523.createapplication.
AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.CreateApplication 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.CreateApplication. 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 165 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
165 schemas
1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.CreateApplication 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.CreateApplication 1
POST
/#X-Amz-Target=KinesisAnalytics_20180523.CreateApplication
Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application .
Schemas 165
The contract defines 165 schemas that model the data the API accepts and returns. The most detailed are ApplicationDetail (17 properties), InputDescription (9 properties), CreateApplicationRequest (8 properties), ApplicationConfigurationDescription (8 properties). Each schema is shown below with its type and property counts.
CheckpointConfigurationDescription
object
Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.
4 properties
SecurityGroupIds
array
ApplicationName
string
ApplicationVersionId
integer
JobPlanDescription
string
BasePath
string
RecordRowPath
string
CloudWatchLoggingOptions
array
RuntimeEnvironment
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
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
RecordColumnName
string
LogLevel
string
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
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
ZipFileContent
string
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
MonitoringConfigurationDescription
object
Describes configuration parameters for CloudWatch logging for an application.
3 properties
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
InputDescriptions
array
ApplicationRestoreConfiguration
object
Specifies the method and snapshot to use when restarting an application using previously saved application state.
2 properties
1 required
MavenArtifactId
string
S3ContentBaseLocation
object
The S3 bucket that holds the application information.
2 properties
1 required
VpcId
string
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
ConditionalToken
string
KinesisStreamsInput
object
Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).
1 property
1 required
CodeValidationException
RecordFormatType
string
FlinkApplicationConfiguration
object
Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.
3 properties
VpcConfiguration
object
Describes the parameters of a VPC used by the application.
2 properties
2 required
InvalidRequestException
ArtifactType
string
ParallelismPerKPU
integer
ZeppelinApplicationConfigurationDescription
object
The configuration of a Kinesis Data Analytics Studio notebook.
4 properties
1 required
S3ApplicationCodeLocationDescription
object
Describes the location of an application's code stored in an S3 bucket.
3 properties
2 required
RunConfigurationDescription
object
Describes the starting properties for a Kinesis Data Analytics application.
2 properties
CheckpointInterval
integer
ApplicationConfiguration
object
Specifies the creation parameters for a Kinesis Data Analytics application.
7 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
ZeppelinMonitoringConfigurationDescription
object
The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
1 property
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
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
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
EnvironmentPropertyDescriptions
object
Describes the execution properties for an Apache Flink runtime.
1 property
RecordColumns
array
CloudWatchLoggingOption
object
Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).
1 property
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
ConfigurationType
string
InputStartingPosition
string
ParallelismConfigurationDescription
object
Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.
5 properties
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
ResourceARN
string
TextContent
string
FlinkApplicationConfigurationDescription
object
Describes configuration parameters for a Flink-based Kinesis Data Analytics application.
4 properties
CustomArtifactsConfigurationDescriptionList
array
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
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
VpcConfigurationDescription
object
Describes the parameters of a VPC used by the application.
4 properties
4 required
SnapshotName
string
Outputs
array
ApplicationConfigurationDescription
object
Describes details about the application code and starting parameters for a Kinesis Data Analytics application.
8 properties
InputStartingPositionConfiguration
object
Describes the point at which the application reads from the streaming source.
1 property
OutputDescriptions
array
Parallelism
integer
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
FileKey
string
S3ContentBaseLocationDescription
object
The description of the S3 base location that holds the application.
2 properties
1 required
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
FlinkRunConfiguration
object
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
1 property
ReferenceDataSources
array
Inputs
array
MonitoringConfiguration
object
Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring .
3 properties
1 required
Timestamp
string
TagValue
string
ApplicationMaintenanceWindowEndTime
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
TagKey
string
DeployAsApplicationConfiguration
object
The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.
1 property
1 required
CodeContentType
string
ApplicationCodeConfigurationDescription
object
Describes code configuration for an application.
2 properties
1 required
VpcConfigurationDescriptions
array
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
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
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
SubnetId
string
DatabaseARN
string
SecurityGroupId
string
PropertyValue
string
PropertyGroup
object
Property key-value pairs passed into an application.
2 properties
2 required
CustomArtifactConfigurationDescription
object
Specifies a dependency JAR or a JAR of user-defined functions.
3 properties
UnsupportedOperationException
ApplicationMaintenanceWindowStartTime
string
ObjectVersion
string
RoleARN
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
SqlApplicationConfiguration
object
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
ApplicationMaintenanceConfigurationDescription
object
The details of the maintenance configuration for the application.
2 properties
2 required
ApplicationStatus
string
RecordColumnMapping
string
InAppStreamNames
array
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
Id
string
ZeppelinApplicationConfiguration
object
The configuration of a Kinesis Data Analytics Studio notebook.
4 properties
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
ResourceInUseException
MinPauseBetweenCheckpoints
integer
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
ApplicationCodeConfiguration
object
Describes code configuration for an application.
2 properties
1 required
MavenVersion
string
InAppTableName
string
PropertyMap
object
CreateApplicationRequest
object
8 properties
3 required
LogStreamARN
string
CodeSize
integer
ApplicationSnapshotConfigurationDescription
object
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property
1 required
CodeContent
object
Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.
3 properties
CloudWatchLoggingOptionDescriptions
array
RecordColumnSqlType
string
CodeMD5
string
CloudWatchLoggingOptionDescription
object
Describes the Amazon CloudWatch logging option.
3 properties
1 required
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
ApplicationSnapshotConfiguration
object
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property
1 required
ApplicationMode
string
ApplicationDetail
object
Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
17 properties
5 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
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
SubnetIds
array
ApplicationRestoreType
string
CreateApplicationResponse
object
1 property
1 required
BucketARN
string
MavenGroupId
string
RecordColumnDelimiter
string
MetricsLevel
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
ApplicationDescription
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
InvalidArgumentException
ReferenceDataSourceDescription
object
For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
4 properties
3 required
RecordEncoding
string
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
BooleanObject
boolean
CustomArtifactsConfigurationList
array
VpcConfigurations
array
SqlApplicationConfigurationDescription
object
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
LimitExceededException
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
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
MavenReference
object
The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.
3 properties
3 required
InputDescription
object
Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
9 properties
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
CustomArtifactConfiguration
object
Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
3 properties
1 required
ReferenceDataSourceDescriptions
array
EnvironmentProperties
object
Describes execution properties for a Flink-based Kinesis Data Analytics application.
1 property
1 required
Tags
array
InputParallelismCount
integer
TooManyTagsException
InAppStreamName
string
CodeContentDescription
object
Describes details about the code of a Kinesis Data Analytics application.
4 properties
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
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
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
PropertyGroups
array
RecordRowDelimiter
string
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 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
##X Amz Target=KinesisAnalytics 20180523.CreateApplication