Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the nextToken
parameter in a subsequent call to this operation to retrieve the next set of items.
- describeSessions :: Text -> Text -> DescribeSessions
- data DescribeSessions
- dsUserId :: Lens' DescribeSessions (Maybe Text)
- dsNextToken :: Lens' DescribeSessions (Maybe Text)
- dsLimit :: Lens' DescribeSessions (Maybe Int)
- dsStackName :: Lens' DescribeSessions Text
- dsFleetName :: Lens' DescribeSessions Text
- describeSessionsResponse :: Int -> DescribeSessionsResponse
- data DescribeSessionsResponse
- dssrsNextToken :: Lens' DescribeSessionsResponse (Maybe Text)
- dssrsSessions :: Lens' DescribeSessionsResponse [Session]
- dssrsResponseStatus :: Lens' DescribeSessionsResponse Int
Creating a Request
Creates a value of DescribeSessions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsUserId
- The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.dsNextToken
- The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.dsLimit
- The size of each page of results. The default value is 20 and the maximum supported value is 50.dsStackName
- The name of the stack for which to list sessions.dsFleetName
- The name of the fleet for which to list sessions.
data DescribeSessions Source #
See: describeSessions
smart constructor.
Request Lenses
dsUserId :: Lens' DescribeSessions (Maybe Text) Source #
The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.
dsNextToken :: Lens' DescribeSessions (Maybe Text) Source #
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dsLimit :: Lens' DescribeSessions (Maybe Int) Source #
The size of each page of results. The default value is 20 and the maximum supported value is 50.
dsStackName :: Lens' DescribeSessions Text Source #
The name of the stack for which to list sessions.
dsFleetName :: Lens' DescribeSessions Text Source #
The name of the fleet for which to list sessions.
Destructuring the Response
describeSessionsResponse Source #
Creates a value of DescribeSessionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dssrsNextToken
- The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.dssrsSessions
- The list of streaming sessions.dssrsResponseStatus
- -- | The response status code.
data DescribeSessionsResponse Source #
See: describeSessionsResponse
smart constructor.
Response Lenses
dssrsNextToken :: Lens' DescribeSessionsResponse (Maybe Text) Source #
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
dssrsSessions :: Lens' DescribeSessionsResponse [Session] Source #
The list of streaming sessions.
dssrsResponseStatus :: Lens' DescribeSessionsResponse Int Source #
- - | The response status code.