| 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.SearchPlaceIndexForTextSummary
Description
Synopsis
- data SearchPlaceIndexForTextSummary = SearchPlaceIndexForTextSummary' {
- biasPosition :: Maybe (Sensitive (NonEmpty Double))
- filterBBox :: Maybe (Sensitive (NonEmpty Double))
- filterCountries :: Maybe (NonEmpty Text)
- language :: Maybe Text
- maxResults :: Maybe Natural
- resultBBox :: Maybe (Sensitive (NonEmpty Double))
- dataSource :: Text
- text :: Sensitive Text
- newSearchPlaceIndexForTextSummary :: Text -> Text -> SearchPlaceIndexForTextSummary
- searchPlaceIndexForTextSummary_biasPosition :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_filterBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_filterCountries :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Text))
- searchPlaceIndexForTextSummary_language :: Lens' SearchPlaceIndexForTextSummary (Maybe Text)
- searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural)
- searchPlaceIndexForTextSummary_resultBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double))
- searchPlaceIndexForTextSummary_dataSource :: Lens' SearchPlaceIndexForTextSummary Text
- searchPlaceIndexForTextSummary_text :: Lens' SearchPlaceIndexForTextSummary Text
Documentation
data SearchPlaceIndexForTextSummary Source #
A summary of the request sent by using SearchPlaceIndexForText.
See: newSearchPlaceIndexForTextSummary smart constructor.
Constructors
| SearchPlaceIndexForTextSummary' | |
Fields
| |
Instances
newSearchPlaceIndexForTextSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> SearchPlaceIndexForTextSummary |
Create a value of SearchPlaceIndexForTextSummary 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:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_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:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_filterBBox - Contains the coordinates for the optional bounding box specified in the
request.
$sel:filterCountries:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_filterCountries - Contains the optional country filter specified in the request.
$sel:language:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_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:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_maxResults - Contains the optional result count limit specified in the request.
$sel:resultBBox:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_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.
$sel:dataSource:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_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:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_text - The search text specified in the request.
searchPlaceIndexForTextSummary_biasPosition :: Lens' SearchPlaceIndexForTextSummary (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.
searchPlaceIndexForTextSummary_filterBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #
Contains the coordinates for the optional bounding box specified in the request.
searchPlaceIndexForTextSummary_filterCountries :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Text)) Source #
Contains the optional country filter specified in the request.
searchPlaceIndexForTextSummary_language :: Lens' SearchPlaceIndexForTextSummary (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.
searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural) Source #
Contains the optional result count limit specified in the request.
searchPlaceIndexForTextSummary_resultBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #
The bounding box that fully contains all search results.
If you specified the optional FilterBBox parameter in the request,
ResultBBox is contained within FilterBBox.
searchPlaceIndexForTextSummary_dataSource :: Lens' SearchPlaceIndexForTextSummary 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.
searchPlaceIndexForTextSummary_text :: Lens' SearchPlaceIndexForTextSummary Text Source #
The search text specified in the request.