Amazon AppStream

{'Sessions': {'NetworkAccessConfiguration': {'EniId': 'string',
                                             'EniPrivateIpAddress': 'string'}}}

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a user ID 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.

See also: AWS API Documentation

Request Syntax

client.describe_sessions(
    StackName='string',
    FleetName='string',
    UserId='string',
    NextToken='string',
    Limit=123,
    AuthenticationType='API'|'SAML'|'USERPOOL'
)

type StackName

string

param StackName

[REQUIRED]

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

type FleetName

string

param FleetName

[REQUIRED]

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

type UserId

string

param UserId

The user ID.

type NextToken

string

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

type Limit

integer

param Limit

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

type AuthenticationType

string

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

rtype

dict

returns

Response Syntax

{
    'Sessions': [
        {
            'Id': 'string',
            'UserId': 'string',
            'StackName': 'string',
            'FleetName': 'string',
            'State': 'ACTIVE'|'PENDING'|'EXPIRED',
            'AuthenticationType': 'API'|'SAML'|'USERPOOL',
            'NetworkAccessConfiguration': {
                'EniPrivateIpAddress': 'string',
                'EniId': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Sessions (list) --

    Information about the streaming sessions.

    • (dict) --

      Describes a streaming session.

      • Id (string) --

        The ID of the streaming session.

      • UserId (string) --

        The identifier of the user for whom the session was created.

      • StackName (string) --

        The name of the stack for the streaming session.

      • FleetName (string) --

        The name of the fleet for the streaming session.

      • State (string) --

        The current state of the streaming session.

      • AuthenticationType (string) --

        The authentication method. The user is authenticated using a streaming URL (API ) or SAML federation (SAML ).

      • NetworkAccessConfiguration (dict) --

        The network details for the streaming session.

        • EniPrivateIpAddress (string) --

          The private IP address of the elastic network interface that is attached to instances in your VPC.

        • EniId (string) --

          The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.

  • NextToken (string) --

    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.