AWS.Tools.GeoPlaces.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.GeoPlaces</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet"> <summary> Finds a place by its unique ID. A <c>PlaceId</c> is returned by other place operations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet.AdditionalFeature"> <summary> <para> <para>A list of optional additional parameters such as time zone that can be requested for each result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet.IntendedUse"> <summary> <para> <para>Indicates if the results will be stored. Defaults to <c>SingleUse</c>, if left empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet.Key"> <summary> <para> <para>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet.Language"> <summary> <para> <para>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet.PlaceId"> <summary> <para> <para>The <c>PlaceId</c> of the place you wish to receive the information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet.PoliticalView"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet.Select"> <summary> 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.GetPlaceResponse). Specifying the name of a property of type Amazon.GeoPlaces.Model.GetPlaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.GetGEOPPlaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PlaceId parameter. The -PassThru parameter is deprecated, use -Select '^PlaceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet"> <summary> The autocomplete operation speeds up and increases the accuracy of entering addresses by providing a list of address candidates matching a partially entered address. Results are sorted from most to least matching. Filtering and biasing can be used to increase the relevance of the results if additional search context is known </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.AdditionalFeature"> <summary> <para> <para>A list of optional additional parameters that can be requested for each result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.BiasPosition"> <summary> <para> <para>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 <c>[lng, lat]</c> and in the WSG84 format.</para><note><para>The fields <c>BiasPosition</c>, <c>FilterBoundingBox</c>, and <c>FilterCircle</c> are mutually exclusive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Filter_BoundingBox"> <summary> <para> <para>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</para><para>The bounding box formed is defined as a set 4 coordinates: <c>[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Circle_Center"> <summary> <para> <para>The center position, in longitude and latitude, of the <c>FilterCircle</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Filter_IncludeCountry"> <summary> <para> <para> A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Filter_IncludePlaceType"> <summary> <para> <para>The included place types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.IntendedUse"> <summary> <para> <para>Indicates if the results will be stored. Defaults to <c>SingleUse</c>, if left empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Key"> <summary> <para> <para>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Language"> <summary> <para> <para>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.PoliticalView"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.PostalCodeMode"> <summary> <para> <para>The <c>PostalCodeMode</c> 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 <c>cityLookup</c>, all cities in that postal code are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.QueryText"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Circle_Radius"> <summary> <para> <para>The radius, in meters, of the <c>FilterCircle</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of results returned in a single call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryText parameter. The -PassThru parameter is deprecated, use -Select '^QueryText' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPAutocompleteCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet"> <summary> The <c>Geocode</c> action allows you to obtain coordinates, addresses, and other information about places. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.AdditionalFeature"> <summary> <para> <para>A list of optional additional parameters, such as time zone, that can be requested for each result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryComponents_AddressNumber"> <summary> <para> <para>The house number or address results should have. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.BiasPosition"> <summary> <para> <para>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 <c>[lng, lat]</c> and in the WSG84 format.</para><note><para>The fields <c>BiasPosition</c>, <c>FilterBoundingBox</c>, and <c>FilterCircle</c> are mutually exclusive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryComponents_Country"> <summary> <para> <para>The alpha-2 or alpha-3 character code for the country that the results will be present in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryComponents_District"> <summary> <para> <para>The district or division of a city the results should be present in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.Filter_IncludeCountry"> <summary> <para> <para> A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.Filter_IncludePlaceType"> <summary> <para> <para>The included place types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.IntendedUse"> <summary> <para> <para>Indicates if the results will be stored. Defaults to <c>SingleUse</c>, if left empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.Key"> <summary> <para> <para>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.Language"> <summary> <para> <para>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryComponents_Locality"> <summary> <para> <para>City or locality results should be present in. </para><para>Example: <c>Vancouver</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.PoliticalView"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryComponents_PostalCode"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryText"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryComponents_Region"> <summary> <para> <para>The region or state results should be to be present in. </para><para>Example: <c>North Rhine-Westphalia</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryComponents_Street"> <summary> <para> <para>The name of the street results should be present in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.QueryComponents_SubRegion"> <summary> <para> <para>The sub-region or county for which results should be present in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of results returned in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.Select"> <summary> 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.GeocodeResponse). Specifying the name of a property of type Amazon.GeoPlaces.Model.GeocodeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryText parameter. The -PassThru parameter is deprecated, use -Select '^QueryText' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPGeocodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet"> <summary> The <c>ReverseGeocode</c> operation allows you to retrieve addresses and place information from coordinates. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.AdditionalFeature"> <summary> <para> <para>A list of optional additional parameters, such as time zone that can be requested for each result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.Filter_IncludePlaceType"> <summary> <para> <para>The included place types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.IntendedUse"> <summary> <para> <para>Indicates if the results will be stored. Defaults to <c>SingleUse</c>, if left empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.Key"> <summary> <para> <para>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.Language"> <summary> <para> <para>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.PoliticalView"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.QueryPosition"> <summary> <para> <para>The position, in <c>[lng, lat]</c> for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.QueryRadius"> <summary> <para> <para>The maximum distance in meters from the QueryPosition from which a result will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of results returned in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.Select"> <summary> 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.ReverseGeocodeResponse). Specifying the name of a property of type Amazon.GeoPlaces.Model.ReverseGeocodeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryPosition parameter. The -PassThru parameter is deprecated, use -Select '^QueryPosition' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPReverseGeocodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet"> <summary> The <c>Suggest</c> operation finds addresses or place candidates based on incomplete or misspelled queries. You then select the best query to submit based on the returned results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.AdditionalFeature"> <summary> <para> <para>A list of optional additional parameters, such as time zone, that can be requested for each result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.BiasPosition"> <summary> <para> <para>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 <c>[lng, lat]</c> and in the WSG84 format.</para><note><para>The fields <c>BiasPosition</c>, <c>FilterBoundingBox</c>, and <c>FilterCircle</c> are mutually exclusive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.Filter_BoundingBox"> <summary> <para> <para>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</para><para>The bounding box formed is defined as a set 4 coordinates: <c>[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.Circle_Center"> <summary> <para> <para>The center position, in longitude and latitude, of the <c>FilterCircle</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.Filter_IncludeCountry"> <summary> <para> <para> A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.IntendedUse"> <summary> <para> <para>Indicates if the results will be stored. Defaults to <c>SingleUse</c>, if left empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.Key"> <summary> <para> <para>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.Language"> <summary> <para> <para>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.MaxQueryRefinement"> <summary> <para> <para>Maximum number of query terms to be returned for use with a search text query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.PoliticalView"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.QueryText"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.Circle_Radius"> <summary> <para> <para>The radius, in meters, of the <c>FilterCircle</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of results returned in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.Select"> <summary> 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.SuggestResponse). Specifying the name of a property of type Amazon.GeoPlaces.Model.SuggestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryText parameter. The -PassThru parameter is deprecated, use -Select '^QueryText' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.InvokeGEOPSuggestCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet"> <summary> Search nearby a specified location. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.AdditionalFeature"> <summary> <para> <para>A list of optional additional parameters, such as time zone, that can be requested for each result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Filter_BoundingBox"> <summary> <para> <para>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</para><para>The bounding box formed is defined as a set 4 coordinates: <c>[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Filter_ExcludeBusinessChain"> <summary> <para> <para>The Business Chains associated with the place.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Filter_ExcludeCategory"> <summary> <para> <para>Categories of results that results are excluded from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Filter_ExcludeFoodType"> <summary> <para> <para>Food types that results are excluded from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Filter_IncludeBusinessChain"> <summary> <para> <para>The Business Chains associated with the place.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Filter_IncludeCategory"> <summary> <para> <para>Categories of results that results must belong too.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Filter_IncludeCountry"> <summary> <para> <para>A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Filter_IncludeFoodType"> <summary> <para> <para>Food types that results are included from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.IntendedUse"> <summary> <para> <para>Indicates if the results will be stored. Defaults to <c>SingleUse</c>, if left empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Key"> <summary> <para> <para>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Language"> <summary> <para> <para>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.PoliticalView"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.QueryPosition"> <summary> <para> <para>The position, in <c>[lng, lat]</c> for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.QueryRadius"> <summary> <para> <para>The maximum distance in meters from the QueryPosition from which a result will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of results returned in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> is a unique pagination token for each page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Select"> <summary> 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.SearchNearbyResponse). Specifying the name of a property of type Amazon.GeoPlaces.Model.SearchNearbyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryPosition parameter. The -PassThru parameter is deprecated, use -Select '^QueryPosition' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPNearbyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet"> <summary> Use the <c>SearchText</c> operation to search for geocode and place information. You can then complete a follow-up query suggested from the <c>Suggest</c> API via a query id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.AdditionalFeature"> <summary> <para> <para>A list of optional additional parameters, such as time zone, that can be requested for each result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.BiasPosition"> <summary> <para> <para>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 <c>[lng, lat]</c> and in the WSG84 format.</para><note><para>The fields <c>BiasPosition</c>, <c>FilterBoundingBox</c>, and <c>FilterCircle</c> are mutually exclusive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.Filter_BoundingBox"> <summary> <para> <para>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</para><para>The bounding box formed is defined as a set 4 coordinates: <c>[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.Circle_Center"> <summary> <para> <para>The center position, in longitude and latitude, of the <c>FilterCircle</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.Filter_IncludeCountry"> <summary> <para> <para> A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.IntendedUse"> <summary> <para> <para>Indicates if the results will be stored. Defaults to <c>SingleUse</c>, if left empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.Key"> <summary> <para> <para>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.Language"> <summary> <para> <para>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.PoliticalView"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.QueryId"> <summary> <para> <para>The query Id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.QueryText"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.Circle_Radius"> <summary> <para> <para>The radius, in meters, of the <c>FilterCircle</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.MaxResult"> <summary> <para> <para>An optional limit for the number of results returned in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> is a unique pagination token for each page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GEOP.SearchGEOPTextCmdlet.Select"> <summary> 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.SearchTextResponse). Specifying the name of a property of type Amazon.GeoPlaces.Model.SearchTextResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> </members> </doc> |