Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListSessions

Lists information for multiple secure browser sessions from a specific portal.

Request Syntax


GET /portals/portalId/sessions?maxResults=maxResults&nextToken=nextToken&sessionId=sessionId&sortBy=sortBy&status=status&username=username HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to be included in the next page.

Valid Range: Minimum value of 1.

nextToken

The pagination token used to retrieve the next page of results for this operation.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^\S+$

portalId

The ID of the web portal for the sessions.

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z0-9\-]+$

Required: Yes

sessionId

The ID of the session.

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z0-9\-]+$

sortBy

The method in which the returned sessions should be sorted.

Valid Values: StartTimeAscending | StartTimeDescending

status

The status of the session.

Valid Values: Active | Terminated

username

The username of the session.

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^[\s\S]*$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "sessions": [ 
      { 
         "endTime": number,
         "portalArn": "string",
         "sessionId": "string",
         "startTime": number,
         "status": "string",
         "username": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The pagination token used to retrieve the next page of results for this operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^\S+$

sessions

The sessions in a list.

Type: Array of SessionSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServerException

There is an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404

ThrottlingException

There is a throttling error.

HTTP Status Code: 429

ValidationException

There is a validation error.

HTTP Status Code: 400