STARTCODEINTERPRETERSESSION()`¶

About StartCodeInterpreterSession¶

Creates and initializes a code interpreter session in Amazon Bedrock. 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¶

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_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 time in seconds after which the session automatically terminates if there is no activity. The default value is 3600 seconds (1 hour). The minimum allowed value is 60 seconds, and the maximum allowed value is 28800 seconds (8 hours).

`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 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`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->/aws1/if_bdc~startcodeinterpretersession(
  iv_clienttoken = |string|
  iv_codeinterpreteridentifier = |string|
  iv_name = |string|
  iv_sessiontimeoutseconds = 123
).

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.

/AWS1/CL_BDC=>STARTCODEINTERPRETERSESSION()¶