Class: Aws::Comprehend::Types::DocumentClassifierProperties

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::DocumentClassifierProperties

Includes:

Structure

Defined in:

lib/aws-sdk-comprehend/types.rb

Overview

Provides information about a document classifier.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:classifier_metadata]

Instance Attribute Summary

• #classifier_metadata ⇒ Types::ClassifierMetadata

  Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

• #data_access_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

• #document_classifier_arn ⇒ String

  The Amazon Resource Name (ARN) that identifies the document classifier.

• #end_time ⇒ Time

  The time that training the document classifier completed.

• #flywheel_arn ⇒ String

  The Amazon Resource Number (ARN) of the flywheel.

• #input_data_config ⇒ Types::DocumentClassifierInputDataConfig

  The input data configuration that you supplied when you created the document classifier for training.

• #language_code ⇒ String

  The language code for the language of the documents that the classifier was trained on.

• #message ⇒ String

  Additional information about the status of the classifier.

• #mode ⇒ String

  Indicates the mode in which the specific classifier was trained.

• #model_kms_key_id ⇒ String

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

• #output_data_config ⇒ Types::DocumentClassifierOutputDataConfig

  Provides output results configuration parameters for custom classifier jobs.

• #source_model_arn ⇒ String

  The Amazon Resource Name (ARN) of the source model.

• #status ⇒ String

  The status of the document classifier.

• #submit_time ⇒ Time

  The time that the document classifier was submitted for training.

• #training_end_time ⇒ Time

  The time that training of the document classifier was completed.

• #training_start_time ⇒ Time

  Indicates the time when the training starts on documentation classifiers.

• #version_name ⇒ String

  The version name that you assigned to the document classifier.

• #volume_kms_key_id ⇒ String

  ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.

• #vpc_config ⇒ Types::VpcConfig

  Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

Instance Attribute Details

#classifier_metadata ⇒ Types::ClassifierMetadata

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

Returns:

• (Types::ClassifierMetadata)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#document_classifier_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the document classifier.

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#end_time ⇒ Time

The time that training the document classifier completed.

Returns:

• (Time)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#flywheel_arn ⇒ String

The Amazon Resource Number (ARN) of the flywheel

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#input_data_config ⇒ Types::DocumentClassifierInputDataConfig

The input data configuration that you supplied when you created the document classifier for training.

Returns:

• (Types::DocumentClassifierInputDataConfig)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#language_code ⇒ String

The language code for the language of the documents that the classifier was trained on.

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#message ⇒ String

Additional information about the status of the classifier.

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#mode ⇒ String

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  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 3201

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#output_data_config ⇒ Types::DocumentClassifierOutputDataConfig

Provides output results configuration parameters for custom classifier jobs.

Returns:

• (Types::DocumentClassifierOutputDataConfig)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#source_model_arn ⇒ String

The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#status ⇒ String

The status of the document classifier. If the status is ‘TRAINED` the classifier is ready to use. If the status is `TRAINED_WITH_WARNINGS` the classifier training succeeded, but you should review the warnings returned in the `CreateDocumentClassifier` response.

If the status is ‘FAILED` you can see additional information about why the classifier wasn’t trained in the ‘Message` field.

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#submit_time ⇒ Time

The time that the document classifier was submitted for training.

Returns:

• (Time)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#training_end_time ⇒ Time

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

Returns:

• (Time)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#training_start_time ⇒ Time

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

Returns:

• (Time)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#version_name ⇒ String

The version name that you assigned to the document classifier.

Returns:

• (String)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#volume_kms_key_id ⇒ String

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId 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 3201

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html

Returns:

• (Types::VpcConfig)

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

class DocumentClassifierProperties < Struct.new(
  :document_classifier_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :output_data_config,
  :classifier_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :mode,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn)
  SENSITIVE = [:classifier_metadata]
  include Aws::Structure
end