Skip to main content

browser_sessions

Creates, updates, deletes, gets or lists a browser_sessions resource.

Overview

Namebrowser_sessions
TypeResource
Idaws.bedrock_agentcore.browser_sessions

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name of the browser session.
browser_identifierstringThe identifier of the browser.
certificatesarrayThe list of certificates installed in the browser session.
created_atstring (date-time)The time at which the browser session was created.
enterprise_policiesarrayA list of files containing enterprise policies for the browser session.
extensionsarrayThe list of browser extensions that are configured in the browser session.
filesystem_configurationsarrayThe file system configurations for the browser session. Each entry describes an access point and its mount path.
last_updated_atstring (date-time)The time at which the browser session was last updated.
profile_configurationobjectThe browser profile configuration associated with this session. Contains the profile identifier that links to persistent browser data such as cookies and local storage.
proxy_configurationobjectThe active proxy configuration for this browser session. This field is only present if proxy configuration was provided when the session was started using StartBrowserSession. The configuration includes proxy servers, domain bypass rules and the proxy authentication credentials.
session_idstringThe identifier of the browser session. (pattern: <code>[0-9a-zA-Z]{1,40}</code>)
session_replay_artifactstringThe artifact containing the session replay information.
session_timeout_secondsintegerThe timeout period for the browser session in seconds.
statusstringThe current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED. (READY, TERMINATED)
streamsobjectThe streams associated with this browser session. These include the automation stream and live view stream.
view_portobjectThe 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.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_browser_sessionselectbrowser_identifier, sessionId, regionRetrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. 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: StartBrowserSession ListBrowserSessions StopBrowserSession
list_browser_sessionsselectbrowser_identifier, regionRetrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps. You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently. We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions. The following operations are related to ListBrowserSessions: StartBrowserSession GetBrowserSession

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
browser_identifierstringThe unique identifier of the browser to list sessions for. If specified, only sessions for this browser are returned. If not specified, sessions for all browsers are returned.
regionstringAWS region (default: us-east-1)
sessionIdstringThe unique identifier of the browser session to retrieve.

SELECT examples

Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. 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: StartBrowserSession ListBrowserSessions StopBrowserSession

SELECT
name,
browser_identifier,
certificates,
created_at,
enterprise_policies,
extensions,
filesystem_configurations,
last_updated_at,
profile_configuration,
proxy_configuration,
session_id,
session_replay_artifact,
session_timeout_seconds,
status,
streams,
view_port
FROM aws.bedrock_agentcore.browser_sessions
WHERE browser_identifier = '{{ browser_identifier }}' -- required
AND sessionId = '{{ sessionId }}' -- required
AND region = '{{ region }}' -- required
;