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
@@ -55,7 +55,7 @@ module Aws::GeoPlaces
|
|
55
55
|
class AccessRestriction < Struct.new(
|
56
56
|
:restricted,
|
57
57
|
:categories)
|
58
|
-
SENSITIVE = []
|
58
|
+
SENSITIVE = [:restricted]
|
59
59
|
include Aws::Structure
|
60
60
|
end
|
61
61
|
|
@@ -82,7 +82,7 @@ module Aws::GeoPlaces
|
|
82
82
|
# @return [Types::SubRegion]
|
83
83
|
#
|
84
84
|
# @!attribute [rw] locality
|
85
|
-
# The
|
85
|
+
# The city or locality of the address.
|
86
86
|
#
|
87
87
|
# Example: `Vancouver`.
|
88
88
|
# @return [String]
|
@@ -100,7 +100,7 @@ module Aws::GeoPlaces
|
|
100
100
|
# @!attribute [rw] postal_code
|
101
101
|
# An alphanumeric string included in a postal address to facilitate
|
102
102
|
# mail sorting, such as post code, postcode, or ZIP code, for which
|
103
|
-
# the result should
|
103
|
+
# the result should possess.
|
104
104
|
# @return [String]
|
105
105
|
#
|
106
106
|
# @!attribute [rw] block
|
@@ -139,6 +139,12 @@ module Aws::GeoPlaces
|
|
139
139
|
# The name of the building at the address.
|
140
140
|
# @return [String]
|
141
141
|
#
|
142
|
+
# @!attribute [rw] secondary_address_components
|
143
|
+
# Components that correspond to secondary identifiers on an Address.
|
144
|
+
# Secondary address components include information such as Suite or
|
145
|
+
# Unit Number, Building, or Floor.
|
146
|
+
# @return [Array<Types::SecondaryAddressComponent>]
|
147
|
+
#
|
142
148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Address AWS API Documentation
|
143
149
|
#
|
144
150
|
class Address < Struct.new(
|
@@ -156,8 +162,9 @@ module Aws::GeoPlaces
|
|
156
162
|
:street,
|
157
163
|
:street_components,
|
158
164
|
:address_number,
|
159
|
-
:building
|
160
|
-
|
165
|
+
:building,
|
166
|
+
:secondary_address_components)
|
167
|
+
SENSITIVE = [:label, :locality, :district, :sub_district, :postal_code, :block, :sub_block, :street, :address_number, :building]
|
161
168
|
include Aws::Structure
|
162
169
|
end
|
163
170
|
|
@@ -198,7 +205,7 @@ module Aws::GeoPlaces
|
|
198
205
|
# @!attribute [rw] postal_code
|
199
206
|
# An alphanumeric string included in a postal address to facilitate
|
200
207
|
# mail sorting, such as post code, postcode, or ZIP code, for which
|
201
|
-
# the result should
|
208
|
+
# the result should possess.
|
202
209
|
# @return [Float]
|
203
210
|
#
|
204
211
|
# @!attribute [rw] block
|
@@ -227,6 +234,10 @@ module Aws::GeoPlaces
|
|
227
234
|
# The name of the building at the address.
|
228
235
|
# @return [Float]
|
229
236
|
#
|
237
|
+
# @!attribute [rw] secondary_address_components
|
238
|
+
# Match scores for the secondary address components in the result.
|
239
|
+
# @return [Array<Types::SecondaryAddressComponentMatchScore>]
|
240
|
+
#
|
230
241
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AddressComponentMatchScores AWS API Documentation
|
231
242
|
#
|
232
243
|
class AddressComponentMatchScores < Struct.new(
|
@@ -241,7 +252,8 @@ module Aws::GeoPlaces
|
|
241
252
|
:sub_block,
|
242
253
|
:intersection,
|
243
254
|
:address_number,
|
244
|
-
:building
|
255
|
+
:building,
|
256
|
+
:secondary_address_components)
|
245
257
|
SENSITIVE = []
|
246
258
|
include Aws::Structure
|
247
259
|
end
|
@@ -354,11 +366,15 @@ module Aws::GeoPlaces
|
|
354
366
|
# @return [Array<Types::Highlight>]
|
355
367
|
#
|
356
368
|
# @!attribute [rw] block
|
357
|
-
# Name of the block.
|
369
|
+
# Name of the block.
|
370
|
+
#
|
371
|
+
# Example: `Sunny Mansion 203 block: 2 Chome`
|
358
372
|
# @return [Array<Types::Highlight>]
|
359
373
|
#
|
360
374
|
# @!attribute [rw] sub_block
|
361
|
-
# Name of sub-block.
|
375
|
+
# Name of sub-block.
|
376
|
+
#
|
377
|
+
# Example: `Sunny Mansion 203 sub-block: 4`
|
362
378
|
# @return [Array<Types::Highlight>]
|
363
379
|
#
|
364
380
|
# @!attribute [rw] intersection
|
@@ -369,7 +385,7 @@ module Aws::GeoPlaces
|
|
369
385
|
# @!attribute [rw] postal_code
|
370
386
|
# An alphanumeric string included in a postal address to facilitate
|
371
387
|
# mail sorting, such as post code, postcode, or ZIP code for which the
|
372
|
-
# result should
|
388
|
+
# result should possess.
|
373
389
|
# @return [Array<Types::Highlight>]
|
374
390
|
#
|
375
391
|
# @!attribute [rw] address_number
|
@@ -402,7 +418,7 @@ module Aws::GeoPlaces
|
|
402
418
|
end
|
403
419
|
|
404
420
|
# Autocomplete structure which contains a set of inclusion/exclusion
|
405
|
-
# properties that results must
|
421
|
+
# properties that results must possess in order to be returned as a
|
406
422
|
# result.
|
407
423
|
#
|
408
424
|
# @!attribute [rw] bounding_box
|
@@ -433,7 +449,7 @@ module Aws::GeoPlaces
|
|
433
449
|
:circle,
|
434
450
|
:include_countries,
|
435
451
|
:include_place_types)
|
436
|
-
SENSITIVE = [:bounding_box, :circle]
|
452
|
+
SENSITIVE = [:bounding_box, :circle, :include_countries]
|
437
453
|
include Aws::Structure
|
438
454
|
end
|
439
455
|
|
@@ -463,6 +479,10 @@ module Aws::GeoPlaces
|
|
463
479
|
# The free-form text query to match addresses against. This is usually
|
464
480
|
# a partially typed address from an end user in an address box or
|
465
481
|
# form.
|
482
|
+
#
|
483
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
484
|
+
#
|
485
|
+
# </note>
|
466
486
|
# @return [String]
|
467
487
|
#
|
468
488
|
# @!attribute [rw] max_results
|
@@ -484,7 +504,7 @@ module Aws::GeoPlaces
|
|
484
504
|
#
|
485
505
|
# @!attribute [rw] filter
|
486
506
|
# A structure which contains a set of inclusion/exclusion properties
|
487
|
-
# that results must
|
507
|
+
# that results must possess in order to be returned as a result.
|
488
508
|
# @return [Types::AutocompleteFilter]
|
489
509
|
#
|
490
510
|
# @!attribute [rw] postal_code_mode
|
@@ -492,7 +512,8 @@ module Aws::GeoPlaces
|
|
492
512
|
# If a postal code spans multiple localities and this value is empty,
|
493
513
|
# partial district or locality information may be returned under a
|
494
514
|
# single postal code result entry. If it's populated with the value
|
495
|
-
# `
|
515
|
+
# `EnumerateSpannedLocalities`, all cities in that postal code are
|
516
|
+
# returned.
|
496
517
|
# @return [String]
|
497
518
|
#
|
498
519
|
# @!attribute [rw] additional_features
|
@@ -516,6 +537,39 @@ module Aws::GeoPlaces
|
|
516
537
|
# country. The political view applies to the results of the request to
|
517
538
|
# represent unresolved territorial claims through the point of view of
|
518
539
|
# the specified country.
|
540
|
+
#
|
541
|
+
# The following political views are currently supported:
|
542
|
+
#
|
543
|
+
# * `ARG`: Argentina's view on the Southern Patagonian Ice Field and
|
544
|
+
# Tierra Del Fuego, including the Falkland Islands, South Georgia,
|
545
|
+
# and South Sandwich Islands
|
546
|
+
#
|
547
|
+
# * `EGY`: Egypt's view on Bir Tawil
|
548
|
+
#
|
549
|
+
# * `IND`: India's view on Gilgit-Baltistan
|
550
|
+
#
|
551
|
+
# * `KEN`: Kenya's view on the Ilemi Triangle
|
552
|
+
#
|
553
|
+
# * `MAR`: Morocco's view on Western Sahara
|
554
|
+
#
|
555
|
+
# * `RUS`: Russia's view on Crimea
|
556
|
+
#
|
557
|
+
# * `SDN`: Sudan's view on the Halaib Triangle
|
558
|
+
#
|
559
|
+
# * `SRB`: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
|
560
|
+
#
|
561
|
+
# * `SUR`: Suriname's view on the Courantyne Headwaters and Lawa
|
562
|
+
# Headwaters
|
563
|
+
#
|
564
|
+
# * `SYR`: Syria's view on the Golan Heights
|
565
|
+
#
|
566
|
+
# * `TUR`: Turkey's view on Cyprus and Northern Cyprus
|
567
|
+
#
|
568
|
+
# * `TZA`: Tanzania's view on Lake Malawi
|
569
|
+
#
|
570
|
+
# * `URY`: Uruguay's view on Rincon de Artigas
|
571
|
+
#
|
572
|
+
# * `VNM`: Vietnam's view on the Paracel Islands and Spratly Islands
|
519
573
|
# @return [String]
|
520
574
|
#
|
521
575
|
# @!attribute [rw] intended_use
|
@@ -541,14 +595,14 @@ module Aws::GeoPlaces
|
|
541
595
|
:political_view,
|
542
596
|
:intended_use,
|
543
597
|
:key)
|
544
|
-
SENSITIVE = [:query_text, :bias_position, :key]
|
598
|
+
SENSITIVE = [:query_text, :bias_position, :political_view, :key]
|
545
599
|
include Aws::Structure
|
546
600
|
end
|
547
601
|
|
548
602
|
# @!attribute [rw] pricing_bucket
|
549
603
|
# The pricing bucket for which the query is charged at.
|
550
604
|
#
|
551
|
-
# For more
|
605
|
+
# For more information on pricing, please visit [Amazon Location
|
552
606
|
# Service Pricing][1].
|
553
607
|
#
|
554
608
|
#
|
@@ -629,7 +683,7 @@ module Aws::GeoPlaces
|
|
629
683
|
:language,
|
630
684
|
:political_view,
|
631
685
|
:highlights)
|
632
|
-
SENSITIVE = []
|
686
|
+
SENSITIVE = [:place_id, :place_type, :title, :distance, :political_view]
|
633
687
|
include Aws::Structure
|
634
688
|
end
|
635
689
|
|
@@ -649,7 +703,7 @@ module Aws::GeoPlaces
|
|
649
703
|
class BusinessChain < Struct.new(
|
650
704
|
:name,
|
651
705
|
:id)
|
652
|
-
SENSITIVE = []
|
706
|
+
SENSITIVE = [:name, :id]
|
653
707
|
include Aws::Structure
|
654
708
|
end
|
655
709
|
|
@@ -679,17 +733,18 @@ module Aws::GeoPlaces
|
|
679
733
|
:name,
|
680
734
|
:localized_name,
|
681
735
|
:primary)
|
682
|
-
SENSITIVE = []
|
736
|
+
SENSITIVE = [:id, :name, :localized_name, :primary]
|
683
737
|
include Aws::Structure
|
684
738
|
end
|
685
739
|
|
686
|
-
# Indicates how well the
|
687
|
-
#
|
688
|
-
#
|
740
|
+
# Indicates how well the returned title and address components matches
|
741
|
+
# the input TextQuery. For each component a score is provied with 1
|
742
|
+
# indicating all tokens were matched and 0 indicating no tokens were
|
743
|
+
# matched.
|
689
744
|
#
|
690
745
|
# @!attribute [rw] title
|
691
|
-
# Indicates the
|
692
|
-
#
|
746
|
+
# Indicates the match score of the title in the text query that match
|
747
|
+
# the found title.
|
693
748
|
# @return [Float]
|
694
749
|
#
|
695
750
|
# @!attribute [rw] address
|
@@ -725,7 +780,7 @@ module Aws::GeoPlaces
|
|
725
780
|
:label,
|
726
781
|
:value,
|
727
782
|
:categories)
|
728
|
-
SENSITIVE = []
|
783
|
+
SENSITIVE = [:label, :value]
|
729
784
|
include Aws::Structure
|
730
785
|
end
|
731
786
|
|
@@ -779,7 +834,7 @@ module Aws::GeoPlaces
|
|
779
834
|
:code_2,
|
780
835
|
:code_3,
|
781
836
|
:name)
|
782
|
-
SENSITIVE = []
|
837
|
+
SENSITIVE = [:code_2, :code_3, :name]
|
783
838
|
include Aws::Structure
|
784
839
|
end
|
785
840
|
|
@@ -821,7 +876,7 @@ module Aws::GeoPlaces
|
|
821
876
|
class FilterCircle < Struct.new(
|
822
877
|
:center,
|
823
878
|
:radius)
|
824
|
-
SENSITIVE = [:center]
|
879
|
+
SENSITIVE = [:center, :radius]
|
825
880
|
include Aws::Structure
|
826
881
|
end
|
827
882
|
|
@@ -847,12 +902,12 @@ module Aws::GeoPlaces
|
|
847
902
|
:localized_name,
|
848
903
|
:id,
|
849
904
|
:primary)
|
850
|
-
SENSITIVE = []
|
905
|
+
SENSITIVE = [:localized_name, :id, :primary]
|
851
906
|
include Aws::Structure
|
852
907
|
end
|
853
908
|
|
854
909
|
# Geocode structure which contains a set of inclusion/exclusion
|
855
|
-
# properties that results must
|
910
|
+
# properties that results must possess in order to be returned as a
|
856
911
|
# result.
|
857
912
|
#
|
858
913
|
# @!attribute [rw] include_countries
|
@@ -869,6 +924,113 @@ module Aws::GeoPlaces
|
|
869
924
|
class GeocodeFilter < Struct.new(
|
870
925
|
:include_countries,
|
871
926
|
:include_place_types)
|
927
|
+
SENSITIVE = [:include_countries, :include_place_types]
|
928
|
+
include Aws::Structure
|
929
|
+
end
|
930
|
+
|
931
|
+
# Parsed components in the provided QueryText.
|
932
|
+
#
|
933
|
+
# @!attribute [rw] title
|
934
|
+
# The localized display name of this result item based on request
|
935
|
+
# parameter `language`.
|
936
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
937
|
+
#
|
938
|
+
# @!attribute [rw] address
|
939
|
+
# The place address.
|
940
|
+
# @return [Types::GeocodeParsedQueryAddressComponents]
|
941
|
+
#
|
942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeParsedQuery AWS API Documentation
|
943
|
+
#
|
944
|
+
class GeocodeParsedQuery < Struct.new(
|
945
|
+
:title,
|
946
|
+
:address)
|
947
|
+
SENSITIVE = []
|
948
|
+
include Aws::Structure
|
949
|
+
end
|
950
|
+
|
951
|
+
# Parsed address components in the provided QueryText.
|
952
|
+
#
|
953
|
+
# @!attribute [rw] country
|
954
|
+
# The alpha-2 or alpha-3 character code for the country that the
|
955
|
+
# results will be present in.
|
956
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
957
|
+
#
|
958
|
+
# @!attribute [rw] region
|
959
|
+
# The region or state results should be present in.
|
960
|
+
#
|
961
|
+
# Example: `North Rhine-Westphalia`.
|
962
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] sub_region
|
965
|
+
# The sub-region or county for which results should be present in.
|
966
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] locality
|
969
|
+
# The city or locality of the address.
|
970
|
+
#
|
971
|
+
# Example: `Vancouver`.
|
972
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
973
|
+
#
|
974
|
+
# @!attribute [rw] district
|
975
|
+
# The district or division of a city the results should be present in.
|
976
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
977
|
+
#
|
978
|
+
# @!attribute [rw] sub_district
|
979
|
+
# A subdivision of a district.
|
980
|
+
#
|
981
|
+
# Example: `Minden-Lübbecke`.
|
982
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
983
|
+
#
|
984
|
+
# @!attribute [rw] postal_code
|
985
|
+
# An alphanumeric string included in a postal address to facilitate
|
986
|
+
# mail sorting, such as post code, postcode, or ZIP code, for which
|
987
|
+
# the result should possess.
|
988
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
989
|
+
#
|
990
|
+
# @!attribute [rw] block
|
991
|
+
# Name of the block.
|
992
|
+
#
|
993
|
+
# Example: `Sunny Mansion 203 block: 2 Chome`
|
994
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
995
|
+
#
|
996
|
+
# @!attribute [rw] sub_block
|
997
|
+
# Name of sub-block.
|
998
|
+
#
|
999
|
+
# Example: `Sunny Mansion 203 sub-block: 4`
|
1000
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] street
|
1003
|
+
# The name of the street results should be present in.
|
1004
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
1005
|
+
#
|
1006
|
+
# @!attribute [rw] address_number
|
1007
|
+
# The number that identifies an address within a street.
|
1008
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
1009
|
+
#
|
1010
|
+
# @!attribute [rw] building
|
1011
|
+
# The name of the building at the address.
|
1012
|
+
# @return [Array<Types::ParsedQueryComponent>]
|
1013
|
+
#
|
1014
|
+
# @!attribute [rw] secondary_address_components
|
1015
|
+
# Parsed secondary address components from the provided query text.
|
1016
|
+
# @return [Array<Types::ParsedQuerySecondaryAddressComponent>]
|
1017
|
+
#
|
1018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeParsedQueryAddressComponents AWS API Documentation
|
1019
|
+
#
|
1020
|
+
class GeocodeParsedQueryAddressComponents < Struct.new(
|
1021
|
+
:country,
|
1022
|
+
:region,
|
1023
|
+
:sub_region,
|
1024
|
+
:locality,
|
1025
|
+
:district,
|
1026
|
+
:sub_district,
|
1027
|
+
:postal_code,
|
1028
|
+
:block,
|
1029
|
+
:sub_block,
|
1030
|
+
:street,
|
1031
|
+
:address_number,
|
1032
|
+
:building,
|
1033
|
+
:secondary_address_components)
|
872
1034
|
SENSITIVE = []
|
873
1035
|
include Aws::Structure
|
874
1036
|
end
|
@@ -892,7 +1054,7 @@ module Aws::GeoPlaces
|
|
892
1054
|
# @return [String]
|
893
1055
|
#
|
894
1056
|
# @!attribute [rw] locality
|
895
|
-
#
|
1057
|
+
# The city or locality results should be present in.
|
896
1058
|
#
|
897
1059
|
# Example: `Vancouver`.
|
898
1060
|
# @return [String]
|
@@ -912,7 +1074,7 @@ module Aws::GeoPlaces
|
|
912
1074
|
# @!attribute [rw] postal_code
|
913
1075
|
# An alphanumeric string included in a postal address to facilitate
|
914
1076
|
# mail sorting, such as post code, postcode, or ZIP code for which the
|
915
|
-
# result should
|
1077
|
+
# result should possess.
|
916
1078
|
# @return [String]
|
917
1079
|
#
|
918
1080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeQueryComponents AWS API Documentation
|
@@ -934,6 +1096,10 @@ module Aws::GeoPlaces
|
|
934
1096
|
# The free-form text query to match addresses against. This is usually
|
935
1097
|
# a partially typed address from an end user in an address box or
|
936
1098
|
# form.
|
1099
|
+
#
|
1100
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
1101
|
+
#
|
1102
|
+
# </note>
|
937
1103
|
# @return [String]
|
938
1104
|
#
|
939
1105
|
# @!attribute [rw] query_components
|
@@ -960,7 +1126,7 @@ module Aws::GeoPlaces
|
|
960
1126
|
#
|
961
1127
|
# @!attribute [rw] filter
|
962
1128
|
# A structure which contains a set of inclusion/exclusion properties
|
963
|
-
# that results must
|
1129
|
+
# that results must possess in order to be returned as a result.
|
964
1130
|
# @return [Types::GeocodeFilter]
|
965
1131
|
#
|
966
1132
|
# @!attribute [rw] additional_features
|
@@ -989,6 +1155,18 @@ module Aws::GeoPlaces
|
|
989
1155
|
# @!attribute [rw] intended_use
|
990
1156
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
991
1157
|
# left empty.
|
1158
|
+
#
|
1159
|
+
# <note markdown="1"> Storing the response of an Geocode query is required to comply with
|
1160
|
+
# service terms, but charged at a higher cost per request. Please
|
1161
|
+
# review the [user agreement][1] and [service pricing structure][2] to
|
1162
|
+
# determine the correct setting for your use case.
|
1163
|
+
#
|
1164
|
+
# </note>
|
1165
|
+
#
|
1166
|
+
#
|
1167
|
+
#
|
1168
|
+
# [1]: https://aws.amazon.com/location/sla/
|
1169
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
992
1170
|
# @return [String]
|
993
1171
|
#
|
994
1172
|
# @!attribute [rw] key
|
@@ -1009,14 +1187,14 @@ module Aws::GeoPlaces
|
|
1009
1187
|
:political_view,
|
1010
1188
|
:intended_use,
|
1011
1189
|
:key)
|
1012
|
-
SENSITIVE = [:query_text, :bias_position, :key]
|
1190
|
+
SENSITIVE = [:query_text, :bias_position, :political_view, :key]
|
1013
1191
|
include Aws::Structure
|
1014
1192
|
end
|
1015
1193
|
|
1016
1194
|
# @!attribute [rw] pricing_bucket
|
1017
1195
|
# The pricing bucket for which the query is charged at.
|
1018
1196
|
#
|
1019
|
-
# For more
|
1197
|
+
# For more information on pricing, please visit [Amazon Location
|
1020
1198
|
# Service Pricing][1].
|
1021
1199
|
#
|
1022
1200
|
#
|
@@ -1040,7 +1218,7 @@ module Aws::GeoPlaces
|
|
1040
1218
|
# The Geocoded result.
|
1041
1219
|
#
|
1042
1220
|
# @!attribute [rw] place_id
|
1043
|
-
# The `PlaceId` of the place
|
1221
|
+
# The `PlaceId` of the place result.
|
1044
1222
|
# @return [String]
|
1045
1223
|
#
|
1046
1224
|
# @!attribute [rw] place_type
|
@@ -1089,7 +1267,7 @@ module Aws::GeoPlaces
|
|
1089
1267
|
# @return [Array<Types::FoodType>]
|
1090
1268
|
#
|
1091
1269
|
# @!attribute [rw] access_points
|
1092
|
-
# Position of the access point
|
1270
|
+
# Position of the access point represented by longitude and latitude.
|
1093
1271
|
# @return [Array<Types::AccessPoint>]
|
1094
1272
|
#
|
1095
1273
|
# @!attribute [rw] time_zone
|
@@ -1108,6 +1286,24 @@ module Aws::GeoPlaces
|
|
1108
1286
|
# equal to 1 if all input tokens are recognized and matched.
|
1109
1287
|
# @return [Types::MatchScoreDetails]
|
1110
1288
|
#
|
1289
|
+
# @!attribute [rw] parsed_query
|
1290
|
+
# Free-form text query.
|
1291
|
+
# @return [Types::GeocodeParsedQuery]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] intersections
|
1294
|
+
# All Intersections that are near the provided address.
|
1295
|
+
# @return [Array<Types::Intersection>]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] main_address
|
1298
|
+
# The main address corresponding to a place of type Secondary Address.
|
1299
|
+
# @return [Types::RelatedPlace]
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] secondary_addresses
|
1302
|
+
# All secondary addresses that are associated with a main address. A
|
1303
|
+
# secondary address is one that includes secondary designators, such
|
1304
|
+
# as a Suite or Unit Number, Building, or Floor information.
|
1305
|
+
# @return [Array<Types::RelatedPlace>]
|
1306
|
+
#
|
1111
1307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeResultItem AWS API Documentation
|
1112
1308
|
#
|
1113
1309
|
class GeocodeResultItem < Struct.new(
|
@@ -1125,8 +1321,12 @@ module Aws::GeoPlaces
|
|
1125
1321
|
:access_points,
|
1126
1322
|
:time_zone,
|
1127
1323
|
:political_view,
|
1128
|
-
:match_scores
|
1129
|
-
|
1324
|
+
:match_scores,
|
1325
|
+
:parsed_query,
|
1326
|
+
:intersections,
|
1327
|
+
:main_address,
|
1328
|
+
:secondary_addresses)
|
1329
|
+
SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view]
|
1130
1330
|
include Aws::Structure
|
1131
1331
|
end
|
1132
1332
|
|
@@ -1160,6 +1360,18 @@ module Aws::GeoPlaces
|
|
1160
1360
|
# @!attribute [rw] intended_use
|
1161
1361
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1162
1362
|
# left empty.
|
1363
|
+
#
|
1364
|
+
# <note markdown="1"> Storing the response of an GetPlace query is required to comply with
|
1365
|
+
# service terms, but charged at a higher cost per request. Please
|
1366
|
+
# review the [user agreement][1] and [service pricing structure][2] to
|
1367
|
+
# determine the correct setting for your use case.
|
1368
|
+
#
|
1369
|
+
# </note>
|
1370
|
+
#
|
1371
|
+
#
|
1372
|
+
#
|
1373
|
+
# [1]: https://aws.amazon.com/location/sla/
|
1374
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1163
1375
|
# @return [String]
|
1164
1376
|
#
|
1165
1377
|
# @!attribute [rw] key
|
@@ -1176,7 +1388,7 @@ module Aws::GeoPlaces
|
|
1176
1388
|
:political_view,
|
1177
1389
|
:intended_use,
|
1178
1390
|
:key)
|
1179
|
-
SENSITIVE = [:place_id, :key]
|
1391
|
+
SENSITIVE = [:place_id, :political_view, :key]
|
1180
1392
|
include Aws::Structure
|
1181
1393
|
end
|
1182
1394
|
|
@@ -1196,7 +1408,7 @@ module Aws::GeoPlaces
|
|
1196
1408
|
# @!attribute [rw] pricing_bucket
|
1197
1409
|
# The pricing bucket for which the query is charged at.
|
1198
1410
|
#
|
1199
|
-
# For more
|
1411
|
+
# For more information on pricing, please visit [Amazon Location
|
1200
1412
|
# Service Pricing][1].
|
1201
1413
|
#
|
1202
1414
|
#
|
@@ -1274,6 +1486,16 @@ module Aws::GeoPlaces
|
|
1274
1486
|
# in various languages.
|
1275
1487
|
# @return [Types::PhonemeDetails]
|
1276
1488
|
#
|
1489
|
+
# @!attribute [rw] main_address
|
1490
|
+
# The main address corresponding to a place of type Secondary Address.
|
1491
|
+
# @return [Types::RelatedPlace]
|
1492
|
+
#
|
1493
|
+
# @!attribute [rw] secondary_addresses
|
1494
|
+
# All secondary addresses that are associated with a main address. A
|
1495
|
+
# secondary address is one that includes secondary designators, such
|
1496
|
+
# as a Suite or Unit Number, Building, or Floor information.
|
1497
|
+
# @return [Array<Types::RelatedPlace>]
|
1498
|
+
#
|
1277
1499
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GetPlaceResponse AWS API Documentation
|
1278
1500
|
#
|
1279
1501
|
class GetPlaceResponse < Struct.new(
|
@@ -1295,12 +1517,15 @@ module Aws::GeoPlaces
|
|
1295
1517
|
:access_restrictions,
|
1296
1518
|
:time_zone,
|
1297
1519
|
:political_view,
|
1298
|
-
:phonemes
|
1299
|
-
|
1520
|
+
:phonemes,
|
1521
|
+
:main_address,
|
1522
|
+
:secondary_addresses)
|
1523
|
+
SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :map_view, :political_view]
|
1300
1524
|
include Aws::Structure
|
1301
1525
|
end
|
1302
1526
|
|
1303
|
-
#
|
1527
|
+
# Indicates the starting and ending index of the text query that match
|
1528
|
+
# the found title.
|
1304
1529
|
#
|
1305
1530
|
# @!attribute [rw] start_index
|
1306
1531
|
# Start index of the highlight.
|
@@ -1320,7 +1545,7 @@ module Aws::GeoPlaces
|
|
1320
1545
|
:start_index,
|
1321
1546
|
:end_index,
|
1322
1547
|
:value)
|
1323
|
-
SENSITIVE = []
|
1548
|
+
SENSITIVE = [:value]
|
1324
1549
|
include Aws::Structure
|
1325
1550
|
end
|
1326
1551
|
|
@@ -1338,6 +1563,61 @@ module Aws::GeoPlaces
|
|
1338
1563
|
include Aws::Structure
|
1339
1564
|
end
|
1340
1565
|
|
1566
|
+
# All Intersections that are near the provided address.
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] place_id
|
1569
|
+
# The `PlaceId` of the place result.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] title
|
1573
|
+
# The localized display name of this result item based on request
|
1574
|
+
# parameter `language`.
|
1575
|
+
# @return [String]
|
1576
|
+
#
|
1577
|
+
# @!attribute [rw] address
|
1578
|
+
# The place address.
|
1579
|
+
# @return [Types::Address]
|
1580
|
+
#
|
1581
|
+
# @!attribute [rw] position
|
1582
|
+
# The position, in longitude and latitude.
|
1583
|
+
# @return [Array<Float>]
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] distance
|
1586
|
+
# The distance in meters from the QueryPosition.
|
1587
|
+
# @return [Integer]
|
1588
|
+
#
|
1589
|
+
# @!attribute [rw] route_distance
|
1590
|
+
# The distance from the routing position of the nearby address to the
|
1591
|
+
# street result.
|
1592
|
+
# @return [Integer]
|
1593
|
+
#
|
1594
|
+
# @!attribute [rw] map_view
|
1595
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
1596
|
+
# an individual result covers.
|
1597
|
+
#
|
1598
|
+
# The bounding box formed is defined as a set of four coordinates:
|
1599
|
+
# `[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]`
|
1600
|
+
# @return [Array<Float>]
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] access_points
|
1603
|
+
# Position of the access point represented by longitude and latitude.
|
1604
|
+
# @return [Array<Types::AccessPoint>]
|
1605
|
+
#
|
1606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Intersection AWS API Documentation
|
1607
|
+
#
|
1608
|
+
class Intersection < Struct.new(
|
1609
|
+
:place_id,
|
1610
|
+
:title,
|
1611
|
+
:address,
|
1612
|
+
:position,
|
1613
|
+
:distance,
|
1614
|
+
:route_distance,
|
1615
|
+
:map_view,
|
1616
|
+
:access_points)
|
1617
|
+
SENSITIVE = [:place_id, :title, :position, :distance, :route_distance, :map_view]
|
1618
|
+
include Aws::Structure
|
1619
|
+
end
|
1620
|
+
|
1341
1621
|
# Details related to the match score.
|
1342
1622
|
#
|
1343
1623
|
# @!attribute [rw] overall
|
@@ -1386,7 +1666,7 @@ module Aws::GeoPlaces
|
|
1386
1666
|
:open_now,
|
1387
1667
|
:components,
|
1388
1668
|
:categories)
|
1389
|
-
SENSITIVE = []
|
1669
|
+
SENSITIVE = [:display, :open_now]
|
1390
1670
|
include Aws::Structure
|
1391
1671
|
end
|
1392
1672
|
|
@@ -1413,7 +1693,74 @@ module Aws::GeoPlaces
|
|
1413
1693
|
:open_time,
|
1414
1694
|
:open_duration,
|
1415
1695
|
:recurrence)
|
1416
|
-
SENSITIVE = []
|
1696
|
+
SENSITIVE = [:open_time, :open_duration, :recurrence]
|
1697
|
+
include Aws::Structure
|
1698
|
+
end
|
1699
|
+
|
1700
|
+
# Parsed components in the provided QueryText.
|
1701
|
+
#
|
1702
|
+
# @!attribute [rw] start_index
|
1703
|
+
# Start index of the parsed query component.
|
1704
|
+
# @return [Integer]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] end_index
|
1707
|
+
# End index of the parsed query component.
|
1708
|
+
# @return [Integer]
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] value
|
1711
|
+
# Value of the parsed query component.
|
1712
|
+
# @return [String]
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] query_component
|
1715
|
+
# The address component that the parsed query component corresponds
|
1716
|
+
# to.
|
1717
|
+
# @return [String]
|
1718
|
+
#
|
1719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ParsedQueryComponent AWS API Documentation
|
1720
|
+
#
|
1721
|
+
class ParsedQueryComponent < Struct.new(
|
1722
|
+
:start_index,
|
1723
|
+
:end_index,
|
1724
|
+
:value,
|
1725
|
+
:query_component)
|
1726
|
+
SENSITIVE = [:value, :query_component]
|
1727
|
+
include Aws::Structure
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# Information about a secondary address component parsed from the query
|
1731
|
+
# text.
|
1732
|
+
#
|
1733
|
+
# @!attribute [rw] start_index
|
1734
|
+
# Start index of the parsed secondary address component in the query
|
1735
|
+
# text.
|
1736
|
+
# @return [Integer]
|
1737
|
+
#
|
1738
|
+
# @!attribute [rw] end_index
|
1739
|
+
# End index of the parsed secondary address component in the query
|
1740
|
+
# text.
|
1741
|
+
# @return [Integer]
|
1742
|
+
#
|
1743
|
+
# @!attribute [rw] value
|
1744
|
+
# Value of the parsed secondary address component.
|
1745
|
+
# @return [String]
|
1746
|
+
#
|
1747
|
+
# @!attribute [rw] number
|
1748
|
+
# Secondary address number provided in the query.
|
1749
|
+
# @return [String]
|
1750
|
+
#
|
1751
|
+
# @!attribute [rw] designator
|
1752
|
+
# Secondary address designator provided in the query.
|
1753
|
+
# @return [String]
|
1754
|
+
#
|
1755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ParsedQuerySecondaryAddressComponent AWS API Documentation
|
1756
|
+
#
|
1757
|
+
class ParsedQuerySecondaryAddressComponent < Struct.new(
|
1758
|
+
:start_index,
|
1759
|
+
:end_index,
|
1760
|
+
:value,
|
1761
|
+
:number,
|
1762
|
+
:designator)
|
1763
|
+
SENSITIVE = [:value, :number, :designator]
|
1417
1764
|
include Aws::Structure
|
1418
1765
|
end
|
1419
1766
|
|
@@ -1464,7 +1811,7 @@ module Aws::GeoPlaces
|
|
1464
1811
|
:value,
|
1465
1812
|
:language,
|
1466
1813
|
:preferred)
|
1467
|
-
SENSITIVE = []
|
1814
|
+
SENSITIVE = [:value, :preferred]
|
1468
1815
|
include Aws::Structure
|
1469
1816
|
end
|
1470
1817
|
|
@@ -1473,7 +1820,7 @@ module Aws::GeoPlaces
|
|
1473
1820
|
# @!attribute [rw] postal_code
|
1474
1821
|
# An alphanumeric string included in a postal address to facilitate
|
1475
1822
|
# mail sorting, such as post code, postcode, or ZIP code for which the
|
1476
|
-
# result should
|
1823
|
+
# result should possess.
|
1477
1824
|
# @return [String]
|
1478
1825
|
#
|
1479
1826
|
# @!attribute [rw] postal_authority
|
@@ -1502,7 +1849,7 @@ module Aws::GeoPlaces
|
|
1502
1849
|
:postal_code_type,
|
1503
1850
|
:usps_zip,
|
1504
1851
|
:usps_zip_plus_4)
|
1505
|
-
SENSITIVE = []
|
1852
|
+
SENSITIVE = [:postal_code, :postal_authority, :postal_code_type]
|
1506
1853
|
include Aws::Structure
|
1507
1854
|
end
|
1508
1855
|
|
@@ -1534,7 +1881,7 @@ module Aws::GeoPlaces
|
|
1534
1881
|
:original_term,
|
1535
1882
|
:start_index,
|
1536
1883
|
:end_index)
|
1537
|
-
SENSITIVE = []
|
1884
|
+
SENSITIVE = [:refined_term, :original_term]
|
1538
1885
|
include Aws::Structure
|
1539
1886
|
end
|
1540
1887
|
|
@@ -1559,7 +1906,7 @@ module Aws::GeoPlaces
|
|
1559
1906
|
class Region < Struct.new(
|
1560
1907
|
:code,
|
1561
1908
|
:name)
|
1562
|
-
SENSITIVE = []
|
1909
|
+
SENSITIVE = [:code, :name]
|
1563
1910
|
include Aws::Structure
|
1564
1911
|
end
|
1565
1912
|
|
@@ -1585,6 +1932,46 @@ module Aws::GeoPlaces
|
|
1585
1932
|
include Aws::Structure
|
1586
1933
|
end
|
1587
1934
|
|
1935
|
+
# Place that is related to the result item.
|
1936
|
+
#
|
1937
|
+
# @!attribute [rw] place_id
|
1938
|
+
# The `PlaceId` of the place result.
|
1939
|
+
# @return [String]
|
1940
|
+
#
|
1941
|
+
# @!attribute [rw] place_type
|
1942
|
+
# A `PlaceType` is a category that the result place must belong to.
|
1943
|
+
# @return [String]
|
1944
|
+
#
|
1945
|
+
# @!attribute [rw] title
|
1946
|
+
# The localized display name of this result item based on request
|
1947
|
+
# parameter `language`.
|
1948
|
+
# @return [String]
|
1949
|
+
#
|
1950
|
+
# @!attribute [rw] address
|
1951
|
+
# The place address.
|
1952
|
+
# @return [Types::Address]
|
1953
|
+
#
|
1954
|
+
# @!attribute [rw] position
|
1955
|
+
# The position, in longitude and latitude.
|
1956
|
+
# @return [Array<Float>]
|
1957
|
+
#
|
1958
|
+
# @!attribute [rw] access_points
|
1959
|
+
# Position of the access point represented by longitude and latitude.
|
1960
|
+
# @return [Array<Types::AccessPoint>]
|
1961
|
+
#
|
1962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/RelatedPlace AWS API Documentation
|
1963
|
+
#
|
1964
|
+
class RelatedPlace < Struct.new(
|
1965
|
+
:place_id,
|
1966
|
+
:place_type,
|
1967
|
+
:title,
|
1968
|
+
:address,
|
1969
|
+
:position,
|
1970
|
+
:access_points)
|
1971
|
+
SENSITIVE = [:place_id, :place_type, :title, :position]
|
1972
|
+
include Aws::Structure
|
1973
|
+
end
|
1974
|
+
|
1588
1975
|
# The included place types.
|
1589
1976
|
#
|
1590
1977
|
# @!attribute [rw] include_place_types
|
@@ -1601,7 +1988,7 @@ module Aws::GeoPlaces
|
|
1601
1988
|
|
1602
1989
|
# @!attribute [rw] query_position
|
1603
1990
|
# The position, in `[lng, lat]` for which you are querying nearby
|
1604
|
-
#
|
1991
|
+
# results for. Results closer to the position will be ranked higher
|
1605
1992
|
# then results further away from the position
|
1606
1993
|
# @return [Array<Float>]
|
1607
1994
|
#
|
@@ -1617,7 +2004,7 @@ module Aws::GeoPlaces
|
|
1617
2004
|
#
|
1618
2005
|
# @!attribute [rw] filter
|
1619
2006
|
# A structure which contains a set of inclusion/exclusion properties
|
1620
|
-
# that results must
|
2007
|
+
# that results must possess in order to be returned as a result.
|
1621
2008
|
# @return [Types::ReverseGeocodeFilter]
|
1622
2009
|
#
|
1623
2010
|
# @!attribute [rw] additional_features
|
@@ -1646,6 +2033,18 @@ module Aws::GeoPlaces
|
|
1646
2033
|
# @!attribute [rw] intended_use
|
1647
2034
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1648
2035
|
# left empty.
|
2036
|
+
#
|
2037
|
+
# <note markdown="1"> Storing the response of an ReverseGeocode query is required to
|
2038
|
+
# comply with service terms, but charged at a higher cost per request.
|
2039
|
+
# Please review the [user agreement][1] and [service pricing
|
2040
|
+
# structure][2] to determine the correct setting for your use case.
|
2041
|
+
#
|
2042
|
+
# </note>
|
2043
|
+
#
|
2044
|
+
#
|
2045
|
+
#
|
2046
|
+
# [1]: https://aws.amazon.com/location/sla/
|
2047
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1649
2048
|
# @return [String]
|
1650
2049
|
#
|
1651
2050
|
# @!attribute [rw] key
|
@@ -1665,14 +2064,14 @@ module Aws::GeoPlaces
|
|
1665
2064
|
:political_view,
|
1666
2065
|
:intended_use,
|
1667
2066
|
:key)
|
1668
|
-
SENSITIVE = [:query_position, :key]
|
2067
|
+
SENSITIVE = [:query_position, :query_radius, :political_view, :key]
|
1669
2068
|
include Aws::Structure
|
1670
2069
|
end
|
1671
2070
|
|
1672
2071
|
# @!attribute [rw] pricing_bucket
|
1673
2072
|
# The pricing bucket for which the query is charged at.
|
1674
2073
|
#
|
1675
|
-
# For more
|
2074
|
+
# For more information on pricing, please visit [Amazon Location
|
1676
2075
|
# Service Pricing][1].
|
1677
2076
|
#
|
1678
2077
|
#
|
@@ -1745,7 +2144,7 @@ module Aws::GeoPlaces
|
|
1745
2144
|
# @return [Array<Types::FoodType>]
|
1746
2145
|
#
|
1747
2146
|
# @!attribute [rw] access_points
|
1748
|
-
# Position of the access point
|
2147
|
+
# Position of the access point represented by longitude and latitude.
|
1749
2148
|
# @return [Array<Types::AccessPoint>]
|
1750
2149
|
#
|
1751
2150
|
# @!attribute [rw] time_zone
|
@@ -1759,6 +2158,10 @@ module Aws::GeoPlaces
|
|
1759
2158
|
# the specified country.
|
1760
2159
|
# @return [String]
|
1761
2160
|
#
|
2161
|
+
# @!attribute [rw] intersections
|
2162
|
+
# All Intersections that are near the provided address.
|
2163
|
+
# @return [Array<Types::Intersection>]
|
2164
|
+
#
|
1762
2165
|
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ReverseGeocodeResultItem AWS API Documentation
|
1763
2166
|
#
|
1764
2167
|
class ReverseGeocodeResultItem < Struct.new(
|
@@ -1775,13 +2178,14 @@ module Aws::GeoPlaces
|
|
1775
2178
|
:food_types,
|
1776
2179
|
:access_points,
|
1777
2180
|
:time_zone,
|
1778
|
-
:political_view
|
1779
|
-
|
2181
|
+
:political_view,
|
2182
|
+
:intersections)
|
2183
|
+
SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view]
|
1780
2184
|
include Aws::Structure
|
1781
2185
|
end
|
1782
2186
|
|
1783
2187
|
# SearchNearby structure which contains a set of inclusion/exclusion
|
1784
|
-
# properties that results must
|
2188
|
+
# properties that results must possess in order to be returned as a
|
1785
2189
|
# result.
|
1786
2190
|
#
|
1787
2191
|
# @!attribute [rw] bounding_box
|
@@ -1832,19 +2236,23 @@ module Aws::GeoPlaces
|
|
1832
2236
|
:exclude_business_chains,
|
1833
2237
|
:include_food_types,
|
1834
2238
|
:exclude_food_types)
|
1835
|
-
SENSITIVE = [:bounding_box]
|
2239
|
+
SENSITIVE = [:bounding_box, :include_countries, :include_categories, :exclude_categories, :include_business_chains, :exclude_business_chains, :include_food_types, :exclude_food_types]
|
1836
2240
|
include Aws::Structure
|
1837
2241
|
end
|
1838
2242
|
|
1839
2243
|
# @!attribute [rw] query_position
|
1840
2244
|
# The position, in `[lng, lat]` for which you are querying nearby
|
1841
|
-
#
|
2245
|
+
# results for. Results closer to the position will be ranked higher
|
1842
2246
|
# then results further away from the position
|
1843
2247
|
# @return [Array<Float>]
|
1844
2248
|
#
|
1845
2249
|
# @!attribute [rw] query_radius
|
1846
2250
|
# The maximum distance in meters from the QueryPosition from which a
|
1847
2251
|
# result will be returned.
|
2252
|
+
#
|
2253
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
2254
|
+
#
|
2255
|
+
# </note>
|
1848
2256
|
# @return [Integer]
|
1849
2257
|
#
|
1850
2258
|
# @!attribute [rw] max_results
|
@@ -1854,7 +2262,7 @@ module Aws::GeoPlaces
|
|
1854
2262
|
#
|
1855
2263
|
# @!attribute [rw] filter
|
1856
2264
|
# A structure which contains a set of inclusion/exclusion properties
|
1857
|
-
# that results must
|
2265
|
+
# that results must possess in order to be returned as a result.
|
1858
2266
|
# @return [Types::SearchNearbyFilter]
|
1859
2267
|
#
|
1860
2268
|
# @!attribute [rw] additional_features
|
@@ -1883,6 +2291,18 @@ module Aws::GeoPlaces
|
|
1883
2291
|
# @!attribute [rw] intended_use
|
1884
2292
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1885
2293
|
# left empty.
|
2294
|
+
#
|
2295
|
+
# <note markdown="1"> Storing the response of an SearchNearby query is required to comply
|
2296
|
+
# with service terms, but charged at a higher cost per request. Please
|
2297
|
+
# review the [user agreement][1] and [service pricing structure][2] to
|
2298
|
+
# determine the correct setting for your use case.
|
2299
|
+
#
|
2300
|
+
# </note>
|
2301
|
+
#
|
2302
|
+
#
|
2303
|
+
#
|
2304
|
+
# [1]: https://aws.amazon.com/location/sla/
|
2305
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1886
2306
|
# @return [String]
|
1887
2307
|
#
|
1888
2308
|
# @!attribute [rw] next_token
|
@@ -1908,14 +2328,14 @@ module Aws::GeoPlaces
|
|
1908
2328
|
:intended_use,
|
1909
2329
|
:next_token,
|
1910
2330
|
:key)
|
1911
|
-
SENSITIVE = [:query_position, :key]
|
2331
|
+
SENSITIVE = [:query_position, :query_radius, :political_view, :key]
|
1912
2332
|
include Aws::Structure
|
1913
2333
|
end
|
1914
2334
|
|
1915
2335
|
# @!attribute [rw] pricing_bucket
|
1916
2336
|
# The pricing bucket for which the query is charged at.
|
1917
2337
|
#
|
1918
|
-
# For more
|
2338
|
+
# For more information on pricing, please visit [Amazon Location
|
1919
2339
|
# Service Pricing][1].
|
1920
2340
|
#
|
1921
2341
|
#
|
@@ -2047,12 +2467,12 @@ module Aws::GeoPlaces
|
|
2047
2467
|
:time_zone,
|
2048
2468
|
:political_view,
|
2049
2469
|
:phonemes)
|
2050
|
-
SENSITIVE = [:position, :map_view]
|
2470
|
+
SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view]
|
2051
2471
|
include Aws::Structure
|
2052
2472
|
end
|
2053
2473
|
|
2054
2474
|
# SearchText structure which contains a set of inclusion/exclusion
|
2055
|
-
# properties that results must
|
2475
|
+
# properties that results must possess in order to be returned as a
|
2056
2476
|
# result.
|
2057
2477
|
#
|
2058
2478
|
# @!attribute [rw] bounding_box
|
@@ -2078,7 +2498,7 @@ module Aws::GeoPlaces
|
|
2078
2498
|
:bounding_box,
|
2079
2499
|
:circle,
|
2080
2500
|
:include_countries)
|
2081
|
-
SENSITIVE = [:bounding_box, :circle]
|
2501
|
+
SENSITIVE = [:bounding_box, :circle, :include_countries]
|
2082
2502
|
include Aws::Structure
|
2083
2503
|
end
|
2084
2504
|
|
@@ -2086,10 +2506,20 @@ module Aws::GeoPlaces
|
|
2086
2506
|
# The free-form text query to match addresses against. This is usually
|
2087
2507
|
# a partially typed address from an end user in an address box or
|
2088
2508
|
# form.
|
2509
|
+
#
|
2510
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
2511
|
+
#
|
2512
|
+
# </note>
|
2089
2513
|
# @return [String]
|
2090
2514
|
#
|
2091
2515
|
# @!attribute [rw] query_id
|
2092
|
-
# The query Id.
|
2516
|
+
# The query Id returned by the suggest API. If passed in the request,
|
2517
|
+
# the SearchText API will preform a SearchText query with the improved
|
2518
|
+
# query terms for the original query made to the suggest API.
|
2519
|
+
#
|
2520
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
2521
|
+
#
|
2522
|
+
# </note>
|
2093
2523
|
# @return [String]
|
2094
2524
|
#
|
2095
2525
|
# @!attribute [rw] max_results
|
@@ -2111,7 +2541,7 @@ module Aws::GeoPlaces
|
|
2111
2541
|
#
|
2112
2542
|
# @!attribute [rw] filter
|
2113
2543
|
# A structure which contains a set of inclusion/exclusion properties
|
2114
|
-
# that results must
|
2544
|
+
# that results must possess in order to be returned as a result.
|
2115
2545
|
# @return [Types::SearchTextFilter]
|
2116
2546
|
#
|
2117
2547
|
# @!attribute [rw] additional_features
|
@@ -2140,6 +2570,18 @@ module Aws::GeoPlaces
|
|
2140
2570
|
# @!attribute [rw] intended_use
|
2141
2571
|
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
2142
2572
|
# left empty.
|
2573
|
+
#
|
2574
|
+
# <note markdown="1"> Storing the response of an SearchText query is required to comply
|
2575
|
+
# with service terms, but charged at a higher cost per request. Please
|
2576
|
+
# review the [user agreement][1] and [service pricing structure][2] to
|
2577
|
+
# determine the correct setting for your use case.
|
2578
|
+
#
|
2579
|
+
# </note>
|
2580
|
+
#
|
2581
|
+
#
|
2582
|
+
#
|
2583
|
+
# [1]: https://aws.amazon.com/location/sla/
|
2584
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
2143
2585
|
# @return [String]
|
2144
2586
|
#
|
2145
2587
|
# @!attribute [rw] next_token
|
@@ -2166,14 +2608,14 @@ module Aws::GeoPlaces
|
|
2166
2608
|
:intended_use,
|
2167
2609
|
:next_token,
|
2168
2610
|
:key)
|
2169
|
-
SENSITIVE = [:query_text, :query_id, :bias_position, :key]
|
2611
|
+
SENSITIVE = [:query_text, :query_id, :bias_position, :political_view, :key]
|
2170
2612
|
include Aws::Structure
|
2171
2613
|
end
|
2172
2614
|
|
2173
2615
|
# @!attribute [rw] pricing_bucket
|
2174
2616
|
# The pricing bucket for which the query is charged at.
|
2175
2617
|
#
|
2176
|
-
# For more
|
2618
|
+
# For more information on pricing, please visit [Amazon Location
|
2177
2619
|
# Service Pricing][1].
|
2178
2620
|
#
|
2179
2621
|
#
|
@@ -2305,7 +2747,36 @@ module Aws::GeoPlaces
|
|
2305
2747
|
:time_zone,
|
2306
2748
|
:political_view,
|
2307
2749
|
:phonemes)
|
2308
|
-
SENSITIVE = [:position, :map_view]
|
2750
|
+
SENSITIVE = [:place_id, :place_type, :title, :address_number_corrected, :position, :distance, :map_view, :political_view]
|
2751
|
+
include Aws::Structure
|
2752
|
+
end
|
2753
|
+
|
2754
|
+
# Components that correspond to secondary identifiers on an address. The
|
2755
|
+
# only component type supported currently is Unit.
|
2756
|
+
#
|
2757
|
+
# @!attribute [rw] number
|
2758
|
+
# Number that uniquely identifies a secondary address.
|
2759
|
+
# @return [String]
|
2760
|
+
#
|
2761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SecondaryAddressComponent AWS API Documentation
|
2762
|
+
#
|
2763
|
+
class SecondaryAddressComponent < Struct.new(
|
2764
|
+
:number)
|
2765
|
+
SENSITIVE = [:number]
|
2766
|
+
include Aws::Structure
|
2767
|
+
end
|
2768
|
+
|
2769
|
+
# Match score for a secondary address component in the result.
|
2770
|
+
#
|
2771
|
+
# @!attribute [rw] number
|
2772
|
+
# Match score for the secondary address number.
|
2773
|
+
# @return [Float]
|
2774
|
+
#
|
2775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SecondaryAddressComponentMatchScore AWS API Documentation
|
2776
|
+
#
|
2777
|
+
class SecondaryAddressComponentMatchScore < Struct.new(
|
2778
|
+
:number)
|
2779
|
+
SENSITIVE = []
|
2309
2780
|
include Aws::Structure
|
2310
2781
|
end
|
2311
2782
|
|
@@ -2314,13 +2785,13 @@ module Aws::GeoPlaces
|
|
2314
2785
|
# @!attribute [rw] base_name
|
2315
2786
|
# Base name part of the street name.
|
2316
2787
|
#
|
2317
|
-
# Example: Younge from the
|
2788
|
+
# Example: Younge from the "Younge street".
|
2318
2789
|
# @return [String]
|
2319
2790
|
#
|
2320
2791
|
# @!attribute [rw] type
|
2321
2792
|
# Street type part of the street name.
|
2322
2793
|
#
|
2323
|
-
# Example:
|
2794
|
+
# Example: `"avenue"`.
|
2324
2795
|
# @return [String]
|
2325
2796
|
#
|
2326
2797
|
# @!attribute [rw] type_placement
|
@@ -2328,7 +2799,8 @@ module Aws::GeoPlaces
|
|
2328
2799
|
# @return [String]
|
2329
2800
|
#
|
2330
2801
|
# @!attribute [rw] type_separator
|
2331
|
-
#
|
2802
|
+
# Defines a separator character such as `""` or `" "` between the base
|
2803
|
+
# name and type.
|
2332
2804
|
# @return [String]
|
2333
2805
|
#
|
2334
2806
|
# @!attribute [rw] prefix
|
@@ -2371,7 +2843,7 @@ module Aws::GeoPlaces
|
|
2371
2843
|
:suffix,
|
2372
2844
|
:direction,
|
2373
2845
|
:language)
|
2374
|
-
SENSITIVE = []
|
2846
|
+
SENSITIVE = [:base_name, :type, :prefix, :suffix, :direction]
|
2375
2847
|
include Aws::Structure
|
2376
2848
|
end
|
2377
2849
|
|
@@ -2390,7 +2862,7 @@ module Aws::GeoPlaces
|
|
2390
2862
|
class SubRegion < Struct.new(
|
2391
2863
|
:code,
|
2392
2864
|
:name)
|
2393
|
-
SENSITIVE = []
|
2865
|
+
SENSITIVE = [:code, :name]
|
2394
2866
|
include Aws::Structure
|
2395
2867
|
end
|
2396
2868
|
|
@@ -2437,7 +2909,7 @@ module Aws::GeoPlaces
|
|
2437
2909
|
end
|
2438
2910
|
|
2439
2911
|
# SuggestFilter structure which contains a set of inclusion/exclusion
|
2440
|
-
# properties that results must
|
2912
|
+
# properties that results must possess in order to be returned as a
|
2441
2913
|
# result.
|
2442
2914
|
#
|
2443
2915
|
# @!attribute [rw] bounding_box
|
@@ -2463,7 +2935,7 @@ module Aws::GeoPlaces
|
|
2463
2935
|
:bounding_box,
|
2464
2936
|
:circle,
|
2465
2937
|
:include_countries)
|
2466
|
-
SENSITIVE = [:bounding_box, :circle]
|
2938
|
+
SENSITIVE = [:bounding_box, :circle, :include_countries]
|
2467
2939
|
include Aws::Structure
|
2468
2940
|
end
|
2469
2941
|
|
@@ -2574,7 +3046,7 @@ module Aws::GeoPlaces
|
|
2574
3046
|
:time_zone,
|
2575
3047
|
:political_view,
|
2576
3048
|
:phonemes)
|
2577
|
-
SENSITIVE = [:position, :map_view]
|
3049
|
+
SENSITIVE = [:place_id, :place_type, :position, :distance, :map_view, :political_view]
|
2578
3050
|
include Aws::Structure
|
2579
3051
|
end
|
2580
3052
|
|
@@ -2587,13 +3059,17 @@ module Aws::GeoPlaces
|
|
2587
3059
|
# the SearchText API documentation for more details [SearchText API
|
2588
3060
|
# docs][1].
|
2589
3061
|
#
|
3062
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
3063
|
+
#
|
3064
|
+
# </note>
|
3065
|
+
#
|
2590
3066
|
#
|
2591
3067
|
#
|
2592
3068
|
# [1]: https://docs.aws.amazon.com/latest/APIReference/API_geoplaces_SearchText.html
|
2593
3069
|
# @return [String]
|
2594
3070
|
#
|
2595
3071
|
# @!attribute [rw] query_type
|
2596
|
-
# The query type. Category
|
3072
|
+
# The query type. Category queries will search for places which have
|
2597
3073
|
# an entry matching the given category, for example "doctor office".
|
2598
3074
|
# BusinessChain queries will search for instances of a given business.
|
2599
3075
|
# @return [String]
|
@@ -2603,7 +3079,7 @@ module Aws::GeoPlaces
|
|
2603
3079
|
class SuggestQueryResult < Struct.new(
|
2604
3080
|
:query_id,
|
2605
3081
|
:query_type)
|
2606
|
-
SENSITIVE = []
|
3082
|
+
SENSITIVE = [:query_id]
|
2607
3083
|
include Aws::Structure
|
2608
3084
|
end
|
2609
3085
|
|
@@ -2611,6 +3087,10 @@ module Aws::GeoPlaces
|
|
2611
3087
|
# The free-form text query to match addresses against. This is usually
|
2612
3088
|
# a partially typed address from an end user in an address box or
|
2613
3089
|
# form.
|
3090
|
+
#
|
3091
|
+
# <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
|
3092
|
+
#
|
3093
|
+
# </note>
|
2614
3094
|
# @return [String]
|
2615
3095
|
#
|
2616
3096
|
# @!attribute [rw] max_results
|
@@ -2637,7 +3117,7 @@ module Aws::GeoPlaces
|
|
2637
3117
|
#
|
2638
3118
|
# @!attribute [rw] filter
|
2639
3119
|
# A structure which contains a set of inclusion/exclusion properties
|
2640
|
-
# that results must
|
3120
|
+
# that results must possess in order to be returned as a result.
|
2641
3121
|
# @return [Types::SuggestFilter]
|
2642
3122
|
#
|
2643
3123
|
# @!attribute [rw] additional_features
|
@@ -2686,14 +3166,14 @@ module Aws::GeoPlaces
|
|
2686
3166
|
:political_view,
|
2687
3167
|
:intended_use,
|
2688
3168
|
:key)
|
2689
|
-
SENSITIVE = [:query_text, :bias_position, :key]
|
3169
|
+
SENSITIVE = [:query_text, :bias_position, :political_view, :key]
|
2690
3170
|
include Aws::Structure
|
2691
3171
|
end
|
2692
3172
|
|
2693
3173
|
# @!attribute [rw] pricing_bucket
|
2694
3174
|
# The pricing bucket for which the query is charged at.
|
2695
3175
|
#
|
2696
|
-
# For more
|
3176
|
+
# For more information on pricing, please visit [Amazon Location
|
2697
3177
|
# Service Pricing][1].
|
2698
3178
|
#
|
2699
3179
|
#
|
@@ -2755,7 +3235,7 @@ module Aws::GeoPlaces
|
|
2755
3235
|
:place,
|
2756
3236
|
:query,
|
2757
3237
|
:highlights)
|
2758
|
-
SENSITIVE = []
|
3238
|
+
SENSITIVE = [:title]
|
2759
3239
|
include Aws::Structure
|
2760
3240
|
end
|
2761
3241
|
|
@@ -2792,7 +3272,7 @@ module Aws::GeoPlaces
|
|
2792
3272
|
:name,
|
2793
3273
|
:offset,
|
2794
3274
|
:offset_seconds)
|
2795
|
-
SENSITIVE = []
|
3275
|
+
SENSITIVE = [:name, :offset, :offset_seconds]
|
2796
3276
|
include Aws::Structure
|
2797
3277
|
end
|
2798
3278
|
|
@@ -2807,7 +3287,7 @@ module Aws::GeoPlaces
|
|
2807
3287
|
#
|
2808
3288
|
class UspsZip < Struct.new(
|
2809
3289
|
:zip_classification_code)
|
2810
|
-
SENSITIVE = []
|
3290
|
+
SENSITIVE = [:zip_classification_code]
|
2811
3291
|
include Aws::Structure
|
2812
3292
|
end
|
2813
3293
|
|
@@ -2821,7 +3301,7 @@ module Aws::GeoPlaces
|
|
2821
3301
|
#
|
2822
3302
|
class UspsZipPlus4 < Struct.new(
|
2823
3303
|
:record_type_code)
|
2824
|
-
SENSITIVE = []
|
3304
|
+
SENSITIVE = [:record_type_code]
|
2825
3305
|
include Aws::Structure
|
2826
3306
|
end
|
2827
3307
|
|