SearchNearbyFilter
SearchNearby structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
Contents
- BoundingBox
-
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}]Type: Array of doubles
Array Members: Fixed number of 4 items.
Required: No
- ExcludeBusinessChains
-
The Business Chains associated with the place.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- ExcludeCategories
-
Categories of results that results are excluded from.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- ExcludeFoodTypes
-
Food types that results are excluded from.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- IncludeBusinessChains
-
The Business Chains associated with the place.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- IncludeCategories
-
Categories of results that results must belong too.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- IncludeCountries
-
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 2. Maximum length of 3.
Pattern:
([A-Z]{2}|[A-Z]{3})Required: No
- IncludeFoodTypes
-
Food types that results are included from.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
