AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.UpdateApplication API
The #X Amz Target=KinesisAnalytics 20180523.UpdateApplication API from AWS Kinesis — 1 operation(s) for #x amz target=kinesisanalytics 20180523.updateapplication.
AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.UpdateApplication 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.UpdateApplication. 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.UpdateApplication 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.UpdateApplication 1
POST
/#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplication
Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the Applic…
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), InputUpdate (7 properties). Each schema is shown below with its type and property counts.
OutputUpdate
object
For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId .
6 properties
1 required
CheckpointConfigurationDescription
object
Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.
4 properties
SecurityGroupIds
array
DeployAsApplicationConfigurationUpdate
object
Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
1 property
ApplicationName
string
ApplicationVersionId
integer
JobPlanDescription
string
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
BasePath
string
RecordRowPath
string
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
RecordColumnName
string
LogLevel
string
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
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
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
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
MavenArtifactId
string
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
CloudWatchLoggingOptionUpdate
object
Describes the Amazon CloudWatch logging option updates.
2 properties
1 required
VpcId
string
ConditionalToken
string
CodeValidationException
RecordFormatType
string
InvalidRequestException
ParallelismPerKPU
integer
ArtifactType
string
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
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
ApplicationConfigurationUpdate
object
Describes updates to an application's configuration.
7 properties
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
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
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
ZeppelinMonitoringConfigurationDescription
object
The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
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
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
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
InvalidApplicationConfigurationException
CustomArtifactsConfigurationDescriptionList
array
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
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
ApplicationConfigurationDescription
object
Describes details about the application code and starting parameters for a Kinesis Data Analytics application.
8 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
InputStartingPositionConfiguration
object
Describes the point at which the application reads from the streaming source.
1 property
OutputDescriptions
array
InputUpdates
array
ZeppelinMonitoringConfigurationUpdate
object
Updates to the monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
1 property
1 required
Parallelism
integer
FileKey
string
S3ContentBaseLocationDescription
object
The description of the S3 base location that holds the application.
2 properties
1 required
MonitoringConfigurationUpdate
object
Describes updates to configuration parameters for Amazon CloudWatch logging for an application.
3 properties
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
ZeppelinApplicationConfigurationUpdate
object
Updates to the configuration of Kinesis Data Analytics Studio notebook.
4 properties
FlinkRunConfiguration
object
Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
1 property
Timestamp
string
CloudWatchLoggingOptionUpdates
array
InputProcessingConfigurationUpdate
object
For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration .
1 property
1 required
ReferenceDataSourceUpdates
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
ApplicationMaintenanceWindowEndTime
string
CodeContentType
string
ApplicationCodeConfigurationDescription
object
Describes code configuration for an application.
2 properties
1 required
VpcConfigurationDescriptions
array
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
CheckpointConfigurationUpdate
object
Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application.
4 properties
SubnetId
string
DatabaseARN
string
SecurityGroupId
string
PropertyValue
string
PropertyGroup
object
Property key-value pairs passed into an application.
2 properties
2 required
ApplicationSnapshotConfigurationUpdate
object
Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property
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
CustomArtifactConfigurationDescription
object
Specifies a dependency JAR or a JAR of user-defined functions.
3 properties
ApplicationMaintenanceWindowStartTime
string
ObjectVersion
string
CodeContentUpdate
object
Describes an update to the code of an application. Not supported for Apache Zeppelin.
3 properties
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
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
ResourceNotFoundException
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
MavenVersion
string
InAppTableName
string
PropertyMap
object
OutputUpdates
array
LogStreamARN
string
UpdateApplicationRequest
object
7 properties
1 required
VpcConfigurationUpdate
object
Describes updates to the VPC configuration used by the application.
3 properties
1 required
InputParallelismUpdate
object
For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.
1 property
1 required
CodeSize
integer
ApplicationSnapshotConfigurationDescription
object
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property
1 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
CloudWatchLoggingOptionDescriptions
array
RecordColumnSqlType
string
CodeMD5
string
CloudWatchLoggingOptionDescription
object
Describes the Amazon CloudWatch logging option.
3 properties
1 required
VpcConfigurationUpdates
array
ApplicationMode
string
SqlApplicationConfigurationUpdate
object
Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 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
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
InputSchemaUpdate
object
Describes updates for an SQL-based Kinesis Data Analytics application's input schema.
3 properties
FlinkApplicationConfigurationUpdate
object
Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application.
3 properties
SubnetIds
array
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
ApplicationRestoreType
string
ParallelismConfigurationUpdate
object
Describes updates to parameters for how an application executes multiple tasks simultaneously.
4 properties
BucketARN
string
MavenGroupId
string
RecordColumnDelimiter
string
MetricsLevel
string
S3ContentBaseLocationUpdate
object
The information required to update the S3 base location that holds the application.
2 properties
S3ContentLocationUpdate
object
Describes an update for the Amazon S3 code content location for an application.
3 properties
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
BooleanObject
boolean
CustomArtifactsConfigurationList
array
LimitExceededException
UpdateApplicationResponse
object
1 property
1 required
SqlApplicationConfigurationDescription
object
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
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
InputParallelismCount
integer
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
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
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
RunConfigurationUpdate
object
Describes the updates to the starting parameters for a Kinesis Data Analytics application.
2 properties
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.UpdateApplication