Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
You can search for places near a given position using
BiasPosition , or filter results within a bounding box using
FilterBBox . Providing both parameters simultaneously returns an error.
Search results are returned in order of highest to lowest relevance.
See also: AWS API Documentation
search-place-index-for-text [--bias-position <value>] [--filter-b-box <value>] [--filter-countries <value>] --index-name <value> [--language <value>] [--max-results <value>] --text <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
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.
[-123.1174, 49.2847]represents the position with longitude
FilterBBoxare mutually exclusive. Specifying both options results in an error.
Syntax:double double ...
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.
[-12.7935, -37.4835, -12.0684, -36.9542]represents a bounding box where the southwest corner has longitude
-37.4835, and the northeast corner has longitude
BiasPositionare mutually exclusive. Specifying both options results in an error.
Syntax:double double ...
An optional parameter that limits the search results by returning only places that are in a specified list of countries.
Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters:
Syntax:"string" "string" ...
The name of the place index resource you want to use for the search.
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,
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
languageparameter set to
en. The result found will most likely be returned as
If you set the
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.
An optional parameter. The maximum number of results returned per request.
The address, name, city, or region to be used in the search in free-form text format. For example,
123 Any Street.
--cli-input-yaml(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
--generate-cli-skeleton(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-inputit will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://will always be treated as binary and use the file contents directly regardless of the
cli-binary-formatsetting. When using
file://the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
Results -> (list)
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.
Contains a search result from a text search query that is run on a place index resource.
Distance -> (double)
The distance in meters of a great-circle arc between the bias position specified and the result.
Distancewill 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.
Place -> (structure)
Details about the search result, such as its address and position.
AddressNumber -> (string)
The numerical portion of an address, such as a building number.
Country -> (string)
A country/region specified using ISO 3166 3-digit country/region code. For example,
Geometry -> (structure)
Places uses a point geometry to specify a location or a Place.
Point -> (list)
A single point geometry specifies a location for a Place using WGS 84 coordinates:
x — Specifies the x coordinate or longitude.
y — Specifies the y coordinate or latitude.
Interpolated -> (boolean)
Trueif the result is interpolated from other known places.
Falseif the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns
Falsefor an address location that is found in the partner data, but returns
Trueif an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.
Label -> (string)
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.
Municipality -> (string)
A name for a local area, such as a city or town name. For example,
Neighborhood -> (string)
The name of a community district. For example,
PostalCode -> (string)
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
Region -> (string)
A name for an area or geographical division, such as a province or state name. For example,
Street -> (string)
The name for a street or a road to identify a location. For example,
SubRegion -> (string)
A county, or an area that’s part of a larger region. For example,
TimeZone -> (structure)
The time zone in which the
Placeis located. Returned only when using HERE as the selected partner.
Name -> (string)
The name of the time zone, following the IANA time zone standard . For example,
Offset -> (integer)
The time zone’s offset, in seconds, from UTC.
UnitNumber -> (string)
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
Returned only for a place index that uses Esri as a data provider. Is not returned for
UnitType -> (string)
For addresses with a
UnitNumber, the type of unit. For example,
PlaceId -> (string)
The unique identifier of the place. You can use this with the
GetPlaceoperation to find the place again later.
PlaceIdis returned only by place indexes that use HERE or Grab as a data provider.
Relevance -> (double)
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 -> (structure)
Contains a summary of the request. Echoes the input values for
Text. Also includes the
DataSourceof the place index and the bounding box,
ResultBBox, which surrounds the search results.
BiasPosition -> (list)
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.
[-123.1174, 49.2847]represents the position with longitude
DataSource -> (string)
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 .
FilterBBox -> (list)
Contains the coordinates for the optional bounding box specified in the request.
FilterCountries -> (list)
Contains the optional country filter specified in the request.
Language -> (string)
The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example,
MaxResults -> (integer)
Contains the optional result count limit specified in the request.
ResultBBox -> (list)
The bounding box that fully contains all search results.
If you specified the optional
FilterBBoxparameter in the request,
ResultBBoxis contained within
Text -> (string)
The search text specified in the request.