Skip to content

/AWS1/IF_DZN=>LISTSUBSCRIPTIONS()

About ListSubscriptions

Lists subscriptions in Amazon DataZone.

Method Signature

METHODS /AWS1/IF_DZN~LISTSUBSCRIPTIONS
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_SUBSCRIPTIONREQUESTID00 TYPE /AWS1/DZNSUBSCRIPTIONREQUESTID OPTIONAL
    !IV_STATUS TYPE /AWS1/DZNSUBSCRIPTIONSTATUS OPTIONAL
    !IV_SUBSCRIBEDLISTINGID TYPE /AWS1/DZNLISTINGID OPTIONAL
    !IV_OWNINGPROJECTID TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_OWNINGUSERID TYPE /AWS1/DZNUSERPROFILEID OPTIONAL
    !IV_OWNINGGROUPID TYPE /AWS1/DZNGROUPPROFILEID OPTIONAL
    !IV_APPROVERPROJECTID TYPE /AWS1/DZNPROJECTID OPTIONAL
    !IV_SORTBY TYPE /AWS1/DZNSORTKEY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/DZNSORTORDER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznlstsubscriptions01
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNRESOURCENOTFOUNDEX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The identifier of the Amazon DataZone domain.

Optional arguments:

iv_subscriptionrequestid00 TYPE /AWS1/DZNSUBSCRIPTIONREQUESTID /AWS1/DZNSUBSCRIPTIONREQUESTID

The identifier of the subscription request for the subscriptions that you want to list.

iv_status TYPE /AWS1/DZNSUBSCRIPTIONSTATUS /AWS1/DZNSUBSCRIPTIONSTATUS

The status of the subscriptions that you want to list.

This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

iv_subscribedlistingid TYPE /AWS1/DZNLISTINGID /AWS1/DZNLISTINGID

The identifier of the subscribed listing for the subscriptions that you want to list.

iv_owningprojectid TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

The identifier of the owning project.

iv_owninguserid TYPE /AWS1/DZNUSERPROFILEID /AWS1/DZNUSERPROFILEID

The ID of the owning user.

iv_owninggroupid TYPE /AWS1/DZNGROUPPROFILEID /AWS1/DZNGROUPPROFILEID

The ID of the owning group.

iv_approverprojectid TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

The identifier of the project for the subscription's approver.

iv_sortby TYPE /AWS1/DZNSORTKEY /AWS1/DZNSORTKEY

Specifies the way in which the results of this action are to be sorted.

iv_sortorder TYPE /AWS1/DZNSORTORDER /AWS1/DZNSORTORDER

Specifies the sort order for the results of this action.

iv_maxresults TYPE /AWS1/DZNMAXRESULTS /AWS1/DZNMAXRESULTS

The maximum number of subscriptions to return in a single call to ListSubscriptions. When the number of subscriptions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptions to list the next set of Subscriptions.

iv_nexttoken TYPE /AWS1/DZNPAGINATIONTOKEN /AWS1/DZNPAGINATIONTOKEN

When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

RETURNING

oo_output TYPE REF TO /aws1/cl_dznlstsubscriptions01 /AWS1/CL_DZNLSTSUBSCRIPTIONS01

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->listsubscriptions(
  iv_approverprojectid = |string|
  iv_domainidentifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_owninggroupid = |string|
  iv_owningprojectid = |string|
  iv_owninguserid = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_status = |string|
  iv_subscribedlistingid = |string|
  iv_subscriptionrequestid00 = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_subscriptionid = lo_row_1->get_id( ).
      lv_createdby = lo_row_1->get_createdby( ).
      lv_updatedby = lo_row_1->get_updatedby( ).
      lv_domainid = lo_row_1->get_domainid( ).
      lv_subscriptionstatus = lo_row_1->get_status( ).
      lv_createdat = lo_row_1->get_createdat( ).
      lv_updatedat = lo_row_1->get_updatedat( ).
      lo_subscribedprincipal = lo_row_1->get_subscribedprincipal( ).
      IF lo_subscribedprincipal IS NOT INITIAL.
        lo_subscribedproject = lo_subscribedprincipal->get_project( ).
        IF lo_subscribedproject IS NOT INITIAL.
          lv_projectid = lo_subscribedproject->get_id( ).
          lv_projectname = lo_subscribedproject->get_name( ).
        ENDIF.
        lo_subscribeduser = lo_subscribedprincipal->get_user( ).
        IF lo_subscribeduser IS NOT INITIAL.
          lv_userprofileid = lo_subscribeduser->get_id( ).
          lo_userprofiledetails = lo_subscribeduser->get_details( ).
          IF lo_userprofiledetails IS NOT INITIAL.
            lo_iamuserprofiledetails = lo_userprofiledetails->get_iam( ).
            IF lo_iamuserprofiledetails IS NOT INITIAL.
              lv_string = lo_iamuserprofiledetails->get_arn( ).
              lv_string = lo_iamuserprofiledetails->get_principalid( ).
            ENDIF.
            lo_ssouserprofiledetails = lo_userprofiledetails->get_sso( ).
            IF lo_ssouserprofiledetails IS NOT INITIAL.
              lv_userprofilename = lo_ssouserprofiledetails->get_username( ).
              lv_firstname = lo_ssouserprofiledetails->get_firstname( ).
              lv_lastname = lo_ssouserprofiledetails->get_lastname( ).
            ENDIF.
          ENDIF.
        ENDIF.
        lo_subscribedgroup = lo_subscribedprincipal->get_group( ).
        IF lo_subscribedgroup IS NOT INITIAL.
          lv_groupprofileid = lo_subscribedgroup->get_id( ).
          lv_groupprofilename = lo_subscribedgroup->get_name( ).
        ENDIF.
      ENDIF.
      lo_subscribedlisting = lo_row_1->get_subscribedlisting( ).
      IF lo_subscribedlisting IS NOT INITIAL.
        lv_listingid = lo_subscribedlisting->get_id( ).
        lv_revision = lo_subscribedlisting->get_revision( ).
        lv_listingname = lo_subscribedlisting->get_name( ).
        lv_description = lo_subscribedlisting->get_description( ).
        lo_subscribedlistingitem = lo_subscribedlisting->get_item( ).
        IF lo_subscribedlistingitem IS NOT INITIAL.
          lo_subscribedassetlisting = lo_subscribedlistingitem->get_assetlisting( ).
          IF lo_subscribedassetlisting IS NOT INITIAL.
            lv_assetid = lo_subscribedassetlisting->get_entityid( ).
            lv_revision = lo_subscribedassetlisting->get_entityrevision( ).
            lv_typename = lo_subscribedassetlisting->get_entitytype( ).
            lv_forms = lo_subscribedassetlisting->get_forms( ).
            LOOP AT lo_subscribedassetlisting->get_glossaryterms( ) into lo_row_2.
              lo_row_3 = lo_row_2.
              IF lo_row_3 IS NOT INITIAL.
                lv_glossarytermname = lo_row_3->get_name( ).
                lv_shortdescription = lo_row_3->get_shortdescription( ).
              ENDIF.
            ENDLOOP.
            lo_assetscope = lo_subscribedassetlisting->get_assetscope( ).
            IF lo_assetscope IS NOT INITIAL.
              lv_assetid = lo_assetscope->get_assetid( ).
              LOOP AT lo_assetscope->get_filterids( ) into lo_row_4.
                lo_row_5 = lo_row_4.
                IF lo_row_5 IS NOT INITIAL.
                  lv_filterid = lo_row_5->get_value( ).
                ENDIF.
              ENDLOOP.
              lv_string = lo_assetscope->get_status( ).
              lv_string = lo_assetscope->get_errormessage( ).
            ENDIF.
            lo_permissions = lo_subscribedassetlisting->get_permissions( ).
            IF lo_permissions IS NOT INITIAL.
              LOOP AT lo_permissions->get_s3( ) into lo_row_6.
                lo_row_7 = lo_row_6.
                IF lo_row_7 IS NOT INITIAL.
                  lv_s3permission = lo_row_7->get_value( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
          ENDIF.
          lo_subscribedproductlistin = lo_subscribedlistingitem->get_productlisting( ).
          IF lo_subscribedproductlistin IS NOT INITIAL.
            lv_assetid = lo_subscribedproductlistin->get_entityid( ).
            lv_revision = lo_subscribedproductlistin->get_entityrevision( ).
            LOOP AT lo_subscribedproductlistin->get_glossaryterms( ) into lo_row_2.
              lo_row_3 = lo_row_2.
              IF lo_row_3 IS NOT INITIAL.
                lv_glossarytermname = lo_row_3->get_name( ).
                lv_shortdescription = lo_row_3->get_shortdescription( ).
              ENDIF.
            ENDLOOP.
            lv_string = lo_subscribedproductlistin->get_name( ).
            lv_string = lo_subscribedproductlistin->get_description( ).
            LOOP AT lo_subscribedproductlistin->get_assetlistings( ) into lo_row_8.
              lo_row_9 = lo_row_8.
              IF lo_row_9 IS NOT INITIAL.
                lv_string = lo_row_9->get_entityid( ).
                lv_string = lo_row_9->get_entityrevision( ).
                lv_string = lo_row_9->get_entitytype( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDIF.
        lv_projectid = lo_subscribedlisting->get_ownerprojectid( ).
        lv_string = lo_subscribedlisting->get_ownerprojectname( ).
      ENDIF.
      lv_subscriptionrequestid = lo_row_1->get_subscriptionrequestid( ).
      lv_boolean = lo_row_1->get_retainpermissions( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.