2024/09/19 - Amazon WorkSpaces Web - 3 new api methods
Changes WorkSpaces Secure Browser now enables Administrators to view and manage end-user browsing sessions via Session Management APIs.
Lists information for multiple secure browser sessions from a specific portal.
See also: AWS API Documentation
Request Syntax
client.list_sessions( maxResults=123, nextToken='string', portalId='string', sessionId='string', sortBy='StartTimeAscending'|'StartTimeDescending', status='Active'|'Terminated', username='string' )
integer
The maximum number of results to be included in the next page.
string
The pagination token used to retrieve the next page of results for this operation.
string
[REQUIRED]
The ID of the web portal for the sessions.
string
The ID of the session.
string
The method in which the returned sessions should be sorted.
string
The status of the session.
string
The username of the session.
dict
Response Syntax
{ 'nextToken': 'string', 'sessions': [ { 'endTime': datetime(2015, 1, 1), 'portalArn': 'string', 'sessionId': 'string', 'startTime': datetime(2015, 1, 1), 'status': 'Active'|'Terminated', 'username': 'string' }, ] }
Response Structure
(dict) --
nextToken (string) --
The pagination token used to retrieve the next page of results for this operation.
sessions (list) --
The sessions in a list.
(dict) --
Summary information about a secure browser session.
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.
Expires an active secure browser session.
See also: AWS API Documentation
Request Syntax
client.expire_session( portalId='string', sessionId='string' )
string
[REQUIRED]
The ID of the web portal for the session.
string
[REQUIRED]
The ID of the session to expire.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets information for a secure browser session.
See also: AWS API Documentation
Request Syntax
client.get_session( portalId='string', sessionId='string' )
string
[REQUIRED]
The ID of the web portal for the session.
string
[REQUIRED]
The ID of the session.
dict
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.