« blib/lib/Paws/PinpointEmail/DailyVolume.pm
↑ Summary
blib/lib/Paws/PinpointEmail/DeleteConfigurationSet.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::PinpointEmail::DedicatedIp; | ||
| 3 | use Moose; | ||
| 4 | has Ip => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has PoolName => (is => 'ro', isa => 'Str'); | ||
| 6 | has WarmupPercentage => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | has WarmupStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::PinpointEmail::DedicatedIp | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::PinpointEmail::DedicatedIp object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Ip => $value, ..., WarmupStatus => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::PinpointEmail::DedicatedIp object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Ip | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Contains information about a dedicated IP address that is associated | ||
| 40 | with your Amazon Pinpoint account. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> Ip => Str | ||
| 46 | |||
| 47 | An IP address that is reserved for use by your Amazon Pinpoint account. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 PoolName => Str | ||
| 51 | |||
| 52 | The name of the dedicated IP pool that the IP address is associated | ||
| 53 | with. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> WarmupPercentage => Int | ||
| 57 | |||
| 58 | Indicates how complete the dedicated IP warm-up process is. When this | ||
| 59 | value equals 1, the address has completed the warm-up process and is | ||
| 60 | ready for use. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> WarmupStatus => Str | ||
| 64 | |||
| 65 | The warm-up status of a dedicated IP address. The status can have one | ||
| 66 | of the following values: | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<IN_PROGRESS> E<ndash> The IP address isn't ready to use because the | ||
| 73 | dedicated IP warm-up process is ongoing. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<DONE> E<ndash> The dedicated IP warm-up process is complete, and the | ||
| 78 | IP address is ready to use. | ||
| 79 | |||
| 80 | =back | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, describing an object used in L<Paws::PinpointEmail> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |