Skip to content

/AWS1/IF_SGN=>LISTSIGNINGJOBS()

About ListSigningJobs

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. 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~LISTSIGNINGJOBS
  IMPORTING
    !IV_STATUS TYPE /AWS1/SGNSIGNINGSTATUS OPTIONAL
    !IV_PLATFORMID TYPE /AWS1/SGNPLATFORMID OPTIONAL
    !IV_REQUESTEDBY TYPE /AWS1/SGNREQUESTEDBY OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGNNEXTTOKEN OPTIONAL
    !IV_ISREVOKED TYPE /AWS1/SGNBOOL OPTIONAL
    !IV_SIGNATUREEXPIRESBEFORE TYPE /AWS1/SGNTIMESTAMP OPTIONAL
    !IV_SIGNATUREEXPIRESAFTER TYPE /AWS1/SGNTIMESTAMP OPTIONAL
    !IV_JOBINVOKER TYPE /AWS1/SGNACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgnlistsigningjobsrsp
  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_status TYPE /AWS1/SGNSIGNINGSTATUS /AWS1/SGNSIGNINGSTATUS

A status value with which to filter your results.

iv_platformid TYPE /AWS1/SGNPLATFORMID /AWS1/SGNPLATFORMID

The ID of microcontroller platform that you specified for the distribution of your code image.

iv_requestedby TYPE /AWS1/SGNREQUESTEDBY /AWS1/SGNREQUESTEDBY

The IAM principal that requested the signing job.

iv_maxresults TYPE /AWS1/SGNMAXRESULTS /AWS1/SGNMAXRESULTS

Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.

iv_nexttoken TYPE /AWS1/SGNNEXTTOKEN /AWS1/SGNNEXTTOKEN

String 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_isrevoked TYPE /AWS1/SGNBOOL /AWS1/SGNBOOL

Filters results to return only signing jobs with revoked signatures.

iv_signatureexpiresbefore TYPE /AWS1/SGNTIMESTAMP /AWS1/SGNTIMESTAMP

Filters results to return only signing jobs with signatures expiring before a specified timestamp.

iv_signatureexpiresafter TYPE /AWS1/SGNTIMESTAMP /AWS1/SGNTIMESTAMP

Filters results to return only signing jobs with signatures expiring after a specified timestamp.

iv_jobinvoker TYPE /AWS1/SGNACCOUNTID /AWS1/SGNACCOUNTID

Filters results to return only signing jobs initiated by a specified IAM entity.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgnlistsigningjobsrsp /AWS1/CL_SGNLISTSIGNINGJOBSRSP

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->listsigningjobs(
  iv_isrevoked = ABAP_TRUE
  iv_jobinvoker = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_platformid = |string|
  iv_requestedby = |string|
  iv_signatureexpiresafter = '20150101000000.0000000'
  iv_signatureexpiresbefore = '20150101000000.0000000'
  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_jobs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_jobid = lo_row_1->get_jobid( ).
      lo_source = lo_row_1->get_source( ).
      IF lo_source IS NOT INITIAL.
        lo_s3source = lo_source->get_s3( ).
        IF lo_s3source IS NOT INITIAL.
          lv_bucketname = lo_s3source->get_bucketname( ).
          lv_key = lo_s3source->get_key( ).
          lv_version = lo_s3source->get_version( ).
        ENDIF.
      ENDIF.
      lo_signedobject = lo_row_1->get_signedobject( ).
      IF lo_signedobject IS NOT INITIAL.
        lo_s3signedobject = lo_signedobject->get_s3( ).
        IF lo_s3signedobject IS NOT INITIAL.
          lv_bucketname = lo_s3signedobject->get_bucketname( ).
          lv_key = lo_s3signedobject->get_key( ).
        ENDIF.
      ENDIF.
      lo_signingmaterial = lo_row_1->get_signingmaterial( ).
      IF lo_signingmaterial IS NOT INITIAL.
        lv_certificatearn = lo_signingmaterial->get_certificatearn( ).
      ENDIF.
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_signingstatus = lo_row_1->get_status( ).
      lv_bool = lo_row_1->get_isrevoked( ).
      lv_profilename = lo_row_1->get_profilename( ).
      lv_profileversion = lo_row_1->get_profileversion( ).
      lv_platformid = lo_row_1->get_platformid( ).
      lv_displayname = lo_row_1->get_platformdisplayname( ).
      lv_timestamp = lo_row_1->get_signatureexpiresat( ).
      lv_accountid = lo_row_1->get_jobowner( ).
      lv_accountid = lo_row_1->get_jobinvoker( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.