Interface ImportModelRequest

interface ImportModelRequest {
    DataAccessRoleArn?: string;
    ModelKmsKeyId?: string;
    ModelName?: string;
    SourceModelArn: undefined | string;
    Tags?: Tag[];
    VersionName?: string;
}

Hierarchy (view full)

Properties

DataAccessRoleArn? ModelKmsKeyId? ModelName? SourceModelArn Tags? VersionName?

Properties

Optional DataAccessRoleArn

DataAccessRoleArn?: string

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.

Optional ModelKmsKeyId

ModelKmsKeyId?: string

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"

Optional ModelName

ModelName?: string

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

SourceModelArn

SourceModelArn: undefined | string

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

Optional Tags

Tags?: Tag[]

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.

Optional VersionName

VersionName?: string

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.

Settings

Member Visibility

Theme

On This Page