Skip to content

/AWS1/CL_PTS=>LISTRESOURCESNAPSHOTS()

About ListResourceSnapshots

Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including:

  • Fetching all snapshots associated with an engagement.

  • Retrieving snapshots of a specific resource type within an engagement.

  • Obtaining snapshots for a particular resource using a specified template.

  • Accessing the latest snapshot of a resource within an engagement.

  • Filtering snapshots by resource owner.

Method Signature

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/PTSCATALOGIDENTIFIER /AWS1/PTSCATALOGIDENTIFIER

Specifies the catalog related to the request.

iv_engagementidentifier TYPE /AWS1/PTSENGAGEMENTIDENTIFIER /AWS1/PTSENGAGEMENTIDENTIFIER

The unique identifier of the engagement associated with the snapshots.

Optional arguments:

iv_maxresults TYPE /AWS1/PTSPAGESIZE /AWS1/PTSPAGESIZE

The maximum number of results to return in a single call.

iv_nexttoken TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING

The token for the next set of results.

iv_resourcetype TYPE /AWS1/PTSRESOURCETYPE /AWS1/PTSRESOURCETYPE

Filters the response to include only snapshots of the specified resource type.

iv_resourceidentifier TYPE /AWS1/PTSRESOURCEIDENTIFIER /AWS1/PTSRESOURCEIDENTIFIER

Filters the response to include only snapshots of the specified resource.

iv_resourcesnaptemplateid TYPE /AWS1/PTSRESOURCETEMPLATENAME /AWS1/PTSRESOURCETEMPLATENAME

Filters the response to include only snapshots created using the specified template.

iv_createdby TYPE /AWS1/PTSAWSACCOUNT /AWS1/PTSAWSACCOUNT

Filters the response to include only snapshots of resources owned by the specified AWS account.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptslistresrcsnapsrsp /AWS1/CL_PTSLISTRESRCSNAPSRSP

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->/aws1/if_pts~listresourcesnapshots(
  iv_catalog = |string|
  iv_createdby = |string|
  iv_engagementidentifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_resourceidentifier = |string|
  iv_resourcesnaptemplateid = |string|
  iv_resourcetype = |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_resourcesnapshotsums( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourcesnapshotarn = lo_row_1->get_arn( ).
      lv_resourcesnapshotrevisio = lo_row_1->get_revision( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_resourceidentifier = lo_row_1->get_resourceid( ).
      lv_resourcetemplatename = lo_row_1->get_resourcesnaptemplatename( ).
      lv_awsaccount = lo_row_1->get_createdby( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.