« blib/lib/Paws/Support/TrustedAdvisorCheckDescription.pm
↑ Summary
blib/lib/Paws/Support/TrustedAdvisorCheckResult.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Support::TrustedAdvisorCheckRefreshStatus; | ||
| 3 | use Moose; | ||
| 4 | has CheckId => (is => 'ro', isa => 'Str', request_name => 'checkId', traits => ['NameInRequest'], required => 1); | ||
| 5 | has MillisUntilNextRefreshable => (is => 'ro', isa => 'Int', request_name => 'millisUntilNextRefreshable', traits => ['NameInRequest'], required => 1); | ||
| 6 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Support::TrustedAdvisorCheckRefreshStatus | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Support::TrustedAdvisorCheckRefreshStatus object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { CheckId => $value, ..., Status => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Support::TrustedAdvisorCheckRefreshStatus object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->CheckId | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The refresh status of a Trusted Advisor check. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> CheckId => Str | ||
| 44 | |||
| 45 | The unique identifier for the Trusted Advisor check. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> MillisUntilNextRefreshable => Int | ||
| 49 | |||
| 50 | The amount of time, in milliseconds, until the Trusted Advisor check is | ||
| 51 | eligible for refresh. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> Status => Str | ||
| 55 | |||
| 56 | The status of the Trusted Advisor check for which a refresh has been | ||
| 57 | requested: | ||
| 58 | |||
| 59 | =over | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | C<none> - The check is not refreshed or the non-success status exceeds | ||
| 64 | the timeout | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<enqueued> - The check refresh requests has entered the refresh queue | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<processing> - The check refresh request is picked up by the rule | ||
| 73 | processing engine | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<success> - The check is successfully refreshed | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<abandoned> - The check refresh has failed | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, describing an object used in L<Paws::Support> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |