amazonka-location-2.0: Amazon Location Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Location.Types.SearchForSuggestionsResult

Description

 
Synopsis

Documentation

data SearchForSuggestionsResult Source #

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

See: newSearchForSuggestionsResult smart constructor.

Constructors

SearchForSuggestionsResult' 

Fields

  • placeId :: Maybe Text

    The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

    For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use HERE or Esri as data providers.

  • text :: Text

    The text of the place suggestion, typically formatted as an address string.

Instances

Instances details
FromJSON SearchForSuggestionsResult Source # 
Instance details

Defined in Amazonka.Location.Types.SearchForSuggestionsResult

Generic SearchForSuggestionsResult Source # 
Instance details

Defined in Amazonka.Location.Types.SearchForSuggestionsResult

Associated Types

type Rep SearchForSuggestionsResult :: Type -> Type #

Read SearchForSuggestionsResult Source # 
Instance details

Defined in Amazonka.Location.Types.SearchForSuggestionsResult

Show SearchForSuggestionsResult Source # 
Instance details

Defined in Amazonka.Location.Types.SearchForSuggestionsResult

NFData SearchForSuggestionsResult Source # 
Instance details

Defined in Amazonka.Location.Types.SearchForSuggestionsResult

Eq SearchForSuggestionsResult Source # 
Instance details

Defined in Amazonka.Location.Types.SearchForSuggestionsResult

Hashable SearchForSuggestionsResult Source # 
Instance details

Defined in Amazonka.Location.Types.SearchForSuggestionsResult

type Rep SearchForSuggestionsResult Source # 
Instance details

Defined in Amazonka.Location.Types.SearchForSuggestionsResult

type Rep SearchForSuggestionsResult = D1 ('MetaData "SearchForSuggestionsResult" "Amazonka.Location.Types.SearchForSuggestionsResult" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "SearchForSuggestionsResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "placeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSearchForSuggestionsResult Source #

Create a value of SearchForSuggestionsResult 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:placeId:SearchForSuggestionsResult', searchForSuggestionsResult_placeId - The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use HERE or Esri as data providers.

$sel:text:SearchForSuggestionsResult', searchForSuggestionsResult_text - The text of the place suggestion, typically formatted as an address string.

searchForSuggestionsResult_placeId :: Lens' SearchForSuggestionsResult (Maybe Text) Source #

The unique identifier of the place. You can use this with the GetPlace operation to find the place again later.

For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use HERE or Esri as data providers.

searchForSuggestionsResult_text :: Lens' SearchForSuggestionsResult Text Source #

The text of the place suggestion, typically formatted as an address string.