Skip to content

/AWS1/CL_CPD=>IMPORTMODEL()

About ImportModel

Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.

If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.

Method Signature

IMPORTING

Required arguments:

iv_sourcemodelarn TYPE /AWS1/CPDCOMPREHENDMODELARN /AWS1/CPDCOMPREHENDMODELARN

The Amazon Resource Name (ARN) of the custom model to import.

Optional arguments:

iv_modelname TYPE /AWS1/CPDCOMPREHENDARNNAME /AWS1/CPDCOMPREHENDARNNAME

The name to assign to the custom model that is created in Amazon Comprehend by this import.

iv_versionname TYPE /AWS1/CPDVERSIONNAME /AWS1/CPDVERSIONNAME

The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/Region.

iv_modelkmskeyid TYPE /AWS1/CPDKMSKEYID /AWS1/CPDKMSKEYID

ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

iv_dataaccessrolearn TYPE /AWS1/CPDIAMROLEARN /AWS1/CPDIAMROLEARN

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.

it_tags TYPE /AWS1/CL_CPDTAG=>TT_TAGLIST TT_TAGLIST

Tags to associate with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

RETURNING

oo_output TYPE REF TO /aws1/cl_cpdimportmodelrsp /AWS1/CL_CPDIMPORTMODELRSP

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_cpd~importmodel(
  it_tags = VALUE /aws1/cl_cpdtag=>tt_taglist(
    (
      new /aws1/cl_cpdtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_dataaccessrolearn = |string|
  iv_modelkmskeyid = |string|
  iv_modelname = |string|
  iv_sourcemodelarn = |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_comprehendmodelarn = lo_result->get_modelarn( ).
ENDIF.