Skip to content

stop_browser_session

Operation

stop_browser_session

stop_browser_session(request: StopBrowserSessionInput | StopBrowserSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopBrowserSessionInputDict]) -> 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
request StopBrowserSessionInput | StopBrowserSessionInputDict | 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[StopBrowserSessionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopBrowserSessionOutput

An instance of StopBrowserSessionOutput.

stop_browser_session async

stop_browser_session(request: StopBrowserSessionInput | StopBrowserSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopBrowserSessionInputDict]) -> 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
request StopBrowserSessionInput | StopBrowserSessionInputDict | 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[StopBrowserSessionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopBrowserSessionOutput

An instance of StopBrowserSessionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

StopBrowserSessionInputDict

Bases: TypedDict

Dictionary form of StopBrowserSessionInput.

Attributes

browser_identifier instance-attribute
browser_identifier: Required[str]

The unique identifier of the browser associated with the session.

client_token instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

session_id instance-attribute
session_id: Required[str]

The unique identifier of the browser session to stop.

trace_id instance-attribute
trace_id: str | None

The trace identifier for request tracking.

trace_parent instance-attribute
trace_parent: str | None

The parent trace information for distributed tracing.

StopBrowserSessionInput dataclass

Bases: _SerdeShape

Dataclass for StopBrowserSessionInput structure.

Attributes

browser_identifier class-attribute instance-attribute
browser_identifier: str | None = ...

The unique identifier of the browser associated with the session.

client_token class-attribute instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

session_id class-attribute instance-attribute
session_id: str | None = ...

The unique identifier of the browser session to stop.

trace_id class-attribute instance-attribute
trace_id: str | None = ...

The trace identifier for request tracking.

trace_parent class-attribute instance-attribute
trace_parent: str | None = ...

The parent trace information for distributed tracing.

Output

StopBrowserSessionOutput dataclass

Bases: _SerdeShape

Dataclass for StopBrowserSessionOutput structure.

Attributes

browser_identifier instance-attribute
browser_identifier: str

The identifier of the browser.

last_updated_at instance-attribute
last_updated_at: datetime

The time at which the browser session was last updated.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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_id instance-attribute
session_id: str

The identifier of the browser session.