Skip to content

/AWS1/IF_PTS=>LSTENGAGEMENTRESRCASSOCIAT00()

About ListEngagementResourceAssociations

Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.

Method Signature

METHODS /AWS1/IF_PTS~LSTENGAGEMENTRESRCASSOCIAT00
  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_RESOURCETYPE TYPE /AWS1/PTSRESOURCETYPE OPTIONAL
    !IV_RESOURCEIDENTIFIER TYPE /AWS1/PTSRESOURCEIDENTIFIER OPTIONAL
    !IV_CREATEDBY TYPE /AWS1/PTSAWSACCOUNT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptslstengagementres01
  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 in which to search for engagement-resource associations. Valid Values: "AWS" or "Sandbox"

  • AWS for production environments.

  • Sandbox for testing and development purposes.

Optional arguments:

iv_maxresults TYPE /AWS1/PTSPAGESIZE /AWS1/PTSPAGESIZE

Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.

iv_nexttoken TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING

A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.

iv_engagementidentifier TYPE /AWS1/PTSENGAGEMENTIDENTIFIER /AWS1/PTSENGAGEMENTIDENTIFIER

Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.

iv_resourcetype TYPE /AWS1/PTSRESOURCETYPE /AWS1/PTSRESOURCETYPE

Filters the results to include only associations with resources of the specified type.

iv_resourceidentifier TYPE /AWS1/PTSRESOURCEIDENTIFIER /AWS1/PTSRESOURCEIDENTIFIER

Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.

iv_createdby TYPE /AWS1/PTSAWSACCOUNT /AWS1/PTSAWSACCOUNT

Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptslstengagementres01 /AWS1/CL_PTSLSTENGAGEMENTRES01

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->lstengagementresrcassociat00(
  iv_catalog = |string|
  iv_createdby = |string|
  iv_engagementidentifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_resourceidentifier = |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_engagementresrcassocia00( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_catalogidentifier = lo_row_1->get_catalog( ).
      lv_engagementidentifier = lo_row_1->get_engagementid( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_resourceidentifier = lo_row_1->get_resourceid( ).
      lv_awsaccount = lo_row_1->get_createdby( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.