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

filter: Statementstmt 0.0% 0 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 22 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Macie2::JobSummary;
3 use Moose;
4 has BucketCriteria => (is => 'ro', isa => 'Paws::Macie2::S3BucketCriteriaForJob', request_name => 'bucketCriteria', traits => ['NameInRequest']);
5 has BucketDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::Macie2::S3BucketDefinitionForJob]', request_name => 'bucketDefinitions', traits => ['NameInRequest']);
6 has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']);
7 has JobId => (is => 'ro', isa => 'Str', request_name => 'jobId', traits => ['NameInRequest']);
8 has JobStatus => (is => 'ro', isa => 'Str', request_name => 'jobStatus', traits => ['NameInRequest']);
9 has JobType => (is => 'ro', isa => 'Str', request_name => 'jobType', traits => ['NameInRequest']);
10 has LastRunErrorStatus => (is => 'ro', isa => 'Paws::Macie2::LastRunErrorStatus', request_name => 'lastRunErrorStatus', traits => ['NameInRequest']);
11 has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']);
12 has UserPausedDetails => (is => 'ro', isa => 'Paws::Macie2::UserPausedDetails', request_name => 'userPausedDetails', traits => ['NameInRequest']);
13  
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::Macie2::JobSummary
21  
22 =head1 USAGE
23  
24 This class represents one of two things:
25  
26 =head3 Arguments in a call to a service
27  
28 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29 Each attribute should be used as a named argument in the calls that expect this type of object.
30  
31 As an example, if Att1 is expected to be a Paws::Macie2::JobSummary object:
32  
33 $service_obj->Method(Att1 => { BucketCriteria => $value, ..., UserPausedDetails => $value });
34  
35 =head3 Results returned from an API call
36  
37 Use accessors for each attribute. If Att1 is expected to be an Paws::Macie2::JobSummary object:
38  
39 $result = $service_obj->Method(...);
40 $result->Att1->BucketCriteria
41  
42 =head1 DESCRIPTION
43  
44 Provides information about a classification job, including the current
45 status of the job.
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 BucketCriteria => L<Paws::Macie2::S3BucketCriteriaForJob>
51  
52 The property- and tag-based conditions that determine which S3 buckets
53 are included or excluded from the job's analysis. Each time the job
54 runs, the job uses these criteria to determine which buckets to
55 analyze. A job's definition can contain a bucketCriteria object or a
56 bucketDefinitions array, not both.
57  
58  
59 =head2 BucketDefinitions => ArrayRef[L<Paws::Macie2::S3BucketDefinitionForJob>]
60  
61 An array of objects, one for each Amazon Web Services account that owns
62 specific S3 buckets for the job to analyze. Each object specifies the
63 account ID for an account and one or more buckets to analyze for that
64 account. A job's definition can contain a bucketDefinitions array or a
65 bucketCriteria object, not both.
66  
67  
68 =head2 CreatedAt => Str
69  
70 The date and time, in UTC and extended ISO 8601 format, when the job
71 was created.
72  
73  
74 =head2 JobId => Str
75  
76 The unique identifier for the job.
77  
78  
79 =head2 JobStatus => Str
80  
81 The current status of the job. Possible values are:
82  
83 =over
84  
85 =item *
86  
87 CANCELLED - You cancelled the job or, if it's a one-time job, you
88 paused the job and didn't resume it within 30 days.
89  
90 =item *
91  
92 COMPLETE - For a one-time job, Amazon Macie finished processing the
93 data specified for the job. This value doesn't apply to recurring jobs.
94  
95 =item *
96  
97 IDLE - For a recurring job, the previous scheduled run is complete and
98 the next scheduled run is pending. This value doesn't apply to one-time
99 jobs.
100  
101 =item *
102  
103 PAUSED - Amazon Macie started running the job but additional processing
104 would exceed the monthly sensitive data discovery quota for your
105 account or one or more member accounts that the job analyzes data for.
106  
107 =item *
108  
109 RUNNING - For a one-time job, the job is in progress. For a recurring
110 job, a scheduled run is in progress.
111  
112 =item *
113  
114 USER_PAUSED - You paused the job. If you paused the job while it had a
115 status of RUNNING and you don't resume it within 30 days of pausing it,
116 the job or job run will expire and be cancelled, depending on the job's
117 type. To check the expiration date, refer to the
118 UserPausedDetails.jobExpiresAt property.
119  
120 =back
121  
122  
123  
124 =head2 JobType => Str
125  
126 The schedule for running the job. Possible values are:
127  
128 =over
129  
130 =item *
131  
132 ONE_TIME - The job runs only once.
133  
134 =item *
135  
136 SCHEDULED - The job runs on a daily, weekly, or monthly basis.
137  
138 =back
139  
140  
141  
142 =head2 LastRunErrorStatus => L<Paws::Macie2::LastRunErrorStatus>
143  
144 Specifies whether any account- or bucket-level access errors occurred
145 when the job ran. For a recurring job, this value indicates the error
146 status of the job's most recent run.
147  
148  
149 =head2 Name => Str
150  
151 The custom name of the job.
152  
153  
154 =head2 UserPausedDetails => L<Paws::Macie2::UserPausedDetails>
155  
156 If the current status of the job is USER_PAUSED, specifies when the job
157 was paused and when the job or job run will expire and be cancelled if
158 it isn't resumed. This value is present only if the value for jobStatus
159 is USER_PAUSED.
160  
161  
162  
163 =head1 SEE ALSO
164  
165 This class forms part of L<Paws>, describing an object used in L<Paws::Macie2>
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