aws-sdk-geoplaces 1.7.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-geoplaces/client.rb +512 -39
- data/lib/aws-sdk-geoplaces/client_api.rb +118 -13
- data/lib/aws-sdk-geoplaces/endpoint_provider.rb +4 -4
- data/lib/aws-sdk-geoplaces/types.rb +569 -89
- data/lib/aws-sdk-geoplaces.rb +1 -1
- data/sig/client.rbs +6 -4
- data/sig/types.rbs +127 -46
- metadata +1 -1
@@ -469,16 +469,23 @@ module Aws::GeoPlaces
|
|
469
469
|
|
470
470
|
# @!group API Operations
|
471
471
|
|
472
|
-
#
|
473
|
-
#
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
472
|
+
# `Autocomplete` completes potential places and addresses as the user
|
473
|
+
# types, based on the partial input. The API enhances the efficiency and
|
474
|
+
# accuracy of address by completing query based on a few entered
|
475
|
+
# keystrokes. It helps you by completing partial queries with valid
|
476
|
+
# address completion. Also, the API supports the filtering of results
|
477
|
+
# based on geographic location, country, or specific place types, and
|
478
|
+
# can be tailored using optional parameters like language and political
|
479
|
+
# views.
|
477
480
|
#
|
478
481
|
# @option params [required, String] :query_text
|
479
482
|
# The free-form text query to match addresses against. This is usually a
|
480
483
|
# partially typed address from an end user in an address box or form.
|
481
484
|
#
|
485
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
486
|
+
#
|
487
|
+
# </note>
|
488
|
+
#
|
482
489
|
# @option params [Integer] :max_results
|
483
490
|
# An optional limit for the number of results returned in a single call.
|
484
491
|
#
|
@@ -495,14 +502,15 @@ module Aws::GeoPlaces
|
|
495
502
|
#
|
496
503
|
# @option params [Types::AutocompleteFilter] :filter
|
497
504
|
# A structure which contains a set of inclusion/exclusion properties
|
498
|
-
# that results must
|
505
|
+
# that results must possess in order to be returned as a result.
|
499
506
|
#
|
500
507
|
# @option params [String] :postal_code_mode
|
501
508
|
# The `PostalCodeMode` affects how postal code results are returned. If
|
502
509
|
# a postal code spans multiple localities and this value is empty,
|
503
510
|
# partial district or locality information may be returned under a
|
504
511
|
# single postal code result entry. If it's populated with the value
|
505
|
-
# `
|
512
|
+
# `EnumerateSpannedLocalities`, all cities in that postal code are
|
513
|
+
# returned.
|
506
514
|
#
|
507
515
|
# @option params [Array<String>] :additional_features
|
508
516
|
# A list of optional additional parameters that can be requested for
|
@@ -523,6 +531,39 @@ module Aws::GeoPlaces
|
|
523
531
|
# represent unresolved territorial claims through the point of view of
|
524
532
|
# the specified country.
|
525
533
|
#
|
534
|
+
# The following political views are currently supported:
|
535
|
+
#
|
536
|
+
# * `ARG`: Argentina's view on the Southern Patagonian Ice Field and
|
537
|
+
# Tierra Del Fuego, including the Falkland Islands, South Georgia, and
|
538
|
+
# South Sandwich Islands
|
539
|
+
#
|
540
|
+
# * `EGY`: Egypt's view on Bir Tawil
|
541
|
+
#
|
542
|
+
# * `IND`: India's view on Gilgit-Baltistan
|
543
|
+
#
|
544
|
+
# * `KEN`: Kenya's view on the Ilemi Triangle
|
545
|
+
#
|
546
|
+
# * `MAR`: Morocco's view on Western Sahara
|
547
|
+
#
|
548
|
+
# * `RUS`: Russia's view on Crimea
|
549
|
+
#
|
550
|
+
# * `SDN`: Sudan's view on the Halaib Triangle
|
551
|
+
#
|
552
|
+
# * `SRB`: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
|
553
|
+
#
|
554
|
+
# * `SUR`: Suriname's view on the Courantyne Headwaters and Lawa
|
555
|
+
# Headwaters
|
556
|
+
#
|
557
|
+
# * `SYR`: Syria's view on the Golan Heights
|
558
|
+
#
|
559
|
+
# * `TUR`: Turkey's view on Cyprus and Northern Cyprus
|
560
|
+
#
|
561
|
+
# * `TZA`: Tanzania's view on Lake Malawi
|
562
|
+
#
|
563
|
+
# * `URY`: Uruguay's view on Rincon de Artigas
|
564
|
+
#
|
565
|
+
# * `VNM`: Vietnam's view on the Paracel Islands and Spratly Islands
|
566
|
+
#
|
526
567
|
# @option params [String] :intended_use
|
527
568
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
528
569
|
# left empty.
|
@@ -564,7 +605,7 @@ module Aws::GeoPlaces
|
|
564
605
|
# resp.pricing_bucket #=> String
|
565
606
|
# resp.result_items #=> Array
|
566
607
|
# resp.result_items[0].place_id #=> String
|
567
|
-
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress"
|
608
|
+
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
568
609
|
# resp.result_items[0].title #=> String
|
569
610
|
# resp.result_items[0].address.label #=> String
|
570
611
|
# resp.result_items[0].address.country.code_2 #=> String
|
@@ -594,6 +635,8 @@ module Aws::GeoPlaces
|
|
594
635
|
# resp.result_items[0].address.street_components[0].language #=> String
|
595
636
|
# resp.result_items[0].address.address_number #=> String
|
596
637
|
# resp.result_items[0].address.building #=> String
|
638
|
+
# resp.result_items[0].address.secondary_address_components #=> Array
|
639
|
+
# resp.result_items[0].address.secondary_address_components[0].number #=> String
|
597
640
|
# resp.result_items[0].distance #=> Integer
|
598
641
|
# resp.result_items[0].language #=> String
|
599
642
|
# resp.result_items[0].political_view #=> String
|
@@ -680,13 +723,22 @@ module Aws::GeoPlaces
|
|
680
723
|
req.send_request(options)
|
681
724
|
end
|
682
725
|
|
683
|
-
#
|
684
|
-
#
|
726
|
+
# `Geocode` converts a textual address or place into geographic
|
727
|
+
# coordinates. You can obtain geographic coordinates, address component,
|
728
|
+
# and other related information. It supports flexible queries, including
|
729
|
+
# free-form text or structured queries with components like street
|
730
|
+
# names, postal codes, and regions. The Geocode API can also provide
|
731
|
+
# additional features such as time zone information and the inclusion of
|
732
|
+
# political views.
|
685
733
|
#
|
686
734
|
# @option params [String] :query_text
|
687
735
|
# The free-form text query to match addresses against. This is usually a
|
688
736
|
# partially typed address from an end user in an address box or form.
|
689
737
|
#
|
738
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
739
|
+
#
|
740
|
+
# </note>
|
741
|
+
#
|
690
742
|
# @option params [Types::GeocodeQueryComponents] :query_components
|
691
743
|
# A structured free text query allows you to search for places by the
|
692
744
|
# name or text representation of specific properties of the place.
|
@@ -707,7 +759,7 @@ module Aws::GeoPlaces
|
|
707
759
|
#
|
708
760
|
# @option params [Types::GeocodeFilter] :filter
|
709
761
|
# A structure which contains a set of inclusion/exclusion properties
|
710
|
-
# that results must
|
762
|
+
# that results must possess in order to be returned as a result.
|
711
763
|
#
|
712
764
|
# @option params [Array<String>] :additional_features
|
713
765
|
# A list of optional additional parameters, such as time zone, that can
|
@@ -732,6 +784,18 @@ module Aws::GeoPlaces
|
|
732
784
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
733
785
|
# left empty.
|
734
786
|
#
|
787
|
+
# <note markdown="1"> Storing the response of an Geocode query is required to comply with
|
788
|
+
# service terms, but charged at a higher cost per request. Please review
|
789
|
+
# the [user agreement][1] and [service pricing structure][2] to
|
790
|
+
# determine the correct setting for your use case.
|
791
|
+
#
|
792
|
+
# </note>
|
793
|
+
#
|
794
|
+
#
|
795
|
+
#
|
796
|
+
# [1]: https://aws.amazon.com/location/sla/
|
797
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
798
|
+
#
|
735
799
|
# @option params [String] :key
|
736
800
|
# Optional: The API key to be used for authorization. Either an API key
|
737
801
|
# or valid SigV4 signature must be provided when making a request.
|
@@ -761,7 +825,7 @@ module Aws::GeoPlaces
|
|
761
825
|
# include_countries: ["CountryCode"],
|
762
826
|
# include_place_types: ["Locality"], # accepts Locality, PostalCode, Intersection, Street, PointAddress, InterpolatedAddress
|
763
827
|
# },
|
764
|
-
# additional_features: ["TimeZone"], # accepts TimeZone, Access
|
828
|
+
# additional_features: ["TimeZone"], # accepts TimeZone, Access, SecondaryAddresses, Intersections
|
765
829
|
# language: "LanguageTag",
|
766
830
|
# political_view: "CountryCode",
|
767
831
|
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
@@ -773,7 +837,7 @@ module Aws::GeoPlaces
|
|
773
837
|
# resp.pricing_bucket #=> String
|
774
838
|
# resp.result_items #=> Array
|
775
839
|
# resp.result_items[0].place_id #=> String
|
776
|
-
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress"
|
840
|
+
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
777
841
|
# resp.result_items[0].title #=> String
|
778
842
|
# resp.result_items[0].address.label #=> String
|
779
843
|
# resp.result_items[0].address.country.code_2 #=> String
|
@@ -803,6 +867,8 @@ module Aws::GeoPlaces
|
|
803
867
|
# resp.result_items[0].address.street_components[0].language #=> String
|
804
868
|
# resp.result_items[0].address.address_number #=> String
|
805
869
|
# resp.result_items[0].address.building #=> String
|
870
|
+
# resp.result_items[0].address.secondary_address_components #=> Array
|
871
|
+
# resp.result_items[0].address.secondary_address_components[0].number #=> String
|
806
872
|
# resp.result_items[0].address_number_corrected #=> Boolean
|
807
873
|
# resp.result_items[0].postal_code_details #=> Array
|
808
874
|
# resp.result_items[0].postal_code_details[0].postal_code #=> String
|
@@ -846,6 +912,198 @@ module Aws::GeoPlaces
|
|
846
912
|
# resp.result_items[0].match_scores.components.address.intersection[0] #=> Float
|
847
913
|
# resp.result_items[0].match_scores.components.address.address_number #=> Float
|
848
914
|
# resp.result_items[0].match_scores.components.address.building #=> Float
|
915
|
+
# resp.result_items[0].match_scores.components.address.secondary_address_components #=> Array
|
916
|
+
# resp.result_items[0].match_scores.components.address.secondary_address_components[0].number #=> Float
|
917
|
+
# resp.result_items[0].parsed_query.title #=> Array
|
918
|
+
# resp.result_items[0].parsed_query.title[0].start_index #=> Integer
|
919
|
+
# resp.result_items[0].parsed_query.title[0].end_index #=> Integer
|
920
|
+
# resp.result_items[0].parsed_query.title[0].value #=> String
|
921
|
+
# resp.result_items[0].parsed_query.title[0].query_component #=> String
|
922
|
+
# resp.result_items[0].parsed_query.address.country #=> Array
|
923
|
+
# resp.result_items[0].parsed_query.address.country[0].start_index #=> Integer
|
924
|
+
# resp.result_items[0].parsed_query.address.country[0].end_index #=> Integer
|
925
|
+
# resp.result_items[0].parsed_query.address.country[0].value #=> String
|
926
|
+
# resp.result_items[0].parsed_query.address.country[0].query_component #=> String
|
927
|
+
# resp.result_items[0].parsed_query.address.region #=> Array
|
928
|
+
# resp.result_items[0].parsed_query.address.region[0].start_index #=> Integer
|
929
|
+
# resp.result_items[0].parsed_query.address.region[0].end_index #=> Integer
|
930
|
+
# resp.result_items[0].parsed_query.address.region[0].value #=> String
|
931
|
+
# resp.result_items[0].parsed_query.address.region[0].query_component #=> String
|
932
|
+
# resp.result_items[0].parsed_query.address.sub_region #=> Array
|
933
|
+
# resp.result_items[0].parsed_query.address.sub_region[0].start_index #=> Integer
|
934
|
+
# resp.result_items[0].parsed_query.address.sub_region[0].end_index #=> Integer
|
935
|
+
# resp.result_items[0].parsed_query.address.sub_region[0].value #=> String
|
936
|
+
# resp.result_items[0].parsed_query.address.sub_region[0].query_component #=> String
|
937
|
+
# resp.result_items[0].parsed_query.address.locality #=> Array
|
938
|
+
# resp.result_items[0].parsed_query.address.locality[0].start_index #=> Integer
|
939
|
+
# resp.result_items[0].parsed_query.address.locality[0].end_index #=> Integer
|
940
|
+
# resp.result_items[0].parsed_query.address.locality[0].value #=> String
|
941
|
+
# resp.result_items[0].parsed_query.address.locality[0].query_component #=> String
|
942
|
+
# resp.result_items[0].parsed_query.address.district #=> Array
|
943
|
+
# resp.result_items[0].parsed_query.address.district[0].start_index #=> Integer
|
944
|
+
# resp.result_items[0].parsed_query.address.district[0].end_index #=> Integer
|
945
|
+
# resp.result_items[0].parsed_query.address.district[0].value #=> String
|
946
|
+
# resp.result_items[0].parsed_query.address.district[0].query_component #=> String
|
947
|
+
# resp.result_items[0].parsed_query.address.sub_district #=> Array
|
948
|
+
# resp.result_items[0].parsed_query.address.sub_district[0].start_index #=> Integer
|
949
|
+
# resp.result_items[0].parsed_query.address.sub_district[0].end_index #=> Integer
|
950
|
+
# resp.result_items[0].parsed_query.address.sub_district[0].value #=> String
|
951
|
+
# resp.result_items[0].parsed_query.address.sub_district[0].query_component #=> String
|
952
|
+
# resp.result_items[0].parsed_query.address.postal_code #=> Array
|
953
|
+
# resp.result_items[0].parsed_query.address.postal_code[0].start_index #=> Integer
|
954
|
+
# resp.result_items[0].parsed_query.address.postal_code[0].end_index #=> Integer
|
955
|
+
# resp.result_items[0].parsed_query.address.postal_code[0].value #=> String
|
956
|
+
# resp.result_items[0].parsed_query.address.postal_code[0].query_component #=> String
|
957
|
+
# resp.result_items[0].parsed_query.address.block #=> Array
|
958
|
+
# resp.result_items[0].parsed_query.address.block[0].start_index #=> Integer
|
959
|
+
# resp.result_items[0].parsed_query.address.block[0].end_index #=> Integer
|
960
|
+
# resp.result_items[0].parsed_query.address.block[0].value #=> String
|
961
|
+
# resp.result_items[0].parsed_query.address.block[0].query_component #=> String
|
962
|
+
# resp.result_items[0].parsed_query.address.sub_block #=> Array
|
963
|
+
# resp.result_items[0].parsed_query.address.sub_block[0].start_index #=> Integer
|
964
|
+
# resp.result_items[0].parsed_query.address.sub_block[0].end_index #=> Integer
|
965
|
+
# resp.result_items[0].parsed_query.address.sub_block[0].value #=> String
|
966
|
+
# resp.result_items[0].parsed_query.address.sub_block[0].query_component #=> String
|
967
|
+
# resp.result_items[0].parsed_query.address.street #=> Array
|
968
|
+
# resp.result_items[0].parsed_query.address.street[0].start_index #=> Integer
|
969
|
+
# resp.result_items[0].parsed_query.address.street[0].end_index #=> Integer
|
970
|
+
# resp.result_items[0].parsed_query.address.street[0].value #=> String
|
971
|
+
# resp.result_items[0].parsed_query.address.street[0].query_component #=> String
|
972
|
+
# resp.result_items[0].parsed_query.address.address_number #=> Array
|
973
|
+
# resp.result_items[0].parsed_query.address.address_number[0].start_index #=> Integer
|
974
|
+
# resp.result_items[0].parsed_query.address.address_number[0].end_index #=> Integer
|
975
|
+
# resp.result_items[0].parsed_query.address.address_number[0].value #=> String
|
976
|
+
# resp.result_items[0].parsed_query.address.address_number[0].query_component #=> String
|
977
|
+
# resp.result_items[0].parsed_query.address.building #=> Array
|
978
|
+
# resp.result_items[0].parsed_query.address.building[0].start_index #=> Integer
|
979
|
+
# resp.result_items[0].parsed_query.address.building[0].end_index #=> Integer
|
980
|
+
# resp.result_items[0].parsed_query.address.building[0].value #=> String
|
981
|
+
# resp.result_items[0].parsed_query.address.building[0].query_component #=> String
|
982
|
+
# resp.result_items[0].parsed_query.address.secondary_address_components #=> Array
|
983
|
+
# resp.result_items[0].parsed_query.address.secondary_address_components[0].start_index #=> Integer
|
984
|
+
# resp.result_items[0].parsed_query.address.secondary_address_components[0].end_index #=> Integer
|
985
|
+
# resp.result_items[0].parsed_query.address.secondary_address_components[0].value #=> String
|
986
|
+
# resp.result_items[0].parsed_query.address.secondary_address_components[0].number #=> String
|
987
|
+
# resp.result_items[0].parsed_query.address.secondary_address_components[0].designator #=> String
|
988
|
+
# resp.result_items[0].intersections #=> Array
|
989
|
+
# resp.result_items[0].intersections[0].place_id #=> String
|
990
|
+
# resp.result_items[0].intersections[0].title #=> String
|
991
|
+
# resp.result_items[0].intersections[0].address.label #=> String
|
992
|
+
# resp.result_items[0].intersections[0].address.country.code_2 #=> String
|
993
|
+
# resp.result_items[0].intersections[0].address.country.code_3 #=> String
|
994
|
+
# resp.result_items[0].intersections[0].address.country.name #=> String
|
995
|
+
# resp.result_items[0].intersections[0].address.region.code #=> String
|
996
|
+
# resp.result_items[0].intersections[0].address.region.name #=> String
|
997
|
+
# resp.result_items[0].intersections[0].address.sub_region.code #=> String
|
998
|
+
# resp.result_items[0].intersections[0].address.sub_region.name #=> String
|
999
|
+
# resp.result_items[0].intersections[0].address.locality #=> String
|
1000
|
+
# resp.result_items[0].intersections[0].address.district #=> String
|
1001
|
+
# resp.result_items[0].intersections[0].address.sub_district #=> String
|
1002
|
+
# resp.result_items[0].intersections[0].address.postal_code #=> String
|
1003
|
+
# resp.result_items[0].intersections[0].address.block #=> String
|
1004
|
+
# resp.result_items[0].intersections[0].address.sub_block #=> String
|
1005
|
+
# resp.result_items[0].intersections[0].address.intersection #=> Array
|
1006
|
+
# resp.result_items[0].intersections[0].address.intersection[0] #=> String
|
1007
|
+
# resp.result_items[0].intersections[0].address.street #=> String
|
1008
|
+
# resp.result_items[0].intersections[0].address.street_components #=> Array
|
1009
|
+
# resp.result_items[0].intersections[0].address.street_components[0].base_name #=> String
|
1010
|
+
# resp.result_items[0].intersections[0].address.street_components[0].type #=> String
|
1011
|
+
# resp.result_items[0].intersections[0].address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
|
1012
|
+
# resp.result_items[0].intersections[0].address.street_components[0].type_separator #=> String
|
1013
|
+
# resp.result_items[0].intersections[0].address.street_components[0].prefix #=> String
|
1014
|
+
# resp.result_items[0].intersections[0].address.street_components[0].suffix #=> String
|
1015
|
+
# resp.result_items[0].intersections[0].address.street_components[0].direction #=> String
|
1016
|
+
# resp.result_items[0].intersections[0].address.street_components[0].language #=> String
|
1017
|
+
# resp.result_items[0].intersections[0].address.address_number #=> String
|
1018
|
+
# resp.result_items[0].intersections[0].address.building #=> String
|
1019
|
+
# resp.result_items[0].intersections[0].address.secondary_address_components #=> Array
|
1020
|
+
# resp.result_items[0].intersections[0].address.secondary_address_components[0].number #=> String
|
1021
|
+
# resp.result_items[0].intersections[0].position #=> Array
|
1022
|
+
# resp.result_items[0].intersections[0].position[0] #=> Float
|
1023
|
+
# resp.result_items[0].intersections[0].distance #=> Integer
|
1024
|
+
# resp.result_items[0].intersections[0].route_distance #=> Integer
|
1025
|
+
# resp.result_items[0].intersections[0].map_view #=> Array
|
1026
|
+
# resp.result_items[0].intersections[0].map_view[0] #=> Float
|
1027
|
+
# resp.result_items[0].intersections[0].access_points #=> Array
|
1028
|
+
# resp.result_items[0].intersections[0].access_points[0].position #=> Array
|
1029
|
+
# resp.result_items[0].intersections[0].access_points[0].position[0] #=> Float
|
1030
|
+
# resp.result_items[0].main_address.place_id #=> String
|
1031
|
+
# resp.result_items[0].main_address.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
1032
|
+
# resp.result_items[0].main_address.title #=> String
|
1033
|
+
# resp.result_items[0].main_address.address.label #=> String
|
1034
|
+
# resp.result_items[0].main_address.address.country.code_2 #=> String
|
1035
|
+
# resp.result_items[0].main_address.address.country.code_3 #=> String
|
1036
|
+
# resp.result_items[0].main_address.address.country.name #=> String
|
1037
|
+
# resp.result_items[0].main_address.address.region.code #=> String
|
1038
|
+
# resp.result_items[0].main_address.address.region.name #=> String
|
1039
|
+
# resp.result_items[0].main_address.address.sub_region.code #=> String
|
1040
|
+
# resp.result_items[0].main_address.address.sub_region.name #=> String
|
1041
|
+
# resp.result_items[0].main_address.address.locality #=> String
|
1042
|
+
# resp.result_items[0].main_address.address.district #=> String
|
1043
|
+
# resp.result_items[0].main_address.address.sub_district #=> String
|
1044
|
+
# resp.result_items[0].main_address.address.postal_code #=> String
|
1045
|
+
# resp.result_items[0].main_address.address.block #=> String
|
1046
|
+
# resp.result_items[0].main_address.address.sub_block #=> String
|
1047
|
+
# resp.result_items[0].main_address.address.intersection #=> Array
|
1048
|
+
# resp.result_items[0].main_address.address.intersection[0] #=> String
|
1049
|
+
# resp.result_items[0].main_address.address.street #=> String
|
1050
|
+
# resp.result_items[0].main_address.address.street_components #=> Array
|
1051
|
+
# resp.result_items[0].main_address.address.street_components[0].base_name #=> String
|
1052
|
+
# resp.result_items[0].main_address.address.street_components[0].type #=> String
|
1053
|
+
# resp.result_items[0].main_address.address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
|
1054
|
+
# resp.result_items[0].main_address.address.street_components[0].type_separator #=> String
|
1055
|
+
# resp.result_items[0].main_address.address.street_components[0].prefix #=> String
|
1056
|
+
# resp.result_items[0].main_address.address.street_components[0].suffix #=> String
|
1057
|
+
# resp.result_items[0].main_address.address.street_components[0].direction #=> String
|
1058
|
+
# resp.result_items[0].main_address.address.street_components[0].language #=> String
|
1059
|
+
# resp.result_items[0].main_address.address.address_number #=> String
|
1060
|
+
# resp.result_items[0].main_address.address.building #=> String
|
1061
|
+
# resp.result_items[0].main_address.address.secondary_address_components #=> Array
|
1062
|
+
# resp.result_items[0].main_address.address.secondary_address_components[0].number #=> String
|
1063
|
+
# resp.result_items[0].main_address.position #=> Array
|
1064
|
+
# resp.result_items[0].main_address.position[0] #=> Float
|
1065
|
+
# resp.result_items[0].main_address.access_points #=> Array
|
1066
|
+
# resp.result_items[0].main_address.access_points[0].position #=> Array
|
1067
|
+
# resp.result_items[0].main_address.access_points[0].position[0] #=> Float
|
1068
|
+
# resp.result_items[0].secondary_addresses #=> Array
|
1069
|
+
# resp.result_items[0].secondary_addresses[0].place_id #=> String
|
1070
|
+
# resp.result_items[0].secondary_addresses[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
1071
|
+
# resp.result_items[0].secondary_addresses[0].title #=> String
|
1072
|
+
# resp.result_items[0].secondary_addresses[0].address.label #=> String
|
1073
|
+
# resp.result_items[0].secondary_addresses[0].address.country.code_2 #=> String
|
1074
|
+
# resp.result_items[0].secondary_addresses[0].address.country.code_3 #=> String
|
1075
|
+
# resp.result_items[0].secondary_addresses[0].address.country.name #=> String
|
1076
|
+
# resp.result_items[0].secondary_addresses[0].address.region.code #=> String
|
1077
|
+
# resp.result_items[0].secondary_addresses[0].address.region.name #=> String
|
1078
|
+
# resp.result_items[0].secondary_addresses[0].address.sub_region.code #=> String
|
1079
|
+
# resp.result_items[0].secondary_addresses[0].address.sub_region.name #=> String
|
1080
|
+
# resp.result_items[0].secondary_addresses[0].address.locality #=> String
|
1081
|
+
# resp.result_items[0].secondary_addresses[0].address.district #=> String
|
1082
|
+
# resp.result_items[0].secondary_addresses[0].address.sub_district #=> String
|
1083
|
+
# resp.result_items[0].secondary_addresses[0].address.postal_code #=> String
|
1084
|
+
# resp.result_items[0].secondary_addresses[0].address.block #=> String
|
1085
|
+
# resp.result_items[0].secondary_addresses[0].address.sub_block #=> String
|
1086
|
+
# resp.result_items[0].secondary_addresses[0].address.intersection #=> Array
|
1087
|
+
# resp.result_items[0].secondary_addresses[0].address.intersection[0] #=> String
|
1088
|
+
# resp.result_items[0].secondary_addresses[0].address.street #=> String
|
1089
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components #=> Array
|
1090
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components[0].base_name #=> String
|
1091
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components[0].type #=> String
|
1092
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
|
1093
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components[0].type_separator #=> String
|
1094
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components[0].prefix #=> String
|
1095
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components[0].suffix #=> String
|
1096
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components[0].direction #=> String
|
1097
|
+
# resp.result_items[0].secondary_addresses[0].address.street_components[0].language #=> String
|
1098
|
+
# resp.result_items[0].secondary_addresses[0].address.address_number #=> String
|
1099
|
+
# resp.result_items[0].secondary_addresses[0].address.building #=> String
|
1100
|
+
# resp.result_items[0].secondary_addresses[0].address.secondary_address_components #=> Array
|
1101
|
+
# resp.result_items[0].secondary_addresses[0].address.secondary_address_components[0].number #=> String
|
1102
|
+
# resp.result_items[0].secondary_addresses[0].position #=> Array
|
1103
|
+
# resp.result_items[0].secondary_addresses[0].position[0] #=> Float
|
1104
|
+
# resp.result_items[0].secondary_addresses[0].access_points #=> Array
|
1105
|
+
# resp.result_items[0].secondary_addresses[0].access_points[0].position #=> Array
|
1106
|
+
# resp.result_items[0].secondary_addresses[0].access_points[0].position[0] #=> Float
|
849
1107
|
#
|
850
1108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Geocode AWS API Documentation
|
851
1109
|
#
|
@@ -856,8 +1114,8 @@ module Aws::GeoPlaces
|
|
856
1114
|
req.send_request(options)
|
857
1115
|
end
|
858
1116
|
|
859
|
-
#
|
860
|
-
# operations.
|
1117
|
+
# `GetPlace` finds a place by its unique ID. A `PlaceId` is returned by
|
1118
|
+
# other place operations.
|
861
1119
|
#
|
862
1120
|
# @option params [required, String] :place_id
|
863
1121
|
# The `PlaceId` of the place you wish to receive the information for.
|
@@ -885,6 +1143,18 @@ module Aws::GeoPlaces
|
|
885
1143
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
886
1144
|
# left empty.
|
887
1145
|
#
|
1146
|
+
# <note markdown="1"> Storing the response of an GetPlace query is required to comply with
|
1147
|
+
# service terms, but charged at a higher cost per request. Please review
|
1148
|
+
# the [user agreement][1] and [service pricing structure][2] to
|
1149
|
+
# determine the correct setting for your use case.
|
1150
|
+
#
|
1151
|
+
# </note>
|
1152
|
+
#
|
1153
|
+
#
|
1154
|
+
#
|
1155
|
+
# [1]: https://aws.amazon.com/location/sla/
|
1156
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1157
|
+
#
|
888
1158
|
# @option params [String] :key
|
889
1159
|
# Optional: The API key to be used for authorization. Either an API key
|
890
1160
|
# or valid SigV4 signature must be provided when making a request.
|
@@ -910,12 +1180,14 @@ module Aws::GeoPlaces
|
|
910
1180
|
# * {Types::GetPlaceResponse#time_zone #time_zone} => Types::TimeZone
|
911
1181
|
# * {Types::GetPlaceResponse#political_view #political_view} => String
|
912
1182
|
# * {Types::GetPlaceResponse#phonemes #phonemes} => Types::PhonemeDetails
|
1183
|
+
# * {Types::GetPlaceResponse#main_address #main_address} => Types::RelatedPlace
|
1184
|
+
# * {Types::GetPlaceResponse#secondary_addresses #secondary_addresses} => Array<Types::RelatedPlace>
|
913
1185
|
#
|
914
1186
|
# @example Request syntax with placeholder values
|
915
1187
|
#
|
916
1188
|
# resp = client.get_place({
|
917
1189
|
# place_id: "GetPlaceRequestPlaceIdString", # required
|
918
|
-
# additional_features: ["TimeZone"], # accepts TimeZone, Phonemes, Access, Contact
|
1190
|
+
# additional_features: ["TimeZone"], # accepts TimeZone, Phonemes, Access, Contact, SecondaryAddresses
|
919
1191
|
# language: "LanguageTag",
|
920
1192
|
# political_view: "CountryCode",
|
921
1193
|
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
@@ -925,7 +1197,7 @@ module Aws::GeoPlaces
|
|
925
1197
|
# @example Response structure
|
926
1198
|
#
|
927
1199
|
# resp.place_id #=> String
|
928
|
-
# resp.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress"
|
1200
|
+
# resp.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
929
1201
|
# resp.title #=> String
|
930
1202
|
# resp.pricing_bucket #=> String
|
931
1203
|
# resp.address.label #=> String
|
@@ -956,6 +1228,8 @@ module Aws::GeoPlaces
|
|
956
1228
|
# resp.address.street_components[0].language #=> String
|
957
1229
|
# resp.address.address_number #=> String
|
958
1230
|
# resp.address.building #=> String
|
1231
|
+
# resp.address.secondary_address_components #=> Array
|
1232
|
+
# resp.address.secondary_address_components[0].number #=> String
|
959
1233
|
# resp.address_number_corrected #=> Boolean
|
960
1234
|
# resp.postal_code_details #=> Array
|
961
1235
|
# resp.postal_code_details[0].postal_code #=> String
|
@@ -1078,6 +1352,83 @@ module Aws::GeoPlaces
|
|
1078
1352
|
# resp.phonemes.address.street[0].value #=> String
|
1079
1353
|
# resp.phonemes.address.street[0].language #=> String
|
1080
1354
|
# resp.phonemes.address.street[0].preferred #=> Boolean
|
1355
|
+
# resp.main_address.place_id #=> String
|
1356
|
+
# resp.main_address.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
1357
|
+
# resp.main_address.title #=> String
|
1358
|
+
# resp.main_address.address.label #=> String
|
1359
|
+
# resp.main_address.address.country.code_2 #=> String
|
1360
|
+
# resp.main_address.address.country.code_3 #=> String
|
1361
|
+
# resp.main_address.address.country.name #=> String
|
1362
|
+
# resp.main_address.address.region.code #=> String
|
1363
|
+
# resp.main_address.address.region.name #=> String
|
1364
|
+
# resp.main_address.address.sub_region.code #=> String
|
1365
|
+
# resp.main_address.address.sub_region.name #=> String
|
1366
|
+
# resp.main_address.address.locality #=> String
|
1367
|
+
# resp.main_address.address.district #=> String
|
1368
|
+
# resp.main_address.address.sub_district #=> String
|
1369
|
+
# resp.main_address.address.postal_code #=> String
|
1370
|
+
# resp.main_address.address.block #=> String
|
1371
|
+
# resp.main_address.address.sub_block #=> String
|
1372
|
+
# resp.main_address.address.intersection #=> Array
|
1373
|
+
# resp.main_address.address.intersection[0] #=> String
|
1374
|
+
# resp.main_address.address.street #=> String
|
1375
|
+
# resp.main_address.address.street_components #=> Array
|
1376
|
+
# resp.main_address.address.street_components[0].base_name #=> String
|
1377
|
+
# resp.main_address.address.street_components[0].type #=> String
|
1378
|
+
# resp.main_address.address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
|
1379
|
+
# resp.main_address.address.street_components[0].type_separator #=> String
|
1380
|
+
# resp.main_address.address.street_components[0].prefix #=> String
|
1381
|
+
# resp.main_address.address.street_components[0].suffix #=> String
|
1382
|
+
# resp.main_address.address.street_components[0].direction #=> String
|
1383
|
+
# resp.main_address.address.street_components[0].language #=> String
|
1384
|
+
# resp.main_address.address.address_number #=> String
|
1385
|
+
# resp.main_address.address.building #=> String
|
1386
|
+
# resp.main_address.address.secondary_address_components #=> Array
|
1387
|
+
# resp.main_address.address.secondary_address_components[0].number #=> String
|
1388
|
+
# resp.main_address.position #=> Array
|
1389
|
+
# resp.main_address.position[0] #=> Float
|
1390
|
+
# resp.main_address.access_points #=> Array
|
1391
|
+
# resp.main_address.access_points[0].position #=> Array
|
1392
|
+
# resp.main_address.access_points[0].position[0] #=> Float
|
1393
|
+
# resp.secondary_addresses #=> Array
|
1394
|
+
# resp.secondary_addresses[0].place_id #=> String
|
1395
|
+
# resp.secondary_addresses[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
1396
|
+
# resp.secondary_addresses[0].title #=> String
|
1397
|
+
# resp.secondary_addresses[0].address.label #=> String
|
1398
|
+
# resp.secondary_addresses[0].address.country.code_2 #=> String
|
1399
|
+
# resp.secondary_addresses[0].address.country.code_3 #=> String
|
1400
|
+
# resp.secondary_addresses[0].address.country.name #=> String
|
1401
|
+
# resp.secondary_addresses[0].address.region.code #=> String
|
1402
|
+
# resp.secondary_addresses[0].address.region.name #=> String
|
1403
|
+
# resp.secondary_addresses[0].address.sub_region.code #=> String
|
1404
|
+
# resp.secondary_addresses[0].address.sub_region.name #=> String
|
1405
|
+
# resp.secondary_addresses[0].address.locality #=> String
|
1406
|
+
# resp.secondary_addresses[0].address.district #=> String
|
1407
|
+
# resp.secondary_addresses[0].address.sub_district #=> String
|
1408
|
+
# resp.secondary_addresses[0].address.postal_code #=> String
|
1409
|
+
# resp.secondary_addresses[0].address.block #=> String
|
1410
|
+
# resp.secondary_addresses[0].address.sub_block #=> String
|
1411
|
+
# resp.secondary_addresses[0].address.intersection #=> Array
|
1412
|
+
# resp.secondary_addresses[0].address.intersection[0] #=> String
|
1413
|
+
# resp.secondary_addresses[0].address.street #=> String
|
1414
|
+
# resp.secondary_addresses[0].address.street_components #=> Array
|
1415
|
+
# resp.secondary_addresses[0].address.street_components[0].base_name #=> String
|
1416
|
+
# resp.secondary_addresses[0].address.street_components[0].type #=> String
|
1417
|
+
# resp.secondary_addresses[0].address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
|
1418
|
+
# resp.secondary_addresses[0].address.street_components[0].type_separator #=> String
|
1419
|
+
# resp.secondary_addresses[0].address.street_components[0].prefix #=> String
|
1420
|
+
# resp.secondary_addresses[0].address.street_components[0].suffix #=> String
|
1421
|
+
# resp.secondary_addresses[0].address.street_components[0].direction #=> String
|
1422
|
+
# resp.secondary_addresses[0].address.street_components[0].language #=> String
|
1423
|
+
# resp.secondary_addresses[0].address.address_number #=> String
|
1424
|
+
# resp.secondary_addresses[0].address.building #=> String
|
1425
|
+
# resp.secondary_addresses[0].address.secondary_address_components #=> Array
|
1426
|
+
# resp.secondary_addresses[0].address.secondary_address_components[0].number #=> String
|
1427
|
+
# resp.secondary_addresses[0].position #=> Array
|
1428
|
+
# resp.secondary_addresses[0].position[0] #=> Float
|
1429
|
+
# resp.secondary_addresses[0].access_points #=> Array
|
1430
|
+
# resp.secondary_addresses[0].access_points[0].position #=> Array
|
1431
|
+
# resp.secondary_addresses[0].access_points[0].position[0] #=> Float
|
1081
1432
|
#
|
1082
1433
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GetPlace AWS API Documentation
|
1083
1434
|
#
|
@@ -1088,12 +1439,17 @@ module Aws::GeoPlaces
|
|
1088
1439
|
req.send_request(options)
|
1089
1440
|
end
|
1090
1441
|
|
1091
|
-
#
|
1092
|
-
# place
|
1442
|
+
# `ReverseGeocode` converts geographic coordinates into a human-readable
|
1443
|
+
# address or place. You can obtain address component, and other related
|
1444
|
+
# information such as place type, category, street information. The
|
1445
|
+
# Reverse Geocode API supports filtering to on place type so that you
|
1446
|
+
# can refine result based on your need. Also, The Reverse Geocode API
|
1447
|
+
# can also provide additional features such as time zone information and
|
1448
|
+
# the inclusion of political views.
|
1093
1449
|
#
|
1094
1450
|
# @option params [required, Array<Float>] :query_position
|
1095
1451
|
# The position, in `[lng, lat]` for which you are querying nearby
|
1096
|
-
#
|
1452
|
+
# results for. Results closer to the position will be ranked higher then
|
1097
1453
|
# results further away from the position
|
1098
1454
|
#
|
1099
1455
|
# @option params [Integer] :query_radius
|
@@ -1105,7 +1461,7 @@ module Aws::GeoPlaces
|
|
1105
1461
|
#
|
1106
1462
|
# @option params [Types::ReverseGeocodeFilter] :filter
|
1107
1463
|
# A structure which contains a set of inclusion/exclusion properties
|
1108
|
-
# that results must
|
1464
|
+
# that results must possess in order to be returned as a result.
|
1109
1465
|
#
|
1110
1466
|
# @option params [Array<String>] :additional_features
|
1111
1467
|
# A list of optional additional parameters, such as time zone that can
|
@@ -1130,6 +1486,18 @@ module Aws::GeoPlaces
|
|
1130
1486
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1131
1487
|
# left empty.
|
1132
1488
|
#
|
1489
|
+
# <note markdown="1"> Storing the response of an ReverseGeocode query is required to comply
|
1490
|
+
# with service terms, but charged at a higher cost per request. Please
|
1491
|
+
# review the [user agreement][1] and [service pricing structure][2] to
|
1492
|
+
# determine the correct setting for your use case.
|
1493
|
+
#
|
1494
|
+
# </note>
|
1495
|
+
#
|
1496
|
+
#
|
1497
|
+
#
|
1498
|
+
# [1]: https://aws.amazon.com/location/sla/
|
1499
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1500
|
+
#
|
1133
1501
|
# @option params [String] :key
|
1134
1502
|
# Optional: The API key to be used for authorization. Either an API key
|
1135
1503
|
# or valid SigV4 signature must be provided when making a request.
|
@@ -1148,7 +1516,7 @@ module Aws::GeoPlaces
|
|
1148
1516
|
# filter: {
|
1149
1517
|
# include_place_types: ["Locality"], # accepts Locality, Intersection, Street, PointAddress, InterpolatedAddress
|
1150
1518
|
# },
|
1151
|
-
# additional_features: ["TimeZone"], # accepts TimeZone, Access
|
1519
|
+
# additional_features: ["TimeZone"], # accepts TimeZone, Access, Intersections
|
1152
1520
|
# language: "LanguageTag",
|
1153
1521
|
# political_view: "CountryCode",
|
1154
1522
|
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
@@ -1160,7 +1528,7 @@ module Aws::GeoPlaces
|
|
1160
1528
|
# resp.pricing_bucket #=> String
|
1161
1529
|
# resp.result_items #=> Array
|
1162
1530
|
# resp.result_items[0].place_id #=> String
|
1163
|
-
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress"
|
1531
|
+
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
1164
1532
|
# resp.result_items[0].title #=> String
|
1165
1533
|
# resp.result_items[0].address.label #=> String
|
1166
1534
|
# resp.result_items[0].address.country.code_2 #=> String
|
@@ -1190,6 +1558,8 @@ module Aws::GeoPlaces
|
|
1190
1558
|
# resp.result_items[0].address.street_components[0].language #=> String
|
1191
1559
|
# resp.result_items[0].address.address_number #=> String
|
1192
1560
|
# resp.result_items[0].address.building #=> String
|
1561
|
+
# resp.result_items[0].address.secondary_address_components #=> Array
|
1562
|
+
# resp.result_items[0].address.secondary_address_components[0].number #=> String
|
1193
1563
|
# resp.result_items[0].address_number_corrected #=> Boolean
|
1194
1564
|
# resp.result_items[0].postal_code_details #=> Array
|
1195
1565
|
# resp.result_items[0].postal_code_details[0].postal_code #=> String
|
@@ -1218,6 +1588,48 @@ module Aws::GeoPlaces
|
|
1218
1588
|
# resp.result_items[0].time_zone.offset #=> String
|
1219
1589
|
# resp.result_items[0].time_zone.offset_seconds #=> Integer
|
1220
1590
|
# resp.result_items[0].political_view #=> String
|
1591
|
+
# resp.result_items[0].intersections #=> Array
|
1592
|
+
# resp.result_items[0].intersections[0].place_id #=> String
|
1593
|
+
# resp.result_items[0].intersections[0].title #=> String
|
1594
|
+
# resp.result_items[0].intersections[0].address.label #=> String
|
1595
|
+
# resp.result_items[0].intersections[0].address.country.code_2 #=> String
|
1596
|
+
# resp.result_items[0].intersections[0].address.country.code_3 #=> String
|
1597
|
+
# resp.result_items[0].intersections[0].address.country.name #=> String
|
1598
|
+
# resp.result_items[0].intersections[0].address.region.code #=> String
|
1599
|
+
# resp.result_items[0].intersections[0].address.region.name #=> String
|
1600
|
+
# resp.result_items[0].intersections[0].address.sub_region.code #=> String
|
1601
|
+
# resp.result_items[0].intersections[0].address.sub_region.name #=> String
|
1602
|
+
# resp.result_items[0].intersections[0].address.locality #=> String
|
1603
|
+
# resp.result_items[0].intersections[0].address.district #=> String
|
1604
|
+
# resp.result_items[0].intersections[0].address.sub_district #=> String
|
1605
|
+
# resp.result_items[0].intersections[0].address.postal_code #=> String
|
1606
|
+
# resp.result_items[0].intersections[0].address.block #=> String
|
1607
|
+
# resp.result_items[0].intersections[0].address.sub_block #=> String
|
1608
|
+
# resp.result_items[0].intersections[0].address.intersection #=> Array
|
1609
|
+
# resp.result_items[0].intersections[0].address.intersection[0] #=> String
|
1610
|
+
# resp.result_items[0].intersections[0].address.street #=> String
|
1611
|
+
# resp.result_items[0].intersections[0].address.street_components #=> Array
|
1612
|
+
# resp.result_items[0].intersections[0].address.street_components[0].base_name #=> String
|
1613
|
+
# resp.result_items[0].intersections[0].address.street_components[0].type #=> String
|
1614
|
+
# resp.result_items[0].intersections[0].address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
|
1615
|
+
# resp.result_items[0].intersections[0].address.street_components[0].type_separator #=> String
|
1616
|
+
# resp.result_items[0].intersections[0].address.street_components[0].prefix #=> String
|
1617
|
+
# resp.result_items[0].intersections[0].address.street_components[0].suffix #=> String
|
1618
|
+
# resp.result_items[0].intersections[0].address.street_components[0].direction #=> String
|
1619
|
+
# resp.result_items[0].intersections[0].address.street_components[0].language #=> String
|
1620
|
+
# resp.result_items[0].intersections[0].address.address_number #=> String
|
1621
|
+
# resp.result_items[0].intersections[0].address.building #=> String
|
1622
|
+
# resp.result_items[0].intersections[0].address.secondary_address_components #=> Array
|
1623
|
+
# resp.result_items[0].intersections[0].address.secondary_address_components[0].number #=> String
|
1624
|
+
# resp.result_items[0].intersections[0].position #=> Array
|
1625
|
+
# resp.result_items[0].intersections[0].position[0] #=> Float
|
1626
|
+
# resp.result_items[0].intersections[0].distance #=> Integer
|
1627
|
+
# resp.result_items[0].intersections[0].route_distance #=> Integer
|
1628
|
+
# resp.result_items[0].intersections[0].map_view #=> Array
|
1629
|
+
# resp.result_items[0].intersections[0].map_view[0] #=> Float
|
1630
|
+
# resp.result_items[0].intersections[0].access_points #=> Array
|
1631
|
+
# resp.result_items[0].intersections[0].access_points[0].position #=> Array
|
1632
|
+
# resp.result_items[0].intersections[0].access_points[0].position[0] #=> Float
|
1221
1633
|
#
|
1222
1634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ReverseGeocode AWS API Documentation
|
1223
1635
|
#
|
@@ -1228,23 +1640,32 @@ module Aws::GeoPlaces
|
|
1228
1640
|
req.send_request(options)
|
1229
1641
|
end
|
1230
1642
|
|
1231
|
-
#
|
1643
|
+
# `SearchNearby` queries for points of interest within a radius from a
|
1644
|
+
# central coordinates, returning place results with optional filters
|
1645
|
+
# such as categories, business chains, food types and more. The API
|
1646
|
+
# returns details such as a place name, address, phone, category, food
|
1647
|
+
# type, contact, opening hours. Also, the API can return phonemes, time
|
1648
|
+
# zones and more based on requested parameters.
|
1232
1649
|
#
|
1233
1650
|
# @option params [required, Array<Float>] :query_position
|
1234
1651
|
# The position, in `[lng, lat]` for which you are querying nearby
|
1235
|
-
#
|
1652
|
+
# results for. Results closer to the position will be ranked higher then
|
1236
1653
|
# results further away from the position
|
1237
1654
|
#
|
1238
1655
|
# @option params [Integer] :query_radius
|
1239
1656
|
# The maximum distance in meters from the QueryPosition from which a
|
1240
1657
|
# result will be returned.
|
1241
1658
|
#
|
1659
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
1660
|
+
#
|
1661
|
+
# </note>
|
1662
|
+
#
|
1242
1663
|
# @option params [Integer] :max_results
|
1243
1664
|
# An optional limit for the number of results returned in a single call.
|
1244
1665
|
#
|
1245
1666
|
# @option params [Types::SearchNearbyFilter] :filter
|
1246
1667
|
# A structure which contains a set of inclusion/exclusion properties
|
1247
|
-
# that results must
|
1668
|
+
# that results must possess in order to be returned as a result.
|
1248
1669
|
#
|
1249
1670
|
# @option params [Array<String>] :additional_features
|
1250
1671
|
# A list of optional additional parameters, such as time zone, that can
|
@@ -1269,6 +1690,18 @@ module Aws::GeoPlaces
|
|
1269
1690
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1270
1691
|
# left empty.
|
1271
1692
|
#
|
1693
|
+
# <note markdown="1"> Storing the response of an SearchNearby query is required to comply
|
1694
|
+
# with service terms, but charged at a higher cost per request. Please
|
1695
|
+
# review the [user agreement][1] and [service pricing structure][2] to
|
1696
|
+
# determine the correct setting for your use case.
|
1697
|
+
#
|
1698
|
+
# </note>
|
1699
|
+
#
|
1700
|
+
#
|
1701
|
+
#
|
1702
|
+
# [1]: https://aws.amazon.com/location/sla/
|
1703
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1704
|
+
#
|
1272
1705
|
# @option params [String] :next_token
|
1273
1706
|
# If `nextToken` is returned, there are more results available. The
|
1274
1707
|
# value of `nextToken` is a unique pagination token for each page.
|
@@ -1312,7 +1745,7 @@ module Aws::GeoPlaces
|
|
1312
1745
|
# resp.pricing_bucket #=> String
|
1313
1746
|
# resp.result_items #=> Array
|
1314
1747
|
# resp.result_items[0].place_id #=> String
|
1315
|
-
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress"
|
1748
|
+
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
1316
1749
|
# resp.result_items[0].title #=> String
|
1317
1750
|
# resp.result_items[0].address.label #=> String
|
1318
1751
|
# resp.result_items[0].address.country.code_2 #=> String
|
@@ -1342,6 +1775,8 @@ module Aws::GeoPlaces
|
|
1342
1775
|
# resp.result_items[0].address.street_components[0].language #=> String
|
1343
1776
|
# resp.result_items[0].address.address_number #=> String
|
1344
1777
|
# resp.result_items[0].address.building #=> String
|
1778
|
+
# resp.result_items[0].address.secondary_address_components #=> Array
|
1779
|
+
# resp.result_items[0].address.secondary_address_components[0].number #=> String
|
1345
1780
|
# resp.result_items[0].address_number_corrected #=> Boolean
|
1346
1781
|
# resp.result_items[0].position #=> Array
|
1347
1782
|
# resp.result_items[0].position[0] #=> Float
|
@@ -1470,16 +1905,26 @@ module Aws::GeoPlaces
|
|
1470
1905
|
req.send_request(options)
|
1471
1906
|
end
|
1472
1907
|
|
1473
|
-
#
|
1474
|
-
#
|
1475
|
-
#
|
1908
|
+
# `SearchText` searches for geocode and place information. You can then
|
1909
|
+
# complete a follow-up query suggested from the `Suggest` API via a
|
1910
|
+
# query id.
|
1476
1911
|
#
|
1477
1912
|
# @option params [String] :query_text
|
1478
1913
|
# The free-form text query to match addresses against. This is usually a
|
1479
1914
|
# partially typed address from an end user in an address box or form.
|
1480
1915
|
#
|
1916
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
1917
|
+
#
|
1918
|
+
# </note>
|
1919
|
+
#
|
1481
1920
|
# @option params [String] :query_id
|
1482
|
-
# The query Id.
|
1921
|
+
# The query Id returned by the suggest API. If passed in the request,
|
1922
|
+
# the SearchText API will preform a SearchText query with the improved
|
1923
|
+
# query terms for the original query made to the suggest API.
|
1924
|
+
#
|
1925
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
1926
|
+
#
|
1927
|
+
# </note>
|
1483
1928
|
#
|
1484
1929
|
# @option params [Integer] :max_results
|
1485
1930
|
# An optional limit for the number of results returned in a single call.
|
@@ -1497,7 +1942,7 @@ module Aws::GeoPlaces
|
|
1497
1942
|
#
|
1498
1943
|
# @option params [Types::SearchTextFilter] :filter
|
1499
1944
|
# A structure which contains a set of inclusion/exclusion properties
|
1500
|
-
# that results must
|
1945
|
+
# that results must possess in order to be returned as a result.
|
1501
1946
|
#
|
1502
1947
|
# @option params [Array<String>] :additional_features
|
1503
1948
|
# A list of optional additional parameters, such as time zone, that can
|
@@ -1522,6 +1967,18 @@ module Aws::GeoPlaces
|
|
1522
1967
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1523
1968
|
# left empty.
|
1524
1969
|
#
|
1970
|
+
# <note markdown="1"> Storing the response of an SearchText query is required to comply with
|
1971
|
+
# service terms, but charged at a higher cost per request. Please review
|
1972
|
+
# the [user agreement][1] and [service pricing structure][2] to
|
1973
|
+
# determine the correct setting for your use case.
|
1974
|
+
#
|
1975
|
+
# </note>
|
1976
|
+
#
|
1977
|
+
#
|
1978
|
+
#
|
1979
|
+
# [1]: https://aws.amazon.com/location/sla/
|
1980
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1981
|
+
#
|
1525
1982
|
# @option params [String] :next_token
|
1526
1983
|
# If `nextToken` is returned, there are more results available. The
|
1527
1984
|
# value of `nextToken` is a unique pagination token for each page.
|
@@ -1564,7 +2021,7 @@ module Aws::GeoPlaces
|
|
1564
2021
|
# resp.pricing_bucket #=> String
|
1565
2022
|
# resp.result_items #=> Array
|
1566
2023
|
# resp.result_items[0].place_id #=> String
|
1567
|
-
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress"
|
2024
|
+
# resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
1568
2025
|
# resp.result_items[0].title #=> String
|
1569
2026
|
# resp.result_items[0].address.label #=> String
|
1570
2027
|
# resp.result_items[0].address.country.code_2 #=> String
|
@@ -1594,6 +2051,8 @@ module Aws::GeoPlaces
|
|
1594
2051
|
# resp.result_items[0].address.street_components[0].language #=> String
|
1595
2052
|
# resp.result_items[0].address.address_number #=> String
|
1596
2053
|
# resp.result_items[0].address.building #=> String
|
2054
|
+
# resp.result_items[0].address.secondary_address_components #=> Array
|
2055
|
+
# resp.result_items[0].address.secondary_address_components[0].number #=> String
|
1597
2056
|
# resp.result_items[0].address_number_corrected #=> Boolean
|
1598
2057
|
# resp.result_items[0].position #=> Array
|
1599
2058
|
# resp.result_items[0].position[0] #=> Float
|
@@ -1722,14 +2181,26 @@ module Aws::GeoPlaces
|
|
1722
2181
|
req.send_request(options)
|
1723
2182
|
end
|
1724
2183
|
|
1725
|
-
#
|
1726
|
-
#
|
1727
|
-
#
|
2184
|
+
# `Suggest` provides intelligent predictions or recommendations based on
|
2185
|
+
# the user's input or context, such as relevant places, points of
|
2186
|
+
# interest, query terms or search category. It is designed to help users
|
2187
|
+
# find places or point of interests candidates or identify a follow on
|
2188
|
+
# query based on incomplete or misspelled queries. It returns a list of
|
2189
|
+
# possible matches or refinements that can be used to formulate a more
|
2190
|
+
# accurate query. Users can select the most appropriate suggestion and
|
2191
|
+
# use it for further searching. The API provides options for filtering
|
2192
|
+
# results by location and other attributes, and allows for additional
|
2193
|
+
# features like phonemes and timezones. The response includes refined
|
2194
|
+
# query terms and detailed place information.
|
1728
2195
|
#
|
1729
2196
|
# @option params [required, String] :query_text
|
1730
2197
|
# The free-form text query to match addresses against. This is usually a
|
1731
2198
|
# partially typed address from an end user in an address box or form.
|
1732
2199
|
#
|
2200
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
2201
|
+
#
|
2202
|
+
# </note>
|
2203
|
+
#
|
1733
2204
|
# @option params [Integer] :max_results
|
1734
2205
|
# An optional limit for the number of results returned in a single call.
|
1735
2206
|
#
|
@@ -1750,7 +2221,7 @@ module Aws::GeoPlaces
|
|
1750
2221
|
#
|
1751
2222
|
# @option params [Types::SuggestFilter] :filter
|
1752
2223
|
# A structure which contains a set of inclusion/exclusion properties
|
1753
|
-
# that results must
|
2224
|
+
# that results must possess in order to be returned as a result.
|
1754
2225
|
#
|
1755
2226
|
# @option params [Array<String>] :additional_features
|
1756
2227
|
# A list of optional additional parameters, such as time zone, that can
|
@@ -1814,7 +2285,7 @@ module Aws::GeoPlaces
|
|
1814
2285
|
# resp.result_items[0].title #=> String
|
1815
2286
|
# resp.result_items[0].suggest_result_item_type #=> String, one of "Place", "Query"
|
1816
2287
|
# resp.result_items[0].place.place_id #=> String
|
1817
|
-
# resp.result_items[0].place.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress"
|
2288
|
+
# resp.result_items[0].place.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
|
1818
2289
|
# resp.result_items[0].place.address.label #=> String
|
1819
2290
|
# resp.result_items[0].place.address.country.code_2 #=> String
|
1820
2291
|
# resp.result_items[0].place.address.country.code_3 #=> String
|
@@ -1843,6 +2314,8 @@ module Aws::GeoPlaces
|
|
1843
2314
|
# resp.result_items[0].place.address.street_components[0].language #=> String
|
1844
2315
|
# resp.result_items[0].place.address.address_number #=> String
|
1845
2316
|
# resp.result_items[0].place.address.building #=> String
|
2317
|
+
# resp.result_items[0].place.address.secondary_address_components #=> Array
|
2318
|
+
# resp.result_items[0].place.address.secondary_address_components[0].number #=> String
|
1846
2319
|
# resp.result_items[0].place.position #=> Array
|
1847
2320
|
# resp.result_items[0].place.position[0] #=> Float
|
1848
2321
|
# resp.result_items[0].place.distance #=> Integer
|
@@ -1957,7 +2430,7 @@ module Aws::GeoPlaces
|
|
1957
2430
|
tracer: tracer
|
1958
2431
|
)
|
1959
2432
|
context[:gem_name] = 'aws-sdk-geoplaces'
|
1960
|
-
context[:gem_version] = '1.
|
2433
|
+
context[:gem_version] = '1.8.0'
|
1961
2434
|
Seahorse::Client::Request.new(handlers, context)
|
1962
2435
|
end
|
1963
2436
|
|