/AWS1/IF_LOV=>CREATEMODEL()

About CreateModel

Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.

To get the current status, check the Status field returned in the response from DescribeModel.

If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.

After training completes, the evaluation metrics are stored at the location specified in OutputConfig.

This operation requires permissions to perform the lookoutvision:CreateModel operation. If you want to tag your model, you also require permission to the lookoutvision:TagResource operation.

Method Signature

METHODS /AWS1/IF_LOV~CREATEMODEL
  IMPORTING
    !IV_PROJECTNAME TYPE /AWS1/LOVPROJECTNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/LOVMODELDESCMESSAGE OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/LOVCLIENTTOKEN OPTIONAL
    !IO_OUTPUTCONFIG TYPE REF TO /AWS1/CL_LOVOUTPUTCONFIG OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/LOVKMSKEYID OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LOVTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lovcreatemodelrsp
  RAISING
    /AWS1/CX_LOVACCESSDENIEDEX
    /AWS1/CX_LOVCONFLICTEXCEPTION
    /AWS1/CX_LOVINTERNALSERVEREX
    /AWS1/CX_LOVRESOURCENOTFOUNDEX
    /AWS1/CX_LOVSERVICEQUOTAEXCDEX
    /AWS1/CX_LOVTHROTTLINGEX
    /AWS1/CX_LOVVALIDATIONEX
    /AWS1/CX_LOVCLIENTEXC
    /AWS1/CX_LOVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_projectname TYPE /AWS1/LOVPROJECTNAME /AWS1/LOVPROJECTNAME

The name of the project in which you want to create a model version.

io_outputconfig TYPE REF TO /AWS1/CL_LOVOUTPUTCONFIG /AWS1/CL_LOVOUTPUTCONFIG

The location where Amazon Lookout for Vision saves the training results.

Optional arguments:

iv_description TYPE /AWS1/LOVMODELDESCMESSAGE /AWS1/LOVMODELDESCMESSAGE

A description for the version of the model.

iv_clienttoken TYPE /AWS1/LOVCLIENTTOKEN /AWS1/LOVCLIENTTOKEN

ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateModel. In this case, safely retry your call to CreateModel by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from starting multiple training jobs. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different
value for ClientToken is considered a new call to CreateModel. An idempotency token is active for 8 hours.

iv_kmskeyid TYPE /AWS1/LOVKMSKEYID /AWS1/LOVKMSKEYID

The identifier for your AWS KMS key. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

it_tags TYPE /AWS1/CL_LOVTAG=>TT_TAGLIST TT_TAGLIST

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

RETURNING

oo_output TYPE REF TO /aws1/cl_lovcreatemodelrsp /AWS1/CL_LOVCREATEMODELRSP

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->createmodel(
  io_outputconfig = new /aws1/cl_lovoutputconfig(
    io_s3location = new /aws1/cl_lovs3location(
      iv_bucket = |string|
      iv_prefix = |string|
    )
  )
  it_tags = VALUE /aws1/cl_lovtag=>tt_taglist(
    (
      new /aws1/cl_lovtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_kmskeyid = |string|
  iv_projectname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_modelmetadata = lo_result->get_modelmetadata( ).
  IF lo_modelmetadata IS NOT INITIAL.
    lv_datetime = lo_modelmetadata->get_creationtimestamp( ).
    lv_modelversion = lo_modelmetadata->get_modelversion( ).
    lv_modelarn = lo_modelmetadata->get_modelarn( ).
    lv_modeldescriptionmessage = lo_modelmetadata->get_description( ).
    lv_modelstatus = lo_modelmetadata->get_status( ).
    lv_modelstatusmessage = lo_modelmetadata->get_statusmessage( ).
    lo_modelperformance = lo_modelmetadata->get_performance( ).
    IF lo_modelperformance IS NOT INITIAL.
      lv_float = lo_modelperformance->get_f1score( ).
      lv_float = lo_modelperformance->get_recall( ).
      lv_float = lo_modelperformance->get_precision( ).
    ENDIF.
  ENDIF.
ENDIF.