AutocompleteAddressHighlights
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.
Contents
- AddressNumber
-
The house number or address results should have.
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- Block
-
Name of the block. Example: Sunny Mansion 203 block: 2 Chome
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- Building
-
The name of the building at the address.
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- Country
-
The alpha-2 or alpha-3 character code for the country that the results will be present in.
Type: CountryHighlights object
Required: No
- District
-
The district or division of a city the results should be present in.
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- Intersection
-
Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]
Type: Array of arrays of Highlight objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- Label
-
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.
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- Locality
-
The city or locality results should be present in.
Example:
Vancouver.Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- PostalCode
-
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 posses.
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- Region
-
The region or state results should be to be present in.
Example:
North Rhine-Westphalia.Type: RegionHighlights object
Required: No
- Street
-
The name of the street results should be present in.
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- SubBlock
-
Name of sub-block. Example Sunny Mansion 203 sub-block: 4
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- SubDistrict
-
Indicates the starting and ending index of the title in the text query that match the found title.
Type: Array of Highlight objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- SubRegion
-
The sub-region or county for which results should be present in.
Type: SubRegionHighlights object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
