blib/lib/Paws/IoTSiteWise/UpdatePortal.pm untested

filter: Statementstmt 0.0% 0 / 28 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 30 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::IoTSiteWise::UpdatePortal;
3 use Moose;
4 has Alarms => (is => 'ro', isa => 'Paws::IoTSiteWise::Alarms', traits => ['NameInRequest'], request_name => 'alarms');
5 has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken');
6 has NotificationSenderEmail => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'notificationSenderEmail');
7 has PortalContactEmail => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalContactEmail', required => 1);
8 has PortalDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalDescription');
9 has PortalId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'portalId', required => 1);
10 has PortalLogoImage => (is => 'ro', isa => 'Paws::IoTSiteWise::Image', traits => ['NameInRequest'], request_name => 'portalLogoImage');
11 has PortalName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'portalName', required => 1);
12 has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn', required => 1);
13  
14 use MooseX::ClassAttribute;
15  
16 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdatePortal');
17 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/portals/{portalId}');
18 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::UpdatePortalResponse');
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::IoTSiteWise::UpdatePortal - Arguments for method UpdatePortal on L<Paws::IoTSiteWise>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method UpdatePortal on the
31 L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class
32 as arguments to method UpdatePortal.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdatePortal.
35  
36 =head1 SYNOPSIS
37  
38 my $iotsitewise = Paws->service('IoTSiteWise');
39 my $UpdatePortalResponse = $iotsitewise->UpdatePortal(
40 PortalContactEmail => 'MyEmail',
41 PortalId => 'MyID',
42 PortalName => 'MyName',
43 RoleArn => 'MyARN',
44 Alarms => {
45 AlarmRoleArn => 'MyARN', # min: 1, max: 1600
46 NotificationLambdaArn => 'MyARN', # min: 1, max: 1600
47 }, # OPTIONAL
48 ClientToken => 'MyClientToken', # OPTIONAL
49 NotificationSenderEmail => 'MyEmail', # OPTIONAL
50 PortalDescription => 'MyDescription', # OPTIONAL
51 PortalLogoImage => {
52 File => {
53 Data => 'BlobImageFileData', # min: 1, max: 1500000
54 Type => 'PNG', # values: PNG
55  
56 }, # OPTIONAL
57 Id => 'MyID', # min: 36, max: 36
58 }, # OPTIONAL
59 );
60  
61 # Results:
62 my $PortalStatus = $UpdatePortalResponse->PortalStatus;
63  
64 # Returns a L<Paws::IoTSiteWise::UpdatePortalResponse> object.
65  
66 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.
67 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/UpdatePortal>
68  
69 =head1 ATTRIBUTES
70  
71  
72 =head2 Alarms => L<Paws::IoTSiteWise::Alarms>
73  
74 Contains the configuration information of an alarm created in an AWS
75 IoT SiteWise Monitor portal. You can use the alarm to monitor an asset
76 property and get notified when the asset property value is outside a
77 specified range. For more information, see .
78  
79  
80  
81 =head2 ClientToken => Str
82  
83 A unique case-sensitive identifier that you can provide to ensure the
84 idempotency of the request. Don't reuse this client token if a new
85 idempotent request is required.
86  
87  
88  
89 =head2 NotificationSenderEmail => Str
90  
91 The email address that sends alarm notifications.
92  
93  
94  
95 =head2 B<REQUIRED> PortalContactEmail => Str
96  
97 The AWS administrator's contact email address.
98  
99  
100  
101 =head2 PortalDescription => Str
102  
103 A new description for the portal.
104  
105  
106  
107 =head2 B<REQUIRED> PortalId => Str
108  
109 The ID of the portal to update.
110  
111  
112  
113 =head2 PortalLogoImage => L<Paws::IoTSiteWise::Image>
114  
115  
116  
117  
118  
119 =head2 B<REQUIRED> PortalName => Str
120  
121 A new friendly name for the portal.
122  
123  
124  
125 =head2 B<REQUIRED> RoleArn => Str
126  
127 The ARN
128 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
129 of a service role that allows the portal's users to access your AWS IoT
130 SiteWise resources on your behalf. For more information, see Using
131 service roles for AWS IoT SiteWise Monitor
132 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
133 in the I<AWS IoT SiteWise User Guide>.
134  
135  
136  
137  
138 =head1 SEE ALSO
139  
140 This class forms part of L<Paws>, documenting arguments for method UpdatePortal in L<Paws::IoTSiteWise>
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