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

Description

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

Synopsis

Creating a Request

data SearchPlaceIndexForPosition Source #

See: newSearchPlaceIndexForPosition smart constructor.

Constructors

SearchPlaceIndexForPosition' 

Fields

  • maxResults :: Maybe Natural

    An optional paramer. The maximum number of results returned per request.

    Default value: 50

  • indexName :: Text

    The name of the place index resource you want to use for the search.

  • position :: Sensitive (NonEmpty Double)

    Specifies a coordinate for the query defined by a longitude, and latitude.

    • The first position is the X coordinate, or longitude.
    • The second position is the Y coordinate, or latitude.

    For example, position=xLongitude&position=yLatitude .

Instances

Instances details
Eq SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

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

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

Show SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

showsPrec :: Int -> SearchPlaceIndexForPosition -> ShowS #

show :: SearchPlaceIndexForPosition -> String #

showList :: [SearchPlaceIndexForPosition] -> ShowS #

Generic SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Associated Types

type Rep SearchPlaceIndexForPosition :: Type -> Type #

Methods

from :: SearchPlaceIndexForPosition -> Rep SearchPlaceIndexForPosition x #

to :: Rep SearchPlaceIndexForPosition x -> SearchPlaceIndexForPosition #

NFData SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

rnf :: SearchPlaceIndexForPosition -> () #

Hashable SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

hashWithSalt :: Int -> SearchPlaceIndexForPosition -> Int #

hash :: SearchPlaceIndexForPosition -> Int #

ToJSON SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

toJSON :: SearchPlaceIndexForPosition -> Value #

toEncoding :: SearchPlaceIndexForPosition -> Encoding #

toJSONList :: [SearchPlaceIndexForPosition] -> Value #

toEncodingList :: [SearchPlaceIndexForPosition] -> Encoding #

AWSRequest SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Associated Types

type AWSResponse SearchPlaceIndexForPosition #

Methods

request :: SearchPlaceIndexForPosition -> Request SearchPlaceIndexForPosition #

response :: MonadResource m => Logger -> Service -> Proxy SearchPlaceIndexForPosition -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchPlaceIndexForPosition))) #

ToHeaders SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

toHeaders :: SearchPlaceIndexForPosition -> [Header] #

ToPath SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

toPath :: SearchPlaceIndexForPosition -> ByteString #

ToQuery SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

toQuery :: SearchPlaceIndexForPosition -> QueryString #

type Rep SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

type Rep SearchPlaceIndexForPosition = D1 ('MetaData "SearchPlaceIndexForPosition" "Amazonka.Location.SearchPlaceIndexForPosition" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "SearchPlaceIndexForPosition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (NonEmpty Double))))))
type AWSResponse SearchPlaceIndexForPosition Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

type AWSResponse SearchPlaceIndexForPosition = SearchPlaceIndexForPositionResponse

newSearchPlaceIndexForPosition Source #

Arguments

:: Text

$sel:indexName:SearchPlaceIndexForPosition'

-> NonEmpty Double

$sel:position:SearchPlaceIndexForPosition'

-> SearchPlaceIndexForPosition 

Create a value of SearchPlaceIndexForPosition 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:maxResults:SearchPlaceIndexForPosition', searchPlaceIndexForPosition_maxResults - An optional paramer. The maximum number of results returned per request.

Default value: 50

$sel:indexName:SearchPlaceIndexForPosition', searchPlaceIndexForPosition_indexName - The name of the place index resource you want to use for the search.

$sel:position:SearchPlaceIndexForPosition', searchPlaceIndexForPosition_position - Specifies a coordinate for the query defined by a longitude, and latitude.

  • The first position is the X coordinate, or longitude.
  • The second position is the Y coordinate, or latitude.

For example, position=xLongitude&position=yLatitude .

Request Lenses

searchPlaceIndexForPosition_maxResults :: Lens' SearchPlaceIndexForPosition (Maybe Natural) Source #

An optional paramer. The maximum number of results returned per request.

Default value: 50

searchPlaceIndexForPosition_indexName :: Lens' SearchPlaceIndexForPosition Text Source #

The name of the place index resource you want to use for the search.

searchPlaceIndexForPosition_position :: Lens' SearchPlaceIndexForPosition (NonEmpty Double) Source #

Specifies a coordinate for the query defined by a longitude, and latitude.

  • The first position is the X coordinate, or longitude.
  • The second position is the Y coordinate, or latitude.

For example, position=xLongitude&position=yLatitude .

Destructuring the Response

data SearchPlaceIndexForPositionResponse Source #

See: newSearchPlaceIndexForPositionResponse smart constructor.

Constructors

SearchPlaceIndexForPositionResponse' 

Fields

Instances

Instances details
Eq SearchPlaceIndexForPositionResponse Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

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

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

Show SearchPlaceIndexForPositionResponse Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

showsPrec :: Int -> SearchPlaceIndexForPositionResponse -> ShowS #

show :: SearchPlaceIndexForPositionResponse -> String #

showList :: [SearchPlaceIndexForPositionResponse] -> ShowS #

Generic SearchPlaceIndexForPositionResponse Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Associated Types

type Rep SearchPlaceIndexForPositionResponse :: Type -> Type #

Methods

from :: SearchPlaceIndexForPositionResponse -> Rep SearchPlaceIndexForPositionResponse x #

to :: Rep SearchPlaceIndexForPositionResponse x -> SearchPlaceIndexForPositionResponse #

NFData SearchPlaceIndexForPositionResponse Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

Methods

rnf :: SearchPlaceIndexForPositionResponse -> () #

type Rep SearchPlaceIndexForPositionResponse Source # 
Instance details

Defined in Amazonka.Location.SearchPlaceIndexForPosition

type Rep SearchPlaceIndexForPositionResponse = D1 ('MetaData "SearchPlaceIndexForPositionResponse" "Amazonka.Location.SearchPlaceIndexForPosition" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "SearchPlaceIndexForPositionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SearchForPositionResult]) :*: S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SearchPlaceIndexForPositionSummary))))

newSearchPlaceIndexForPositionResponse Source #

Arguments

:: Int

$sel:httpStatus:SearchPlaceIndexForPositionResponse'

-> SearchPlaceIndexForPositionSummary

$sel:summary:SearchPlaceIndexForPositionResponse'

-> SearchPlaceIndexForPositionResponse 

Create a value of SearchPlaceIndexForPositionResponse 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:httpStatus:SearchPlaceIndexForPositionResponse', searchPlaceIndexForPositionResponse_httpStatus - The response's http status code.

$sel:results:SearchPlaceIndexForPositionResponse', searchPlaceIndexForPositionResponse_results - Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

$sel:summary:SearchPlaceIndexForPositionResponse', searchPlaceIndexForPositionResponse_summary - Contains a summary of the request.

Response Lenses

searchPlaceIndexForPositionResponse_httpStatus :: Lens' SearchPlaceIndexForPositionResponse Int Source #

The response's http status code.

searchPlaceIndexForPositionResponse_results :: Lens' SearchPlaceIndexForPositionResponse [SearchForPositionResult] Source #

Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

searchPlaceIndexForPositionResponse_summary :: Lens' SearchPlaceIndexForPositionResponse SearchPlaceIndexForPositionSummary Source #

Contains a summary of the request.