Module Awso_geo_places.ValuesSource

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 CategoryIdString : sig ... end
Sourcemodule CategoryNameString : sig ... end
Sourcemodule SensitiveBoolean : sig ... end
Sourcemodule LanguageTag : sig ... end
Sourcemodule Double : sig ... end
Sourcemodule TypePlacement : sig ... end
Sourcemodule TypeSeparator : sig ... end
Sourcemodule MatchScore : sig ... end
Sourcemodule HighlightEndIndexInteger : sig ... end
Sourcemodule HighlightValueString : sig ... end
Sourcemodule Category : sig ... end

Category of the Place returned.

Sourcemodule PhonemeTranscription : sig ... end

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

Sourcemodule Position : sig ... end
Sourcemodule CountryCode2 : sig ... end
Sourcemodule CountryCode3 : sig ... end
Sourcemodule CountryNameString : sig ... end
Sourcemodule IntersectionStreet : sig ... end
Sourcemodule RegionCodeString : sig ... end
Sourcemodule RegionNameString : sig ... end
Sourcemodule SecondaryAddressComponent : sig ... end

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

Sourcemodule StreetComponents : sig ... end

Components of a street.

Sourcemodule SubRegionCodeString : sig ... end
Sourcemodule SubRegionNameString : sig ... end

Match score for a secondary address component in the result.

Sourcemodule Highlight : sig ... end

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

Sourcemodule CategoryList : sig ... end
Sourcemodule BusinessChainIdString : sig ... end
Sourcemodule BusinessChainNameString : sig ... end
Sourcemodule FoodTypeIdString : sig ... end
Sourcemodule PhonemeTranscriptionList : sig ... end
Sourcemodule ContactDetailsLabelString : sig ... end
Sourcemodule ContactDetailsValueString : sig ... end
Sourcemodule OpeningHoursComponents : sig ... end

Components of the opening hours object.

Sourcemodule OpeningHoursDisplay : sig ... end
Sourcemodule AccessPoint : sig ... end

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

Sourcemodule AddressBlockString : sig ... end
Sourcemodule AddressBuildingString : sig ... end
Sourcemodule AddressDistrictString : sig ... end
Sourcemodule AddressLabelString : sig ... end
Sourcemodule AddressLocalityString : sig ... end
Sourcemodule AddressPostalCodeString : sig ... end
Sourcemodule AddressStreetString : sig ... end
Sourcemodule AddressSubBlockString : sig ... end
Sourcemodule AddressSubDistrictString : sig ... end
Sourcemodule Country : sig ... end

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

Sourcemodule IntersectionStreetList : sig ... end
Sourcemodule Region : sig ... end

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

Sourcemodule StreetComponentsList : sig ... end
Sourcemodule SubRegion : sig ... end

The sub-region.

Sourcemodule ZipClassificationCode : sig ... end
Sourcemodule RecordTypeCode : sig ... end
Sourcemodule ParsedQueryComponent : sig ... end

Parsed components in the provided QueryText.

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

Sourcemodule HighlightList : sig ... end
Sourcemodule AccessRestriction : sig ... end

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.

Sourcemodule BusinessChain : sig ... end

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

Sourcemodule FoodType : sig ... end

List of Food types offered by this result.

Sourcemodule AddressComponentPhonemes : sig ... end

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

Sourcemodule TimeZoneNameString : sig ... end
Sourcemodule TimeZoneOffsetSecondsLong : sig ... end
Sourcemodule TimeZoneOffsetString : sig ... end
Sourcemodule ContactDetails : sig ... end

Details related to contacts.

Sourcemodule OpeningHoursDisplayList : sig ... end
Sourcemodule AccessPointList : sig ... end
Sourcemodule Address : sig ... end

The place address.

Sourcemodule BoundingBox : sig ... end
Sourcemodule DistanceMeters : sig ... end
Sourcemodule IntersectionPlaceIdString : sig ... end
Sourcemodule IntersectionTitleString : sig ... end
Sourcemodule PostalAuthority : sig ... end
Sourcemodule PostalCodeType : sig ... end
Sourcemodule UspsZip : sig ... end

The USPS zip code.

Sourcemodule UspsZipPlus4 : sig ... end

The USPS zip+4 code.

Sourcemodule ParsedQueryComponentList : sig ... end

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

Sourcemodule PlaceType : sig ... end
Sourcemodule RelatedPlacePlaceIdString : sig ... end
Sourcemodule RelatedPlaceTitleString : sig ... end
Sourcemodule CountryHighlights : sig ... end

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

Sourcemodule RegionHighlights : sig ... end

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

Sourcemodule SubRegionHighlights : sig ... end

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

Sourcemodule SuggestAddressHighlights : sig ... end

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

Sourcemodule AccessRestrictionList : sig ... end
Sourcemodule BusinessChainList : sig ... end
Sourcemodule FoodTypeList : sig ... end
Sourcemodule PhonemeDetails : sig ... end

The phoneme details.

Sourcemodule TimeZone : sig ... end

The time zone in which the place is located.

Sourcemodule QueryType : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule ContactDetailsList : sig ... end
Sourcemodule OpeningHours : sig ... end

List of opening hours objects.

Sourcemodule Intersection : sig ... end

All Intersections that are near the provided address.

Sourcemodule PostalCodeDetails : sig ... end

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

Parsed address components in the provided QueryText.

Sourcemodule ComponentMatchScores : sig ... end

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.

Sourcemodule RelatedPlace : sig ... end

Place that is related to the result item.

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 SuggestHighlights : sig ... end

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

Sourcemodule SuggestPlaceResult : sig ... end

The suggested place results.

Sourcemodule SuggestQueryResult : sig ... end

The suggested query results.

Sourcemodule SuggestResultItemType : sig ... end
Sourcemodule ValidationExceptionField : sig ... end

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

Sourcemodule CountryCode : sig ... end
Sourcemodule FilterCircleRadiusLong : sig ... end
Sourcemodule Contacts : sig ... end

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

Sourcemodule OpeningHoursList : sig ... end
Sourcemodule IntersectionList : sig ... end
Sourcemodule PostalCodeDetailsList : sig ... end
Sourcemodule GeocodeParsedQuery : sig ... end

Parsed components in the provided QueryText.

Sourcemodule MatchScoreDetails : sig ... end

Details related to the match score.

Sourcemodule RelatedPlaceList : sig ... end
Sourcemodule GeocodeFilterPlaceType : sig ... end
Sourcemodule AutocompleteHighlights : sig ... end

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 QueryRefinement : sig ... end

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

Sourcemodule SuggestResultItem : sig ... end

The resulting item from the suggested query.

Sourcemodule ValidationExceptionReason : sig ... end
Sourcemodule SuggestAdditionalFeature : sig ... end
Sourcemodule CountryCodeList : sig ... end
Sourcemodule FilterCircle : sig ... end

The Circle that all results must be in.

Sourcemodule SearchTextResultItem : sig ... end

The text search result.

Sourcemodule SearchNearbyResultItem : sig ... end

The search results of nearby places.

Sourcemodule FilterBusinessChainList : sig ... end
Sourcemodule FilterCategoryList : sig ... end
Sourcemodule FilterFoodTypeList : sig ... end
Sourcemodule ReverseGeocodeResultItem : sig ... end

The returned location from the Reverse Geocode action.

Sourcemodule GetPlaceAdditionalFeature : sig ... end
Sourcemodule GeocodeResultItem : sig ... end

The Geocoded result.

Sourcemodule GeocodeAdditionalFeature : sig ... end
Sourcemodule AutocompleteResultItem : sig ... end

A result matching the input query text.

Sourcemodule AccessDeniedException : sig ... end

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

Sourcemodule InternalServerException : sig ... end

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

Sourcemodule QueryRefinementList : sig ... end
Sourcemodule SuggestResultItemList : sig ... end
Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

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

Sourcemodule ApiKey : sig ... end
Sourcemodule SuggestFilter : sig ... end

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

Sourcemodule SuggestIntendedUse : sig ... end
Sourcemodule SearchTextResultItemList : sig ... end
Sourcemodule Token : sig ... end
Sourcemodule SearchTextFilter : sig ... end

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

Sourcemodule SearchTextIntendedUse : sig ... end
Sourcemodule SearchNearbyFilter : sig ... end

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

Sourcemodule SearchNearbyIntendedUse : sig ... end
Sourcemodule Heading : sig ... end
Sourcemodule ReverseGeocodeFilter : sig ... end

The included place types.

Sourcemodule ReverseGeocodeIntendedUse : sig ... end
Sourcemodule GetPlaceIntendedUse : sig ... end
Sourcemodule GeocodeResultItemList : sig ... end
Sourcemodule GeocodeFilter : sig ... end

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

Sourcemodule GeocodeIntendedUse : sig ... end
Sourcemodule GeocodeQueryComponents : sig ... end

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

Sourcemodule AutocompleteFilter : sig ... end

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

Sourcemodule AutocompleteIntendedUse : sig ... end
Sourcemodule PostalCodeMode : sig ... end
Sourcemodule SuggestResponse : sig ... end

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.

Sourcemodule SuggestRequest : sig ... end

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.

Sourcemodule SearchTextResponse : sig ... end

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.

Sourcemodule SearchTextRequest : sig ... end

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.

Sourcemodule SearchNearbyResponse : sig ... end

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.

Sourcemodule SearchNearbyRequest : sig ... end

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.

Sourcemodule ReverseGeocodeResponse : sig ... end

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.

Sourcemodule ReverseGeocodeRequest : sig ... end

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.

Sourcemodule GetPlaceResponse : sig ... end

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.

Sourcemodule GetPlaceRequest : sig ... end

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.

Sourcemodule GeocodeResponse : sig ... end

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.

Sourcemodule GeocodeRequest : sig ... end

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.

Sourcemodule AutocompleteResponse : sig ... end

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.

Sourcemodule AutocompleteRequest : sig ... end

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.