Skip to content

/AWS1/IF_SGM=>STARTPIPELINEEXECUTION()

About StartPipelineExecution

Starts a pipeline execution.

Method Signature

METHODS /AWS1/IF_SGM~STARTPIPELINEEXECUTION
  IMPORTING
    !IV_PIPELINENAME TYPE /AWS1/SGMPIPELINENAMEORARN OPTIONAL
    !IV_PIPELINEEXECDISPLAYNAME TYPE /AWS1/SGMPIPELINEEXECUTIONNAME OPTIONAL
    !IT_PIPELINEPARAMETERS TYPE /AWS1/CL_SGMPARAMETER=>TT_PARAMETERLIST OPTIONAL
    !IV_PIPELINEEXECUTIONDESC TYPE /AWS1/SGMPIPELINEEXECUTIONDESC OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/SGMIDEMPOTENCYTOKEN OPTIONAL
    !IO_PARALLELISMCONFIGURATION TYPE REF TO /AWS1/CL_SGMPARALLELISMCONF OPTIONAL
    !IO_SELECTIVEEXECUTIONCONFIG TYPE REF TO /AWS1/CL_SGMSELECTIVEEXECCFG OPTIONAL
    !IV_PIPELINEVERSIONID TYPE /AWS1/SGMPIPELINEVERSIONID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmstartplinexecrsp
  RAISING
    /AWS1/CX_SGMCONFLICTEXCEPTION
    /AWS1/CX_SGMRESOURCELIMITEXCD
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_pipelinename TYPE /AWS1/SGMPIPELINENAMEORARN /AWS1/SGMPIPELINENAMEORARN

The name or Amazon Resource Name (ARN) of the pipeline.

iv_clientrequesttoken TYPE /AWS1/SGMIDEMPOTENCYTOKEN /AWS1/SGMIDEMPOTENCYTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

Optional arguments:

iv_pipelineexecdisplayname TYPE /AWS1/SGMPIPELINEEXECUTIONNAME /AWS1/SGMPIPELINEEXECUTIONNAME

The display name of the pipeline execution.

it_pipelineparameters TYPE /AWS1/CL_SGMPARAMETER=>TT_PARAMETERLIST TT_PARAMETERLIST

Contains a list of pipeline parameters. This list can be empty.

iv_pipelineexecutiondesc TYPE /AWS1/SGMPIPELINEEXECUTIONDESC /AWS1/SGMPIPELINEEXECUTIONDESC

The description of the pipeline execution.

io_parallelismconfiguration TYPE REF TO /AWS1/CL_SGMPARALLELISMCONF /AWS1/CL_SGMPARALLELISMCONF

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

io_selectiveexecutionconfig TYPE REF TO /AWS1/CL_SGMSELECTIVEEXECCFG /AWS1/CL_SGMSELECTIVEEXECCFG

The selective execution configuration applied to the pipeline run.

iv_pipelineversionid TYPE /AWS1/SGMPIPELINEVERSIONID /AWS1/SGMPIPELINEVERSIONID

The ID of the pipeline version to start execution from.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmstartplinexecrsp /AWS1/CL_SGMSTARTPLINEXECRSP

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->startpipelineexecution(
  io_parallelismconfiguration = new /aws1/cl_sgmparallelismconf( 123 )
  io_selectiveexecutionconfig = new /aws1/cl_sgmselectiveexeccfg(
    it_selectedsteps = VALUE /aws1/cl_sgmselectedstep=>tt_selectedsteplist(
      ( new /aws1/cl_sgmselectedstep( |string| ) )
    )
    iv_sourcepipelineexecarn = |string|
  )
  it_pipelineparameters = VALUE /aws1/cl_sgmparameter=>tt_parameterlist(
    (
      new /aws1/cl_sgmparameter(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_pipelineexecdisplayname = |string|
  iv_pipelineexecutiondesc = |string|
  iv_pipelinename = |string|
  iv_pipelineversionid = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_pipelineexecutionarn = lo_result->get_pipelineexecutionarn( ).
ENDIF.