Skip to content

/AWS1/IF_BDZ=>ENDSESSION00()

About EndSession

Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Method Signature

METHODS /AWS1/IF_BDZ~ENDSESSION00
  IMPORTING
    !IV_SESSIONIDENTIFIER TYPE /AWS1/BDZSESSIONIDENTIFIER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdzendsessionresponse
  RAISING
    /AWS1/CX_BDZACCESSDENIEDEX
    /AWS1/CX_BDZCONFLICTEXCEPTION
    /AWS1/CX_BDZINTERNALSERVEREX
    /AWS1/CX_BDZRESOURCENOTFOUNDEX
    /AWS1/CX_BDZTHROTTLINGEX
    /AWS1/CX_BDZVALIDATIONEX
    /AWS1/CX_BDZCLIENTEXC
    /AWS1/CX_BDZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_sessionidentifier TYPE /AWS1/BDZSESSIONIDENTIFIER /AWS1/BDZSESSIONIDENTIFIER

The unique identifier for the session to end. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

RETURNING

oo_output TYPE REF TO /aws1/cl_bdzendsessionresponse /AWS1/CL_BDZENDSESSIONRESPONSE

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->endsession00( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_uuid = lo_result->get_sessionid( ).
  lv_sessionarn = lo_result->get_sessionarn( ).
  lv_sessionstatus = lo_result->get_sessionstatus( ).
ENDIF.