browser_sessions
Creates, updates, deletes, gets or lists a browser_sessions resource.
Overview
| Name | browser_sessions |
| Type | Resource |
| Id | aws.bedrock_agentcore.browser_sessions |
Fields
The following fields are returned by SELECT queries:
- get_browser_session
- list_browser_sessions
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the browser session. |
browser_identifier | string | The identifier of the browser. |
certificates | array | The list of certificates installed in the browser session. |
created_at | string (date-time) | The time at which the browser session was created. |
enterprise_policies | array | A list of files containing enterprise policies for the browser session. |
extensions | array | The list of browser extensions that are configured in the browser session. |
filesystem_configurations | array | The file system configurations for the browser session. Each entry describes an access point and its mount path. |
last_updated_at | string (date-time) | The time at which the browser session was last updated. |
profile_configuration | object | The browser profile configuration associated with this session. Contains the profile identifier that links to persistent browser data such as cookies and local storage. |
proxy_configuration | object | The 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_id | string | The identifier of the browser session. (pattern: <code>[0-9a-zA-Z]{1,40}</code>) |
session_replay_artifact | string | The artifact containing the session replay information. |
session_timeout_seconds | integer | The timeout period for the browser session in seconds. |
status | string | The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED. (READY, TERMINATED) |
streams | object | The streams associated with this browser session. These include the automation stream and live view stream. |
view_port | object | 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. |
| Name | Datatype | Description |
|---|---|---|
items_ | array | The list of browser sessions that match the specified criteria. |
next_token | string | The token to use in a subsequent ListBrowserSessions request to get the next set of results. (pattern: <code>\S*</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_browser_session | select | browser_identifier, sessionId, region | 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 | |
list_browser_sessions | select | browser_identifier, region | Retrieves 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.
| Name | Datatype | Description |
|---|---|---|
browser_identifier | string | The 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. |
region | string | AWS region (default: us-east-1) |
sessionId | string | The unique identifier of the browser session to retrieve. |
SELECT examples
- get_browser_session
- list_browser_sessions
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
;
Retrieves 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
SELECT
items_,
next_token
FROM aws.bedrock_agentcore.browser_sessions
WHERE browser_identifier = '{{ browser_identifier }}' -- required
AND region = '{{ region }}' -- required
;