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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass ImportModelRequest data as a hash:

{
  source_model_arn: "ComprehendModelArn", # required
  model_name: "ComprehendArnName",
  version_name: "VersionName",
  model_kms_key_id: "KmsKeyId",
  data_access_role_arn: "IamRoleArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arnString

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

Returns:

  • (String)


3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3898

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_idString

ID for the AWS Key Management Service (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)


3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3898

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_nameString

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

Returns:

  • (String)


3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3898

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_arnString

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

Returns:

  • (String)


3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3898

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

#tagsArray<Types::Tag>

Tags to be associated 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:



3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3898

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_nameString

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/AWS Region.

Returns:

  • (String)


3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3898

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