blib/lib/Paws/DS.pm untested

filter: Statementstmt 0.0% 0 / 381 Branchbran 0.0% 0 / 36 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 78 Podpod 0.0% 0 / 77 totaltotal 0.0% 0 / 572 CC 19 SCAR 15.7
CC
19
Cov
0%
DescribeAllDirectories
12.0
DescribeAllDomainControllers
12.0
DescribeAllSharedDirectories
12.0
CRAP 4.8
1 package Paws::DS;
2 use Moose;
3 sub service { 'ds' }
4 sub signing_name { 'ds' }
5 sub version { '2015-04-16' }
6 sub target_prefix { 'DirectoryService_20150416' }
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 AcceptSharedDirectory {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::DS::AcceptSharedDirectory', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub AddIpRoutes {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::DS::AddIpRoutes', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub AddRegion {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::DS::AddRegion', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub AddTagsToResource {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::DS::AddTagsToResource', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub CancelSchemaExtension {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::DS::CancelSchemaExtension', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub ConnectDirectory {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::DS::ConnectDirectory', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub CreateAlias {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::DS::CreateAlias', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub CreateComputer {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::DS::CreateComputer', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub CreateConditionalForwarder {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::DS::CreateConditionalForwarder', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub CreateDirectory {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::DS::CreateDirectory', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub CreateLogSubscription {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::DS::CreateLogSubscription', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub CreateMicrosoftAD {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::DS::CreateMicrosoftAD', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub CreateSnapshot {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::DS::CreateSnapshot', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83 sub CreateTrust {
84 my $self = shift;
85 my $call_object = $self->new_with_coercions('Paws::DS::CreateTrust', @_);
86 return $self->caller->do_call($self, $call_object);
87 }
88 sub DeleteConditionalForwarder {
89 my $self = shift;
90 my $call_object = $self->new_with_coercions('Paws::DS::DeleteConditionalForwarder', @_);
91 return $self->caller->do_call($self, $call_object);
92 }
93 sub DeleteDirectory {
94 my $self = shift;
95 my $call_object = $self->new_with_coercions('Paws::DS::DeleteDirectory', @_);
96 return $self->caller->do_call($self, $call_object);
97 }
98 sub DeleteLogSubscription {
99 my $self = shift;
100 my $call_object = $self->new_with_coercions('Paws::DS::DeleteLogSubscription', @_);
101 return $self->caller->do_call($self, $call_object);
102 }
103 sub DeleteSnapshot {
104 my $self = shift;
105 my $call_object = $self->new_with_coercions('Paws::DS::DeleteSnapshot', @_);
106 return $self->caller->do_call($self, $call_object);
107 }
108 sub DeleteTrust {
109 my $self = shift;
110 my $call_object = $self->new_with_coercions('Paws::DS::DeleteTrust', @_);
111 return $self->caller->do_call($self, $call_object);
112 }
113 sub DeregisterCertificate {
114 my $self = shift;
115 my $call_object = $self->new_with_coercions('Paws::DS::DeregisterCertificate', @_);
116 return $self->caller->do_call($self, $call_object);
117 }
118 sub DeregisterEventTopic {
119 my $self = shift;
120 my $call_object = $self->new_with_coercions('Paws::DS::DeregisterEventTopic', @_);
121 return $self->caller->do_call($self, $call_object);
122 }
123 sub DescribeCertificate {
124 my $self = shift;
125 my $call_object = $self->new_with_coercions('Paws::DS::DescribeCertificate', @_);
126 return $self->caller->do_call($self, $call_object);
127 }
128 sub DescribeConditionalForwarders {
129 my $self = shift;
130 my $call_object = $self->new_with_coercions('Paws::DS::DescribeConditionalForwarders', @_);
131 return $self->caller->do_call($self, $call_object);
132 }
133 sub DescribeDirectories {
134 my $self = shift;
135 my $call_object = $self->new_with_coercions('Paws::DS::DescribeDirectories', @_);
136 return $self->caller->do_call($self, $call_object);
137 }
138 sub DescribeDomainControllers {
139 my $self = shift;
140 my $call_object = $self->new_with_coercions('Paws::DS::DescribeDomainControllers', @_);
141 return $self->caller->do_call($self, $call_object);
142 }
143 sub DescribeEventTopics {
144 my $self = shift;
145 my $call_object = $self->new_with_coercions('Paws::DS::DescribeEventTopics', @_);
146 return $self->caller->do_call($self, $call_object);
147 }
148 sub DescribeLDAPSSettings {
149 my $self = shift;
150 my $call_object = $self->new_with_coercions('Paws::DS::DescribeLDAPSSettings', @_);
151 return $self->caller->do_call($self, $call_object);
152 }
153 sub DescribeRegions {
154 my $self = shift;
155 my $call_object = $self->new_with_coercions('Paws::DS::DescribeRegions', @_);
156 return $self->caller->do_call($self, $call_object);
157 }
158 sub DescribeSharedDirectories {
159 my $self = shift;
160 my $call_object = $self->new_with_coercions('Paws::DS::DescribeSharedDirectories', @_);
161 return $self->caller->do_call($self, $call_object);
162 }
163 sub DescribeSnapshots {
164 my $self = shift;
165 my $call_object = $self->new_with_coercions('Paws::DS::DescribeSnapshots', @_);
166 return $self->caller->do_call($self, $call_object);
167 }
168 sub DescribeTrusts {
169 my $self = shift;
170 my $call_object = $self->new_with_coercions('Paws::DS::DescribeTrusts', @_);
171 return $self->caller->do_call($self, $call_object);
172 }
173 sub DisableClientAuthentication {
174 my $self = shift;
175 my $call_object = $self->new_with_coercions('Paws::DS::DisableClientAuthentication', @_);
176 return $self->caller->do_call($self, $call_object);
177 }
178 sub DisableLDAPS {
179 my $self = shift;
180 my $call_object = $self->new_with_coercions('Paws::DS::DisableLDAPS', @_);
181 return $self->caller->do_call($self, $call_object);
182 }
183 sub DisableRadius {
184 my $self = shift;
185 my $call_object = $self->new_with_coercions('Paws::DS::DisableRadius', @_);
186 return $self->caller->do_call($self, $call_object);
187 }
188 sub DisableSso {
189 my $self = shift;
190 my $call_object = $self->new_with_coercions('Paws::DS::DisableSso', @_);
191 return $self->caller->do_call($self, $call_object);
192 }
193 sub EnableClientAuthentication {
194 my $self = shift;
195 my $call_object = $self->new_with_coercions('Paws::DS::EnableClientAuthentication', @_);
196 return $self->caller->do_call($self, $call_object);
197 }
198 sub EnableLDAPS {
199 my $self = shift;
200 my $call_object = $self->new_with_coercions('Paws::DS::EnableLDAPS', @_);
201 return $self->caller->do_call($self, $call_object);
202 }
203 sub EnableRadius {
204 my $self = shift;
205 my $call_object = $self->new_with_coercions('Paws::DS::EnableRadius', @_);
206 return $self->caller->do_call($self, $call_object);
207 }
208 sub EnableSso {
209 my $self = shift;
210 my $call_object = $self->new_with_coercions('Paws::DS::EnableSso', @_);
211 return $self->caller->do_call($self, $call_object);
212 }
213 sub GetDirectoryLimits {
214 my $self = shift;
215 my $call_object = $self->new_with_coercions('Paws::DS::GetDirectoryLimits', @_);
216 return $self->caller->do_call($self, $call_object);
217 }
218 sub GetSnapshotLimits {
219 my $self = shift;
220 my $call_object = $self->new_with_coercions('Paws::DS::GetSnapshotLimits', @_);
221 return $self->caller->do_call($self, $call_object);
222 }
223 sub ListCertificates {
224 my $self = shift;
225 my $call_object = $self->new_with_coercions('Paws::DS::ListCertificates', @_);
226 return $self->caller->do_call($self, $call_object);
227 }
228 sub ListIpRoutes {
229 my $self = shift;
230 my $call_object = $self->new_with_coercions('Paws::DS::ListIpRoutes', @_);
231 return $self->caller->do_call($self, $call_object);
232 }
233 sub ListLogSubscriptions {
234 my $self = shift;
235 my $call_object = $self->new_with_coercions('Paws::DS::ListLogSubscriptions', @_);
236 return $self->caller->do_call($self, $call_object);
237 }
238 sub ListSchemaExtensions {
239 my $self = shift;
240 my $call_object = $self->new_with_coercions('Paws::DS::ListSchemaExtensions', @_);
241 return $self->caller->do_call($self, $call_object);
242 }
243 sub ListTagsForResource {
244 my $self = shift;
245 my $call_object = $self->new_with_coercions('Paws::DS::ListTagsForResource', @_);
246 return $self->caller->do_call($self, $call_object);
247 }
248 sub RegisterCertificate {
249 my $self = shift;
250 my $call_object = $self->new_with_coercions('Paws::DS::RegisterCertificate', @_);
251 return $self->caller->do_call($self, $call_object);
252 }
253 sub RegisterEventTopic {
254 my $self = shift;
255 my $call_object = $self->new_with_coercions('Paws::DS::RegisterEventTopic', @_);
256 return $self->caller->do_call($self, $call_object);
257 }
258 sub RejectSharedDirectory {
259 my $self = shift;
260 my $call_object = $self->new_with_coercions('Paws::DS::RejectSharedDirectory', @_);
261 return $self->caller->do_call($self, $call_object);
262 }
263 sub RemoveIpRoutes {
264 my $self = shift;
265 my $call_object = $self->new_with_coercions('Paws::DS::RemoveIpRoutes', @_);
266 return $self->caller->do_call($self, $call_object);
267 }
268 sub RemoveRegion {
269 my $self = shift;
270 my $call_object = $self->new_with_coercions('Paws::DS::RemoveRegion', @_);
271 return $self->caller->do_call($self, $call_object);
272 }
273 sub RemoveTagsFromResource {
274 my $self = shift;
275 my $call_object = $self->new_with_coercions('Paws::DS::RemoveTagsFromResource', @_);
276 return $self->caller->do_call($self, $call_object);
277 }
278 sub ResetUserPassword {
279 my $self = shift;
280 my $call_object = $self->new_with_coercions('Paws::DS::ResetUserPassword', @_);
281 return $self->caller->do_call($self, $call_object);
282 }
283 sub RestoreFromSnapshot {
284 my $self = shift;
285 my $call_object = $self->new_with_coercions('Paws::DS::RestoreFromSnapshot', @_);
286 return $self->caller->do_call($self, $call_object);
287 }
288 sub ShareDirectory {
289 my $self = shift;
290 my $call_object = $self->new_with_coercions('Paws::DS::ShareDirectory', @_);
291 return $self->caller->do_call($self, $call_object);
292 }
293 sub StartSchemaExtension {
294 my $self = shift;
295 my $call_object = $self->new_with_coercions('Paws::DS::StartSchemaExtension', @_);
296 return $self->caller->do_call($self, $call_object);
297 }
298 sub UnshareDirectory {
299 my $self = shift;
300 my $call_object = $self->new_with_coercions('Paws::DS::UnshareDirectory', @_);
301 return $self->caller->do_call($self, $call_object);
302 }
303 sub UpdateConditionalForwarder {
304 my $self = shift;
305 my $call_object = $self->new_with_coercions('Paws::DS::UpdateConditionalForwarder', @_);
306 return $self->caller->do_call($self, $call_object);
307 }
308 sub UpdateNumberOfDomainControllers {
309 my $self = shift;
310 my $call_object = $self->new_with_coercions('Paws::DS::UpdateNumberOfDomainControllers', @_);
311 return $self->caller->do_call($self, $call_object);
312 }
313 sub UpdateRadius {
314 my $self = shift;
315 my $call_object = $self->new_with_coercions('Paws::DS::UpdateRadius', @_);
316 return $self->caller->do_call($self, $call_object);
317 }
318 sub UpdateTrust {
319 my $self = shift;
320 my $call_object = $self->new_with_coercions('Paws::DS::UpdateTrust', @_);
321 return $self->caller->do_call($self, $call_object);
322 }
323 sub VerifyTrust {
324 my $self = shift;
325 my $call_object = $self->new_with_coercions('Paws::DS::VerifyTrust', @_);
326 return $self->caller->do_call($self, $call_object);
327 }
328
329 sub DescribeAllDirectories {
330 my $self = shift;
331  
332 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
333 my $result = $self->DescribeDirectories(@_);
334 my $next_result = $result;
335  
336 if (not defined $callback) {
337 while ($next_result->NextToken) {
338 $next_result = $self->DescribeDirectories(@_, NextToken => $next_result->NextToken);
339 push @{ $result->DirectoryDescriptions }, @{ $next_result->DirectoryDescriptions };
340 }
341 return $result;
342 } else {
343 while ($result->NextToken) {
344 $callback->($_ => 'DirectoryDescriptions') foreach (@{ $result->DirectoryDescriptions });
345 $result = $self->DescribeDirectories(@_, NextToken => $result->NextToken);
346 }
347 $callback->($_ => 'DirectoryDescriptions') foreach (@{ $result->DirectoryDescriptions });
348 }
349  
350 return undef
351 }
352 sub DescribeAllDomainControllers {
353 my $self = shift;
354  
355 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
356 my $result = $self->DescribeDomainControllers(@_);
357 my $next_result = $result;
358  
359 if (not defined $callback) {
360 while ($next_result->NextToken) {
361 $next_result = $self->DescribeDomainControllers(@_, NextToken => $next_result->NextToken);
362 push @{ $result->DomainControllers }, @{ $next_result->DomainControllers };
363 }
364 return $result;
365 } else {
366 while ($result->NextToken) {
367 $callback->($_ => 'DomainControllers') foreach (@{ $result->DomainControllers });
368 $result = $self->DescribeDomainControllers(@_, NextToken => $result->NextToken);
369 }
370 $callback->($_ => 'DomainControllers') foreach (@{ $result->DomainControllers });
371 }
372  
373 return undef
374 }
375 sub DescribeAllSharedDirectories {
376 my $self = shift;
377  
378 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
379 my $result = $self->DescribeSharedDirectories(@_);
380 my $next_result = $result;
381  
382 if (not defined $callback) {
383 while ($next_result->NextToken) {
384 $next_result = $self->DescribeSharedDirectories(@_, NextToken => $next_result->NextToken);
385 push @{ $result->SharedDirectories }, @{ $next_result->SharedDirectories };
386 }
387 return $result;
388 } else {
389 while ($result->NextToken) {
390 $callback->($_ => 'SharedDirectories') foreach (@{ $result->SharedDirectories });
391 $result = $self->DescribeSharedDirectories(@_, NextToken => $result->NextToken);
392 }
393 $callback->($_ => 'SharedDirectories') foreach (@{ $result->SharedDirectories });
394 }
395  
396 return undef
397 }
398 sub DescribeAllSnapshots {
399 my $self = shift;
400  
401 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
402 my $result = $self->DescribeSnapshots(@_);
403 my $next_result = $result;
404  
405 if (not defined $callback) {
406 while ($next_result->NextToken) {
407 $next_result = $self->DescribeSnapshots(@_, NextToken => $next_result->NextToken);
408 push @{ $result->Snapshots }, @{ $next_result->Snapshots };
409 }
410 return $result;
411 } else {
412 while ($result->NextToken) {
413 $callback->($_ => 'Snapshots') foreach (@{ $result->Snapshots });
414 $result = $self->DescribeSnapshots(@_, NextToken => $result->NextToken);
415 }
416 $callback->($_ => 'Snapshots') foreach (@{ $result->Snapshots });
417 }
418  
419 return undef
420 }
421 sub DescribeAllTrusts {
422 my $self = shift;
423  
424 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
425 my $result = $self->DescribeTrusts(@_);
426 my $next_result = $result;
427  
428 if (not defined $callback) {
429 while ($next_result->NextToken) {
430 $next_result = $self->DescribeTrusts(@_, NextToken => $next_result->NextToken);
431 push @{ $result->Trusts }, @{ $next_result->Trusts };
432 }
433 return $result;
434 } else {
435 while ($result->NextToken) {
436 $callback->($_ => 'Trusts') foreach (@{ $result->Trusts });
437 $result = $self->DescribeTrusts(@_, NextToken => $result->NextToken);
438 }
439 $callback->($_ => 'Trusts') foreach (@{ $result->Trusts });
440 }
441  
442 return undef
443 }
444 sub ListAllIpRoutes {
445 my $self = shift;
446  
447 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
448 my $result = $self->ListIpRoutes(@_);
449 my $next_result = $result;
450  
451 if (not defined $callback) {
452 while ($next_result->NextToken) {
453 $next_result = $self->ListIpRoutes(@_, NextToken => $next_result->NextToken);
454 push @{ $result->IpRoutesInfo }, @{ $next_result->IpRoutesInfo };
455 }
456 return $result;
457 } else {
458 while ($result->NextToken) {
459 $callback->($_ => 'IpRoutesInfo') foreach (@{ $result->IpRoutesInfo });
460 $result = $self->ListIpRoutes(@_, NextToken => $result->NextToken);
461 }
462 $callback->($_ => 'IpRoutesInfo') foreach (@{ $result->IpRoutesInfo });
463 }
464  
465 return undef
466 }
467 sub ListAllLogSubscriptions {
468 my $self = shift;
469  
470 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
471 my $result = $self->ListLogSubscriptions(@_);
472 my $next_result = $result;
473  
474 if (not defined $callback) {
475 while ($next_result->NextToken) {
476 $next_result = $self->ListLogSubscriptions(@_, NextToken => $next_result->NextToken);
477 push @{ $result->LogSubscriptions }, @{ $next_result->LogSubscriptions };
478 }
479 return $result;
480 } else {
481 while ($result->NextToken) {
482 $callback->($_ => 'LogSubscriptions') foreach (@{ $result->LogSubscriptions });
483 $result = $self->ListLogSubscriptions(@_, NextToken => $result->NextToken);
484 }
485 $callback->($_ => 'LogSubscriptions') foreach (@{ $result->LogSubscriptions });
486 }
487  
488 return undef
489 }
490 sub ListAllSchemaExtensions {
491 my $self = shift;
492  
493 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
494 my $result = $self->ListSchemaExtensions(@_);
495 my $next_result = $result;
496  
497 if (not defined $callback) {
498 while ($next_result->NextToken) {
499 $next_result = $self->ListSchemaExtensions(@_, NextToken => $next_result->NextToken);
500 push @{ $result->SchemaExtensionsInfo }, @{ $next_result->SchemaExtensionsInfo };
501 }
502 return $result;
503 } else {
504 while ($result->NextToken) {
505 $callback->($_ => 'SchemaExtensionsInfo') foreach (@{ $result->SchemaExtensionsInfo });
506 $result = $self->ListSchemaExtensions(@_, NextToken => $result->NextToken);
507 }
508 $callback->($_ => 'SchemaExtensionsInfo') foreach (@{ $result->SchemaExtensionsInfo });
509 }
510  
511 return undef
512 }
513 sub ListAllTagsForResource {
514 my $self = shift;
515  
516 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
517 my $result = $self->ListTagsForResource(@_);
518 my $next_result = $result;
519  
520 if (not defined $callback) {
521 while ($next_result->NextToken) {
522 $next_result = $self->ListTagsForResource(@_, NextToken => $next_result->NextToken);
523 push @{ $result->Tags }, @{ $next_result->Tags };
524 }
525 return $result;
526 } else {
527 while ($result->NextToken) {
528 $callback->($_ => 'Tags') foreach (@{ $result->Tags });
529 $result = $self->ListTagsForResource(@_, NextToken => $result->NextToken);
530 }
531 $callback->($_ => 'Tags') foreach (@{ $result->Tags });
532 }
533  
534 return undef
535 }
536  
537  
538 sub operations { qw/AcceptSharedDirectory AddIpRoutes AddRegion AddTagsToResource CancelSchemaExtension ConnectDirectory CreateAlias CreateComputer CreateConditionalForwarder CreateDirectory CreateLogSubscription CreateMicrosoftAD CreateSnapshot CreateTrust DeleteConditionalForwarder DeleteDirectory DeleteLogSubscription DeleteSnapshot DeleteTrust DeregisterCertificate DeregisterEventTopic DescribeCertificate DescribeConditionalForwarders DescribeDirectories DescribeDomainControllers DescribeEventTopics DescribeLDAPSSettings DescribeRegions DescribeSharedDirectories DescribeSnapshots DescribeTrusts DisableClientAuthentication DisableLDAPS DisableRadius DisableSso EnableClientAuthentication EnableLDAPS EnableRadius EnableSso GetDirectoryLimits GetSnapshotLimits ListCertificates ListIpRoutes ListLogSubscriptions ListSchemaExtensions ListTagsForResource RegisterCertificate RegisterEventTopic RejectSharedDirectory RemoveIpRoutes RemoveRegion RemoveTagsFromResource ResetUserPassword RestoreFromSnapshot ShareDirectory StartSchemaExtension UnshareDirectory UpdateConditionalForwarder UpdateNumberOfDomainControllers UpdateRadius UpdateTrust VerifyTrust / }
539  
540 1;
541  
542 ### main pod documentation begin ###
543  
544 =head1 NAME
545  
546 Paws::DS - Perl Interface to AWS AWS Directory Service
547  
548 =head1 SYNOPSIS
549  
550 use Paws;
551  
552 my $obj = Paws->service('DS');
553 my $res = $obj->Method(
554 Arg1 => $val1,
555 Arg2 => [ 'V1', 'V2' ],
556 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
557 # of the arguments type
558 Arg3 => { Att1 => 'Val1' },
559 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
560 # the constructor of the arguments type
561 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
562 );
563  
564 =head1 DESCRIPTION
565  
566 AWS Directory Service
567  
568 AWS Directory Service is a web service that makes it easy for you to
569 setup and run directories in the AWS cloud, or connect your AWS
570 resources with an existing on-premises Microsoft Active Directory. This
571 guide provides detailed information about AWS Directory Service
572 operations, data types, parameters, and errors. For information about
573 AWS Directory Services features, see AWS Directory Service
574 (https://aws.amazon.com/directoryservice/) and the AWS Directory
575 Service Administration Guide
576 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html).
577  
578 AWS provides SDKs that consist of libraries and sample code for various
579 programming languages and platforms (Java, Ruby, .Net, iOS, Android,
580 etc.). The SDKs provide a convenient way to create programmatic access
581 to AWS Directory Service and other AWS services. For more information
582 about the AWS SDKs, including how to download and install them, see
583 Tools for Amazon Web Services (http://aws.amazon.com/tools/).
584  
585 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16>
586  
587  
588 =head1 METHODS
589  
590 =head2 AcceptSharedDirectory
591  
592 =over
593  
594 =item SharedDirectoryId => Str
595  
596  
597 =back
598  
599 Each argument is described in detail in: L<Paws::DS::AcceptSharedDirectory>
600  
601 Returns: a L<Paws::DS::AcceptSharedDirectoryResult> instance
602  
603 Accepts a directory sharing request that was sent from the directory
604 owner account.
605  
606  
607 =head2 AddIpRoutes
608  
609 =over
610  
611 =item DirectoryId => Str
612  
613 =item IpRoutes => ArrayRef[L<Paws::DS::IpRoute>]
614  
615 =item [UpdateSecurityGroupForDirectoryControllers => Bool]
616  
617  
618 =back
619  
620 Each argument is described in detail in: L<Paws::DS::AddIpRoutes>
621  
622 Returns: a L<Paws::DS::AddIpRoutesResult> instance
623  
624 If the DNS server for your on-premises domain uses a publicly
625 addressable IP address, you must add a CIDR address block to correctly
626 route traffic to and from your Microsoft AD on Amazon Web Services.
627 I<AddIpRoutes> adds this address block. You can also use I<AddIpRoutes>
628 to facilitate routing traffic that uses public IP ranges from your
629 Microsoft AD on AWS to a peer VPC.
630  
631 Before you call I<AddIpRoutes>, ensure that all of the required
632 permissions have been explicitly granted through a policy. For details
633 about what permissions are required to run the I<AddIpRoutes>
634 operation, see AWS Directory Service API Permissions: Actions,
635 Resources, and Conditions Reference
636 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).
637  
638  
639 =head2 AddRegion
640  
641 =over
642  
643 =item DirectoryId => Str
644  
645 =item RegionName => Str
646  
647 =item VPCSettings => L<Paws::DS::DirectoryVpcSettings>
648  
649  
650 =back
651  
652 Each argument is described in detail in: L<Paws::DS::AddRegion>
653  
654 Returns: a L<Paws::DS::AddRegionResult> instance
655  
656 Adds two domain controllers in the specified Region for the specified
657 directory.
658  
659  
660 =head2 AddTagsToResource
661  
662 =over
663  
664 =item ResourceId => Str
665  
666 =item Tags => ArrayRef[L<Paws::DS::Tag>]
667  
668  
669 =back
670  
671 Each argument is described in detail in: L<Paws::DS::AddTagsToResource>
672  
673 Returns: a L<Paws::DS::AddTagsToResourceResult> instance
674  
675 Adds or overwrites one or more tags for the specified directory. Each
676 directory can have a maximum of 50 tags. Each tag consists of a key and
677 optional value. Tag keys must be unique to each resource.
678  
679  
680 =head2 CancelSchemaExtension
681  
682 =over
683  
684 =item DirectoryId => Str
685  
686 =item SchemaExtensionId => Str
687  
688  
689 =back
690  
691 Each argument is described in detail in: L<Paws::DS::CancelSchemaExtension>
692  
693 Returns: a L<Paws::DS::CancelSchemaExtensionResult> instance
694  
695 Cancels an in-progress schema extension to a Microsoft AD directory.
696 Once a schema extension has started replicating to all domain
697 controllers, the task can no longer be canceled. A schema extension can
698 be canceled during any of the following states; C<Initializing>,
699 C<CreatingSnapshot>, and C<UpdatingSchema>.
700  
701  
702 =head2 ConnectDirectory
703  
704 =over
705  
706 =item ConnectSettings => L<Paws::DS::DirectoryConnectSettings>
707  
708 =item Name => Str
709  
710 =item Password => Str
711  
712 =item Size => Str
713  
714 =item [Description => Str]
715  
716 =item [ShortName => Str]
717  
718 =item [Tags => ArrayRef[L<Paws::DS::Tag>]]
719  
720  
721 =back
722  
723 Each argument is described in detail in: L<Paws::DS::ConnectDirectory>
724  
725 Returns: a L<Paws::DS::ConnectDirectoryResult> instance
726  
727 Creates an AD Connector to connect to an on-premises directory.
728  
729 Before you call C<ConnectDirectory>, ensure that all of the required
730 permissions have been explicitly granted through a policy. For details
731 about what permissions are required to run the C<ConnectDirectory>
732 operation, see AWS Directory Service API Permissions: Actions,
733 Resources, and Conditions Reference
734 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).
735  
736  
737 =head2 CreateAlias
738  
739 =over
740  
741 =item Alias => Str
742  
743 =item DirectoryId => Str
744  
745  
746 =back
747  
748 Each argument is described in detail in: L<Paws::DS::CreateAlias>
749  
750 Returns: a L<Paws::DS::CreateAliasResult> instance
751  
752 Creates an alias for a directory and assigns the alias to the
753 directory. The alias is used to construct the access URL for the
754 directory, such as C<http://E<lt>aliasE<gt>.awsapps.com>.
755  
756 After an alias has been created, it cannot be deleted or reused, so
757 this operation should only be used when absolutely necessary.
758  
759  
760 =head2 CreateComputer
761  
762 =over
763  
764 =item ComputerName => Str
765  
766 =item DirectoryId => Str
767  
768 =item Password => Str
769  
770 =item [ComputerAttributes => ArrayRef[L<Paws::DS::Attribute>]]
771  
772 =item [OrganizationalUnitDistinguishedName => Str]
773  
774  
775 =back
776  
777 Each argument is described in detail in: L<Paws::DS::CreateComputer>
778  
779 Returns: a L<Paws::DS::CreateComputerResult> instance
780  
781 Creates an Active Directory computer object in the specified directory.
782  
783  
784 =head2 CreateConditionalForwarder
785  
786 =over
787  
788 =item DirectoryId => Str
789  
790 =item DnsIpAddrs => ArrayRef[Str|Undef]
791  
792 =item RemoteDomainName => Str
793  
794  
795 =back
796  
797 Each argument is described in detail in: L<Paws::DS::CreateConditionalForwarder>
798  
799 Returns: a L<Paws::DS::CreateConditionalForwarderResult> instance
800  
801 Creates a conditional forwarder associated with your AWS directory.
802 Conditional forwarders are required in order to set up a trust
803 relationship with another domain. The conditional forwarder points to
804 the trusted domain.
805  
806  
807 =head2 CreateDirectory
808  
809 =over
810  
811 =item Name => Str
812  
813 =item Password => Str
814  
815 =item Size => Str
816  
817 =item [Description => Str]
818  
819 =item [ShortName => Str]
820  
821 =item [Tags => ArrayRef[L<Paws::DS::Tag>]]
822  
823 =item [VpcSettings => L<Paws::DS::DirectoryVpcSettings>]
824  
825  
826 =back
827  
828 Each argument is described in detail in: L<Paws::DS::CreateDirectory>
829  
830 Returns: a L<Paws::DS::CreateDirectoryResult> instance
831  
832 Creates a Simple AD directory. For more information, see Simple Active
833 Directory
834 (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html)
835 in the I<AWS Directory Service Admin Guide>.
836  
837 Before you call C<CreateDirectory>, ensure that all of the required
838 permissions have been explicitly granted through a policy. For details
839 about what permissions are required to run the C<CreateDirectory>
840 operation, see AWS Directory Service API Permissions: Actions,
841 Resources, and Conditions Reference
842 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).
843  
844  
845 =head2 CreateLogSubscription
846  
847 =over
848  
849 =item DirectoryId => Str
850  
851 =item LogGroupName => Str
852  
853  
854 =back
855  
856 Each argument is described in detail in: L<Paws::DS::CreateLogSubscription>
857  
858 Returns: a L<Paws::DS::CreateLogSubscriptionResult> instance
859  
860 Creates a subscription to forward real-time Directory Service domain
861 controller security logs to the specified Amazon CloudWatch log group
862 in your AWS account.
863  
864  
865 =head2 CreateMicrosoftAD
866  
867 =over
868  
869 =item Name => Str
870  
871 =item Password => Str
872  
873 =item VpcSettings => L<Paws::DS::DirectoryVpcSettings>
874  
875 =item [Description => Str]
876  
877 =item [Edition => Str]
878  
879 =item [ShortName => Str]
880  
881 =item [Tags => ArrayRef[L<Paws::DS::Tag>]]
882  
883  
884 =back
885  
886 Each argument is described in detail in: L<Paws::DS::CreateMicrosoftAD>
887  
888 Returns: a L<Paws::DS::CreateMicrosoftADResult> instance
889  
890 Creates a Microsoft AD directory in the AWS Cloud. For more
891 information, see AWS Managed Microsoft AD
892 (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html)
893 in the I<AWS Directory Service Admin Guide>.
894  
895 Before you call I<CreateMicrosoftAD>, ensure that all of the required
896 permissions have been explicitly granted through a policy. For details
897 about what permissions are required to run the I<CreateMicrosoftAD>
898 operation, see AWS Directory Service API Permissions: Actions,
899 Resources, and Conditions Reference
900 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).
901  
902  
903 =head2 CreateSnapshot
904  
905 =over
906  
907 =item DirectoryId => Str
908  
909 =item [Name => Str]
910  
911  
912 =back
913  
914 Each argument is described in detail in: L<Paws::DS::CreateSnapshot>
915  
916 Returns: a L<Paws::DS::CreateSnapshotResult> instance
917  
918 Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS
919 cloud.
920  
921 You cannot take snapshots of AD Connector directories.
922  
923  
924 =head2 CreateTrust
925  
926 =over
927  
928 =item DirectoryId => Str
929  
930 =item RemoteDomainName => Str
931  
932 =item TrustDirection => Str
933  
934 =item TrustPassword => Str
935  
936 =item [ConditionalForwarderIpAddrs => ArrayRef[Str|Undef]]
937  
938 =item [SelectiveAuth => Str]
939  
940 =item [TrustType => Str]
941  
942  
943 =back
944  
945 Each argument is described in detail in: L<Paws::DS::CreateTrust>
946  
947 Returns: a L<Paws::DS::CreateTrustResult> instance
948  
949 AWS Directory Service for Microsoft Active Directory allows you to
950 configure trust relationships. For example, you can establish a trust
951 between your AWS Managed Microsoft AD directory, and your existing
952 on-premises Microsoft Active Directory. This would allow you to provide
953 users and groups access to resources in either domain, with a single
954 set of credentials.
955  
956 This action initiates the creation of the AWS side of a trust
957 relationship between an AWS Managed Microsoft AD directory and an
958 external domain. You can create either a forest trust or an external
959 trust.
960  
961  
962 =head2 DeleteConditionalForwarder
963  
964 =over
965  
966 =item DirectoryId => Str
967  
968 =item RemoteDomainName => Str
969  
970  
971 =back
972  
973 Each argument is described in detail in: L<Paws::DS::DeleteConditionalForwarder>
974  
975 Returns: a L<Paws::DS::DeleteConditionalForwarderResult> instance
976  
977 Deletes a conditional forwarder that has been set up for your AWS
978 directory.
979  
980  
981 =head2 DeleteDirectory
982  
983 =over
984  
985 =item DirectoryId => Str
986  
987  
988 =back
989  
990 Each argument is described in detail in: L<Paws::DS::DeleteDirectory>
991  
992 Returns: a L<Paws::DS::DeleteDirectoryResult> instance
993  
994 Deletes an AWS Directory Service directory.
995  
996 Before you call C<DeleteDirectory>, ensure that all of the required
997 permissions have been explicitly granted through a policy. For details
998 about what permissions are required to run the C<DeleteDirectory>
999 operation, see AWS Directory Service API Permissions: Actions,
1000 Resources, and Conditions Reference
1001 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).
1002  
1003  
1004 =head2 DeleteLogSubscription
1005  
1006 =over
1007  
1008 =item DirectoryId => Str
1009  
1010  
1011 =back
1012  
1013 Each argument is described in detail in: L<Paws::DS::DeleteLogSubscription>
1014  
1015 Returns: a L<Paws::DS::DeleteLogSubscriptionResult> instance
1016  
1017 Deletes the specified log subscription.
1018  
1019  
1020 =head2 DeleteSnapshot
1021  
1022 =over
1023  
1024 =item SnapshotId => Str
1025  
1026  
1027 =back
1028  
1029 Each argument is described in detail in: L<Paws::DS::DeleteSnapshot>
1030  
1031 Returns: a L<Paws::DS::DeleteSnapshotResult> instance
1032  
1033 Deletes a directory snapshot.
1034  
1035  
1036 =head2 DeleteTrust
1037  
1038 =over
1039  
1040 =item TrustId => Str
1041  
1042 =item [DeleteAssociatedConditionalForwarder => Bool]
1043  
1044  
1045 =back
1046  
1047 Each argument is described in detail in: L<Paws::DS::DeleteTrust>
1048  
1049 Returns: a L<Paws::DS::DeleteTrustResult> instance
1050  
1051 Deletes an existing trust relationship between your AWS Managed
1052 Microsoft AD directory and an external domain.
1053  
1054  
1055 =head2 DeregisterCertificate
1056  
1057 =over
1058  
1059 =item CertificateId => Str
1060  
1061 =item DirectoryId => Str
1062  
1063  
1064 =back
1065  
1066 Each argument is described in detail in: L<Paws::DS::DeregisterCertificate>
1067  
1068 Returns: a L<Paws::DS::DeregisterCertificateResult> instance
1069  
1070 Deletes from the system the certificate that was registered for secure
1071 LDAP or client certificate authentication.
1072  
1073  
1074 =head2 DeregisterEventTopic
1075  
1076 =over
1077  
1078 =item DirectoryId => Str
1079  
1080 =item TopicName => Str
1081  
1082  
1083 =back
1084  
1085 Each argument is described in detail in: L<Paws::DS::DeregisterEventTopic>
1086  
1087 Returns: a L<Paws::DS::DeregisterEventTopicResult> instance
1088  
1089 Removes the specified directory as a publisher to the specified SNS
1090 topic.
1091  
1092  
1093 =head2 DescribeCertificate
1094  
1095 =over
1096  
1097 =item CertificateId => Str
1098  
1099 =item DirectoryId => Str
1100  
1101  
1102 =back
1103  
1104 Each argument is described in detail in: L<Paws::DS::DescribeCertificate>
1105  
1106 Returns: a L<Paws::DS::DescribeCertificateResult> instance
1107  
1108 Displays information about the certificate registered for secure LDAP
1109 or client certificate authentication.
1110  
1111  
1112 =head2 DescribeConditionalForwarders
1113  
1114 =over
1115  
1116 =item DirectoryId => Str
1117  
1118 =item [RemoteDomainNames => ArrayRef[Str|Undef]]
1119  
1120  
1121 =back
1122  
1123 Each argument is described in detail in: L<Paws::DS::DescribeConditionalForwarders>
1124  
1125 Returns: a L<Paws::DS::DescribeConditionalForwardersResult> instance
1126  
1127 Obtains information about the conditional forwarders for this account.
1128  
1129 If no input parameters are provided for RemoteDomainNames, this request
1130 describes all conditional forwarders for the specified directory ID.
1131  
1132  
1133 =head2 DescribeDirectories
1134  
1135 =over
1136  
1137 =item [DirectoryIds => ArrayRef[Str|Undef]]
1138  
1139 =item [Limit => Int]
1140  
1141 =item [NextToken => Str]
1142  
1143  
1144 =back
1145  
1146 Each argument is described in detail in: L<Paws::DS::DescribeDirectories>
1147  
1148 Returns: a L<Paws::DS::DescribeDirectoriesResult> instance
1149  
1150 Obtains information about the directories that belong to this account.
1151  
1152 You can retrieve information about specific directories by passing the
1153 directory identifiers in the C<DirectoryIds> parameter. Otherwise, all
1154 directories that belong to the current account are returned.
1155  
1156 This operation supports pagination with the use of the C<NextToken>
1157 request and response parameters. If more results are available, the
1158 C<DescribeDirectoriesResult.NextToken> member contains a token that you
1159 pass in the next call to DescribeDirectories to retrieve the next set
1160 of items.
1161  
1162 You can also specify a maximum number of return results with the
1163 C<Limit> parameter.
1164  
1165  
1166 =head2 DescribeDomainControllers
1167  
1168 =over
1169  
1170 =item DirectoryId => Str
1171  
1172 =item [DomainControllerIds => ArrayRef[Str|Undef]]
1173  
1174 =item [Limit => Int]
1175  
1176 =item [NextToken => Str]
1177  
1178  
1179 =back
1180  
1181 Each argument is described in detail in: L<Paws::DS::DescribeDomainControllers>
1182  
1183 Returns: a L<Paws::DS::DescribeDomainControllersResult> instance
1184  
1185 Provides information about any domain controllers in your directory.
1186  
1187  
1188 =head2 DescribeEventTopics
1189  
1190 =over
1191  
1192 =item [DirectoryId => Str]
1193  
1194 =item [TopicNames => ArrayRef[Str|Undef]]
1195  
1196  
1197 =back
1198  
1199 Each argument is described in detail in: L<Paws::DS::DescribeEventTopics>
1200  
1201 Returns: a L<Paws::DS::DescribeEventTopicsResult> instance
1202  
1203 Obtains information about which SNS topics receive status messages from
1204 the specified directory.
1205  
1206 If no input parameters are provided, such as DirectoryId or TopicName,
1207 this request describes all of the associations in the account.
1208  
1209  
1210 =head2 DescribeLDAPSSettings
1211  
1212 =over
1213  
1214 =item DirectoryId => Str
1215  
1216 =item [Limit => Int]
1217  
1218 =item [NextToken => Str]
1219  
1220 =item [Type => Str]
1221  
1222  
1223 =back
1224  
1225 Each argument is described in detail in: L<Paws::DS::DescribeLDAPSSettings>
1226  
1227 Returns: a L<Paws::DS::DescribeLDAPSSettingsResult> instance
1228  
1229 Describes the status of LDAP security for the specified directory.
1230  
1231  
1232 =head2 DescribeRegions
1233  
1234 =over
1235  
1236 =item DirectoryId => Str
1237  
1238 =item [NextToken => Str]
1239  
1240 =item [RegionName => Str]
1241  
1242  
1243 =back
1244  
1245 Each argument is described in detail in: L<Paws::DS::DescribeRegions>
1246  
1247 Returns: a L<Paws::DS::DescribeRegionsResult> instance
1248  
1249 Provides information about the Regions that are configured for
1250 multi-Region replication.
1251  
1252  
1253 =head2 DescribeSharedDirectories
1254  
1255 =over
1256  
1257 =item OwnerDirectoryId => Str
1258  
1259 =item [Limit => Int]
1260  
1261 =item [NextToken => Str]
1262  
1263 =item [SharedDirectoryIds => ArrayRef[Str|Undef]]
1264  
1265  
1266 =back
1267  
1268 Each argument is described in detail in: L<Paws::DS::DescribeSharedDirectories>
1269  
1270 Returns: a L<Paws::DS::DescribeSharedDirectoriesResult> instance
1271  
1272 Returns the shared directories in your account.
1273  
1274  
1275 =head2 DescribeSnapshots
1276  
1277 =over
1278  
1279 =item [DirectoryId => Str]
1280  
1281 =item [Limit => Int]
1282  
1283 =item [NextToken => Str]
1284  
1285 =item [SnapshotIds => ArrayRef[Str|Undef]]
1286  
1287  
1288 =back
1289  
1290 Each argument is described in detail in: L<Paws::DS::DescribeSnapshots>
1291  
1292 Returns: a L<Paws::DS::DescribeSnapshotsResult> instance
1293  
1294 Obtains information about the directory snapshots that belong to this
1295 account.
1296  
1297 This operation supports pagination with the use of the I<NextToken>
1298 request and response parameters. If more results are available, the
1299 I<DescribeSnapshots.NextToken> member contains a token that you pass in
1300 the next call to DescribeSnapshots to retrieve the next set of items.
1301  
1302 You can also specify a maximum number of return results with the
1303 I<Limit> parameter.
1304  
1305  
1306 =head2 DescribeTrusts
1307  
1308 =over
1309  
1310 =item [DirectoryId => Str]
1311  
1312 =item [Limit => Int]
1313  
1314 =item [NextToken => Str]
1315  
1316 =item [TrustIds => ArrayRef[Str|Undef]]
1317  
1318  
1319 =back
1320  
1321 Each argument is described in detail in: L<Paws::DS::DescribeTrusts>
1322  
1323 Returns: a L<Paws::DS::DescribeTrustsResult> instance
1324  
1325 Obtains information about the trust relationships for this account.
1326  
1327 If no input parameters are provided, such as DirectoryId or TrustIds,
1328 this request describes all the trust relationships belonging to the
1329 account.
1330  
1331  
1332 =head2 DisableClientAuthentication
1333  
1334 =over
1335  
1336 =item DirectoryId => Str
1337  
1338 =item Type => Str
1339  
1340  
1341 =back
1342  
1343 Each argument is described in detail in: L<Paws::DS::DisableClientAuthentication>
1344  
1345 Returns: a L<Paws::DS::DisableClientAuthenticationResult> instance
1346  
1347 Disables alternative client authentication methods for the specified
1348 directory.
1349  
1350  
1351 =head2 DisableLDAPS
1352  
1353 =over
1354  
1355 =item DirectoryId => Str
1356  
1357 =item Type => Str
1358  
1359  
1360 =back
1361  
1362 Each argument is described in detail in: L<Paws::DS::DisableLDAPS>
1363  
1364 Returns: a L<Paws::DS::DisableLDAPSResult> instance
1365  
1366 Deactivates LDAP secure calls for the specified directory.
1367  
1368  
1369 =head2 DisableRadius
1370  
1371 =over
1372  
1373 =item DirectoryId => Str
1374  
1375  
1376 =back
1377  
1378 Each argument is described in detail in: L<Paws::DS::DisableRadius>
1379  
1380 Returns: a L<Paws::DS::DisableRadiusResult> instance
1381  
1382 Disables multi-factor authentication (MFA) with the Remote
1383 Authentication Dial In User Service (RADIUS) server for an AD Connector
1384 or Microsoft AD directory.
1385  
1386  
1387 =head2 DisableSso
1388  
1389 =over
1390  
1391 =item DirectoryId => Str
1392  
1393 =item [Password => Str]
1394  
1395 =item [UserName => Str]
1396  
1397  
1398 =back
1399  
1400 Each argument is described in detail in: L<Paws::DS::DisableSso>
1401  
1402 Returns: a L<Paws::DS::DisableSsoResult> instance
1403  
1404 Disables single-sign on for a directory.
1405  
1406  
1407 =head2 EnableClientAuthentication
1408  
1409 =over
1410  
1411 =item DirectoryId => Str
1412  
1413 =item Type => Str
1414  
1415  
1416 =back
1417  
1418 Each argument is described in detail in: L<Paws::DS::EnableClientAuthentication>
1419  
1420 Returns: a L<Paws::DS::EnableClientAuthenticationResult> instance
1421  
1422 Enables alternative client authentication methods for the specified
1423 directory.
1424  
1425  
1426 =head2 EnableLDAPS
1427  
1428 =over
1429  
1430 =item DirectoryId => Str
1431  
1432 =item Type => Str
1433  
1434  
1435 =back
1436  
1437 Each argument is described in detail in: L<Paws::DS::EnableLDAPS>
1438  
1439 Returns: a L<Paws::DS::EnableLDAPSResult> instance
1440  
1441 Activates the switch for the specific directory to always use LDAP
1442 secure calls.
1443  
1444  
1445 =head2 EnableRadius
1446  
1447 =over
1448  
1449 =item DirectoryId => Str
1450  
1451 =item RadiusSettings => L<Paws::DS::RadiusSettings>
1452  
1453  
1454 =back
1455  
1456 Each argument is described in detail in: L<Paws::DS::EnableRadius>
1457  
1458 Returns: a L<Paws::DS::EnableRadiusResult> instance
1459  
1460 Enables multi-factor authentication (MFA) with the Remote
1461 Authentication Dial In User Service (RADIUS) server for an AD Connector
1462 or Microsoft AD directory.
1463  
1464  
1465 =head2 EnableSso
1466  
1467 =over
1468  
1469 =item DirectoryId => Str
1470  
1471 =item [Password => Str]
1472  
1473 =item [UserName => Str]
1474  
1475  
1476 =back
1477  
1478 Each argument is described in detail in: L<Paws::DS::EnableSso>
1479  
1480 Returns: a L<Paws::DS::EnableSsoResult> instance
1481  
1482 Enables single sign-on for a directory. Single sign-on allows users in
1483 your directory to access certain AWS services from a computer joined to
1484 the directory without having to enter their credentials separately.
1485  
1486  
1487 =head2 GetDirectoryLimits
1488  
1489  
1490  
1491  
1492  
1493  
1494 Each argument is described in detail in: L<Paws::DS::GetDirectoryLimits>
1495  
1496 Returns: a L<Paws::DS::GetDirectoryLimitsResult> instance
1497  
1498 Obtains directory limit information for the current Region.
1499  
1500  
1501 =head2 GetSnapshotLimits
1502  
1503 =over
1504  
1505 =item DirectoryId => Str
1506  
1507  
1508 =back
1509  
1510 Each argument is described in detail in: L<Paws::DS::GetSnapshotLimits>
1511  
1512 Returns: a L<Paws::DS::GetSnapshotLimitsResult> instance
1513  
1514 Obtains the manual snapshot limits for a directory.
1515  
1516  
1517 =head2 ListCertificates
1518  
1519 =over
1520  
1521 =item DirectoryId => Str
1522  
1523 =item [Limit => Int]
1524  
1525 =item [NextToken => Str]
1526  
1527  
1528 =back
1529  
1530 Each argument is described in detail in: L<Paws::DS::ListCertificates>
1531  
1532 Returns: a L<Paws::DS::ListCertificatesResult> instance
1533  
1534 For the specified directory, lists all the certificates registered for
1535 a secure LDAP or client certificate authentication.
1536  
1537  
1538 =head2 ListIpRoutes
1539  
1540 =over
1541  
1542 =item DirectoryId => Str
1543  
1544 =item [Limit => Int]
1545  
1546 =item [NextToken => Str]
1547  
1548  
1549 =back
1550  
1551 Each argument is described in detail in: L<Paws::DS::ListIpRoutes>
1552  
1553 Returns: a L<Paws::DS::ListIpRoutesResult> instance
1554  
1555 Lists the address blocks that you have added to a directory.
1556  
1557  
1558 =head2 ListLogSubscriptions
1559  
1560 =over
1561  
1562 =item [DirectoryId => Str]
1563  
1564 =item [Limit => Int]
1565  
1566 =item [NextToken => Str]
1567  
1568  
1569 =back
1570  
1571 Each argument is described in detail in: L<Paws::DS::ListLogSubscriptions>
1572  
1573 Returns: a L<Paws::DS::ListLogSubscriptionsResult> instance
1574  
1575 Lists the active log subscriptions for the AWS account.
1576  
1577  
1578 =head2 ListSchemaExtensions
1579  
1580 =over
1581  
1582 =item DirectoryId => Str
1583  
1584 =item [Limit => Int]
1585  
1586 =item [NextToken => Str]
1587  
1588  
1589 =back
1590  
1591 Each argument is described in detail in: L<Paws::DS::ListSchemaExtensions>
1592  
1593 Returns: a L<Paws::DS::ListSchemaExtensionsResult> instance
1594  
1595 Lists all schema extensions applied to a Microsoft AD Directory.
1596  
1597  
1598 =head2 ListTagsForResource
1599  
1600 =over
1601  
1602 =item ResourceId => Str
1603  
1604 =item [Limit => Int]
1605  
1606 =item [NextToken => Str]
1607  
1608  
1609 =back
1610  
1611 Each argument is described in detail in: L<Paws::DS::ListTagsForResource>
1612  
1613 Returns: a L<Paws::DS::ListTagsForResourceResult> instance
1614  
1615 Lists all tags on a directory.
1616  
1617  
1618 =head2 RegisterCertificate
1619  
1620 =over
1621  
1622 =item CertificateData => Str
1623  
1624 =item DirectoryId => Str
1625  
1626 =item [ClientCertAuthSettings => L<Paws::DS::ClientCertAuthSettings>]
1627  
1628 =item [Type => Str]
1629  
1630  
1631 =back
1632  
1633 Each argument is described in detail in: L<Paws::DS::RegisterCertificate>
1634  
1635 Returns: a L<Paws::DS::RegisterCertificateResult> instance
1636  
1637 Registers a certificate for a secure LDAP or client certificate
1638 authentication.
1639  
1640  
1641 =head2 RegisterEventTopic
1642  
1643 =over
1644  
1645 =item DirectoryId => Str
1646  
1647 =item TopicName => Str
1648  
1649  
1650 =back
1651  
1652 Each argument is described in detail in: L<Paws::DS::RegisterEventTopic>
1653  
1654 Returns: a L<Paws::DS::RegisterEventTopicResult> instance
1655  
1656 Associates a directory with an SNS topic. This establishes the
1657 directory as a publisher to the specified SNS topic. You can then
1658 receive email or text (SMS) messages when the status of your directory
1659 changes. You get notified if your directory goes from an Active status
1660 to an Impaired or Inoperable status. You also receive a notification
1661 when the directory returns to an Active status.
1662  
1663  
1664 =head2 RejectSharedDirectory
1665  
1666 =over
1667  
1668 =item SharedDirectoryId => Str
1669  
1670  
1671 =back
1672  
1673 Each argument is described in detail in: L<Paws::DS::RejectSharedDirectory>
1674  
1675 Returns: a L<Paws::DS::RejectSharedDirectoryResult> instance
1676  
1677 Rejects a directory sharing request that was sent from the directory
1678 owner account.
1679  
1680  
1681 =head2 RemoveIpRoutes
1682  
1683 =over
1684  
1685 =item CidrIps => ArrayRef[Str|Undef]
1686  
1687 =item DirectoryId => Str
1688  
1689  
1690 =back
1691  
1692 Each argument is described in detail in: L<Paws::DS::RemoveIpRoutes>
1693  
1694 Returns: a L<Paws::DS::RemoveIpRoutesResult> instance
1695  
1696 Removes IP address blocks from a directory.
1697  
1698  
1699 =head2 RemoveRegion
1700  
1701 =over
1702  
1703 =item DirectoryId => Str
1704  
1705  
1706 =back
1707  
1708 Each argument is described in detail in: L<Paws::DS::RemoveRegion>
1709  
1710 Returns: a L<Paws::DS::RemoveRegionResult> instance
1711  
1712 Stops all replication and removes the domain controllers from the
1713 specified Region. You cannot remove the primary Region with this
1714 operation. Instead, use the C<DeleteDirectory> API.
1715  
1716  
1717 =head2 RemoveTagsFromResource
1718  
1719 =over
1720  
1721 =item ResourceId => Str
1722  
1723 =item TagKeys => ArrayRef[Str|Undef]
1724  
1725  
1726 =back
1727  
1728 Each argument is described in detail in: L<Paws::DS::RemoveTagsFromResource>
1729  
1730 Returns: a L<Paws::DS::RemoveTagsFromResourceResult> instance
1731  
1732 Removes tags from a directory.
1733  
1734  
1735 =head2 ResetUserPassword
1736  
1737 =over
1738  
1739 =item DirectoryId => Str
1740  
1741 =item NewPassword => Str
1742  
1743 =item UserName => Str
1744  
1745  
1746 =back
1747  
1748 Each argument is described in detail in: L<Paws::DS::ResetUserPassword>
1749  
1750 Returns: a L<Paws::DS::ResetUserPasswordResult> instance
1751  
1752 Resets the password for any user in your AWS Managed Microsoft AD or
1753 Simple AD directory.
1754  
1755 You can reset the password for any user in your directory with the
1756 following exceptions:
1757  
1758 =over
1759  
1760 =item *
1761  
1762 For Simple AD, you cannot reset the password for any user that is a
1763 member of either the B<Domain Admins> or B<Enterprise Admins> group
1764 except for the administrator user.
1765  
1766 =item *
1767  
1768 For AWS Managed Microsoft AD, you can only reset the password for a
1769 user that is in an OU based off of the NetBIOS name that you typed when
1770 you created your directory. For example, you cannot reset the password
1771 for a user in the B<AWS Reserved> OU. For more information about the OU
1772 structure for an AWS Managed Microsoft AD directory, see What Gets
1773 Created
1774 (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html)
1775 in the I<AWS Directory Service Administration Guide>.
1776  
1777 =back
1778  
1779  
1780  
1781 =head2 RestoreFromSnapshot
1782  
1783 =over
1784  
1785 =item SnapshotId => Str
1786  
1787  
1788 =back
1789  
1790 Each argument is described in detail in: L<Paws::DS::RestoreFromSnapshot>
1791  
1792 Returns: a L<Paws::DS::RestoreFromSnapshotResult> instance
1793  
1794 Restores a directory using an existing directory snapshot.
1795  
1796 When you restore a directory from a snapshot, any changes made to the
1797 directory after the snapshot date are overwritten.
1798  
1799 This action returns as soon as the restore operation is initiated. You
1800 can monitor the progress of the restore operation by calling the
1801 DescribeDirectories operation with the directory identifier. When the
1802 B<DirectoryDescription.Stage> value changes to C<Active>, the restore
1803 operation is complete.
1804  
1805  
1806 =head2 ShareDirectory
1807  
1808 =over
1809  
1810 =item DirectoryId => Str
1811  
1812 =item ShareMethod => Str
1813  
1814 =item ShareTarget => L<Paws::DS::ShareTarget>
1815  
1816 =item [ShareNotes => Str]
1817  
1818  
1819 =back
1820  
1821 Each argument is described in detail in: L<Paws::DS::ShareDirectory>
1822  
1823 Returns: a L<Paws::DS::ShareDirectoryResult> instance
1824  
1825 Shares a specified directory (C<DirectoryId>) in your AWS account
1826 (directory owner) with another AWS account (directory consumer). With
1827 this operation you can use your directory from any AWS account and from
1828 any Amazon VPC within an AWS Region.
1829  
1830 When you share your AWS Managed Microsoft AD directory, AWS Directory
1831 Service creates a shared directory in the directory consumer account.
1832 This shared directory contains the metadata to provide access to the
1833 directory within the directory owner account. The shared directory is
1834 visible in all VPCs in the directory consumer account.
1835  
1836 The C<ShareMethod> parameter determines whether the specified directory
1837 can be shared between AWS accounts inside the same AWS organization
1838 (C<ORGANIZATIONS>). It also determines whether you can share the
1839 directory with any other AWS account either inside or outside of the
1840 organization (C<HANDSHAKE>).
1841  
1842 The C<ShareNotes> parameter is only used when C<HANDSHAKE> is called,
1843 which sends a directory sharing request to the directory consumer.
1844  
1845  
1846 =head2 StartSchemaExtension
1847  
1848 =over
1849  
1850 =item CreateSnapshotBeforeSchemaExtension => Bool
1851  
1852 =item Description => Str
1853  
1854 =item DirectoryId => Str
1855  
1856 =item LdifContent => Str
1857  
1858  
1859 =back
1860  
1861 Each argument is described in detail in: L<Paws::DS::StartSchemaExtension>
1862  
1863 Returns: a L<Paws::DS::StartSchemaExtensionResult> instance
1864  
1865 Applies a schema extension to a Microsoft AD directory.
1866  
1867  
1868 =head2 UnshareDirectory
1869  
1870 =over
1871  
1872 =item DirectoryId => Str
1873  
1874 =item UnshareTarget => L<Paws::DS::UnshareTarget>
1875  
1876  
1877 =back
1878  
1879 Each argument is described in detail in: L<Paws::DS::UnshareDirectory>
1880  
1881 Returns: a L<Paws::DS::UnshareDirectoryResult> instance
1882  
1883 Stops the directory sharing between the directory owner and consumer
1884 accounts.
1885  
1886  
1887 =head2 UpdateConditionalForwarder
1888  
1889 =over
1890  
1891 =item DirectoryId => Str
1892  
1893 =item DnsIpAddrs => ArrayRef[Str|Undef]
1894  
1895 =item RemoteDomainName => Str
1896  
1897  
1898 =back
1899  
1900 Each argument is described in detail in: L<Paws::DS::UpdateConditionalForwarder>
1901  
1902 Returns: a L<Paws::DS::UpdateConditionalForwarderResult> instance
1903  
1904 Updates a conditional forwarder that has been set up for your AWS
1905 directory.
1906  
1907  
1908 =head2 UpdateNumberOfDomainControllers
1909  
1910 =over
1911  
1912 =item DesiredNumber => Int
1913  
1914 =item DirectoryId => Str
1915  
1916  
1917 =back
1918  
1919 Each argument is described in detail in: L<Paws::DS::UpdateNumberOfDomainControllers>
1920  
1921 Returns: a L<Paws::DS::UpdateNumberOfDomainControllersResult> instance
1922  
1923 Adds or removes domain controllers to or from the directory. Based on
1924 the difference between current value and new value (provided through
1925 this API call), domain controllers will be added or removed. It may
1926 take up to 45 minutes for any new domain controllers to become fully
1927 active once the requested number of domain controllers is updated.
1928 During this time, you cannot make another update request.
1929  
1930  
1931 =head2 UpdateRadius
1932  
1933 =over
1934  
1935 =item DirectoryId => Str
1936  
1937 =item RadiusSettings => L<Paws::DS::RadiusSettings>
1938  
1939  
1940 =back
1941  
1942 Each argument is described in detail in: L<Paws::DS::UpdateRadius>
1943  
1944 Returns: a L<Paws::DS::UpdateRadiusResult> instance
1945  
1946 Updates the Remote Authentication Dial In User Service (RADIUS) server
1947 information for an AD Connector or Microsoft AD directory.
1948  
1949  
1950 =head2 UpdateTrust
1951  
1952 =over
1953  
1954 =item TrustId => Str
1955  
1956 =item [SelectiveAuth => Str]
1957  
1958  
1959 =back
1960  
1961 Each argument is described in detail in: L<Paws::DS::UpdateTrust>
1962  
1963 Returns: a L<Paws::DS::UpdateTrustResult> instance
1964  
1965 Updates the trust that has been set up between your AWS Managed
1966 Microsoft AD directory and an on-premises Active Directory.
1967  
1968  
1969 =head2 VerifyTrust
1970  
1971 =over
1972  
1973 =item TrustId => Str
1974  
1975  
1976 =back
1977  
1978 Each argument is described in detail in: L<Paws::DS::VerifyTrust>
1979  
1980 Returns: a L<Paws::DS::VerifyTrustResult> instance
1981  
1982 AWS Directory Service for Microsoft Active Directory allows you to
1983 configure and verify trust relationships.
1984  
1985 This action verifies a trust relationship between your AWS Managed
1986 Microsoft AD directory and an external domain.
1987  
1988  
1989  
1990  
1991 =head1 PAGINATORS
1992  
1993 Paginator methods are helpers that repetively call methods that return partial results
1994  
1995 =head2 DescribeAllDirectories(sub { },[DirectoryIds => ArrayRef[Str|Undef], Limit => Int, NextToken => Str])
1996  
1997 =head2 DescribeAllDirectories([DirectoryIds => ArrayRef[Str|Undef], Limit => Int, NextToken => Str])
1998  
1999  
2000 If passed a sub as first parameter, it will call the sub for each element found in :
2001  
2002 - DirectoryDescriptions, passing the object as the first parameter, and the string 'DirectoryDescriptions' as the second parameter
2003  
2004 If not, it will return a a L<Paws::DS::DescribeDirectoriesResult> 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.
2005  
2006  
2007 =head2 DescribeAllDomainControllers(sub { },DirectoryId => Str, [DomainControllerIds => ArrayRef[Str|Undef], Limit => Int, NextToken => Str])
2008  
2009 =head2 DescribeAllDomainControllers(DirectoryId => Str, [DomainControllerIds => ArrayRef[Str|Undef], Limit => Int, NextToken => Str])
2010  
2011  
2012 If passed a sub as first parameter, it will call the sub for each element found in :
2013  
2014 - DomainControllers, passing the object as the first parameter, and the string 'DomainControllers' as the second parameter
2015  
2016 If not, it will return a a L<Paws::DS::DescribeDomainControllersResult> 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.
2017  
2018  
2019 =head2 DescribeAllSharedDirectories(sub { },OwnerDirectoryId => Str, [Limit => Int, NextToken => Str, SharedDirectoryIds => ArrayRef[Str|Undef]])
2020  
2021 =head2 DescribeAllSharedDirectories(OwnerDirectoryId => Str, [Limit => Int, NextToken => Str, SharedDirectoryIds => ArrayRef[Str|Undef]])
2022  
2023  
2024 If passed a sub as first parameter, it will call the sub for each element found in :
2025  
2026 - SharedDirectories, passing the object as the first parameter, and the string 'SharedDirectories' as the second parameter
2027  
2028 If not, it will return a a L<Paws::DS::DescribeSharedDirectoriesResult> 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.
2029  
2030  
2031 =head2 DescribeAllSnapshots(sub { },[DirectoryId => Str, Limit => Int, NextToken => Str, SnapshotIds => ArrayRef[Str|Undef]])
2032  
2033 =head2 DescribeAllSnapshots([DirectoryId => Str, Limit => Int, NextToken => Str, SnapshotIds => ArrayRef[Str|Undef]])
2034  
2035  
2036 If passed a sub as first parameter, it will call the sub for each element found in :
2037  
2038 - Snapshots, passing the object as the first parameter, and the string 'Snapshots' as the second parameter
2039  
2040 If not, it will return a a L<Paws::DS::DescribeSnapshotsResult> 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.
2041  
2042  
2043 =head2 DescribeAllTrusts(sub { },[DirectoryId => Str, Limit => Int, NextToken => Str, TrustIds => ArrayRef[Str|Undef]])
2044  
2045 =head2 DescribeAllTrusts([DirectoryId => Str, Limit => Int, NextToken => Str, TrustIds => ArrayRef[Str|Undef]])
2046  
2047  
2048 If passed a sub as first parameter, it will call the sub for each element found in :
2049  
2050 - Trusts, passing the object as the first parameter, and the string 'Trusts' as the second parameter
2051  
2052 If not, it will return a a L<Paws::DS::DescribeTrustsResult> 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.
2053  
2054  
2055 =head2 ListAllIpRoutes(sub { },DirectoryId => Str, [Limit => Int, NextToken => Str])
2056  
2057 =head2 ListAllIpRoutes(DirectoryId => Str, [Limit => Int, NextToken => Str])
2058  
2059  
2060 If passed a sub as first parameter, it will call the sub for each element found in :
2061  
2062 - IpRoutesInfo, passing the object as the first parameter, and the string 'IpRoutesInfo' as the second parameter
2063  
2064 If not, it will return a a L<Paws::DS::ListIpRoutesResult> 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.
2065  
2066  
2067 =head2 ListAllLogSubscriptions(sub { },[DirectoryId => Str, Limit => Int, NextToken => Str])
2068  
2069 =head2 ListAllLogSubscriptions([DirectoryId => Str, Limit => Int, NextToken => Str])
2070  
2071  
2072 If passed a sub as first parameter, it will call the sub for each element found in :
2073  
2074 - LogSubscriptions, passing the object as the first parameter, and the string 'LogSubscriptions' as the second parameter
2075  
2076 If not, it will return a a L<Paws::DS::ListLogSubscriptionsResult> 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.
2077  
2078  
2079 =head2 ListAllSchemaExtensions(sub { },DirectoryId => Str, [Limit => Int, NextToken => Str])
2080  
2081 =head2 ListAllSchemaExtensions(DirectoryId => Str, [Limit => Int, NextToken => Str])
2082  
2083  
2084 If passed a sub as first parameter, it will call the sub for each element found in :
2085  
2086 - SchemaExtensionsInfo, passing the object as the first parameter, and the string 'SchemaExtensionsInfo' as the second parameter
2087  
2088 If not, it will return a a L<Paws::DS::ListSchemaExtensionsResult> 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.
2089  
2090  
2091 =head2 ListAllTagsForResource(sub { },ResourceId => Str, [Limit => Int, NextToken => Str])
2092  
2093 =head2 ListAllTagsForResource(ResourceId => Str, [Limit => Int, NextToken => Str])
2094  
2095  
2096 If passed a sub as first parameter, it will call the sub for each element found in :
2097  
2098 - Tags, passing the object as the first parameter, and the string 'Tags' as the second parameter
2099  
2100 If not, it will return a a L<Paws::DS::ListTagsForResourceResult> 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.
2101  
2102  
2103  
2104  
2105  
2106 =head1 SEE ALSO
2107  
2108 This service class forms part of L<Paws>
2109  
2110 =head1 BUGS and CONTRIBUTIONS
2111  
2112 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
2113  
2114 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
2115  
2116 =cut
2117