After careful consideration, we have decided to discontinue Amazon Kinesis Data Analytics for SQL applications in two steps:
1. From October 15, 2025, you will not be able to create new Kinesis Data Analytics for SQL applications.
2. We will delete your applications starting January 27, 2026. You will not be able to start or operate your Amazon Kinesis Data Analytics for SQL applications. Support will no longer be available for Amazon Kinesis Data Analytics for SQL from that time. For more information, see Amazon Kinesis Data Analytics for SQL Applications discontinuation.
ListApplications
Note
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 and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Returns a list of Amazon Kinesis Analytics applications in your account. For each
application, the response includes the application name, Amazon Resource Name (ARN), and
status. If the response returns the HasMoreApplications value as true, you
can send another request by adding the ExclusiveStartApplicationName in the
request body, and set the value of this to the last application name from the previous
response.
If you want detailed information about a specific application, use DescribeApplication.
This operation requires permissions to perform the
kinesisanalytics:ListApplications action.
Request Syntax
{
"ExclusiveStartApplicationName": "string",
"Limit": number
}Request Parameters
The request accepts the following data in JSON format.
- ExclusiveStartApplicationName
-
Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+Required: No
- Limit
-
Maximum number of applications to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
Response Syntax
{
"ApplicationSummaries": [
{
"ApplicationARN": "string",
"ApplicationName": "string",
"ApplicationStatus": "string"
}
],
"HasMoreApplications": boolean
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ApplicationSummaries
-
List of
ApplicationSummaryobjects.Type: Array of ApplicationSummary objects
- HasMoreApplications
-
Returns true if there are more applications to retrieve.
Type: Boolean
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
