libZSservicesZSamazonka-appstreamZSamazonka-appstream
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppStream.DescribeSessions

Description

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.

Synopsis

Creating a Request

data DescribeSessions Source #

See: newDescribeSessions smart constructor.

Constructors

DescribeSessions' 

Fields

  • userId :: Maybe Text

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

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

  • limit :: Maybe Int

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

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

  • 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

Instances details
Eq DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Read DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Show DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Generic DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Associated Types

type Rep DescribeSessions :: Type -> Type #

NFData DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Methods

rnf :: DescribeSessions -> () #

Hashable DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

ToJSON DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

AWSPager DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

AWSRequest DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Associated Types

type AWSResponse DescribeSessions #

ToHeaders DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

ToPath DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

ToQuery DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

type Rep DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

type Rep DescribeSessions = D1 ('MetaData "DescribeSessions" "Amazonka.AppStream.DescribeSessions" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "DescribeSessions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationType)) :*: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fleetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribeSessions Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

newDescribeSessions Source #

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:

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

$sel:nextToken: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.

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

$sel:authenticationType: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:stackName:DescribeSessions', describeSessions_stackName - The name of the stack. This value is case-sensitive.

$sel:fleetName:DescribeSessions', describeSessions_fleetName - The name of the fleet. This value is case-sensitive.

Request Lenses

describeSessions_userId :: Lens' DescribeSessions (Maybe Text) Source #

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

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

describeSessions_limit :: Lens' DescribeSessions (Maybe Int) Source #

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

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

describeSessions_stackName :: Lens' DescribeSessions Text Source #

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

describeSessions_fleetName :: Lens' DescribeSessions Text Source #

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

Destructuring the Response

data DescribeSessionsResponse Source #

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

Instances details
Eq DescribeSessionsResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Read DescribeSessionsResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Show DescribeSessionsResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Generic DescribeSessionsResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

Associated Types

type Rep DescribeSessionsResponse :: Type -> Type #

NFData DescribeSessionsResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

type Rep DescribeSessionsResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeSessions

type Rep DescribeSessionsResponse = D1 ('MetaData "DescribeSessionsResponse" "Amazonka.AppStream.DescribeSessions" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" '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 Source #

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:

$sel:nextToken: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) 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.

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

Information about the streaming sessions.