Skip to content

/AWS1/IF_PTS=>LISTRESOURCESNAPSHOTJOBS()

About ListResourceSnapshotJobs

Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters.

Method Signature

METHODS /AWS1/IF_PTS~LISTRESOURCESNAPSHOTJOBS
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTSCATALOGIDENTIFIER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PTSPAGESIZE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PTSSTRING OPTIONAL
    !IV_ENGAGEMENTIDENTIFIER TYPE /AWS1/PTSENGAGEMENTIDENTIFIER OPTIONAL
    !IV_STATUS TYPE /AWS1/PTSRESOURCESNAPJOBSTATUS OPTIONAL
    !IO_SORT TYPE REF TO /AWS1/CL_PTSSORTOBJECT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptslstresrcsnapjobs01
  RAISING
    /AWS1/CX_PTSACCESSDENIEDEX
    /AWS1/CX_PTSINTERNALSERVEREX
    /AWS1/CX_PTSRESOURCENOTFOUNDEX
    /AWS1/CX_PTSTHROTTLINGEX
    /AWS1/CX_PTSVALIDATIONEX
    /AWS1/CX_PTSCLIENTEXC
    /AWS1/CX_PTSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/PTSCATALOGIDENTIFIER /AWS1/PTSCATALOGIDENTIFIER

Specifies the catalog related to the request.

Optional arguments:

iv_maxresults TYPE /AWS1/PTSPAGESIZE /AWS1/PTSPAGESIZE

The maximum number of results to return in a single call. If omitted, defaults to 50.

iv_nexttoken TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING

The token for the next set of results.

iv_engagementidentifier TYPE /AWS1/PTSENGAGEMENTIDENTIFIER /AWS1/PTSENGAGEMENTIDENTIFIER

The identifier of the engagement to filter the response.

iv_status TYPE /AWS1/PTSRESOURCESNAPJOBSTATUS /AWS1/PTSRESOURCESNAPJOBSTATUS

The status of the jobs to filter the response.

io_sort TYPE REF TO /AWS1/CL_PTSSORTOBJECT /AWS1/CL_PTSSORTOBJECT

Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptslstresrcsnapjobs01 /AWS1/CL_PTSLSTRESRCSNAPJOBS01

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->listresourcesnapshotjobs(
  io_sort = new /aws1/cl_ptssortobject(
    iv_sortby = |string|
    iv_sortorder = |string|
  )
  iv_catalog = |string|
  iv_engagementidentifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_status = |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_resourcesnapshotjobsums( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourcesnapshotjobiden = lo_row_1->get_id( ).
      lv_resourcesnapshotjobarn = lo_row_1->get_arn( ).
      lv_engagementidentifier = lo_row_1->get_engagementid( ).
      lv_resourcesnapshotjobstat = lo_row_1->get_status( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.