Skip to content

/AWS1/IF_BDC=>DELETECAPACITYPVDRSESSION()

About DeleteCapacityProviderSession

Deletes a session associated with a capacity provider in Amazon Bedrock AgentCore and makes the session unavailable for further use. To delete a capacity provider session, specify both the capacity provider identifier and the session ID. After you delete a session, you cannot restart it.

Method Signature

METHODS /AWS1/IF_BDC~DELETECAPACITYPVDRSESSION
  IMPORTING
    !IV_CAPACITYPROVIDERID TYPE /AWS1/BDCCAPACITYPROVIDERID OPTIONAL
    !IV_SESSIONID TYPE /AWS1/BDCSESSIONID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdcdelcappvdrsessrsp
  RAISING
    /AWS1/CX_BDCACCESSDENIEDEX
    /AWS1/CX_BDCINTERNALSERVEREX
    /AWS1/CX_BDCRESOURCENOTFOUNDEX
    /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_capacityproviderid TYPE /AWS1/BDCCAPACITYPROVIDERID /AWS1/BDCCAPACITYPROVIDERID

The unique identifier of the capacity provider associated with the session.

iv_sessionid TYPE /AWS1/BDCSESSIONID /AWS1/BDCSESSIONID

The unique identifier of the capacity provider session to delete.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdcdelcappvdrsessrsp /AWS1/CL_BDCDELCAPPVDRSESSRSP

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->deletecapacitypvdrsession(
  iv_capacityproviderid = |string|
  iv_sessionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_capacityproviderarn = lo_result->get_capacityproviderarn( ).
  lv_sessionid = lo_result->get_sessionid( ).
  lv_capacityprovidersession = lo_result->get_status( ).
ENDIF.