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

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 26 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Macie2::CreateFindingsFilter;
3 use Moose;
4 has Action => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'action', required => 1);
5 has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken');
6 has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description');
7 has FindingCriteria => (is => 'ro', isa => 'Paws::Macie2::FindingCriteria', traits => ['NameInRequest'], request_name => 'findingCriteria', required => 1);
8 has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1);
9 has Position => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'position');
10 has Tags => (is => 'ro', isa => 'Paws::Macie2::TagMap', traits => ['NameInRequest'], request_name => 'tags');
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFindingsFilter');
15 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/findingsfilters');
16 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
17 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Macie2::CreateFindingsFilterResponse');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::Macie2::CreateFindingsFilter - Arguments for method CreateFindingsFilter on L<Paws::Macie2>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method CreateFindingsFilter on the
29 L<Amazon Macie 2|Paws::Macie2> service. Use the attributes of this class
30 as arguments to method CreateFindingsFilter.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFindingsFilter.
33  
34 =head1 SYNOPSIS
35  
36 my $macie2 = Paws->service('Macie2');
37 my $CreateFindingsFilterResponse = $macie2->CreateFindingsFilter(
38 Action => 'ARCHIVE',
39 FindingCriteria => {
40 Criterion => {
41 'My__string' => {
42 Eq => [ 'My__string', ... ], # OPTIONAL
43 EqExactMatch => [ 'My__string', ... ], # OPTIONAL
44 Gt => 1, # OPTIONAL
45 Gte => 1, # OPTIONAL
46 Lt => 1, # OPTIONAL
47 Lte => 1, # OPTIONAL
48 Neq => [ 'My__string', ... ], # OPTIONAL
49 },
50 }, # OPTIONAL
51 },
52 Name => 'My__string',
53 ClientToken => 'My__string', # OPTIONAL
54 Description => 'My__string', # OPTIONAL
55 Position => 1, # OPTIONAL
56 Tags => { 'My__string' => 'My__string', }, # OPTIONAL
57 );
58  
59 # Results:
60 my $Arn = $CreateFindingsFilterResponse->Arn;
61 my $Id = $CreateFindingsFilterResponse->Id;
62  
63 # Returns a L<Paws::Macie2::CreateFindingsFilterResponse> object.
64  
65 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.
66 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/macie2/CreateFindingsFilter>
67  
68 =head1 ATTRIBUTES
69  
70  
71 =head2 B<REQUIRED> Action => Str
72  
73 The action to perform on findings that meet the filter criteria
74 (findingCriteria). Valid values are: ARCHIVE, suppress (automatically
75 archive) the findings; and, NOOP, don't perform any action on the
76 findings.
77  
78 Valid values are: C<"ARCHIVE">, C<"NOOP">
79  
80 =head2 ClientToken => Str
81  
82 A unique, case-sensitive token that you provide to ensure the
83 idempotency of the request.
84  
85  
86  
87 =head2 Description => Str
88  
89 A custom description of the filter. The description can contain as many
90 as 512 characters.
91  
92 We strongly recommend that you avoid including any sensitive data in
93 the description of a filter. Other users of your account might be able
94 to see the filter's description, depending on the actions that they're
95 allowed to perform in Amazon Macie.
96  
97  
98  
99 =head2 B<REQUIRED> FindingCriteria => L<Paws::Macie2::FindingCriteria>
100  
101 The criteria to use to filter findings.
102  
103  
104  
105 =head2 B<REQUIRED> Name => Str
106  
107 A custom name for the filter. The name must contain at least 3
108 characters and can contain as many as 64 characters.
109  
110 We strongly recommend that you avoid including any sensitive data in
111 the name of a filter. Other users of your account might be able to see
112 the filter's name, depending on the actions that they're allowed to
113 perform in Amazon Macie.
114  
115  
116  
117 =head2 Position => Int
118  
119 The position of the filter in the list of saved filters on the Amazon
120 Macie console. This value also determines the order in which the filter
121 is applied to findings, relative to other filters that are also applied
122 to the findings.
123  
124  
125  
126 =head2 Tags => L<Paws::Macie2::TagMap>
127  
128 A map of key-value pairs that specifies the tags to associate with the
129 filter.
130  
131 A findings filter can have a maximum of 50 tags. Each tag consists of a
132 tag key and an associated tag value. The maximum length of a tag key is
133 128 characters. The maximum length of a tag value is 256 characters.
134  
135  
136  
137  
138 =head1 SEE ALSO
139  
140 This class forms part of L<Paws>, documenting arguments for method CreateFindingsFilter in L<Paws::Macie2>
141  
142 =head1 BUGS and CONTRIBUTIONS
143  
144 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
145  
146 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
147  
148 =cut
149