« blib/lib/Paws/Route53/ListHostedZones.pm
↑ Summary
blib/lib/Paws/Route53/ListHostedZonesByNameResponse.pm »
| 1 | |||
| 2 | package Paws::Route53::ListHostedZonesByName; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has DNSName => (is => 'ro', isa => 'Str', query_name => 'dnsname', traits => ['ParamInQuery']); | |
| 5 | 1 | has HostedZoneId => (is => 'ro', isa => 'Str', query_name => 'hostedzoneid', traits => ['ParamInQuery']); | |
| 6 | 1 | has MaxItems => (is => 'ro', isa => 'Str', query_name => 'maxitems', traits => ['ParamInQuery']); | |
| 7 | |||
| 8 | |||
| 9 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 10 | |||
| 11 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListHostedZonesByName'); | |
| 12 | 1 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2013-04-01/hostedzonesbyname'); | |
| 13 | 1 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | |
| 14 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Route53::ListHostedZonesByNameResponse'); | |
| 15 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 16 | |||
| 17 | |||
| 18 | 1 | 1; | |
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Route53::ListHostedZonesByName - Arguments for method ListHostedZonesByName on L<Paws::Route53> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method ListHostedZonesByName on the | ||
| 29 | L<Amazon Route 53|Paws::Route53> service. Use the attributes of this class | ||
| 30 | as arguments to method ListHostedZonesByName. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListHostedZonesByName. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $route53 = Paws->service('Route53'); | ||
| 37 | my $ListHostedZonesByNameResponse = $route53->ListHostedZonesByName( | ||
| 38 | DNSName => 'MyDNSName', # OPTIONAL | ||
| 39 | HostedZoneId => 'MyResourceId', # OPTIONAL | ||
| 40 | MaxItems => 'MyPageMaxItems', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $DNSName = $ListHostedZonesByNameResponse->DNSName; | ||
| 45 | my $HostedZoneId = $ListHostedZonesByNameResponse->HostedZoneId; | ||
| 46 | my $HostedZones = $ListHostedZonesByNameResponse->HostedZones; | ||
| 47 | my $IsTruncated = $ListHostedZonesByNameResponse->IsTruncated; | ||
| 48 | my $MaxItems = $ListHostedZonesByNameResponse->MaxItems; | ||
| 49 | my $NextDNSName = $ListHostedZonesByNameResponse->NextDNSName; | ||
| 50 | my $NextHostedZoneId = $ListHostedZonesByNameResponse->NextHostedZoneId; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Route53::ListHostedZonesByNameResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/route53/ListHostedZonesByName> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 DNSName => Str | ||
| 61 | |||
| 62 | (Optional) For your first request to C<ListHostedZonesByName>, include | ||
| 63 | the C<dnsname> parameter only if you want to specify the name of the | ||
| 64 | first hosted zone in the response. If you don't include the C<dnsname> | ||
| 65 | parameter, Amazon Route 53 returns all of the hosted zones that were | ||
| 66 | created by the current AWS account, in ASCII order. For subsequent | ||
| 67 | requests, include both C<dnsname> and C<hostedzoneid> parameters. For | ||
| 68 | C<dnsname>, specify the value of C<NextDNSName> from the previous | ||
| 69 | response. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 HostedZoneId => Str | ||
| 74 | |||
| 75 | (Optional) For your first request to C<ListHostedZonesByName>, do not | ||
| 76 | include the C<hostedzoneid> parameter. | ||
| 77 | |||
| 78 | If you have more hosted zones than the value of C<maxitems>, | ||
| 79 | C<ListHostedZonesByName> returns only the first C<maxitems> hosted | ||
| 80 | zones. To get the next group of C<maxitems> hosted zones, submit | ||
| 81 | another request to C<ListHostedZonesByName> and include both C<dnsname> | ||
| 82 | and C<hostedzoneid> parameters. For the value of C<hostedzoneid>, | ||
| 83 | specify the value of the C<NextHostedZoneId> element from the previous | ||
| 84 | response. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 MaxItems => Str | ||
| 89 | |||
| 90 | The maximum number of hosted zones to be included in the response body | ||
| 91 | for this request. If you have more than C<maxitems> hosted zones, then | ||
| 92 | the value of the C<IsTruncated> element in the response is true, and | ||
| 93 | the values of C<NextDNSName> and C<NextHostedZoneId> specify the first | ||
| 94 | hosted zone in the next group of C<maxitems> hosted zones. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method ListHostedZonesByName in L<Paws::Route53> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 | |||