File Coverage

blib/lib/Paws/MigrationHub.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::MigrationHub;
2 1     1   995 use Moose;
  1         2  
  1         9  
3             sub service { 'mgh' }
4             sub version { '2017-05-31' }
5             sub target_prefix { 'AWSMigrationHub' }
6             sub json_version { "1.1" }
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::JsonCaller', 'Paws::Net::JsonResponse';
15              
16            
17             sub AssociateCreatedArtifact {
18             my $self = shift;
19             my $call_object = $self->new_with_coercions('Paws::MigrationHub::AssociateCreatedArtifact', @_);
20             return $self->caller->do_call($self, $call_object);
21             }
22             sub AssociateDiscoveredResource {
23             my $self = shift;
24             my $call_object = $self->new_with_coercions('Paws::MigrationHub::AssociateDiscoveredResource', @_);
25             return $self->caller->do_call($self, $call_object);
26             }
27             sub CreateProgressUpdateStream {
28             my $self = shift;
29             my $call_object = $self->new_with_coercions('Paws::MigrationHub::CreateProgressUpdateStream', @_);
30             return $self->caller->do_call($self, $call_object);
31             }
32             sub DeleteProgressUpdateStream {
33             my $self = shift;
34             my $call_object = $self->new_with_coercions('Paws::MigrationHub::DeleteProgressUpdateStream', @_);
35             return $self->caller->do_call($self, $call_object);
36             }
37             sub DescribeApplicationState {
38             my $self = shift;
39             my $call_object = $self->new_with_coercions('Paws::MigrationHub::DescribeApplicationState', @_);
40             return $self->caller->do_call($self, $call_object);
41             }
42             sub DescribeMigrationTask {
43             my $self = shift;
44             my $call_object = $self->new_with_coercions('Paws::MigrationHub::DescribeMigrationTask', @_);
45             return $self->caller->do_call($self, $call_object);
46             }
47             sub DisassociateCreatedArtifact {
48             my $self = shift;
49             my $call_object = $self->new_with_coercions('Paws::MigrationHub::DisassociateCreatedArtifact', @_);
50             return $self->caller->do_call($self, $call_object);
51             }
52             sub DisassociateDiscoveredResource {
53             my $self = shift;
54             my $call_object = $self->new_with_coercions('Paws::MigrationHub::DisassociateDiscoveredResource', @_);
55             return $self->caller->do_call($self, $call_object);
56             }
57             sub ImportMigrationTask {
58             my $self = shift;
59             my $call_object = $self->new_with_coercions('Paws::MigrationHub::ImportMigrationTask', @_);
60             return $self->caller->do_call($self, $call_object);
61             }
62             sub ListCreatedArtifacts {
63             my $self = shift;
64             my $call_object = $self->new_with_coercions('Paws::MigrationHub::ListCreatedArtifacts', @_);
65             return $self->caller->do_call($self, $call_object);
66             }
67             sub ListDiscoveredResources {
68             my $self = shift;
69             my $call_object = $self->new_with_coercions('Paws::MigrationHub::ListDiscoveredResources', @_);
70             return $self->caller->do_call($self, $call_object);
71             }
72             sub ListMigrationTasks {
73             my $self = shift;
74             my $call_object = $self->new_with_coercions('Paws::MigrationHub::ListMigrationTasks', @_);
75             return $self->caller->do_call($self, $call_object);
76             }
77             sub ListProgressUpdateStreams {
78             my $self = shift;
79             my $call_object = $self->new_with_coercions('Paws::MigrationHub::ListProgressUpdateStreams', @_);
80             return $self->caller->do_call($self, $call_object);
81             }
82             sub NotifyApplicationState {
83             my $self = shift;
84             my $call_object = $self->new_with_coercions('Paws::MigrationHub::NotifyApplicationState', @_);
85             return $self->caller->do_call($self, $call_object);
86             }
87             sub NotifyMigrationTaskState {
88             my $self = shift;
89             my $call_object = $self->new_with_coercions('Paws::MigrationHub::NotifyMigrationTaskState', @_);
90             return $self->caller->do_call($self, $call_object);
91             }
92             sub PutResourceAttributes {
93             my $self = shift;
94             my $call_object = $self->new_with_coercions('Paws::MigrationHub::PutResourceAttributes', @_);
95             return $self->caller->do_call($self, $call_object);
96             }
97            
98              
99              
100             sub operations { qw/AssociateCreatedArtifact AssociateDiscoveredResource CreateProgressUpdateStream DeleteProgressUpdateStream DescribeApplicationState DescribeMigrationTask DisassociateCreatedArtifact DisassociateDiscoveredResource ImportMigrationTask ListCreatedArtifacts ListDiscoveredResources ListMigrationTasks ListProgressUpdateStreams NotifyApplicationState NotifyMigrationTaskState PutResourceAttributes / }
101              
102             1;
103              
104             ### main pod documentation begin ###
105              
106             =head1 NAME
107              
108             Paws::MigrationHub - Perl Interface to AWS AWS Migration Hub
109              
110             =head1 SYNOPSIS
111              
112             use Paws;
113              
114             my $obj = Paws->service('MigrationHub');
115             my $res = $obj->Method(
116             Arg1 => $val1,
117             Arg2 => [ 'V1', 'V2' ],
118             # if Arg3 is an object, the HashRef will be used as arguments to the constructor
119             # of the arguments type
120             Arg3 => { Att1 => 'Val1' },
121             # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
122             # the constructor of the arguments type
123             Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
124             );
125              
126             =head1 DESCRIPTION
127              
128              
129              
130             =head1 METHODS
131              
132             =head2 AssociateCreatedArtifact(CreatedArtifact => L<Paws::MigrationHub::CreatedArtifact>, MigrationTaskName => Str, ProgressUpdateStream => Str, [DryRun => Bool])
133              
134             Each argument is described in detail in: L<Paws::MigrationHub::AssociateCreatedArtifact>
135              
136             Returns: a L<Paws::MigrationHub::AssociateCreatedArtifactResult> instance
137              
138             Associates a created artifact of an AWS cloud resource, the target
139             receiving the migration, with the migration task performed by a
140             migration tool. This API has the following traits:
141              
142             =over
143              
144             =item *
145              
146             Migration tools can call the C<AssociateCreatedArtifact> operation to
147             indicate which AWS artifact is associated with a migration task.
148              
149             =item *
150              
151             The created artifact name must be provided in ARN (Amazon Resource
152             Name) format which will contain information about type and region; for
153             example: C<arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b>.
154              
155             =item *
156              
157             Examples of the AWS resource behind the created artifact are, AMI's,
158             EC2 instance, or DMS endpoint, etc.
159              
160             =back
161              
162              
163              
164             =head2 AssociateDiscoveredResource(DiscoveredResource => L<Paws::MigrationHub::DiscoveredResource>, MigrationTaskName => Str, ProgressUpdateStream => Str, [DryRun => Bool])
165              
166             Each argument is described in detail in: L<Paws::MigrationHub::AssociateDiscoveredResource>
167              
168             Returns: a L<Paws::MigrationHub::AssociateDiscoveredResourceResult> instance
169              
170             Associates a discovered resource ID from Application Discovery Service
171             (ADS) with a migration task.
172              
173              
174             =head2 CreateProgressUpdateStream(ProgressUpdateStreamName => Str, [DryRun => Bool])
175              
176             Each argument is described in detail in: L<Paws::MigrationHub::CreateProgressUpdateStream>
177              
178             Returns: a L<Paws::MigrationHub::CreateProgressUpdateStreamResult> instance
179              
180             Creates a progress update stream which is an AWS resource used for
181             access control as well as a namespace for migration task names that is
182             implicitly linked to your AWS account. It must uniquely identify the
183             migration tool as it is used for all updates made by the tool; however,
184             it does not need to be unique for each AWS account because it is scoped
185             to the AWS account.
186              
187              
188             =head2 DeleteProgressUpdateStream(ProgressUpdateStreamName => Str, [DryRun => Bool])
189              
190             Each argument is described in detail in: L<Paws::MigrationHub::DeleteProgressUpdateStream>
191              
192             Returns: a L<Paws::MigrationHub::DeleteProgressUpdateStreamResult> instance
193              
194             Deletes a progress update stream, including all of its tasks, which was
195             previously created as an AWS resource used for access control. This API
196             has the following traits:
197              
198             =over
199              
200             =item *
201              
202             The only parameter needed for C<DeleteProgressUpdateStream> is the
203             stream name (same as a C<CreateProgressUpdateStream> call).
204              
205             =item *
206              
207             The call will return, and a background process will asynchronously be
208             doing the actual delete of the stream and all of its resources (tasks,
209             associated resources, resource attributes, created artifacts).
210              
211             =item *
212              
213             If the stream takes time to be deleted, it might still show up on a
214             C<ListProgressUpdateStreams> call.
215              
216             =item *
217              
218             C<CreateProgressUpdateStream>, C<ImportMigrationTask>,
219             C<NotifyMigrationTaskState>, and all Associate[*] APIs realted to the
220             tasks belonging to the stream will throw "InvalidInputException" if the
221             stream of the same name is in the process of being deleted.
222              
223             =item *
224              
225             Once the stream and all of its resources are deleted,
226             C<CreateProgressUpdateStream> for a stream of the same name will
227             succeed, and that stream will be an entirely new logical resource
228             (without any resources associated with the old stream).
229              
230             =back
231              
232              
233              
234             =head2 DescribeApplicationState(ApplicationId => Str)
235              
236             Each argument is described in detail in: L<Paws::MigrationHub::DescribeApplicationState>
237              
238             Returns: a L<Paws::MigrationHub::DescribeApplicationStateResult> instance
239              
240             Gets the migration status of an application.
241              
242              
243             =head2 DescribeMigrationTask(MigrationTaskName => Str, ProgressUpdateStream => Str)
244              
245             Each argument is described in detail in: L<Paws::MigrationHub::DescribeMigrationTask>
246              
247             Returns: a L<Paws::MigrationHub::DescribeMigrationTaskResult> instance
248              
249             Retrieves a list of all attributes associated with a specific migration
250             task.
251              
252              
253             =head2 DisassociateCreatedArtifact(CreatedArtifactName => Str, MigrationTaskName => Str, ProgressUpdateStream => Str, [DryRun => Bool])
254              
255             Each argument is described in detail in: L<Paws::MigrationHub::DisassociateCreatedArtifact>
256              
257             Returns: a L<Paws::MigrationHub::DisassociateCreatedArtifactResult> instance
258              
259             Disassociates a created artifact of an AWS resource with a migration
260             task performed by a migration tool that was previously associated. This
261             API has the following traits:
262              
263             =over
264              
265             =item *
266              
267             A migration user can call the C<DisassociateCreatedArtifacts> operation
268             to disassociate a created AWS Artifact from a migration task.
269              
270             =item *
271              
272             The created artifact name must be provided in ARN (Amazon Resource
273             Name) format which will contain information about type and region; for
274             example: C<arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b>.
275              
276             =item *
277              
278             Examples of the AWS resource behind the created artifact are, AMI's,
279             EC2 instance, or RDS instance, etc.
280              
281             =back
282              
283              
284              
285             =head2 DisassociateDiscoveredResource(ConfigurationId => Str, MigrationTaskName => Str, ProgressUpdateStream => Str, [DryRun => Bool])
286              
287             Each argument is described in detail in: L<Paws::MigrationHub::DisassociateDiscoveredResource>
288              
289             Returns: a L<Paws::MigrationHub::DisassociateDiscoveredResourceResult> instance
290              
291             Disassociate an Application Discovery Service (ADS) discovered resource
292             from a migration task.
293              
294              
295             =head2 ImportMigrationTask(MigrationTaskName => Str, ProgressUpdateStream => Str, [DryRun => Bool])
296              
297             Each argument is described in detail in: L<Paws::MigrationHub::ImportMigrationTask>
298              
299             Returns: a L<Paws::MigrationHub::ImportMigrationTaskResult> instance
300              
301             Registers a new migration task which represents a server, database,
302             etc., being migrated to AWS by a migration tool.
303              
304             This API is a prerequisite to calling the C<NotifyMigrationTaskState>
305             API as the migration tool must first register the migration task with
306             Migration Hub.
307              
308              
309             =head2 ListCreatedArtifacts(MigrationTaskName => Str, ProgressUpdateStream => Str, [MaxResults => Int, NextToken => Str])
310              
311             Each argument is described in detail in: L<Paws::MigrationHub::ListCreatedArtifacts>
312              
313             Returns: a L<Paws::MigrationHub::ListCreatedArtifactsResult> instance
314              
315             Lists the created artifacts attached to a given migration task in an
316             update stream. This API has the following traits:
317              
318             =over
319              
320             =item *
321              
322             Gets the list of the created artifacts while migration is taking place.
323              
324             =item *
325              
326             Shows the artifacts created by the migration tool that was associated
327             by the C<AssociateCreatedArtifact> API.
328              
329             =item *
330              
331             Lists created artifacts in a paginated interface.
332              
333             =back
334              
335              
336              
337             =head2 ListDiscoveredResources(MigrationTaskName => Str, ProgressUpdateStream => Str, [MaxResults => Int, NextToken => Str])
338              
339             Each argument is described in detail in: L<Paws::MigrationHub::ListDiscoveredResources>
340              
341             Returns: a L<Paws::MigrationHub::ListDiscoveredResourcesResult> instance
342              
343             Lists discovered resources associated with the given C<MigrationTask>.
344              
345              
346             =head2 ListMigrationTasks([MaxResults => Int, NextToken => Str, ResourceName => Str])
347              
348             Each argument is described in detail in: L<Paws::MigrationHub::ListMigrationTasks>
349              
350             Returns: a L<Paws::MigrationHub::ListMigrationTasksResult> instance
351              
352             Lists all, or filtered by resource name, migration tasks associated
353             with the user account making this call. This API has the following
354             traits:
355              
356             =over
357              
358             =item *
359              
360             Can show a summary list of the most recent migration tasks.
361              
362             =item *
363              
364             Can show a summary list of migration tasks associated with a given
365             discovered resource.
366              
367             =item *
368              
369             Lists migration tasks in a paginated interface.
370              
371             =back
372              
373              
374              
375             =head2 ListProgressUpdateStreams([MaxResults => Int, NextToken => Str])
376              
377             Each argument is described in detail in: L<Paws::MigrationHub::ListProgressUpdateStreams>
378              
379             Returns: a L<Paws::MigrationHub::ListProgressUpdateStreamsResult> instance
380              
381             Lists progress update streams associated with the user account making
382             this call.
383              
384              
385             =head2 NotifyApplicationState(ApplicationId => Str, Status => Str, [DryRun => Bool])
386              
387             Each argument is described in detail in: L<Paws::MigrationHub::NotifyApplicationState>
388              
389             Returns: a L<Paws::MigrationHub::NotifyApplicationStateResult> instance
390              
391             Sets the migration state of an application. For a given application
392             identified by the value passed to C<ApplicationId>, its status is set
393             or updated by passing one of three values to C<Status>: C<NOT_STARTED |
394             IN_PROGRESS | COMPLETED>.
395              
396              
397             =head2 NotifyMigrationTaskState(MigrationTaskName => Str, NextUpdateSeconds => Int, ProgressUpdateStream => Str, Task => L<Paws::MigrationHub::Task>, UpdateDateTime => Str, [DryRun => Bool])
398              
399             Each argument is described in detail in: L<Paws::MigrationHub::NotifyMigrationTaskState>
400              
401             Returns: a L<Paws::MigrationHub::NotifyMigrationTaskStateResult> instance
402              
403             Notifies Migration Hub of the current status, progress, or other detail
404             regarding a migration task. This API has the following traits:
405              
406             =over
407              
408             =item *
409              
410             Migration tools will call the C<NotifyMigrationTaskState> API to share
411             the latest progress and status.
412              
413             =item *
414              
415             C<MigrationTaskName> is used for addressing updates to the correct
416             target.
417              
418             =item *
419              
420             C<ProgressUpdateStream> is used for access control and to provide a
421             namespace for each migration tool.
422              
423             =back
424              
425              
426              
427             =head2 PutResourceAttributes(MigrationTaskName => Str, ProgressUpdateStream => Str, ResourceAttributeList => ArrayRef[L<Paws::MigrationHub::ResourceAttribute>], [DryRun => Bool])
428              
429             Each argument is described in detail in: L<Paws::MigrationHub::PutResourceAttributes>
430              
431             Returns: a L<Paws::MigrationHub::PutResourceAttributesResult> instance
432              
433             Provides identifying details of the resource being migrated so that it
434             can be associated in the Application Discovery Service (ADS)'s
435             repository. This association occurs asynchronously after
436             C<PutResourceAttributes> returns.
437              
438             Keep in mind that subsequent calls to PutResourceAttributes will
439             override previously stored attributes. For example, if it is first
440             called with a MAC address, but later, it is desired to I<add> an IP
441             address, it will then be required to call it with I<both> the IP and
442             MAC addresses to prevent overiding the MAC address.
443              
444             Because this is an asynchronous call, it will always return 200,
445             whether an association occurs or not. To confirm if an association was
446             found based on the provided details, call C<ListAssociatedResource>.
447              
448              
449              
450              
451             =head1 PAGINATORS
452              
453             Paginator methods are helpers that repetively call methods that return partial results
454              
455              
456              
457              
458             =head1 SEE ALSO
459              
460             This service class forms part of L<Paws>
461              
462             =head1 BUGS and CONTRIBUTIONS
463              
464             The source code is located here: https://github.com/pplu/aws-sdk-perl
465              
466             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
467              
468             =cut
469