/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::LocationService::SearchPlaceIndexForText

NAME

Paws::LocationService::SearchPlaceIndexForText - Arguments for method SearchPlaceIndexForText on Paws::LocationService

DESCRIPTION

This class represents the parameters used for calling the method SearchPlaceIndexForText on the Amazon Location Service service. Use the attributes of this class as arguments to method SearchPlaceIndexForText.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchPlaceIndexForText.

SYNOPSIS

 my $geo = Paws->service('LocationService');
 my $SearchPlaceIndexForTextResponse = $geo->SearchPlaceIndexForText(
   IndexName       => 'MyResourceName',
   Text            => 'MySyntheticSearchPlaceIndexForTextRequestString',
   BiasPosition    => [ 1,               ... ],    # OPTIONAL
   FilterBBox      => [ 1,               ... ],    # OPTIONAL
   FilterCountries => [ 'MyCountryCode', ... ],    # OPTIONAL
   MaxResults      => 1,                           # OPTIONAL
 );

 # Results:
 my $Results = $SearchPlaceIndexForTextResponse->Results;
 my $Summary = $SearchPlaceIndexForTextResponse->Summary;

# Returns a L<Paws::LocationService::SearchPlaceIndexForTextResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/geo/SearchPlaceIndexForText

ATTRIBUTES

BiasPosition => ArrayRef[Num]

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

  • The first bias position is the X coordinate, or longitude.

  • The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

FilterBBox => ArrayRef[Num]

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

  • The first bbox position is the X coordinate or longitude of the lower southwest corner.

  • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

  • The third bbox position is the X coordinate, or longitude of the upper northeast corner.

  • The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

FilterCountries => ArrayRef[Str|Undef]

Limits the search to the given a list of countries/regions. An optional parameter.

  • Use the ISO 3166 (https://www.iso.org/iso-3166-country-codes.html) 3-digit country code. For example, Australia uses three upper-case characters: AUS.

REQUIRED IndexName => Str

The name of the place index resource you want to use for the search.

MaxResults => Int

An optional parameter. The maximum number of results returned per request.

The default: 50

REQUIRED Text => Str

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

SEE ALSO

This class forms part of Paws, documenting arguments for method SearchPlaceIndexForText in Paws::LocationService

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues