Skip to content

DescribeSessionsRequest

Source code in docs_src/capo_appstream/types/describe_sessions_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class DescribeSessionsRequest(TypedDict, closed=True):
    stack_name: NotRequired["capo_appstream.types.name.Name"]
    """<p>The name of the stack. This value is case-sensitive.</p>"""
    fleet_name: NotRequired["capo_appstream.types.name.Name"]
    """<p>The name of the fleet. This value is case-sensitive.</p>"""
    user_id: NotRequired["capo_appstream.types.user_id.UserId"]
    """<p>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</p>"""
    next_token: NotRequired["capo_appstream.types.string.String"]
    """<p>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.</p>"""
    limit: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>"""
    authentication_type: NotRequired[
        "capo_appstream.types.authentication_type.AuthenticationType"
    ]
    """<p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>"""
    instance_id: NotRequired["capo_appstream.types.string.String"]
    """<p>The identifier for the instance hosting the session.</p>"""

authentication_type instance-attribute 

authentication_type: NotRequired[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.

fleet_name instance-attribute 

fleet_name: NotRequired[Name]

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

instance_id instance-attribute 

instance_id: NotRequired[String]

The identifier for the instance hosting the session.

limit instance-attribute 

limit: NotRequired[Integer]

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

next_token instance-attribute 

next_token: NotRequired[String]

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.

stack_name instance-attribute 

stack_name: NotRequired[Name]

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

user_id instance-attribute 

user_id: NotRequired[UserId]

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