get_browser_session¶
Operation¶
get_browser_session
¶
get_browser_session(request: GetBrowserSessionInput | GetBrowserSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBrowserSessionInputDict]) -> 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 |
|---|---|---|---|
request
|
GetBrowserSessionInput | GetBrowserSessionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetBrowserSessionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetBrowserSessionOutput
|
An instance of |
get_browser_session
async
¶
get_browser_session(request: GetBrowserSessionInput | GetBrowserSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBrowserSessionInputDict]) -> 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 |
|---|---|---|---|
request
|
GetBrowserSessionInput | GetBrowserSessionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetBrowserSessionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetBrowserSessionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetBrowserSessionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBrowserSessionOutput structure.
Attributes¶
certificates
class-attribute
instance-attribute
¶
certificates: list[Certificate] | None = ...
The list of certificates installed in the browser session.
created_at
instance-attribute
¶
created_at: datetime
The time at which the browser session was created.
enterprise_policies
class-attribute
instance-attribute
¶
enterprise_policies: list[BrowserEnterprisePolicy] | None = ...
A list of files containing enterprise policies for the browser session.
extensions
class-attribute
instance-attribute
¶
extensions: list[BrowserExtension] | None = ...
The list of browser extensions that are configured in the browser session.
filesystem_configurations
class-attribute
instance-attribute
¶
filesystem_configurations: list[ToolsFileSystemConfiguration] | None = ...
The file system configurations for the browser session. Each entry describes an access point and its mount path.
last_updated_at
class-attribute
instance-attribute
¶
last_updated_at: datetime | None = ...
The time at which the browser session was last updated.
profile_configuration
class-attribute
instance-attribute
¶
profile_configuration: BrowserProfileConfiguration | 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.
proxy_configuration
class-attribute
instance-attribute
¶
proxy_configuration: ProxyConfiguration | 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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
session_replay_artifact
class-attribute
instance-attribute
¶
session_replay_artifact: str | None = ...
The artifact containing the session replay information.
session_timeout_seconds
class-attribute
instance-attribute
¶
session_timeout_seconds: int | None = ...
The timeout period for the browser session in seconds.
status
class-attribute
instance-attribute
¶
status: str | None = ...
The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
streams
class-attribute
instance-attribute
¶
streams: BrowserSessionStream | None = ...
The streams associated with this browser session. These include the automation stream and live view stream.
view_port
class-attribute
instance-attribute
¶
view_port: ViewPort | 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.