LISTARCHIVES()`¶

About ListArchives¶

Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.

Method Signature¶

METHODS /AWS1/IF_CWE~LISTARCHIVES
  IMPORTING
    !IV_NAMEPREFIX TYPE /AWS1/CWEARCHIVENAME OPTIONAL
    !IV_EVENTSOURCEARN TYPE /AWS1/CWEARN OPTIONAL
    !IV_STATE TYPE /AWS1/CWEARCHIVESTATE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CWENEXTTOKEN OPTIONAL
    !IV_LIMIT TYPE /AWS1/CWELIMITMAX100 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwelistarchivesrsp
  RAISING
    /AWS1/CX_CWEINTERNALEXCEPTION
    /AWS1/CX_CWERESOURCENOTFOUNDEX
    /AWS1/CX_CWECLIENTEXC
    /AWS1/CX_CWESERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nameprefix` `TYPE /AWS1/CWEARCHIVENAME` `/AWS1/CWEARCHIVENAME`¶

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

`iv_eventsourcearn` `TYPE /AWS1/CWEARN` `/AWS1/CWEARN`¶

The ARN of the event source associated with the archive.

`iv_state` `TYPE /AWS1/CWEARCHIVESTATE` `/AWS1/CWEARCHIVESTATE`¶

The state of the archive.

`iv_nexttoken` `TYPE /AWS1/CWENEXTTOKEN` `/AWS1/CWENEXTTOKEN`¶

The token returned by a previous call to retrieve the next set of results.

`iv_limit` `TYPE /AWS1/CWELIMITMAX100` `/AWS1/CWELIMITMAX100`¶

The maximum number of results to return.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cwelistarchivesrsp` `/AWS1/CL_CWELISTARCHIVESRSP`¶

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->listarchives(
  iv_eventsourcearn = |string|
  iv_limit = 123
  iv_nameprefix = |string|
  iv_nexttoken = |string|
  iv_state = |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_archives( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_archivename = lo_row_1->get_archivename( ).
      lv_arn = lo_row_1->get_eventsourcearn( ).
      lv_archivestate = lo_row_1->get_state( ).
      lv_archivestatereason = lo_row_1->get_statereason( ).
      lv_retentiondays = lo_row_1->get_retentiondays( ).
      lv_long = lo_row_1->get_sizebytes( ).
      lv_long = lo_row_1->get_eventcount( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CWE=>LISTARCHIVES()¶