Module Values.GeocodeRequestSource

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.

Sourcetype nonrec t = {
  1. queryText : GeocodeRequestQueryTextString.t option;
    (*

    The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

    *)
  2. queryComponents : GeocodeQueryComponents.t option;
  3. maxResults : GeocodeRequestMaxResultsInteger.t option;
    (*

    An optional limit for the number of results returned in a single call. Default value: 20

    *)
  4. biasPosition : Position.t option;
    (*

    The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WGS 84 format.

    *)
  5. filter : GeocodeFilter.t option;
    (*

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

    *)
  6. additionalFeatures : GeocodeAdditionalFeatureList.t option;
    (*

    A list of optional additional parameters, such as time zone, that can be requested for each result.

    *)
  7. language : LanguageTag.t option;
    (*

    A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

    *)
  8. politicalView : CountryCode.t option;
    (*

    The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

    *)
  9. intendedUse : GeocodeIntendedUse.t option;
    (*

    Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. When storing Geocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

    *)
  10. key : ApiKey.t option;
    (*

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    *)
}
Sourceval make : ?queryText:??? -> ?queryComponents:??? -> ?maxResults:??? -> ?biasPosition:??? -> ?filter:??? -> ?additionalFeatures:??? -> ?language:??? -> ?politicalView:??? -> ?intendedUse:??? -> ?key:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of GeocodeRequestMaxResultsInteger.t | `List of [> `Double of Double.t | `Enum of string ] list | `String of GeocodeRequestQueryTextString.t | `Structure of (string * [> `List of [> `Enum of string | `String of CountryCode.t ] list | `String of GeocodeQueryComponentsCountryString.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t