Skip to content

Stop Runtime Session

bedrockagentcore_stop_runtime_session R Documentation

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

Description

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

Usage

bedrockagentcore_stop_runtime_session(runtimeSessionId, agentRuntimeArn,
  qualifier, clientToken)

Arguments

runtimeSessionId

[required] The ID of the session that you want to stop.

agentRuntimeArn

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

qualifier

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

clientToken

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.

Value

A list with the following syntax:

list(
  runtimeSessionId = "string",
  statusCode = 123
)

Request syntax

svc$stop_runtime_session(
  runtimeSessionId = "string",
  agentRuntimeArn = "string",
  qualifier = "string",
  clientToken = "string"
)