Skip to content

/AWS1/IF_REK=>CREATEPROJECTVERSION()

About CreateProjectVersion

Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the project version.

The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

The following applies only to projects with Amazon Rekognition Custom Labels as the chosen feature:

You can train a model in a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields.

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.

Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.

Method Signature

METHODS /AWS1/IF_REK~CREATEPROJECTVERSION
  IMPORTING
    !IV_PROJECTARN TYPE /AWS1/REKPROJECTARN OPTIONAL
    !IV_VERSIONNAME TYPE /AWS1/REKVERSIONNAME OPTIONAL
    !IO_OUTPUTCONFIG TYPE REF TO /AWS1/CL_REKOUTPUTCONFIG OPTIONAL
    !IO_TRAININGDATA TYPE REF TO /AWS1/CL_REKTRAININGDATA OPTIONAL
    !IO_TESTINGDATA TYPE REF TO /AWS1/CL_REKTESTINGDATA OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_REKTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/REKKMSKEYID OPTIONAL
    !IV_VERSIONDESCRIPTION TYPE /AWS1/REKVERSIONDESCRIPTION OPTIONAL
    !IO_FEATURECONFIG TYPE REF TO /AWS1/CL_REKCUSTIZATIONFEATCFG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rekcreprojectvrsrsp
  RAISING
    /AWS1/CX_REKACCESSDENIEDEX
    /AWS1/CX_REKINTERNALSERVERERR
    /AWS1/CX_REKINVALIDPARAMETEREX
    /AWS1/CX_REKLIMITEXCEEDEDEX
    /AWS1/CX_REKPROVTHRUPUTEXCDEX
    /AWS1/CX_REKRESOURCEINUSEEX
    /AWS1/CX_REKRESOURCENOTFOUNDEX
    /AWS1/CX_REKSERVICEQUOTAEXCDEX
    /AWS1/CX_REKTHROTTLINGEX
    /AWS1/CX_REKCLIENTEXC
    /AWS1/CX_REKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_projectarn TYPE /AWS1/REKPROJECTARN /AWS1/REKPROJECTARN

The ARN of the Amazon Rekognition project that will manage the project version you want to train.

iv_versionname TYPE /AWS1/REKVERSIONNAME /AWS1/REKVERSIONNAME

A name for the version of the project version. This value must be unique.

io_outputconfig TYPE REF TO /AWS1/CL_REKOUTPUTCONFIG /AWS1/CL_REKOUTPUTCONFIG

The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the bucket.

Optional arguments:

io_trainingdata TYPE REF TO /AWS1/CL_REKTRAININGDATA /AWS1/CL_REKTRAININGDATA

Specifies an external manifest that the services uses to train the project version. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

io_testingdata TYPE REF TO /AWS1/CL_REKTESTINGDATA /AWS1/CL_REKTESTINGDATA

Specifies an external manifest that the service uses to test the project version. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

it_tags TYPE /AWS1/CL_REKTAGMAP_W=>TT_TAGMAP TT_TAGMAP

A set of tags (key-value pairs) that you want to attach to the project version.

iv_kmskeyid TYPE /AWS1/REKKMSKEYID /AWS1/REKKMSKEYID

The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

If you choose to use your own KMS key, you need the following permissions on the KMS key.

  • kms:CreateGrant

  • kms:DescribeKey

  • kms:GenerateDataKey

  • kms:Decrypt

If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

iv_versiondescription TYPE /AWS1/REKVERSIONDESCRIPTION /AWS1/REKVERSIONDESCRIPTION

A description applied to the project version being created.

io_featureconfig TYPE REF TO /AWS1/CL_REKCUSTIZATIONFEATCFG /AWS1/CL_REKCUSTIZATIONFEATCFG

Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.

RETURNING

oo_output TYPE REF TO /aws1/cl_rekcreprojectvrsrsp /AWS1/CL_REKCREPROJECTVRSRSP

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->createprojectversion(
  io_featureconfig = new /aws1/cl_rekcustizationfeatcfg( new /aws1/cl_rekcustizationftcon00( '0.1' ) )
  io_outputconfig = new /aws1/cl_rekoutputconfig(
    iv_s3bucket = |string|
    iv_s3keyprefix = |string|
  )
  io_testingdata = new /aws1/cl_rektestingdata(
    it_assets = VALUE /aws1/cl_rekasset=>tt_assets(
      (
        new /aws1/cl_rekasset(
          io_groundtruthmanifest = new /aws1/cl_rekgroundtruthmanif00(
            io_s3object = new /aws1/cl_reks3object(
              iv_bucket = |string|
              iv_name = |string|
              iv_version = |string|
            )
          )
        )
      )
    )
    iv_autocreate = ABAP_TRUE
  )
  io_trainingdata = new /aws1/cl_rektrainingdata(
    it_assets = VALUE /aws1/cl_rekasset=>tt_assets(
      (
        new /aws1/cl_rekasset(
          io_groundtruthmanifest = new /aws1/cl_rekgroundtruthmanif00(
            io_s3object = new /aws1/cl_reks3object(
              iv_bucket = |string|
              iv_name = |string|
              iv_version = |string|
            )
          )
        )
      )
    )
  )
  it_tags = VALUE /aws1/cl_rektagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_rektagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_rektagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_kmskeyid = |string|
  iv_projectarn = |string|
  iv_versiondescription = |string|
  iv_versionname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_projectversionarn = lo_result->get_projectversionarn( ).
ENDIF.

To train an Amazon Rekognition Custom Labels model

Trains a version of an Amazon Rekognition Custom Labels model.

DATA(lo_result) = lo_client->createprojectversion(
  io_outputconfig = new /aws1/cl_rekoutputconfig(
    iv_s3bucket = |output_bucket|
    iv_s3keyprefix = |output_folder|
  )
  iv_projectarn = |arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815|
  iv_versionname = |1|
).