Skip to content

/AWS1/IF_SGN=>STARTSIGNINGJOB()

About StartSigningJob

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation. Note the following requirements:

  • You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide.

  • Your S3 source bucket must be version enabled.

  • You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

  • You specify the name of the source and destination buckets when calling the StartSigningJob operation.

  • You must ensure the S3 buckets are from the same Region as the signing profile. Cross-Region signing isn't supported.

  • You must also specify a request token that identifies your request to Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see StartSigningJob.

Method Signature

METHODS /AWS1/IF_SGN~STARTSIGNINGJOB
  IMPORTING
    !IO_SOURCE TYPE REF TO /AWS1/CL_SGNSOURCE OPTIONAL
    !IO_DESTINATION TYPE REF TO /AWS1/CL_SGNDESTINATION OPTIONAL
    !IV_PROFILENAME TYPE /AWS1/SGNPROFILENAME OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/SGNCLIENTREQUESTTOKEN OPTIONAL
    !IV_PROFILEOWNER TYPE /AWS1/SGNACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgnstartsigningjobrsp
  RAISING
    /AWS1/CX_SGNACCESSDENIEDEX
    /AWS1/CX_SGNINTERNALSVCERROREX
    /AWS1/CX_SGNRESOURCENOTFOUNDEX
    /AWS1/CX_SGNTHROTTLINGEX
    /AWS1/CX_SGNTOOMANYREQUESTSEX
    /AWS1/CX_SGNVALIDATIONEX
    /AWS1/CX_SGNCLIENTEXC
    /AWS1/CX_SGNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_source TYPE REF TO /AWS1/CL_SGNSOURCE /AWS1/CL_SGNSOURCE

The S3 bucket that contains the object to sign or a BLOB that contains your raw code.

io_destination TYPE REF TO /AWS1/CL_SGNDESTINATION /AWS1/CL_SGNDESTINATION

The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.

iv_profilename TYPE /AWS1/SGNPROFILENAME /AWS1/SGNPROFILENAME

The name of the signing profile.

iv_clientrequesttoken TYPE /AWS1/SGNCLIENTREQUESTTOKEN /AWS1/SGNCLIENTREQUESTTOKEN

String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

Optional arguments:

iv_profileowner TYPE /AWS1/SGNACCOUNTID /AWS1/SGNACCOUNTID

The AWS account ID of the signing profile owner.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgnstartsigningjobrsp /AWS1/CL_SGNSTARTSIGNINGJOBRSP

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->startsigningjob(
  io_destination = new /aws1/cl_sgndestination(
    io_s3 = new /aws1/cl_sgns3destination(
      iv_bucketname = |string|
      iv_prefix = |string|
    )
  )
  io_source = new /aws1/cl_sgnsource(
    io_s3 = new /aws1/cl_sgns3source(
      iv_bucketname = |string|
      iv_key = |string|
      iv_version = |string|
    )
  )
  iv_clientrequesttoken = |string|
  iv_profilename = |string|
  iv_profileowner = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_jobid = lo_result->get_jobid( ).
  lv_accountid = lo_result->get_jobowner( ).
ENDIF.