Skip to content

/AWS1/IF_SGN=>LISTSIGNINGPLATFORMS()

About ListSigningPlatforms

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Method Signature

METHODS /AWS1/IF_SGN~LISTSIGNINGPLATFORMS
  IMPORTING
    !IV_CATEGORY TYPE /AWS1/SGNSTRING OPTIONAL
    !IV_PARTNER TYPE /AWS1/SGNSTRING OPTIONAL
    !IV_TARGET TYPE /AWS1/SGNSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGNSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgnlstsigningplatfo01
  RAISING
    /AWS1/CX_SGNACCESSDENIEDEX
    /AWS1/CX_SGNINTERNALSVCERROREX
    /AWS1/CX_SGNTOOMANYREQUESTSEX
    /AWS1/CX_SGNVALIDATIONEX
    /AWS1/CX_SGNCLIENTEXC
    /AWS1/CX_SGNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_category TYPE /AWS1/SGNSTRING /AWS1/SGNSTRING

The category type of a signing platform.

iv_partner TYPE /AWS1/SGNSTRING /AWS1/SGNSTRING

Any partner entities connected to a signing platform.

iv_target TYPE /AWS1/SGNSTRING /AWS1/SGNSTRING

The validation template that is used by the target signing platform.

iv_maxresults TYPE /AWS1/SGNMAXRESULTS /AWS1/SGNMAXRESULTS

The maximum number of results to be returned by this operation.

iv_nexttoken TYPE /AWS1/SGNSTRING /AWS1/SGNSTRING

Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgnlstsigningplatfo01 /AWS1/CL_SGNLSTSIGNINGPLATFO01

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->listsigningplatforms(
  iv_category = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_partner = |string|
  iv_target = |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_platforms( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_platformid( ).
      lv_string = lo_row_1->get_displayname( ).
      lv_string = lo_row_1->get_partner( ).
      lv_string = lo_row_1->get_target( ).
      lv_category = lo_row_1->get_category( ).
      lo_signingconfiguration = lo_row_1->get_signingconfiguration( ).
      IF lo_signingconfiguration IS NOT INITIAL.
        lo_encryptionalgorithmopti = lo_signingconfiguration->get_encalgorithmoptions( ).
        IF lo_encryptionalgorithmopti IS NOT INITIAL.
          LOOP AT lo_encryptionalgorithmopti->get_allowedvalues( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_encryptionalgorithm = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_encryptionalgorithm = lo_encryptionalgorithmopti->get_defaultvalue( ).
        ENDIF.
        lo_hashalgorithmoptions = lo_signingconfiguration->get_hashalgorithmoptions( ).
        IF lo_hashalgorithmoptions IS NOT INITIAL.
          LOOP AT lo_hashalgorithmoptions->get_allowedvalues( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_hashalgorithm = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_hashalgorithm = lo_hashalgorithmoptions->get_defaultvalue( ).
        ENDIF.
      ENDIF.
      lo_signingimageformat = lo_row_1->get_signingimageformat( ).
      IF lo_signingimageformat IS NOT INITIAL.
        LOOP AT lo_signingimageformat->get_supportedformats( ) into lo_row_6.
          lo_row_7 = lo_row_6.
          IF lo_row_7 IS NOT INITIAL.
            lv_imageformat = lo_row_7->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_imageformat = lo_signingimageformat->get_defaultformat( ).
      ENDIF.
      lv_maxsizeinmb = lo_row_1->get_maxsizeinmb( ).
      lv_bool = lo_row_1->get_revocationsupported( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.