Stop Code Interpreter Session

bedrockagentcore_stop_code_interpreter_session

R Documentation

Terminates an active code interpreter session in Amazon Bedrock AgentCore¶

Description¶

Terminates an active code interpreter session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using start_code_interpreter_session.

The following operations are related to stop_code_interpreter_session:

start_code_interpreter_session
get_code_interpreter_session

Usage¶

bedrockagentcore_stop_code_interpreter_session(traceId, traceParent,
  codeInterpreterIdentifier, sessionId, clientToken)

Arguments¶

traceId

The trace identifier for request tracking.

traceParent

The parent trace information for distributed tracing.

codeInterpreterIdentifier

[required] The unique identifier of the code interpreter associated with the session.

sessionId

[required] The unique identifier of the code interpreter session to stop.

clientToken

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.

Value¶

A list with the following syntax:

list(
  codeInterpreterIdentifier = "string",
  sessionId = "string",
  lastUpdatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$stop_code_interpreter_session(
  traceId = "string",
  traceParent = "string",
  codeInterpreterIdentifier = "string",
  sessionId = "string",
  clientToken = "string"
)