Network.AWS.AppStream.DescribeSessions

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

Defined in Network.AWS.AppStream.DescribeSessions

Methods

(==) :: DescribeSessions -> DescribeSessions -> Bool

(/=) :: DescribeSessions -> DescribeSessions -> Bool

Data DescribeSessions

Defined in Network.AWS.AppStream.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

Defined in Network.AWS.AppStream.DescribeSessions

Methods

readsPrec :: Int -> ReadS DescribeSessions

readList :: ReadS [DescribeSessions]

readPrec :: ReadPrec DescribeSessions

readListPrec :: ReadPrec [DescribeSessions]

Show DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Methods

showsPrec :: Int -> DescribeSessions -> ShowS

show :: DescribeSessions -> String

showList :: [DescribeSessions] -> ShowS

Generic DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Associated Types

type Rep DescribeSessions :: Type -> Type

Methods

from :: DescribeSessions -> Rep DescribeSessions x

to :: Rep DescribeSessions x -> DescribeSessions

Hashable DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Methods

hashWithSalt :: Int -> DescribeSessions -> Int

hash :: DescribeSessions -> Int

ToJSON DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Methods

toJSON :: DescribeSessions -> Value

toEncoding :: DescribeSessions -> Encoding

toJSONList :: [DescribeSessions] -> Value

toEncodingList :: [DescribeSessions] -> Encoding

AWSRequest DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Associated Types

type Rs DescribeSessions :: Type

Methods

request :: DescribeSessions -> Request DescribeSessions

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeSessions -> ClientResponse -> m (Response DescribeSessions)

ToHeaders DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Methods

toHeaders :: DescribeSessions -> [Header]

ToPath DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Methods

toPath :: DescribeSessions -> ByteString

ToQuery DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Methods

toQuery :: DescribeSessions -> QueryString

NFData DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

Methods

rnf :: DescribeSessions -> ()

type Rep DescribeSessions

Defined in Network.AWS.AppStream.DescribeSessions

type Rep DescribeSessions = D1 (MetaData "DescribeSessions" "Network.AWS.AppStream.DescribeSessions" "amazonka-appstream-1.6.1-EdCHYsZUFpaEeuyeL4H95g" False) (C1 (MetaCons "DescribeSessions'" PrefixI True) ((S1 (MetaSel (Just "_dsUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 (MetaSel (Just "_dsAuthenticationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AuthenticationType)) :*: (S1 (MetaSel (Just "_dsStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dsFleetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs DescribeSessions

Defined in Network.AWS.AppStream.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

Defined in Network.AWS.AppStream.DescribeSessions

Methods

(==) :: DescribeSessionsResponse -> DescribeSessionsResponse -> Bool

(/=) :: DescribeSessionsResponse -> DescribeSessionsResponse -> Bool

Data DescribeSessionsResponse

Defined in Network.AWS.AppStream.DescribeSessions

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

Defined in Network.AWS.AppStream.DescribeSessions

Methods

readsPrec :: Int -> ReadS DescribeSessionsResponse

readList :: ReadS [DescribeSessionsResponse]

readPrec :: ReadPrec DescribeSessionsResponse

readListPrec :: ReadPrec [DescribeSessionsResponse]

Show DescribeSessionsResponse

Defined in Network.AWS.AppStream.DescribeSessions

Methods

showsPrec :: Int -> DescribeSessionsResponse -> ShowS

show :: DescribeSessionsResponse -> String

showList :: [DescribeSessionsResponse] -> ShowS

Generic DescribeSessionsResponse

Defined in Network.AWS.AppStream.DescribeSessions

Associated Types

type Rep DescribeSessionsResponse :: Type -> Type

Methods

from :: DescribeSessionsResponse -> Rep DescribeSessionsResponse x

to :: Rep DescribeSessionsResponse x -> DescribeSessionsResponse

NFData DescribeSessionsResponse

Defined in Network.AWS.AppStream.DescribeSessions

Methods

rnf :: DescribeSessionsResponse -> ()

type Rep DescribeSessionsResponse

Defined in Network.AWS.AppStream.DescribeSessions

type Rep DescribeSessionsResponse = D1 (MetaData "DescribeSessionsResponse" "Network.AWS.AppStream.DescribeSessions" "amazonka-appstream-1.6.1-EdCHYsZUFpaEeuyeL4H95g" False) (C1 (MetaCons "DescribeSessionsResponse'" PrefixI True) (S1 (MetaSel (Just "_dssrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dssrsSessions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Session])) :*: S1 (MetaSel (Just "_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.