Skip to content

/AWS1/IF_BDC=>STARTCODEINTERPRETERSESSION()

About StartCodeInterpreterSession

Creates and initializes a code interpreter session in Amazon Bedrock AgentCore. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.

To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.

The following operations are related to StartCodeInterpreterSession:

Method Signature

METHODS /AWS1/IF_BDC~STARTCODEINTERPRETERSESSION
  IMPORTING
    !IV_TRACEID TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_TRACEPARENT TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_CODEINTERPRETERIDENTIFIER TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_NAME TYPE /AWS1/BDCNAME OPTIONAL
    !IV_SESSIONTIMEOUTSECONDS TYPE /AWS1/BDCCODEINTERPTRSESSTMOUT OPTIONAL
    !IT_CERTIFICATES TYPE /AWS1/CL_BDCCERTIFICATE=>TT_CERTIFICATES OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/BDCCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdcstrtcodeintsessrsp
  RAISING
    /AWS1/CX_BDCACCESSDENIEDEX
    /AWS1/CX_BDCCONFLICTEXCEPTION
    /AWS1/CX_BDCINTERNALSERVEREX
    /AWS1/CX_BDCRESOURCENOTFOUNDEX
    /AWS1/CX_BDCSERVICEQUOTAEXCDEX
    /AWS1/CX_BDCTHROTTLINGEX
    /AWS1/CX_BDCVALIDATIONEX
    /AWS1/CX_BDCCLIENTEXC
    /AWS1/CX_BDCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_codeinterpreteridentifier TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The unique identifier of the code interpreter to use for this session. This identifier specifies which code interpreter environment to initialize for the session.

Optional arguments:

iv_traceid TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The trace identifier for request tracking.

iv_traceparent TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The parent trace information for distributed tracing.

iv_name TYPE /AWS1/BDCNAME /AWS1/BDCNAME

The name of the code interpreter session. This name helps you identify and manage the session. The name does not need to be unique.

iv_sessiontimeoutseconds TYPE /AWS1/BDCCODEINTERPTRSESSTMOUT /AWS1/BDCCODEINTERPTRSESSTMOUT

The duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 900 seconds (15 minutes). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).

it_certificates TYPE /AWS1/CL_BDCCERTIFICATE=>TT_CERTIFICATES TT_CERTIFICATES

A list of certificates to install in the code interpreter session.

iv_clienttoken TYPE /AWS1/BDCCLIENTTOKEN /AWS1/BDCCLIENTTOKEN

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. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdcstrtcodeintsessrsp /AWS1/CL_BDCSTRTCODEINTSESSRSP

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startcodeinterpretersession(
  it_certificates = VALUE /aws1/cl_bdccertificate=>tt_certificates(
    ( new /aws1/cl_bdccertificate( new /aws1/cl_bdccertlocation( new /aws1/cl_bdcsecretsmanagerloc( |string| ) ) ) )
  )
  iv_clienttoken = |string|
  iv_codeinterpreteridentifier = |string|
  iv_name = |string|
  iv_sessiontimeoutseconds = 123
  iv_traceid = |string|
  iv_traceparent = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_codeinterptridentifier( ).
  lv_codeinterpretersessioni = lo_result->get_sessionid( ).
  lv_datetimestamp = lo_result->get_createdat( ).
ENDIF.