blib/lib/Paws/AmplifyBackend.pm untested

filter: Statementstmt 0.0% 0 / 108 Branchbran 0.0% 0 / 4 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 32 Podpod 0.0% 0 / 31 totaltotal 0.0% 0 / 175 CC 3 SCAR 10.6
CC
3
Cov
0%
ListAllBackendJobs
12.0
service
2.0
signing_name
2.0
CRAP 2.9
1 package Paws::AmplifyBackend;
2 use Moose;
3 sub service { 'amplifybackend' }
4 sub signing_name { 'amplifybackend' }
5 sub version { '2020-08-11' }
6 sub flattened_arrays { 0 }
7 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 has retry => (is => 'ro', isa => 'HashRef', default => sub {
9 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 });
11 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12 ] });
13  
14 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 sub CloneBackend {
18 my $self = shift;
19 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::CloneBackend', @_);
20 return $self->caller->do_call($self, $call_object);
21 }
22 sub CreateBackend {
23 my $self = shift;
24 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::CreateBackend', @_);
25 return $self->caller->do_call($self, $call_object);
26 }
27 sub CreateBackendAPI {
28 my $self = shift;
29 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::CreateBackendAPI', @_);
30 return $self->caller->do_call($self, $call_object);
31 }
32 sub CreateBackendAuth {
33 my $self = shift;
34 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::CreateBackendAuth', @_);
35 return $self->caller->do_call($self, $call_object);
36 }
37 sub CreateBackendConfig {
38 my $self = shift;
39 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::CreateBackendConfig', @_);
40 return $self->caller->do_call($self, $call_object);
41 }
42 sub CreateToken {
43 my $self = shift;
44 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::CreateToken', @_);
45 return $self->caller->do_call($self, $call_object);
46 }
47 sub DeleteBackend {
48 my $self = shift;
49 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::DeleteBackend', @_);
50 return $self->caller->do_call($self, $call_object);
51 }
52 sub DeleteBackendAPI {
53 my $self = shift;
54 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::DeleteBackendAPI', @_);
55 return $self->caller->do_call($self, $call_object);
56 }
57 sub DeleteBackendAuth {
58 my $self = shift;
59 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::DeleteBackendAuth', @_);
60 return $self->caller->do_call($self, $call_object);
61 }
62 sub DeleteToken {
63 my $self = shift;
64 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::DeleteToken', @_);
65 return $self->caller->do_call($self, $call_object);
66 }
67 sub GenerateBackendAPIModels {
68 my $self = shift;
69 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::GenerateBackendAPIModels', @_);
70 return $self->caller->do_call($self, $call_object);
71 }
72 sub GetBackend {
73 my $self = shift;
74 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::GetBackend', @_);
75 return $self->caller->do_call($self, $call_object);
76 }
77 sub GetBackendAPI {
78 my $self = shift;
79 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::GetBackendAPI', @_);
80 return $self->caller->do_call($self, $call_object);
81 }
82 sub GetBackendAPIModels {
83 my $self = shift;
84 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::GetBackendAPIModels', @_);
85 return $self->caller->do_call($self, $call_object);
86 }
87 sub GetBackendAuth {
88 my $self = shift;
89 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::GetBackendAuth', @_);
90 return $self->caller->do_call($self, $call_object);
91 }
92 sub GetBackendJob {
93 my $self = shift;
94 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::GetBackendJob', @_);
95 return $self->caller->do_call($self, $call_object);
96 }
97 sub GetToken {
98 my $self = shift;
99 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::GetToken', @_);
100 return $self->caller->do_call($self, $call_object);
101 }
102 sub ImportBackendAuth {
103 my $self = shift;
104 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::ImportBackendAuth', @_);
105 return $self->caller->do_call($self, $call_object);
106 }
107 sub ListBackendJobs {
108 my $self = shift;
109 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::ListBackendJobs', @_);
110 return $self->caller->do_call($self, $call_object);
111 }
112 sub RemoveAllBackends {
113 my $self = shift;
114 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::RemoveAllBackends', @_);
115 return $self->caller->do_call($self, $call_object);
116 }
117 sub RemoveBackendConfig {
118 my $self = shift;
119 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::RemoveBackendConfig', @_);
120 return $self->caller->do_call($self, $call_object);
121 }
122 sub UpdateBackendAPI {
123 my $self = shift;
124 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::UpdateBackendAPI', @_);
125 return $self->caller->do_call($self, $call_object);
126 }
127 sub UpdateBackendAuth {
128 my $self = shift;
129 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::UpdateBackendAuth', @_);
130 return $self->caller->do_call($self, $call_object);
131 }
132 sub UpdateBackendConfig {
133 my $self = shift;
134 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::UpdateBackendConfig', @_);
135 return $self->caller->do_call($self, $call_object);
136 }
137 sub UpdateBackendJob {
138 my $self = shift;
139 my $call_object = $self->new_with_coercions('Paws::AmplifyBackend::UpdateBackendJob', @_);
140 return $self->caller->do_call($self, $call_object);
141 }
142
143 sub ListAllBackendJobs {
144 my $self = shift;
145  
146 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
147 my $result = $self->ListBackendJobs(@_);
148 my $next_result = $result;
149  
150 if (not defined $callback) {
151 while ($next_result->NextToken) {
152 $next_result = $self->ListBackendJobs(@_, NextToken => $next_result->NextToken);
153 push @{ $result->Jobs }, @{ $next_result->Jobs };
154 }
155 return $result;
156 } else {
157 while ($result->NextToken) {
158 $callback->($_ => 'Jobs') foreach (@{ $result->Jobs });
159 $result = $self->ListBackendJobs(@_, NextToken => $result->NextToken);
160 }
161 $callback->($_ => 'Jobs') foreach (@{ $result->Jobs });
162 }
163  
164 return undef
165 }
166  
167  
168 sub operations { qw/CloneBackend CreateBackend CreateBackendAPI CreateBackendAuth CreateBackendConfig CreateToken DeleteBackend DeleteBackendAPI DeleteBackendAuth DeleteToken GenerateBackendAPIModels GetBackend GetBackendAPI GetBackendAPIModels GetBackendAuth GetBackendJob GetToken ImportBackendAuth ListBackendJobs RemoveAllBackends RemoveBackendConfig UpdateBackendAPI UpdateBackendAuth UpdateBackendConfig UpdateBackendJob / }
169  
170 1;
171  
172 ### main pod documentation begin ###
173  
174 =head1 NAME
175  
176 Paws::AmplifyBackend - Perl Interface to AWS AmplifyBackend
177  
178 =head1 SYNOPSIS
179  
180 use Paws;
181  
182 my $obj = Paws->service('AmplifyBackend');
183 my $res = $obj->Method(
184 Arg1 => $val1,
185 Arg2 => [ 'V1', 'V2' ],
186 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
187 # of the arguments type
188 Arg3 => { Att1 => 'Val1' },
189 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
190 # the constructor of the arguments type
191 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
192 );
193  
194 =head1 DESCRIPTION
195  
196 AWS Amplify Admin API
197  
198 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11>
199  
200  
201 =head1 METHODS
202  
203 =head2 CloneBackend
204  
205 =over
206  
207 =item AppId => Str
208  
209 =item BackendEnvironmentName => Str
210  
211 =item TargetEnvironmentName => Str
212  
213  
214 =back
215  
216 Each argument is described in detail in: L<Paws::AmplifyBackend::CloneBackend>
217  
218 Returns: a L<Paws::AmplifyBackend::CloneBackendResponse> instance
219  
220 This operation clones an existing backend.
221  
222  
223 =head2 CreateBackend
224  
225 =over
226  
227 =item AppId => Str
228  
229 =item AppName => Str
230  
231 =item BackendEnvironmentName => Str
232  
233 =item [ResourceConfig => L<Paws::AmplifyBackend::ResourceConfig>]
234  
235 =item [ResourceName => Str]
236  
237  
238 =back
239  
240 Each argument is described in detail in: L<Paws::AmplifyBackend::CreateBackend>
241  
242 Returns: a L<Paws::AmplifyBackend::CreateBackendResponse> instance
243  
244 This operation creates a backend for an Amplify app. Backends are
245 automatically created at the time of app creation.
246  
247  
248 =head2 CreateBackendAPI
249  
250 =over
251  
252 =item AppId => Str
253  
254 =item BackendEnvironmentName => Str
255  
256 =item ResourceConfig => L<Paws::AmplifyBackend::BackendAPIResourceConfig>
257  
258 =item ResourceName => Str
259  
260  
261 =back
262  
263 Each argument is described in detail in: L<Paws::AmplifyBackend::CreateBackendAPI>
264  
265 Returns: a L<Paws::AmplifyBackend::CreateBackendAPIResponse> instance
266  
267 Creates a new backend API resource.
268  
269  
270 =head2 CreateBackendAuth
271  
272 =over
273  
274 =item AppId => Str
275  
276 =item BackendEnvironmentName => Str
277  
278 =item ResourceConfig => L<Paws::AmplifyBackend::CreateBackendAuthResourceConfig>
279  
280 =item ResourceName => Str
281  
282  
283 =back
284  
285 Each argument is described in detail in: L<Paws::AmplifyBackend::CreateBackendAuth>
286  
287 Returns: a L<Paws::AmplifyBackend::CreateBackendAuthResponse> instance
288  
289 Creates a new backend authentication resource.
290  
291  
292 =head2 CreateBackendConfig
293  
294 =over
295  
296 =item AppId => Str
297  
298 =item [BackendManagerAppId => Str]
299  
300  
301 =back
302  
303 Each argument is described in detail in: L<Paws::AmplifyBackend::CreateBackendConfig>
304  
305 Returns: a L<Paws::AmplifyBackend::CreateBackendConfigResponse> instance
306  
307 Creates a config object for a backend.
308  
309  
310 =head2 CreateToken
311  
312 =over
313  
314 =item AppId => Str
315  
316  
317 =back
318  
319 Each argument is described in detail in: L<Paws::AmplifyBackend::CreateToken>
320  
321 Returns: a L<Paws::AmplifyBackend::CreateTokenResponse> instance
322  
323 Generates a one-time challenge code to authenticate a user into your
324 Amplify Admin UI.
325  
326  
327 =head2 DeleteBackend
328  
329 =over
330  
331 =item AppId => Str
332  
333 =item BackendEnvironmentName => Str
334  
335  
336 =back
337  
338 Each argument is described in detail in: L<Paws::AmplifyBackend::DeleteBackend>
339  
340 Returns: a L<Paws::AmplifyBackend::DeleteBackendResponse> instance
341  
342 Removes an existing environment from your Amplify project.
343  
344  
345 =head2 DeleteBackendAPI
346  
347 =over
348  
349 =item AppId => Str
350  
351 =item BackendEnvironmentName => Str
352  
353 =item ResourceName => Str
354  
355 =item [ResourceConfig => L<Paws::AmplifyBackend::BackendAPIResourceConfig>]
356  
357  
358 =back
359  
360 Each argument is described in detail in: L<Paws::AmplifyBackend::DeleteBackendAPI>
361  
362 Returns: a L<Paws::AmplifyBackend::DeleteBackendAPIResponse> instance
363  
364 Deletes an existing backend API resource.
365  
366  
367 =head2 DeleteBackendAuth
368  
369 =over
370  
371 =item AppId => Str
372  
373 =item BackendEnvironmentName => Str
374  
375 =item ResourceName => Str
376  
377  
378 =back
379  
380 Each argument is described in detail in: L<Paws::AmplifyBackend::DeleteBackendAuth>
381  
382 Returns: a L<Paws::AmplifyBackend::DeleteBackendAuthResponse> instance
383  
384 Deletes an existing backend authentication resource.
385  
386  
387 =head2 DeleteToken
388  
389 =over
390  
391 =item AppId => Str
392  
393 =item SessionId => Str
394  
395  
396 =back
397  
398 Each argument is described in detail in: L<Paws::AmplifyBackend::DeleteToken>
399  
400 Returns: a L<Paws::AmplifyBackend::DeleteTokenResponse> instance
401  
402 Deletes the challenge token based on the given appId and sessionId.
403  
404  
405 =head2 GenerateBackendAPIModels
406  
407 =over
408  
409 =item AppId => Str
410  
411 =item BackendEnvironmentName => Str
412  
413 =item ResourceName => Str
414  
415  
416 =back
417  
418 Each argument is described in detail in: L<Paws::AmplifyBackend::GenerateBackendAPIModels>
419  
420 Returns: a L<Paws::AmplifyBackend::GenerateBackendAPIModelsResponse> instance
421  
422 Generates a model schema for an existing backend API resource.
423  
424  
425 =head2 GetBackend
426  
427 =over
428  
429 =item AppId => Str
430  
431 =item [BackendEnvironmentName => Str]
432  
433  
434 =back
435  
436 Each argument is described in detail in: L<Paws::AmplifyBackend::GetBackend>
437  
438 Returns: a L<Paws::AmplifyBackend::GetBackendResponse> instance
439  
440 Provides project-level details for your Amplify UI project.
441  
442  
443 =head2 GetBackendAPI
444  
445 =over
446  
447 =item AppId => Str
448  
449 =item BackendEnvironmentName => Str
450  
451 =item ResourceName => Str
452  
453 =item [ResourceConfig => L<Paws::AmplifyBackend::BackendAPIResourceConfig>]
454  
455  
456 =back
457  
458 Each argument is described in detail in: L<Paws::AmplifyBackend::GetBackendAPI>
459  
460 Returns: a L<Paws::AmplifyBackend::GetBackendAPIResponse> instance
461  
462 Gets the details for a backend API.
463  
464  
465 =head2 GetBackendAPIModels
466  
467 =over
468  
469 =item AppId => Str
470  
471 =item BackendEnvironmentName => Str
472  
473 =item ResourceName => Str
474  
475  
476 =back
477  
478 Each argument is described in detail in: L<Paws::AmplifyBackend::GetBackendAPIModels>
479  
480 Returns: a L<Paws::AmplifyBackend::GetBackendAPIModelsResponse> instance
481  
482 Generates a model schema for existing backend API resource.
483  
484  
485 =head2 GetBackendAuth
486  
487 =over
488  
489 =item AppId => Str
490  
491 =item BackendEnvironmentName => Str
492  
493 =item ResourceName => Str
494  
495  
496 =back
497  
498 Each argument is described in detail in: L<Paws::AmplifyBackend::GetBackendAuth>
499  
500 Returns: a L<Paws::AmplifyBackend::GetBackendAuthResponse> instance
501  
502 Gets a backend auth details.
503  
504  
505 =head2 GetBackendJob
506  
507 =over
508  
509 =item AppId => Str
510  
511 =item BackendEnvironmentName => Str
512  
513 =item JobId => Str
514  
515  
516 =back
517  
518 Each argument is described in detail in: L<Paws::AmplifyBackend::GetBackendJob>
519  
520 Returns: a L<Paws::AmplifyBackend::GetBackendJobResponse> instance
521  
522 Returns information about a specific job.
523  
524  
525 =head2 GetToken
526  
527 =over
528  
529 =item AppId => Str
530  
531 =item SessionId => Str
532  
533  
534 =back
535  
536 Each argument is described in detail in: L<Paws::AmplifyBackend::GetToken>
537  
538 Returns: a L<Paws::AmplifyBackend::GetTokenResponse> instance
539  
540 Gets the challenge token based on the given appId and sessionId.
541  
542  
543 =head2 ImportBackendAuth
544  
545 =over
546  
547 =item AppId => Str
548  
549 =item BackendEnvironmentName => Str
550  
551 =item NativeClientId => Str
552  
553 =item UserPoolId => Str
554  
555 =item WebClientId => Str
556  
557 =item [IdentityPoolId => Str]
558  
559  
560 =back
561  
562 Each argument is described in detail in: L<Paws::AmplifyBackend::ImportBackendAuth>
563  
564 Returns: a L<Paws::AmplifyBackend::ImportBackendAuthResponse> instance
565  
566 Imports an existing backend authentication resource.
567  
568  
569 =head2 ListBackendJobs
570  
571 =over
572  
573 =item AppId => Str
574  
575 =item BackendEnvironmentName => Str
576  
577 =item [JobId => Str]
578  
579 =item [MaxResults => Int]
580  
581 =item [NextToken => Str]
582  
583 =item [Operation => Str]
584  
585 =item [Status => Str]
586  
587  
588 =back
589  
590 Each argument is described in detail in: L<Paws::AmplifyBackend::ListBackendJobs>
591  
592 Returns: a L<Paws::AmplifyBackend::ListBackendJobsResponse> instance
593  
594 Lists the jobs for the backend of an Amplify app.
595  
596  
597 =head2 RemoveAllBackends
598  
599 =over
600  
601 =item AppId => Str
602  
603 =item [CleanAmplifyApp => Bool]
604  
605  
606 =back
607  
608 Each argument is described in detail in: L<Paws::AmplifyBackend::RemoveAllBackends>
609  
610 Returns: a L<Paws::AmplifyBackend::RemoveAllBackendsResponse> instance
611  
612 Removes all backend environments from your Amplify project.
613  
614  
615 =head2 RemoveBackendConfig
616  
617 =over
618  
619 =item AppId => Str
620  
621  
622 =back
623  
624 Each argument is described in detail in: L<Paws::AmplifyBackend::RemoveBackendConfig>
625  
626 Returns: a L<Paws::AmplifyBackend::RemoveBackendConfigResponse> instance
627  
628 Removes the AWS resources required to access the Amplify Admin UI.
629  
630  
631 =head2 UpdateBackendAPI
632  
633 =over
634  
635 =item AppId => Str
636  
637 =item BackendEnvironmentName => Str
638  
639 =item ResourceName => Str
640  
641 =item [ResourceConfig => L<Paws::AmplifyBackend::BackendAPIResourceConfig>]
642  
643  
644 =back
645  
646 Each argument is described in detail in: L<Paws::AmplifyBackend::UpdateBackendAPI>
647  
648 Returns: a L<Paws::AmplifyBackend::UpdateBackendAPIResponse> instance
649  
650 Updates an existing backend API resource.
651  
652  
653 =head2 UpdateBackendAuth
654  
655 =over
656  
657 =item AppId => Str
658  
659 =item BackendEnvironmentName => Str
660  
661 =item ResourceConfig => L<Paws::AmplifyBackend::UpdateBackendAuthResourceConfig>
662  
663 =item ResourceName => Str
664  
665  
666 =back
667  
668 Each argument is described in detail in: L<Paws::AmplifyBackend::UpdateBackendAuth>
669  
670 Returns: a L<Paws::AmplifyBackend::UpdateBackendAuthResponse> instance
671  
672 Updates an existing backend authentication resource.
673  
674  
675 =head2 UpdateBackendConfig
676  
677 =over
678  
679 =item AppId => Str
680  
681 =item [LoginAuthConfig => L<Paws::AmplifyBackend::LoginAuthConfigReqObj>]
682  
683  
684 =back
685  
686 Each argument is described in detail in: L<Paws::AmplifyBackend::UpdateBackendConfig>
687  
688 Returns: a L<Paws::AmplifyBackend::UpdateBackendConfigResponse> instance
689  
690 Updates the AWS resources required to access the Amplify Admin UI.
691  
692  
693 =head2 UpdateBackendJob
694  
695 =over
696  
697 =item AppId => Str
698  
699 =item BackendEnvironmentName => Str
700  
701 =item JobId => Str
702  
703 =item [Operation => Str]
704  
705 =item [Status => Str]
706  
707  
708 =back
709  
710 Each argument is described in detail in: L<Paws::AmplifyBackend::UpdateBackendJob>
711  
712 Returns: a L<Paws::AmplifyBackend::UpdateBackendJobResponse> instance
713  
714 Updates a specific job.
715  
716  
717  
718  
719 =head1 PAGINATORS
720  
721 Paginator methods are helpers that repetively call methods that return partial results
722  
723 =head2 ListAllBackendJobs(sub { },AppId => Str, BackendEnvironmentName => Str, [JobId => Str, MaxResults => Int, NextToken => Str, Operation => Str, Status => Str])
724  
725 =head2 ListAllBackendJobs(AppId => Str, BackendEnvironmentName => Str, [JobId => Str, MaxResults => Int, NextToken => Str, Operation => Str, Status => Str])
726  
727  
728 If passed a sub as first parameter, it will call the sub for each element found in :
729  
730 - Jobs, passing the object as the first parameter, and the string 'Jobs' as the second parameter
731  
732 If not, it will return a a L<Paws::AmplifyBackend::ListBackendJobsResponse> 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.
733  
734  
735  
736  
737  
738 =head1 SEE ALSO
739  
740 This service class forms part of L<Paws>
741  
742 =head1 BUGS and CONTRIBUTIONS
743  
744 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
745  
746 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
747  
748 =cut
749