Skip to content

Bedrock AgentCore  >  Operations  >  stop_runtime_session

stop_runtime_session

Operation

stop_runtime_session async 

stop_runtime_session(input: StopRuntimeSessionInput, plugins: list[Plugin] | None = None) -> StopRuntimeSessionOutput

Stops a session that is running in an running AgentCore Runtime agent.

Parameters:

Name Type Description Default
input StopRuntimeSessionInput

An instance of StopRuntimeSessionInput.

 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
StopRuntimeSessionOutput

An instance of StopRuntimeSessionOutput.

Input

StopRuntimeSessionInput dataclass

Dataclass for StopRuntimeSessionInput structure.

Attributes

agent_runtime_arn class-attribute instance-attribute 
agent_runtime_arn: str | None = None

The ARN of the agent that contains the session that you want to stop.

client_token class-attribute instance-attribute 
client_token: str | None = None

Idempotent token used to identify the request. If you use the same token with multiple requests, the same response is returned. Use ClientToken to prevent the same request from being processed more than once.

qualifier class-attribute instance-attribute 
qualifier: str | None = None

Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.

runtime_session_id class-attribute instance-attribute 
runtime_session_id: str | None = None

The ID of the session that you want to stop.

Output

StopRuntimeSessionOutput dataclass

Dataclass for StopRuntimeSessionOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.

runtime_session_id class-attribute instance-attribute 
runtime_session_id: str | None = None

The ID of the session that you requested to stop.

status_code class-attribute instance-attribute 
status_code: int | None = None

The status code of the request to stop the session.