DESCRSERVERLESSCACHESNAPS()`¶

About DescribeServerlessCacheSnapshots¶

Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

Method Signature¶

METHODS /AWS1/IF_ECA~DESCRSERVERLESSCACHESNAPS
  IMPORTING
    !IV_SERVERLESSCACHENAME TYPE /AWS1/ECASTRING OPTIONAL
    !IV_SERVERLESSCACHESNAPNAME TYPE /AWS1/ECASTRING OPTIONAL
    !IV_SNAPSHOTTYPE TYPE /AWS1/ECASTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECASTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECAINTEGEROPTIONAL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecadscserverlesscac03
  RAISING
    /AWS1/CX_ECAINVPRMCOMBINATIO00
    /AWS1/CX_ECAINVPARAMVALUEEX
    /AWS1/CX_ECASERVERLESSCACHEN00
    /AWS1/CX_ECASERVERLESSCACHES00
    /AWS1/CX_ECACLIENTEXC
    /AWS1/CX_ECASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_serverlesscachename` `TYPE /AWS1/ECASTRING` `/AWS1/ECASTRING`¶

The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.

`iv_serverlesscachesnapname` `TYPE /AWS1/ECASTRING` `/AWS1/ECASTRING`¶

The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.

`iv_snapshottype` `TYPE /AWS1/ECASTRING` `/AWS1/ECASTRING`¶

The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.

`iv_nexttoken` `TYPE /AWS1/ECASTRING` `/AWS1/ECASTRING`¶

An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

`iv_maxresults` `TYPE /AWS1/ECAINTEGEROPTIONAL` `/AWS1/ECAINTEGEROPTIONAL`¶

The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ecadscserverlesscac03` `/AWS1/CL_ECADSCSERVERLESSCAC03`¶

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->descrserverlesscachesnaps(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_serverlesscachename = |string|
  iv_serverlesscachesnapname = |string|
  iv_snapshottype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_serverlesscachesnapshots( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_serverlesscachesnapname( ).
      lv_string = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_kmskeyid( ).
      lv_string = lo_row_1->get_snapshottype( ).
      lv_string = lo_row_1->get_status( ).
      lv_tstamp = lo_row_1->get_createtime( ).
      lv_tstamp = lo_row_1->get_expirytime( ).
      lv_string = lo_row_1->get_bytesusedforcache( ).
      lo_serverlesscacheconfigur = lo_row_1->get_serverlesscacheconf( ).
      IF lo_serverlesscacheconfigur IS NOT INITIAL.
        lv_string = lo_serverlesscacheconfigur->get_serverlesscachename( ).
        lv_string = lo_serverlesscacheconfigur->get_engine( ).
        lv_string = lo_serverlesscacheconfigur->get_majorengineversion( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_ECA=>DESCRSERVERLESSCACHESNAPS()¶