@aws-sdk/client-location 3.38.0 → 3.42.0

package/dist-types/models/models_0.d.ts

@@ -788,7 +788,7 @@ export declare namespace CalculateRouteTruckModeOptions {
 }
 export interface CalculateRouteRequest {
     /**
-     * <p>The name of the route calculator resource that you want to use to calculate a route. </p>
+     * <p>The name of the route calculator resource that you want to use to calculate the route. </p>
      */
     CalculatorName: string | undefined;
     /**
@@ -866,7 +866,7 @@ export interface CalculateRouteRequest {
      */
     TravelMode?: TravelMode | string;
     /**
-     * <p>Specifies the desired time of departure. Uses the given time to calculate a route.
+     * <p>Specifies the desired time of departure. Uses the given time to calculate the route.
      *             Otherwise, the best time of day to travel with the best traffic conditions is used to
      *             calculate the route.</p>
      *         <note>
@@ -1138,7 +1138,7 @@ export interface CalculateRouteSummary {
      */
     DurationSeconds: number | undefined;
     /**
-     * <p>The unit of measurement for the distance.</p>
+     * <p>The unit of measurement for route distances.</p>
      */
     DistanceUnit: DistanceUnit | string | undefined;
 }
@@ -1268,6 +1268,9 @@ export interface CreateGeofenceCollectionRequest {
      *                 <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
      *                     + - = . _ : / @. </p>
      *             </li>
+     *             <li>
+     *                 <p>Cannot use "aws:" as a prefix for a key.</p>
+     *             </li>
      *          </ul>
      */
     Tags?: {
@@ -1438,6 +1441,9 @@ export interface CreateMapRequest {
      *                <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : /
      *                     @. </p>
      *             </li>
+     *             <li>
+     *                <p>Cannot use "aws:" as a prefix for a key.</p>
+     *             </li>
      *          </ul>
      */
     Tags?: {
@@ -1514,7 +1520,7 @@ export interface DataSourceConfiguration {
      *                   <code>Storage</code> specifies that the result can be cached or stored in a database.</p>
      *             </li>
      *          </ul>
-     *          <p>Default value:  <code>SingleUse</code>
+     *          <p>Default value: <code>SingleUse</code>
      *          </p>
      */
     IntendedUse?: IntendedUse | string;
@@ -1544,7 +1550,7 @@ export interface CreatePlaceIndexRequest {
      */
     IndexName: string | undefined;
     /**
-     * <p>Specifies the data provider of geospatial data.</p>
+     * <p>Specifies the geospatial data provider for the new place index.</p>
      *          <note>
      *             <p>This field is case-sensitive. Enter the valid values as shown. For example, entering
      *                <code>HERE</code> returns an error.</p>
@@ -1561,7 +1567,8 @@ export interface CreatePlaceIndexRequest {
      *                   <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a>'
      *                coverage in your region of interest, see <a href="https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html">HERE details on goecoding coverage</a>.</p>
      *                <important>
-     *                   <p>Place index resources using HERE Technologies as a data provider can't <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see the
+     *                   <p>If you specify HERE Technologies (<code>Here</code>) as the data provider,
+     *                   you may not <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see the
      *                      <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a>
      *                   for Amazon Location Service.</p>
      *                </important>
@@ -1585,27 +1592,30 @@ export interface CreatePlaceIndexRequest {
      */
     DataSourceConfiguration?: DataSourceConfiguration;
     /**
-     * <p>Applies one or more tags to the place index resource. A tag is a key-value pair helps
-     *          manage, identify, search, and filter your resources by labelling them.</p>
+     * <p>Applies one or more tags to the place index resource. A tag is a key-value pair that helps you
+     *          manage, identify, search, and filter your resources.</p>
      *          <p>Format: <code>"key" : "value"</code>
      *          </p>
      *          <p>Restrictions:</p>
      *          <ul>
      *             <li>
-     *                <p>Maximum 50 tags per resource</p>
+     *                <p>Maximum 50 tags per resource.</p>
      *             </li>
      *             <li>
-     *                <p>Each resource tag must be unique with a maximum of one value.</p>
+     *                <p>Each tag key must be unique and must have exactly one associated value.</p>
      *             </li>
      *             <li>
-     *                <p>Maximum key length: 128 Unicode characters in UTF-8</p>
+     *                <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
      *             </li>
      *             <li>
-     *                <p>Maximum value length: 256 Unicode characters in UTF-8</p>
+     *                <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
      *             </li>
      *             <li>
      *                <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
-     *                = . _ : / @. </p>
+     *                = . _ : / @</p>
+     *             </li>
+     *             <li>
+     *                <p>Cannot use "aws:" as a prefix for a key.</p>
      *             </li>
      *          </ul>
      */
@@ -1727,6 +1737,9 @@ export interface CreateRouteCalculatorRequest {
      *                 <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
      *                     + - = . _ : / @. </p>
      *             </li>
+     *             <li>
+     *                 <p>Cannot use "aws:" as a prefix for a key.</p>
+     *             </li>
      *          </ul>
      */
     Tags?: {
@@ -1779,7 +1792,7 @@ export declare namespace CreateRouteCalculatorResponse {
      */
     const filterSensitiveLog: (obj: CreateRouteCalculatorResponse) => any;
 }
-export declare type PositionFiltering = "DistanceBased" | "TimeBased";
+export declare type PositionFiltering = "AccuracyBased" | "DistanceBased" | "TimeBased";
 export interface CreateTrackerRequest {
     /**
      * <p>The name for the tracker resource.</p>
@@ -1851,6 +1864,9 @@ export interface CreateTrackerRequest {
      *                 <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
      *                     + - = . _ : / @. </p>
      *             </li>
+     *             <li>
+     *                 <p>Cannot use "aws:" as a prefix for a key.</p>
+     *             </li>
      *          </ul>
      */
     Tags?: {
@@ -1870,9 +1886,9 @@ export interface CreateTrackerRequest {
      *             <li>
      *                 <p>
      *                     <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
-     *                     ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
-     *                     This helps control costs by reducing the number of geofence evaluations and device positions to retrieve.
-     *                     Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
+     *                     ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored.
+     *                     This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.
+     *                     Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
      *                 </p>
      *             </li>
      *          </ul>
@@ -2206,7 +2222,7 @@ export interface DescribePlaceIndexResponse {
      */
     UpdateTime: Date | undefined;
     /**
-     * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
+     * <p>The data provider of geospatial data. Values can be one of the following:</p>
      *          <ul>
      *             <li>
      *                <p>
@@ -2219,7 +2235,7 @@ export interface DescribePlaceIndexResponse {
      *                </p>
      *             </li>
      *          </ul>
-     *          <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
+     *          <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
      */
     DataSource: string | undefined;
     /**
@@ -2485,11 +2501,30 @@ export interface TagResourceRequest {
      */
     ResourceArn: string | undefined;
     /**
-     * <p>Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: <code>"TagKey" : "TagValue"</code>.</p>
-     * 	        <ul>
+     * <p>Applies one or more tags to specific resource. A tag is a key-value pair that helps you
+     *             manage, identify, search, and filter your resources.</p>
+     *         <p>Format: <code>"key" : "value"</code>
+     *          </p>
+     *         <p>Restrictions:</p>
+     *         <ul>
      *             <li>
-     *                <p>Format example: <code>{"tag1" : "value1", "tag2" : "value2"} </code>
-     *                </p>
+     *                 <p>Maximum 50 tags per resource.</p>
+     *             </li>
+     *             <li>
+     *                 <p>Each tag key must be unique and must have exactly one associated value.</p>
+     *             </li>
+     *             <li>
+     *                 <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
+     *             </li>
+     *             <li>
+     *                 <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
+     *             </li>
+     *             <li>
+     *                 <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
+     *                     = . _ : / @</p>
+     *             </li>
+     *             <li>
+     *                 <p>Cannot use "aws:" as a prefix for a key.</p>
      *             </li>
      *          </ul>
      */
@@ -3393,7 +3428,7 @@ export interface ListPlaceIndexesResponseEntry {
      */
     Description: string | undefined;
     /**
-     * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
+     * <p>The data provider of geospatial data. Values can be one of the following:</p>
      *          <ul>
      *             <li>
      *                <p>
@@ -3406,7 +3441,7 @@ export interface ListPlaceIndexesResponseEntry {
      *                </p>
      *             </li>
      *          </ul>
-     *          <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
+     *          <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
      */
     DataSource: string | undefined;
     /**
@@ -3437,8 +3472,8 @@ export interface ListPlaceIndexesResponse {
      */
     Entries: ListPlaceIndexesResponseEntry[] | undefined;
     /**
-     * <p>A pagination token indicating there are additional pages available. You can use the
-     *          token in a following request to fetch the next set of results.</p>
+     * <p>A pagination token indicating that there are additional pages available. You can use the
+     *          token in a new request to fetch the next page of results.</p>
      */
     NextToken?: string;
 }
@@ -3724,24 +3759,29 @@ export interface SearchPlaceIndexForPositionRequest {
      */
     IndexName: string | undefined;
     /**
-     * <p>Specifies a coordinate for the query defined by a longitude, and latitude.</p>
-     *          <ul>
-     *             <li>
-     *                <p>The first position is the X coordinate, or longitude.</p>
-     *             </li>
-     *             <li>
-     *                <p>The second position is the Y coordinate, or latitude. </p>
-     *             </li>
-     *          </ul>
-     *          <p>For example, <code>position=xLongitude&amp;position=yLatitude</code> .</p>
+     * <p>Specifies the longitude and latitude of the position to query.</p>
+     *          <p>
+     *          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.</p>
+     *          <p>For example, <code>[-123.1174, 49.2847]</code> represents a position with
+     *          longitude <code>-123.1174</code> and
+     *          latitude <code>49.2847</code>.</p>
      */
     Position: number[] | undefined;
     /**
-     * <p>An optional paramer. The maximum number of results returned per request. </p>
+     * <p>An optional parameter. The maximum number of results returned per request.</p>
      *          <p>Default value: <code>50</code>
      *          </p>
      */
     MaxResults?: number;
+    /**
+     * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
+     *          <code>en</code> for English.</p>
+     *          <p>This setting affects the languages used in the results. It does not change which
+     *          results are returned. If the language is not specified, or not supported for a
+     *          particular result, the partner automatically chooses a language for the result.</p>
+     */
+    Language?: string;
 }
 export declare namespace SearchPlaceIndexForPositionRequest {
     /**
@@ -3775,6 +3815,27 @@ export declare namespace PlaceGeometry {
      */
     const filterSensitiveLog: (obj: PlaceGeometry) => any;
 }
+/**
+ * <p>Information about a time zone. Includes the name of the time zone and the offset
+ *          from UTC in seconds.</p>
+ */
+export interface TimeZone {
+    /**
+     * <p>The name of the time zone, following the <a href="https://www.iana.org/time-zones">
+     *          IANA time zone standard</a>. For example, <code>America/Los_Angeles</code>.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The time zone's offset, in seconds, from UTC.</p>
+     */
+    Offset?: number;
+}
+export declare namespace TimeZone {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: TimeZone) => any;
+}
 /**
  * <p>Contains details about addresses or points of interest that match the search
  *          criteria.</p>
@@ -3808,7 +3869,7 @@ export interface Place {
      */
     Municipality?: string;
     /**
-     * <p>A country, or an area that's part of a larger region .  For example, <code>Metro
+     * <p>A country, or an area that's part of a larger region.  For example, <code>Metro
      *             Vancouver</code>.</p>
      */
     SubRegion?: string;
@@ -3827,6 +3888,23 @@ export interface Place {
      *          address for the purpose of identifying a location. </p>
      */
     PostalCode?: string;
+    /**
+     * <p>
+     *             <code>True</code> if the result is interpolated from other known places.</p>
+     *          <p>
+     *             <code>False</code> if the Place is a known place.</p>
+     *          <p>Not returned when the partner does not provide the information.</p>
+     *          <p>For example, returns <code>False</code> for an address location that is found in the
+     *          partner data, but returns <code>True</code> if an address does not exist in the partner
+     *          data and its location is calculated by interpolating between other known addresses.
+     *       </p>
+     */
+    Interpolated?: boolean;
+    /**
+     * <p>The time zone in which the <code>Place</code> is located. Returned only when using
+     *          Here as the selected partner.</p>
+     */
+    TimeZone?: TimeZone;
 }
 export declare namespace Place {
     /**
@@ -3835,14 +3913,22 @@ export declare namespace Place {
     const filterSensitiveLog: (obj: Place) => any;
 }
 /**
- * <p>Specifies a single point of interest, or Place as a result of a search query obtained
- *          from a dataset configured in the place index resource.</p>
+ * <p>Contains a search result from a position search query that is run on a place index resource.</p>
  */
 export interface SearchForPositionResult {
     /**
-     * <p>Contains details about the relevant point of interest.</p>
+     * <p>Details about the search result, such as its address and position.</p>
      */
     Place: Place | undefined;
+    /**
+     * <p>The distance in meters of a great-circle arc between the query position and the
+     *          result.</p>
+     *          <note>
+     *             <p>A great-circle arc is the shortest path on a sphere, in this case the
+     *             Earth. This returns the shortest distance between two locations.</p>
+     *          </note>
+     */
+    Distance: number | undefined;
 }
 export declare namespace SearchForPositionResult {
     /**
@@ -3851,32 +3937,39 @@ export declare namespace SearchForPositionResult {
     const filterSensitiveLog: (obj: SearchForPositionResult) => any;
 }
 /**
- * <p>A summary of the reverse geocoding request sent using <code>SearchPlaceIndexForPosition</code>.</p>
+ * <p>A summary of the request sent by using <code>SearchPlaceIndexForPosition</code>.</p>
  */
 export interface SearchPlaceIndexForPositionSummary {
     /**
-     * <p>The position given in the reverse geocoding request.</p>
+     * <p>The position specified in the request.</p>
      */
     Position: number[] | undefined;
     /**
-     * <p>An optional parameter. The maximum number of results returned per request. </p>
+     * <p>Contains the optional result count limit that is specified in the request.</p>
      *          <p>Default value: <code>50</code>
      *          </p>
      */
     MaxResults?: number;
     /**
-     * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
+     * <p>The geospatial data provider attached to the place index resource specified in the request.
+     *          Values can be one of the following:</p>
      *          <ul>
      *             <li>
      *                <p>Esri</p>
      *             </li>
      *             <li>
-     *                <p>HERE</p>
+     *                <p>Here</p>
      *             </li>
      *          </ul>
-     *          <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
+     *          <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
      */
     DataSource: string | undefined;
+    /**
+     * <p>The preferred language used to return results. Matches the language in the request.
+     *          The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
+     *          <code>en</code> for English.</p>
+     */
+    Language?: string;
 }
 export declare namespace SearchPlaceIndexForPositionSummary {
     /**
@@ -3886,7 +3979,9 @@ export declare namespace SearchPlaceIndexForPositionSummary {
 }
 export interface SearchPlaceIndexForPositionResponse {
     /**
-     * <p>Contains a summary of the request.</p>
+     * <p>Contains a summary of the request. Echoes the input values for <code>Position</code>,
+     *          <code>Language</code>, <code>MaxResults</code>, and the <code>DataSource</code> of the place index.
+     *       </p>
      */
     Summary: SearchPlaceIndexForPositionSummary | undefined;
     /**
@@ -3908,61 +4003,49 @@ export interface SearchPlaceIndexForTextRequest {
     IndexName: string | undefined;
     /**
      * <p>The address, name,
-     *          city, or region to be used in the search. In free-form text format. For example, <code>123 Any
+     *          city, or region to be used in the search in free-form text format. For example, <code>123 Any
      *             Street</code>.</p>
      */
     Text: string | undefined;
     /**
-     * <p>Searches for results closest to the given position. An optional parameter defined by
-     *          longitude, and latitude.</p>
-     *          <ul>
-     *             <li>
-     *                <p>The first <code>bias</code> position is the X coordinate, or longitude.</p>
-     *             </li>
-     *             <li>
-     *                <p>The second <code>bias</code> position is the Y coordinate, or latitude. </p>
-     *             </li>
-     *          </ul>
-     *          <p>For example, <code>bias=xLongitude&amp;bias=yLatitude</code>.</p>
+     * <p>An optional parameter that indicates a preference for places that are closer to a specified position.</p>
+     *          <p>
+     *          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.</p>
+     *          <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
+     *          longitude <code>-123.1174</code> and
+     *          latitude <code>49.2847</code>.</p>
+     *          <note>
+     *             <p>
+     *                <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options
+     *             results in an error.
+     *          </p>
+     *          </note>
      */
     BiasPosition?: number[];
     /**
-     * <p>Filters the results by returning only Places within the provided bounding box. An
-     *          optional parameter.</p>
-     *          <p>The first 2 <code>bbox</code> parameters describe the lower southwest corner:</p>
-     *          <ul>
-     *             <li>
-     *                <p>The first <code>bbox</code> position is the X coordinate or longitude of the lower
-     *                southwest corner.</p>
-     *             </li>
-     *             <li>
-     *                <p>The second <code>bbox</code> position is the Y coordinate or latitude of the lower
-     *                southwest corner.</p>
-     *             </li>
-     *          </ul>
-     *          <p>For example, <code>bbox=xLongitudeSW&amp;bbox=yLatitudeSW</code>.</p>
-     *          <p>The next <code>bbox</code> parameters describe the upper northeast corner:</p>
-     *          <ul>
-     *             <li>
-     *                <p>The third <code>bbox</code> position is the X coordinate, or longitude of the
-     *                upper northeast corner.</p>
-     *             </li>
-     *             <li>
-     *                <p>The fourth <code>bbox</code> position is the Y coordinate, or longitude of the
-     *                upper northeast corner.</p>
-     *             </li>
-     *          </ul>
-     *          <p>For example, <code>bbox=xLongitudeNE&amp;bbox=yLatitudeNE</code>
+     * <p>An optional parameter that limits the search results by returning only places that are within the provided bounding box.</p>
+     *          <p>
+     *          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.</p>
+     *          <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents
+     *          a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>,
+     *          and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p>
+     *          <note>
+     *             <p>
+     *                <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.
      *          </p>
+     *          </note>
      */
     FilterBBox?: number[];
     /**
-     * <p>Limits the search to the given a list of countries/regions. An optional
-     *          parameter.</p>
+     * <p>An optional parameter that limits the search results by returning only places that are in a specified list of countries.</p>
      *          <ul>
      *             <li>
-     *                <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
-     *             country code. For example, Australia uses three upper-case characters:
+     *                <p>Valid values include <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
+     *             country codes. For example, Australia uses three upper-case characters:
      *             <code>AUS</code>.</p>
      *             </li>
      *          </ul>
@@ -3974,6 +4057,14 @@ export interface SearchPlaceIndexForTextRequest {
      *          </p>
      */
     MaxResults?: number;
+    /**
+     * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
+     *          <code>en</code> for English.</p>
+     *          <p>This setting affects the languages used in the results. It does not change which
+     *          results are returned. If the language is not specified, or not supported for a
+     *          particular result, the partner automatically chooses a language for the result.</p>
+     */
+    Language?: string;
 }
 export declare namespace SearchPlaceIndexForTextRequest {
     /**
@@ -3982,14 +4073,30 @@ export declare namespace SearchPlaceIndexForTextRequest {
     const filterSensitiveLog: (obj: SearchPlaceIndexForTextRequest) => any;
 }
 /**
- * <p>Contains relevant Places returned by calling
- *          <code>SearchPlaceIndexForText</code>.</p>
+ * <p>Contains a search result from a text search query that is run on a place index resource.</p>
  */
 export interface SearchForTextResult {
     /**
-     * <p>Contains details about the relevant point of interest.</p>
+     * <p>Details about the search result, such as its address and position.</p>
      */
     Place: Place | undefined;
+    /**
+     * <p>The distance in meters of a great-circle arc between the bias position specified
+     *          and the result. <code>Distance</code> will be returned only if a bias position was
+     *          specified in the query.</p>
+     *          <note>
+     *             <p>A great-circle arc is the shortest path on a sphere, in this case the
+     *             Earth. This returns the shortest distance between two locations.</p>
+     *          </note>
+     */
+    Distance?: number;
+    /**
+     * <p>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.</p>
+     *          <p>Returned only when the partner selected is Esri.</p>
+     */
+    Relevance?: number;
 }
 export declare namespace SearchForTextResult {
     /**
@@ -3998,50 +4105,57 @@ export declare namespace SearchForTextResult {
     const filterSensitiveLog: (obj: SearchForTextResult) => any;
 }
 /**
- * <p>A summary of the geocoding request sent using <code>SearchPlaceIndexForText</code>.</p>
+ * <p>A summary of the request sent by using <code>SearchPlaceIndexForText</code>.</p>
  */
 export interface SearchPlaceIndexForTextSummary {
     /**
-     * <p>The address, name, city or region to be used in the geocoding request. In free-form text
-     *          format. For example, <code>Vancouver</code>.</p>
+     * <p>The search text specified in the request.</p>
      */
     Text: string | undefined;
     /**
-     * <p>Contains the coordinates for the bias position entered in the geocoding request.</p>
+     * <p>Contains the coordinates for the optional bias position specified in the request.</p>
      */
     BiasPosition?: number[];
     /**
-     * <p>Contains the coordinates for the optional bounding box coordinated entered in the
-     *          geocoding request.</p>
+     * <p>Contains the coordinates for the optional bounding box specified in the request.</p>
      */
     FilterBBox?: number[];
     /**
-     * <p>Contains the country filter entered in the geocoding request.</p>
+     * <p>Contains the optional country filter specified in the request.</p>
      */
     FilterCountries?: string[];
     /**
-     * <p>Contains the maximum number of results indicated for the request.</p>
+     * <p>Contains the optional result count limit specified in the request.</p>
      */
     MaxResults?: number;
     /**
-     * <p>A bounding box that contains the search results within the specified area indicated by
-     *             <code>FilterBBox</code>. A subset of bounding box specified using
-     *             <code>FilterBBox</code>.</p>
+     * <p>The bounding box that fully contains all search results.</p>
+     *          <note>
+     *             <p>If you specified the optional <code>FilterBBox</code> parameter in the request, <code>ResultBBox</code>
+     *             is contained within <code>FilterBBox</code>.</p>
+     *          </note>
      */
     ResultBBox?: number[];
     /**
-     * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
+     * <p>The geospatial data provider attached to the place index resource specified in the request.
+     *          Values can be one of the following:</p>
      *          <ul>
      *             <li>
      *                <p>Esri</p>
      *             </li>
      *             <li>
-     *                <p>HERE</p>
+     *                <p>Here</p>
      *             </li>
      *          </ul>
-     *          <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
+     *          <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
      */
     DataSource: string | undefined;
+    /**
+     * <p>The preferred language used to return results. Matches the language in the request.
+     *          The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
+     *          <code>en</code> for English.</p>
+     */
+    Language?: string;
 }
 export declare namespace SearchPlaceIndexForTextSummary {
     /**
@@ -4051,13 +4165,15 @@ export declare namespace SearchPlaceIndexForTextSummary {
 }
 export interface SearchPlaceIndexForTextResponse {
     /**
-     * <p>Contains a summary of the request. Contains the <code>BiasPosition</code>,
-     *          <code>DataSource</code>, <code>FilterBBox</code>, <code>FilterCountries</code>,
-     *          <code>MaxResults</code>, <code>ResultBBox</code>, and <code>Text</code>.</p>
+     * <p>Contains a summary of the request. Echoes the input values for <code>BiasPosition</code>,
+     *          <code>FilterBBox</code>, <code>FilterCountries</code>, <code>Language</code>, <code>MaxResults</code>,
+     *          and <code>Text</code>. Also includes the <code>DataSource</code> of the place index and
+     *          the bounding box, <code>ResultBBox</code>, which surrounds the search results.
+     *       </p>
      */
     Summary: SearchPlaceIndexForTextSummary | undefined;
     /**
-     * <p>A list of Places closest to the specified position. Each result contains additional
+     * <p>A list of Places matching the input text. Each result contains additional
      *          information about the specific point of interest. </p>
      */
     Results: SearchForTextResult[] | undefined;