AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeSessions operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AppStream.AmazonAppStreamRequest
      Amazon.AppStream.Model.DescribeSessionsRequest

Namespace: Amazon.AppStream.Model
Assembly: AWSSDK.AppStream.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeSessionsRequest : AmazonAppStreamRequest
         IAmazonWebServiceRequest

The DescribeSessionsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeSessionsRequest()

Properties

NameTypeDescription
Public Property AuthenticationType Amazon.AppStream.AuthenticationType

Gets and sets the property 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.

Public Property FleetName System.String

Gets and sets the property FleetName.

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

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The identifier for the instance hosting the session.

Public Property Limit System.Int32

Gets and sets the property Limit.

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

Public Property NextToken System.String

Gets and sets the property 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.

Public Property StackName System.String

Gets and sets the property StackName.

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

Public Property UserId System.String

Gets and sets the property UserId.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5