Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Documentation

data SearchPlaceIndexForTextSummary

A summary of the request sent by using SearchPlaceIndexForText.

See: newSearchPlaceIndexForTextSummary smart constructor.

Constructors

SearchPlaceIndexForTextSummary'

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 Natural

  Contains the optional result count limit specified in the request.

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

  The bounding box that fully contains all search results.

  If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

• 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 search text specified in the request.

Instances

FromJSON SearchPlaceIndexForTextSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

parseJSON :: Value -> Parser SearchPlaceIndexForTextSummary

parseJSONList :: Value -> Parser [SearchPlaceIndexForTextSummary]

Generic SearchPlaceIndexForTextSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Associated Types

type Rep SearchPlaceIndexForTextSummary :: Type -> Type

Methods

from :: SearchPlaceIndexForTextSummary -> Rep SearchPlaceIndexForTextSummary x

to :: Rep SearchPlaceIndexForTextSummary x -> SearchPlaceIndexForTextSummary

Show SearchPlaceIndexForTextSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

showsPrec :: Int -> SearchPlaceIndexForTextSummary -> ShowS

show :: SearchPlaceIndexForTextSummary -> String

showList :: [SearchPlaceIndexForTextSummary] -> ShowS

NFData SearchPlaceIndexForTextSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

rnf :: SearchPlaceIndexForTextSummary -> ()

Eq SearchPlaceIndexForTextSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

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

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

Hashable SearchPlaceIndexForTextSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

Methods

hashWithSalt :: Int -> SearchPlaceIndexForTextSummary -> Int

hash :: SearchPlaceIndexForTextSummary -> Int

type Rep SearchPlaceIndexForTextSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForTextSummary

type Rep SearchPlaceIndexForTextSummary = D1 ('MetaData "SearchPlaceIndexForTextSummary" "Amazonka.Location.Types.SearchPlaceIndexForTextSummary" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "SearchPlaceIndexForTextSummary'" '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 Natural)) :*: S1 ('MetaSel ('Just "resultBBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (NonEmpty Double))))) :*: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newSearchPlaceIndexForTextSummary

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

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

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

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

Contains the optional country filter specified in the request.

searchPlaceIndexForTextSummary_language :: Lens' SearchPlaceIndexForTextSummary (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.

searchPlaceIndexForTextSummary_maxResults :: Lens' SearchPlaceIndexForTextSummary (Maybe Natural)

Contains the optional result count limit specified in the request.

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

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

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

The search text specified in the request.