LISTSESSIONS()`¶

About ListSessions¶

Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

Empty sessions are automatically deleted after one day.

To use this operation, you must have the bedrock-agentcore:ListSessions permission.

Method Signature¶

METHODS /AWS1/IF_BDC~LISTSESSIONS
  IMPORTING
    !IV_MEMORYID TYPE /AWS1/BDCMEMORYID OPTIONAL
    !IV_ACTORID TYPE /AWS1/BDCACTORID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDCMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDCPAGINATIONTOKEN OPTIONAL
    !IO_FILTER TYPE REF TO /AWS1/CL_BDCSESSIONFILTER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdclistsessionsoutput
  RAISING
    /AWS1/CX_BDCACCESSDENIEDEX
    /AWS1/CX_BDCINVALIDINPUTEX
    /AWS1/CX_BDCRESOURCENOTFOUNDEX
    /AWS1/CX_BDCSERVICEEXCEPTION
    /AWS1/CX_BDCSERVICEQUOTAEXCDEX
    /AWS1/CX_BDCTHROTTLEDEXCEPTION
    /AWS1/CX_BDCVALIDATIONEX
    /AWS1/CX_BDCCLIENTEXC
    /AWS1/CX_BDCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_memoryid` `TYPE /AWS1/BDCMEMORYID` `/AWS1/BDCMEMORYID`¶

The identifier of the AgentCore Memory resource for which to list sessions.

`iv_actorid` `TYPE /AWS1/BDCACTORID` `/AWS1/BDCACTORID`¶

The identifier of the actor for which to list sessions.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/BDCMAXRESULTS` `/AWS1/BDCMAXRESULTS`¶

The maximum number of results to return in a single call. The default value is 20.

`iv_nexttoken` `TYPE /AWS1/BDCPAGINATIONTOKEN` `/AWS1/BDCPAGINATIONTOKEN`¶

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

`io_filter` `TYPE REF TO /AWS1/CL_BDCSESSIONFILTER` `/AWS1/CL_BDCSESSIONFILTER`¶

Filter criteria to apply when listing sessions.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdclistsessionsoutput` `/AWS1/CL_BDCLISTSESSIONSOUTPUT`¶

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->listsessions(
  io_filter = new /aws1/cl_bdcsessionfilter( |string| )
  iv_actorid = |string|
  iv_maxresults = 123
  iv_memoryid = |string|
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_sessionsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_sessionid = lo_row_1->get_sessionid( ).
      lv_actorid = lo_row_1->get_actorid( ).
      lv_timestamp = lo_row_1->get_createdat( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BDC=>LISTSESSIONS()¶