STARTMODEL()`¶

About StartModel¶

Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use DescribeModel.

A model is ready to use when its status is HOSTED.

Once the model is running, you can detect custom labels in new images by calling DetectAnomalies.

You are charged for the amount of time that the model is running. To stop a running model, call StopModel.

This operation requires permissions to perform the lookoutvision:StartModel operation.

Method Signature¶

METHODS /AWS1/IF_LOV~STARTMODEL
  IMPORTING
    !IV_PROJECTNAME TYPE /AWS1/LOVPROJECTNAME OPTIONAL
    !IV_MODELVERSION TYPE /AWS1/LOVMODELVERSION OPTIONAL
    !IV_MININFERENCEUNITS TYPE /AWS1/LOVINFERENCEUNITS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/LOVCLIENTTOKEN OPTIONAL
    !IV_MAXINFERENCEUNITS TYPE /AWS1/LOVINFERENCEUNITS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lovstartmodelresponse
  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 that contains the model that you want to start.

`iv_modelversion` `TYPE /AWS1/LOVMODELVERSION` `/AWS1/LOVMODELVERSION`¶

The version of the model that you want to start.

`iv_mininferenceunits` `TYPE /AWS1/LOVINFERENCEUNITS` `/AWS1/LOVINFERENCEUNITS`¶

The minimum number of inference units to use. A single inference unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/LOVCLIENTTOKEN` `/AWS1/LOVCLIENTTOKEN`¶

ClientToken is an idempotency token that ensures a call to StartModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModel. In this case, safely retry your call to StartModel 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 making multiple start requests. 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 StartModel. An idempotency token is active for 8 hours.

`iv_maxinferenceunits` `TYPE /AWS1/LOVINFERENCEUNITS` `/AWS1/LOVINFERENCEUNITS`¶

The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Lookout for Vision doesn't auto-scale the model.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lovstartmodelresponse` `/AWS1/CL_LOVSTARTMODELRESPONSE`¶

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->startmodel(
  iv_clienttoken = |string|
  iv_maxinferenceunits = 123
  iv_mininferenceunits = 123
  iv_modelversion = |string|
  iv_projectname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_modelhostingstatus = lo_result->get_status( ).
ENDIF.

/AWS1/IF_LOV=>STARTMODEL()¶