Skip to content

Amazon Kinesis Analytics API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.

Amazon Kinesis Analytics is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 51 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2018-05-23
Endpoints
51
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=KinesisAnalytics_20150814.AddApplicationCloudWatchLoggingOption<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.AddApplicationInput<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.AddApplicationInputProcessingConfiguration<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.AddApplicationOutput<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.AddApplicationReferenceDataSource<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.CreateApplication<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.DeleteApplication<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.DeleteApplicationCloudWatchLoggingOption<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.DeleteApplicationInputProcessingConfiguration<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.DeleteApplicationOutput<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.DeleteApplicationReferenceDataSource<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.DescribeApplication<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.DiscoverInputSchema<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.ListApplications<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.ListTagsForResourceRetrieves the list of key-value tags assigned to the application. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how
POST/#X-Amz-Target=KinesisAnalytics_20150814.StartApplication<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.StopApplication<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20150814.TagResourceAdds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of
POST/#X-Amz-Target=KinesisAnalytics_20150814.UntagResourceRemoves one or more tags from a Kinesis Analytics application. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-ta
POST/#X-Amz-Target=KinesisAnalytics_20150814.UpdateApplication<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL
POST/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationCloudWatchLoggingOptionAdds an Amazon CloudWatch log stream to monitor application configuration errors.
POST/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInput<p> Adds a streaming source to your SQL-based Kinesis Data Analytics application. </p> <p>You can add a streaming source when you create an application, or you
POST/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationInputProcessingConfigurationAdds an <a>InputProcessingConfiguration</a> to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream befo
POST/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationOutput<p>Adds an external destination to your SQL-based Kinesis Data Analytics application.</p> <p>If you want Kinesis Data Analytics to deliver data from an in-appli
POST/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationReferenceDataSource<p>Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.</p> <p>Kinesis Data Analytics reads reference data (that is, an Ama
POST/#X-Amz-Target=KinesisAnalytics_20180523.AddApplicationVpcConfiguration<p>Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.</p> <p>Note the follow
POST/#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationCreates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see <a href="https://docs.aws.amazon.com/kine
POST/#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationPresignedUrl<p>Creates and returns a URL that you can use to connect to an application's extension.</p> <p>The IAM role or user used to call this API defines the permission
POST/#X-Amz-Target=KinesisAnalytics_20180523.CreateApplicationSnapshotCreates a snapshot of the application's state data.
POST/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationDeletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
POST/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationCloudWatchLoggingOptionDeletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
POST/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationInputProcessingConfigurationDeletes an <a>InputProcessingConfiguration</a> from an input.
POST/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationOutputDeletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write
POST/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationReferenceDataSource<p>Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.</p> <p>If the application is r
POST/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationSnapshotDeletes a snapshot of application state.
POST/#X-Amz-Target=KinesisAnalytics_20180523.DeleteApplicationVpcConfigurationRemoves a VPC configuration from a Kinesis Data Analytics application.
POST/#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplication<p>Returns information about a specific Kinesis Data Analytics application.</p> <p>If you want to retrieve a list of all applications in your account, use the <
POST/#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationSnapshotReturns information about a snapshot of application state data.
POST/#X-Amz-Target=KinesisAnalytics_20180523.DescribeApplicationVersion<p>Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the <a>ListApplication
POST/#X-Amz-Target=KinesisAnalytics_20180523.DiscoverInputSchema<p>Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kin
POST/#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationSnapshotsLists information about the current application snapshots.
POST/#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationVersions<p>Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration ass
POST/#X-Amz-Target=KinesisAnalytics_20180523.ListApplications<p>Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name
POST/#X-Amz-Target=KinesisAnalytics_20180523.ListTagsForResourceRetrieves the list of key-value tags assigned to the application. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/java/ho
POST/#X-Amz-Target=KinesisAnalytics_20180523.RollbackApplication<p>Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status. </p> <p>You can r
POST/#X-Amz-Target=KinesisAnalytics_20180523.StartApplicationStarts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
POST/#X-Amz-Target=KinesisAnalytics_20180523.StopApplication<p>Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the <code>Force</code> parameter
POST/#X-Amz-Target=KinesisAnalytics_20180523.TagResourceAdds 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 numb
POST/#X-Amz-Target=KinesisAnalytics_20180523.UntagResourceRemoves one or more tags from a Kinesis Data Analytics application. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/java/
POST/#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplication<p>Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.
POST/#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguration<p>Updates the maintenance configuration of the Kinesis Data Analytics application. </p> <p>You can invoke this operation on an application that is in one of th

Questions

Does the Amazon Kinesis Analytics API need an API key?

Yes. The Amazon Kinesis Analytics API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Kinesis Analytics API support HTTPS?

Yes, the Amazon Kinesis Analytics API is served over HTTPS.

How many endpoints does the Amazon Kinesis Analytics API have?

Its OpenAPI description lists 51 endpoints in version 2018-05-23. All of them are shown on this page.

What are alternatives to the Amazon Kinesis Analytics API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).