Skip to content

/AWS1/CL_LOCSRCHPLACEIDXFORT02

A summary of the request sent by using SearchPlaceIndexForText.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_text TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING

The search text specified in the request.

iv_datasource TYPE /AWS1/LOCSTRING /AWS1/LOCSTRING

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

  • Esri

  • Grab

  • Here

For more information about data providers, see Amazon Location Service data providers.

Optional arguments:

it_biasposition TYPE /AWS1/CL_LOCPOSITION_W=>TT_POSITION TT_POSITION

Contains the coordinates for the optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

it_filterbbox TYPE /AWS1/CL_LOCBOUNDINGBOX_W=>TT_BOUNDINGBOX TT_BOUNDINGBOX

Contains the coordinates for the optional bounding box specified in the request.

it_filtercountries TYPE /AWS1/CL_LOCCOUNTRYCODELIST_W=>TT_COUNTRYCODELIST TT_COUNTRYCODELIST

Contains the optional country filter specified in the request.

iv_maxresults TYPE /AWS1/LOCPLACEIDXSRCHRSLTLIMIT /AWS1/LOCPLACEIDXSRCHRSLTLIMIT

Contains the optional result count limit specified in the request.

it_resultbbox TYPE /AWS1/CL_LOCBOUNDINGBOX_W=>TT_BOUNDINGBOX TT_BOUNDINGBOX

The bounding box that fully contains all search results.

If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

iv_language TYPE /AWS1/LOCLANGUAGETAG /AWS1/LOCLANGUAGETAG

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

it_filtercategories TYPE /AWS1/CL_LOCFILTPLACECATLIST_W=>TT_FILTERPLACECATEGORYLIST TT_FILTERPLACECATEGORYLIST

The optional category filter specified in the request.

Queryable Attributes

Text

The search text specified in the request.

Accessible with the following methods

Method Description
GET_TEXT() Getter for TEXT, with configurable default
ASK_TEXT() Getter for TEXT w/ exceptions if field has no value
HAS_TEXT() Determine if TEXT has a value

BiasPosition

Contains the coordinates for the optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

Accessible with the following methods

Method Description
GET_BIASPOSITION() Getter for BIASPOSITION, with configurable default
ASK_BIASPOSITION() Getter for BIASPOSITION w/ exceptions if field has no value
HAS_BIASPOSITION() Determine if BIASPOSITION has a value

FilterBBox

Contains the coordinates for the optional bounding box specified in the request.

Accessible with the following methods

Method Description
GET_FILTERBBOX() Getter for FILTERBBOX, with configurable default
ASK_FILTERBBOX() Getter for FILTERBBOX w/ exceptions if field has no value
HAS_FILTERBBOX() Determine if FILTERBBOX has a value

FilterCountries

Contains the optional country filter specified in the request.

Accessible with the following methods

Method Description
GET_FILTERCOUNTRIES() Getter for FILTERCOUNTRIES, with configurable default
ASK_FILTERCOUNTRIES() Getter for FILTERCOUNTRIES w/ exceptions if field has no val
HAS_FILTERCOUNTRIES() Determine if FILTERCOUNTRIES has a value

MaxResults

Contains the optional result count limit specified in the request.

Accessible with the following methods

Method Description
GET_MAXRESULTS() Getter for MAXRESULTS, with configurable default
ASK_MAXRESULTS() Getter for MAXRESULTS w/ exceptions if field has no value
HAS_MAXRESULTS() Determine if MAXRESULTS has a value

ResultBBox

The bounding box that fully contains all search results.

If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

Accessible with the following methods

Method Description
GET_RESULTBBOX() Getter for RESULTBBOX, with configurable default
ASK_RESULTBBOX() Getter for RESULTBBOX w/ exceptions if field has no value
HAS_RESULTBBOX() Determine if RESULTBBOX has a value

DataSource

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

  • Esri

  • Grab

  • Here

For more information about data providers, see Amazon Location Service data providers.

Accessible with the following methods

Method Description
GET_DATASOURCE() Getter for DATASOURCE, with configurable default
ASK_DATASOURCE() Getter for DATASOURCE w/ exceptions if field has no value
HAS_DATASOURCE() Determine if DATASOURCE has a value

Language

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Accessible with the following methods

Method Description
GET_LANGUAGE() Getter for LANGUAGE, with configurable default
ASK_LANGUAGE() Getter for LANGUAGE w/ exceptions if field has no value
HAS_LANGUAGE() Determine if LANGUAGE has a value

FilterCategories

The optional category filter specified in the request.

Accessible with the following methods

Method Description
GET_FILTERCATEGORIES() Getter for FILTERCATEGORIES, with configurable default
ASK_FILTERCATEGORIES() Getter for FILTERCATEGORIES w/ exceptions if field has no va
HAS_FILTERCATEGORIES() Determine if FILTERCATEGORIES has a value