Skip to content

/AWS1/IF_NWS=>LISTSCOPESNAPSHOTS()

About ListScopeSnapshots

Lists the snapshots of the specified scope.

Method Signature

METHODS /AWS1/IF_NWS~LISTSCOPESNAPSHOTS
  IMPORTING
    !IV_SCOPEIDENTIFIER TYPE /AWS1/NWSSCOPEIDENTIFIER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/NWSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/NWSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwslistscpsnapsoutput
  RAISING
    /AWS1/CX_NWSACCESSDENIEDEX
    /AWS1/CX_NWSINTERNALSERVEREX
    /AWS1/CX_NWSRESOURCENOTFOUNDEX
    /AWS1/CX_NWSTHROTTLINGEX
    /AWS1/CX_NWSVLDTNEXCEPTION
    /AWS1/CX_NWSCLIENTEXC
    /AWS1/CX_NWSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_scopeidentifier TYPE /AWS1/NWSSCOPEIDENTIFIER /AWS1/NWSSCOPEIDENTIFIER

The identifier of the scope. This is the scope's Amazon Resource Name (ARN).

Optional arguments:

iv_maxresults TYPE /AWS1/NWSMAXRESULTS /AWS1/NWSMAXRESULTS

The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.

iv_nexttoken TYPE /AWS1/NWSNEXTTOKEN /AWS1/NWSNEXTTOKEN

The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.

RETURNING

oo_output TYPE REF TO /aws1/cl_nwslistscpsnapsoutput /AWS1/CL_NWSLISTSCPSNAPSOUTPUT

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->listscopesnapshots(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_scopeidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_snapshots( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_scopeid = lo_row_1->get_scopeid( ).
      lv_scopearn = lo_row_1->get_scopearn( ).
      lv_scopename = lo_row_1->get_scopename( ).
      lv_entitystatus = lo_row_1->get_status( ).
      lv_entityversion = lo_row_1->get_version( ).
      lv_haspublishedversion = lo_row_1->get_haspublishedversion( ).
      lv_datetimestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
ENDIF.

List the snapshots of a scope

Lists the immutable snapshots that have been created for a scope.

DATA(lo_result) = lo_client->listscopesnapshots(
  iv_maxresults = 10
  iv_scopeidentifier = |arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123|
).