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

GetSession

Gets information for a secure browser session.

Request Syntax


GET /portals/portalId/sessions/sessionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

portalId

The ID of the web portal for the session.

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\-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "session": { 
      "clientIpAddresses": [ "string" ],
      "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.

session

The sessions in a list.

Type: Session object

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.

retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ResourceNotFoundException

The resource cannot be found.

resourceId: Hypothetical identifier of the resource affected.
resourceType: Hypothetical type of the resource affected.

HTTP Status Code: 404

ThrottlingException

There is a throttling error.

quotaCode: The originating quota.
retryAfterSeconds: Advice to clients on when the call can be safely retried.
serviceCode: The originating service.

HTTP Status Code: 429

ValidationException

There is a validation error.

fieldList: The field that caused the error.
reason: Reason the request failed validation

HTTP Status Code: 400