Module Values.GetPlaceRequestSource

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.

Sourcetype nonrec t = {
  1. placeId : GetPlaceRequestPlaceIdString.t;
    (*

    The PlaceId of the place you wish to receive the information for.

    *)
  2. additionalFeatures : GetPlaceAdditionalFeatureList.t option;
    (*

    A list of optional additional parameters such as time zone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the TimeZone value.

    *)
  3. 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. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the following codes: en, id, km, lo, ms, my, pt, th, tl, vi, zh

    *)
  4. 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. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  5. intendedUse : GetPlaceIntendedUse.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 GetPlace 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.

    *)
  6. 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 context_ : string
Sourceval make : ?additionalFeatures:??? -> ?language:??? -> ?politicalView:??? -> ?intendedUse:??? -> ?key:??? -> placeId:GetPlaceRequestPlaceIdString.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list | `String of GetPlaceRequestPlaceIdString.t ]) 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