stop_browser_session¶
Operation¶
async
¶
stop_browser_session(input: StopBrowserSessionInput, plugins: list[Plugin] | None = None) -> StopBrowserSessionOutput
Terminates an active browser session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a browser session, you must specify both the browser identifier
and the session ID. Once stopped, a session cannot be restarted; you
must create a new session using StartBrowserSession.
The following operations are related to StopBrowserSession:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StopBrowserSessionInput
|
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 |
|---|---|
StopBrowserSessionOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for StopBrowserSessionInput 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
¶
client_token: str | None = None
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
class-attribute
instance-attribute
¶
session_id: str | None = None
The unique identifier of the browser session to stop.
class-attribute
instance-attribute
¶
trace_id: str | None = None
The trace identifier for request tracking.
class-attribute
instance-attribute
¶
trace_parent: str | None = None
The parent trace information for distributed tracing.