Module Awso_geo_places_lwtSource

include module type of struct include Awso_geo_places.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule PhonemeTranscriptionValueString = Awso_geo_places.Values.PhonemeTranscriptionValueString
Sourcemodule SecondaryAddressComponentDesignatorString = Awso_geo_places.Values.SecondaryAddressComponentDesignatorString
Sourcemodule SecondaryAddressComponentNumberString = Awso_geo_places.Values.SecondaryAddressComponentNumberString
Sourcemodule StreetComponentsBaseNameString = Awso_geo_places.Values.StreetComponentsBaseNameString
Sourcemodule StreetComponentsDirectionString = Awso_geo_places.Values.StreetComponentsDirectionString
Sourcemodule StreetComponentsPrefixString = Awso_geo_places.Values.StreetComponentsPrefixString
Sourcemodule StreetComponentsSuffixString = Awso_geo_places.Values.StreetComponentsSuffixString

Category of the Place returned.

How to pronounce the various components of the address or place.

Sourcemodule OpeningHoursComponentsOpenDurationString = Awso_geo_places.Values.OpeningHoursComponentsOpenDurationString
Sourcemodule OpeningHoursComponentsOpenTimeString = Awso_geo_places.Values.OpeningHoursComponentsOpenTimeString
Sourcemodule OpeningHoursComponentsRecurrenceString = Awso_geo_places.Values.OpeningHoursComponentsRecurrenceString

Components that correspond to secondary identifiers on an address. The only component type supported currently is Unit.

Components of a street.

Sourcemodule ParsedQueryComponentEndIndexInteger = Awso_geo_places.Values.ParsedQueryComponentEndIndexInteger
Sourcemodule ParsedQueryComponentQueryComponentString = Awso_geo_places.Values.ParsedQueryComponentQueryComponentString
Sourcemodule ParsedQueryComponentStartIndexInteger = Awso_geo_places.Values.ParsedQueryComponentStartIndexInteger
Sourcemodule ParsedQueryComponentValueString = Awso_geo_places.Values.ParsedQueryComponentValueString
Sourcemodule ParsedQuerySecondaryAddressComponentDesignatorString = Awso_geo_places.Values.ParsedQuerySecondaryAddressComponentDesignatorString
Sourcemodule ParsedQuerySecondaryAddressComponentEndIndexInteger = Awso_geo_places.Values.ParsedQuerySecondaryAddressComponentEndIndexInteger
Sourcemodule ParsedQuerySecondaryAddressComponentNumberString = Awso_geo_places.Values.ParsedQuerySecondaryAddressComponentNumberString
Sourcemodule ParsedQuerySecondaryAddressComponentStartIndexInteger = Awso_geo_places.Values.ParsedQuerySecondaryAddressComponentStartIndexInteger
Sourcemodule ParsedQuerySecondaryAddressComponentValueString = Awso_geo_places.Values.ParsedQuerySecondaryAddressComponentValueString
Sourcemodule SecondaryAddressComponentMatchScore = Awso_geo_places.Values.SecondaryAddressComponentMatchScore

Match score for a secondary address component in the result.

Indicates the starting and ending index of the text query that match the found title.

Components of the opening hours object.

Position of the access point represented by longitude and latitude for a vehicle.

The alpha-2 or alpha-3 character code for the country that the results will be present in.

The region or state results should be to be present in. Example: North Rhine-Westphalia.

Sourcemodule SecondaryAddressComponentList = Awso_geo_places.Values.SecondaryAddressComponentList

The sub-region.

Parsed components in the provided QueryText.

Sourcemodule ParsedQuerySecondaryAddressComponent = Awso_geo_places.Values.ParsedQuerySecondaryAddressComponent

Information about a secondary address component parsed from the query text.

Sourcemodule AddressComponentMatchScoresIntersectionList = Awso_geo_places.Values.AddressComponentMatchScoresIntersectionList
Sourcemodule SecondaryAddressComponentMatchScoreList = Awso_geo_places.Values.SecondaryAddressComponentMatchScoreList

Indicates if the access location is restricted. Index correlates to that of an access point and indicates if access through this point has some form of restriction.

A businesschain is a chain of businesses that belong to the same brand. For example 7-11.

List of Food types offered by this result.

How to pronounce the various components of the address or place.

Details related to contacts.

The place address.

Sourcemodule PostalCodeDetailsPostalCodeString = Awso_geo_places.Values.PostalCodeDetailsPostalCodeString

The USPS zip code.

The USPS zip+4 code.

Sourcemodule ParsedQuerySecondaryAddressComponentList = Awso_geo_places.Values.ParsedQuerySecondaryAddressComponentList

Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

Indicates the starting and ending index of the country in the text query that match the found title.

Indicates the starting and ending index of the region in the text query that match the found title.

Indicates the starting and ending index of the sub-region in the text query that match the found title.

Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.

The phoneme details.

Sourcemodule SuggestPlaceResultPlaceIdString = Awso_geo_places.Values.SuggestPlaceResultPlaceIdString

The time zone in which the place is located.

Sourcemodule SuggestQueryResultQueryIdString = Awso_geo_places.Values.SuggestQueryResultQueryIdString

List of opening hours objects.

All Intersections that are near the provided address.

Contains details about the postal code of the place or result.

Sourcemodule GeocodeParsedQueryAddressComponents = Awso_geo_places.Values.GeocodeParsedQueryAddressComponents

Parsed address components in the provided QueryText.

Indicates how well the returned title and address components matches the input TextQuery. For each component a score is provied with 1 indicating all tokens were matched and 0 indicating no tokens were matched.

Place that is related to the result item.

Sourcemodule AutocompleteAddressHighlights = Awso_geo_places.Values.AutocompleteAddressHighlights

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

Sourcemodule QueryRefinementEndIndexInteger = Awso_geo_places.Values.QueryRefinementEndIndexInteger
Sourcemodule QueryRefinementOriginalTermString = Awso_geo_places.Values.QueryRefinementOriginalTermString
Sourcemodule QueryRefinementRefinedTermString = Awso_geo_places.Values.QueryRefinementRefinedTermString
Sourcemodule QueryRefinementStartIndexInteger = Awso_geo_places.Values.QueryRefinementStartIndexInteger

Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.

The suggested place results.

The suggested query results.

Sourcemodule SuggestResultItemTitleString = Awso_geo_places.Values.SuggestResultItemTitleString

The input fails to satisfy the constraints specified by the Amazon Location service.

A list of potential contact methods for the result/place.

Sourcemodule SearchTextResultItemPlaceIdString = Awso_geo_places.Values.SearchTextResultItemPlaceIdString
Sourcemodule SearchTextResultItemTitleString = Awso_geo_places.Values.SearchTextResultItemTitleString
Sourcemodule SearchNearbyResultItemPlaceIdString = Awso_geo_places.Values.SearchNearbyResultItemPlaceIdString
Sourcemodule SearchNearbyResultItemTitleString = Awso_geo_places.Values.SearchNearbyResultItemTitleString
Sourcemodule FilterBusinessChainListMemberString = Awso_geo_places.Values.FilterBusinessChainListMemberString
Sourcemodule FilterCategoryListMemberString = Awso_geo_places.Values.FilterCategoryListMemberString
Sourcemodule FilterFoodTypeListMemberString = Awso_geo_places.Values.FilterFoodTypeListMemberString
Sourcemodule ReverseGeocodeResultItemPlaceIdString = Awso_geo_places.Values.ReverseGeocodeResultItemPlaceIdString
Sourcemodule ReverseGeocodeResultItemTitleString = Awso_geo_places.Values.ReverseGeocodeResultItemTitleString
Sourcemodule ReverseGeocodeFilterPlaceType = Awso_geo_places.Values.ReverseGeocodeFilterPlaceType

Parsed components in the provided QueryText.

Sourcemodule GeocodeResultItemPlaceIdString = Awso_geo_places.Values.GeocodeResultItemPlaceIdString
Sourcemodule GeocodeResultItemTitleString = Awso_geo_places.Values.GeocodeResultItemTitleString

Details related to the match score.

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

Sourcemodule AutocompleteResultItemPlaceIdString = Awso_geo_places.Values.AutocompleteResultItemPlaceIdString
Sourcemodule AutocompleteResultItemTitleString = Awso_geo_places.Values.AutocompleteResultItemTitleString

Suggestions for refining individual query terms. Suggestions are returned as objects which note the term, suggested replacement, and its index in the query.

The resulting item from the suggested query.

Sourcemodule ValidationExceptionFieldList = Awso_geo_places.Values.ValidationExceptionFieldList

The Circle that all results must be in.

The text search result.

The search results of nearby places.

Sourcemodule SearchNearbyAdditionalFeature = Awso_geo_places.Values.SearchNearbyAdditionalFeature

The returned location from the Reverse Geocode action.

Sourcemodule ReverseGeocodeAdditionalFeature = Awso_geo_places.Values.ReverseGeocodeAdditionalFeature
Sourcemodule ReverseGeocodeFilterPlaceTypeList = Awso_geo_places.Values.ReverseGeocodeFilterPlaceTypeList

The Geocoded result.

Sourcemodule GeocodeQueryComponentsAddressNumberString = Awso_geo_places.Values.GeocodeQueryComponentsAddressNumberString
Sourcemodule GeocodeQueryComponentsCountryString = Awso_geo_places.Values.GeocodeQueryComponentsCountryString
Sourcemodule GeocodeQueryComponentsDistrictString = Awso_geo_places.Values.GeocodeQueryComponentsDistrictString
Sourcemodule GeocodeQueryComponentsLocalityString = Awso_geo_places.Values.GeocodeQueryComponentsLocalityString
Sourcemodule GeocodeQueryComponentsPostalCodeString = Awso_geo_places.Values.GeocodeQueryComponentsPostalCodeString
Sourcemodule GeocodeQueryComponentsRegionString = Awso_geo_places.Values.GeocodeQueryComponentsRegionString
Sourcemodule GeocodeQueryComponentsStreetString = Awso_geo_places.Values.GeocodeQueryComponentsStreetString
Sourcemodule GeocodeQueryComponentsSubRegionString = Awso_geo_places.Values.GeocodeQueryComponentsSubRegionString

A result matching the input query text.

Sourcemodule AutocompleteAdditionalFeature = Awso_geo_places.Values.AutocompleteAdditionalFeature
Sourcemodule AutocompleteFilterPlaceTypeList = Awso_geo_places.Values.AutocompleteFilterPlaceTypeList

You don't have sufficient access to perform this action.

The request processing has failed because of an unknown error, exception or failure.

The request was denied due to request throttling.

The input fails to satisfy the constraints specified by an AWS service.

Sourcemodule SuggestAdditionalFeatureList = Awso_geo_places.Values.SuggestAdditionalFeatureList

SuggestFilter structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

Sourcemodule SuggestRequestMaxQueryRefinementsInteger = Awso_geo_places.Values.SuggestRequestMaxQueryRefinementsInteger
Sourcemodule SuggestRequestMaxResultsInteger = Awso_geo_places.Values.SuggestRequestMaxResultsInteger
Sourcemodule SuggestRequestQueryTextString = Awso_geo_places.Values.SuggestRequestQueryTextString
Sourcemodule SearchTextAdditionalFeatureList = Awso_geo_places.Values.SearchTextAdditionalFeatureList

SearchText structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

Sourcemodule SearchTextRequestMaxResultsInteger = Awso_geo_places.Values.SearchTextRequestMaxResultsInteger
Sourcemodule SearchTextRequestQueryIdString = Awso_geo_places.Values.SearchTextRequestQueryIdString
Sourcemodule SearchTextRequestQueryTextString = Awso_geo_places.Values.SearchTextRequestQueryTextString
Sourcemodule SearchNearbyAdditionalFeatureList = Awso_geo_places.Values.SearchNearbyAdditionalFeatureList

SearchNearby structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

Sourcemodule SearchNearbyRequestMaxResultsInteger = Awso_geo_places.Values.SearchNearbyRequestMaxResultsInteger
Sourcemodule SearchNearbyRequestQueryRadiusLong = Awso_geo_places.Values.SearchNearbyRequestQueryRadiusLong
Sourcemodule ReverseGeocodeResultItemList = Awso_geo_places.Values.ReverseGeocodeResultItemList
Sourcemodule ReverseGeocodeAdditionalFeatureList = Awso_geo_places.Values.ReverseGeocodeAdditionalFeatureList

The included place types.

Sourcemodule ReverseGeocodeRequestMaxResultsInteger = Awso_geo_places.Values.ReverseGeocodeRequestMaxResultsInteger
Sourcemodule ReverseGeocodeRequestQueryRadiusLong = Awso_geo_places.Values.ReverseGeocodeRequestQueryRadiusLong
Sourcemodule GetPlaceResponsePlaceIdString = Awso_geo_places.Values.GetPlaceResponsePlaceIdString
Sourcemodule GetPlaceAdditionalFeatureList = Awso_geo_places.Values.GetPlaceAdditionalFeatureList
Sourcemodule GetPlaceRequestPlaceIdString = Awso_geo_places.Values.GetPlaceRequestPlaceIdString
Sourcemodule GeocodeAdditionalFeatureList = Awso_geo_places.Values.GeocodeAdditionalFeatureList

Geocode structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

A structured free text query allows you to search for places by the name or text representation of specific properties of the place.

Sourcemodule GeocodeRequestMaxResultsInteger = Awso_geo_places.Values.GeocodeRequestMaxResultsInteger
Sourcemodule GeocodeRequestQueryTextString = Awso_geo_places.Values.GeocodeRequestQueryTextString
Sourcemodule AutocompleteAdditionalFeatureList = Awso_geo_places.Values.AutocompleteAdditionalFeatureList

Autocomplete structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

Sourcemodule AutocompleteRequestMaxResultsInteger = Awso_geo_places.Values.AutocompleteRequestMaxResultsInteger
Sourcemodule AutocompleteRequestQueryTextString = Awso_geo_places.Values.AutocompleteRequestQueryTextString

Suggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information. For more information, see Suggest in the Amazon Location Service Developer Guide.

Suggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information. For more information, see Suggest in the Amazon Location Service Developer Guide.

SearchText searches for geocode and place information. You can then complete a follow-up query suggested from the Suggest API via a query id. For more information, see Search Text in the Amazon Location Service Developer Guide.

SearchText searches for geocode and place information. You can then complete a follow-up query suggested from the Suggest API via a query id. For more information, see Search Text in the Amazon Location Service Developer Guide.

SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. For more information, see Search Nearby in the Amazon Location Service Developer Guide.

SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. For more information, see Search Nearby in the Amazon Location Service Developer Guide.

ReverseGeocode converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see Reverse Geocode in the Amazon Location Service Developer Guide.

ReverseGeocode converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see Reverse Geocode in the Amazon Location Service Developer Guide.

GetPlace finds a place by its unique ID. A PlaceId is returned by other place operations. For more information, see GetPlace in the Amazon Location Service Developer Guide.

GetPlace finds a place by its unique ID. A PlaceId is returned by other place operations. For more information, see GetPlace in the Amazon Location Service Developer Guide.

Geocode converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see Geocode in the Amazon Location Service Developer Guide.

Geocode converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see Geocode in the Amazon Location Service Developer Guide.

Autocomplete completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views. For more information, see Autocomplete in the Amazon Location Service Developer Guide.

Autocomplete completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views. For more information, see Autocomplete in the Amazon Location Service Developer Guide.