LISTSIGNINGPROFILES()`¶

About ListSigningProfiles¶

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS 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~LISTSIGNINGPROFILES
  IMPORTING
    !IV_INCLUDECANCELED TYPE /AWS1/SGNBOOL OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGNNEXTTOKEN OPTIONAL
    !IV_PLATFORMID TYPE /AWS1/SGNPLATFORMID OPTIONAL
    !IT_STATUSES TYPE /AWS1/CL_SGNSTATUSES_W=>TT_STATUSES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgnlistsigningpflsrsp
  RAISING
    /AWS1/CX_SGNACCESSDENIEDEX
    /AWS1/CX_SGNINTERNALSVCERROREX
    /AWS1/CX_SGNTOOMANYREQUESTSEX
    /AWS1/CX_SGNCLIENTEXC
    /AWS1/CX_SGNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_includecanceled` `TYPE /AWS1/SGNBOOL` `/AWS1/SGNBOOL`¶

Designates whether to include profiles with the status of CANCELED.

`iv_maxresults` `TYPE /AWS1/SGNMAXRESULTS` `/AWS1/SGNMAXRESULTS`¶

The maximum number of profiles to be returned.

`iv_nexttoken` `TYPE /AWS1/SGNNEXTTOKEN` `/AWS1/SGNNEXTTOKEN`¶

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.

`iv_platformid` `TYPE /AWS1/SGNPLATFORMID` `/AWS1/SGNPLATFORMID`¶

Filters results to return only signing jobs initiated for a specified signing platform.

`it_statuses` `TYPE /AWS1/CL_SGNSTATUSES_W=>TT_STATUSES` `TT_STATUSES`¶

Filters results to return only signing jobs with statuses in the specified list.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgnlistsigningpflsrsp` `/AWS1/CL_SGNLISTSIGNINGPFLSRSP`¶

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->listsigningprofiles(
  it_statuses = VALUE /aws1/cl_sgnstatuses_w=>tt_statuses(
    ( new /aws1/cl_sgnstatuses_w( |string| ) )
  )
  iv_includecanceled = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_platformid = |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_profiles( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_profilename = lo_row_1->get_profilename( ).
      lv_profileversion = lo_row_1->get_profileversion( ).
      lv_arn = lo_row_1->get_profileversionarn( ).
      lo_signingmaterial = lo_row_1->get_signingmaterial( ).
      IF lo_signingmaterial IS NOT INITIAL.
        lv_certificatearn = lo_signingmaterial->get_certificatearn( ).
      ENDIF.
      lo_signaturevalidityperiod = lo_row_1->get_signaturevalidityperiod( ).
      IF lo_signaturevalidityperiod IS NOT INITIAL.
        lv_integer = lo_signaturevalidityperiod->get_value( ).
        lv_validitytype = lo_signaturevalidityperiod->get_type( ).
      ENDIF.
      lv_platformid = lo_row_1->get_platformid( ).
      lv_displayname = lo_row_1->get_platformdisplayname( ).
      LOOP AT lo_row_1->get_signingparameters( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_signingparametervalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_signingprofilestatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_arn( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_3.
        lv_key_1 = ls_row_3-key.
        lo_value_1 = ls_row_3-value.
        IF lo_value_1 IS NOT INITIAL.
          lv_tagvalue = lo_value_1->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_SGN=>LISTSIGNINGPROFILES()¶