Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465766489.0 KB

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

post/runtimes/{agentRuntimeArn}/stopruntimesession#X-Amzn-Bedrock-AgentCore-Runtime-Session-Id

Path parameters

agentRuntimeArnstring required

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

Query parameters

qualifierstring

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

Headers

X-Amzn-Bedrock-AgentCore-Runtime-Session-Idstring required

The ID of the session that you want to stop.

Request body

clientTokenstring

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.

Response

Success

statusCodeinteger

The status code of the request to stop the session.