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

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