aws-sdk-geoplaces 1.7.0 → 1.9.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.
@@ -95,7 +95,7 @@ module Aws::GeoPlaces
95
95
  # class name or an instance of a plugin class.
96
96
  #
97
97
  # @option options [required, Aws::CredentialProvider] :credentials
98
- # Your AWS credentials. This can be an instance of any one of the
98
+ # Your AWS credentials used for authentication. This can be an instance of any one of the
99
99
  # following classes:
100
100
  #
101
101
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
@@ -128,18 +128,23 @@ module Aws::GeoPlaces
128
128
  # locations will be searched for credentials:
129
129
  #
130
130
  # * `Aws.config[:credentials]`
131
+ #
131
132
  # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
133
  # `:account_id` options.
133
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
- # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
134
+ #
135
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
136
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
137
+ #
135
138
  # * `~/.aws/credentials`
139
+ #
136
140
  # * `~/.aws/config`
141
+ #
137
142
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
143
  # are very aggressive. Construct and pass an instance of
139
144
  # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
145
  # enable retries and extended timeouts. Instance profile credential
141
- # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
- # to true.
146
+ # fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
147
+ # to `true`.
143
148
  #
144
149
  # @option options [required, String] :region
145
150
  # The AWS region to connect to. The configured `:region` is
@@ -167,6 +172,11 @@ module Aws::GeoPlaces
167
172
  # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
173
  # not retry instead of sleeping.
169
174
  #
175
+ # @option options [Array<String>] :auth_scheme_preference
176
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
177
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
178
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
179
+ #
170
180
  # @option options [Boolean] :client_side_monitoring (false)
171
181
  # When `true`, client-side metrics will be collected for all API requests from
172
182
  # this client.
@@ -253,8 +263,8 @@ module Aws::GeoPlaces
253
263
  # 4 times. Used in `standard` and `adaptive` retry modes.
254
264
  #
255
265
  # @option options [String] :profile ("default")
256
- # Used when loading credentials from the shared credentials file
257
- # at HOME/.aws/credentials. When not specified, 'default' is used.
266
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
267
+ # When not specified, 'default' is used.
258
268
  #
259
269
  # @option options [String] :request_checksum_calculation ("when_supported")
260
270
  # Determines when a checksum will be calculated for request payloads. Values are:
@@ -367,7 +377,7 @@ module Aws::GeoPlaces
367
377
  # `Aws::Telemetry::OTelProvider` for telemetry provider.
368
378
  #
369
379
  # @option options [Aws::TokenProvider] :token_provider
370
- # A Bearer Token Provider. This can be an instance of any one of the
380
+ # Your Bearer token used for authentication. This can be an instance of any one of the
371
381
  # following classes:
372
382
  #
373
383
  # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
@@ -469,16 +479,23 @@ module Aws::GeoPlaces
469
479
 
470
480
  # @!group API Operations
471
481
 
472
- # The autocomplete operation speeds up and increases the accuracy of
473
- # entering addresses by providing a list of address candidates matching
474
- # a partially entered address. Results are sorted from most to least
475
- # matching. Filtering and biasing can be used to increase the relevance
476
- # of the results if additional search context is known
482
+ # `Autocomplete` completes potential places and addresses as the user
483
+ # types, based on the partial input. The API enhances the efficiency and
484
+ # accuracy of address by completing query based on a few entered
485
+ # keystrokes. It helps you by completing partial queries with valid
486
+ # address completion. Also, the API supports the filtering of results
487
+ # based on geographic location, country, or specific place types, and
488
+ # can be tailored using optional parameters like language and political
489
+ # views.
477
490
  #
478
491
  # @option params [required, String] :query_text
479
492
  # The free-form text query to match addresses against. This is usually a
480
493
  # partially typed address from an end user in an address box or form.
481
494
  #
495
+ # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
496
+ #
497
+ # </note>
498
+ #
482
499
  # @option params [Integer] :max_results
483
500
  # An optional limit for the number of results returned in a single call.
484
501
  #
@@ -495,14 +512,15 @@ module Aws::GeoPlaces
495
512
  #
496
513
  # @option params [Types::AutocompleteFilter] :filter
497
514
  # A structure which contains a set of inclusion/exclusion properties
498
- # that results must posses in order to be returned as a result.
515
+ # that results must possess in order to be returned as a result.
499
516
  #
500
517
  # @option params [String] :postal_code_mode
501
518
  # The `PostalCodeMode` affects how postal code results are returned. If
502
519
  # a postal code spans multiple localities and this value is empty,
503
520
  # partial district or locality information may be returned under a
504
521
  # single postal code result entry. If it's populated with the value
505
- # `cityLookup`, all cities in that postal code are returned.
522
+ # `EnumerateSpannedLocalities`, all cities in that postal code are
523
+ # returned.
506
524
  #
507
525
  # @option params [Array<String>] :additional_features
508
526
  # A list of optional additional parameters that can be requested for
@@ -523,6 +541,39 @@ module Aws::GeoPlaces
523
541
  # represent unresolved territorial claims through the point of view of
524
542
  # the specified country.
525
543
  #
544
+ # The following political views are currently supported:
545
+ #
546
+ # * `ARG`: Argentina's view on the Southern Patagonian Ice Field and
547
+ # Tierra Del Fuego, including the Falkland Islands, South Georgia, and
548
+ # South Sandwich Islands
549
+ #
550
+ # * `EGY`: Egypt's view on Bir Tawil
551
+ #
552
+ # * `IND`: India's view on Gilgit-Baltistan
553
+ #
554
+ # * `KEN`: Kenya's view on the Ilemi Triangle
555
+ #
556
+ # * `MAR`: Morocco's view on Western Sahara
557
+ #
558
+ # * `RUS`: Russia's view on Crimea
559
+ #
560
+ # * `SDN`: Sudan's view on the Halaib Triangle
561
+ #
562
+ # * `SRB`: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
563
+ #
564
+ # * `SUR`: Suriname's view on the Courantyne Headwaters and Lawa
565
+ # Headwaters
566
+ #
567
+ # * `SYR`: Syria's view on the Golan Heights
568
+ #
569
+ # * `TUR`: Turkey's view on Cyprus and Northern Cyprus
570
+ #
571
+ # * `TZA`: Tanzania's view on Lake Malawi
572
+ #
573
+ # * `URY`: Uruguay's view on Rincon de Artigas
574
+ #
575
+ # * `VNM`: Vietnam's view on the Paracel Islands and Spratly Islands
576
+ #
526
577
  # @option params [String] :intended_use
527
578
  # Indicates if the results will be stored. Defaults to `SingleUse`, if
528
579
  # left empty.
@@ -564,7 +615,7 @@ module Aws::GeoPlaces
564
615
  # resp.pricing_bucket #=> String
565
616
  # resp.result_items #=> Array
566
617
  # 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"
618
+ # 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
619
  # resp.result_items[0].title #=> String
569
620
  # resp.result_items[0].address.label #=> String
570
621
  # resp.result_items[0].address.country.code_2 #=> String
@@ -594,6 +645,8 @@ module Aws::GeoPlaces
594
645
  # resp.result_items[0].address.street_components[0].language #=> String
595
646
  # resp.result_items[0].address.address_number #=> String
596
647
  # resp.result_items[0].address.building #=> String
648
+ # resp.result_items[0].address.secondary_address_components #=> Array
649
+ # resp.result_items[0].address.secondary_address_components[0].number #=> String
597
650
  # resp.result_items[0].distance #=> Integer
598
651
  # resp.result_items[0].language #=> String
599
652
  # resp.result_items[0].political_view #=> String
@@ -680,13 +733,22 @@ module Aws::GeoPlaces
680
733
  req.send_request(options)
681
734
  end
682
735
 
683
- # The `Geocode` action allows you to obtain coordinates, addresses, and
684
- # other information about places.
736
+ # `Geocode` converts a textual address or place into geographic
737
+ # coordinates. You can obtain geographic coordinates, address component,
738
+ # and other related information. It supports flexible queries, including
739
+ # free-form text or structured queries with components like street
740
+ # names, postal codes, and regions. The Geocode API can also provide
741
+ # additional features such as time zone information and the inclusion of
742
+ # political views.
685
743
  #
686
744
  # @option params [String] :query_text
687
745
  # The free-form text query to match addresses against. This is usually a
688
746
  # partially typed address from an end user in an address box or form.
689
747
  #
748
+ # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
749
+ #
750
+ # </note>
751
+ #
690
752
  # @option params [Types::GeocodeQueryComponents] :query_components
691
753
  # A structured free text query allows you to search for places by the
692
754
  # name or text representation of specific properties of the place.
@@ -707,7 +769,7 @@ module Aws::GeoPlaces
707
769
  #
708
770
  # @option params [Types::GeocodeFilter] :filter
709
771
  # A structure which contains a set of inclusion/exclusion properties
710
- # that results must posses in order to be returned as a result.
772
+ # that results must possess in order to be returned as a result.
711
773
  #
712
774
  # @option params [Array<String>] :additional_features
713
775
  # A list of optional additional parameters, such as time zone, that can
@@ -732,6 +794,18 @@ module Aws::GeoPlaces
732
794
  # Indicates if the results will be stored. Defaults to `SingleUse`, if
733
795
  # left empty.
734
796
  #
797
+ # <note markdown="1"> Storing the response of an Geocode query is required to comply with
798
+ # service terms, but charged at a higher cost per request. Please review
799
+ # the [user agreement][1] and [service pricing structure][2] to
800
+ # determine the correct setting for your use case.
801
+ #
802
+ # </note>
803
+ #
804
+ #
805
+ #
806
+ # [1]: https://aws.amazon.com/location/sla/
807
+ # [2]: https://aws.amazon.com/location/pricing/
808
+ #
735
809
  # @option params [String] :key
736
810
  # Optional: The API key to be used for authorization. Either an API key
737
811
  # or valid SigV4 signature must be provided when making a request.
@@ -761,7 +835,7 @@ module Aws::GeoPlaces
761
835
  # include_countries: ["CountryCode"],
762
836
  # include_place_types: ["Locality"], # accepts Locality, PostalCode, Intersection, Street, PointAddress, InterpolatedAddress
763
837
  # },
764
- # additional_features: ["TimeZone"], # accepts TimeZone, Access
838
+ # additional_features: ["TimeZone"], # accepts TimeZone, Access, SecondaryAddresses, Intersections
765
839
  # language: "LanguageTag",
766
840
  # political_view: "CountryCode",
767
841
  # intended_use: "SingleUse", # accepts SingleUse, Storage
@@ -773,7 +847,7 @@ module Aws::GeoPlaces
773
847
  # resp.pricing_bucket #=> String
774
848
  # resp.result_items #=> Array
775
849
  # 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"
850
+ # 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
851
  # resp.result_items[0].title #=> String
778
852
  # resp.result_items[0].address.label #=> String
779
853
  # resp.result_items[0].address.country.code_2 #=> String
@@ -803,6 +877,8 @@ module Aws::GeoPlaces
803
877
  # resp.result_items[0].address.street_components[0].language #=> String
804
878
  # resp.result_items[0].address.address_number #=> String
805
879
  # resp.result_items[0].address.building #=> String
880
+ # resp.result_items[0].address.secondary_address_components #=> Array
881
+ # resp.result_items[0].address.secondary_address_components[0].number #=> String
806
882
  # resp.result_items[0].address_number_corrected #=> Boolean
807
883
  # resp.result_items[0].postal_code_details #=> Array
808
884
  # resp.result_items[0].postal_code_details[0].postal_code #=> String
@@ -846,6 +922,198 @@ module Aws::GeoPlaces
846
922
  # resp.result_items[0].match_scores.components.address.intersection[0] #=> Float
847
923
  # resp.result_items[0].match_scores.components.address.address_number #=> Float
848
924
  # resp.result_items[0].match_scores.components.address.building #=> Float
925
+ # resp.result_items[0].match_scores.components.address.secondary_address_components #=> Array
926
+ # resp.result_items[0].match_scores.components.address.secondary_address_components[0].number #=> Float
927
+ # resp.result_items[0].parsed_query.title #=> Array
928
+ # resp.result_items[0].parsed_query.title[0].start_index #=> Integer
929
+ # resp.result_items[0].parsed_query.title[0].end_index #=> Integer
930
+ # resp.result_items[0].parsed_query.title[0].value #=> String
931
+ # resp.result_items[0].parsed_query.title[0].query_component #=> String
932
+ # resp.result_items[0].parsed_query.address.country #=> Array
933
+ # resp.result_items[0].parsed_query.address.country[0].start_index #=> Integer
934
+ # resp.result_items[0].parsed_query.address.country[0].end_index #=> Integer
935
+ # resp.result_items[0].parsed_query.address.country[0].value #=> String
936
+ # resp.result_items[0].parsed_query.address.country[0].query_component #=> String
937
+ # resp.result_items[0].parsed_query.address.region #=> Array
938
+ # resp.result_items[0].parsed_query.address.region[0].start_index #=> Integer
939
+ # resp.result_items[0].parsed_query.address.region[0].end_index #=> Integer
940
+ # resp.result_items[0].parsed_query.address.region[0].value #=> String
941
+ # resp.result_items[0].parsed_query.address.region[0].query_component #=> String
942
+ # resp.result_items[0].parsed_query.address.sub_region #=> Array
943
+ # resp.result_items[0].parsed_query.address.sub_region[0].start_index #=> Integer
944
+ # resp.result_items[0].parsed_query.address.sub_region[0].end_index #=> Integer
945
+ # resp.result_items[0].parsed_query.address.sub_region[0].value #=> String
946
+ # resp.result_items[0].parsed_query.address.sub_region[0].query_component #=> String
947
+ # resp.result_items[0].parsed_query.address.locality #=> Array
948
+ # resp.result_items[0].parsed_query.address.locality[0].start_index #=> Integer
949
+ # resp.result_items[0].parsed_query.address.locality[0].end_index #=> Integer
950
+ # resp.result_items[0].parsed_query.address.locality[0].value #=> String
951
+ # resp.result_items[0].parsed_query.address.locality[0].query_component #=> String
952
+ # resp.result_items[0].parsed_query.address.district #=> Array
953
+ # resp.result_items[0].parsed_query.address.district[0].start_index #=> Integer
954
+ # resp.result_items[0].parsed_query.address.district[0].end_index #=> Integer
955
+ # resp.result_items[0].parsed_query.address.district[0].value #=> String
956
+ # resp.result_items[0].parsed_query.address.district[0].query_component #=> String
957
+ # resp.result_items[0].parsed_query.address.sub_district #=> Array
958
+ # resp.result_items[0].parsed_query.address.sub_district[0].start_index #=> Integer
959
+ # resp.result_items[0].parsed_query.address.sub_district[0].end_index #=> Integer
960
+ # resp.result_items[0].parsed_query.address.sub_district[0].value #=> String
961
+ # resp.result_items[0].parsed_query.address.sub_district[0].query_component #=> String
962
+ # resp.result_items[0].parsed_query.address.postal_code #=> Array
963
+ # resp.result_items[0].parsed_query.address.postal_code[0].start_index #=> Integer
964
+ # resp.result_items[0].parsed_query.address.postal_code[0].end_index #=> Integer
965
+ # resp.result_items[0].parsed_query.address.postal_code[0].value #=> String
966
+ # resp.result_items[0].parsed_query.address.postal_code[0].query_component #=> String
967
+ # resp.result_items[0].parsed_query.address.block #=> Array
968
+ # resp.result_items[0].parsed_query.address.block[0].start_index #=> Integer
969
+ # resp.result_items[0].parsed_query.address.block[0].end_index #=> Integer
970
+ # resp.result_items[0].parsed_query.address.block[0].value #=> String
971
+ # resp.result_items[0].parsed_query.address.block[0].query_component #=> String
972
+ # resp.result_items[0].parsed_query.address.sub_block #=> Array
973
+ # resp.result_items[0].parsed_query.address.sub_block[0].start_index #=> Integer
974
+ # resp.result_items[0].parsed_query.address.sub_block[0].end_index #=> Integer
975
+ # resp.result_items[0].parsed_query.address.sub_block[0].value #=> String
976
+ # resp.result_items[0].parsed_query.address.sub_block[0].query_component #=> String
977
+ # resp.result_items[0].parsed_query.address.street #=> Array
978
+ # resp.result_items[0].parsed_query.address.street[0].start_index #=> Integer
979
+ # resp.result_items[0].parsed_query.address.street[0].end_index #=> Integer
980
+ # resp.result_items[0].parsed_query.address.street[0].value #=> String
981
+ # resp.result_items[0].parsed_query.address.street[0].query_component #=> String
982
+ # resp.result_items[0].parsed_query.address.address_number #=> Array
983
+ # resp.result_items[0].parsed_query.address.address_number[0].start_index #=> Integer
984
+ # resp.result_items[0].parsed_query.address.address_number[0].end_index #=> Integer
985
+ # resp.result_items[0].parsed_query.address.address_number[0].value #=> String
986
+ # resp.result_items[0].parsed_query.address.address_number[0].query_component #=> String
987
+ # resp.result_items[0].parsed_query.address.building #=> Array
988
+ # resp.result_items[0].parsed_query.address.building[0].start_index #=> Integer
989
+ # resp.result_items[0].parsed_query.address.building[0].end_index #=> Integer
990
+ # resp.result_items[0].parsed_query.address.building[0].value #=> String
991
+ # resp.result_items[0].parsed_query.address.building[0].query_component #=> String
992
+ # resp.result_items[0].parsed_query.address.secondary_address_components #=> Array
993
+ # resp.result_items[0].parsed_query.address.secondary_address_components[0].start_index #=> Integer
994
+ # resp.result_items[0].parsed_query.address.secondary_address_components[0].end_index #=> Integer
995
+ # resp.result_items[0].parsed_query.address.secondary_address_components[0].value #=> String
996
+ # resp.result_items[0].parsed_query.address.secondary_address_components[0].number #=> String
997
+ # resp.result_items[0].parsed_query.address.secondary_address_components[0].designator #=> String
998
+ # resp.result_items[0].intersections #=> Array
999
+ # resp.result_items[0].intersections[0].place_id #=> String
1000
+ # resp.result_items[0].intersections[0].title #=> String
1001
+ # resp.result_items[0].intersections[0].address.label #=> String
1002
+ # resp.result_items[0].intersections[0].address.country.code_2 #=> String
1003
+ # resp.result_items[0].intersections[0].address.country.code_3 #=> String
1004
+ # resp.result_items[0].intersections[0].address.country.name #=> String
1005
+ # resp.result_items[0].intersections[0].address.region.code #=> String
1006
+ # resp.result_items[0].intersections[0].address.region.name #=> String
1007
+ # resp.result_items[0].intersections[0].address.sub_region.code #=> String
1008
+ # resp.result_items[0].intersections[0].address.sub_region.name #=> String
1009
+ # resp.result_items[0].intersections[0].address.locality #=> String
1010
+ # resp.result_items[0].intersections[0].address.district #=> String
1011
+ # resp.result_items[0].intersections[0].address.sub_district #=> String
1012
+ # resp.result_items[0].intersections[0].address.postal_code #=> String
1013
+ # resp.result_items[0].intersections[0].address.block #=> String
1014
+ # resp.result_items[0].intersections[0].address.sub_block #=> String
1015
+ # resp.result_items[0].intersections[0].address.intersection #=> Array
1016
+ # resp.result_items[0].intersections[0].address.intersection[0] #=> String
1017
+ # resp.result_items[0].intersections[0].address.street #=> String
1018
+ # resp.result_items[0].intersections[0].address.street_components #=> Array
1019
+ # resp.result_items[0].intersections[0].address.street_components[0].base_name #=> String
1020
+ # resp.result_items[0].intersections[0].address.street_components[0].type #=> String
1021
+ # resp.result_items[0].intersections[0].address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
1022
+ # resp.result_items[0].intersections[0].address.street_components[0].type_separator #=> String
1023
+ # resp.result_items[0].intersections[0].address.street_components[0].prefix #=> String
1024
+ # resp.result_items[0].intersections[0].address.street_components[0].suffix #=> String
1025
+ # resp.result_items[0].intersections[0].address.street_components[0].direction #=> String
1026
+ # resp.result_items[0].intersections[0].address.street_components[0].language #=> String
1027
+ # resp.result_items[0].intersections[0].address.address_number #=> String
1028
+ # resp.result_items[0].intersections[0].address.building #=> String
1029
+ # resp.result_items[0].intersections[0].address.secondary_address_components #=> Array
1030
+ # resp.result_items[0].intersections[0].address.secondary_address_components[0].number #=> String
1031
+ # resp.result_items[0].intersections[0].position #=> Array
1032
+ # resp.result_items[0].intersections[0].position[0] #=> Float
1033
+ # resp.result_items[0].intersections[0].distance #=> Integer
1034
+ # resp.result_items[0].intersections[0].route_distance #=> Integer
1035
+ # resp.result_items[0].intersections[0].map_view #=> Array
1036
+ # resp.result_items[0].intersections[0].map_view[0] #=> Float
1037
+ # resp.result_items[0].intersections[0].access_points #=> Array
1038
+ # resp.result_items[0].intersections[0].access_points[0].position #=> Array
1039
+ # resp.result_items[0].intersections[0].access_points[0].position[0] #=> Float
1040
+ # resp.result_items[0].main_address.place_id #=> String
1041
+ # 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"
1042
+ # resp.result_items[0].main_address.title #=> String
1043
+ # resp.result_items[0].main_address.address.label #=> String
1044
+ # resp.result_items[0].main_address.address.country.code_2 #=> String
1045
+ # resp.result_items[0].main_address.address.country.code_3 #=> String
1046
+ # resp.result_items[0].main_address.address.country.name #=> String
1047
+ # resp.result_items[0].main_address.address.region.code #=> String
1048
+ # resp.result_items[0].main_address.address.region.name #=> String
1049
+ # resp.result_items[0].main_address.address.sub_region.code #=> String
1050
+ # resp.result_items[0].main_address.address.sub_region.name #=> String
1051
+ # resp.result_items[0].main_address.address.locality #=> String
1052
+ # resp.result_items[0].main_address.address.district #=> String
1053
+ # resp.result_items[0].main_address.address.sub_district #=> String
1054
+ # resp.result_items[0].main_address.address.postal_code #=> String
1055
+ # resp.result_items[0].main_address.address.block #=> String
1056
+ # resp.result_items[0].main_address.address.sub_block #=> String
1057
+ # resp.result_items[0].main_address.address.intersection #=> Array
1058
+ # resp.result_items[0].main_address.address.intersection[0] #=> String
1059
+ # resp.result_items[0].main_address.address.street #=> String
1060
+ # resp.result_items[0].main_address.address.street_components #=> Array
1061
+ # resp.result_items[0].main_address.address.street_components[0].base_name #=> String
1062
+ # resp.result_items[0].main_address.address.street_components[0].type #=> String
1063
+ # resp.result_items[0].main_address.address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
1064
+ # resp.result_items[0].main_address.address.street_components[0].type_separator #=> String
1065
+ # resp.result_items[0].main_address.address.street_components[0].prefix #=> String
1066
+ # resp.result_items[0].main_address.address.street_components[0].suffix #=> String
1067
+ # resp.result_items[0].main_address.address.street_components[0].direction #=> String
1068
+ # resp.result_items[0].main_address.address.street_components[0].language #=> String
1069
+ # resp.result_items[0].main_address.address.address_number #=> String
1070
+ # resp.result_items[0].main_address.address.building #=> String
1071
+ # resp.result_items[0].main_address.address.secondary_address_components #=> Array
1072
+ # resp.result_items[0].main_address.address.secondary_address_components[0].number #=> String
1073
+ # resp.result_items[0].main_address.position #=> Array
1074
+ # resp.result_items[0].main_address.position[0] #=> Float
1075
+ # resp.result_items[0].main_address.access_points #=> Array
1076
+ # resp.result_items[0].main_address.access_points[0].position #=> Array
1077
+ # resp.result_items[0].main_address.access_points[0].position[0] #=> Float
1078
+ # resp.result_items[0].secondary_addresses #=> Array
1079
+ # resp.result_items[0].secondary_addresses[0].place_id #=> String
1080
+ # 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"
1081
+ # resp.result_items[0].secondary_addresses[0].title #=> String
1082
+ # resp.result_items[0].secondary_addresses[0].address.label #=> String
1083
+ # resp.result_items[0].secondary_addresses[0].address.country.code_2 #=> String
1084
+ # resp.result_items[0].secondary_addresses[0].address.country.code_3 #=> String
1085
+ # resp.result_items[0].secondary_addresses[0].address.country.name #=> String
1086
+ # resp.result_items[0].secondary_addresses[0].address.region.code #=> String
1087
+ # resp.result_items[0].secondary_addresses[0].address.region.name #=> String
1088
+ # resp.result_items[0].secondary_addresses[0].address.sub_region.code #=> String
1089
+ # resp.result_items[0].secondary_addresses[0].address.sub_region.name #=> String
1090
+ # resp.result_items[0].secondary_addresses[0].address.locality #=> String
1091
+ # resp.result_items[0].secondary_addresses[0].address.district #=> String
1092
+ # resp.result_items[0].secondary_addresses[0].address.sub_district #=> String
1093
+ # resp.result_items[0].secondary_addresses[0].address.postal_code #=> String
1094
+ # resp.result_items[0].secondary_addresses[0].address.block #=> String
1095
+ # resp.result_items[0].secondary_addresses[0].address.sub_block #=> String
1096
+ # resp.result_items[0].secondary_addresses[0].address.intersection #=> Array
1097
+ # resp.result_items[0].secondary_addresses[0].address.intersection[0] #=> String
1098
+ # resp.result_items[0].secondary_addresses[0].address.street #=> String
1099
+ # resp.result_items[0].secondary_addresses[0].address.street_components #=> Array
1100
+ # resp.result_items[0].secondary_addresses[0].address.street_components[0].base_name #=> String
1101
+ # resp.result_items[0].secondary_addresses[0].address.street_components[0].type #=> String
1102
+ # resp.result_items[0].secondary_addresses[0].address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
1103
+ # resp.result_items[0].secondary_addresses[0].address.street_components[0].type_separator #=> String
1104
+ # resp.result_items[0].secondary_addresses[0].address.street_components[0].prefix #=> String
1105
+ # resp.result_items[0].secondary_addresses[0].address.street_components[0].suffix #=> String
1106
+ # resp.result_items[0].secondary_addresses[0].address.street_components[0].direction #=> String
1107
+ # resp.result_items[0].secondary_addresses[0].address.street_components[0].language #=> String
1108
+ # resp.result_items[0].secondary_addresses[0].address.address_number #=> String
1109
+ # resp.result_items[0].secondary_addresses[0].address.building #=> String
1110
+ # resp.result_items[0].secondary_addresses[0].address.secondary_address_components #=> Array
1111
+ # resp.result_items[0].secondary_addresses[0].address.secondary_address_components[0].number #=> String
1112
+ # resp.result_items[0].secondary_addresses[0].position #=> Array
1113
+ # resp.result_items[0].secondary_addresses[0].position[0] #=> Float
1114
+ # resp.result_items[0].secondary_addresses[0].access_points #=> Array
1115
+ # resp.result_items[0].secondary_addresses[0].access_points[0].position #=> Array
1116
+ # resp.result_items[0].secondary_addresses[0].access_points[0].position[0] #=> Float
849
1117
  #
850
1118
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Geocode AWS API Documentation
851
1119
  #
@@ -856,8 +1124,8 @@ module Aws::GeoPlaces
856
1124
  req.send_request(options)
857
1125
  end
858
1126
 
859
- # Finds a place by its unique ID. A `PlaceId` is returned by other place
860
- # operations.
1127
+ # `GetPlace` finds a place by its unique ID. A `PlaceId` is returned by
1128
+ # other place operations.
861
1129
  #
862
1130
  # @option params [required, String] :place_id
863
1131
  # The `PlaceId` of the place you wish to receive the information for.
@@ -885,6 +1153,18 @@ module Aws::GeoPlaces
885
1153
  # Indicates if the results will be stored. Defaults to `SingleUse`, if
886
1154
  # left empty.
887
1155
  #
1156
+ # <note markdown="1"> Storing the response of an GetPlace query is required to comply with
1157
+ # service terms, but charged at a higher cost per request. Please review
1158
+ # the [user agreement][1] and [service pricing structure][2] to
1159
+ # determine the correct setting for your use case.
1160
+ #
1161
+ # </note>
1162
+ #
1163
+ #
1164
+ #
1165
+ # [1]: https://aws.amazon.com/location/sla/
1166
+ # [2]: https://aws.amazon.com/location/pricing/
1167
+ #
888
1168
  # @option params [String] :key
889
1169
  # Optional: The API key to be used for authorization. Either an API key
890
1170
  # or valid SigV4 signature must be provided when making a request.
@@ -910,12 +1190,14 @@ module Aws::GeoPlaces
910
1190
  # * {Types::GetPlaceResponse#time_zone #time_zone} => Types::TimeZone
911
1191
  # * {Types::GetPlaceResponse#political_view #political_view} => String
912
1192
  # * {Types::GetPlaceResponse#phonemes #phonemes} => Types::PhonemeDetails
1193
+ # * {Types::GetPlaceResponse#main_address #main_address} => Types::RelatedPlace
1194
+ # * {Types::GetPlaceResponse#secondary_addresses #secondary_addresses} => Array&lt;Types::RelatedPlace&gt;
913
1195
  #
914
1196
  # @example Request syntax with placeholder values
915
1197
  #
916
1198
  # resp = client.get_place({
917
1199
  # place_id: "GetPlaceRequestPlaceIdString", # required
918
- # additional_features: ["TimeZone"], # accepts TimeZone, Phonemes, Access, Contact
1200
+ # additional_features: ["TimeZone"], # accepts TimeZone, Phonemes, Access, Contact, SecondaryAddresses
919
1201
  # language: "LanguageTag",
920
1202
  # political_view: "CountryCode",
921
1203
  # intended_use: "SingleUse", # accepts SingleUse, Storage
@@ -925,7 +1207,7 @@ module Aws::GeoPlaces
925
1207
  # @example Response structure
926
1208
  #
927
1209
  # 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"
1210
+ # resp.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
929
1211
  # resp.title #=> String
930
1212
  # resp.pricing_bucket #=> String
931
1213
  # resp.address.label #=> String
@@ -956,6 +1238,8 @@ module Aws::GeoPlaces
956
1238
  # resp.address.street_components[0].language #=> String
957
1239
  # resp.address.address_number #=> String
958
1240
  # resp.address.building #=> String
1241
+ # resp.address.secondary_address_components #=> Array
1242
+ # resp.address.secondary_address_components[0].number #=> String
959
1243
  # resp.address_number_corrected #=> Boolean
960
1244
  # resp.postal_code_details #=> Array
961
1245
  # resp.postal_code_details[0].postal_code #=> String
@@ -1078,6 +1362,83 @@ module Aws::GeoPlaces
1078
1362
  # resp.phonemes.address.street[0].value #=> String
1079
1363
  # resp.phonemes.address.street[0].language #=> String
1080
1364
  # resp.phonemes.address.street[0].preferred #=> Boolean
1365
+ # resp.main_address.place_id #=> String
1366
+ # resp.main_address.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
1367
+ # resp.main_address.title #=> String
1368
+ # resp.main_address.address.label #=> String
1369
+ # resp.main_address.address.country.code_2 #=> String
1370
+ # resp.main_address.address.country.code_3 #=> String
1371
+ # resp.main_address.address.country.name #=> String
1372
+ # resp.main_address.address.region.code #=> String
1373
+ # resp.main_address.address.region.name #=> String
1374
+ # resp.main_address.address.sub_region.code #=> String
1375
+ # resp.main_address.address.sub_region.name #=> String
1376
+ # resp.main_address.address.locality #=> String
1377
+ # resp.main_address.address.district #=> String
1378
+ # resp.main_address.address.sub_district #=> String
1379
+ # resp.main_address.address.postal_code #=> String
1380
+ # resp.main_address.address.block #=> String
1381
+ # resp.main_address.address.sub_block #=> String
1382
+ # resp.main_address.address.intersection #=> Array
1383
+ # resp.main_address.address.intersection[0] #=> String
1384
+ # resp.main_address.address.street #=> String
1385
+ # resp.main_address.address.street_components #=> Array
1386
+ # resp.main_address.address.street_components[0].base_name #=> String
1387
+ # resp.main_address.address.street_components[0].type #=> String
1388
+ # resp.main_address.address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
1389
+ # resp.main_address.address.street_components[0].type_separator #=> String
1390
+ # resp.main_address.address.street_components[0].prefix #=> String
1391
+ # resp.main_address.address.street_components[0].suffix #=> String
1392
+ # resp.main_address.address.street_components[0].direction #=> String
1393
+ # resp.main_address.address.street_components[0].language #=> String
1394
+ # resp.main_address.address.address_number #=> String
1395
+ # resp.main_address.address.building #=> String
1396
+ # resp.main_address.address.secondary_address_components #=> Array
1397
+ # resp.main_address.address.secondary_address_components[0].number #=> String
1398
+ # resp.main_address.position #=> Array
1399
+ # resp.main_address.position[0] #=> Float
1400
+ # resp.main_address.access_points #=> Array
1401
+ # resp.main_address.access_points[0].position #=> Array
1402
+ # resp.main_address.access_points[0].position[0] #=> Float
1403
+ # resp.secondary_addresses #=> Array
1404
+ # resp.secondary_addresses[0].place_id #=> String
1405
+ # resp.secondary_addresses[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
1406
+ # resp.secondary_addresses[0].title #=> String
1407
+ # resp.secondary_addresses[0].address.label #=> String
1408
+ # resp.secondary_addresses[0].address.country.code_2 #=> String
1409
+ # resp.secondary_addresses[0].address.country.code_3 #=> String
1410
+ # resp.secondary_addresses[0].address.country.name #=> String
1411
+ # resp.secondary_addresses[0].address.region.code #=> String
1412
+ # resp.secondary_addresses[0].address.region.name #=> String
1413
+ # resp.secondary_addresses[0].address.sub_region.code #=> String
1414
+ # resp.secondary_addresses[0].address.sub_region.name #=> String
1415
+ # resp.secondary_addresses[0].address.locality #=> String
1416
+ # resp.secondary_addresses[0].address.district #=> String
1417
+ # resp.secondary_addresses[0].address.sub_district #=> String
1418
+ # resp.secondary_addresses[0].address.postal_code #=> String
1419
+ # resp.secondary_addresses[0].address.block #=> String
1420
+ # resp.secondary_addresses[0].address.sub_block #=> String
1421
+ # resp.secondary_addresses[0].address.intersection #=> Array
1422
+ # resp.secondary_addresses[0].address.intersection[0] #=> String
1423
+ # resp.secondary_addresses[0].address.street #=> String
1424
+ # resp.secondary_addresses[0].address.street_components #=> Array
1425
+ # resp.secondary_addresses[0].address.street_components[0].base_name #=> String
1426
+ # resp.secondary_addresses[0].address.street_components[0].type #=> String
1427
+ # resp.secondary_addresses[0].address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
1428
+ # resp.secondary_addresses[0].address.street_components[0].type_separator #=> String
1429
+ # resp.secondary_addresses[0].address.street_components[0].prefix #=> String
1430
+ # resp.secondary_addresses[0].address.street_components[0].suffix #=> String
1431
+ # resp.secondary_addresses[0].address.street_components[0].direction #=> String
1432
+ # resp.secondary_addresses[0].address.street_components[0].language #=> String
1433
+ # resp.secondary_addresses[0].address.address_number #=> String
1434
+ # resp.secondary_addresses[0].address.building #=> String
1435
+ # resp.secondary_addresses[0].address.secondary_address_components #=> Array
1436
+ # resp.secondary_addresses[0].address.secondary_address_components[0].number #=> String
1437
+ # resp.secondary_addresses[0].position #=> Array
1438
+ # resp.secondary_addresses[0].position[0] #=> Float
1439
+ # resp.secondary_addresses[0].access_points #=> Array
1440
+ # resp.secondary_addresses[0].access_points[0].position #=> Array
1441
+ # resp.secondary_addresses[0].access_points[0].position[0] #=> Float
1081
1442
  #
1082
1443
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GetPlace AWS API Documentation
1083
1444
  #
@@ -1088,12 +1449,17 @@ module Aws::GeoPlaces
1088
1449
  req.send_request(options)
1089
1450
  end
1090
1451
 
1091
- # The `ReverseGeocode` operation allows you to retrieve addresses and
1092
- # place information from coordinates.
1452
+ # `ReverseGeocode` converts geographic coordinates into a human-readable
1453
+ # address or place. You can obtain address component, and other related
1454
+ # information such as place type, category, street information. The
1455
+ # Reverse Geocode API supports filtering to on place type so that you
1456
+ # can refine result based on your need. Also, The Reverse Geocode API
1457
+ # can also provide additional features such as time zone information and
1458
+ # the inclusion of political views.
1093
1459
  #
1094
1460
  # @option params [required, Array<Float>] :query_position
1095
1461
  # The position, in `[lng, lat]` for which you are querying nearby
1096
- # resultsfor. Results closer to the position will be ranked higher then
1462
+ # results for. Results closer to the position will be ranked higher then
1097
1463
  # results further away from the position
1098
1464
  #
1099
1465
  # @option params [Integer] :query_radius
@@ -1105,7 +1471,7 @@ module Aws::GeoPlaces
1105
1471
  #
1106
1472
  # @option params [Types::ReverseGeocodeFilter] :filter
1107
1473
  # A structure which contains a set of inclusion/exclusion properties
1108
- # that results must posses in order to be returned as a result.
1474
+ # that results must possess in order to be returned as a result.
1109
1475
  #
1110
1476
  # @option params [Array<String>] :additional_features
1111
1477
  # A list of optional additional parameters, such as time zone that can
@@ -1130,6 +1496,18 @@ module Aws::GeoPlaces
1130
1496
  # Indicates if the results will be stored. Defaults to `SingleUse`, if
1131
1497
  # left empty.
1132
1498
  #
1499
+ # <note markdown="1"> Storing the response of an ReverseGeocode query is required to comply
1500
+ # with service terms, but charged at a higher cost per request. Please
1501
+ # review the [user agreement][1] and [service pricing structure][2] to
1502
+ # determine the correct setting for your use case.
1503
+ #
1504
+ # </note>
1505
+ #
1506
+ #
1507
+ #
1508
+ # [1]: https://aws.amazon.com/location/sla/
1509
+ # [2]: https://aws.amazon.com/location/pricing/
1510
+ #
1133
1511
  # @option params [String] :key
1134
1512
  # Optional: The API key to be used for authorization. Either an API key
1135
1513
  # or valid SigV4 signature must be provided when making a request.
@@ -1148,7 +1526,7 @@ module Aws::GeoPlaces
1148
1526
  # filter: {
1149
1527
  # include_place_types: ["Locality"], # accepts Locality, Intersection, Street, PointAddress, InterpolatedAddress
1150
1528
  # },
1151
- # additional_features: ["TimeZone"], # accepts TimeZone, Access
1529
+ # additional_features: ["TimeZone"], # accepts TimeZone, Access, Intersections
1152
1530
  # language: "LanguageTag",
1153
1531
  # political_view: "CountryCode",
1154
1532
  # intended_use: "SingleUse", # accepts SingleUse, Storage
@@ -1160,7 +1538,7 @@ module Aws::GeoPlaces
1160
1538
  # resp.pricing_bucket #=> String
1161
1539
  # resp.result_items #=> Array
1162
1540
  # 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"
1541
+ # 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
1542
  # resp.result_items[0].title #=> String
1165
1543
  # resp.result_items[0].address.label #=> String
1166
1544
  # resp.result_items[0].address.country.code_2 #=> String
@@ -1190,6 +1568,8 @@ module Aws::GeoPlaces
1190
1568
  # resp.result_items[0].address.street_components[0].language #=> String
1191
1569
  # resp.result_items[0].address.address_number #=> String
1192
1570
  # resp.result_items[0].address.building #=> String
1571
+ # resp.result_items[0].address.secondary_address_components #=> Array
1572
+ # resp.result_items[0].address.secondary_address_components[0].number #=> String
1193
1573
  # resp.result_items[0].address_number_corrected #=> Boolean
1194
1574
  # resp.result_items[0].postal_code_details #=> Array
1195
1575
  # resp.result_items[0].postal_code_details[0].postal_code #=> String
@@ -1218,6 +1598,48 @@ module Aws::GeoPlaces
1218
1598
  # resp.result_items[0].time_zone.offset #=> String
1219
1599
  # resp.result_items[0].time_zone.offset_seconds #=> Integer
1220
1600
  # resp.result_items[0].political_view #=> String
1601
+ # resp.result_items[0].intersections #=> Array
1602
+ # resp.result_items[0].intersections[0].place_id #=> String
1603
+ # resp.result_items[0].intersections[0].title #=> String
1604
+ # resp.result_items[0].intersections[0].address.label #=> String
1605
+ # resp.result_items[0].intersections[0].address.country.code_2 #=> String
1606
+ # resp.result_items[0].intersections[0].address.country.code_3 #=> String
1607
+ # resp.result_items[0].intersections[0].address.country.name #=> String
1608
+ # resp.result_items[0].intersections[0].address.region.code #=> String
1609
+ # resp.result_items[0].intersections[0].address.region.name #=> String
1610
+ # resp.result_items[0].intersections[0].address.sub_region.code #=> String
1611
+ # resp.result_items[0].intersections[0].address.sub_region.name #=> String
1612
+ # resp.result_items[0].intersections[0].address.locality #=> String
1613
+ # resp.result_items[0].intersections[0].address.district #=> String
1614
+ # resp.result_items[0].intersections[0].address.sub_district #=> String
1615
+ # resp.result_items[0].intersections[0].address.postal_code #=> String
1616
+ # resp.result_items[0].intersections[0].address.block #=> String
1617
+ # resp.result_items[0].intersections[0].address.sub_block #=> String
1618
+ # resp.result_items[0].intersections[0].address.intersection #=> Array
1619
+ # resp.result_items[0].intersections[0].address.intersection[0] #=> String
1620
+ # resp.result_items[0].intersections[0].address.street #=> String
1621
+ # resp.result_items[0].intersections[0].address.street_components #=> Array
1622
+ # resp.result_items[0].intersections[0].address.street_components[0].base_name #=> String
1623
+ # resp.result_items[0].intersections[0].address.street_components[0].type #=> String
1624
+ # resp.result_items[0].intersections[0].address.street_components[0].type_placement #=> String, one of "BeforeBaseName", "AfterBaseName"
1625
+ # resp.result_items[0].intersections[0].address.street_components[0].type_separator #=> String
1626
+ # resp.result_items[0].intersections[0].address.street_components[0].prefix #=> String
1627
+ # resp.result_items[0].intersections[0].address.street_components[0].suffix #=> String
1628
+ # resp.result_items[0].intersections[0].address.street_components[0].direction #=> String
1629
+ # resp.result_items[0].intersections[0].address.street_components[0].language #=> String
1630
+ # resp.result_items[0].intersections[0].address.address_number #=> String
1631
+ # resp.result_items[0].intersections[0].address.building #=> String
1632
+ # resp.result_items[0].intersections[0].address.secondary_address_components #=> Array
1633
+ # resp.result_items[0].intersections[0].address.secondary_address_components[0].number #=> String
1634
+ # resp.result_items[0].intersections[0].position #=> Array
1635
+ # resp.result_items[0].intersections[0].position[0] #=> Float
1636
+ # resp.result_items[0].intersections[0].distance #=> Integer
1637
+ # resp.result_items[0].intersections[0].route_distance #=> Integer
1638
+ # resp.result_items[0].intersections[0].map_view #=> Array
1639
+ # resp.result_items[0].intersections[0].map_view[0] #=> Float
1640
+ # resp.result_items[0].intersections[0].access_points #=> Array
1641
+ # resp.result_items[0].intersections[0].access_points[0].position #=> Array
1642
+ # resp.result_items[0].intersections[0].access_points[0].position[0] #=> Float
1221
1643
  #
1222
1644
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ReverseGeocode AWS API Documentation
1223
1645
  #
@@ -1228,23 +1650,32 @@ module Aws::GeoPlaces
1228
1650
  req.send_request(options)
1229
1651
  end
1230
1652
 
1231
- # Search nearby a specified location.
1653
+ # `SearchNearby` queries for points of interest within a radius from a
1654
+ # central coordinates, returning place results with optional filters
1655
+ # such as categories, business chains, food types and more. The API
1656
+ # returns details such as a place name, address, phone, category, food
1657
+ # type, contact, opening hours. Also, the API can return phonemes, time
1658
+ # zones and more based on requested parameters.
1232
1659
  #
1233
1660
  # @option params [required, Array<Float>] :query_position
1234
1661
  # The position, in `[lng, lat]` for which you are querying nearby
1235
- # resultsfor. Results closer to the position will be ranked higher then
1662
+ # results for. Results closer to the position will be ranked higher then
1236
1663
  # results further away from the position
1237
1664
  #
1238
1665
  # @option params [Integer] :query_radius
1239
1666
  # The maximum distance in meters from the QueryPosition from which a
1240
1667
  # result will be returned.
1241
1668
  #
1669
+ # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
1670
+ #
1671
+ # </note>
1672
+ #
1242
1673
  # @option params [Integer] :max_results
1243
1674
  # An optional limit for the number of results returned in a single call.
1244
1675
  #
1245
1676
  # @option params [Types::SearchNearbyFilter] :filter
1246
1677
  # A structure which contains a set of inclusion/exclusion properties
1247
- # that results must posses in order to be returned as a result.
1678
+ # that results must possess in order to be returned as a result.
1248
1679
  #
1249
1680
  # @option params [Array<String>] :additional_features
1250
1681
  # A list of optional additional parameters, such as time zone, that can
@@ -1269,6 +1700,18 @@ module Aws::GeoPlaces
1269
1700
  # Indicates if the results will be stored. Defaults to `SingleUse`, if
1270
1701
  # left empty.
1271
1702
  #
1703
+ # <note markdown="1"> Storing the response of an SearchNearby query is required to comply
1704
+ # with service terms, but charged at a higher cost per request. Please
1705
+ # review the [user agreement][1] and [service pricing structure][2] to
1706
+ # determine the correct setting for your use case.
1707
+ #
1708
+ # </note>
1709
+ #
1710
+ #
1711
+ #
1712
+ # [1]: https://aws.amazon.com/location/sla/
1713
+ # [2]: https://aws.amazon.com/location/pricing/
1714
+ #
1272
1715
  # @option params [String] :next_token
1273
1716
  # If `nextToken` is returned, there are more results available. The
1274
1717
  # value of `nextToken` is a unique pagination token for each page.
@@ -1312,7 +1755,7 @@ module Aws::GeoPlaces
1312
1755
  # resp.pricing_bucket #=> String
1313
1756
  # resp.result_items #=> Array
1314
1757
  # 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"
1758
+ # 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
1759
  # resp.result_items[0].title #=> String
1317
1760
  # resp.result_items[0].address.label #=> String
1318
1761
  # resp.result_items[0].address.country.code_2 #=> String
@@ -1342,6 +1785,8 @@ module Aws::GeoPlaces
1342
1785
  # resp.result_items[0].address.street_components[0].language #=> String
1343
1786
  # resp.result_items[0].address.address_number #=> String
1344
1787
  # resp.result_items[0].address.building #=> String
1788
+ # resp.result_items[0].address.secondary_address_components #=> Array
1789
+ # resp.result_items[0].address.secondary_address_components[0].number #=> String
1345
1790
  # resp.result_items[0].address_number_corrected #=> Boolean
1346
1791
  # resp.result_items[0].position #=> Array
1347
1792
  # resp.result_items[0].position[0] #=> Float
@@ -1470,16 +1915,26 @@ module Aws::GeoPlaces
1470
1915
  req.send_request(options)
1471
1916
  end
1472
1917
 
1473
- # Use the `SearchText` operation to search for geocode and place
1474
- # information. You can then complete a follow-up query suggested from
1475
- # the `Suggest` API via a query id.
1918
+ # `SearchText` searches for geocode and place information. You can then
1919
+ # complete a follow-up query suggested from the `Suggest` API via a
1920
+ # query id.
1476
1921
  #
1477
1922
  # @option params [String] :query_text
1478
1923
  # The free-form text query to match addresses against. This is usually a
1479
1924
  # partially typed address from an end user in an address box or form.
1480
1925
  #
1926
+ # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
1927
+ #
1928
+ # </note>
1929
+ #
1481
1930
  # @option params [String] :query_id
1482
- # The query Id.
1931
+ # The query Id returned by the suggest API. If passed in the request,
1932
+ # the SearchText API will preform a SearchText query with the improved
1933
+ # query terms for the original query made to the suggest API.
1934
+ #
1935
+ # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
1936
+ #
1937
+ # </note>
1483
1938
  #
1484
1939
  # @option params [Integer] :max_results
1485
1940
  # An optional limit for the number of results returned in a single call.
@@ -1497,7 +1952,7 @@ module Aws::GeoPlaces
1497
1952
  #
1498
1953
  # @option params [Types::SearchTextFilter] :filter
1499
1954
  # A structure which contains a set of inclusion/exclusion properties
1500
- # that results must posses in order to be returned as a result.
1955
+ # that results must possess in order to be returned as a result.
1501
1956
  #
1502
1957
  # @option params [Array<String>] :additional_features
1503
1958
  # A list of optional additional parameters, such as time zone, that can
@@ -1522,6 +1977,18 @@ module Aws::GeoPlaces
1522
1977
  # Indicates if the results will be stored. Defaults to `SingleUse`, if
1523
1978
  # left empty.
1524
1979
  #
1980
+ # <note markdown="1"> Storing the response of an SearchText query is required to comply with
1981
+ # service terms, but charged at a higher cost per request. Please review
1982
+ # the [user agreement][1] and [service pricing structure][2] to
1983
+ # determine the correct setting for your use case.
1984
+ #
1985
+ # </note>
1986
+ #
1987
+ #
1988
+ #
1989
+ # [1]: https://aws.amazon.com/location/sla/
1990
+ # [2]: https://aws.amazon.com/location/pricing/
1991
+ #
1525
1992
  # @option params [String] :next_token
1526
1993
  # If `nextToken` is returned, there are more results available. The
1527
1994
  # value of `nextToken` is a unique pagination token for each page.
@@ -1564,7 +2031,7 @@ module Aws::GeoPlaces
1564
2031
  # resp.pricing_bucket #=> String
1565
2032
  # resp.result_items #=> Array
1566
2033
  # 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"
2034
+ # 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
2035
  # resp.result_items[0].title #=> String
1569
2036
  # resp.result_items[0].address.label #=> String
1570
2037
  # resp.result_items[0].address.country.code_2 #=> String
@@ -1594,6 +2061,8 @@ module Aws::GeoPlaces
1594
2061
  # resp.result_items[0].address.street_components[0].language #=> String
1595
2062
  # resp.result_items[0].address.address_number #=> String
1596
2063
  # resp.result_items[0].address.building #=> String
2064
+ # resp.result_items[0].address.secondary_address_components #=> Array
2065
+ # resp.result_items[0].address.secondary_address_components[0].number #=> String
1597
2066
  # resp.result_items[0].address_number_corrected #=> Boolean
1598
2067
  # resp.result_items[0].position #=> Array
1599
2068
  # resp.result_items[0].position[0] #=> Float
@@ -1722,14 +2191,26 @@ module Aws::GeoPlaces
1722
2191
  req.send_request(options)
1723
2192
  end
1724
2193
 
1725
- # The `Suggest` operation finds addresses or place candidates based on
1726
- # incomplete or misspelled queries. You then select the best query to
1727
- # submit based on the returned results.
2194
+ # `Suggest` provides intelligent predictions or recommendations based on
2195
+ # the user's input or context, such as relevant places, points of
2196
+ # interest, query terms or search category. It is designed to help users
2197
+ # find places or point of interests candidates or identify a follow on
2198
+ # query based on incomplete or misspelled queries. It returns a list of
2199
+ # possible matches or refinements that can be used to formulate a more
2200
+ # accurate query. Users can select the most appropriate suggestion and
2201
+ # use it for further searching. The API provides options for filtering
2202
+ # results by location and other attributes, and allows for additional
2203
+ # features like phonemes and timezones. The response includes refined
2204
+ # query terms and detailed place information.
1728
2205
  #
1729
2206
  # @option params [required, String] :query_text
1730
2207
  # The free-form text query to match addresses against. This is usually a
1731
2208
  # partially typed address from an end user in an address box or form.
1732
2209
  #
2210
+ # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
2211
+ #
2212
+ # </note>
2213
+ #
1733
2214
  # @option params [Integer] :max_results
1734
2215
  # An optional limit for the number of results returned in a single call.
1735
2216
  #
@@ -1750,7 +2231,7 @@ module Aws::GeoPlaces
1750
2231
  #
1751
2232
  # @option params [Types::SuggestFilter] :filter
1752
2233
  # A structure which contains a set of inclusion/exclusion properties
1753
- # that results must posses in order to be returned as a result.
2234
+ # that results must possess in order to be returned as a result.
1754
2235
  #
1755
2236
  # @option params [Array<String>] :additional_features
1756
2237
  # A list of optional additional parameters, such as time zone, that can
@@ -1814,7 +2295,7 @@ module Aws::GeoPlaces
1814
2295
  # resp.result_items[0].title #=> String
1815
2296
  # resp.result_items[0].suggest_result_item_type #=> String, one of "Place", "Query"
1816
2297
  # 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"
2298
+ # 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
2299
  # resp.result_items[0].place.address.label #=> String
1819
2300
  # resp.result_items[0].place.address.country.code_2 #=> String
1820
2301
  # resp.result_items[0].place.address.country.code_3 #=> String
@@ -1843,6 +2324,8 @@ module Aws::GeoPlaces
1843
2324
  # resp.result_items[0].place.address.street_components[0].language #=> String
1844
2325
  # resp.result_items[0].place.address.address_number #=> String
1845
2326
  # resp.result_items[0].place.address.building #=> String
2327
+ # resp.result_items[0].place.address.secondary_address_components #=> Array
2328
+ # resp.result_items[0].place.address.secondary_address_components[0].number #=> String
1846
2329
  # resp.result_items[0].place.position #=> Array
1847
2330
  # resp.result_items[0].place.position[0] #=> Float
1848
2331
  # resp.result_items[0].place.distance #=> Integer
@@ -1957,7 +2440,7 @@ module Aws::GeoPlaces
1957
2440
  tracer: tracer
1958
2441
  )
1959
2442
  context[:gem_name] = 'aws-sdk-geoplaces'
1960
- context[:gem_version] = '1.7.0'
2443
+ context[:gem_version] = '1.9.0'
1961
2444
  Seahorse::Client::Request.new(handlers, context)
1962
2445
  end
1963
2446