Skip to content

/AWS1/IF_SGM=>CREATEPIPELINE()

About CreatePipeline

Creates a pipeline using a JSON pipeline definition.

Method Signature

METHODS /AWS1/IF_SGM~CREATEPIPELINE
  IMPORTING
    !IV_PIPELINENAME TYPE /AWS1/SGMPIPELINENAME OPTIONAL
    !IV_PIPELINEDISPLAYNAME TYPE /AWS1/SGMPIPELINENAME OPTIONAL
    !IV_PIPELINEDEFINITION TYPE /AWS1/SGMPIPELINEDEFINITION OPTIONAL
    !IO_PIPELINEDEFNS3LOCATION TYPE REF TO /AWS1/CL_SGMPIPELINEDEFNS3LOC OPTIONAL
    !IV_PIPELINEDESCRIPTION TYPE /AWS1/SGMPIPELINEDESCRIPTION OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/SGMIDEMPOTENCYTOKEN OPTIONAL
    !IV_ROLEARN TYPE /AWS1/SGMROLEARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST OPTIONAL
    !IO_PARALLELISMCONFIGURATION TYPE REF TO /AWS1/CL_SGMPARALLELISMCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmcreateplinresponse
  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/SGMPIPELINENAME /AWS1/SGMPIPELINENAME

The name 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 one time.

iv_rolearn TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

Optional arguments:

iv_pipelinedisplayname TYPE /AWS1/SGMPIPELINENAME /AWS1/SGMPIPELINENAME

The display name of the pipeline.

iv_pipelinedefinition TYPE /AWS1/SGMPIPELINEDEFINITION /AWS1/SGMPIPELINEDEFINITION

The JSON pipeline definition of the pipeline.

io_pipelinedefns3location TYPE REF TO /AWS1/CL_SGMPIPELINEDEFNS3LOC /AWS1/CL_SGMPIPELINEDEFNS3LOC

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

iv_pipelinedescription TYPE /AWS1/SGMPIPELINEDESCRIPTION /AWS1/SGMPIPELINEDESCRIPTION

A description of the pipeline.

it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

A list of tags to apply to the created pipeline.

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

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmcreateplinresponse /AWS1/CL_SGMCREATEPLINRESPONSE

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->createpipeline(
  io_parallelismconfiguration = new /aws1/cl_sgmparallelismconf( 123 )
  io_pipelinedefns3location = new /aws1/cl_sgmpipelinedefns3loc(
    iv_bucket = |string|
    iv_objectkey = |string|
    iv_versionid = |string|
  )
  it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
    (
      new /aws1/cl_sgmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_pipelinedefinition = |string|
  iv_pipelinedescription = |string|
  iv_pipelinedisplayname = |string|
  iv_pipelinename = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_pipelinearn = lo_result->get_pipelinearn( ).
ENDIF.