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 |
Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
- describeSessions :: Text -> Text -> DescribeSessions
- data DescribeSessions
- dsUserId :: Lens' DescribeSessions (Maybe Text)
- dsNextToken :: Lens' DescribeSessions (Maybe Text)
- dsLimit :: Lens' DescribeSessions (Maybe Int)
- dsAuthenticationType :: Lens' DescribeSessions (Maybe AuthenticationType)
- 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 ID.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 value is 50.dsAuthenticationType
- The authentication method. SpecifyAPI
for a user authenticated using a streaming URL orSAML
for a SAML federated user. The default is to authenticate users using a streaming URL.dsStackName
- The name of the stack. This value is case-sensitive.dsFleetName
- The name of the fleet. This value is case-sensitive.
data DescribeSessions Source #
See: describeSessions
smart constructor.
Request Lenses
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 value is 50.
dsAuthenticationType :: Lens' DescribeSessions (Maybe AuthenticationType) Source #
The authentication method. Specify API
for a user authenticated using a streaming URL or SAML
for a SAML federated user. The default is to authenticate users using a streaming URL.
dsStackName :: Lens' DescribeSessions Text Source #
The name of the stack. This value is case-sensitive.
dsFleetName :: Lens' DescribeSessions Text Source #
The name of the fleet. This value is case-sensitive.
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
- Information about the 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 #
Information about the streaming sessions.
dssrsResponseStatus :: Lens' DescribeSessionsResponse Int Source #
- - | The response status code.