Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary

Documentation

data SearchPlaceIndexForSuggestionsSummary

A summary of the request sent by using SearchPlaceIndexForSuggestions.

See: newSearchPlaceIndexForSuggestionsSummary smart constructor.

Constructors

SearchPlaceIndexForSuggestionsSummary'

Fields

• biasPosition :: Maybe (Sensitive (NonEmpty Double))

  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.

• filterBBox :: Maybe (Sensitive (NonEmpty Double))

  Contains the coordinates for the optional bounding box specified in the request.

• filterCountries :: Maybe (NonEmpty Text)

  Contains the optional country filter specified in the request.

• language :: Maybe Text

  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.

• maxResults :: Maybe Int

  Contains the optional result count limit specified in the request.

• dataSource :: Text

  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.

• text :: Sensitive Text

  The free-form partial text input specified in the request.

Instances

FromJSON SearchPlaceIndexForSuggestionsSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary

Methods

parseJSON :: Value -> Parser SearchPlaceIndexForSuggestionsSummary

parseJSONList :: Value -> Parser [SearchPlaceIndexForSuggestionsSummary]

Generic SearchPlaceIndexForSuggestionsSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary

Associated Types

type Rep SearchPlaceIndexForSuggestionsSummary :: Type -> Type

Methods

from :: SearchPlaceIndexForSuggestionsSummary -> Rep SearchPlaceIndexForSuggestionsSummary x

to :: Rep SearchPlaceIndexForSuggestionsSummary x -> SearchPlaceIndexForSuggestionsSummary

Show SearchPlaceIndexForSuggestionsSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary

Methods

showsPrec :: Int -> SearchPlaceIndexForSuggestionsSummary -> ShowS

show :: SearchPlaceIndexForSuggestionsSummary -> String

showList :: [SearchPlaceIndexForSuggestionsSummary] -> ShowS

NFData SearchPlaceIndexForSuggestionsSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary

Methods

rnf :: SearchPlaceIndexForSuggestionsSummary -> ()

Eq SearchPlaceIndexForSuggestionsSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary

Methods

(==) :: SearchPlaceIndexForSuggestionsSummary -> SearchPlaceIndexForSuggestionsSummary -> Bool

(/=) :: SearchPlaceIndexForSuggestionsSummary -> SearchPlaceIndexForSuggestionsSummary -> Bool

Hashable SearchPlaceIndexForSuggestionsSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary

Methods

hashWithSalt :: Int -> SearchPlaceIndexForSuggestionsSummary -> Int

hash :: SearchPlaceIndexForSuggestionsSummary -> Int

type Rep SearchPlaceIndexForSuggestionsSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary

type Rep SearchPlaceIndexForSuggestionsSummary = D1 ('MetaData "SearchPlaceIndexForSuggestionsSummary" "Amazonka.Location.Types.SearchPlaceIndexForSuggestionsSummary" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "SearchPlaceIndexForSuggestionsSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "biasPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (NonEmpty Double)))) :*: (S1 ('MetaSel ('Just "filterBBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (NonEmpty Double)))) :*: S1 ('MetaSel ('Just "filterCountries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) :*: ((S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newSearchPlaceIndexForSuggestionsSummary

Arguments

:: Text

$sel:dataSource:SearchPlaceIndexForSuggestionsSummary'

-> Text

$sel:text:SearchPlaceIndexForSuggestionsSummary'

-> 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))

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))

Contains the coordinates for the optional bounding box specified in the request.

searchPlaceIndexForSuggestionsSummary_filterCountries :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe (NonEmpty Text))

Contains the optional country filter specified in the request.

searchPlaceIndexForSuggestionsSummary_language :: Lens' SearchPlaceIndexForSuggestionsSummary (Maybe Text)

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)

Contains the optional result count limit specified in the request.

searchPlaceIndexForSuggestionsSummary_dataSource :: Lens' SearchPlaceIndexForSuggestionsSummary Text

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

The free-form partial text input specified in the request.