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