blib/lib/Paws/WorkMail.pm untested

filter: Statementstmt 0.0% 0 / 337 Branchbran 0.0% 0 / 32 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 69 Podpod 0.0% 0 / 68 totaltotal 0.0% 0 / 506 CC 17 SCAR 15.7
CC
17
Cov
0%
ListAllAliases
12.0
ListAllGroupMembers
12.0
ListAllGroups
12.0
CRAP 4.8
1 package Paws::WorkMail;
2 use Moose;
3 sub service { 'workmail' }
4 sub signing_name { 'workmail' }
5 sub version { '2017-10-01' }
6 sub target_prefix { 'WorkMailService' }
7 sub json_version { "1.1" }
8 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 has retry => (is => 'ro', isa => 'HashRef', default => sub {
10 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 });
12 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
13 ] });
14  
15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 sub AssociateDelegateToResource {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::WorkMail::AssociateDelegateToResource', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub AssociateMemberToGroup {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::WorkMail::AssociateMemberToGroup', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub CancelMailboxExportJob {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::WorkMail::CancelMailboxExportJob', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub CreateAlias {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::WorkMail::CreateAlias', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub CreateGroup {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::WorkMail::CreateGroup', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub CreateMobileDeviceAccessRule {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::WorkMail::CreateMobileDeviceAccessRule', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub CreateOrganization {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::WorkMail::CreateOrganization', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub CreateResource {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::WorkMail::CreateResource', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub CreateUser {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::WorkMail::CreateUser', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub DeleteAccessControlRule {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteAccessControlRule', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub DeleteAlias {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteAlias', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub DeleteGroup {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteGroup', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub DeleteMailboxPermissions {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteMailboxPermissions', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83 sub DeleteMobileDeviceAccessRule {
84 my $self = shift;
85 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteMobileDeviceAccessRule', @_);
86 return $self->caller->do_call($self, $call_object);
87 }
88 sub DeleteOrganization {
89 my $self = shift;
90 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteOrganization', @_);
91 return $self->caller->do_call($self, $call_object);
92 }
93 sub DeleteResource {
94 my $self = shift;
95 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteResource', @_);
96 return $self->caller->do_call($self, $call_object);
97 }
98 sub DeleteRetentionPolicy {
99 my $self = shift;
100 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteRetentionPolicy', @_);
101 return $self->caller->do_call($self, $call_object);
102 }
103 sub DeleteUser {
104 my $self = shift;
105 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeleteUser', @_);
106 return $self->caller->do_call($self, $call_object);
107 }
108 sub DeregisterFromWorkMail {
109 my $self = shift;
110 my $call_object = $self->new_with_coercions('Paws::WorkMail::DeregisterFromWorkMail', @_);
111 return $self->caller->do_call($self, $call_object);
112 }
113 sub DescribeGroup {
114 my $self = shift;
115 my $call_object = $self->new_with_coercions('Paws::WorkMail::DescribeGroup', @_);
116 return $self->caller->do_call($self, $call_object);
117 }
118 sub DescribeMailboxExportJob {
119 my $self = shift;
120 my $call_object = $self->new_with_coercions('Paws::WorkMail::DescribeMailboxExportJob', @_);
121 return $self->caller->do_call($self, $call_object);
122 }
123 sub DescribeOrganization {
124 my $self = shift;
125 my $call_object = $self->new_with_coercions('Paws::WorkMail::DescribeOrganization', @_);
126 return $self->caller->do_call($self, $call_object);
127 }
128 sub DescribeResource {
129 my $self = shift;
130 my $call_object = $self->new_with_coercions('Paws::WorkMail::DescribeResource', @_);
131 return $self->caller->do_call($self, $call_object);
132 }
133 sub DescribeUser {
134 my $self = shift;
135 my $call_object = $self->new_with_coercions('Paws::WorkMail::DescribeUser', @_);
136 return $self->caller->do_call($self, $call_object);
137 }
138 sub DisassociateDelegateFromResource {
139 my $self = shift;
140 my $call_object = $self->new_with_coercions('Paws::WorkMail::DisassociateDelegateFromResource', @_);
141 return $self->caller->do_call($self, $call_object);
142 }
143 sub DisassociateMemberFromGroup {
144 my $self = shift;
145 my $call_object = $self->new_with_coercions('Paws::WorkMail::DisassociateMemberFromGroup', @_);
146 return $self->caller->do_call($self, $call_object);
147 }
148 sub GetAccessControlEffect {
149 my $self = shift;
150 my $call_object = $self->new_with_coercions('Paws::WorkMail::GetAccessControlEffect', @_);
151 return $self->caller->do_call($self, $call_object);
152 }
153 sub GetDefaultRetentionPolicy {
154 my $self = shift;
155 my $call_object = $self->new_with_coercions('Paws::WorkMail::GetDefaultRetentionPolicy', @_);
156 return $self->caller->do_call($self, $call_object);
157 }
158 sub GetMailboxDetails {
159 my $self = shift;
160 my $call_object = $self->new_with_coercions('Paws::WorkMail::GetMailboxDetails', @_);
161 return $self->caller->do_call($self, $call_object);
162 }
163 sub GetMobileDeviceAccessEffect {
164 my $self = shift;
165 my $call_object = $self->new_with_coercions('Paws::WorkMail::GetMobileDeviceAccessEffect', @_);
166 return $self->caller->do_call($self, $call_object);
167 }
168 sub ListAccessControlRules {
169 my $self = shift;
170 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListAccessControlRules', @_);
171 return $self->caller->do_call($self, $call_object);
172 }
173 sub ListAliases {
174 my $self = shift;
175 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListAliases', @_);
176 return $self->caller->do_call($self, $call_object);
177 }
178 sub ListGroupMembers {
179 my $self = shift;
180 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListGroupMembers', @_);
181 return $self->caller->do_call($self, $call_object);
182 }
183 sub ListGroups {
184 my $self = shift;
185 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListGroups', @_);
186 return $self->caller->do_call($self, $call_object);
187 }
188 sub ListMailboxExportJobs {
189 my $self = shift;
190 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListMailboxExportJobs', @_);
191 return $self->caller->do_call($self, $call_object);
192 }
193 sub ListMailboxPermissions {
194 my $self = shift;
195 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListMailboxPermissions', @_);
196 return $self->caller->do_call($self, $call_object);
197 }
198 sub ListMobileDeviceAccessRules {
199 my $self = shift;
200 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListMobileDeviceAccessRules', @_);
201 return $self->caller->do_call($self, $call_object);
202 }
203 sub ListOrganizations {
204 my $self = shift;
205 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListOrganizations', @_);
206 return $self->caller->do_call($self, $call_object);
207 }
208 sub ListResourceDelegates {
209 my $self = shift;
210 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListResourceDelegates', @_);
211 return $self->caller->do_call($self, $call_object);
212 }
213 sub ListResources {
214 my $self = shift;
215 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListResources', @_);
216 return $self->caller->do_call($self, $call_object);
217 }
218 sub ListTagsForResource {
219 my $self = shift;
220 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListTagsForResource', @_);
221 return $self->caller->do_call($self, $call_object);
222 }
223 sub ListUsers {
224 my $self = shift;
225 my $call_object = $self->new_with_coercions('Paws::WorkMail::ListUsers', @_);
226 return $self->caller->do_call($self, $call_object);
227 }
228 sub PutAccessControlRule {
229 my $self = shift;
230 my $call_object = $self->new_with_coercions('Paws::WorkMail::PutAccessControlRule', @_);
231 return $self->caller->do_call($self, $call_object);
232 }
233 sub PutMailboxPermissions {
234 my $self = shift;
235 my $call_object = $self->new_with_coercions('Paws::WorkMail::PutMailboxPermissions', @_);
236 return $self->caller->do_call($self, $call_object);
237 }
238 sub PutRetentionPolicy {
239 my $self = shift;
240 my $call_object = $self->new_with_coercions('Paws::WorkMail::PutRetentionPolicy', @_);
241 return $self->caller->do_call($self, $call_object);
242 }
243 sub RegisterToWorkMail {
244 my $self = shift;
245 my $call_object = $self->new_with_coercions('Paws::WorkMail::RegisterToWorkMail', @_);
246 return $self->caller->do_call($self, $call_object);
247 }
248 sub ResetPassword {
249 my $self = shift;
250 my $call_object = $self->new_with_coercions('Paws::WorkMail::ResetPassword', @_);
251 return $self->caller->do_call($self, $call_object);
252 }
253 sub StartMailboxExportJob {
254 my $self = shift;
255 my $call_object = $self->new_with_coercions('Paws::WorkMail::StartMailboxExportJob', @_);
256 return $self->caller->do_call($self, $call_object);
257 }
258 sub TagResource {
259 my $self = shift;
260 my $call_object = $self->new_with_coercions('Paws::WorkMail::TagResource', @_);
261 return $self->caller->do_call($self, $call_object);
262 }
263 sub UntagResource {
264 my $self = shift;
265 my $call_object = $self->new_with_coercions('Paws::WorkMail::UntagResource', @_);
266 return $self->caller->do_call($self, $call_object);
267 }
268 sub UpdateMailboxQuota {
269 my $self = shift;
270 my $call_object = $self->new_with_coercions('Paws::WorkMail::UpdateMailboxQuota', @_);
271 return $self->caller->do_call($self, $call_object);
272 }
273 sub UpdateMobileDeviceAccessRule {
274 my $self = shift;
275 my $call_object = $self->new_with_coercions('Paws::WorkMail::UpdateMobileDeviceAccessRule', @_);
276 return $self->caller->do_call($self, $call_object);
277 }
278 sub UpdatePrimaryEmailAddress {
279 my $self = shift;
280 my $call_object = $self->new_with_coercions('Paws::WorkMail::UpdatePrimaryEmailAddress', @_);
281 return $self->caller->do_call($self, $call_object);
282 }
283 sub UpdateResource {
284 my $self = shift;
285 my $call_object = $self->new_with_coercions('Paws::WorkMail::UpdateResource', @_);
286 return $self->caller->do_call($self, $call_object);
287 }
288
289 sub ListAllAliases {
290 my $self = shift;
291  
292 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
293 my $result = $self->ListAliases(@_);
294 my $next_result = $result;
295  
296 if (not defined $callback) {
297 while ($next_result->NextToken) {
298 $next_result = $self->ListAliases(@_, NextToken => $next_result->NextToken);
299 push @{ $result->Aliases }, @{ $next_result->Aliases };
300 }
301 return $result;
302 } else {
303 while ($result->NextToken) {
304 $callback->($_ => 'Aliases') foreach (@{ $result->Aliases });
305 $result = $self->ListAliases(@_, NextToken => $result->NextToken);
306 }
307 $callback->($_ => 'Aliases') foreach (@{ $result->Aliases });
308 }
309  
310 return undef
311 }
312 sub ListAllGroupMembers {
313 my $self = shift;
314  
315 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
316 my $result = $self->ListGroupMembers(@_);
317 my $next_result = $result;
318  
319 if (not defined $callback) {
320 while ($next_result->NextToken) {
321 $next_result = $self->ListGroupMembers(@_, NextToken => $next_result->NextToken);
322 push @{ $result->Members }, @{ $next_result->Members };
323 }
324 return $result;
325 } else {
326 while ($result->NextToken) {
327 $callback->($_ => 'Members') foreach (@{ $result->Members });
328 $result = $self->ListGroupMembers(@_, NextToken => $result->NextToken);
329 }
330 $callback->($_ => 'Members') foreach (@{ $result->Members });
331 }
332  
333 return undef
334 }
335 sub ListAllGroups {
336 my $self = shift;
337  
338 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
339 my $result = $self->ListGroups(@_);
340 my $next_result = $result;
341  
342 if (not defined $callback) {
343 while ($next_result->NextToken) {
344 $next_result = $self->ListGroups(@_, NextToken => $next_result->NextToken);
345 push @{ $result->Groups }, @{ $next_result->Groups };
346 }
347 return $result;
348 } else {
349 while ($result->NextToken) {
350 $callback->($_ => 'Groups') foreach (@{ $result->Groups });
351 $result = $self->ListGroups(@_, NextToken => $result->NextToken);
352 }
353 $callback->($_ => 'Groups') foreach (@{ $result->Groups });
354 }
355  
356 return undef
357 }
358 sub ListAllMailboxPermissions {
359 my $self = shift;
360  
361 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
362 my $result = $self->ListMailboxPermissions(@_);
363 my $next_result = $result;
364  
365 if (not defined $callback) {
366 while ($next_result->NextToken) {
367 $next_result = $self->ListMailboxPermissions(@_, NextToken => $next_result->NextToken);
368 push @{ $result->Permissions }, @{ $next_result->Permissions };
369 }
370 return $result;
371 } else {
372 while ($result->NextToken) {
373 $callback->($_ => 'Permissions') foreach (@{ $result->Permissions });
374 $result = $self->ListMailboxPermissions(@_, NextToken => $result->NextToken);
375 }
376 $callback->($_ => 'Permissions') foreach (@{ $result->Permissions });
377 }
378  
379 return undef
380 }
381 sub ListAllOrganizations {
382 my $self = shift;
383  
384 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
385 my $result = $self->ListOrganizations(@_);
386 my $next_result = $result;
387  
388 if (not defined $callback) {
389 while ($next_result->NextToken) {
390 $next_result = $self->ListOrganizations(@_, NextToken => $next_result->NextToken);
391 push @{ $result->OrganizationSummaries }, @{ $next_result->OrganizationSummaries };
392 }
393 return $result;
394 } else {
395 while ($result->NextToken) {
396 $callback->($_ => 'OrganizationSummaries') foreach (@{ $result->OrganizationSummaries });
397 $result = $self->ListOrganizations(@_, NextToken => $result->NextToken);
398 }
399 $callback->($_ => 'OrganizationSummaries') foreach (@{ $result->OrganizationSummaries });
400 }
401  
402 return undef
403 }
404 sub ListAllResourceDelegates {
405 my $self = shift;
406  
407 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
408 my $result = $self->ListResourceDelegates(@_);
409 my $next_result = $result;
410  
411 if (not defined $callback) {
412 while ($next_result->NextToken) {
413 $next_result = $self->ListResourceDelegates(@_, NextToken => $next_result->NextToken);
414 push @{ $result->Delegates }, @{ $next_result->Delegates };
415 }
416 return $result;
417 } else {
418 while ($result->NextToken) {
419 $callback->($_ => 'Delegates') foreach (@{ $result->Delegates });
420 $result = $self->ListResourceDelegates(@_, NextToken => $result->NextToken);
421 }
422 $callback->($_ => 'Delegates') foreach (@{ $result->Delegates });
423 }
424  
425 return undef
426 }
427 sub ListAllResources {
428 my $self = shift;
429  
430 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
431 my $result = $self->ListResources(@_);
432 my $next_result = $result;
433  
434 if (not defined $callback) {
435 while ($next_result->NextToken) {
436 $next_result = $self->ListResources(@_, NextToken => $next_result->NextToken);
437 push @{ $result->Resources }, @{ $next_result->Resources };
438 }
439 return $result;
440 } else {
441 while ($result->NextToken) {
442 $callback->($_ => 'Resources') foreach (@{ $result->Resources });
443 $result = $self->ListResources(@_, NextToken => $result->NextToken);
444 }
445 $callback->($_ => 'Resources') foreach (@{ $result->Resources });
446 }
447  
448 return undef
449 }
450 sub ListAllUsers {
451 my $self = shift;
452  
453 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
454 my $result = $self->ListUsers(@_);
455 my $next_result = $result;
456  
457 if (not defined $callback) {
458 while ($next_result->NextToken) {
459 $next_result = $self->ListUsers(@_, NextToken => $next_result->NextToken);
460 push @{ $result->Users }, @{ $next_result->Users };
461 }
462 return $result;
463 } else {
464 while ($result->NextToken) {
465 $callback->($_ => 'Users') foreach (@{ $result->Users });
466 $result = $self->ListUsers(@_, NextToken => $result->NextToken);
467 }
468 $callback->($_ => 'Users') foreach (@{ $result->Users });
469 }
470  
471 return undef
472 }
473  
474  
475 sub operations { qw/AssociateDelegateToResource AssociateMemberToGroup CancelMailboxExportJob CreateAlias CreateGroup CreateMobileDeviceAccessRule CreateOrganization CreateResource CreateUser DeleteAccessControlRule DeleteAlias DeleteGroup DeleteMailboxPermissions DeleteMobileDeviceAccessRule DeleteOrganization DeleteResource DeleteRetentionPolicy DeleteUser DeregisterFromWorkMail DescribeGroup DescribeMailboxExportJob DescribeOrganization DescribeResource DescribeUser DisassociateDelegateFromResource DisassociateMemberFromGroup GetAccessControlEffect GetDefaultRetentionPolicy GetMailboxDetails GetMobileDeviceAccessEffect ListAccessControlRules ListAliases ListGroupMembers ListGroups ListMailboxExportJobs ListMailboxPermissions ListMobileDeviceAccessRules ListOrganizations ListResourceDelegates ListResources ListTagsForResource ListUsers PutAccessControlRule PutMailboxPermissions PutRetentionPolicy RegisterToWorkMail ResetPassword StartMailboxExportJob TagResource UntagResource UpdateMailboxQuota UpdateMobileDeviceAccessRule UpdatePrimaryEmailAddress UpdateResource / }
476  
477 1;
478  
479 ### main pod documentation begin ###
480  
481 =head1 NAME
482  
483 Paws::WorkMail - Perl Interface to AWS Amazon WorkMail
484  
485 =head1 SYNOPSIS
486  
487 use Paws;
488  
489 my $obj = Paws->service('WorkMail');
490 my $res = $obj->Method(
491 Arg1 => $val1,
492 Arg2 => [ 'V1', 'V2' ],
493 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
494 # of the arguments type
495 Arg3 => { Att1 => 'Val1' },
496 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
497 # the constructor of the arguments type
498 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
499 );
500  
501 =head1 DESCRIPTION
502  
503 Amazon WorkMail is a secure, managed business email and calendaring
504 service with support for existing desktop and mobile email clients. You
505 can access your email, contacts, and calendars using Microsoft Outlook,
506 your browser, or other native iOS and Android email applications. You
507 can integrate WorkMail with your existing corporate directory and
508 control both the keys that encrypt your data and the location in which
509 your data is stored.
510  
511 The WorkMail API is designed for the following scenarios:
512  
513 =over
514  
515 =item *
516  
517 Listing and describing organizations
518  
519 =back
520  
521 =over
522  
523 =item *
524  
525 Managing users
526  
527 =back
528  
529 =over
530  
531 =item *
532  
533 Managing groups
534  
535 =back
536  
537 =over
538  
539 =item *
540  
541 Managing resources
542  
543 =back
544  
545 All WorkMail API operations are Amazon-authenticated and
546 certificate-signed. They not only require the use of the AWS SDK, but
547 also allow for the exclusive use of AWS Identity and Access Management
548 users and roles to help facilitate access, trust, and permission
549 policies. By creating a role and allowing an IAM user to access the
550 WorkMail site, the IAM user gains full administrative visibility into
551 the entire WorkMail organization (or as set in the IAM policy). This
552 includes, but is not limited to, the ability to create, update, and
553 delete users, groups, and resources. This allows developers to perform
554 the scenarios listed above, as well as give users the ability to grant
555 access on a selective basis using the IAM model.
556  
557 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01>
558  
559  
560 =head1 METHODS
561  
562 =head2 AssociateDelegateToResource
563  
564 =over
565  
566 =item EntityId => Str
567  
568 =item OrganizationId => Str
569  
570 =item ResourceId => Str
571  
572  
573 =back
574  
575 Each argument is described in detail in: L<Paws::WorkMail::AssociateDelegateToResource>
576  
577 Returns: a L<Paws::WorkMail::AssociateDelegateToResourceResponse> instance
578  
579 Adds a member (user or group) to the resource's set of delegates.
580  
581  
582 =head2 AssociateMemberToGroup
583  
584 =over
585  
586 =item GroupId => Str
587  
588 =item MemberId => Str
589  
590 =item OrganizationId => Str
591  
592  
593 =back
594  
595 Each argument is described in detail in: L<Paws::WorkMail::AssociateMemberToGroup>
596  
597 Returns: a L<Paws::WorkMail::AssociateMemberToGroupResponse> instance
598  
599 Adds a member (user or group) to the group's set.
600  
601  
602 =head2 CancelMailboxExportJob
603  
604 =over
605  
606 =item ClientToken => Str
607  
608 =item JobId => Str
609  
610 =item OrganizationId => Str
611  
612  
613 =back
614  
615 Each argument is described in detail in: L<Paws::WorkMail::CancelMailboxExportJob>
616  
617 Returns: a L<Paws::WorkMail::CancelMailboxExportJobResponse> instance
618  
619 Cancels a mailbox export job.
620  
621 If the mailbox export job is near completion, it might not be possible
622 to cancel it.
623  
624  
625 =head2 CreateAlias
626  
627 =over
628  
629 =item Alias => Str
630  
631 =item EntityId => Str
632  
633 =item OrganizationId => Str
634  
635  
636 =back
637  
638 Each argument is described in detail in: L<Paws::WorkMail::CreateAlias>
639  
640 Returns: a L<Paws::WorkMail::CreateAliasResponse> instance
641  
642 Adds an alias to the set of a given member (user or group) of Amazon
643 WorkMail.
644  
645  
646 =head2 CreateGroup
647  
648 =over
649  
650 =item Name => Str
651  
652 =item OrganizationId => Str
653  
654  
655 =back
656  
657 Each argument is described in detail in: L<Paws::WorkMail::CreateGroup>
658  
659 Returns: a L<Paws::WorkMail::CreateGroupResponse> instance
660  
661 Creates a group that can be used in Amazon WorkMail by calling the
662 RegisterToWorkMail operation.
663  
664  
665 =head2 CreateMobileDeviceAccessRule
666  
667 =over
668  
669 =item Effect => Str
670  
671 =item Name => Str
672  
673 =item OrganizationId => Str
674  
675 =item [ClientToken => Str]
676  
677 =item [Description => Str]
678  
679 =item [DeviceModels => ArrayRef[Str|Undef]]
680  
681 =item [DeviceOperatingSystems => ArrayRef[Str|Undef]]
682  
683 =item [DeviceTypes => ArrayRef[Str|Undef]]
684  
685 =item [DeviceUserAgents => ArrayRef[Str|Undef]]
686  
687 =item [NotDeviceModels => ArrayRef[Str|Undef]]
688  
689 =item [NotDeviceOperatingSystems => ArrayRef[Str|Undef]]
690  
691 =item [NotDeviceTypes => ArrayRef[Str|Undef]]
692  
693 =item [NotDeviceUserAgents => ArrayRef[Str|Undef]]
694  
695  
696 =back
697  
698 Each argument is described in detail in: L<Paws::WorkMail::CreateMobileDeviceAccessRule>
699  
700 Returns: a L<Paws::WorkMail::CreateMobileDeviceAccessRuleResponse> instance
701  
702 Creates a new mobile device access rule for the specified Amazon
703 WorkMail organization.
704  
705  
706 =head2 CreateOrganization
707  
708 =over
709  
710 =item Alias => Str
711  
712 =item [ClientToken => Str]
713  
714 =item [DirectoryId => Str]
715  
716 =item [Domains => ArrayRef[L<Paws::WorkMail::Domain>]]
717  
718 =item [EnableInteroperability => Bool]
719  
720 =item [KmsKeyArn => Str]
721  
722  
723 =back
724  
725 Each argument is described in detail in: L<Paws::WorkMail::CreateOrganization>
726  
727 Returns: a L<Paws::WorkMail::CreateOrganizationResponse> instance
728  
729 Creates a new Amazon WorkMail organization. Optionally, you can choose
730 to associate an existing AWS Directory Service directory with your
731 organization. If an AWS Directory Service directory ID is specified,
732 the organization alias must match the directory alias. If you choose
733 not to associate an existing directory with your organization, then we
734 create a new Amazon WorkMail directory for you. For more information,
735 see Adding an organization
736 (https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html)
737 in the I<Amazon WorkMail Administrator Guide>.
738  
739 You can associate multiple email domains with an organization, then set
740 your default email domain from the Amazon WorkMail console. You can
741 also associate a domain that is managed in an Amazon Route 53 public
742 hosted zone. For more information, see Adding a domain
743 (https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html)
744 and Choosing the default domain
745 (https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html)
746 in the I<Amazon WorkMail Administrator Guide>.
747  
748 Optionally, you can use a customer managed master key from AWS Key
749 Management Service (AWS KMS) to encrypt email for your organization. If
750 you don't associate an AWS KMS key, Amazon WorkMail creates a default
751 AWS managed master key for you.
752  
753  
754 =head2 CreateResource
755  
756 =over
757  
758 =item Name => Str
759  
760 =item OrganizationId => Str
761  
762 =item Type => Str
763  
764  
765 =back
766  
767 Each argument is described in detail in: L<Paws::WorkMail::CreateResource>
768  
769 Returns: a L<Paws::WorkMail::CreateResourceResponse> instance
770  
771 Creates a new Amazon WorkMail resource.
772  
773  
774 =head2 CreateUser
775  
776 =over
777  
778 =item DisplayName => Str
779  
780 =item Name => Str
781  
782 =item OrganizationId => Str
783  
784 =item Password => Str
785  
786  
787 =back
788  
789 Each argument is described in detail in: L<Paws::WorkMail::CreateUser>
790  
791 Returns: a L<Paws::WorkMail::CreateUserResponse> instance
792  
793 Creates a user who can be used in Amazon WorkMail by calling the
794 RegisterToWorkMail operation.
795  
796  
797 =head2 DeleteAccessControlRule
798  
799 =over
800  
801 =item Name => Str
802  
803 =item OrganizationId => Str
804  
805  
806 =back
807  
808 Each argument is described in detail in: L<Paws::WorkMail::DeleteAccessControlRule>
809  
810 Returns: a L<Paws::WorkMail::DeleteAccessControlRuleResponse> instance
811  
812 Deletes an access control rule for the specified WorkMail organization.
813  
814  
815 =head2 DeleteAlias
816  
817 =over
818  
819 =item Alias => Str
820  
821 =item EntityId => Str
822  
823 =item OrganizationId => Str
824  
825  
826 =back
827  
828 Each argument is described in detail in: L<Paws::WorkMail::DeleteAlias>
829  
830 Returns: a L<Paws::WorkMail::DeleteAliasResponse> instance
831  
832 Remove one or more specified aliases from a set of aliases for a given
833 user.
834  
835  
836 =head2 DeleteGroup
837  
838 =over
839  
840 =item GroupId => Str
841  
842 =item OrganizationId => Str
843  
844  
845 =back
846  
847 Each argument is described in detail in: L<Paws::WorkMail::DeleteGroup>
848  
849 Returns: a L<Paws::WorkMail::DeleteGroupResponse> instance
850  
851 Deletes a group from Amazon WorkMail.
852  
853  
854 =head2 DeleteMailboxPermissions
855  
856 =over
857  
858 =item EntityId => Str
859  
860 =item GranteeId => Str
861  
862 =item OrganizationId => Str
863  
864  
865 =back
866  
867 Each argument is described in detail in: L<Paws::WorkMail::DeleteMailboxPermissions>
868  
869 Returns: a L<Paws::WorkMail::DeleteMailboxPermissionsResponse> instance
870  
871 Deletes permissions granted to a member (user or group).
872  
873  
874 =head2 DeleteMobileDeviceAccessRule
875  
876 =over
877  
878 =item MobileDeviceAccessRuleId => Str
879  
880 =item OrganizationId => Str
881  
882  
883 =back
884  
885 Each argument is described in detail in: L<Paws::WorkMail::DeleteMobileDeviceAccessRule>
886  
887 Returns: a L<Paws::WorkMail::DeleteMobileDeviceAccessRuleResponse> instance
888  
889 Deletes a mobile device access rule for the specified Amazon WorkMail
890 organization.
891  
892  
893 =head2 DeleteOrganization
894  
895 =over
896  
897 =item DeleteDirectory => Bool
898  
899 =item OrganizationId => Str
900  
901 =item [ClientToken => Str]
902  
903  
904 =back
905  
906 Each argument is described in detail in: L<Paws::WorkMail::DeleteOrganization>
907  
908 Returns: a L<Paws::WorkMail::DeleteOrganizationResponse> instance
909  
910 Deletes an Amazon WorkMail organization and all underlying AWS
911 resources managed by Amazon WorkMail as part of the organization. You
912 can choose whether to delete the associated directory. For more
913 information, see Removing an organization
914 (https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html)
915 in the I<Amazon WorkMail Administrator Guide>.
916  
917  
918 =head2 DeleteResource
919  
920 =over
921  
922 =item OrganizationId => Str
923  
924 =item ResourceId => Str
925  
926  
927 =back
928  
929 Each argument is described in detail in: L<Paws::WorkMail::DeleteResource>
930  
931 Returns: a L<Paws::WorkMail::DeleteResourceResponse> instance
932  
933 Deletes the specified resource.
934  
935  
936 =head2 DeleteRetentionPolicy
937  
938 =over
939  
940 =item Id => Str
941  
942 =item OrganizationId => Str
943  
944  
945 =back
946  
947 Each argument is described in detail in: L<Paws::WorkMail::DeleteRetentionPolicy>
948  
949 Returns: a L<Paws::WorkMail::DeleteRetentionPolicyResponse> instance
950  
951 Deletes the specified retention policy from the specified organization.
952  
953  
954 =head2 DeleteUser
955  
956 =over
957  
958 =item OrganizationId => Str
959  
960 =item UserId => Str
961  
962  
963 =back
964  
965 Each argument is described in detail in: L<Paws::WorkMail::DeleteUser>
966  
967 Returns: a L<Paws::WorkMail::DeleteUserResponse> instance
968  
969 Deletes a user from Amazon WorkMail and all subsequent systems. Before
970 you can delete a user, the user state must be C<DISABLED>. Use the
971 DescribeUser action to confirm the user state.
972  
973 Deleting a user is permanent and cannot be undone. WorkMail archives
974 user mailboxes for 30 days before they are permanently removed.
975  
976  
977 =head2 DeregisterFromWorkMail
978  
979 =over
980  
981 =item EntityId => Str
982  
983 =item OrganizationId => Str
984  
985  
986 =back
987  
988 Each argument is described in detail in: L<Paws::WorkMail::DeregisterFromWorkMail>
989  
990 Returns: a L<Paws::WorkMail::DeregisterFromWorkMailResponse> instance
991  
992 Mark a user, group, or resource as no longer used in Amazon WorkMail.
993 This action disassociates the mailbox and schedules it for clean-up.
994 WorkMail keeps mailboxes for 30 days before they are permanently
995 removed. The functionality in the console is I<Disable>.
996  
997  
998 =head2 DescribeGroup
999  
1000 =over
1001  
1002 =item GroupId => Str
1003  
1004 =item OrganizationId => Str
1005  
1006  
1007 =back
1008  
1009 Each argument is described in detail in: L<Paws::WorkMail::DescribeGroup>
1010  
1011 Returns: a L<Paws::WorkMail::DescribeGroupResponse> instance
1012  
1013 Returns the data available for the group.
1014  
1015  
1016 =head2 DescribeMailboxExportJob
1017  
1018 =over
1019  
1020 =item JobId => Str
1021  
1022 =item OrganizationId => Str
1023  
1024  
1025 =back
1026  
1027 Each argument is described in detail in: L<Paws::WorkMail::DescribeMailboxExportJob>
1028  
1029 Returns: a L<Paws::WorkMail::DescribeMailboxExportJobResponse> instance
1030  
1031 Describes the current status of a mailbox export job.
1032  
1033  
1034 =head2 DescribeOrganization
1035  
1036 =over
1037  
1038 =item OrganizationId => Str
1039  
1040  
1041 =back
1042  
1043 Each argument is described in detail in: L<Paws::WorkMail::DescribeOrganization>
1044  
1045 Returns: a L<Paws::WorkMail::DescribeOrganizationResponse> instance
1046  
1047 Provides more information regarding a given organization based on its
1048 identifier.
1049  
1050  
1051 =head2 DescribeResource
1052  
1053 =over
1054  
1055 =item OrganizationId => Str
1056  
1057 =item ResourceId => Str
1058  
1059  
1060 =back
1061  
1062 Each argument is described in detail in: L<Paws::WorkMail::DescribeResource>
1063  
1064 Returns: a L<Paws::WorkMail::DescribeResourceResponse> instance
1065  
1066 Returns the data available for the resource.
1067  
1068  
1069 =head2 DescribeUser
1070  
1071 =over
1072  
1073 =item OrganizationId => Str
1074  
1075 =item UserId => Str
1076  
1077  
1078 =back
1079  
1080 Each argument is described in detail in: L<Paws::WorkMail::DescribeUser>
1081  
1082 Returns: a L<Paws::WorkMail::DescribeUserResponse> instance
1083  
1084 Provides information regarding the user.
1085  
1086  
1087 =head2 DisassociateDelegateFromResource
1088  
1089 =over
1090  
1091 =item EntityId => Str
1092  
1093 =item OrganizationId => Str
1094  
1095 =item ResourceId => Str
1096  
1097  
1098 =back
1099  
1100 Each argument is described in detail in: L<Paws::WorkMail::DisassociateDelegateFromResource>
1101  
1102 Returns: a L<Paws::WorkMail::DisassociateDelegateFromResourceResponse> instance
1103  
1104 Removes a member from the resource's set of delegates.
1105  
1106  
1107 =head2 DisassociateMemberFromGroup
1108  
1109 =over
1110  
1111 =item GroupId => Str
1112  
1113 =item MemberId => Str
1114  
1115 =item OrganizationId => Str
1116  
1117  
1118 =back
1119  
1120 Each argument is described in detail in: L<Paws::WorkMail::DisassociateMemberFromGroup>
1121  
1122 Returns: a L<Paws::WorkMail::DisassociateMemberFromGroupResponse> instance
1123  
1124 Removes a member from a group.
1125  
1126  
1127 =head2 GetAccessControlEffect
1128  
1129 =over
1130  
1131 =item Action => Str
1132  
1133 =item IpAddress => Str
1134  
1135 =item OrganizationId => Str
1136  
1137 =item UserId => Str
1138  
1139  
1140 =back
1141  
1142 Each argument is described in detail in: L<Paws::WorkMail::GetAccessControlEffect>
1143  
1144 Returns: a L<Paws::WorkMail::GetAccessControlEffectResponse> instance
1145  
1146 Gets the effects of an organization's access control rules as they
1147 apply to a specified IPv4 address, access protocol action, or user ID.
1148  
1149  
1150 =head2 GetDefaultRetentionPolicy
1151  
1152 =over
1153  
1154 =item OrganizationId => Str
1155  
1156  
1157 =back
1158  
1159 Each argument is described in detail in: L<Paws::WorkMail::GetDefaultRetentionPolicy>
1160  
1161 Returns: a L<Paws::WorkMail::GetDefaultRetentionPolicyResponse> instance
1162  
1163 Gets the default retention policy details for the specified
1164 organization.
1165  
1166  
1167 =head2 GetMailboxDetails
1168  
1169 =over
1170  
1171 =item OrganizationId => Str
1172  
1173 =item UserId => Str
1174  
1175  
1176 =back
1177  
1178 Each argument is described in detail in: L<Paws::WorkMail::GetMailboxDetails>
1179  
1180 Returns: a L<Paws::WorkMail::GetMailboxDetailsResponse> instance
1181  
1182 Requests a user's mailbox details for a specified organization and
1183 user.
1184  
1185  
1186 =head2 GetMobileDeviceAccessEffect
1187  
1188 =over
1189  
1190 =item OrganizationId => Str
1191  
1192 =item [DeviceModel => Str]
1193  
1194 =item [DeviceOperatingSystem => Str]
1195  
1196 =item [DeviceType => Str]
1197  
1198 =item [DeviceUserAgent => Str]
1199  
1200  
1201 =back
1202  
1203 Each argument is described in detail in: L<Paws::WorkMail::GetMobileDeviceAccessEffect>
1204  
1205 Returns: a L<Paws::WorkMail::GetMobileDeviceAccessEffectResponse> instance
1206  
1207 Simulates the effect of the mobile device access rules for the given
1208 attributes of a sample access event. Use this method to test the
1209 effects of the current set of mobile device access rules for the Amazon
1210 WorkMail organization for a particular user's attributes.
1211  
1212  
1213 =head2 ListAccessControlRules
1214  
1215 =over
1216  
1217 =item OrganizationId => Str
1218  
1219  
1220 =back
1221  
1222 Each argument is described in detail in: L<Paws::WorkMail::ListAccessControlRules>
1223  
1224 Returns: a L<Paws::WorkMail::ListAccessControlRulesResponse> instance
1225  
1226 Lists the access control rules for the specified organization.
1227  
1228  
1229 =head2 ListAliases
1230  
1231 =over
1232  
1233 =item EntityId => Str
1234  
1235 =item OrganizationId => Str
1236  
1237 =item [MaxResults => Int]
1238  
1239 =item [NextToken => Str]
1240  
1241  
1242 =back
1243  
1244 Each argument is described in detail in: L<Paws::WorkMail::ListAliases>
1245  
1246 Returns: a L<Paws::WorkMail::ListAliasesResponse> instance
1247  
1248 Creates a paginated call to list the aliases associated with a given
1249 entity.
1250  
1251  
1252 =head2 ListGroupMembers
1253  
1254 =over
1255  
1256 =item GroupId => Str
1257  
1258 =item OrganizationId => Str
1259  
1260 =item [MaxResults => Int]
1261  
1262 =item [NextToken => Str]
1263  
1264  
1265 =back
1266  
1267 Each argument is described in detail in: L<Paws::WorkMail::ListGroupMembers>
1268  
1269 Returns: a L<Paws::WorkMail::ListGroupMembersResponse> instance
1270  
1271 Returns an overview of the members of a group. Users and groups can be
1272 members of a group.
1273  
1274  
1275 =head2 ListGroups
1276  
1277 =over
1278  
1279 =item OrganizationId => Str
1280  
1281 =item [MaxResults => Int]
1282  
1283 =item [NextToken => Str]
1284  
1285  
1286 =back
1287  
1288 Each argument is described in detail in: L<Paws::WorkMail::ListGroups>
1289  
1290 Returns: a L<Paws::WorkMail::ListGroupsResponse> instance
1291  
1292 Returns summaries of the organization's groups.
1293  
1294  
1295 =head2 ListMailboxExportJobs
1296  
1297 =over
1298  
1299 =item OrganizationId => Str
1300  
1301 =item [MaxResults => Int]
1302  
1303 =item [NextToken => Str]
1304  
1305  
1306 =back
1307  
1308 Each argument is described in detail in: L<Paws::WorkMail::ListMailboxExportJobs>
1309  
1310 Returns: a L<Paws::WorkMail::ListMailboxExportJobsResponse> instance
1311  
1312 Lists the mailbox export jobs started for the specified organization
1313 within the last seven days.
1314  
1315  
1316 =head2 ListMailboxPermissions
1317  
1318 =over
1319  
1320 =item EntityId => Str
1321  
1322 =item OrganizationId => Str
1323  
1324 =item [MaxResults => Int]
1325  
1326 =item [NextToken => Str]
1327  
1328  
1329 =back
1330  
1331 Each argument is described in detail in: L<Paws::WorkMail::ListMailboxPermissions>
1332  
1333 Returns: a L<Paws::WorkMail::ListMailboxPermissionsResponse> instance
1334  
1335 Lists the mailbox permissions associated with a user, group, or
1336 resource mailbox.
1337  
1338  
1339 =head2 ListMobileDeviceAccessRules
1340  
1341 =over
1342  
1343 =item OrganizationId => Str
1344  
1345  
1346 =back
1347  
1348 Each argument is described in detail in: L<Paws::WorkMail::ListMobileDeviceAccessRules>
1349  
1350 Returns: a L<Paws::WorkMail::ListMobileDeviceAccessRulesResponse> instance
1351  
1352 Lists the mobile device access rules for the specified Amazon WorkMail
1353 organization.
1354  
1355  
1356 =head2 ListOrganizations
1357  
1358 =over
1359  
1360 =item [MaxResults => Int]
1361  
1362 =item [NextToken => Str]
1363  
1364  
1365 =back
1366  
1367 Each argument is described in detail in: L<Paws::WorkMail::ListOrganizations>
1368  
1369 Returns: a L<Paws::WorkMail::ListOrganizationsResponse> instance
1370  
1371 Returns summaries of the customer's organizations.
1372  
1373  
1374 =head2 ListResourceDelegates
1375  
1376 =over
1377  
1378 =item OrganizationId => Str
1379  
1380 =item ResourceId => Str
1381  
1382 =item [MaxResults => Int]
1383  
1384 =item [NextToken => Str]
1385  
1386  
1387 =back
1388  
1389 Each argument is described in detail in: L<Paws::WorkMail::ListResourceDelegates>
1390  
1391 Returns: a L<Paws::WorkMail::ListResourceDelegatesResponse> instance
1392  
1393 Lists the delegates associated with a resource. Users and groups can be
1394 resource delegates and answer requests on behalf of the resource.
1395  
1396  
1397 =head2 ListResources
1398  
1399 =over
1400  
1401 =item OrganizationId => Str
1402  
1403 =item [MaxResults => Int]
1404  
1405 =item [NextToken => Str]
1406  
1407  
1408 =back
1409  
1410 Each argument is described in detail in: L<Paws::WorkMail::ListResources>
1411  
1412 Returns: a L<Paws::WorkMail::ListResourcesResponse> instance
1413  
1414 Returns summaries of the organization's resources.
1415  
1416  
1417 =head2 ListTagsForResource
1418  
1419 =over
1420  
1421 =item ResourceARN => Str
1422  
1423  
1424 =back
1425  
1426 Each argument is described in detail in: L<Paws::WorkMail::ListTagsForResource>
1427  
1428 Returns: a L<Paws::WorkMail::ListTagsForResourceResponse> instance
1429  
1430 Lists the tags applied to an Amazon WorkMail organization resource.
1431  
1432  
1433 =head2 ListUsers
1434  
1435 =over
1436  
1437 =item OrganizationId => Str
1438  
1439 =item [MaxResults => Int]
1440  
1441 =item [NextToken => Str]
1442  
1443  
1444 =back
1445  
1446 Each argument is described in detail in: L<Paws::WorkMail::ListUsers>
1447  
1448 Returns: a L<Paws::WorkMail::ListUsersResponse> instance
1449  
1450 Returns summaries of the organization's users.
1451  
1452  
1453 =head2 PutAccessControlRule
1454  
1455 =over
1456  
1457 =item Description => Str
1458  
1459 =item Effect => Str
1460  
1461 =item Name => Str
1462  
1463 =item OrganizationId => Str
1464  
1465 =item [Actions => ArrayRef[Str|Undef]]
1466  
1467 =item [IpRanges => ArrayRef[Str|Undef]]
1468  
1469 =item [NotActions => ArrayRef[Str|Undef]]
1470  
1471 =item [NotIpRanges => ArrayRef[Str|Undef]]
1472  
1473 =item [NotUserIds => ArrayRef[Str|Undef]]
1474  
1475 =item [UserIds => ArrayRef[Str|Undef]]
1476  
1477  
1478 =back
1479  
1480 Each argument is described in detail in: L<Paws::WorkMail::PutAccessControlRule>
1481  
1482 Returns: a L<Paws::WorkMail::PutAccessControlRuleResponse> instance
1483  
1484 Adds a new access control rule for the specified organization. The rule
1485 allows or denies access to the organization for the specified IPv4
1486 addresses, access protocol actions, and user IDs. Adding a new rule
1487 with the same name as an existing rule replaces the older rule.
1488  
1489  
1490 =head2 PutMailboxPermissions
1491  
1492 =over
1493  
1494 =item EntityId => Str
1495  
1496 =item GranteeId => Str
1497  
1498 =item OrganizationId => Str
1499  
1500 =item PermissionValues => ArrayRef[Str|Undef]
1501  
1502  
1503 =back
1504  
1505 Each argument is described in detail in: L<Paws::WorkMail::PutMailboxPermissions>
1506  
1507 Returns: a L<Paws::WorkMail::PutMailboxPermissionsResponse> instance
1508  
1509 Sets permissions for a user, group, or resource. This replaces any
1510 pre-existing permissions.
1511  
1512  
1513 =head2 PutRetentionPolicy
1514  
1515 =over
1516  
1517 =item FolderConfigurations => ArrayRef[L<Paws::WorkMail::FolderConfiguration>]
1518  
1519 =item Name => Str
1520  
1521 =item OrganizationId => Str
1522  
1523 =item [Description => Str]
1524  
1525 =item [Id => Str]
1526  
1527  
1528 =back
1529  
1530 Each argument is described in detail in: L<Paws::WorkMail::PutRetentionPolicy>
1531  
1532 Returns: a L<Paws::WorkMail::PutRetentionPolicyResponse> instance
1533  
1534 Puts a retention policy to the specified organization.
1535  
1536  
1537 =head2 RegisterToWorkMail
1538  
1539 =over
1540  
1541 =item Email => Str
1542  
1543 =item EntityId => Str
1544  
1545 =item OrganizationId => Str
1546  
1547  
1548 =back
1549  
1550 Each argument is described in detail in: L<Paws::WorkMail::RegisterToWorkMail>
1551  
1552 Returns: a L<Paws::WorkMail::RegisterToWorkMailResponse> instance
1553  
1554 Registers an existing and disabled user, group, or resource for Amazon
1555 WorkMail use by associating a mailbox and calendaring capabilities. It
1556 performs no change if the user, group, or resource is enabled and fails
1557 if the user, group, or resource is deleted. This operation results in
1558 the accumulation of costs. For more information, see Pricing
1559 (https://aws.amazon.com/workmail/pricing). The equivalent console
1560 functionality for this operation is I<Enable>.
1561  
1562 Users can either be created by calling the CreateUser API operation or
1563 they can be synchronized from your directory. For more information, see
1564 DeregisterFromWorkMail.
1565  
1566  
1567 =head2 ResetPassword
1568  
1569 =over
1570  
1571 =item OrganizationId => Str
1572  
1573 =item Password => Str
1574  
1575 =item UserId => Str
1576  
1577  
1578 =back
1579  
1580 Each argument is described in detail in: L<Paws::WorkMail::ResetPassword>
1581  
1582 Returns: a L<Paws::WorkMail::ResetPasswordResponse> instance
1583  
1584 Allows the administrator to reset the password for a user.
1585  
1586  
1587 =head2 StartMailboxExportJob
1588  
1589 =over
1590  
1591 =item ClientToken => Str
1592  
1593 =item EntityId => Str
1594  
1595 =item KmsKeyArn => Str
1596  
1597 =item OrganizationId => Str
1598  
1599 =item RoleArn => Str
1600  
1601 =item S3BucketName => Str
1602  
1603 =item S3Prefix => Str
1604  
1605 =item [Description => Str]
1606  
1607  
1608 =back
1609  
1610 Each argument is described in detail in: L<Paws::WorkMail::StartMailboxExportJob>
1611  
1612 Returns: a L<Paws::WorkMail::StartMailboxExportJobResponse> instance
1613  
1614 Starts a mailbox export job to export MIME-format email messages and
1615 calendar items from the specified mailbox to the specified Amazon
1616 Simple Storage Service (Amazon S3) bucket. For more information, see
1617 Exporting mailbox content
1618 (https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html)
1619 in the I<Amazon WorkMail Administrator Guide>.
1620  
1621  
1622 =head2 TagResource
1623  
1624 =over
1625  
1626 =item ResourceARN => Str
1627  
1628 =item Tags => ArrayRef[L<Paws::WorkMail::Tag>]
1629  
1630  
1631 =back
1632  
1633 Each argument is described in detail in: L<Paws::WorkMail::TagResource>
1634  
1635 Returns: a L<Paws::WorkMail::TagResourceResponse> instance
1636  
1637 Applies the specified tags to the specified Amazon WorkMail
1638 organization resource.
1639  
1640  
1641 =head2 UntagResource
1642  
1643 =over
1644  
1645 =item ResourceARN => Str
1646  
1647 =item TagKeys => ArrayRef[Str|Undef]
1648  
1649  
1650 =back
1651  
1652 Each argument is described in detail in: L<Paws::WorkMail::UntagResource>
1653  
1654 Returns: a L<Paws::WorkMail::UntagResourceResponse> instance
1655  
1656 Untags the specified tags from the specified Amazon WorkMail
1657 organization resource.
1658  
1659  
1660 =head2 UpdateMailboxQuota
1661  
1662 =over
1663  
1664 =item MailboxQuota => Int
1665  
1666 =item OrganizationId => Str
1667  
1668 =item UserId => Str
1669  
1670  
1671 =back
1672  
1673 Each argument is described in detail in: L<Paws::WorkMail::UpdateMailboxQuota>
1674  
1675 Returns: a L<Paws::WorkMail::UpdateMailboxQuotaResponse> instance
1676  
1677 Updates a user's current mailbox quota for a specified organization and
1678 user.
1679  
1680  
1681 =head2 UpdateMobileDeviceAccessRule
1682  
1683 =over
1684  
1685 =item Effect => Str
1686  
1687 =item MobileDeviceAccessRuleId => Str
1688  
1689 =item Name => Str
1690  
1691 =item OrganizationId => Str
1692  
1693 =item [Description => Str]
1694  
1695 =item [DeviceModels => ArrayRef[Str|Undef]]
1696  
1697 =item [DeviceOperatingSystems => ArrayRef[Str|Undef]]
1698  
1699 =item [DeviceTypes => ArrayRef[Str|Undef]]
1700  
1701 =item [DeviceUserAgents => ArrayRef[Str|Undef]]
1702  
1703 =item [NotDeviceModels => ArrayRef[Str|Undef]]
1704  
1705 =item [NotDeviceOperatingSystems => ArrayRef[Str|Undef]]
1706  
1707 =item [NotDeviceTypes => ArrayRef[Str|Undef]]
1708  
1709 =item [NotDeviceUserAgents => ArrayRef[Str|Undef]]
1710  
1711  
1712 =back
1713  
1714 Each argument is described in detail in: L<Paws::WorkMail::UpdateMobileDeviceAccessRule>
1715  
1716 Returns: a L<Paws::WorkMail::UpdateMobileDeviceAccessRuleResponse> instance
1717  
1718 Updates a mobile device access rule for the specified Amazon WorkMail
1719 organization.
1720  
1721  
1722 =head2 UpdatePrimaryEmailAddress
1723  
1724 =over
1725  
1726 =item Email => Str
1727  
1728 =item EntityId => Str
1729  
1730 =item OrganizationId => Str
1731  
1732  
1733 =back
1734  
1735 Each argument is described in detail in: L<Paws::WorkMail::UpdatePrimaryEmailAddress>
1736  
1737 Returns: a L<Paws::WorkMail::UpdatePrimaryEmailAddressResponse> instance
1738  
1739 Updates the primary email for a user, group, or resource. The current
1740 email is moved into the list of aliases (or swapped between an existing
1741 alias and the current primary email), and the email provided in the
1742 input is promoted as the primary.
1743  
1744  
1745 =head2 UpdateResource
1746  
1747 =over
1748  
1749 =item OrganizationId => Str
1750  
1751 =item ResourceId => Str
1752  
1753 =item [BookingOptions => L<Paws::WorkMail::BookingOptions>]
1754  
1755 =item [Name => Str]
1756  
1757  
1758 =back
1759  
1760 Each argument is described in detail in: L<Paws::WorkMail::UpdateResource>
1761  
1762 Returns: a L<Paws::WorkMail::UpdateResourceResponse> instance
1763  
1764 Updates data for the resource. To have the latest information, it must
1765 be preceded by a DescribeResource call. The dataset in the request
1766 should be the one expected when performing another C<DescribeResource>
1767 call.
1768  
1769  
1770  
1771  
1772 =head1 PAGINATORS
1773  
1774 Paginator methods are helpers that repetively call methods that return partial results
1775  
1776 =head2 ListAllAliases(sub { },EntityId => Str, OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1777  
1778 =head2 ListAllAliases(EntityId => Str, OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1779  
1780  
1781 If passed a sub as first parameter, it will call the sub for each element found in :
1782  
1783 - Aliases, passing the object as the first parameter, and the string 'Aliases' as the second parameter
1784  
1785 If not, it will return a a L<Paws::WorkMail::ListAliasesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1786  
1787  
1788 =head2 ListAllGroupMembers(sub { },GroupId => Str, OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1789  
1790 =head2 ListAllGroupMembers(GroupId => Str, OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1791  
1792  
1793 If passed a sub as first parameter, it will call the sub for each element found in :
1794  
1795 - Members, passing the object as the first parameter, and the string 'Members' as the second parameter
1796  
1797 If not, it will return a a L<Paws::WorkMail::ListGroupMembersResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1798  
1799  
1800 =head2 ListAllGroups(sub { },OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1801  
1802 =head2 ListAllGroups(OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1803  
1804  
1805 If passed a sub as first parameter, it will call the sub for each element found in :
1806  
1807 - Groups, passing the object as the first parameter, and the string 'Groups' as the second parameter
1808  
1809 If not, it will return a a L<Paws::WorkMail::ListGroupsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1810  
1811  
1812 =head2 ListAllMailboxPermissions(sub { },EntityId => Str, OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1813  
1814 =head2 ListAllMailboxPermissions(EntityId => Str, OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1815  
1816  
1817 If passed a sub as first parameter, it will call the sub for each element found in :
1818  
1819 - Permissions, passing the object as the first parameter, and the string 'Permissions' as the second parameter
1820  
1821 If not, it will return a a L<Paws::WorkMail::ListMailboxPermissionsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1822  
1823  
1824 =head2 ListAllOrganizations(sub { },[MaxResults => Int, NextToken => Str])
1825  
1826 =head2 ListAllOrganizations([MaxResults => Int, NextToken => Str])
1827  
1828  
1829 If passed a sub as first parameter, it will call the sub for each element found in :
1830  
1831 - OrganizationSummaries, passing the object as the first parameter, and the string 'OrganizationSummaries' as the second parameter
1832  
1833 If not, it will return a a L<Paws::WorkMail::ListOrganizationsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1834  
1835  
1836 =head2 ListAllResourceDelegates(sub { },OrganizationId => Str, ResourceId => Str, [MaxResults => Int, NextToken => Str])
1837  
1838 =head2 ListAllResourceDelegates(OrganizationId => Str, ResourceId => Str, [MaxResults => Int, NextToken => Str])
1839  
1840  
1841 If passed a sub as first parameter, it will call the sub for each element found in :
1842  
1843 - Delegates, passing the object as the first parameter, and the string 'Delegates' as the second parameter
1844  
1845 If not, it will return a a L<Paws::WorkMail::ListResourceDelegatesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1846  
1847  
1848 =head2 ListAllResources(sub { },OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1849  
1850 =head2 ListAllResources(OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1851  
1852  
1853 If passed a sub as first parameter, it will call the sub for each element found in :
1854  
1855 - Resources, passing the object as the first parameter, and the string 'Resources' as the second parameter
1856  
1857 If not, it will return a a L<Paws::WorkMail::ListResourcesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1858  
1859  
1860 =head2 ListAllUsers(sub { },OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1861  
1862 =head2 ListAllUsers(OrganizationId => Str, [MaxResults => Int, NextToken => Str])
1863  
1864  
1865 If passed a sub as first parameter, it will call the sub for each element found in :
1866  
1867 - Users, passing the object as the first parameter, and the string 'Users' as the second parameter
1868  
1869 If not, it will return a a L<Paws::WorkMail::ListUsersResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1870  
1871  
1872  
1873  
1874  
1875 =head1 SEE ALSO
1876  
1877 This service class forms part of L<Paws>
1878  
1879 =head1 BUGS and CONTRIBUTIONS
1880  
1881 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
1882  
1883 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
1884  
1885 =cut
1886