| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.KinesisAnalytics.ListApplications
Description
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.
Synopsis
- data ListApplications = ListApplications' {}
- newListApplications :: ListApplications
- listApplications_exclusiveStartApplicationName :: Lens' ListApplications (Maybe Text)
- listApplications_limit :: Lens' ListApplications (Maybe Natural)
- data ListApplicationsResponse = ListApplicationsResponse' {}
- newListApplicationsResponse :: Int -> Bool -> ListApplicationsResponse
- listApplicationsResponse_httpStatus :: Lens' ListApplicationsResponse Int
- listApplicationsResponse_applicationSummaries :: Lens' ListApplicationsResponse [ApplicationSummary]
- listApplicationsResponse_hasMoreApplications :: Lens' ListApplicationsResponse Bool
Creating a Request
data ListApplications Source #
See: newListApplications smart constructor.
Constructors
| ListApplications' | |
Fields
| |
Instances
newListApplications :: ListApplications Source #
Create a value of ListApplications with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exclusiveStartApplicationName:ListApplications', listApplications_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.
$sel:limit:ListApplications', listApplications_limit - Maximum number of applications to list.
Request Lenses
listApplications_exclusiveStartApplicationName :: Lens' ListApplications (Maybe Text) Source #
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.
listApplications_limit :: Lens' ListApplications (Maybe Natural) Source #
Maximum number of applications to list.
Destructuring the Response
data ListApplicationsResponse Source #
See: newListApplicationsResponse smart constructor.
Constructors
| ListApplicationsResponse' | |
Fields
| |
Instances
newListApplicationsResponse Source #
Arguments
| :: Int | |
| -> Bool | |
| -> ListApplicationsResponse |
Create a value of ListApplicationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ListApplicationsResponse', listApplicationsResponse_httpStatus - The response's http status code.
$sel:applicationSummaries:ListApplicationsResponse', listApplicationsResponse_applicationSummaries - List of ApplicationSummary objects.
$sel:hasMoreApplications:ListApplicationsResponse', listApplicationsResponse_hasMoreApplications - Returns true if there are more applications to retrieve.
Response Lenses
listApplicationsResponse_httpStatus :: Lens' ListApplicationsResponse Int Source #
The response's http status code.
listApplicationsResponse_applicationSummaries :: Lens' ListApplicationsResponse [ApplicationSummary] Source #
List of ApplicationSummary objects.
listApplicationsResponse_hasMoreApplications :: Lens' ListApplicationsResponse Bool Source #
Returns true if there are more applications to retrieve.