| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary
Description
Synopsis
- data SearchPlaceIndexForSuggestionsSummary = SearchPlaceIndexForSuggestionsSummary' {
- biasPosition :: Maybe (Sensitive (NonEmpty Double))
- filterBBox :: Maybe (Sensitive (NonEmpty Double))
- filterCountries :: Maybe (NonEmpty Text)
- language :: Maybe Text
- maxResults :: Maybe Int
- dataSource :: Text
- text :: Sensitive Text
- newSearchPlaceIndexForSuggestionsSummary :: Text -> Text -> SearchPlaceIndexForSuggestionsSummary
- searchPlaceIndexForSuggestionsSummary_biasPosition :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForSuggestionsSummary_filterBBox :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForSuggestionsSummary_filterCountries :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Text))
- searchPlaceIndexForSuggestionsSummary_language :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Text)
- searchPlaceIndexForSuggestionsSummary_maxResults :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Int)
- searchPlaceIndexForSuggestionsSummary_dataSource :: Lens' SearchPlaceIndexForSuggestionsSummary Text
- searchPlaceIndexForSuggestionsSummary_text :: Lens' SearchPlaceIndexForSuggestionsSummary Text
Documentation
data SearchPlaceIndexForSuggestionsSummary Source #
A summary of the request sent by using SearchPlaceIndexForSuggestions.
See: newSearchPlaceIndexForSuggestionsSummary smart constructor.
Constructors
| SearchPlaceIndexForSuggestionsSummary' | |
Fields
| |
Instances
newSearchPlaceIndexForSuggestionsSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> SearchPlaceIndexForSuggestionsSummary |
Create a value of SearchPlaceIndexForSuggestionsSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:biasPosition:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_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.
$sel:filterBBox:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_filterBBox - Contains the coordinates for the optional bounding box specified in the
request.
$sel:filterCountries:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_filterCountries - Contains the optional country filter specified in the request.
$sel:language:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_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.
$sel:maxResults:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_maxResults - Contains the optional result count limit specified in the request.
$sel:dataSource:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_dataSource - The geospatial data provider attached to the place index resource
specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
$sel:text:SearchPlaceIndexForSuggestionsSummary', searchPlaceIndexForSuggestionsSummary_text - The free-form partial text input specified in the request.
searchPlaceIndexForSuggestionsSummary_biasPosition :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double)) Source #
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.
searchPlaceIndexForSuggestionsSummary_filterBBox :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bounding box specified in the request.
searchPlaceIndexForSuggestionsSummary_filterCountries :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Text)) Source #
Contains the optional country filter specified in the request.
searchPlaceIndexForSuggestionsSummary_language :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Text) Source #
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.
searchPlaceIndexForSuggestionsSummary_maxResults :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Int) Source #
Contains the optional result count limit specified in the request.
searchPlaceIndexForSuggestionsSummary_dataSource :: Lens' SearchPlaceIndexForSuggestionsSummary Text Source #
The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:
- Esri
- Here
For more information about data providers, see Amazon Location Service data providers.
searchPlaceIndexForSuggestionsSummary_text :: Lens' SearchPlaceIndexForSuggestionsSummary Text Source #
The free-form partial text input specified in the request.