Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- listApplications :: ListApplications
- data ListApplications
- laLimit :: Lens' ListApplications (Maybe Natural)
- laExclusiveStartApplicationName :: Lens' ListApplications (Maybe Text)
- listApplicationsResponse :: Int -> Bool -> ListApplicationsResponse
- data ListApplicationsResponse
- larsResponseStatus :: Lens' ListApplicationsResponse Int
- larsApplicationSummaries :: Lens' ListApplicationsResponse [ApplicationSummary]
- larsHasMoreApplications :: Lens' ListApplicationsResponse Bool
Creating a Request
listApplications :: ListApplications Source #
Creates a value of ListApplications
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
laLimit
- Maximum number of applications to list.laExclusiveStartApplicationName
- 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.
data ListApplications Source #
See: listApplications
smart constructor.
Request Lenses
laExclusiveStartApplicationName :: 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.
Destructuring the Response
listApplicationsResponse Source #
Creates a value of ListApplicationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
larsResponseStatus
- -- | The response status code.larsApplicationSummaries
- List ofApplicationSummary
objects.larsHasMoreApplications
- Returns true if there are more applications to retrieve.
data ListApplicationsResponse Source #
See: listApplicationsResponse
smart constructor.
Response Lenses
larsResponseStatus :: Lens' ListApplicationsResponse Int Source #
- - | The response status code.
larsApplicationSummaries :: Lens' ListApplicationsResponse [ApplicationSummary] Source #
List of ApplicationSummary
objects.
larsHasMoreApplications :: Lens' ListApplicationsResponse Bool Source #
Returns true if there are more applications to retrieve.