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