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

Network.AWS.AppStream.DescribeSessions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

describeSessions #

Arguments

:: Text	`dsStackName`
-> Text	`dsFleetName`
-> DescribeSessions

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. 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 - The name of the stack. This value is case-sensitive.
dsFleetName - The name of the fleet. This value is case-sensitive.

data DescribeSessions #

See: describeSessions smart constructor.

Instances

Eq DescribeSessions #
Methods (==) :: DescribeSessions -> DescribeSessions -> Bool # (/=) :: DescribeSessions -> DescribeSessions -> Bool #
Data DescribeSessions #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeSessions -> c DescribeSessions # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeSessions # toConstr :: DescribeSessions -> Constr # dataTypeOf :: DescribeSessions -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeSessions) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeSessions) # gmapT :: (forall b. Data b => b -> b) -> DescribeSessions -> DescribeSessions # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSessions -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSessions -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeSessions -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeSessions -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeSessions -> m DescribeSessions # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSessions -> m DescribeSessions # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSessions -> m DescribeSessions #
Read DescribeSessions #
Methods readsPrec :: Int -> ReadS DescribeSessions # readList :: ReadS [DescribeSessions] # readPrec :: ReadPrec DescribeSessions # readListPrec :: ReadPrec [DescribeSessions] #
Show DescribeSessions #
Methods showsPrec :: Int -> DescribeSessions -> ShowS # show :: DescribeSessions -> String # showList :: [DescribeSessions] -> ShowS #
Generic DescribeSessions #
Associated Types type Rep DescribeSessions :: * -> * # Methods from :: DescribeSessions -> Rep DescribeSessions x # to :: Rep DescribeSessions x -> DescribeSessions #
Hashable DescribeSessions #
Methods hashWithSalt :: Int -> DescribeSessions -> Int # hash :: DescribeSessions -> Int #
ToJSON DescribeSessions #
Methods toJSON :: DescribeSessions -> Value # toEncoding :: DescribeSessions -> Encoding # toJSONList :: [DescribeSessions] -> Value # toEncodingList :: [DescribeSessions] -> Encoding #
NFData DescribeSessions #
Methods rnf :: DescribeSessions -> () #
AWSRequest DescribeSessions #
Associated Types type Rs DescribeSessions :: * # Methods request :: DescribeSessions -> Request DescribeSessions # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeSessions -> ClientResponse -> m (Response DescribeSessions) #
ToHeaders DescribeSessions #
Methods toHeaders :: DescribeSessions -> [Header] #
ToPath DescribeSessions #
Methods toPath :: DescribeSessions -> ByteString #
ToQuery DescribeSessions #
Methods toQuery :: DescribeSessions -> QueryString #
type Rep DescribeSessions #
type Rep DescribeSessions = D1 * (MetaData "DescribeSessions" "Network.AWS.AppStream.DescribeSessions" "amazonka-appstream-1.6.0-y8y45x8oYo6J4ypuRyPpf" False) (C1 * (MetaCons "DescribeSessions'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_dsUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_dsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))) ((::) (S1 * (MetaSel (Just Symbol "_dsAuthenticationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AuthenticationType))) ((::) (S1 * (MetaSel (Just Symbol "_dsStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_dsFleetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs DescribeSessions #
type Rs DescribeSessions = DescribeSessionsResponse

Request Lenses

dsUserId :: Lens' DescribeSessions (Maybe Text) #

The user ID.

dsNextToken :: Lens' DescribeSessions (Maybe Text) #

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) #

The size of each page of results. The default value is 20 and the maximum value is 50.

dsAuthenticationType :: Lens' DescribeSessions (Maybe AuthenticationType) #

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 #

The name of the stack. This value is case-sensitive.

dsFleetName :: Lens' DescribeSessions Text #

The name of the fleet. This value is case-sensitive.

Destructuring the Response

describeSessionsResponse #

Arguments

:: Int	`dssrsResponseStatus`
-> DescribeSessionsResponse

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 #

See: describeSessionsResponse smart constructor.

Instances

Eq DescribeSessionsResponse #
Methods (==) :: DescribeSessionsResponse -> DescribeSessionsResponse -> Bool # (/=) :: DescribeSessionsResponse -> DescribeSessionsResponse -> Bool #
Data DescribeSessionsResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeSessionsResponse -> c DescribeSessionsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeSessionsResponse # toConstr :: DescribeSessionsResponse -> Constr # dataTypeOf :: DescribeSessionsResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeSessionsResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeSessionsResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeSessionsResponse -> DescribeSessionsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSessionsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSessionsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeSessionsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeSessionsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeSessionsResponse -> m DescribeSessionsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSessionsResponse -> m DescribeSessionsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSessionsResponse -> m DescribeSessionsResponse #
Read DescribeSessionsResponse #
Methods readsPrec :: Int -> ReadS DescribeSessionsResponse # readList :: ReadS [DescribeSessionsResponse] # readPrec :: ReadPrec DescribeSessionsResponse # readListPrec :: ReadPrec [DescribeSessionsResponse] #
Show DescribeSessionsResponse #
Methods showsPrec :: Int -> DescribeSessionsResponse -> ShowS # show :: DescribeSessionsResponse -> String # showList :: [DescribeSessionsResponse] -> ShowS #
Generic DescribeSessionsResponse #
Associated Types type Rep DescribeSessionsResponse :: * -> * # Methods from :: DescribeSessionsResponse -> Rep DescribeSessionsResponse x # to :: Rep DescribeSessionsResponse x -> DescribeSessionsResponse #
NFData DescribeSessionsResponse #
Methods rnf :: DescribeSessionsResponse -> () #
type Rep DescribeSessionsResponse #
type Rep DescribeSessionsResponse = D1 * (MetaData "DescribeSessionsResponse" "Network.AWS.AppStream.DescribeSessions" "amazonka-appstream-1.6.0-y8y45x8oYo6J4ypuRyPpf" False) (C1 * (MetaCons "DescribeSessionsResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_dssrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_dssrsSessions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Session]))) (S1 * (MetaSel (Just Symbol "_dssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dssrsNextToken :: Lens' DescribeSessionsResponse (Maybe Text) #

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] #

Information about the streaming sessions.

dssrsResponseStatus :: Lens' DescribeSessionsResponse Int #

- | The response status code.