STARTBROWSERSESSION()`¶

About StartBrowserSession¶

Creates and initializes a browser session in Amazon Bedrock. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.

To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSession operation.

The following operations are related to StartBrowserSession:

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_browseridentifier` `TYPE /AWS1/BDCSTRING` `/AWS1/BDCSTRING`¶

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

Optional arguments:¶

`iv_name` `TYPE /AWS1/BDCNAME` `/AWS1/BDCNAME`¶

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

`iv_sessiontimeoutseconds` `TYPE /AWS1/BDCBROWSERSESSIONTIMEOUT` `/AWS1/BDCBROWSERSESSIONTIMEOUT`¶

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).

`io_viewport` `TYPE REF TO /AWS1/CL_BDCVIEWPORT` `/AWS1/CL_BDCVIEWPORT`¶

The dimensions of the browser viewport for this session. This determines the visible area of the web content and affects how web pages are rendered. If not specified, Amazon Bedrock uses a default viewport size.

`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_bdcstartbrowssessrsp` `/AWS1/CL_BDCSTARTBROWSSESSRSP`¶

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~startbrowsersession(
  io_viewport = new /aws1/cl_bdcviewport(
    iv_height = 123
    iv_width = 123
  )
  iv_browseridentifier = |string|
  iv_clienttoken = |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_browseridentifier( ).
  lv_browsersessionid = lo_result->get_sessionid( ).
  lv_datetimestamp = lo_result->get_createdat( ).
  lo_browsersessionstream = lo_result->get_streams( ).
  IF lo_browsersessionstream IS NOT INITIAL.
    lo_automationstream = lo_browsersessionstream->get_automationstream( ).
    IF lo_automationstream IS NOT INITIAL.
      lv_browserstreamendpoint = lo_automationstream->get_streamendpoint( ).
      lv_automationstreamstatus = lo_automationstream->get_streamstatus( ).
    ENDIF.
    lo_liveviewstream = lo_browsersessionstream->get_liveviewstream( ).
    IF lo_liveviewstream IS NOT INITIAL.
      lv_browserstreamendpoint = lo_liveviewstream->get_streamendpoint( ).
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/CL_BDC=>STARTBROWSERSESSION()¶