Skip to content

Import Model

comprehend_import_model R Documentation

Creates a new custom model that replicates a source custom model that you import

Description

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.

Usage

comprehend_import_model(SourceModelArn, ModelName, VersionName,
  ModelKmsKeyId, DataAccessRoleArn, Tags)

Arguments

SourceModelArn

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

ModelName

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

VersionName

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.

ModelKmsKeyId

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"

DataAccessRoleArn

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.

Tags

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.

Value

A list with the following syntax: 

list(
  ModelArn = "string"
)

Request syntax

svc$import_model(
  SourceModelArn = "string",
  ModelName = "string",
  VersionName = "string",
  ModelKmsKeyId = "string",
  DataAccessRoleArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)