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

GetBrowserSession

Retrieves detailed information about a specific browser session in Amazon Bedrock. This operation returns the session's configuration, current status, associated streams, and metadata.

To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.

The following operations are related to GetBrowserSession:

Request Syntax


GET /browsers/browserIdentifier/sessions/get?sessionId=sessionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

browserIdentifier

The unique identifier of the browser associated with the session.

Required: Yes

sessionId

The unique identifier of the browser session to retrieve.

Pattern: [0-9a-zA-Z]{1,40}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "browserIdentifier": "string",
   "createdAt": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "sessionId": "string",
   "sessionReplayArtifact": "string",
   "sessionTimeoutSeconds": number,
   "status": "string",
   "streams": { 
      "automationStream": { 
         "streamEndpoint": "string",
         "streamStatus": "string"
      },
      "liveViewStream": { 
         "streamEndpoint": "string"
      }
   },
   "viewPort": { 
      "height": number,
      "width": number
   }
}

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.

browserIdentifier

The identifier of the browser.

Type: String

createdAt

The time at which the browser session was created.

Type: Timestamp

lastUpdatedAt

The time at which the browser session was last updated.

Type: Timestamp

name

The name of the browser session.

Type: String

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

sessionId

The identifier of the browser session.

Type: String

Pattern: [0-9a-zA-Z]{1,40}

sessionReplayArtifact

The artifact containing the session replay information.

Type: String

sessionTimeoutSeconds

The timeout period for the browser session in seconds.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 28800.

status

The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.

Type: String

Valid Values: READY | TERMINATED

streams

The streams associated with this browser session. These include the automation stream and live view stream.

Type: BrowserSessionStream object

viewPort

The configuration that defines the dimensions of a browser viewport in a browser session. The viewport determines the visible area of web content and affects how web pages are rendered and displayed. Proper viewport configuration ensures that web content is displayed correctly for the agent's browsing tasks.

Type: ViewPort object

Errors

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

AccessDeniedException

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

HTTP Status Code: 403

InternalServerException

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

HTTP Status Code: 500

ResourceNotFoundException

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

HTTP Status Code: 404

ThrottlingException

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

HTTP Status Code: 429

ValidationException

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

HTTP Status Code: 400