blib/lib/Paws/Macie2/CreateClassificationJob.pm untested

filter: Statementstmt 0.0% 0 / 30 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 32 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Macie2::CreateClassificationJob;
3 use Moose;
4 has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken', required => 1);
5 has CustomDataIdentifierIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'customDataIdentifierIds');
6 has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description');
7 has InitialRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'initialRun');
8 has JobType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobType', required => 1);
9 has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1);
10 has S3JobDefinition => (is => 'ro', isa => 'Paws::Macie2::S3JobDefinition', traits => ['NameInRequest'], request_name => 's3JobDefinition', required => 1);
11 has SamplingPercentage => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'samplingPercentage');
12 has ScheduleFrequency => (is => 'ro', isa => 'Paws::Macie2::JobScheduleFrequency', traits => ['NameInRequest'], request_name => 'scheduleFrequency');
13 has Tags => (is => 'ro', isa => 'Paws::Macie2::TagMap', traits => ['NameInRequest'], request_name => 'tags');
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateClassificationJob');
18 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/jobs');
19 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
20 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Macie2::CreateClassificationJobResponse');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::Macie2::CreateClassificationJob - Arguments for method CreateClassificationJob on L<Paws::Macie2>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method CreateClassificationJob on the
32 L<Amazon Macie 2|Paws::Macie2> service. Use the attributes of this class
33 as arguments to method CreateClassificationJob.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateClassificationJob.
36  
37 =head1 SYNOPSIS
38  
39 my $macie2 = Paws->service('Macie2');
40 my $CreateClassificationJobResponse = $macie2->CreateClassificationJob(
41 ClientToken => 'My__string',
42 JobType => 'ONE_TIME',
43 Name => 'My__string',
44 S3JobDefinition => {
45 BucketCriteria => {
46 Excludes => {
47 And => [
48 {
49 SimpleCriterion => {
50 Comparator => 'EQ'
51 , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
52 Key => 'ACCOUNT_ID'
53 , # values: ACCOUNT_ID, S3_BUCKET_NAME, S3_BUCKET_EFFECTIVE_PERMISSION, S3_BUCKET_SHARED_ACCESS; OPTIONAL
54 Values => [ 'My__string', ... ], # OPTIONAL
55 }, # OPTIONAL
56 TagCriterion => {
57 Comparator => 'EQ'
58 , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
59 TagValues => [
60 {
61 Key => 'My__string',
62 Value => 'My__string',
63 },
64 ...
65 ], # OPTIONAL
66 }, # OPTIONAL
67 },
68 ...
69 ], # OPTIONAL
70 }, # OPTIONAL
71 Includes => {
72 And => [
73 {
74 SimpleCriterion => {
75 Comparator => 'EQ'
76 , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
77 Key => 'ACCOUNT_ID'
78 , # values: ACCOUNT_ID, S3_BUCKET_NAME, S3_BUCKET_EFFECTIVE_PERMISSION, S3_BUCKET_SHARED_ACCESS; OPTIONAL
79 Values => [ 'My__string', ... ], # OPTIONAL
80 }, # OPTIONAL
81 TagCriterion => {
82 Comparator => 'EQ'
83 , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
84 TagValues => [
85 {
86 Key => 'My__string',
87 Value => 'My__string',
88 },
89 ...
90 ], # OPTIONAL
91 }, # OPTIONAL
92 },
93 ...
94 ], # OPTIONAL
95 }, # OPTIONAL
96 }, # OPTIONAL
97 BucketDefinitions => [
98 {
99 AccountId => 'My__string',
100 Buckets => [ 'My__string', ... ], # OPTIONAL
101  
102 },
103 ...
104 ], # OPTIONAL
105 Scoping => {
106 Excludes => {
107 And => [
108 {
109 SimpleScopeTerm => {
110 Comparator => 'EQ'
111 , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
112 Key => 'OBJECT_EXTENSION'
113 , # values: OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, OBJECT_KEY; OPTIONAL
114 Values => [ 'My__string', ... ], # OPTIONAL
115 }, # OPTIONAL
116 TagScopeTerm => {
117 Comparator => 'EQ'
118 , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
119 Key => 'My__string',
120 TagValues => [
121 {
122 Key => 'My__string',
123 Value => 'My__string',
124 },
125 ...
126 ], # OPTIONAL
127 Target => 'S3_OBJECT', # values: S3_OBJECT; OPTIONAL
128 }, # OPTIONAL
129 },
130 ...
131 ], # OPTIONAL
132 }, # OPTIONAL
133 Includes => {
134 And => [
135 {
136 SimpleScopeTerm => {
137 Comparator => 'EQ'
138 , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
139 Key => 'OBJECT_EXTENSION'
140 , # values: OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, OBJECT_KEY; OPTIONAL
141 Values => [ 'My__string', ... ], # OPTIONAL
142 }, # OPTIONAL
143 TagScopeTerm => {
144 Comparator => 'EQ'
145 , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
146 Key => 'My__string',
147 TagValues => [
148 {
149 Key => 'My__string',
150 Value => 'My__string',
151 },
152 ...
153 ], # OPTIONAL
154 Target => 'S3_OBJECT', # values: S3_OBJECT; OPTIONAL
155 }, # OPTIONAL
156 },
157 ...
158 ], # OPTIONAL
159 }, # OPTIONAL
160 }, # OPTIONAL
161 },
162 CustomDataIdentifierIds => [ 'My__string', ... ], # OPTIONAL
163 Description => 'My__string', # OPTIONAL
164 InitialRun => 1, # OPTIONAL
165 SamplingPercentage => 1, # OPTIONAL
166 ScheduleFrequency => {
167 DailySchedule => {
168  
169 }, # OPTIONAL
170 MonthlySchedule => { DayOfMonth => 1, }, # OPTIONAL
171 WeeklySchedule => {
172 DayOfWeek => 'SUNDAY'
173 , # values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY; OPTIONAL
174 }, # OPTIONAL
175 }, # OPTIONAL
176 Tags => { 'My__string' => 'My__string', }, # OPTIONAL
177 );
178  
179 # Results:
180 my $JobArn = $CreateClassificationJobResponse->JobArn;
181 my $JobId = $CreateClassificationJobResponse->JobId;
182  
183 # Returns a L<Paws::Macie2::CreateClassificationJobResponse> object.
184  
185 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.
186 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/macie2/CreateClassificationJob>
187  
188 =head1 ATTRIBUTES
189  
190  
191 =head2 B<REQUIRED> ClientToken => Str
192  
193 A unique, case-sensitive token that you provide to ensure the
194 idempotency of the request.
195  
196  
197  
198 =head2 CustomDataIdentifierIds => ArrayRef[Str|Undef]
199  
200 The custom data identifiers to use for data analysis and
201 classification.
202  
203  
204  
205 =head2 Description => Str
206  
207 A custom description of the job. The description can contain as many as
208 200 characters.
209  
210  
211  
212 =head2 InitialRun => Bool
213  
214 Specifies whether to analyze all existing, eligible objects immediately
215 after the job is created.
216  
217  
218  
219 =head2 B<REQUIRED> JobType => Str
220  
221 The schedule for running the job. Valid values are:
222  
223 =over
224  
225 =item *
226  
227 ONE_TIME - Run the job only once. If you specify this value, don't
228 specify a value for the scheduleFrequency property.
229  
230 =item *
231  
232 SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you
233 specify this value, use the scheduleFrequency property to define the
234 recurrence pattern for the job.
235  
236 =back
237  
238  
239 Valid values are: C<"ONE_TIME">, C<"SCHEDULED">
240  
241 =head2 B<REQUIRED> Name => Str
242  
243 A custom name for the job. The name can contain as many as 500
244 characters.
245  
246  
247  
248 =head2 B<REQUIRED> S3JobDefinition => L<Paws::Macie2::S3JobDefinition>
249  
250 The S3 buckets that contain the objects to analyze, and the scope of
251 that analysis.
252  
253  
254  
255 =head2 SamplingPercentage => Int
256  
257 The sampling depth, as a percentage, to apply when processing objects.
258 This value determines the percentage of eligible objects that the job
259 analyzes. If this value is less than 100, Amazon Macie selects the
260 objects to analyze at random, up to the specified percentage, and
261 analyzes all the data in those objects.
262  
263  
264  
265 =head2 ScheduleFrequency => L<Paws::Macie2::JobScheduleFrequency>
266  
267 The recurrence pattern for running the job. To run the job only once,
268 don't specify a value for this property and set the value for the
269 jobType property to ONE_TIME.
270  
271  
272  
273 =head2 Tags => L<Paws::Macie2::TagMap>
274  
275 A map of key-value pairs that specifies the tags to associate with the
276 job.
277  
278 A job can have a maximum of 50 tags. Each tag consists of a tag key and
279 an associated tag value. The maximum length of a tag key is 128
280 characters. The maximum length of a tag value is 256 characters.
281  
282  
283  
284  
285 =head1 SEE ALSO
286  
287 This class forms part of L<Paws>, documenting arguments for method CreateClassificationJob in L<Paws::Macie2>
288  
289 =head1 BUGS and CONTRIBUTIONS
290  
291 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
292  
293 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
294  
295 =cut
296