STOPRUNTIMESESSION()`¶

About StopRuntimeSession¶

Stops a session that is running in an running AgentCore Runtime agent.

Method Signature¶

METHODS /AWS1/IF_BDC~STOPRUNTIMESESSION
  IMPORTING
    !IV_RUNTIMESESSIONID TYPE /AWS1/BDCSESSIONTYPE OPTIONAL
    !IV_AGENTRUNTIMEARN TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_QUALIFIER TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/BDCCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdcstopruntimesessrsp
  RAISING
    /AWS1/CX_BDCACCESSDENIEDEX
    /AWS1/CX_BDCCONFLICTEXCEPTION
    /AWS1/CX_BDCINTERNALSERVEREX
    /AWS1/CX_BDCRESOURCENOTFOUNDEX
    /AWS1/CX_BDCRUNTIMECLIENTERROR
    /AWS1/CX_BDCSERVICEQUOTAEXCDEX
    /AWS1/CX_BDCTHROTTLINGEX
    /AWS1/CX_BDCUNAUTHORIZEDEX
    /AWS1/CX_BDCVALIDATIONEX
    /AWS1/CX_BDCCLIENTEXC
    /AWS1/CX_BDCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_runtimesessionid` `TYPE /AWS1/BDCSESSIONTYPE` `/AWS1/BDCSESSIONTYPE`¶

The ID of the session that you want to stop.

`iv_agentruntimearn` `TYPE /AWS1/BDCSTRING` `/AWS1/BDCSTRING`¶

The ARN of the agent that contains the session that you want to stop.

Optional arguments:¶

`iv_qualifier` `TYPE /AWS1/BDCSTRING` `/AWS1/BDCSTRING`¶

Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.

`iv_clienttoken` `TYPE /AWS1/BDCCLIENTTOKEN` `/AWS1/BDCCLIENTTOKEN`¶

Idempotent token used to identify the request. If you use the same token with multiple requests, the same response is returned. Use ClientToken to prevent the same request from being processed more than once.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdcstopruntimesessrsp` `/AWS1/CL_BDCSTOPRUNTIMESESSRSP`¶

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->stopruntimesession(
  iv_agentruntimearn = |string|
  iv_clienttoken = |string|
  iv_qualifier = |string|
  iv_runtimesessionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_sessionid = lo_result->get_runtimesessionid( ).
  lv_httpresponsecode = lo_result->get_statuscode( ).
ENDIF.

/AWS1/IF_BDC=>STOPRUNTIMESESSION()¶