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

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Comprehend::StartDocumentClassificationJob;
3 use Moose;
4 has ClientRequestToken => (is => 'ro', isa => 'Str');
5 has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1);
6 has DocumentClassifierArn => (is => 'ro', isa => 'Str', required => 1);
7 has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::InputDataConfig', required => 1);
8 has JobName => (is => 'ro', isa => 'Str');
9 has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::OutputDataConfig', required => 1);
10 has VolumeKmsKeyId => (is => 'ro', isa => 'Str');
11 has VpcConfig => (is => 'ro', isa => 'Paws::Comprehend::VpcConfig');
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartDocumentClassificationJob');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::StartDocumentClassificationJobResponse');
17 class_has _result_key => (isa => 'Str', is => 'ro');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::Comprehend::StartDocumentClassificationJob - Arguments for method StartDocumentClassificationJob on L<Paws::Comprehend>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method StartDocumentClassificationJob on the
29 L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class
30 as arguments to method StartDocumentClassificationJob.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartDocumentClassificationJob.
33  
34 =head1 SYNOPSIS
35  
36 my $comprehend = Paws->service('Comprehend');
37 my $StartDocumentClassificationJobResponse =
38 $comprehend->StartDocumentClassificationJob(
39 DataAccessRoleArn => 'MyIamRoleArn',
40 DocumentClassifierArn => 'MyDocumentClassifierArn',
41 InputDataConfig => {
42 S3Uri => 'MyS3Uri', # max: 1024
43 InputFormat => 'ONE_DOC_PER_FILE'
44 , # values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE; OPTIONAL
45 },
46 OutputDataConfig => {
47 S3Uri => 'MyS3Uri', # max: 1024
48 KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL
49 },
50 ClientRequestToken => 'MyClientRequestTokenString', # OPTIONAL
51 JobName => 'MyJobName', # OPTIONAL
52 VolumeKmsKeyId => 'MyKmsKeyId', # OPTIONAL
53 VpcConfig => {
54 SecurityGroupIds => [
55 'MySecurityGroupId', ... # min: 1, max: 32
56 ], # min: 1, max: 5
57 Subnets => [
58 'MySubnetId', ... # min: 1, max: 32
59 ], # min: 1, max: 16
60  
61 }, # OPTIONAL
62 );
63  
64 # Results:
65 my $JobId = $StartDocumentClassificationJobResponse->JobId;
66 my $JobStatus = $StartDocumentClassificationJobResponse->JobStatus;
67  
68 # Returns a L<Paws::Comprehend::StartDocumentClassificationJobResponse> object.
69  
70 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.
71 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/comprehend/StartDocumentClassificationJob>
72  
73 =head1 ATTRIBUTES
74  
75  
76 =head2 ClientRequestToken => Str
77  
78 A unique identifier for the request. If you do not set the client
79 request token, Amazon Comprehend generates one.
80  
81  
82  
83 =head2 B<REQUIRED> DataAccessRoleArn => Str
84  
85 The Amazon Resource Name (ARN) of the AWS Identity and Access
86 Management (IAM) role that grants Amazon Comprehend read access to your
87 input data.
88  
89  
90  
91 =head2 B<REQUIRED> DocumentClassifierArn => Str
92  
93 The Amazon Resource Name (ARN) of the document classifier to use to
94 process the job.
95  
96  
97  
98 =head2 B<REQUIRED> InputDataConfig => L<Paws::Comprehend::InputDataConfig>
99  
100 Specifies the format and location of the input data for the job.
101  
102  
103  
104 =head2 JobName => Str
105  
106 The identifier of the job.
107  
108  
109  
110 =head2 B<REQUIRED> OutputDataConfig => L<Paws::Comprehend::OutputDataConfig>
111  
112 Specifies where to send the output files.
113  
114  
115  
116 =head2 VolumeKmsKeyId => Str
117  
118 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
119 uses to encrypt data on the storage volume attached to the ML compute
120 instance(s) that process the analysis job. The VolumeKmsKeyId can be
121 either of the following formats:
122  
123 =over
124  
125 =item *
126  
127 KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab">
128  
129 =item *
130  
131 Amazon Resource Name (ARN) of a KMS Key:
132 C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab">
133  
134 =back
135  
136  
137  
138  
139 =head2 VpcConfig => L<Paws::Comprehend::VpcConfig>
140  
141 Configuration parameters for an optional private Virtual Private Cloud
142 (VPC) containing the resources you are using for your document
143 classification job. For more information, see Amazon VPC
144 (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
145  
146  
147  
148  
149 =head1 SEE ALSO
150  
151 This class forms part of L<Paws>, documenting arguments for method StartDocumentClassificationJob in L<Paws::Comprehend>
152  
153 =head1 BUGS and CONTRIBUTIONS
154  
155 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
156  
157 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
158  
159 =cut
160