« blib/lib/Paws/PinpointEmail/GetDedicatedIpResponse.pm
↑ Summary
blib/lib/Paws/PinpointEmail/GetDedicatedIpsResponse.pm »
| 1 | |||
| 2 | package Paws::PinpointEmail::GetDedicatedIps; | ||
| 3 | use Moose; | ||
| 4 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'NextToken'); | ||
| 5 | has PageSize => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'PageSize'); | ||
| 6 | has PoolName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'PoolName'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDedicatedIps'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/email/dedicated-ips'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PinpointEmail::GetDedicatedIpsResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::PinpointEmail::GetDedicatedIps - Arguments for method GetDedicatedIps on L<Paws::PinpointEmail> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetDedicatedIps on the | ||
| 25 | L<Amazon Pinpoint Email Service|Paws::PinpointEmail> service. Use the attributes of this class | ||
| 26 | as arguments to method GetDedicatedIps. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDedicatedIps. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $email = Paws->service('PinpointEmail'); | ||
| 33 | my $GetDedicatedIpsResponse = $email->GetDedicatedIps( | ||
| 34 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 35 | PageSize => 1, # OPTIONAL | ||
| 36 | PoolName => 'MyPoolName', # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $DedicatedIps = $GetDedicatedIpsResponse->DedicatedIps; | ||
| 41 | my $NextToken = $GetDedicatedIpsResponse->NextToken; | ||
| 42 | |||
| 43 | # Returns a L<Paws::PinpointEmail::GetDedicatedIpsResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/GetDedicatedIps> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 NextToken => Str | ||
| 52 | |||
| 53 | A token returned from a previous call to C<GetDedicatedIps> to indicate | ||
| 54 | the position of the dedicated IP pool in the list of IP pools. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 PageSize => Int | ||
| 59 | |||
| 60 | The number of results to show in a single call to | ||
| 61 | C<GetDedicatedIpsRequest>. If the number of results is larger than the | ||
| 62 | number you specified in this parameter, then the response includes a | ||
| 63 | C<NextToken> element, which you can use to obtain additional results. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 PoolName => Str | ||
| 68 | |||
| 69 | The name of the IP pool that the dedicated IP address is associated | ||
| 70 | with. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method GetDedicatedIps in L<Paws::PinpointEmail> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |