get_browser_session¶
Operation¶
async
¶
get_browser_session(input: GetBrowserSessionInput, plugins: list[Plugin] | None = None) -> GetBrowserSessionOutput
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:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetBrowserSessionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetBrowserSessionOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetBrowserSessionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
browser_identifier: str | None = None
The unique identifier of the browser associated with the session.
class-attribute
instance-attribute
¶
session_id: str | None = None
The unique identifier of the browser session to retrieve.
Output¶
dataclass
¶
Dataclass for GetBrowserSessionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
certificates: list[Certificate] | None = None
The list of certificates installed in the browser session.
instance-attribute
¶
created_at: datetime
The time at which the browser session was created.
class-attribute
instance-attribute
¶
enterprise_policies: list[BrowserEnterprisePolicy] | None = None
A list of files containing enterprise policies for the browser session.
class-attribute
instance-attribute
¶
extensions: list[BrowserExtension] | None = None
The list of browser extensions that are configured in the browser session.
class-attribute
instance-attribute
¶
filesystem_configurations: list[ToolsFileSystemConfiguration] | None = None
The file system configurations for the browser session. Each entry describes an access point and its mount path.
class-attribute
instance-attribute
¶
last_updated_at: datetime | None = None
The time at which the browser session was last updated.
class-attribute
instance-attribute
¶
profile_configuration: BrowserProfileConfiguration | None = None
The browser profile configuration associated with this session. Contains the profile identifier that links to persistent browser data such as cookies and local storage.
class-attribute
instance-attribute
¶
proxy_configuration: ProxyConfiguration | None = None
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.
class-attribute
instance-attribute
¶
session_replay_artifact: str | None = None
The artifact containing the session replay information.
class-attribute
instance-attribute
¶
session_timeout_seconds: int | None = None
The timeout period for the browser session in seconds.
class-attribute
instance-attribute
¶
status: BrowserSessionStatus | None = None
The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
class-attribute
instance-attribute
¶
streams: BrowserSessionStream | None = None
The streams associated with this browser session. These include the automation stream and live view stream.
class-attribute
instance-attribute
¶
view_port: ViewPort | None = None
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.