blib/lib/Paws/Comprehend/CreateDocumentClassifier.pm untested

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 22 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Comprehend::CreateDocumentClassifier;
3 use Moose;
4 has ClientRequestToken => (is => 'ro', isa => 'Str');
5 has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1);
6 has DocumentClassifierName => (is => 'ro', isa => 'Str', required => 1);
7 has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::DocumentClassifierInputDataConfig', required => 1);
8 has LanguageCode => (is => 'ro', isa => 'Str', required => 1);
9 has Mode => (is => 'ro', isa => 'Str');
10 has ModelKmsKeyId => (is => 'ro', isa => 'Str');
11 has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::DocumentClassifierOutputDataConfig');
12 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Comprehend::Tag]');
13 has VolumeKmsKeyId => (is => 'ro', isa => 'Str');
14 has VpcConfig => (is => 'ro', isa => 'Paws::Comprehend::VpcConfig');
15  
16 use MooseX::ClassAttribute;
17  
18 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDocumentClassifier');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::CreateDocumentClassifierResponse');
20 class_has _result_key => (isa => 'Str', is => 'ro');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::Comprehend::CreateDocumentClassifier - Arguments for method CreateDocumentClassifier on L<Paws::Comprehend>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method CreateDocumentClassifier on the
32 L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class
33 as arguments to method CreateDocumentClassifier.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDocumentClassifier.
36  
37 =head1 SYNOPSIS
38  
39 my $comprehend = Paws->service('Comprehend');
40 my $CreateDocumentClassifierResponse =
41 $comprehend->CreateDocumentClassifier(
42 DataAccessRoleArn => 'MyIamRoleArn',
43 DocumentClassifierName => 'MyComprehendArnName',
44 InputDataConfig => {
45 AugmentedManifests => [
46 {
47 AttributeNames => [
48 'MyAttributeNamesListItem', ... # min: 1, max: 63
49 ],
50 S3Uri => 'MyS3Uri', # max: 1024
51  
52 },
53 ...
54 ], # OPTIONAL
55 DataFormat => 'COMPREHEND_CSV'
56 , # values: COMPREHEND_CSV, AUGMENTED_MANIFEST; OPTIONAL
57 LabelDelimiter => 'MyLabelDelimiter', # min: 1, max: 1; OPTIONAL
58 S3Uri => 'MyS3Uri', # max: 1024
59 },
60 LanguageCode => 'en',
61 ClientRequestToken => 'MyClientRequestTokenString', # OPTIONAL
62 Mode => 'MULTI_CLASS', # OPTIONAL
63 ModelKmsKeyId => 'MyKmsKeyId', # OPTIONAL
64 OutputDataConfig => {
65 KmsKeyId => 'MyKmsKeyId', # max: 2048
66 S3Uri => 'MyS3Uri', # max: 1024
67 }, # OPTIONAL
68 Tags => [
69 {
70 Key => 'MyTagKey', # min: 1, max: 128
71 Value => 'MyTagValue', # max: 256; OPTIONAL
72 },
73 ...
74 ], # OPTIONAL
75 VolumeKmsKeyId => 'MyKmsKeyId', # OPTIONAL
76 VpcConfig => {
77 SecurityGroupIds => [
78 'MySecurityGroupId', ... # min: 1, max: 32
79 ], # min: 1, max: 5
80 Subnets => [
81 'MySubnetId', ... # min: 1, max: 32
82 ], # min: 1, max: 16
83  
84 }, # OPTIONAL
85 );
86  
87 # Results:
88 my $DocumentClassifierArn =
89 $CreateDocumentClassifierResponse->DocumentClassifierArn;
90  
91 # Returns a L<Paws::Comprehend::CreateDocumentClassifierResponse> object.
92  
93 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
94 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/comprehend/CreateDocumentClassifier>
95  
96 =head1 ATTRIBUTES
97  
98  
99 =head2 ClientRequestToken => Str
100  
101 A unique identifier for the request. If you don't set the client
102 request token, Amazon Comprehend generates one.
103  
104  
105  
106 =head2 B<REQUIRED> DataAccessRoleArn => Str
107  
108 The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
109 role that grants Amazon Comprehend read access to your input data.
110  
111  
112  
113 =head2 B<REQUIRED> DocumentClassifierName => Str
114  
115 The name of the document classifier.
116  
117  
118  
119 =head2 B<REQUIRED> InputDataConfig => L<Paws::Comprehend::DocumentClassifierInputDataConfig>
120  
121 Specifies the format and location of the input data for the job.
122  
123  
124  
125 =head2 B<REQUIRED> LanguageCode => Str
126  
127 The language of the input documents. You can specify any of the
128 following languages supported by Amazon Comprehend: German ("de"),
129 English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or
130 Portuguese ("pt"). All documents must be in the same language.
131  
132 Valid values are: C<"en">, C<"es">, C<"fr">, C<"de">, C<"it">, C<"pt">, C<"ar">, C<"hi">, C<"ja">, C<"ko">, C<"zh">, C<"zh-TW">
133  
134 =head2 Mode => Str
135  
136 Indicates the mode in which the classifier will be trained. The
137 classifier can be trained in multi-class mode, which identifies one and
138 only one class for each document, or multi-label mode, which identifies
139 one or more labels for each document. In multi-label mode, multiple
140 labels for an individual document are separated by a delimiter. The
141 default delimiter between labels is a pipe (|).
142  
143 Valid values are: C<"MULTI_CLASS">, C<"MULTI_LABEL">
144  
145 =head2 ModelKmsKeyId => Str
146  
147 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
148 uses to encrypt trained custom models. The ModelKmsKeyId can be either
149 of the following formats:
150  
151 =over
152  
153 =item *
154  
155 KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab">
156  
157 =item *
158  
159 Amazon Resource Name (ARN) of a KMS Key:
160 C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab">
161  
162 =back
163  
164  
165  
166  
167 =head2 OutputDataConfig => L<Paws::Comprehend::DocumentClassifierOutputDataConfig>
168  
169 Enables the addition of output results configuration parameters for
170 custom classifier jobs.
171  
172  
173  
174 =head2 Tags => ArrayRef[L<Paws::Comprehend::Tag>]
175  
176 Tags to be associated with the document classifier being created. A tag
177 is a key-value pair that adds as a metadata to a resource used by
178 Amazon Comprehend. For example, a tag with "Sales" as the key might be
179 added to a resource to indicate its use by the sales department.
180  
181  
182  
183 =head2 VolumeKmsKeyId => Str
184  
185 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
186 uses to encrypt data on the storage volume attached to the ML compute
187 instance(s) that process the analysis job. The VolumeKmsKeyId can be
188 either of the following formats:
189  
190 =over
191  
192 =item *
193  
194 KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab">
195  
196 =item *
197  
198 Amazon Resource Name (ARN) of a KMS Key:
199 C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab">
200  
201 =back
202  
203  
204  
205  
206 =head2 VpcConfig => L<Paws::Comprehend::VpcConfig>
207  
208 Configuration parameters for an optional private Virtual Private Cloud
209 (VPC) containing the resources you are using for your custom
210 classifier. For more information, see Amazon VPC
211 (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
212  
213  
214  
215  
216 =head1 SEE ALSO
217  
218 This class forms part of L<Paws>, documenting arguments for method CreateDocumentClassifier in L<Paws::Comprehend>
219  
220 =head1 BUGS and CONTRIBUTIONS
221  
222 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
223  
224 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
225  
226 =cut
227