Module Values.GetPlaceResponseSource

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 : GetPlaceResponsePlaceIdString.t option;
    (*

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

    *)
  2. placeType : PlaceType.t option;
    (*

    A PlaceType is a category that the result place must belong to.

    *)
  3. title : GetPlaceResponseTitleString.t option;
    (*

    The localized display name of this result item based on request parameter language.

    *)
  4. pricingBucket : String_.t option;
    (*

    The pricing bucket for which the query is charged at. For more information on pricing, please visit Amazon Location Service Pricing.

    *)
  5. address : Address.t option;
    (*

    The place's address.

    *)
  6. addressNumberCorrected : SensitiveBoolean.t option;
    (*

    Boolean indicating if the address provided has been corrected. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  7. postalCodeDetails : PostalCodeDetailsList.t option;
    (*

    Contains details about the postal code of the place/result. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  8. position : Position.t option;
    (*

    The position in World Geodetic System (WGS 84) format: [longitude, latitude].

    *)
  9. mapView : BoundingBox.t option;
    (*

    The bounding box enclosing the geometric shape (area or line) that an individual result covers. The bounding box formed is defined as a set of four coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

    *)
  10. categories : CategoryList.t option;
    (*

    Categories of results that results must belong to.

    *)
  11. foodTypes : FoodTypeList.t option;
    (*

    List of food types offered by this result. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  12. businessChains : BusinessChainList.t option;
    (*

    The Business Chains associated with the place.

    *)
  13. contacts : Contacts.t option;
    (*

    List of potential contact methods for the result/place. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  14. openingHours : OpeningHoursList.t option;
    (*

    List of opening hours objects. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  15. accessPoints : AccessPointList.t option;
    (*

    Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  16. accessRestrictions : AccessRestrictionList.t option;
    (*

    Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  17. timeZone : TimeZone.t option;
    (*

    The time zone in which the place is located.

    *)
  18. politicalView : CountryCode3.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 available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  19. phonemes : PhonemeDetails.t option;
    (*

    How the various components of the result's address are pronounced in various languages. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  20. mainAddress : RelatedPlace.t option;
    (*

    The main address corresponding to a place of type Secondary Address. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  21. secondaryAddresses : RelatedPlaceList.t option;
    (*

    All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ThrottlingException of ThrottlingException.t
  4. | `ValidationException of ValidationException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?placeId:??? -> ?placeType:??? -> ?title:??? -> ?pricingBucket:??? -> ?address:??? -> ?addressNumberCorrected:??? -> ?postalCodeDetails:??? -> ?position:??? -> ?mapView:??? -> ?categories:??? -> ?foodTypes:??? -> ?businessChains:??? -> ?contacts:??? -> ?openingHours:??? -> ?accessPoints:??? -> ?accessRestrictions:??? -> ?timeZone:??? -> ?politicalView:??? -> ?phonemes:??? -> ?mainAddress:??? -> ?secondaryAddresses:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of SensitiveBoolean.t | `Enum of string | `List of [> `Double of Double.t | `Structure of (string * [> `Boolean of SensitiveBoolean.t | `Enum of string | `List of [> `Double of Double.t | `String of OpeningHoursDisplay.t | `Structure of (string * [> `Boolean of SensitiveBoolean.t | `List of [> `Double of Double.t ] list | `String of OpeningHoursComponentsOpenTimeString.t ]) list ] list | `String of PostalCodeDetailsPostalCodeString.t | `Structure of (string * [> `Enum of string | `List of [> `String of IntersectionStreet.t | `Structure of (string * [> `Enum of string | `String of StreetComponentsBaseNameString.t ]) list ] list | `String of AddressLabelString.t | `Structure of (string * [> `String of CountryCode2.t ]) list ]) list ]) list ] list | `String of GetPlaceResponsePlaceIdString.t | `Structure of (string * [> `Enum of string | `List of [> `Double of Double.t | `String of IntersectionStreet.t | `Structure of (string * [> `Boolean of SensitiveBoolean.t | `Enum of string | `List of [> `Double of Double.t | `Structure of (string * [> `Boolean of SensitiveBoolean.t | `String of CategoryIdString.t ]) list ] list | `String of StreetComponentsBaseNameString.t ]) list ] list | `Long of TimeZoneOffsetSecondsLong.t | `String of AddressLabelString.t | `Structure of (string * [> `List of [> `String of IntersectionStreet.t | `Structure of (string * [> `Boolean of SensitiveBoolean.t | `Enum of string | `String of PhonemeTranscriptionValueString.t ]) list ] list | `String of CountryCode2.t | `Structure of (string * [> `String of CountryCode2.t ]) list ]) list ]) 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