Amazonka.Location.Types.SearchPlaceIndexForPositionSummary

Documentation

data SearchPlaceIndexForPositionSummary

A summary of the request sent by using SearchPlaceIndexForPosition.

See: newSearchPlaceIndexForPositionSummary smart constructor.

Constructors

SearchPlaceIndexForPositionSummary'

Fields

• 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 that is specified in the request.

  Default value: 50

• 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.

• position :: Sensitive (NonEmpty Double)

  The position specified in the request.

Instances

FromJSON SearchPlaceIndexForPositionSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForPositionSummary

Methods

parseJSON :: Value -> Parser SearchPlaceIndexForPositionSummary

parseJSONList :: Value -> Parser [SearchPlaceIndexForPositionSummary]

Generic SearchPlaceIndexForPositionSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForPositionSummary

Associated Types

type Rep SearchPlaceIndexForPositionSummary :: Type -> Type

Methods

from :: SearchPlaceIndexForPositionSummary -> Rep SearchPlaceIndexForPositionSummary x

to :: Rep SearchPlaceIndexForPositionSummary x -> SearchPlaceIndexForPositionSummary

Show SearchPlaceIndexForPositionSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForPositionSummary

Methods

showsPrec :: Int -> SearchPlaceIndexForPositionSummary -> ShowS

show :: SearchPlaceIndexForPositionSummary -> String

showList :: [SearchPlaceIndexForPositionSummary] -> ShowS

NFData SearchPlaceIndexForPositionSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForPositionSummary

Methods

rnf :: SearchPlaceIndexForPositionSummary -> ()

Eq SearchPlaceIndexForPositionSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForPositionSummary

Methods

(==) :: SearchPlaceIndexForPositionSummary -> SearchPlaceIndexForPositionSummary -> Bool

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

Hashable SearchPlaceIndexForPositionSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForPositionSummary

Methods

hashWithSalt :: Int -> SearchPlaceIndexForPositionSummary -> Int

hash :: SearchPlaceIndexForPositionSummary -> Int

type Rep SearchPlaceIndexForPositionSummary

Defined in Amazonka.Location.Types.SearchPlaceIndexForPositionSummary

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

newSearchPlaceIndexForPositionSummary

Arguments

:: Text

$sel:dataSource:SearchPlaceIndexForPositionSummary'

-> NonEmpty Double

$sel:position:SearchPlaceIndexForPositionSummary'

-> SearchPlaceIndexForPositionSummary

Create a value of SearchPlaceIndexForPositionSummary 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:language:SearchPlaceIndexForPositionSummary', searchPlaceIndexForPositionSummary_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:SearchPlaceIndexForPositionSummary', searchPlaceIndexForPositionSummary_maxResults - Contains the optional result count limit that is specified in the request.

Default value: 50

$sel:dataSource:SearchPlaceIndexForPositionSummary', searchPlaceIndexForPositionSummary_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:position:SearchPlaceIndexForPositionSummary', searchPlaceIndexForPositionSummary_position - The position specified in the request.

searchPlaceIndexForPositionSummary_language :: Lens' SearchPlaceIndexForPositionSummary (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.

searchPlaceIndexForPositionSummary_maxResults :: Lens' SearchPlaceIndexForPositionSummary (Maybe Natural)

Contains the optional result count limit that is specified in the request.

Default value: 50

searchPlaceIndexForPositionSummary_dataSource :: Lens' SearchPlaceIndexForPositionSummary 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.

searchPlaceIndexForPositionSummary_position :: Lens' SearchPlaceIndexForPositionSummary (NonEmpty Double)

The position specified in the request.