| Column Name | Column Data Type |
|---|
index_name Required Input Column
The name of the place index resource you want to use for the search. | VARCHAR |
text Required Input Column
The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street. | VARCHAR |
bias_position Input Column
An optional parameter that indicates a preference for places that are closer to a specified position. If provided, this parameter must contain 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. BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error. | DOUBLE[] |
Show child fields- bias_position[]
|
filter_b_box Input Column
An optional parameter that limits the search results by returning only places that are within the provided bounding box. If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box. For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542. FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error. | DOUBLE[] |
Show child fields- filter_b_box[]
|
filter_categories Input Column
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed. For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide. | VARCHAR[] |
Show child fields- filter_categories[]
|
filter_countries Input Column
An optional parameter that limits the search results by returning only places that are in a specified list of countries. | VARCHAR[] |
Show child fields- filter_countries[]
|
key Input Column
The optional API key to authorize the request. | VARCHAR |
language Input Column
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English. This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result. For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens. If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα. If the data provider does not have a value for Greek, the result will be in a language that the provider does support. | VARCHAR |
max_results Input Column
An optional parameter. The maximum number of results returned per request. The default: 50 | BIGINT |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
results
A list of Places matching the input text. Each result contains additional information about the specific point of interest. Not all response properties are included with all responses. Some properties may only be returned by specific data partners. | STRUCT(
"place" STRUCT(
"label" VARCHAR,
"geometry" STRUCT(
"point" DOUBLE[]
),
"address_number" VARCHAR,
"street" VARCHAR,
"neighborhood" VARCHAR,
"municipality" VARCHAR,
"sub_region" VARCHAR,
"region" VARCHAR,
"country" VARCHAR,
"postal_code" VARCHAR,
"interpolated" BOOLEAN,
"time_zone" STRUCT(
"name" VARCHAR,
"offset" BIGINT
),
"unit_type" VARCHAR,
"unit_number" VARCHAR,
"categories" VARCHAR[],
"supplemental_categories" VARCHAR[],
"sub_municipality" VARCHAR
),
"distance" DOUBLE,
"relevance" DOUBLE,
"place_id" VARCHAR
)[] |
Show child fields- results[]
Show child fields- results[].distance
The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query. A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations. - results[].place
Details about the search result, such as its address and position. Show child fields- results[].place.address_number
The numerical portion of an address, such as a building number. - results[].place.categories[]
- results[].place.country
A country/region specified using ISO 3166 3-digit country/region code. For example, CAN. - results[].place.geometry
Places uses a point geometry to specify a location or a Place. Show child fields- results[].place.geometry.point[]
- results[].place.interpolated
True if the result is interpolated from other known places. False if the Place is a known place. Not returned when the partner does not provide the information. For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses. - results[].place.label
The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA. - results[].place.municipality
A name for a local area, such as a city or town name. For example, Toronto. - results[].place.neighborhood
The name of a community district. For example, Downtown. - results[].place.postal_code
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location. - results[].place.region
A name for an area or geographical division, such as a province or state name. For example, British Columbia. - results[].place.street
The name for a street or a road to identify a location. For example, Main Street. - results[].place.sub_municipality
An area that's part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York. This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough. - results[].place.sub_region
A county, or an area that's part of a larger region. For example, Metro Vancouver. - results[].place.supplemental_categories[]
- results[].place.time_zone
The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner. Show child fields- results[].place.time_zone.name
The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles. - results[].place.time_zone.offset
The time zone's offset, in seconds, from UTC.
- results[].place.unit_number
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123. Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for SearchPlaceIndexForPosition. - results[].place.unit_type
For addresses with a UnitNumber, the type of unit. For example, Apartment. Returned only for a place index that uses Esri as a data provider.
- results[].place_id
The unique identifier of the place. You can use this with the GetPlace operation to find the place again later. For SearchPlaceIndexForText operations, the PlaceId is returned only by place indexes that use HERE or Grab as a data provider. - results[].relevance
The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1. Returned only when the partner selected is Esri or Grab.
|
summary
Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results. | STRUCT(
"text" VARCHAR,
"bias_position" DOUBLE[],
"filter_b_box" DOUBLE[],
"filter_countries" VARCHAR[],
"max_results" BIGINT,
"result_b_box" DOUBLE[],
"data_source" VARCHAR,
"language" VARCHAR,
"filter_categories" VARCHAR[]
) |
Show child fields- summary.bias_position[]
- summary.data_source
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following: For more information about data providers, see Amazon Location Service data providers. - summary.filter_b_box[]
- summary.filter_categories[]
- summary.filter_countries[]
- summary.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. - summary.max_results
Contains the optional result count limit specified in the request. - summary.result_b_box[]
- summary.text
The search text specified in the request.
|