blib/lib/Paws/Comprehend/StartSentimentDetectionJob.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::StartSentimentDetectionJob;
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 LanguageCode => (is => 'ro', isa => 'Str', required => 1);
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 => 'StartSentimentDetectionJob');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::StartSentimentDetectionJobResponse');
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::StartSentimentDetectionJob - Arguments for method StartSentimentDetectionJob on L<Paws::Comprehend>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method StartSentimentDetectionJob on the
29 L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class
30 as arguments to method StartSentimentDetectionJob.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartSentimentDetectionJob.
33  
34 =head1 SYNOPSIS
35  
36 my $comprehend = Paws->service('Comprehend');
37 my $StartSentimentDetectionJobResponse =
38 $comprehend->StartSentimentDetectionJob(
39 DataAccessRoleArn => 'MyIamRoleArn',
40 InputDataConfig => {
41 S3Uri => 'MyS3Uri', # max: 1024
42 InputFormat => 'ONE_DOC_PER_FILE'
43 , # values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE; OPTIONAL
44 },
45 LanguageCode => 'en',
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 = $StartSentimentDetectionJobResponse->JobId;
66 my $JobStatus = $StartSentimentDetectionJobResponse->JobStatus;
67  
68 # Returns a L<Paws::Comprehend::StartSentimentDetectionJobResponse> 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/StartSentimentDetectionJob>
72  
73 =head1 ATTRIBUTES
74  
75  
76 =head2 ClientRequestToken => Str
77  
78 A unique identifier for the request. If you don't 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. For more information, see
88 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
89 (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
90  
91  
92  
93 =head2 B<REQUIRED> InputDataConfig => L<Paws::Comprehend::InputDataConfig>
94  
95 Specifies the format and location of the input data for the job.
96  
97  
98  
99 =head2 JobName => Str
100  
101 The identifier of the job.
102  
103  
104  
105 =head2 B<REQUIRED> LanguageCode => Str
106  
107 The language of the input documents. You can specify any of the primary
108 languages supported by Amazon Comprehend. All documents must be in the
109 same language.
110  
111 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">
112  
113 =head2 B<REQUIRED> OutputDataConfig => L<Paws::Comprehend::OutputDataConfig>
114  
115 Specifies where to send the output files.
116  
117  
118  
119 =head2 VolumeKmsKeyId => Str
120  
121 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
122 uses to encrypt data on the storage volume attached to the ML compute
123 instance(s) that process the analysis job. The VolumeKmsKeyId can be
124 either of the following formats:
125  
126 =over
127  
128 =item *
129  
130 KMS Key ID: C<"1234abcd-12ab-34cd-56ef-1234567890ab">
131  
132 =item *
133  
134 Amazon Resource Name (ARN) of a KMS Key:
135 C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab">
136  
137 =back
138  
139  
140  
141  
142 =head2 VpcConfig => L<Paws::Comprehend::VpcConfig>
143  
144 Configuration parameters for an optional private Virtual Private Cloud
145 (VPC) containing the resources you are using for your sentiment
146 detection job. For more information, see Amazon VPC
147 (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
148  
149  
150  
151  
152 =head1 SEE ALSO
153  
154 This class forms part of L<Paws>, documenting arguments for method StartSentimentDetectionJob in L<Paws::Comprehend>
155  
156 =head1 BUGS and CONTRIBUTIONS
157  
158 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
159  
160 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
161  
162 =cut
163