WorkSpaces / Client / describe_workspaces_pool_sessions

describe_workspaces_pool_sessions

WorkSpaces.Client.describe_workspaces_pool_sessions(**kwargs)

Note

End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support.

Retrieves a list that describes the streaming sessions for a specified pool.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspaces_pool_sessions(
    PoolId='string',
    UserId='string',
    Limit=123,
    NextToken='string'
)
Parameters:

  • PoolId (string) –

    [REQUIRED]

    The identifier of the pool.

  • UserId (string) – The identifier of the user.

  • Limit (integer) – The maximum size of each page of results. The default value is 20 and the maximum value is 50.

  • NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'Sessions': [
        {
            'AuthenticationType': 'SAML',
            'ConnectionState': 'CONNECTED'|'NOT_CONNECTED',
            'SessionId': 'string',
            'InstanceId': 'string',
            'PoolId': 'string',
            'ExpirationTime': datetime(2015, 1, 1),
            'NetworkAccessConfiguration': {
                'EniPrivateIpAddress': 'string',
                'EniId': 'string'
            },
            'StartTime': datetime(2015, 1, 1),
            'UserId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Sessions (list) –

      Describes the pool sessions.

      • (dict) –

        Describes a pool session.

        • AuthenticationType (string) –

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

        • ConnectionState (string) –

          Specifies whether a user is connected to the pool session.

        • SessionId (string) –

          The identifier of the session.

        • InstanceId (string) –

          The identifier for the instance hosting the session.

        • PoolId (string) –

          The identifier of the pool.

        • ExpirationTime (datetime) –

          The time that the pool session ended.

        • NetworkAccessConfiguration (dict) –

          Describes the network details of the pool.

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

        • StartTime (datetime) –

          The time that the pool sission started.

        • UserId (string) –

          The identifier of the user.

    • NextToken (string) –

      If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Exceptions

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.ResourceNotFoundException

  • WorkSpaces.Client.exceptions.AccessDeniedException