naftiko: 1.0.0-alpha2 info: label: Amazon Kinesis Analytics description: 'Amazon Kinesis Analytics. 31 operations. Lead operation: Amazon Kinesis Analytics. Self-contained Naftiko capability covering one Kinesis business surface.' tags: - Kinesis - Amazon Kinesis Analytics created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: KINESIS_API_KEY: KINESIS_API_KEY capability: consumes: - type: http namespace: amazon-kinesis-data-analytics baseUri: http://kinesisanalytics.{region}.amazonaws.com description: Amazon Kinesis Analytics business capability. Self-contained, no shared references. resources: - name: '#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationCloudWatchLoggingOption' path: /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationCloudWatchLoggingOption operations: - name: addapplicationcloudwatchloggingoption method: POST description: Adds an Amazon CloudWatch log stream to monitor application configuration errors. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInput' path: /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInput operations: - name: addapplicationinput method: POST description:
Adds a streaming source to your SQL-based Kinesis Data Analytics application.
You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInputProcessingConfigurati' path: /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInputProcessingConfiguration operations: - name: addapplicationinputprocessingconfiguration method: POST description: Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor avai outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationOutput' path: /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationOutput operations: - name: addapplicationoutput method: POST description:
Adds an external destination to your SQL-based Kinesis Data Analytics application.
If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kin outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationReferenceDataSource' path: /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationReferenceDataSource operations: - name: addapplicationreferencedatasource method: POST description:
Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In t outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationVpcConfiguration' path: /#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationVpcConfiguration operations: - name: addapplicationvpcconfiguration method: POST description:
Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.
Note the following about VPC configurations for Kinesis Data Analytics applications:
Creates and returns a URL that you can use to connect to an application's extension.
The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional per outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationSnapshot' path: /#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationSnapshot operations: - name: createapplicationsnapshot method: POST description: Creates a snapshot of the application's state data. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplication' path: /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplication operations: - name: deleteapplication method: POST description: Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationCloudWatchLoggingOption' path: /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationCloudWatchLoggingOption operations: - name: deleteapplicationcloudwatchloggingoption method: POST description: Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationInputProcessingConfigur' path: /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationInputProcessingConfiguration operations: - name: deleteapplicationinputprocessingconfiguration method: POST description: Deletes an InputProcessingConfiguration from an input. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationOutput' path: /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationOutput operations: - name: deleteapplicationoutput method: POST description: Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destin outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationReferenceDataSource' path: /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationReferenceDataSource operations: - name: deleteapplicationreferencedatasource method: POST description:
Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.
If the application is running, Kinesis Data Analytics immediately removes the in-application table that outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationSnapshot' path: /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationSnapshot operations: - name: deleteapplicationsnapshot method: POST description: Deletes a snapshot of application state. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationVpcConfiguration' path: /#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationVpcConfiguration operations: - name: deleteapplicationvpcconfiguration method: POST description: Removes a VPC configuration from a Kinesis Data Analytics application. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplication' path: /#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplication operations: - name: describeapplication method: POST description:
Returns information about a specific Kinesis Data Analytics application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationSnapshot' path: /#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationSnapshot operations: - name: describeapplicationsnapshot method: POST description: Returns information about a snapshot of application state data. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationVersion' path: /#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationVersion operations: - name: describeapplicationversion method: POST description:Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.
This operation is supported only for Amazo outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.DiscoverInputSchema' path: /#X-Amz-Target=KinesisAnalytics_20180523.DiscoverInputSchema operations: - name: discoverinputschema method: POST description:
Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the op outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationSnapshots' path: /#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationSnapshots operations: - name: listapplicationsnapshots method: POST description: Lists information about the current application snapshots. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationVersions' path: /#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationVersions operations: - name: listapplicationversions method: POST description: '
Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.
To get the complete description of a specific ' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.ListApplications' path: /#X-Amz-Target=KinesisAnalytics_20180523.ListApplications operations: - name: listapplications method: POST description:
Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.
If you want detailed information about a specific ap outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.ListTagsForResource' path: /#X-Amz-Target=KinesisAnalytics_20180523.ListTagsForResource operations: - name: listtagsforresource method: POST description: Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: X-Amz-Target in: header type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: '#X-Amz-Target=KinesisAnalytics_20180523.RollbackApplication' path: /#X-Amz-Target=KinesisAnalytics_20180523.RollbackApplication operations: - name: rollbackapplication method: POST description:
Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status.
You can roll back an application only if it is in the Stops the application from processing data. You can stop an application only if it is in the running
status, unless you set the You can use the DescribeApplication
operatio
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=KinesisAnalytics_20180523.TagResource'
path: /#X-Amz-Target=KinesisAnalytics_20180523.TagResource
operations:
- name: tagresource
method: POST
description: Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number
of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information,
see Using
Tagging.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplication'
path: /#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplication
operations:
- name: updateapplication
method: POST
description: 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 Updates the maintenance configuration of the Kinesis Data Analytics application. You can
invoke this operation on an application that is in one of the two following states: Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add
a streaming source when you create an application, or you can use this operation to add a streaming source after
you create an application
call: amazon-kinesis-data-analytics.addapplicationinput
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-addapplicationinputprocessingconfiguration
name: x-amz-target-kinesisanalytics-20180523-addapplicationinputprocessingconfigurati
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInputProcessingConfigurati.'
operations:
- method: POST
name: addapplicationinputprocessingconfiguration
description: Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input
processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only
input processor avai
call: amazon-kinesis-data-analytics.addapplicationinputprocessingconfiguration
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-addapplicationoutput
name: x-amz-target-kinesisanalytics-20180523-addapplicationoutput
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.AddApplicationOutput.'
operations:
- method: POST
name: addapplicationoutput
description: Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want
Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination
(such as an Kin
call: amazon-kinesis-data-analytics.addapplicationoutput
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-addapplicationreferencedatasource
name: x-amz-target-kinesisanalytics-20180523-addapplicationreferencedatasource
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.AddApplicationReferenceDataSource.'
operations:
- method: POST
name: addapplicationreferencedatasource
description: Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. Kinesis
Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your
application. In t
call: amazon-kinesis-data-analytics.addapplicationreferencedatasource
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-addapplicationvpcconfiguration
name: x-amz-target-kinesisanalytics-20180523-addapplicationvpcconfiguration
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.AddApplicationVpcConfiguration.'
operations:
- method: POST
name: addapplicationvpcconfiguration
description: Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to
store and access resources securely. Note the following about VPC configurations for Kinesis Data Analytics
applications: Creates and returns a URL that you can use to connect to an application's extension. The IAM
role or user used to call this API defines the permissions to access the extension. After the presigned URL is created,
no additional per
call: amazon-kinesis-data-analytics.createapplicationpresignedurl
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-createapplicationsnapshot
name: x-amz-target-kinesisanalytics-20180523-createapplicationsnapshot
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationSnapshot.'
operations:
- method: POST
name: createapplicationsnapshot
description: Creates a snapshot of the application's state data.
call: amazon-kinesis-data-analytics.createapplicationsnapshot
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-deleteapplication
name: x-amz-target-kinesisanalytics-20180523-deleteapplication
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DeleteApplication.'
operations:
- method: POST
name: deleteapplication
description: Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the
application.
call: amazon-kinesis-data-analytics.deleteapplication
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-deleteapplicationcloudwatchloggingoption
name: x-amz-target-kinesisanalytics-20180523-deleteapplicationcloudwatchloggingoption
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationCloudWatchLoggingOption.'
operations:
- method: POST
name: deleteapplicationcloudwatchloggingoption
description: Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
call: amazon-kinesis-data-analytics.deleteapplicationcloudwatchloggingoption
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-deleteapplicationinputprocessingconfiguration
name: x-amz-target-kinesisanalytics-20180523-deleteapplicationinputprocessingconfigur
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationInputProcessingConfigur.'
operations:
- method: POST
name: deleteapplicationinputprocessingconfiguration
description: Deletes an InputProcessingConfiguration from an input.
call: amazon-kinesis-data-analytics.deleteapplicationinputprocessingconfiguration
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-deleteapplicationoutput
name: x-amz-target-kinesisanalytics-20180523-deleteapplicationoutput
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationOutput.'
operations:
- method: POST
name: deleteapplicationoutput
description: Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's
configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to
the external output destin
call: amazon-kinesis-data-analytics.deleteapplicationoutput
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-deleteapplicationreferencedatasource
name: x-amz-target-kinesisanalytics-20180523-deleteapplicationreferencedatasource
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationReferenceDataSource.'
operations:
- method: POST
name: deleteapplicationreferencedatasource
description: Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics
application's configuration. If the application is running, Kinesis Data Analytics immediately removes the
in-application table that
call: amazon-kinesis-data-analytics.deleteapplicationreferencedatasource
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-deleteapplicationsnapshot
name: x-amz-target-kinesisanalytics-20180523-deleteapplicationsnapshot
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationSnapshot.'
operations:
- method: POST
name: deleteapplicationsnapshot
description: Deletes a snapshot of application state.
call: amazon-kinesis-data-analytics.deleteapplicationsnapshot
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-deleteapplicationvpcconfiguration
name: x-amz-target-kinesisanalytics-20180523-deleteapplicationvpcconfiguration
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationVpcConfiguration.'
operations:
- method: POST
name: deleteapplicationvpcconfiguration
description: Removes a VPC configuration from a Kinesis Data Analytics application.
call: amazon-kinesis-data-analytics.deleteapplicationvpcconfiguration
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-describeapplication
name: x-amz-target-kinesisanalytics-20180523-describeapplication
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DescribeApplication.'
operations:
- method: POST
name: describeapplication
description: Returns information about a specific Kinesis Data Analytics application. If you want to retrieve
a list of all applications in your account, use the ListApplications operation. Provides a detailed description of a specified version of the application. To see a list of all the
versions of an application, invoke the ListApplicationVersions operation. This operation is
supported only for Amazo
call: amazon-kinesis-data-analytics.describeapplicationversion
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-discoverinputschema
name: x-amz-target-kinesisanalytics-20180523-discoverinputschema
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.DiscoverInputSchema.'
operations:
- method: POST
name: discoverinputschema
description: Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on
the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object.
In the response, the op
call: amazon-kinesis-data-analytics.discoverinputschema
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-listapplicationsnapshots
name: x-amz-target-kinesisanalytics-20180523-listapplicationsnapshots
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.ListApplicationSnapshots.'
operations:
- method: POST
name: listapplicationsnapshots
description: Lists information about the current application snapshots.
call: amazon-kinesis-data-analytics.listapplicationsnapshots
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-listapplicationversions
name: x-amz-target-kinesisanalytics-20180523-listapplicationversions
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.ListApplicationVersions.'
operations:
- method: POST
name: listapplicationversions
description: ' Lists all the versions for the specified application, including versions that were rolled back. The
response also includes a summary of the configuration associated with each version. To get the complete description
of a specific '
call: amazon-kinesis-data-analytics.listapplicationversions
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-listapplications
name: x-amz-target-kinesisanalytics-20180523-listapplications
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.ListApplications.'
operations:
- method: POST
name: listapplications
description: Returns a list of Kinesis Data Analytics applications in your account. For each application, the response
includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information
about a specific ap
call: amazon-kinesis-data-analytics.listapplications
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-listtagsforresource
name: x-amz-target-kinesisanalytics-20180523-listtagsforresource
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.ListTagsForResource.'
operations:
- method: POST
name: listtagsforresource
description: Retrieves the list of key-value tags assigned to the application. For more information, see Using
Tagging.
call: amazon-kinesis-data-analytics.listtagsforresource
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-rollbackapplication
name: x-amz-target-kinesisanalytics-20180523-rollbackapplication
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.RollbackApplication.'
operations:
- method: POST
name: rollbackapplication
description: Reverts the application to the previous running version. You can roll back an application if you suspect
it is stuck in a transient status. You can roll back an application only if it is in the Stops the application from processing data. You can stop an application only if it is in the running
status, unless you set the You can use the DescribeApplication
operatio
call: amazon-kinesis-data-analytics.stopapplication
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-tagresource
name: x-amz-target-kinesisanalytics-20180523-tagresource
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.TagResource.'
operations:
- method: POST
name: tagresource
description: Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number
of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information,
see Using
Tagging.
call: amazon-kinesis-data-analytics.untagresource
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-updateapplication
name: x-amz-target-kinesisanalytics-20180523-updateapplication
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.UpdateApplication.'
operations:
- method: POST
name: updateapplication
description: 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 Updates the maintenance configuration of the Kinesis Data Analytics application. You can
invoke this operation on an application that is in one of the two following states: Adds a streaming source to your SQL-based Kinesis Data Analytics application. You can add a
streaming source when you create an application, or you can use this operation to add a streaming source after you
create an application
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.addapplicationinput
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: adds-a-inputprocessingconfiguration-sql-based-kinesis
description: Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input
processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only
input processor avai
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.addapplicationinputprocessingconfiguration
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-adds-external-destination-your-sql
description: Adds an external destination to your SQL-based Kinesis Data Analytics application. If you want
Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination
(such as an Kin
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.addapplicationoutput
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-adds-reference-data-source-existing
description: Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. Kinesis
Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your
application. In t
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.addapplicationreferencedatasource
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-adds-virtual-private-cloud-vpc
description: Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store
and access resources securely. Note the following about VPC configurations for Kinesis Data Analytics applications: Creates and returns a URL that you can use to connect to an application's extension. The IAM
role or user used to call this API defines the permissions to access the extension. After the presigned URL is created,
no additional per
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.createapplicationpresignedurl
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: creates-snapshot-application-s-state-data
description: Creates a snapshot of the application's state data.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.createapplicationsnapshot
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: deletes-specified-application-kinesis-data
description: Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.deleteapplication
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: deletes-amazon-cloudwatch-log-stream
description: Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.deleteapplicationcloudwatchloggingoption
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: deletes-a-inputprocessingconfiguration-input
description: Deletes an InputProcessingConfiguration from an input.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.deleteapplicationinputprocessingconfiguration
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: deletes-output-destination-configuration-your
description: Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration.
Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output
destin
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.deleteapplicationoutput
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-deletes-reference-data-source-configuration
description: Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's
configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application
table that
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.deleteapplicationreferencedatasource
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: deletes-snapshot-application-state
description: Deletes a snapshot of application state.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.deleteapplicationsnapshot
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: removes-vpc-configuration-kinesis-data
description: Removes a VPC configuration from a Kinesis Data Analytics application.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.deleteapplicationvpcconfiguration
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-information-about-specific-kinesis
description: Returns information about a specific Kinesis Data Analytics application. If you want to retrieve
a list of all applications in your account, use the ListApplications operation. Provides a detailed description of a specified version of the application. To see a list of all the
versions of an application, invoke the ListApplicationVersions operation. This operation is supported
only for Amazo
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.describeapplicationversion
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-infers-schema-sql-based-kinesis
description: Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the
specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In
the response, the op
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.discoverinputschema
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: lists-information-about-current-application
description: Lists information about the current application snapshots.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.listapplicationsnapshots
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-lists-all-versions-specified-application
description: ' Lists all the versions for the specified application, including versions that were rolled back. The
response also includes a summary of the configuration associated with each version. To get the complete description
of a specific '
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.listapplicationversions
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-list-kinesis-data-analytics
description: Returns a list of Kinesis Data Analytics applications in your account. For each application, the response
includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about
a specific ap
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.listapplications
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: retrieves-list-key-value-tags
description: Retrieves the list of key-value tags assigned to the application. For more information, see Using
Tagging.
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.listtagsforresource
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-reverts-application-previous-running-version
description: Reverts the application to the previous running version. You can roll back an application if you suspect
it is stuck in a transient status. You can roll back an application only if it is in the Stops the application from processing data. You can stop an application only if it is in the running
status, unless you set the You can use the DescribeApplication
operatio
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.stopapplication
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: adds-one-more-key-value
description: Adds one or more key-value tags to a Kinesis Data Analytics application. Note that the maximum number of
application tags includes system tags. The maximum number of user-defined application tags is 50. For more information,
see Using
Tagging.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.untagresource
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-existing-kinesis-data-analytics
description: 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 Updates the maintenance configuration of the Kinesis Data Analytics application. You can invoke
this operation on an application that is in one of the two following states: UPDATING
or AUTO
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=KinesisAnalytics_20180523.StartApplication'
path: /#X-Amz-Target=KinesisAnalytics_20180523.StartApplication
operations:
- name: startapplication
method: POST
description: Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively
call this operation to start your application.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=KinesisAnalytics_20180523.StopApplication'
path: /#X-Amz-Target=KinesisAnalytics_20180523.StopApplication
operations:
- name: stopapplication
method: POST
description: Force parameter to true.ApplicationVersionId
ea
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: '#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguratio'
path: /#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguration
operations:
- name: updateapplicationmaintenanceconfiguration
method: POST
description: 'READY or RUNNING.
If you invok'
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Amz-Target
in: header
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: true
authentication:
type: apikey
key: Authorization
value: '{{env.KINESIS_API_KEY}}'
placement: header
exposes:
- type: rest
namespace: amazon-kinesis-data-analytics-rest
port: 8080
description: REST adapter for Amazon Kinesis Analytics. One Spectral-compliant resource per consumed operation, prefixed
with /v1.
resources:
- path: /v1/x-amz-target-kinesisanalytics-20180523-addapplicationcloudwatchloggingoption
name: x-amz-target-kinesisanalytics-20180523-addapplicationcloudwatchloggingoption
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.AddApplicationCloudWatchLoggingOption.'
operations:
- method: POST
name: addapplicationcloudwatchloggingoption
description: Adds an Amazon CloudWatch log stream to monitor application configuration errors.
call: amazon-kinesis-data-analytics.addapplicationcloudwatchloggingoption
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-addapplicationinput
name: x-amz-target-kinesisanalytics-20180523-addapplicationinput
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInput.'
operations:
- method: POST
name: addapplicationinput
description: <
call: amazon-kinesis-data-analytics.addapplicationvpcconfiguration
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-createapplication
name: x-amz-target-kinesisanalytics-20180523-createapplication
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.CreateApplication.'
operations:
- method: POST
name: createapplication
description: Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics
application, see Creating
an Application.
call: amazon-kinesis-data-analytics.createapplication
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-createapplicationpresignedurl
name: x-amz-target-kinesisanalytics-20180523-createapplicationpresignedurl
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationPresignedUrl.'
operations:
- method: POST
name: createapplicationpresignedurl
description:
UPDATING
or AUTO
call: amazon-kinesis-data-analytics.rollbackapplication
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-startapplication
name: x-amz-target-kinesisanalytics-20180523-startapplication
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.StartApplication.'
operations:
- method: POST
name: startapplication
description: Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively
call this operation to start your application.
call: amazon-kinesis-data-analytics.startapplication
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-stopapplication
name: x-amz-target-kinesisanalytics-20180523-stopapplication
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.StopApplication.'
operations:
- method: POST
name: stopapplication
description: Force parameter to true.ApplicationVersionId
ea
call: amazon-kinesis-data-analytics.updateapplication
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/x-amz-target-kinesisanalytics-20180523-updateapplicationmaintenanceconfiguration
name: x-amz-target-kinesisanalytics-20180523-updateapplicationmaintenanceconfiguratio
description: 'REST surface for #X-Amz-Target=KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguratio.'
operations:
- method: POST
name: updateapplicationmaintenanceconfiguration
description: 'READY or RUNNING.
If you invok'
call: amazon-kinesis-data-analytics.updateapplicationmaintenanceconfiguration
with:
X-Amz-Target: rest.X-Amz-Target
body: rest.body
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: amazon-kinesis-data-analytics-mcp
port: 9090
transport: http
description: MCP adapter for Amazon Kinesis Analytics. One tool per consumed operation, routed inline through this capability's
consumes block.
tools:
- name: adds-amazon-cloudwatch-log-stream
description: Adds an Amazon CloudWatch log stream to monitor application configuration errors.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.addapplicationcloudwatchloggingoption
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-adds-streaming-source-your
description: <
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.addapplicationvpcconfiguration
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: creates-kinesis-data-analytics-application
description: Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application,
see Creating an Application.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.createapplication
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-creates-and-returns-url-that
description:
UPDATING
or AUTO
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.rollbackapplication
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: starts-specified-kinesis-data-analytics
description: Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively
call this operation to start your application.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.startapplication
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-stops-application-processing-data-you
description: Force parameter to true.ApplicationVersionId
ea
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.updateapplication
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-maintenance-configuration-kinesis-data
description: 'READY or RUNNING.
If you invok'
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-data-analytics.updateapplicationmaintenanceconfiguration
with:
X-Amz-Target: tools.X-Amz-Target
body: tools.body
outputParameters:
- type: object
mapping: $.