Skip to content

/AWS1/IF_OMX=>CREATEWORKFLOWVERSION()

About CreateWorkflowVersion

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Don’t include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Method Signature

IMPORTING

Required arguments:

iv_workflowid TYPE /AWS1/OMXWORKFLOWID /AWS1/OMXWORKFLOWID

The ID of the workflow where you are creating the new version.

iv_versionname TYPE /AWS1/OMXWORKFLOWVERSIONNAME /AWS1/OMXWORKFLOWVERSIONNAME

A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.

iv_requestid TYPE /AWS1/OMXWORKFLOWREQUESTID /AWS1/OMXWORKFLOWREQUESTID

To ensure that requests don't run multiple times, specify a unique ID for each request.

Optional arguments:

iv_definitionzip TYPE /AWS1/OMXBLOB /AWS1/OMXBLOB

A zip archive containing the workflow definition for this workflow version.

iv_definitionuri TYPE /AWS1/OMXWORKFLOWDEFINITION /AWS1/OMXWORKFLOWDEFINITION

The URI specifies the location of the workflow definition for this workflow version.

iv_accelerators TYPE /AWS1/OMXACCELERATORS /AWS1/OMXACCELERATORS

The computational accelerator for this workflow version.

iv_description TYPE /AWS1/OMXWORKFLOWVERSIONDESC /AWS1/OMXWORKFLOWVERSIONDESC

A description for this workflow version.

iv_engine TYPE /AWS1/OMXWORKFLOWENGINE /AWS1/OMXWORKFLOWENGINE

The workflow engine for this workflow version.

iv_main TYPE /AWS1/OMXWORKFLOWMAIN /AWS1/OMXWORKFLOWMAIN

The path of the main definition file for this workflow version.

it_parametertemplate TYPE /AWS1/CL_OMXWORKFLOWPARAMETER=>TT_WORKFLOWPARAMETERTEMPLATE TT_WORKFLOWPARAMETERTEMPLATE

The parameter template defines the input parameters for runs that use this workflow version.

iv_storagetype TYPE /AWS1/OMXSTORAGETYPE /AWS1/OMXSTORAGETYPE

The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

iv_storagecapacity TYPE /AWS1/OMXINTEGER /AWS1/OMXINTEGER

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

it_tags TYPE /AWS1/CL_OMXTAGMAP_W=>TT_TAGMAP TT_TAGMAP

Optional tags to associate with this workflow version.

iv_workflowbucketownerid TYPE /AWS1/OMXWORKFLOWBUCKETOWNERID /AWS1/OMXWORKFLOWBUCKETOWNERID

Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.

iv_readmemarkdown TYPE /AWS1/OMXREADMEMARKDOWN /AWS1/OMXREADMEMARKDOWN

The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.

iv_parametertemplatepath TYPE /AWS1/OMXPARAMETERTEMPLATEPATH /AWS1/OMXPARAMETERTEMPLATEPATH

The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.

iv_readmepath TYPE /AWS1/OMXREADMEPATH /AWS1/OMXREADMEPATH

The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

io_definitionrepository TYPE REF TO /AWS1/CL_OMXDEFNREPOSITORY /AWS1/CL_OMXDEFNREPOSITORY

The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.

iv_readmeuri TYPE /AWS1/OMXS3URIFOROBJECT /AWS1/OMXS3URIFOROBJECT

The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include:

  • The S3 URI must begin with s3://USER-OWNED-BUCKET/

  • The requester must have access to the S3 bucket and object.

  • The max README content length is 500 KiB.

RETURNING

oo_output TYPE REF TO /aws1/cl_omxcreworkflowvrsrsp /AWS1/CL_OMXCREWORKFLOWVRSRSP

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->/aws1/if_omx~createworkflowversion(
  io_definitionrepository = new /aws1/cl_omxdefnrepository(
    io_sourcereference = new /aws1/cl_omxsourcereference(
      iv_type = |string|
      iv_value = |string|
    )
    it_excludefilepatterns = VALUE /aws1/cl_omxexcludefilepatls00=>tt_excludefilepatternlist(
      ( new /aws1/cl_omxexcludefilepatls00( |string| ) )
    )
    iv_connectionarn = |string|
    iv_fullrepositoryid = |string|
  )
  it_parametertemplate = VALUE /aws1/cl_omxworkflowparameter=>tt_workflowparametertemplate(
    (
      VALUE /aws1/cl_omxworkflowparameter=>ts_workflowparamtmpl_maprow(
        key = |string|
        value = new /aws1/cl_omxworkflowparameter(
          iv_description = |string|
          iv_optional = ABAP_TRUE
        )
      )
    )
  )
  it_tags = VALUE /aws1/cl_omxtagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_omxtagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_omxtagmap_w( |string| )
      )
    )
  )
  iv_accelerators = |string|
  iv_definitionuri = |string|
  iv_definitionzip = '5347567362473873563239796247513D'
  iv_description = |string|
  iv_engine = |string|
  iv_main = |string|
  iv_parametertemplatepath = |string|
  iv_readmemarkdown = |string|
  iv_readmepath = |string|
  iv_readmeuri = |string|
  iv_requestid = |string|
  iv_storagecapacity = 123
  iv_storagetype = |string|
  iv_versionname = |string|
  iv_workflowbucketownerid = |string|
  iv_workflowid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_workflowversionarn = lo_result->get_arn( ).
  lv_workflowid = lo_result->get_workflowid( ).
  lv_workflowversionname = lo_result->get_versionname( ).
  lv_workflowstatus = lo_result->get_status( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_workflowuuid = lo_result->get_uuid( ).
ENDIF.