How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.UpdateApplication API

The #X Amz Target=KinesisAnalytics 20180523.UpdateApplication API from Amazon Managed Service for Apache Flink — 1 operation(s) for #x amz target=kinesisanalytics 20180523.updateapplication.

Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.UpdateApplication 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.UpdateApplication. 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 165 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.

1 operations 1 paths 165 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://kinesisanalytics.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Managed Service for Apache Flink #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
Amazon Managed Service for Apache Flink Update Application
UpdateApplication 8 params body → 200480481482483484485486

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), ApplicationConfigurationUpdate (7 properties). Each schema is shown below with its type and property counts.

S3ContentLocationUpdate
object
Describes an update for the Amazon S3 code content location for an application.
3 properties
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
ApplicationStatus
string
InvalidArgumentException
RuntimeEnvironment
string
PropertyValue
string
RecordRowDelimiter
string
ParallelismConfigurationUpdate
object
Describes updates to parameters for how an application executes multiple tasks simultaneously.
4 properties
CodeContentUpdate
object
Describes an update to the code of an application. Not supported for Apache Zeppelin.
3 properties
BasePath
string
ParallelismConfigurationDescription
object
Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.
5 properties
InputUpdates
array
RunConfigurationDescription
object
Describes the starting properties for a Kinesis Data Analytics application.
2 properties
ConfigurationType
string
InputParallelismUpdate
object
For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.
1 property 1 required
CodeContentType
string
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
Id
string
DeployAsApplicationConfigurationUpdate
object
Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
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
FlinkApplicationConfigurationUpdate
object
Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application.
3 properties
Parallelism
integer
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
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
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
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
ApplicationName
string
ResourceInUseException
CodeSize
integer
ZeppelinMonitoringConfigurationDescription
object
The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
1 property
OutputUpdates
array
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
InputDescriptions
array
ApplicationConfigurationDescription
object
Describes details about the application code and starting parameters for a Kinesis Data Analytics application.
8 properties
SecurityGroupId
string
CodeValidationException
DeployAsApplicationConfigurationDescription
object
The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
1 property 1 required
SnapshotName
string
UpdateApplicationResponse
object
1 property 1 required
LimitExceededException
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
ArtifactType
string
InAppTableName
string
ZipFileContent
string
MavenVersion
string
InvalidRequestException
CheckpointInterval
integer
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
FileKey
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
MonitoringConfigurationDescription
object
Describes configuration parameters for CloudWatch logging for an application.
3 properties
DatabaseARN
string
CheckpointConfigurationUpdate
object
Describes updates to the 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
FlinkApplicationConfigurationDescription
object
Describes configuration parameters for a Flink-based Kinesis Data Analytics application.
4 properties
RunConfigurationUpdate
object
Describes the updates to the starting parameters for a Kinesis Data Analytics application.
2 properties
SubnetId
string
ApplicationSnapshotConfigurationDescription
object
Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property 1 required
CodeMD5
string
CustomArtifactsConfigurationDescriptionList
array
CloudWatchLoggingOptionUpdates
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
MetricsLevel
string
VpcConfigurationDescriptions
array
InputProcessingConfigurationUpdate
object
For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration .
1 property 1 required
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
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
SubnetIds
array
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
SqlApplicationConfigurationUpdate
object
Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
PropertyGroups
array
ReferenceDataSourceUpdates
array
SecurityGroupIds
array
JobPlanDescription
string
VpcId
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
MavenArtifactId
string
UpdateApplicationRequest
object
7 properties 1 required
ApplicationMaintenanceWindowStartTime
string
CloudWatchLoggingOptionDescription
object
Describes the Amazon CloudWatch logging option.
3 properties 1 required
LogStreamARN
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
ZeppelinMonitoringConfigurationUpdate
object
Updates to the monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
1 property 1 required
S3ContentBaseLocationUpdate
object
The information required to update the S3 base location that holds the application.
2 properties
ParallelismPerKPU
integer
ApplicationMaintenanceWindowEndTime
string
BucketARN
string
ResourceARN
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
RecordEncoding
string
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
VpcConfigurationUpdate
object
Describes updates to the VPC configuration used by the application.
3 properties 1 required
CloudWatchLoggingOptionUpdate
object
Describes the Amazon CloudWatch logging option updates.
2 properties 1 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
RecordFormatType
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
TextContent
string
RecordColumnDelimiter
string
EnvironmentPropertyDescriptions
object
Describes the execution properties for an Apache Flink runtime.
1 property
RecordColumnName
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
MonitoringConfigurationUpdate
object
Describes updates to configuration parameters for Amazon CloudWatch logging for an application.
3 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
CustomArtifactConfiguration
object
Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
3 properties 1 required
ConcurrentModificationException
ApplicationVersionId
integer
OutputUpdate
object
For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId .
6 properties 1 required
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
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
VpcConfigurationDescription
object
Describes the parameters of a VPC used by the application.
4 properties 4 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
ZeppelinApplicationConfigurationUpdate
object
Updates to the configuration of Kinesis Data Analytics Studio notebook.
4 properties
MavenGroupId
string
LogLevel
string
InputSchemaUpdate
object
Describes updates for an SQL-based Kinesis Data Analytics application's input schema.
3 properties
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
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
InAppStreamNames
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
PropertyMap
object
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
BooleanObject
boolean
ApplicationConfigurationUpdate
object
Describes updates to an application's configuration.
7 properties
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
ApplicationMode
string
InAppStreamName
string
ConditionalToken
string
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
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
ApplicationSnapshotConfigurationUpdate
object
Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
1 property 1 required
ApplicationDescription
string
RecordRowPath
string
CodeContentDescription
object
Describes details about the code of a Kinesis Data Analytics application.
4 properties
Timestamp
string
ObjectVersion
string
VpcConfigurationUpdates
array
ApplicationMaintenanceConfigurationDescription
object
The details of the maintenance configuration for the application.
2 properties 2 required
RoleARN
string
InvalidApplicationConfigurationException
OutputDescriptions
array
CustomArtifactsConfigurationList
array
SqlApplicationConfigurationDescription
object
Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
3 properties
RecordColumns
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-managed-apache-flink-x-amz-target-kinesisanalytics-20180523-updateapplication-api-openapi.yml Raw ↑

Other APIs Amazon Managed Service for Apache Flink publishes across the network.

Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.AddApplicationCloudWatchLoggingOption API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.AddApplicationInput API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.AddApplicationInputProcessingConfiguration API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.AddApplicationOutput API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.AddApplicationReferenceDataSource API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.AddApplicationVpcConfiguration API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.CreateApplication API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.CreateApplicationPresignedUrl API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.CreateApplicationSnapshot API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.DeleteApplication API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.DeleteApplicationCloudWatchLoggingOption API
Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.DeleteApplicationInputProcessingConfiguration API
Where this information came from

This is an independent, third-party profile of Amazon Managed Service for Apache Flink #X Amz Target=KinesisAnalytics 20180523.UpdateApplication 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.