Amazonka.AppStream.DescribeSessions

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

This operation returns paginated results.

Creating a Request

data DescribeSessions

See: newDescribeSessions smart constructor.

Constructors

DescribeSessions'

Fields

• authenticationType :: 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.

• limit :: Maybe Int

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

• nextToken :: 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.

• userId :: Maybe Text

  The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

• stackName :: Text

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

• fleetName :: Text

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

Instances

ToJSON DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

toJSON :: DescribeSessions -> Value

toEncoding :: DescribeSessions -> Encoding

toJSONList :: [DescribeSessions] -> Value

toEncodingList :: [DescribeSessions] -> Encoding

ToHeaders DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

toHeaders :: DescribeSessions -> [Header]

ToPath DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

toPath :: DescribeSessions -> ByteString

ToQuery DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

toQuery :: DescribeSessions -> QueryString

AWSPager DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

page :: DescribeSessions -> AWSResponse DescribeSessions -> Maybe DescribeSessions

AWSRequest DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Associated Types

type AWSResponse DescribeSessions

Methods

request :: (Service -> Service) -> DescribeSessions -> Request DescribeSessions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSessions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSessions)))

Generic DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Associated Types

type Rep DescribeSessions :: Type -> Type

Methods

from :: DescribeSessions -> Rep DescribeSessions x

to :: Rep DescribeSessions x -> DescribeSessions

Read DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

readsPrec :: Int -> ReadS DescribeSessions

readList :: ReadS [DescribeSessions]

readPrec :: ReadPrec DescribeSessions

readListPrec :: ReadPrec [DescribeSessions]

Show DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

showsPrec :: Int -> DescribeSessions -> ShowS

show :: DescribeSessions -> String

showList :: [DescribeSessions] -> ShowS

NFData DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

rnf :: DescribeSessions -> ()

Eq DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

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

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

Hashable DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

Methods

hashWithSalt :: Int -> DescribeSessions -> Int

hash :: DescribeSessions -> Int

type AWSResponse DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

type AWSResponse DescribeSessions = DescribeSessionsResponse

type Rep DescribeSessions

Defined in Amazonka.AppStream.DescribeSessions

type Rep DescribeSessions = D1 ('MetaData "DescribeSessions" "Amazonka.AppStream.DescribeSessions" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DescribeSessions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationType)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fleetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeSessions

Arguments

:: Text

DescribeSessions

-> Text

DescribeSessions

-> DescribeSessions

Create a value of DescribeSessions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSessions, describeSessions_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.

$sel:limit:DescribeSessions', describeSessions_limit - The size of each page of results. The default value is 20 and the maximum value is 50.

DescribeSessions, describeSessions_nextToken - 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.

DescribeSessions, describeSessions_userId - The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

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

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

Request Lenses

describeSessions_authenticationType :: 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.

describeSessions_limit :: Lens' DescribeSessions (Maybe Int)

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

describeSessions_nextToken :: 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.

describeSessions_userId :: Lens' DescribeSessions (Maybe Text)

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

describeSessions_stackName :: Lens' DescribeSessions Text

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

describeSessions_fleetName :: Lens' DescribeSessions Text

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

Destructuring the Response

data DescribeSessionsResponse

See: newDescribeSessionsResponse smart constructor.

Constructors

DescribeSessionsResponse'

Fields

• nextToken :: 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.

• sessions :: Maybe [Session]

  Information about the streaming sessions.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeSessionsResponse

Defined in Amazonka.AppStream.DescribeSessions

Associated Types

type Rep DescribeSessionsResponse :: Type -> Type

Methods

from :: DescribeSessionsResponse -> Rep DescribeSessionsResponse x

to :: Rep DescribeSessionsResponse x -> DescribeSessionsResponse

Read DescribeSessionsResponse

Defined in Amazonka.AppStream.DescribeSessions

Methods

readsPrec :: Int -> ReadS DescribeSessionsResponse

readList :: ReadS [DescribeSessionsResponse]

readPrec :: ReadPrec DescribeSessionsResponse

readListPrec :: ReadPrec [DescribeSessionsResponse]

Show DescribeSessionsResponse

Defined in Amazonka.AppStream.DescribeSessions

Methods

showsPrec :: Int -> DescribeSessionsResponse -> ShowS

show :: DescribeSessionsResponse -> String

showList :: [DescribeSessionsResponse] -> ShowS

NFData DescribeSessionsResponse

Defined in Amazonka.AppStream.DescribeSessions

Methods

rnf :: DescribeSessionsResponse -> ()

Eq DescribeSessionsResponse

Defined in Amazonka.AppStream.DescribeSessions

Methods

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

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

type Rep DescribeSessionsResponse

Defined in Amazonka.AppStream.DescribeSessions

type Rep DescribeSessionsResponse = D1 ('MetaData "DescribeSessionsResponse" "Amazonka.AppStream.DescribeSessions" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DescribeSessionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sessions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Session])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSessionsResponse

Arguments

:: Int

$sel:httpStatus:DescribeSessionsResponse'

-> DescribeSessionsResponse

Create a value of DescribeSessionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSessions, describeSessionsResponse_nextToken - 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.

$sel:sessions:DescribeSessionsResponse', describeSessionsResponse_sessions - Information about the streaming sessions.

$sel:httpStatus:DescribeSessionsResponse', describeSessionsResponse_httpStatus - The response's http status code.

Response Lenses

describeSessionsResponse_nextToken :: 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.

describeSessionsResponse_sessions :: Lens' DescribeSessionsResponse (Maybe [Session])

Information about the streaming sessions.

describeSessionsResponse_httpStatus :: Lens' DescribeSessionsResponse Int

The response's http status code.