WorkSpacesWeb / Client / get_session

get_session

WorkSpacesWeb.Client.get_session(**kwargs)

Gets information for a secure browser session.

See also: AWS API Documentation

Request Syntax

response = client.get_session(
    portalId='string',
    sessionId='string'
)

Parameters:

• portalId (string) –

  [REQUIRED]

  The ID of the web portal for the session.

• sessionId (string) –

  [REQUIRED]

  The ID of the session.

Return type:

dict

Returns:

Response Syntax

{
    'session': {
        'clientIpAddresses': [
            'string',
        ],
        'endTime': datetime(2015, 1, 1),
        'portalArn': 'string',
        'sessionId': 'string',
        'startTime': datetime(2015, 1, 1),
        'status': 'Active'|'Terminated',
        'username': 'string'
    }
}

Response Structure

• (dict) –

  • session (dict) –

    The sessions in a list.

    • clientIpAddresses (list) –

      The IP address of the client.

      • (string) –

    • endTime (datetime) –

      The end time of the session.

    • portalArn (string) –

      The ARN of the web portal.

    • sessionId (string) –

      The ID of the session.

    • startTime (datetime) –

      The start time of the session.

    • status (string) –

      The status of the session.

    • username (string) –

      The username of the session.

Exceptions

• WorkSpacesWeb.Client.exceptions.InternalServerException

• WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

• WorkSpacesWeb.Client.exceptions.AccessDeniedException

• WorkSpacesWeb.Client.exceptions.ThrottlingException

• WorkSpacesWeb.Client.exceptions.ValidationException