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.
", "readonly":true }, "Geocode":{ "name":"Geocode", "http":{ "method":"POST", "requestUri":"/geocode", "responseCode":200 }, "input":{"shape":"GeocodeRequest"}, "output":{"shape":"GeocodeResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":" 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.
", "readonly":true }, "GetPlace":{ "name":"GetPlace", "http":{ "method":"GET", "requestUri":"/place/{PlaceId}", "responseCode":200 }, "input":{"shape":"GetPlaceRequest"}, "output":{"shape":"GetPlaceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":" 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.
", "readonly":true }, "ReverseGeocode":{ "name":"ReverseGeocode", "http":{ "method":"POST", "requestUri":"/reverse-geocode", "responseCode":200 }, "input":{"shape":"ReverseGeocodeRequest"}, "output":{"shape":"ReverseGeocodeResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":" 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.
", "readonly":true }, "SearchNearby":{ "name":"SearchNearby", "http":{ "method":"POST", "requestUri":"/search-nearby", "responseCode":200 }, "input":{"shape":"SearchNearbyRequest"}, "output":{"shape":"SearchNearbyResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":" 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.
", "readonly":true }, "SearchText":{ "name":"SearchText", "http":{ "method":"POST", "requestUri":"/search-text", "responseCode":200 }, "input":{"shape":"SearchTextRequest"}, "output":{"shape":"SearchTextResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":" 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.
", "readonly":true }, "Suggest":{ "name":"Suggest", "http":{ "method":"POST", "requestUri":"/suggest", "responseCode":200 }, "input":{"shape":"SuggestRequest"}, "output":{"shape":"SuggestResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":" 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.
", "readonly":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"You don't have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccessPoint":{ "type":"structure", "members":{ "Position":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" } }, "documentation":"Position of the access point represented by longitude and latitude for a vehicle.
" }, "AccessPointList":{ "type":"list", "member":{"shape":"AccessPoint"}, "max":100, "min":0 }, "AccessRestriction":{ "type":"structure", "members":{ "Restricted":{ "shape":"SensitiveBoolean", "documentation":"The restriction.
" }, "Categories":{ "shape":"CategoryList", "documentation":"Categories of results that results must belong too.
" } }, "documentation":"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.
" }, "AccessRestrictionList":{ "type":"list", "member":{"shape":"AccessRestriction"}, "max":100, "min":1 }, "Address":{ "type":"structure", "members":{ "Label":{ "shape":"AddressLabelString", "documentation":"Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
" }, "Country":{ "shape":"Country", "documentation":"The country component of the address.
" }, "Region":{ "shape":"Region", "documentation":"The region or state results should be present in.
Example: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
" }, "Locality":{ "shape":"AddressLocalityString", "documentation":"The city or locality of the address.
Example: Vancouver.
The district or division of a locality associated with this address.
" }, "SubDistrict":{ "shape":"AddressSubDistrictString", "documentation":"A subdivision of a district.
Example: Minden-Lübbecke.
An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.
" }, "Block":{ "shape":"AddressBlockString", "documentation":"Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Name of the streets in the intersection.
Example: [\"Friedrichstraße\",\"Unter den Linden\"]
The name of the street results should be present in.
" }, "StreetComponents":{ "shape":"StreetComponentsList", "documentation":"Components of the street.
Example: Younge from the \"Younge street\".
" }, "AddressNumber":{ "shape":"AddressAddressNumberString", "documentation":"The number that identifies an address within a street.
" }, "Building":{ "shape":"AddressBuildingString", "documentation":"The name of the building at the address.
" }, "SecondaryAddressComponents":{ "shape":"SecondaryAddressComponentList", "documentation":"Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.
Coverage for Address.SecondaryAddressComponents is available in the following countries:
AUS, CAN, NZL, USA, PRI
The place address.
" }, "AddressAddressNumberString":{ "type":"string", "max":10, "min":0, "sensitive":true }, "AddressBlockString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "AddressBuildingString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "AddressComponentMatchScores":{ "type":"structure", "members":{ "Country":{ "shape":"MatchScore", "documentation":"The alpha-2 or alpha-3 character code for the country that the results will be present in.
" }, "Region":{ "shape":"MatchScore", "documentation":"The region or state results should be to be present in.
Example: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
" }, "Locality":{ "shape":"MatchScore", "documentation":"The city or locality results should be present in.
Example: Vancouver.
The district or division of a city the results should be present in.
" }, "SubDistrict":{ "shape":"MatchScore", "documentation":"A subdivision of a district.
Example: Minden-Lübbecke
An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.
" }, "Block":{ "shape":"MatchScore", "documentation":"Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Name of the streets in the intersection.
Example: [\"Friedrichstraße\",\"Unter den Linden\"]
The house number or address results should have.
" }, "Building":{ "shape":"MatchScore", "documentation":"The name of the building at the address.
" }, "SecondaryAddressComponents":{ "shape":"SecondaryAddressComponentMatchScoreList", "documentation":"Match scores for the secondary address components in the result.
Coverage for this functionality is available in the following countries: AUS, AUT, BRA, CAN, ESP, FRA, GBR, IDN, IND, NZL, TUR, TWN, USA.
Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
" }, "AddressComponentMatchScoresIntersectionList":{ "type":"list", "member":{"shape":"MatchScore"}, "max":2, "min":1 }, "AddressComponentPhonemes":{ "type":"structure", "members":{ "Country":{ "shape":"PhonemeTranscriptionList", "documentation":"The alpha-2 or alpha-3 character code for the country that the results will be present in.
" }, "Region":{ "shape":"PhonemeTranscriptionList", "documentation":"How to pronounce the region or state results should be to be present in.
" }, "SubRegion":{ "shape":"PhonemeTranscriptionList", "documentation":"How to pronounce the sub-region or county for which results should be present in.
" }, "Locality":{ "shape":"PhonemeTranscriptionList", "documentation":"How to pronounce the city or locality results should be present in.
Example: Vancouver.
How to pronounce the district or division of a city results should be present in.
" }, "SubDistrict":{ "shape":"PhonemeTranscriptionList", "documentation":"How to pronounce the sub-district or division of a city results should be present in.
" }, "Block":{ "shape":"PhonemeTranscriptionList", "documentation":"How to pronounce the name of the block.
" }, "SubBlock":{ "shape":"PhonemeTranscriptionList", "documentation":"How to pronounce the name of the sub-block.
" }, "Street":{ "shape":"PhonemeTranscriptionList", "documentation":"How to pronounce the name of the street results should be present in.
" } }, "documentation":"How to pronounce the various components of the address or place.
" }, "AddressDistrictString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "AddressLabelString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "AddressLocalityString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "AddressPostalCodeString":{ "type":"string", "max":50, "min":0, "sensitive":true }, "AddressStreetString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "AddressSubBlockString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "AddressSubDistrictString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "ApiKey":{ "type":"string", "max":1000, "min":0, "sensitive":true }, "AutocompleteAdditionalFeature":{ "type":"string", "enum":["Core"] }, "AutocompleteAdditionalFeatureList":{ "type":"list", "member":{"shape":"AutocompleteAdditionalFeature"}, "max":1, "min":1 }, "AutocompleteAddressHighlights":{ "type":"structure", "members":{ "Label":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
" }, "Country":{ "shape":"CountryHighlights", "documentation":"The alpha-2 or alpha-3 character code for the country that the results will be present in.
" }, "Region":{ "shape":"RegionHighlights", "documentation":"The region or state results should be to be present in.
Example: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
" }, "Locality":{ "shape":"HighlightList", "documentation":"The city or locality results should be present in.
Example: Vancouver.
The district or division of a city the results should be present in.
" }, "SubDistrict":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending index of the title in the text query that match the found title.
" }, "Street":{ "shape":"HighlightList", "documentation":"The name of the street results should be present in.
" }, "Block":{ "shape":"HighlightList", "documentation":"Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Name of the streets in the intersection. For example: e.g. [\"Friedrichstraße\",\"Unter den Linden\"]
" }, "PostalCode":{ "shape":"HighlightList", "documentation":"An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.
" }, "AddressNumber":{ "shape":"HighlightList", "documentation":"The house number or address results should have.
" }, "Building":{ "shape":"HighlightList", "documentation":"The name of the building at the address.
" } }, "documentation":"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.
" }, "AutocompleteFilter":{ "type":"structure", "members":{ "BoundingBox":{ "shape":"BoundingBox", "documentation":"The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" }, "IncludePlaceTypes":{ "shape":"AutocompleteFilterPlaceTypeList", "documentation":"The included place types.
" } }, "documentation":"Autocomplete structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "AutocompleteFilterPlaceType":{ "type":"string", "enum":[ "Locality", "PostalCode" ] }, "AutocompleteFilterPlaceTypeList":{ "type":"list", "member":{"shape":"AutocompleteFilterPlaceType"}, "max":2, "min":1 }, "AutocompleteHighlights":{ "type":"structure", "members":{ "Title":{ "shape":"HighlightList", "documentation":"Indicates where the title field in the result matches the input query.
" }, "Address":{ "shape":"AutocompleteAddressHighlights", "documentation":"Describes how part of the result address match the input query.
" } }, "documentation":"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.
" }, "AutocompleteIntendedUse":{ "type":"string", "enum":["SingleUse"] }, "AutocompleteRequest":{ "type":"structure", "required":["QueryText"], "members":{ "QueryText":{ "shape":"AutocompleteRequestQueryTextString", "documentation":"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.
The fields QueryText, and QueryID are mutually exclusive.
An optional limit for the number of results returned in a single call.
Default value: 5
" }, "BiasPosition":{ "shape":"Position", "documentation":"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.
The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "PostalCodeMode":{ "shape":"PostalCodeMode", "documentation":"The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value EnumerateSpannedLocalities, all cities in that postal code are returned.
A list of optional additional parameters that can be requested for each result.
" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"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.
The following political views are currently supported:
ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands
EGY: Egypt's view on Bir Tawil
IND: India's view on Gilgit-Baltistan
KEN: Kenya's view on the Ilemi Triangle
MAR: Morocco's view on Western Sahara
RUS: Russia's view on Crimea
SDN: Sudan's view on the Halaib Triangle
SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters
SYR: Syria's view on the Golan Heights
TUR: Turkey's view on Cyprus and Northern Cyprus
TZA: Tanzania's view on Lake Malawi
URY: Uruguay's view on Rincon de Artigas
VNM: Vietnam's view on the Paracel Islands and Spratly Islands
Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" } } }, "AutocompleteRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":20, "min":1 }, "AutocompleteRequestQueryTextString":{ "type":"string", "max":200, "min":1, "sensitive":true }, "AutocompleteResponse":{ "type":"structure", "required":["PricingBucket"], "members":{ "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "ResultItems":{ "shape":"AutocompleteResultItemList", "documentation":"List of places or results returned for a query.
" } } }, "AutocompleteResultItem":{ "type":"structure", "required":[ "PlaceId", "PlaceType", "Title" ], "members":{ "PlaceId":{ "shape":"AutocompleteResultItemPlaceIdString", "documentation":"The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.
" }, "PlaceType":{ "shape":"PlaceType", "documentation":"PlaceType describes the type of result entry returned.
" }, "Title":{ "shape":"AutocompleteResultItemTitleString", "documentation":"A formatted string for display when presenting this result to an end user.
" }, "Address":{ "shape":"Address", "documentation":"The address associated with this result.
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.
" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "PoliticalView":{ "shape":"CountryCode3", "documentation":"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.
" }, "Highlights":{ "shape":"AutocompleteHighlights", "documentation":"Indicates the starting and ending index of the place in the text query that match the found title.
" } }, "documentation":"A result matching the input query text.
" }, "AutocompleteResultItemList":{ "type":"list", "member":{"shape":"AutocompleteResultItem"}, "max":20, "min":0 }, "AutocompleteResultItemPlaceIdString":{ "type":"string", "max":500, "min":0, "sensitive":true }, "AutocompleteResultItemTitleString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "BoundingBox":{ "type":"list", "member":{"shape":"Double"}, "max":4, "min":4, "sensitive":true }, "BusinessChain":{ "type":"structure", "members":{ "Name":{ "shape":"BusinessChainNameString", "documentation":"The business chain name.
" }, "Id":{ "shape":"BusinessChainIdString", "documentation":"The Business Chain Id.
" } }, "documentation":"A businesschain is a chain of businesses that belong to the same brand. For example 7-11.
The category ID.
" }, "Name":{ "shape":"CategoryNameString", "documentation":"The category name.
" }, "LocalizedName":{ "shape":"CategoryLocalizedNameString", "documentation":"Localized name of the category type.
" }, "Primary":{ "shape":"SensitiveBoolean", "documentation":"Boolean which indicates if this category is the primary offered by the place.
" } }, "documentation":"Category of the Place returned.
Indicates the match score of the title in the text query that match the found title.
" }, "Address":{ "shape":"AddressComponentMatchScores", "documentation":"The place's address.
" } }, "documentation":"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.
" }, "ContactDetails":{ "type":"structure", "members":{ "Label":{ "shape":"ContactDetailsLabelString", "documentation":"The contact's label.
" }, "Value":{ "shape":"ContactDetailsValueString", "documentation":"The contact's value.
" }, "Categories":{ "shape":"CategoryList", "documentation":"Categories of results that results must belong too.
" } }, "documentation":"Details related to contacts.
" }, "ContactDetailsLabelString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "ContactDetailsList":{ "type":"list", "member":{"shape":"ContactDetails"}, "max":100, "min":1 }, "ContactDetailsValueString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "Contacts":{ "type":"structure", "members":{ "Phones":{ "shape":"ContactDetailsList", "documentation":"List of phone numbers for the results contact.
" }, "Faxes":{ "shape":"ContactDetailsList", "documentation":"List of fax addresses for the result contact.
" }, "Websites":{ "shape":"ContactDetailsList", "documentation":"List of website URLs that belong to the result.
" }, "Emails":{ "shape":"ContactDetailsList", "documentation":"List of emails for contacts of the result.
" } }, "documentation":"A list of potential contact methods for the result/place.
" }, "Country":{ "type":"structure", "members":{ "Code2":{ "shape":"CountryCode2", "documentation":"Country, represented by its alpha 2-character code.
" }, "Code3":{ "shape":"CountryCode3", "documentation":"Country, represented by its alpha t-character code.
" }, "Name":{ "shape":"CountryNameString", "documentation":"Name of the country.
" } }, "documentation":"The alpha-2 or alpha-3 character code for the country that the results will be present in.
" }, "CountryCode":{ "type":"string", "max":3, "min":2, "pattern":"([A-Z]{2}|[A-Z]{3})", "sensitive":true }, "CountryCode2":{ "type":"string", "max":2, "min":2, "pattern":"[A-Z]{2}", "sensitive":true }, "CountryCode3":{ "type":"string", "max":3, "min":3, "pattern":"[A-Z]{3}", "sensitive":true }, "CountryCodeList":{ "type":"list", "member":{"shape":"CountryCode"}, "max":100, "min":1 }, "CountryHighlights":{ "type":"structure", "members":{ "Code":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending index of the country code in the text query that match the found title.
" }, "Name":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending index of the country code in the text query that match the found title.
" } }, "documentation":"Indicates the starting and ending index of the country in the text query that match the found title.
" }, "CountryNameString":{ "type":"string", "max":100, "min":0, "sensitive":true }, "DistanceMeters":{ "type":"long", "max":4294967295, "min":0, "sensitive":true }, "Double":{ "type":"double", "box":true }, "FilterBusinessChainList":{ "type":"list", "member":{"shape":"FilterBusinessChainListMemberString"}, "max":10, "min":1 }, "FilterBusinessChainListMemberString":{ "type":"string", "max":100, "min":1, "sensitive":true }, "FilterCategoryList":{ "type":"list", "member":{"shape":"FilterCategoryListMemberString"}, "max":10, "min":1 }, "FilterCategoryListMemberString":{ "type":"string", "max":100, "min":1, "sensitive":true }, "FilterCircle":{ "type":"structure", "required":[ "Center", "Radius" ], "members":{ "Center":{ "shape":"Position", "documentation":"The center position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "Radius":{ "shape":"FilterCircleRadiusLong", "documentation":"The radius, in meters, of the FilterCircle.
The Circle that all results must be in.
Localized name of the food type.
" }, "Id":{ "shape":"FoodTypeIdString", "documentation":"The Food Type Id.
" }, "Primary":{ "shape":"SensitiveBoolean", "documentation":"Boolean which indicates if this food type is the primary offered by the place. For example, if a location serves fast food, but also dessert, he primary would likely be fast food.
" } }, "documentation":"List of Food types offered by this result.
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" }, "IncludePlaceTypes":{ "shape":"GeocodeFilterPlaceTypeList", "documentation":"The included place types.
" } }, "documentation":"Geocode structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "GeocodeFilterPlaceType":{ "type":"string", "enum":[ "Locality", "PostalCode", "Intersection", "Street", "PointAddress", "InterpolatedAddress" ], "sensitive":true }, "GeocodeFilterPlaceTypeList":{ "type":"list", "member":{"shape":"GeocodeFilterPlaceType"}, "max":6, "min":1 }, "GeocodeIntendedUse":{ "type":"string", "enum":[ "SingleUse", "Storage" ] }, "GeocodeParsedQuery":{ "type":"structure", "members":{ "Title":{ "shape":"ParsedQueryComponentList", "documentation":"The localized display name of this result item based on request parameter language.
The place address.
" } }, "documentation":"Parsed components in the provided QueryText.
" }, "GeocodeParsedQueryAddressComponents":{ "type":"structure", "members":{ "Country":{ "shape":"ParsedQueryComponentList", "documentation":"The alpha-2 or alpha-3 character code for the country that the results will be present in.
" }, "Region":{ "shape":"ParsedQueryComponentList", "documentation":"The region or state results should be present in.
Example: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
" }, "Locality":{ "shape":"ParsedQueryComponentList", "documentation":"The city or locality of the address.
Example: Vancouver.
The district or division of a city the results should be present in.
" }, "SubDistrict":{ "shape":"ParsedQueryComponentList", "documentation":"A subdivision of a district.
Example: Minden-Lübbecke.
An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.
" }, "Block":{ "shape":"ParsedQueryComponentList", "documentation":"Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
The name of the street results should be present in.
" }, "AddressNumber":{ "shape":"ParsedQueryComponentList", "documentation":"The number that identifies an address within a street.
" }, "Building":{ "shape":"ParsedQueryComponentList", "documentation":"The name of the building at the address.
" }, "SecondaryAddressComponents":{ "shape":"ParsedQuerySecondaryAddressComponentList", "documentation":"Parsed secondary address components from the provided query text.
Coverage for ParsedQuery.Address.SecondaryAddressComponents is available in the following countries:
AUS, AUT, BRA, CAN, ESP, FRA, GBR, HKG, IDN, IND, NZL, TUR, TWN, USA
Parsed address components in the provided QueryText.
" }, "GeocodeQueryComponents":{ "type":"structure", "members":{ "Country":{ "shape":"GeocodeQueryComponentsCountryString", "documentation":"The alpha-2 or alpha-3 character code for the country that the results will be present in.
" }, "Region":{ "shape":"GeocodeQueryComponentsRegionString", "documentation":"The region or state results should be to be present in.
Example: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
" }, "Locality":{ "shape":"GeocodeQueryComponentsLocalityString", "documentation":"The city or locality results should be present in.
Example: Vancouver.
The district or division of a city the results should be present in.
" }, "Street":{ "shape":"GeocodeQueryComponentsStreetString", "documentation":"The name of the street results should be present in.
" }, "AddressNumber":{ "shape":"GeocodeQueryComponentsAddressNumberString", "documentation":"The house number or address results should have.
" }, "PostalCode":{ "shape":"GeocodeQueryComponentsPostalCodeString", "documentation":"An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.
" } }, "documentation":"A structured free text query allows you to search for places by the name or text representation of specific properties of the place.
" }, "GeocodeQueryComponentsAddressNumberString":{ "type":"string", "max":100, "min":1, "pattern":"[^;]+", "sensitive":true }, "GeocodeQueryComponentsCountryString":{ "type":"string", "max":100, "min":1, "pattern":"[^;]+", "sensitive":true }, "GeocodeQueryComponentsDistrictString":{ "type":"string", "max":100, "min":1, "pattern":"[^;]+", "sensitive":true }, "GeocodeQueryComponentsLocalityString":{ "type":"string", "max":100, "min":1, "pattern":"[^;]+", "sensitive":true }, "GeocodeQueryComponentsPostalCodeString":{ "type":"string", "max":100, "min":1, "pattern":"[^;]+", "sensitive":true }, "GeocodeQueryComponentsRegionString":{ "type":"string", "max":100, "min":1, "pattern":"[^;]+", "sensitive":true }, "GeocodeQueryComponentsStreetString":{ "type":"string", "max":100, "min":1, "pattern":"[^;]+", "sensitive":true }, "GeocodeQueryComponentsSubRegionString":{ "type":"string", "max":100, "min":1, "pattern":"[^;]+", "sensitive":true }, "GeocodeRequest":{ "type":"structure", "members":{ "QueryText":{ "shape":"GeocodeRequestQueryTextString", "documentation":"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.
" }, "QueryComponents":{"shape":"GeocodeQueryComponents"}, "MaxResults":{ "shape":"GeocodeRequestMaxResultsInteger", "documentation":"An optional limit for the number of results returned in a single call.
Default value: 20
" }, "BiasPosition":{ "shape":"Position", "documentation":"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.
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "AdditionalFeatures":{ "shape":"GeocodeAdditionalFeatureList", "documentation":"A list of optional additional parameters, such as time zone, that can be requested for each result.
" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"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.
" }, "IntendedUse":{ "shape":"GeocodeIntendedUse", "documentation":"Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an Geocode query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" } } }, "GeocodeRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "GeocodeRequestQueryTextString":{ "type":"string", "max":200, "min":1, "sensitive":true }, "GeocodeResponse":{ "type":"structure", "required":["PricingBucket"], "members":{ "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at, or the maximum pricing bucket when the query is charged per item within the query.
For more information on pricing, please visit Amazon Location Service Pricing.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "ResultItems":{ "shape":"GeocodeResultItemList", "documentation":"List of places or results returned for a query.
" } } }, "GeocodeResultItem":{ "type":"structure", "required":[ "PlaceId", "PlaceType", "Title" ], "members":{ "PlaceId":{ "shape":"GeocodeResultItemPlaceIdString", "documentation":"The PlaceId of the place result.
A PlaceType is a category that the result place must belong to.
The localized display name of this result item based on request parameter language.
The place's address.
" }, "AddressNumberCorrected":{ "shape":"SensitiveBoolean", "documentation":"Boolean indicating if the address provided has been corrected.
" }, "PostalCodeDetails":{ "shape":"PostalCodeDetailsList", "documentation":"Contains details about the postal code of the place/result.
" }, "Position":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"The distance in meters from the QueryPosition.
" }, "MapView":{ "shape":"BoundingBox", "documentation":"The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
Categories of results that results must belong to.
" }, "FoodTypes":{ "shape":"FoodTypeList", "documentation":"List of food types offered by this result.
" }, "AccessPoints":{ "shape":"AccessPointList", "documentation":"Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "TimeZone":{ "shape":"TimeZone", "documentation":"The time zone in which the place is located.
" }, "PoliticalView":{ "shape":"CountryCode3", "documentation":"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.
" }, "MatchScores":{ "shape":"MatchScoreDetails", "documentation":"Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
" }, "ParsedQuery":{ "shape":"GeocodeParsedQuery", "documentation":"Free-form text query.
" }, "Intersections":{ "shape":"IntersectionList", "documentation":"All Intersections that are near the provided address.
" }, "MainAddress":{ "shape":"RelatedPlace", "documentation":"The main address corresponding to a place of type Secondary Address.
" }, "SecondaryAddresses":{ "shape":"RelatedPlaceList", "documentation":"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.
Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.
The Geocoded result.
" }, "GeocodeResultItemList":{ "type":"list", "member":{"shape":"GeocodeResultItem"}, "max":100, "min":0 }, "GeocodeResultItemPlaceIdString":{ "type":"string", "max":500, "min":0, "sensitive":true }, "GeocodeResultItemTitleString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "GetPlaceAdditionalFeature":{ "type":"string", "enum":[ "TimeZone", "Phonemes", "Access", "Contact", "SecondaryAddresses" ] }, "GetPlaceAdditionalFeatureList":{ "type":"list", "member":{"shape":"GetPlaceAdditionalFeature"}, "max":5, "min":1 }, "GetPlaceIntendedUse":{ "type":"string", "enum":[ "SingleUse", "Storage" ] }, "GetPlaceRequest":{ "type":"structure", "required":["PlaceId"], "members":{ "PlaceId":{ "shape":"GetPlaceRequestPlaceIdString", "documentation":"The PlaceId of the place you wish to receive the information for.
A list of optional additional parameters such as time zone that can be requested for each result.
", "location":"querystring", "locationName":"additional-features" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
", "location":"querystring", "locationName":"language" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"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.
", "location":"querystring", "locationName":"political-view" }, "IntendedUse":{ "shape":"GetPlaceIntendedUse", "documentation":"Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an GetPlace query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" } } }, "GetPlaceRequestPlaceIdString":{ "type":"string", "max":500, "min":0, "sensitive":true }, "GetPlaceResponse":{ "type":"structure", "required":[ "PlaceId", "PlaceType", "Title", "PricingBucket" ], "members":{ "PlaceId":{ "shape":"GetPlaceResponsePlaceIdString", "documentation":"The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The localized display name of this result item based on request parameter language.
The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "Address":{ "shape":"Address", "documentation":"The place's address.
" }, "AddressNumberCorrected":{ "shape":"SensitiveBoolean", "documentation":"Boolean indicating if the address provided has been corrected.
" }, "PostalCodeDetails":{ "shape":"PostalCodeDetailsList", "documentation":"Contains details about the postal code of the place/result.
" }, "Position":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "MapView":{ "shape":"BoundingBox", "documentation":"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}]
Categories of results that results must belong to.
" }, "FoodTypes":{ "shape":"FoodTypeList", "documentation":"List of food types offered by this result.
" }, "BusinessChains":{ "shape":"BusinessChainList", "documentation":"The Business Chains associated with the place.
" }, "Contacts":{ "shape":"Contacts", "documentation":"List of potential contact methods for the result/place.
" }, "OpeningHours":{ "shape":"OpeningHoursList", "documentation":"List of opening hours objects.
" }, "AccessPoints":{ "shape":"AccessPointList", "documentation":"Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "AccessRestrictions":{ "shape":"AccessRestrictionList", "documentation":"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.
" }, "TimeZone":{ "shape":"TimeZone", "documentation":"The time zone in which the place is located.
" }, "PoliticalView":{ "shape":"CountryCode3", "documentation":"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.
" }, "Phonemes":{ "shape":"PhonemeDetails", "documentation":"How the various components of the result's address are pronounced in various languages.
" }, "MainAddress":{ "shape":"RelatedPlace", "documentation":"The main address corresponding to a place of type Secondary Address.
" }, "SecondaryAddresses":{ "shape":"RelatedPlaceList", "documentation":"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.
Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.
Start index of the highlight.
" }, "EndIndex":{ "shape":"HighlightEndIndexInteger", "documentation":"End index of the highlight.
" }, "Value":{ "shape":"HighlightValueString", "documentation":"The highlight's value.
" } }, "documentation":"Indicates the starting and ending index of the text query that match the found title.
" }, "HighlightEndIndexInteger":{ "type":"integer", "box":true, "min":0 }, "HighlightList":{ "type":"list", "member":{"shape":"Highlight"}, "max":200, "min":0 }, "HighlightStartIndexInteger":{ "type":"integer", "box":true, "min":0 }, "HighlightValueString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"The request processing has failed because of an unknown error, exception or failure.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "Intersection":{ "type":"structure", "required":[ "PlaceId", "Title" ], "members":{ "PlaceId":{ "shape":"IntersectionPlaceIdString", "documentation":"The PlaceId of the place result.
The localized display name of this result item based on request parameter language.
The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"The distance in meters from the QueryPosition.
", "box":true }, "RouteDistance":{ "shape":"DistanceMeters", "documentation":"The distance from the routing position of the nearby address to the street result.
", "box":true }, "MapView":{ "shape":"BoundingBox", "documentation":"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}]
Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
" } }, "documentation":"All Intersections that are near the provided address.
" }, "IntersectionHighlightsList":{ "type":"list", "member":{"shape":"HighlightList"}, "max":100, "min":1 }, "IntersectionList":{ "type":"list", "member":{"shape":"Intersection"}, "min":1 }, "IntersectionPlaceIdString":{ "type":"string", "max":500, "min":0, "sensitive":true }, "IntersectionStreet":{ "type":"string", "max":200, "min":0 }, "IntersectionStreetList":{ "type":"list", "member":{"shape":"IntersectionStreet"}, "max":100, "min":1 }, "IntersectionTitleString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "LanguageTag":{ "type":"string", "max":35, "min":2 }, "MatchScore":{ "type":"double", "max":1, "min":0 }, "MatchScoreDetails":{ "type":"structure", "members":{ "Overall":{ "shape":"MatchScore", "documentation":"Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
" }, "Components":{ "shape":"ComponentMatchScores", "documentation":"Indicates how well the component input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
" } }, "documentation":"Details related to the match score.
" }, "OpeningHours":{ "type":"structure", "members":{ "Display":{ "shape":"OpeningHoursDisplayList", "documentation":"List of opening hours in the format they are displayed in. This can vary by result and in most cases represents how the result uniquely formats their opening hours.
" }, "OpenNow":{ "shape":"SensitiveBoolean", "documentation":"Boolean which indicates if the result/place is currently open.
" }, "Components":{ "shape":"OpeningHoursComponentsList", "documentation":"Components of the opening hours object.
" }, "Categories":{ "shape":"CategoryList", "documentation":"Categories of results that results must belong too.
" } }, "documentation":"List of opening hours objects.
" }, "OpeningHoursComponents":{ "type":"structure", "members":{ "OpenTime":{ "shape":"OpeningHoursComponentsOpenTimeString", "documentation":"String which represents the opening hours, such as \"T070000\".
String which represents the duration of the opening period, such as \"PT12H00M\".
Days or periods when the provided opening hours are in affect.
Example: FREQ:DAILY;BYDAY:MO,TU,WE,TH,SU
Components of the opening hours object.
" }, "OpeningHoursComponentsList":{ "type":"list", "member":{"shape":"OpeningHoursComponents"}, "max":100, "min":1 }, "OpeningHoursComponentsOpenDurationString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "OpeningHoursComponentsOpenTimeString":{ "type":"string", "max":21, "min":0, "sensitive":true }, "OpeningHoursComponentsRecurrenceString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "OpeningHoursDisplay":{ "type":"string", "max":200, "min":0, "sensitive":true }, "OpeningHoursDisplayList":{ "type":"list", "member":{"shape":"OpeningHoursDisplay"}, "max":100, "min":1 }, "OpeningHoursList":{ "type":"list", "member":{"shape":"OpeningHours"}, "max":100, "min":1 }, "ParsedQueryComponent":{ "type":"structure", "members":{ "StartIndex":{ "shape":"ParsedQueryComponentStartIndexInteger", "documentation":"Start index of the parsed query component.
" }, "EndIndex":{ "shape":"ParsedQueryComponentEndIndexInteger", "documentation":"End index of the parsed query component.
" }, "Value":{ "shape":"ParsedQueryComponentValueString", "documentation":"Value of the parsed query component.
" }, "QueryComponent":{ "shape":"ParsedQueryComponentQueryComponentString", "documentation":"The address component that the parsed query component corresponds to.
" } }, "documentation":"Parsed components in the provided QueryText.
" }, "ParsedQueryComponentEndIndexInteger":{ "type":"integer", "box":true, "min":0 }, "ParsedQueryComponentList":{ "type":"list", "member":{"shape":"ParsedQueryComponent"}, "max":200, "min":0 }, "ParsedQueryComponentQueryComponentString":{ "type":"string", "max":11, "min":0, "sensitive":true }, "ParsedQueryComponentStartIndexInteger":{ "type":"integer", "box":true, "min":0 }, "ParsedQueryComponentValueString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "ParsedQuerySecondaryAddressComponent":{ "type":"structure", "required":[ "StartIndex", "EndIndex", "Value", "Number", "Designator" ], "members":{ "StartIndex":{ "shape":"ParsedQuerySecondaryAddressComponentStartIndexInteger", "documentation":"Start index of the parsed secondary address component in the query text.
" }, "EndIndex":{ "shape":"ParsedQuerySecondaryAddressComponentEndIndexInteger", "documentation":"End index of the parsed secondary address component in the query text.
" }, "Value":{ "shape":"ParsedQuerySecondaryAddressComponentValueString", "documentation":"Value of the parsed secondary address component.
" }, "Number":{ "shape":"ParsedQuerySecondaryAddressComponentNumberString", "documentation":"Secondary address number provided in the query.
" }, "Designator":{ "shape":"ParsedQuerySecondaryAddressComponentDesignatorString", "documentation":"Secondary address designator provided in the query.
" } }, "documentation":"Information about a secondary address component parsed from the query text.
" }, "ParsedQuerySecondaryAddressComponentDesignatorString":{ "type":"string", "max":4, "min":0, "sensitive":true }, "ParsedQuerySecondaryAddressComponentEndIndexInteger":{ "type":"integer", "box":true, "min":0 }, "ParsedQuerySecondaryAddressComponentList":{ "type":"list", "member":{"shape":"ParsedQuerySecondaryAddressComponent"}, "max":200, "min":0 }, "ParsedQuerySecondaryAddressComponentNumberString":{ "type":"string", "max":10, "min":0, "sensitive":true }, "ParsedQuerySecondaryAddressComponentStartIndexInteger":{ "type":"integer", "box":true, "min":0 }, "ParsedQuerySecondaryAddressComponentValueString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "PhonemeDetails":{ "type":"structure", "members":{ "Title":{ "shape":"PhonemeTranscriptionList", "documentation":"List of PhonemeTranscription. See PhonemeTranscription for fields.
How to pronounce the address.
" } }, "documentation":"The phoneme details.
" }, "PhonemeTranscription":{ "type":"structure", "members":{ "Value":{ "shape":"PhonemeTranscriptionValueString", "documentation":"Value which indicates how to pronounce the value.
" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "Preferred":{ "shape":"SensitiveBoolean", "documentation":"Boolean which indicates if it the preferred pronunciation.
" } }, "documentation":"How to pronounce the various components of the address or place.
" }, "PhonemeTranscriptionList":{ "type":"list", "member":{"shape":"PhonemeTranscription"}, "max":100, "min":0 }, "PhonemeTranscriptionValueString":{ "type":"string", "max":50, "min":0, "sensitive":true }, "PlaceType":{ "type":"string", "enum":[ "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress" ], "sensitive":true }, "Position":{ "type":"list", "member":{"shape":"Double"}, "max":2, "min":2, "sensitive":true }, "PostalAuthority":{ "type":"string", "enum":["Usps"], "sensitive":true }, "PostalCodeDetails":{ "type":"structure", "members":{ "PostalCode":{ "shape":"PostalCodeDetailsPostalCodeString", "documentation":"An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should possess.
" }, "PostalAuthority":{ "shape":"PostalAuthority", "documentation":"The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.
" }, "PostalCodeType":{ "shape":"PostalCodeType", "documentation":"The postal code type.
" }, "UspsZip":{ "shape":"UspsZip", "documentation":"The ZIP Classification Code, or in other words what type of postal code is it.
" }, "UspsZipPlus4":{ "shape":"UspsZipPlus4", "documentation":"The USPS ZIP+4 Record Type Code.
" } }, "documentation":"Contains details about the postal code of the place or result.
" }, "PostalCodeDetailsList":{ "type":"list", "member":{"shape":"PostalCodeDetails"}, "max":100, "min":0 }, "PostalCodeDetailsPostalCodeString":{ "type":"string", "max":50, "min":0, "sensitive":true }, "PostalCodeMode":{ "type":"string", "enum":[ "MergeAllSpannedLocalities", "EnumerateSpannedLocalities" ] }, "PostalCodeType":{ "type":"string", "enum":[ "UspsZip", "UspsZipPlus4" ], "sensitive":true }, "QueryRefinement":{ "type":"structure", "required":[ "RefinedTerm", "OriginalTerm", "StartIndex", "EndIndex" ], "members":{ "RefinedTerm":{ "shape":"QueryRefinementRefinedTermString", "documentation":"The term that will be suggested to the user.
" }, "OriginalTerm":{ "shape":"QueryRefinementOriginalTermString", "documentation":"The sub-string of the original query that is replaced by this query term.
" }, "StartIndex":{ "shape":"QueryRefinementStartIndexInteger", "documentation":"Start index of the parsed component.
" }, "EndIndex":{ "shape":"QueryRefinementEndIndexInteger", "documentation":"End index of the parsed query.
" } }, "documentation":"Suggestions for refining individual query terms. Suggestions are returned as objects which note the term, suggested replacement, and its index in the query.
" }, "QueryRefinementEndIndexInteger":{ "type":"integer", "box":true, "min":0 }, "QueryRefinementList":{ "type":"list", "member":{"shape":"QueryRefinement"}, "max":10, "min":0 }, "QueryRefinementOriginalTermString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "QueryRefinementRefinedTermString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "QueryRefinementStartIndexInteger":{ "type":"integer", "box":true, "min":0 }, "QueryType":{ "type":"string", "enum":[ "Category", "BusinessChain" ] }, "RecordTypeCode":{ "type":"string", "enum":[ "Firm", "General", "HighRise", "PostOfficeBox", "Rural", "Street" ], "sensitive":true }, "Region":{ "type":"structure", "members":{ "Code":{ "shape":"RegionCodeString", "documentation":"Abbreviated code for a the state, province or region of the country.
Example: BC.
Name for a the state, province, or region of the country.
Example: British Columbia.
The region or state results should be to be present in.
Example: North Rhine-Westphalia.
Indicates the starting and ending index of the region in the text query that match the found title.
" }, "Name":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending index of the region name in the text query that match the found title.
" } }, "documentation":"Indicates the starting and ending index of the region in the text query that match the found title.
" }, "RegionNameString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "RelatedPlace":{ "type":"structure", "required":[ "PlaceId", "PlaceType", "Title" ], "members":{ "PlaceId":{ "shape":"RelatedPlacePlaceIdString", "documentation":"The PlaceId of the place result.
A PlaceType is a category that the result place must belong to.
The localized display name of this result item based on request parameter language.
The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "AccessPoints":{ "shape":"AccessPointList", "documentation":"Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
" } }, "documentation":"Place that is related to the result item.
" }, "RelatedPlaceList":{ "type":"list", "member":{"shape":"RelatedPlace"}, "min":1 }, "RelatedPlacePlaceIdString":{ "type":"string", "max":500, "min":0, "sensitive":true }, "RelatedPlaceTitleString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "ReverseGeocodeAdditionalFeature":{ "type":"string", "enum":[ "TimeZone", "Access", "Intersections" ] }, "ReverseGeocodeAdditionalFeatureList":{ "type":"list", "member":{"shape":"ReverseGeocodeAdditionalFeature"}, "max":3, "min":1 }, "ReverseGeocodeFilter":{ "type":"structure", "members":{ "IncludePlaceTypes":{ "shape":"ReverseGeocodeFilterPlaceTypeList", "documentation":"The included place types.
" } }, "documentation":"The included place types.
" }, "ReverseGeocodeFilterPlaceType":{ "type":"string", "enum":[ "Locality", "Intersection", "Street", "PointAddress", "InterpolatedAddress" ] }, "ReverseGeocodeFilterPlaceTypeList":{ "type":"list", "member":{"shape":"ReverseGeocodeFilterPlaceType"}, "max":5, "min":1 }, "ReverseGeocodeIntendedUse":{ "type":"string", "enum":[ "SingleUse", "Storage" ] }, "ReverseGeocodeRequest":{ "type":"structure", "required":["QueryPosition"], "members":{ "QueryPosition":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position
" }, "QueryRadius":{ "shape":"ReverseGeocodeRequestQueryRadiusLong", "documentation":"The maximum distance in meters from the QueryPosition from which a result will be returned.
", "box":true }, "MaxResults":{ "shape":"ReverseGeocodeRequestMaxResultsInteger", "documentation":"An optional limit for the number of results returned in a single call.
Default value: 1
" }, "Filter":{ "shape":"ReverseGeocodeFilter", "documentation":"A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "AdditionalFeatures":{ "shape":"ReverseGeocodeAdditionalFeatureList", "documentation":"A list of optional additional parameters, such as time zone that can be requested for each result.
" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"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.
" }, "IntendedUse":{ "shape":"ReverseGeocodeIntendedUse", "documentation":"Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an ReverseGeocode query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" }, "Heading":{ "shape":"Heading", "documentation":"The heading in degrees from true north in a navigation context. The heading is measured as the angle clockwise from the North direction.
Example: North is 0 degrees, East is 90 degrees, South is 180 degrees, and West is 270 degrees.
The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "ResultItems":{ "shape":"ReverseGeocodeResultItemList", "documentation":"List of places or results returned for a query.
" } } }, "ReverseGeocodeResultItem":{ "type":"structure", "required":[ "PlaceId", "PlaceType", "Title" ], "members":{ "PlaceId":{ "shape":"ReverseGeocodeResultItemPlaceIdString", "documentation":"The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The localized display name of this result item based on request parameter language.
The place's address.
" }, "AddressNumberCorrected":{ "shape":"SensitiveBoolean", "documentation":"Boolean indicating if the address provided has been corrected.
" }, "PostalCodeDetails":{ "shape":"PostalCodeDetailsList", "documentation":"Contains details about the postal code of the place/result.
" }, "Position":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"The distance in meters from the QueryPosition.
" }, "MapView":{ "shape":"BoundingBox", "documentation":"The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
Categories of results that results must belong to.
" }, "FoodTypes":{ "shape":"FoodTypeList", "documentation":"List of food types offered by this result.
" }, "AccessPoints":{ "shape":"AccessPointList", "documentation":"Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "TimeZone":{ "shape":"TimeZone", "documentation":"The time zone in which the place is located.
" }, "PoliticalView":{ "shape":"CountryCode3", "documentation":"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.
" }, "Intersections":{ "shape":"IntersectionList", "documentation":"All Intersections that are near the provided address.
" } }, "documentation":"The returned location from the Reverse Geocode action.
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" }, "IncludeCategories":{ "shape":"FilterCategoryList", "documentation":"Categories of results that results must belong too.
" }, "ExcludeCategories":{ "shape":"FilterCategoryList", "documentation":"Categories of results that results are excluded from.
" }, "IncludeBusinessChains":{ "shape":"FilterBusinessChainList", "documentation":"The Business Chains associated with the place.
" }, "ExcludeBusinessChains":{ "shape":"FilterBusinessChainList", "documentation":"The Business Chains associated with the place.
" }, "IncludeFoodTypes":{ "shape":"FilterFoodTypeList", "documentation":"Food types that results are included from.
" }, "ExcludeFoodTypes":{ "shape":"FilterFoodTypeList", "documentation":"Food types that results are excluded from.
" } }, "documentation":"SearchNearby structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "SearchNearbyIntendedUse":{ "type":"string", "enum":[ "SingleUse", "Storage" ] }, "SearchNearbyRequest":{ "type":"structure", "required":["QueryPosition"], "members":{ "QueryPosition":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position
" }, "QueryRadius":{ "shape":"SearchNearbyRequestQueryRadiusLong", "documentation":"The maximum distance in meters from the QueryPosition from which a result will be returned.
The fields QueryText, and QueryID are mutually exclusive.
An optional limit for the number of results returned in a single call.
Default value: 20
" }, "Filter":{ "shape":"SearchNearbyFilter", "documentation":"A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "AdditionalFeatures":{ "shape":"SearchNearbyAdditionalFeatureList", "documentation":"A list of optional additional parameters, such as time zone, that can be requested for each result.
" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"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.
" }, "IntendedUse":{ "shape":"SearchNearbyIntendedUse", "documentation":"Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an SearchNearby query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" } } }, "SearchNearbyRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "SearchNearbyRequestQueryRadiusLong":{ "type":"long", "max":21000000, "min":1, "sensitive":true }, "SearchNearbyResponse":{ "type":"structure", "required":["PricingBucket"], "members":{ "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "ResultItems":{ "shape":"SearchNearbyResultItemList", "documentation":"List of places or results returned for a query.
" }, "NextToken":{ "shape":"Token", "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The item's title.
" }, "Address":{ "shape":"Address", "documentation":"The place's address.
" }, "AddressNumberCorrected":{ "shape":"SensitiveBoolean", "documentation":"Boolean indicating if the address provided has been corrected.
" }, "Position":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"The distance in meters from the QueryPosition.
" }, "MapView":{ "shape":"BoundingBox", "documentation":"The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
Categories of results that results must belong to.
" }, "FoodTypes":{ "shape":"FoodTypeList", "documentation":"List of food types offered by this result.
" }, "BusinessChains":{ "shape":"BusinessChainList", "documentation":"The Business Chains associated with the place.
" }, "Contacts":{ "shape":"Contacts", "documentation":"List of potential contact methods for the result/place.
" }, "OpeningHours":{ "shape":"OpeningHoursList", "documentation":"List of opening hours objects.
" }, "AccessPoints":{ "shape":"AccessPointList", "documentation":"Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "AccessRestrictions":{ "shape":"AccessRestrictionList", "documentation":"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.
" }, "TimeZone":{ "shape":"TimeZone", "documentation":"The time zone in which the place is located.
" }, "PoliticalView":{ "shape":"CountryCode3", "documentation":"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.
" }, "Phonemes":{ "shape":"PhonemeDetails", "documentation":"How the various components of the result's address are pronounced in various languages.
" } }, "documentation":"The search results of nearby places.
" }, "SearchNearbyResultItemList":{ "type":"list", "member":{"shape":"SearchNearbyResultItem"}, "max":100, "min":0 }, "SearchNearbyResultItemPlaceIdString":{ "type":"string", "max":500, "min":0, "sensitive":true }, "SearchNearbyResultItemTitleString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "SearchTextAdditionalFeature":{ "type":"string", "enum":[ "TimeZone", "Phonemes", "Access", "Contact" ] }, "SearchTextAdditionalFeatureList":{ "type":"list", "member":{"shape":"SearchTextAdditionalFeature"}, "max":4, "min":1 }, "SearchTextFilter":{ "type":"structure", "members":{ "BoundingBox":{ "shape":"BoundingBox", "documentation":"The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" } }, "documentation":"SearchText structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "SearchTextIntendedUse":{ "type":"string", "enum":[ "SingleUse", "Storage" ] }, "SearchTextRequest":{ "type":"structure", "members":{ "QueryText":{ "shape":"SearchTextRequestQueryTextString", "documentation":"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.
Exactly one of the following fields must be set: QueryText or QueryId.
The query Id returned by the suggest API. If passed in the request, the SearchText API will preform a SearchText query with the improved query terms for the original query made to the suggest API.
Exactly one of the following fields must be set: QueryText or QueryId.
An optional limit for the number of results returned in a single call.
Default value: 20
" }, "BiasPosition":{ "shape":"Position", "documentation":"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.
Exactly one of the following fields must be set: BiasPosition, Filter.BoundingBox, or Filter.Circle.
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "AdditionalFeatures":{ "shape":"SearchTextAdditionalFeatureList", "documentation":"A list of optional additional parameters, such as time zone, that can be requested for each result.
" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"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.
" }, "IntendedUse":{ "shape":"SearchTextIntendedUse", "documentation":"Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Storing the response of an SearchText query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" } } }, "SearchTextRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "SearchTextRequestQueryIdString":{ "type":"string", "max":500, "min":1, "sensitive":true }, "SearchTextRequestQueryTextString":{ "type":"string", "max":200, "min":1, "sensitive":true }, "SearchTextResponse":{ "type":"structure", "required":["PricingBucket"], "members":{ "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "ResultItems":{ "shape":"SearchTextResultItemList", "documentation":"List of places or results returned for a query.
" }, "NextToken":{ "shape":"Token", "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The item's title.
" }, "Address":{ "shape":"Address", "documentation":"The place's address.
" }, "AddressNumberCorrected":{ "shape":"SensitiveBoolean", "documentation":"Boolean indicating if the address provided has been corrected.
" }, "Position":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"The distance in meters from the QueryPosition.
" }, "MapView":{ "shape":"BoundingBox", "documentation":"The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
Categories of results that results must belong to.
" }, "FoodTypes":{ "shape":"FoodTypeList", "documentation":"List of food types offered by this result.
" }, "BusinessChains":{ "shape":"BusinessChainList", "documentation":"The Business Chains associated with the place.
" }, "Contacts":{ "shape":"Contacts", "documentation":"List of potential contact methods for the result/place.
" }, "OpeningHours":{ "shape":"OpeningHoursList", "documentation":"List of opening hours objects.
" }, "AccessPoints":{ "shape":"AccessPointList", "documentation":"Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "AccessRestrictions":{ "shape":"AccessRestrictionList", "documentation":"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.
" }, "TimeZone":{ "shape":"TimeZone", "documentation":"The time zone in which the place is located.
" }, "PoliticalView":{ "shape":"CountryCode3", "documentation":"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.
" }, "Phonemes":{ "shape":"PhonemeDetails", "documentation":"How the various components of the result's address are pronounced in various languages.
" } }, "documentation":"The text search result.
" }, "SearchTextResultItemList":{ "type":"list", "member":{"shape":"SearchTextResultItem"}, "max":100, "min":0 }, "SearchTextResultItemPlaceIdString":{ "type":"string", "max":500, "min":0, "sensitive":true }, "SearchTextResultItemTitleString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "SecondaryAddressComponent":{ "type":"structure", "required":["Number"], "members":{ "Number":{ "shape":"SecondaryAddressComponentNumberString", "documentation":"Number that uniquely identifies a secondary address.
" }, "Designator":{ "shape":"SecondaryAddressComponentDesignatorString", "documentation":"The designator of the secondary address component.
Example: Apt.
Components that correspond to secondary identifiers on an address. The only component type supported currently is Unit.
" }, "SecondaryAddressComponentDesignatorString":{ "type":"string", "max":20, "min":0, "sensitive":true }, "SecondaryAddressComponentList":{ "type":"list", "member":{"shape":"SecondaryAddressComponent"}, "max":3, "min":0 }, "SecondaryAddressComponentMatchScore":{ "type":"structure", "members":{ "Number":{ "shape":"MatchScore", "documentation":"Match score for the secondary address number.
" } }, "documentation":"Match score for a secondary address component in the result.
" }, "SecondaryAddressComponentMatchScoreList":{ "type":"list", "member":{"shape":"SecondaryAddressComponentMatchScore"} }, "SecondaryAddressComponentNumberString":{ "type":"string", "max":10, "min":0, "sensitive":true }, "SensitiveBoolean":{ "type":"boolean", "box":true, "sensitive":true }, "StreetComponents":{ "type":"structure", "members":{ "BaseName":{ "shape":"StreetComponentsBaseNameString", "documentation":"Base name part of the street name.
Example: Younge from the \"Younge street\".
" }, "Type":{ "shape":"StreetComponentsTypeString", "documentation":"Street type part of the street name.
Example: \"avenue\".
Defines if the street type is before or after the base name.
" }, "TypeSeparator":{ "shape":"TypeSeparator", "documentation":"Defines a separator character such as \"\" or \" \" between the base name and type.
A prefix is a directional identifier that precedes, but is not included in, the base name of a road.
Example: E for East.
" }, "Suffix":{ "shape":"StreetComponentsSuffixString", "documentation":"A suffix is a directional identifier that follows, but is not included in, the base name of a road.
Example W for West.
" }, "Direction":{ "shape":"StreetComponentsDirectionString", "documentation":"Indicates the official directional identifiers assigned to highways.
" }, "Language":{ "shape":"LanguageTag", "documentation":"A 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.
" } }, "documentation":"Components of a street.
" }, "StreetComponentsBaseNameString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "StreetComponentsDirectionString":{ "type":"string", "max":50, "min":0, "sensitive":true }, "StreetComponentsList":{ "type":"list", "member":{"shape":"StreetComponents"}, "max":100, "min":0 }, "StreetComponentsPrefixString":{ "type":"string", "max":50, "min":0, "sensitive":true }, "StreetComponentsSuffixString":{ "type":"string", "max":50, "min":0, "sensitive":true }, "StreetComponentsTypeString":{ "type":"string", "max":50, "min":0, "sensitive":true }, "String":{"type":"string"}, "SubRegion":{ "type":"structure", "members":{ "Code":{ "shape":"SubRegionCodeString", "documentation":"Abbreviated code for the county or sub-region.
" }, "Name":{ "shape":"SubRegionNameString", "documentation":"Name for the county or sub-region.
" } }, "documentation":"The sub-region.
" }, "SubRegionCodeString":{ "type":"string", "max":3, "min":0, "sensitive":true }, "SubRegionHighlights":{ "type":"structure", "members":{ "Code":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending index of the sub-region in the text query that match the found title.
" }, "Name":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending index of the name in the text query that match the found title.
" } }, "documentation":"Indicates the starting and ending index of the sub-region in the text query that match the found title.
" }, "SubRegionNameString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "SuggestAdditionalFeature":{ "type":"string", "enum":[ "Core", "TimeZone", "Phonemes", "Access" ] }, "SuggestAdditionalFeatureList":{ "type":"list", "member":{"shape":"SuggestAdditionalFeature"}, "max":4, "min":1 }, "SuggestAddressHighlights":{ "type":"structure", "members":{ "Label":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.
" } }, "documentation":"Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.
" }, "SuggestFilter":{ "type":"structure", "members":{ "BoundingBox":{ "shape":"BoundingBox", "documentation":"The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" } }, "documentation":"SuggestFilter structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "SuggestHighlights":{ "type":"structure", "members":{ "Title":{ "shape":"HighlightList", "documentation":"Indicates the starting and ending index of the title in the text query that match the found title.
" }, "Address":{ "shape":"SuggestAddressHighlights", "documentation":"The place's address.
" } }, "documentation":"Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.
" }, "SuggestIntendedUse":{ "type":"string", "enum":["SingleUse"] }, "SuggestPlaceResult":{ "type":"structure", "members":{ "PlaceId":{ "shape":"SuggestPlaceResultPlaceIdString", "documentation":"The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The place's address.
" }, "Position":{ "shape":"Position", "documentation":"The position in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "Distance":{ "shape":"DistanceMeters", "documentation":"The distance in meters from the QueryPosition.
" }, "MapView":{ "shape":"BoundingBox", "documentation":"The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
Categories of results that results must belong to.
" }, "FoodTypes":{ "shape":"FoodTypeList", "documentation":"List of food types offered by this result.
" }, "BusinessChains":{ "shape":"BusinessChainList", "documentation":"The Business Chains associated with the place.
" }, "AccessPoints":{ "shape":"AccessPointList", "documentation":"Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
" }, "AccessRestrictions":{ "shape":"AccessRestrictionList", "documentation":"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.
" }, "TimeZone":{ "shape":"TimeZone", "documentation":"The time zone in which the place is located.
" }, "PoliticalView":{ "shape":"CountryCode3", "documentation":"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.
" }, "Phonemes":{ "shape":"PhonemeDetails", "documentation":"How the various components of the result's address are pronounced in various languages.
" } }, "documentation":"The suggested place results.
" }, "SuggestPlaceResultPlaceIdString":{ "type":"string", "max":500, "min":1, "sensitive":true }, "SuggestQueryResult":{ "type":"structure", "members":{ "QueryId":{ "shape":"SuggestQueryResultQueryIdString", "documentation":"QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details SearchText API docs.
The fields QueryText, and QueryID are mutually exclusive.
The query type. Category queries will search for places which have an entry matching the given category, for example \"doctor office\". BusinessChain queries will search for instances of a given business.
" } }, "documentation":"The suggested query results.
" }, "SuggestQueryResultQueryIdString":{ "type":"string", "max":500, "min":0, "sensitive":true }, "SuggestRequest":{ "type":"structure", "required":["QueryText"], "members":{ "QueryText":{ "shape":"SuggestRequestQueryTextString", "documentation":"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.
The fields QueryText and QueryID are mutually exclusive.
An optional limit for the number of results returned in a single call.
Default value: 20
" }, "MaxQueryRefinements":{ "shape":"SuggestRequestMaxQueryRefinementsInteger", "documentation":"Maximum number of query terms to be returned for use with a search text query.
" }, "BiasPosition":{ "shape":"Position", "documentation":"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.
The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
" }, "AdditionalFeatures":{ "shape":"SuggestAdditionalFeatureList", "documentation":"A list of optional additional parameters, such as time zone, that can be requested for each result.
" }, "Language":{ "shape":"LanguageTag", "documentation":"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.
" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"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.
" }, "IntendedUse":{ "shape":"SuggestIntendedUse", "documentation":"Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
", "location":"querystring", "locationName":"key" } } }, "SuggestRequestMaxQueryRefinementsInteger":{ "type":"integer", "box":true, "max":10, "min":1 }, "SuggestRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "SuggestRequestQueryTextString":{ "type":"string", "max":200, "min":1, "sensitive":true }, "SuggestResponse":{ "type":"structure", "required":["PricingBucket"], "members":{ "PricingBucket":{ "shape":"String", "documentation":"The pricing bucket for which the query is charged at.
For more information on pricing, please visit Amazon Location Service Pricing.
", "location":"header", "locationName":"x-amz-geo-pricing-bucket" }, "ResultItems":{ "shape":"SuggestResultItemList", "documentation":"List of places or results returned for a query.
" }, "QueryRefinements":{ "shape":"QueryRefinementList", "documentation":"Maximum number of query terms to be returned for use with a search text query.
" } } }, "SuggestResultItem":{ "type":"structure", "required":[ "Title", "SuggestResultItemType" ], "members":{ "Title":{ "shape":"SuggestResultItemTitleString", "documentation":"The display title that should be used when presenting this option to the end user.
" }, "SuggestResultItemType":{ "shape":"SuggestResultItemType", "documentation":"The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.
" }, "Place":{ "shape":"SuggestPlaceResult", "documentation":"The suggested place by its unique ID.
" }, "Query":{"shape":"SuggestQueryResult"}, "Highlights":{ "shape":"SuggestHighlights", "documentation":"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.
" } }, "documentation":"The resulting item from the suggested query.
" }, "SuggestResultItemList":{ "type":"list", "member":{"shape":"SuggestResultItem"}, "max":100, "min":0 }, "SuggestResultItemTitleString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "SuggestResultItemType":{ "type":"string", "enum":[ "Place", "Query" ] }, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "TimeZone":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"TimeZoneNameString", "documentation":"The time zone name.
" }, "Offset":{ "shape":"TimeZoneOffsetString", "documentation":"Time zone offset of the timezone from UTC.
" }, "OffsetSeconds":{ "shape":"TimeZoneOffsetSecondsLong", "documentation":"The offset of the time zone from UTC, in seconds.
" } }, "documentation":"The time zone in which the place is located.
" }, "TimeZoneNameString":{ "type":"string", "max":200, "min":0, "sensitive":true }, "TimeZoneOffsetSecondsLong":{ "type":"long", "min":0, "sensitive":true }, "TimeZoneOffsetString":{ "type":"string", "max":6, "min":0, "sensitive":true }, "Token":{ "type":"string", "max":2000, "min":1 }, "TypePlacement":{ "type":"string", "enum":[ "BeforeBaseName", "AfterBaseName" ] }, "TypeSeparator":{ "type":"string", "max":1, "min":0, "pattern":"$|^ " }, "UspsZip":{ "type":"structure", "members":{ "ZipClassificationCode":{ "shape":"ZipClassificationCode", "documentation":"The ZIP Classification Code, or in other words what type of postal code is it.
" } }, "documentation":"The USPS zip code.
" }, "UspsZipPlus4":{ "type":"structure", "members":{ "RecordTypeCode":{ "shape":"RecordTypeCode", "documentation":"The USPS ZIP+4 Record Type Code.
" } }, "documentation":"The USPS zip+4 code.
" }, "ValidationException":{ "type":"structure", "required":[ "Message", "Reason", "FieldList" ], "members":{ "Message":{ "shape":"String", "locationName":"message" }, "Reason":{ "shape":"ValidationExceptionReason", "documentation":"Test stub for reason
", "locationName":"reason" }, "FieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"Test stub for FieldList.
", "locationName":"fieldList" } }, "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "Name", "Message" ], "members":{ "Name":{ "shape":"String", "documentation":"The name of the resource.
", "locationName":"name" }, "Message":{ "shape":"String", "documentation":"The error message.
", "locationName":"message" } }, "documentation":"The input fails to satisfy the constraints specified by the Amazon Location service.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "UnknownOperation", "Missing", "CannotParse", "FieldValidationFailed", "Other", "UnknownField" ] }, "ZipClassificationCode":{ "type":"string", "enum":[ "Military", "PostOfficeBoxes", "Unique" ], "sensitive":true } }, "documentation":"The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include:
Forward and reverse geocoding for addresses and coordinates
Comprehensive place searches with detailed information, including:
Business names and addresses
Contact information
Hours of operation
POI (Points of Interest) categories
Food types for restaurants
Chain affiliation for relevant businesses
Global data coverage with a wide range of POI categories
Regular data updates to ensure accuracy and relevance