« blib/lib/Paws/Route53/LinkedService.pm
↑ Summary
blib/lib/Paws/Route53/ListGeoLocationsResponse.pm »
| 1 | |||
| 2 | package Paws::Route53::ListGeoLocations; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has MaxItems => (is => 'ro', isa => 'Str', query_name => 'maxitems', traits => ['ParamInQuery']); | |
| 5 | 1 | has StartContinentCode => (is => 'ro', isa => 'Str', query_name => 'startcontinentcode', traits => ['ParamInQuery']); | |
| 6 | 1 | has StartCountryCode => (is => 'ro', isa => 'Str', query_name => 'startcountrycode', traits => ['ParamInQuery']); | |
| 7 | 1 | has StartSubdivisionCode => (is => 'ro', isa => 'Str', query_name => 'startsubdivisioncode', traits => ['ParamInQuery']); | |
| 8 | |||
| 9 | |||
| 10 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 11 | |||
| 12 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListGeoLocations'); | |
| 13 | 1 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2013-04-01/geolocations'); | |
| 14 | 1 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | |
| 15 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Route53::ListGeoLocationsResponse'); | |
| 16 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 17 | |||
| 18 | |||
| 19 | 1 | 1; | |
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Route53::ListGeoLocations - Arguments for method ListGeoLocations on L<Paws::Route53> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ListGeoLocations on the | ||
| 30 | L<Amazon Route 53|Paws::Route53> service. Use the attributes of this class | ||
| 31 | as arguments to method ListGeoLocations. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGeoLocations. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $route53 = Paws->service('Route53'); | ||
| 38 | my $ListGeoLocationsResponse = $route53->ListGeoLocations( | ||
| 39 | MaxItems => 'MyPageMaxItems', # OPTIONAL | ||
| 40 | StartContinentCode => 'MyGeoLocationContinentCode', # OPTIONAL | ||
| 41 | StartCountryCode => 'MyGeoLocationCountryCode', # OPTIONAL | ||
| 42 | StartSubdivisionCode => 'MyGeoLocationSubdivisionCode', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $GeoLocationDetailsList = | ||
| 47 | $ListGeoLocationsResponse->GeoLocationDetailsList; | ||
| 48 | my $IsTruncated = $ListGeoLocationsResponse->IsTruncated; | ||
| 49 | my $MaxItems = $ListGeoLocationsResponse->MaxItems; | ||
| 50 | my $NextContinentCode = $ListGeoLocationsResponse->NextContinentCode; | ||
| 51 | my $NextCountryCode = $ListGeoLocationsResponse->NextCountryCode; | ||
| 52 | my $NextSubdivisionCode = $ListGeoLocationsResponse->NextSubdivisionCode; | ||
| 53 | |||
| 54 | # Returns a L<Paws::Route53::ListGeoLocationsResponse> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/route53/ListGeoLocations> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 MaxItems => Str | ||
| 63 | |||
| 64 | (Optional) The maximum number of geolocations to be included in the | ||
| 65 | response body for this request. If more than C<maxitems> geolocations | ||
| 66 | remain to be listed, then the value of the C<IsTruncated> element in | ||
| 67 | the response is C<true>. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 StartContinentCode => Str | ||
| 72 | |||
| 73 | The code for the continent with which you want to start listing | ||
| 74 | locations that Amazon Route 53 supports for geolocation. If Route 53 | ||
| 75 | has already returned a page or more of results, if C<IsTruncated> is | ||
| 76 | true, and if C<NextContinentCode> from the previous response has a | ||
| 77 | value, enter that value in C<startcontinentcode> to return the next | ||
| 78 | page of results. | ||
| 79 | |||
| 80 | Include C<startcontinentcode> only if you want to list continents. | ||
| 81 | Don't include C<startcontinentcode> when you're listing countries or | ||
| 82 | countries with their subdivisions. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 StartCountryCode => Str | ||
| 87 | |||
| 88 | The code for the country with which you want to start listing locations | ||
| 89 | that Amazon Route 53 supports for geolocation. If Route 53 has already | ||
| 90 | returned a page or more of results, if C<IsTruncated> is C<true>, and | ||
| 91 | if C<NextCountryCode> from the previous response has a value, enter | ||
| 92 | that value in C<startcountrycode> to return the next page of results. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 StartSubdivisionCode => Str | ||
| 97 | |||
| 98 | The code for the state of the United States with which you want to | ||
| 99 | start listing locations that Amazon Route 53 supports for geolocation. | ||
| 100 | If Route 53 has already returned a page or more of results, if | ||
| 101 | C<IsTruncated> is C<true>, and if C<NextSubdivisionCode> from the | ||
| 102 | previous response has a value, enter that value in | ||
| 103 | C<startsubdivisioncode> to return the next page of results. | ||
| 104 | |||
| 105 | To list subdivisions (U.S. states), you must include both | ||
| 106 | C<startcountrycode> and C<startsubdivisioncode>. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method ListGeoLocations in L<Paws::Route53> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 | |||