« blib/lib/Paws/Comprehend/DocumentClassifierOutputDataConfig.pm
↑ Summary
blib/lib/Paws/Comprehend/DocumentLabel.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Comprehend::DocumentClassifierProperties; | ||
| 3 | use Moose; | ||
| 4 | has ClassifierMetadata => (is => 'ro', isa => 'Paws::Comprehend::ClassifierMetadata'); | ||
| 5 | has DataAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has DocumentClassifierArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 8 | has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::DocumentClassifierInputDataConfig'); | ||
| 9 | has LanguageCode => (is => 'ro', isa => 'Str'); | ||
| 10 | has Message => (is => 'ro', isa => 'Str'); | ||
| 11 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 12 | has ModelKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 13 | has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::DocumentClassifierOutputDataConfig'); | ||
| 14 | has Status => (is => 'ro', isa => 'Str'); | ||
| 15 | has SubmitTime => (is => 'ro', isa => 'Str'); | ||
| 16 | has TrainingEndTime => (is => 'ro', isa => 'Str'); | ||
| 17 | has TrainingStartTime => (is => 'ro', isa => 'Str'); | ||
| 18 | has VolumeKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 19 | has VpcConfig => (is => 'ro', isa => 'Paws::Comprehend::VpcConfig'); | ||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::Comprehend::DocumentClassifierProperties | ||
| 28 | |||
| 29 | =head1 USAGE | ||
| 30 | |||
| 31 | This class represents one of two things: | ||
| 32 | |||
| 33 | =head3 Arguments in a call to a service | ||
| 34 | |||
| 35 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 36 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 37 | |||
| 38 | As an example, if Att1 is expected to be a Paws::Comprehend::DocumentClassifierProperties object: | ||
| 39 | |||
| 40 | $service_obj->Method(Att1 => { ClassifierMetadata => $value, ..., VpcConfig => $value }); | ||
| 41 | |||
| 42 | =head3 Results returned from an API call | ||
| 43 | |||
| 44 | Use accessors for each attribute. If Att1 is expected to be an Paws::Comprehend::DocumentClassifierProperties object: | ||
| 45 | |||
| 46 | $result = $service_obj->Method(...); | ||
| 47 | $result->Att1->ClassifierMetadata | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | Provides information about a document classifier. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 ClassifierMetadata => L<Paws::Comprehend::ClassifierMetadata> | ||
| 57 | |||
| 58 | Information about the document classifier, including the number of | ||
| 59 | documents used for training the classifier, the number of documents | ||
| 60 | used for test the classifier, and an accuracy rating. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 DataAccessRoleArn => Str | ||
| 64 | |||
| 65 | The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) | ||
| 66 | role that grants Amazon Comprehend read access to your input data. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 DocumentClassifierArn => Str | ||
| 70 | |||
| 71 | The Amazon Resource Name (ARN) that identifies the document classifier. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 EndTime => Str | ||
| 75 | |||
| 76 | The time that training the document classifier completed. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 InputDataConfig => L<Paws::Comprehend::DocumentClassifierInputDataConfig> | ||
| 80 | |||
| 81 | The input data configuration that you supplied when you created the | ||
| 82 | document classifier for training. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 LanguageCode => Str | ||
| 86 | |||
| 87 | The language code for the language of the documents that the classifier | ||
| 88 | was trained on. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Message => Str | ||
| 92 | |||
| 93 | Additional information about the status of the classifier. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Mode => Str | ||
| 97 | |||
| 98 | Indicates the mode in which the specific classifier was trained. This | ||
| 99 | also indicates the format of input documents and the format of the | ||
| 100 | confusion matrix. Each classifier can only be trained in one mode and | ||
| 101 | this cannot be changed once the classifier is trained. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 ModelKmsKeyId => Str | ||
| 105 | |||
| 106 | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend | ||
| 107 | uses to encrypt trained custom models. The ModelKmsKeyId can be either | ||
| 108 | of the following formats: | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | Amazon Resource Name (ARN) of a KMS Key: | ||
| 119 | C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 OutputDataConfig => L<Paws::Comprehend::DocumentClassifierOutputDataConfig> | ||
| 126 | |||
| 127 | Provides output results configuration parameters for custom classifier | ||
| 128 | jobs. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 Status => Str | ||
| 132 | |||
| 133 | The status of the document classifier. If the status is C<TRAINED> the | ||
| 134 | classifier is ready to use. If the status is C<FAILED> you can see | ||
| 135 | additional information about why the classifier wasn't trained in the | ||
| 136 | C<Message> field. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 SubmitTime => Str | ||
| 140 | |||
| 141 | The time that the document classifier was submitted for training. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 TrainingEndTime => Str | ||
| 145 | |||
| 146 | The time that training of the document classifier was completed. | ||
| 147 | Indicates the time when the training completes on documentation | ||
| 148 | classifiers. You are billed for the time interval between this time and | ||
| 149 | the value of TrainingStartTime. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 TrainingStartTime => Str | ||
| 153 | |||
| 154 | Indicates the time when the training starts on documentation | ||
| 155 | classifiers. You are billed for the time interval between this time and | ||
| 156 | the value of TrainingEndTime. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 VolumeKmsKeyId => Str | ||
| 160 | |||
| 161 | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend | ||
| 162 | uses to encrypt data on the storage volume attached to the ML compute | ||
| 163 | instance(s) that process the analysis job. The VolumeKmsKeyId can be | ||
| 164 | either of the following formats: | ||
| 165 | |||
| 166 | =over | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 171 | |||
| 172 | =item * | ||
| 173 | |||
| 174 | Amazon Resource Name (ARN) of a KMS Key: | ||
| 175 | C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 176 | |||
| 177 | =back | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 VpcConfig => L<Paws::Comprehend::VpcConfig> | ||
| 182 | |||
| 183 | Configuration parameters for a private Virtual Private Cloud (VPC) | ||
| 184 | containing the resources you are using for your custom classifier. For | ||
| 185 | more information, see Amazon VPC | ||
| 186 | (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head1 SEE ALSO | ||
| 191 | |||
| 192 | This class forms part of L<Paws>, describing an object used in L<Paws::Comprehend> | ||
| 193 | |||
| 194 | =head1 BUGS and CONTRIBUTIONS | ||
| 195 | |||
| 196 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 197 | |||
| 198 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 199 | |||
| 200 | =cut | ||
| 201 |