/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Comprehend::DocumentClassifierProperties

NAME

Paws::Comprehend::DocumentClassifierProperties

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Comprehend::DocumentClassifierProperties object:

$service_obj->Method(Att1 => { ClassifierMetadata => $value, ..., VpcConfig => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Comprehend::DocumentClassifierProperties object:

$result = $service_obj->Method(...);
$result->Att1->ClassifierMetadata

DESCRIPTION

Provides information about a document classifier.

ATTRIBUTES

ClassifierMetadata => Paws::Comprehend::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.

DataAccessRoleArn => Str

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

DocumentClassifierArn => Str

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

EndTime => Str

The time that training the document classifier completed.

InputDataConfig => Paws::Comprehend::DocumentClassifierInputDataConfig

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

LanguageCode => Str

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

Message => Str

Additional information about the status of the classifier.

Mode => Str

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.

ModelKmsKeyId => Str

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"

OutputDataConfig => Paws::Comprehend::DocumentClassifierOutputDataConfig

Provides output results configuration parameters for custom classifier jobs.

Status => Str

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

SubmitTime => Str

The time that the document classifier was submitted for training.

TrainingEndTime => Str

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.

TrainingStartTime => Str

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.

VolumeKmsKeyId => Str

ID for the AWS 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"

VpcConfig => Paws::Comprehend::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 (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Comprehend

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues