« blib/lib/Paws/LocationService/SearchForTextResult.pm
↑ Summary
blib/lib/Paws/LocationService/SearchPlaceIndexForPositionResponse.pm »
| 1 | |||
| 2 | package Paws::LocationService::SearchPlaceIndexForPosition; | ||
| 3 | use Moose; | ||
| 4 | has IndexName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'IndexName', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has Position => (is => 'ro', isa => 'ArrayRef[Num]', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchPlaceIndexForPosition'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/places/v0/indexes/{IndexName}/search/position'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LocationService::SearchPlaceIndexForPositionResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::LocationService::SearchPlaceIndexForPosition - Arguments for method SearchPlaceIndexForPosition on L<Paws::LocationService> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method SearchPlaceIndexForPosition on the | ||
| 25 | L<Amazon Location Service|Paws::LocationService> service. Use the attributes of this class | ||
| 26 | as arguments to method SearchPlaceIndexForPosition. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchPlaceIndexForPosition. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $geo = Paws->service('LocationService'); | ||
| 33 | my $SearchPlaceIndexForPositionResponse = $geo->SearchPlaceIndexForPosition( | ||
| 34 | IndexName => 'MyResourceName', | ||
| 35 | Position => [ 1, ... ], | ||
| 36 | MaxResults => 1, # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $Results = $SearchPlaceIndexForPositionResponse->Results; | ||
| 41 | my $Summary = $SearchPlaceIndexForPositionResponse->Summary; | ||
| 42 | |||
| 43 | # Returns a L<Paws::LocationService::SearchPlaceIndexForPositionResponse> 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/geo/SearchPlaceIndexForPosition> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> IndexName => Str | ||
| 52 | |||
| 53 | The name of the place index resource you want to use for the search. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 MaxResults => Int | ||
| 58 | |||
| 59 | An optional paramer. The maximum number of results returned per | ||
| 60 | request. | ||
| 61 | |||
| 62 | Default value: C<50> | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Position => ArrayRef[Num] | ||
| 67 | |||
| 68 | Specifies a coordinate for the query defined by a longitude, and | ||
| 69 | latitude. | ||
| 70 | |||
| 71 | =over | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | The first position is the X coordinate, or longitude. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | The second position is the Y coordinate, or latitude. | ||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | For example, C<position=xLongitude&position=yLatitude> . | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method SearchPlaceIndexForPosition in L<Paws::LocationService> | ||
| 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 |