« blib/lib/Paws/MigrationHub/NotifyApplicationStateResult.pm
↑ Summary
blib/lib/Paws/MigrationHub/NotifyMigrationTaskStateResult.pm »
| 1 | |||
| 2 | package Paws::MigrationHub::NotifyMigrationTaskState; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has MigrationTaskName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has NextUpdateSeconds => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | has ProgressUpdateStream => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Task => (is => 'ro', isa => 'Paws::MigrationHub::Task', required => 1); | ||
| 9 | has UpdateDateTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'NotifyMigrationTaskState'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MigrationHub::NotifyMigrationTaskStateResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::MigrationHub::NotifyMigrationTaskState - Arguments for method NotifyMigrationTaskState on L<Paws::MigrationHub> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method NotifyMigrationTaskState on the | ||
| 27 | L<AWS Migration Hub|Paws::MigrationHub> service. Use the attributes of this class | ||
| 28 | as arguments to method NotifyMigrationTaskState. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to NotifyMigrationTaskState. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $mgh = Paws->service('MigrationHub'); | ||
| 35 | my $NotifyMigrationTaskStateResult = $mgh->NotifyMigrationTaskState( | ||
| 36 | MigrationTaskName => 'MyMigrationTaskName', | ||
| 37 | NextUpdateSeconds => 1, | ||
| 38 | ProgressUpdateStream => 'MyProgressUpdateStream', | ||
| 39 | Task => { | ||
| 40 | Status => | ||
| 41 | 'NOT_STARTED', # values: NOT_STARTED, IN_PROGRESS, FAILED, COMPLETED | ||
| 42 | ProgressPercent => 1, # max: 100; OPTIONAL | ||
| 43 | StatusDetail => 'MyStatusDetail', # max: 500; OPTIONAL | ||
| 44 | }, | ||
| 45 | UpdateDateTime => '1970-01-01T01:00:00', | ||
| 46 | DryRun => 1, # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mgh/NotifyMigrationTaskState> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 DryRun => Bool | ||
| 56 | |||
| 57 | Optional boolean flag to indicate whether any effect should take place. | ||
| 58 | Used to test if the caller has permission to make the call. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> MigrationTaskName => Str | ||
| 63 | |||
| 64 | Unique identifier that references the migration task. I<Do not store | ||
| 65 | personal data in this field.> | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> NextUpdateSeconds => Int | ||
| 70 | |||
| 71 | Number of seconds after the UpdateDateTime within which the Migration | ||
| 72 | Hub can expect an update. If Migration Hub does not receive an update | ||
| 73 | within the specified interval, then the migration task will be | ||
| 74 | considered stale. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> ProgressUpdateStream => Str | ||
| 79 | |||
| 80 | The name of the ProgressUpdateStream. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> Task => L<Paws::MigrationHub::Task> | ||
| 85 | |||
| 86 | Information about the task's progress and status. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> UpdateDateTime => Str | ||
| 91 | |||
| 92 | The timestamp when the task was gathered. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method NotifyMigrationTaskState in L<Paws::MigrationHub> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |