stop_runtime_session¶
Operation¶
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 |
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 |
Input¶
dataclass
¶
Dataclass for StopRuntimeSessionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
agent_runtime_arn: str | None = None
The ARN of the agent that contains the session that you want to stop.
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.
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.
class-attribute
instance-attribute
¶
runtime_session_id: str | None = None
The ID of the session that you want to stop.
Output¶
dataclass
¶
Dataclass for StopRuntimeSessionOutput structure.