Class: Aws::Comprehend::Types::ImportModelRequest

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::ImportModelRequest

Includes:

Structure

Defined in:

lib/aws-sdk-comprehend/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_access_role_arn ⇒ 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.

• #model_kms_key_id ⇒ String

  ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.

• #model_name ⇒ String

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

• #source_model_arn ⇒ String

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

• #tags ⇒ Array<Types::Tag>

  Tags to associate with the custom model that is created by this import.

• #version_name ⇒ String

  The version name given to the custom model that is created by this import.

Instance Attribute Details

#data_access_role_arn ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 4953

class ImportModelRequest < Struct.new(
  :source_model_arn,
  :model_name,
  :version_name,
  :model_kms_key_id,
  :data_access_role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_kms_key_id ⇒ 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”`

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 4953

class ImportModelRequest < Struct.new(
  :source_model_arn,
  :model_name,
  :version_name,
  :model_kms_key_id,
  :data_access_role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 4953

class ImportModelRequest < Struct.new(
  :source_model_arn,
  :model_name,
  :version_name,
  :model_kms_key_id,
  :data_access_role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_model_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 4953

class ImportModelRequest < Struct.new(
  :source_model_arn,
  :model_name,
  :version_name,
  :model_kms_key_id,
  :data_access_role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::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.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-comprehend/types.rb', line 4953

class ImportModelRequest < Struct.new(
  :source_model_arn,
  :model_name,
  :version_name,
  :model_kms_key_id,
  :data_access_role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#version_name ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 4953

class ImportModelRequest < Struct.new(
  :source_model_arn,
  :model_name,
  :version_name,
  :model_kms_key_id,
  :data_access_role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end