blib/lib/Paws/IoT/UpdateSecurityProfile.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::IoT::UpdateSecurityProfile;
3 use Moose;
4 has AdditionalMetricsToRetain => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'additionalMetricsToRetain');
5 has AdditionalMetricsToRetainV2 => (is => 'ro', isa => 'ArrayRef[Paws::IoT::MetricToRetain]', traits => ['NameInRequest'], request_name => 'additionalMetricsToRetainV2');
6 has AlertTargets => (is => 'ro', isa => 'Paws::IoT::AlertTargets', traits => ['NameInRequest'], request_name => 'alertTargets');
7 has Behaviors => (is => 'ro', isa => 'ArrayRef[Paws::IoT::Behavior]', traits => ['NameInRequest'], request_name => 'behaviors');
8 has DeleteAdditionalMetricsToRetain => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'deleteAdditionalMetricsToRetain');
9 has DeleteAlertTargets => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'deleteAlertTargets');
10 has DeleteBehaviors => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'deleteBehaviors');
11 has ExpectedVersion => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'expectedVersion');
12 has SecurityProfileDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'securityProfileDescription');
13 has SecurityProfileName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'securityProfileName', required => 1);
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateSecurityProfile');
18 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/security-profiles/{securityProfileName}');
19 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH');
20 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::UpdateSecurityProfileResponse');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::IoT::UpdateSecurityProfile - Arguments for method UpdateSecurityProfile on L<Paws::IoT>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method UpdateSecurityProfile on the
32 L<AWS IoT|Paws::IoT> service. Use the attributes of this class
33 as arguments to method UpdateSecurityProfile.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateSecurityProfile.
36  
37 =head1 SYNOPSIS
38  
39 my $iot = Paws->service('IoT');
40 my $UpdateSecurityProfileResponse = $iot->UpdateSecurityProfile(
41 SecurityProfileName => 'MySecurityProfileName',
42 AdditionalMetricsToRetain => [ 'MyBehaviorMetric', ... ], # OPTIONAL
43 AdditionalMetricsToRetainV2 => [
44 {
45 Metric => 'MyBehaviorMetric',
46 MetricDimension => {
47 DimensionName => 'MyDimensionName', # min: 1, max: 128
48 Operator => 'IN', # values: IN, NOT_IN; OPTIONAL
49 }, # OPTIONAL
50 },
51 ...
52 ], # OPTIONAL
53 AlertTargets => {
54 'SNS' => {
55 AlertTargetArn => 'MyAlertTargetArn',
56 RoleArn => 'MyRoleArn', # min: 20, max: 2048
57  
58 }, # key: values: SNS
59 }, # OPTIONAL
60 Behaviors => [
61 {
62 Name => 'MyBehaviorName', # min: 1, max: 128
63 Criteria => {
64 ComparisonOperator => 'less-than'
65 , # values: less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set; OPTIONAL
66 ConsecutiveDatapointsToAlarm => 1, # min: 1, max: 10; OPTIONAL
67 ConsecutiveDatapointsToClear => 1, # min: 1, max: 10; OPTIONAL
68 DurationSeconds => 1, # OPTIONAL
69 MlDetectionConfig => {
70 ConfidenceLevel => 'LOW', # values: LOW, MEDIUM, HIGH
71  
72 }, # OPTIONAL
73 StatisticalThreshold => {
74 Statistic => 'MyEvaluationStatistic', # OPTIONAL
75 }, # OPTIONAL
76 Value => {
77 Cidrs => [
78 'MyCidr', ... # min: 2, max: 43
79 ], # OPTIONAL
80 Count => 1, # OPTIONAL
81 Number => 1, # OPTIONAL
82 Numbers => [
83 1, ... # OPTIONAL
84 ], # OPTIONAL
85 Ports => [
86 1, ... # max: 65535
87 ], # OPTIONAL
88 Strings => [ 'MystringValue', ... ], # OPTIONAL
89 }, # OPTIONAL
90 }, # OPTIONAL
91 Metric => 'MyBehaviorMetric',
92 MetricDimension => {
93 DimensionName => 'MyDimensionName', # min: 1, max: 128
94 Operator => 'IN', # values: IN, NOT_IN; OPTIONAL
95 }, # OPTIONAL
96 SuppressAlerts => 1, # OPTIONAL
97 },
98 ...
99 ], # OPTIONAL
100 DeleteAdditionalMetricsToRetain => 1, # OPTIONAL
101 DeleteAlertTargets => 1, # OPTIONAL
102 DeleteBehaviors => 1, # OPTIONAL
103 ExpectedVersion => 1, # OPTIONAL
104 SecurityProfileDescription => 'MySecurityProfileDescription', # OPTIONAL
105 );
106  
107 # Results:
108 my $AdditionalMetricsToRetain =
109 $UpdateSecurityProfileResponse->AdditionalMetricsToRetain;
110 my $AdditionalMetricsToRetainV2 =
111 $UpdateSecurityProfileResponse->AdditionalMetricsToRetainV2;
112 my $AlertTargets = $UpdateSecurityProfileResponse->AlertTargets;
113 my $Behaviors = $UpdateSecurityProfileResponse->Behaviors;
114 my $CreationDate = $UpdateSecurityProfileResponse->CreationDate;
115 my $LastModifiedDate = $UpdateSecurityProfileResponse->LastModifiedDate;
116 my $SecurityProfileArn = $UpdateSecurityProfileResponse->SecurityProfileArn;
117 my $SecurityProfileDescription =
118 $UpdateSecurityProfileResponse->SecurityProfileDescription;
119 my $SecurityProfileName =
120 $UpdateSecurityProfileResponse->SecurityProfileName;
121 my $Version = $UpdateSecurityProfileResponse->Version;
122  
123 # Returns a L<Paws::IoT::UpdateSecurityProfileResponse> object.
124  
125 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.
126 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/UpdateSecurityProfile>
127  
128 =head1 ATTRIBUTES
129  
130  
131 =head2 AdditionalMetricsToRetain => ArrayRef[Str|Undef]
132  
133 I<Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2
134 instead.>
135  
136 A list of metrics whose data is retained (stored). By default, data is
137 retained for any metric used in the profile's C<behaviors>, but it is
138 also retained for any metric specified here. Can be used with custom
139 metrics; cannot be used with dimensions.
140  
141  
142  
143 =head2 AdditionalMetricsToRetainV2 => ArrayRef[L<Paws::IoT::MetricToRetain>]
144  
145 A list of metrics whose data is retained (stored). By default, data is
146 retained for any metric used in the profile's behaviors, but it is also
147 retained for any metric specified here. Can be used with custom
148 metrics; cannot be used with dimensions.
149  
150  
151  
152 =head2 AlertTargets => L<Paws::IoT::AlertTargets>
153  
154 Where the alerts are sent. (Alerts are always sent to the console.)
155  
156  
157  
158 =head2 Behaviors => ArrayRef[L<Paws::IoT::Behavior>]
159  
160 Specifies the behaviors that, when violated by a device (thing), cause
161 an alert.
162  
163  
164  
165 =head2 DeleteAdditionalMetricsToRetain => Bool
166  
167 If true, delete all C<additionalMetricsToRetain> defined for this
168 security profile. If any C<additionalMetricsToRetain> are defined in
169 the current invocation, an exception occurs.
170  
171  
172  
173 =head2 DeleteAlertTargets => Bool
174  
175 If true, delete all C<alertTargets> defined for this security profile.
176 If any C<alertTargets> are defined in the current invocation, an
177 exception occurs.
178  
179  
180  
181 =head2 DeleteBehaviors => Bool
182  
183 If true, delete all C<behaviors> defined for this security profile. If
184 any C<behaviors> are defined in the current invocation, an exception
185 occurs.
186  
187  
188  
189 =head2 ExpectedVersion => Int
190  
191 The expected version of the security profile. A new version is
192 generated whenever the security profile is updated. If you specify a
193 value that is different from the actual version, a
194 C<VersionConflictException> is thrown.
195  
196  
197  
198 =head2 SecurityProfileDescription => Str
199  
200 A description of the security profile.
201  
202  
203  
204 =head2 B<REQUIRED> SecurityProfileName => Str
205  
206 The name of the security profile you want to update.
207  
208  
209  
210  
211 =head1 SEE ALSO
212  
213 This class forms part of L<Paws>, documenting arguments for method UpdateSecurityProfile in L<Paws::IoT>
214  
215 =head1 BUGS and CONTRIBUTIONS
216  
217 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
218  
219 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
220  
221 =cut
222