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

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