libZSservicesZSamazonka-locationZSamazonka-location
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Description

 
Synopsis

Documentation

data SearchPlaceIndexForTextSummary Source #

A summary of the geocoding request sent using SearchPlaceIndexForText.

See: newSearchPlaceIndexForTextSummary smart constructor.

Constructors

SearchPlaceIndexForTextSummary' 

Fields

Instances

Instances details
Eq SearchPlaceIndexForTextSummary Source # 
Instance details

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

(==) :: SearchPlaceIndexForTextSummary -> SearchPlaceIndexForTextSummary -> Bool #

(/=) :: SearchPlaceIndexForTextSummary -> SearchPlaceIndexForTextSummary -> Bool #

Show SearchPlaceIndexForTextSummary Source # 
Instance details

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

showsPrec :: Int -> SearchPlaceIndexForTextSummary -> ShowS #

show :: SearchPlaceIndexForTextSummary -> String #

showList :: [SearchPlaceIndexForTextSummary] -> ShowS #

Generic SearchPlaceIndexForTextSummary Source # 
Instance details

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Associated Types

type Rep SearchPlaceIndexForTextSummary :: Type -> Type #

Methods

from :: SearchPlaceIndexForTextSummary -> Rep SearchPlaceIndexForTextSummary x #

to :: Rep SearchPlaceIndexForTextSummary x -> SearchPlaceIndexForTextSummary #

NFData SearchPlaceIndexForTextSummary Source # 
Instance details

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

rnf :: SearchPlaceIndexForTextSummary -> () #

Hashable SearchPlaceIndexForTextSummary Source # 
Instance details

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

hashWithSalt :: Int -> SearchPlaceIndexForTextSummary -> Int #

hash :: SearchPlaceIndexForTextSummary -> Int #

FromJSON SearchPlaceIndexForTextSummary Source # 
Instance details

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

parseJSON :: Value -> Parser SearchPlaceIndexForTextSummary #

parseJSONList :: Value -> Parser [SearchPlaceIndexForTextSummary] #

type Rep SearchPlaceIndexForTextSummary Source # 
Instance details

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

type Rep SearchPlaceIndexForTextSummary = D1 ('MetaData "SearchPlaceIndexForTextSummary" "Amazonka.Location.Types.SearchPlaceIndexForTextSummary" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "SearchPlaceIndexForTextSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterBBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (NonEmpty Double)))) :*: (S1 ('MetaSel ('Just "resultBBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (NonEmpty Double)))) :*: S1 ('MetaSel ('Just "biasPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (NonEmpty Double)))))) :*: ((S1 ('MetaSel ('Just "filterCountries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newSearchPlaceIndexForTextSummary Source #

Arguments

:: Text

$sel:dataSource:SearchPlaceIndexForTextSummary'

-> Text

$sel:text:SearchPlaceIndexForTextSummary'

-> 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:filterBBox:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_filterBBox - Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

$sel:resultBBox:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_resultBBox - A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.

$sel:biasPosition:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_biasPosition - Contains the coordinates for the bias position entered in the geocoding request.

$sel:filterCountries:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_filterCountries - Contains the country filter entered in the geocoding request.

$sel:maxResults:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_maxResults - Contains the maximum number of results indicated for the request.

$sel:dataSource:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_dataSource - The data provider of geospatial data. Indicates one of the available providers:

  • Esri
  • HERE

For additional details on data providers, see Amazon Location Service data providers.

$sel:text:SearchPlaceIndexForTextSummary', searchPlaceIndexForTextSummary_text - The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.

searchPlaceIndexForTextSummary_filterBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #

Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

searchPlaceIndexForTextSummary_resultBBox :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #

A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.

searchPlaceIndexForTextSummary_biasPosition :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Double)) Source #

Contains the coordinates for the bias position entered in the geocoding request.

searchPlaceIndexForTextSummary_filterCountries :: Lens' SearchPlaceIndexForTextSummary (Maybe (NonEmpty Text)) Source #

Contains the country filter entered in the geocoding request.

searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural) Source #

Contains the maximum number of results indicated for the request.

searchPlaceIndexForTextSummary_dataSource :: Lens' SearchPlaceIndexForTextSummary Text Source #

The data provider of geospatial data. Indicates one of the available providers:

  • Esri
  • HERE

For additional details on data providers, see Amazon Location Service data providers.

searchPlaceIndexForTextSummary_text :: Lens' SearchPlaceIndexForTextSummary Text Source #

The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.