A list of optional additional parameters that can be requested for each result. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AdditionalFeatures |
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 WSG84 format.The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The center position, in longitude and latitude, of the FilterCircle. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Filter_Circle_Center |
-Circle_Radius <Int64>
The radius, in meters, of the FilterCircle.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Filter_Circle_Radius |
Amazon.PowerShell.Cmdlets.GEOP.AmazonGeoPlacesClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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}] Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Filter_IncludeCountries |
The included place types. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Filter_IncludePlaceTypes |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
An optional limit for the number of results returned in a single call.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MaxResults |
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
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GeoPlaces.Model.AutocompleteResponse). Specifying the name of a property of type Amazon.GeoPlaces.Model.AutocompleteResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |