/AWS1/IF_BDC=>STARTBROWSERSESSION()

About StartBrowserSession

Creates and initializes a browser session in Amazon Bedrock AgentCore. 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:

• GetBrowserSession

• UpdateBrowserStream

• SaveBrowserSessionProfile

• StopBrowserSession

• InvokeBrowser

Method Signature

METHODS /AWS1/IF_BDC~STARTBROWSERSESSION
  IMPORTING
    !IV_TRACEID TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_TRACEPARENT TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_BROWSERIDENTIFIER TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_NAME TYPE /AWS1/BDCNAME OPTIONAL
    !IV_SESSIONTIMEOUTSECONDS TYPE /AWS1/BDCBROWSERSESSIONTIMEOUT OPTIONAL
    !IO_VIEWPORT TYPE REF TO /AWS1/CL_BDCVIEWPORT OPTIONAL
    !IT_EXTENSIONS TYPE /AWS1/CL_BDCBROWSEREXTENSION=>TT_BROWSEREXTENSIONS OPTIONAL
    !IO_PROFILECONFIGURATION TYPE REF TO /AWS1/CL_BDCBROWSERPROFILECONF OPTIONAL
    !IO_PROXYCONFIGURATION TYPE REF TO /AWS1/CL_BDCPROXYCONFIGURATION OPTIONAL
    !IT_ENTERPRISEPOLICIES TYPE /AWS1/CL_BDCBROWSERENTRPPOLICY=>TT_BROWSERENTERPRISEPOLICIES 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_bdcstartbrowssessrsp
  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_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_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 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 duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 3600 seconds (1 hour). Recommended minimum: 60 seconds. Maximum allowed: 28,800 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 AgentCore uses a default viewport size.

it_extensions TYPE /AWS1/CL_BDCBROWSEREXTENSION=>TT_BROWSEREXTENSIONS TT_BROWSEREXTENSIONS

A list of browser extensions to load into the browser session.

io_profileconfiguration TYPE REF TO /AWS1/CL_BDCBROWSERPROFILECONF /AWS1/CL_BDCBROWSERPROFILECONF

The browser profile configuration to use for this session. A browser profile contains persistent data such as cookies and local storage that can be reused across multiple browser sessions. If specified, the session initializes with the profile's stored data, enabling continuity for tasks that require authentication or personalized settings.

io_proxyconfiguration TYPE REF TO /AWS1/CL_BDCPROXYCONFIGURATION /AWS1/CL_BDCPROXYCONFIGURATION

Optional proxy configuration for routing browser traffic through customer-specified proxy servers. When provided, enables HTTP Basic authentication via Amazon Web Services Secrets Manager and domain-based routing rules. Requires secretsmanager:GetSecretValue IAM permission for the specified secret ARNs.

it_enterprisepolicies TYPE /AWS1/CL_BDCBROWSERENTRPPOLICY=>TT_BROWSERENTERPRISEPOLICIES TT_BROWSERENTERPRISEPOLICIES

A list of files containing enterprise policies for the browser.

it_certificates TYPE /AWS1/CL_BDCCERTIFICATE=>TT_CERTIFICATES TT_CERTIFICATES

A list of certificates to install in the browser 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_bdcstartbrowssessrsp /AWS1/CL_BDCSTARTBROWSSESSRSP

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->startbrowsersession(
  io_profileconfiguration = new /aws1/cl_bdcbrowserprofileconf( |string| )
  io_proxyconfiguration = new /aws1/cl_bdcproxyconfiguration(
    io_bypass = new /aws1/cl_bdcproxybypass(
      it_domainpatterns = VALUE /aws1/cl_bdcdomainpatterns_w=>tt_domainpatterns(
        ( new /aws1/cl_bdcdomainpatterns_w( |string| ) )
      )
    )
    it_proxies = VALUE /aws1/cl_bdcproxy=>tt_proxies(
      (
        new /aws1/cl_bdcproxy(
          io_externalproxy = new /aws1/cl_bdcexternalproxy(
            io_credentials = new /aws1/cl_bdcproxycredentials( new /aws1/cl_bdcbasicauth( |string| ) )
            it_domainpatterns = VALUE /aws1/cl_bdcdomainpatterns_w=>tt_domainpatterns(
              ( new /aws1/cl_bdcdomainpatterns_w( |string| ) )
            )
            iv_port = 123
            iv_server = |string|
          )
        )
      )
    )
  )
  io_viewport = new /aws1/cl_bdcviewport(
    iv_height = 123
    iv_width = 123
  )
  it_certificates = VALUE /aws1/cl_bdccertificate=>tt_certificates(
    ( new /aws1/cl_bdccertificate( new /aws1/cl_bdccertlocation( new /aws1/cl_bdcsecretsmanagerloc( |string| ) ) ) )
  )
  it_enterprisepolicies = VALUE /aws1/cl_bdcbrowserentrppolicy=>tt_browserenterprisepolicies(
    (
      new /aws1/cl_bdcbrowserentrppolicy(
        io_location = new /aws1/cl_bdcresourcelocation(
          io_s3 = new /aws1/cl_bdcs3location(
            iv_bucket = |string|
            iv_prefix = |string|
            iv_versionid = |string|
          )
        )
        iv_type = |string|
      )
    )
  )
  it_extensions = VALUE /aws1/cl_bdcbrowserextension=>tt_browserextensions(
    (
      new /aws1/cl_bdcbrowserextension(
        io_location = new /aws1/cl_bdcresourcelocation(
          io_s3 = new /aws1/cl_bdcs3location(
            iv_bucket = |string|
            iv_prefix = |string|
            iv_versionid = |string|
          )
        )
      )
    )
  )
  iv_browseridentifier = |string|
  iv_clienttoken = |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_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.