aws-sdk-geoplaces 1.16.0 → 1.17.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7879cbadb80cdd5ead1d8365733583d4f7ecc46d53fa1ea305d66bb6d0ca5e9d
4
- data.tar.gz: 6e11b466acae21450fae7d70b966cdc4b3313680bb8da8419f186cefa2c5b46f
3
+ metadata.gz: da0c0bfba498229df98772558d74661863a08533fc2ce88bbd96956395511785
4
+ data.tar.gz: 2a2f7e91c44c53d097b74c017a8ad563eee42dc05f002790b9a97ddc644bff36
5
5
  SHA512:
6
- metadata.gz: a0818821e341f4b69c27179986f13bd18d5476f625a314c0e31d4eddd59c81bd8812d79c5b9535a7a0c678741b04460320a8bb9c5598d9d8de5e1073fd1d47a2
7
- data.tar.gz: 0a15c8d986de161e627211cdc88458115c56645910294b585a89c0e6c201cf5779aaca392272e231389790032f4022a661bfde399751c2b6ea9bc0ec2783f0c2
6
+ metadata.gz: ed887d1f84d4419a35a32a43e0465026bf8ac535d49876403ac54a508b88fcfa19d408bd8e0c0efba28944a042056adcbc88ad2ca8af757db52d5d87ee0207b7
7
+ data.tar.gz: 467ca7ed31b77941ca45ec42c0267ca911e630ce15e9b47305075efc6107e9ee025c6b425efcb74b03740563b2cffea48a9bba5dcdffa760afb28bd1ee52d64d
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.17.0 (2025-12-23)
5
+ ------------------
6
+
7
+ * Feature - Adds support for InferredSecondaryAddress place type, Designator in SecondaryAddressComponent and Heading in ReverseGeocode.
8
+
4
9
  1.16.0 (2025-11-21)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.16.0
1
+ 1.17.0
@@ -485,6 +485,13 @@ module Aws::GeoPlaces
485
485
  # can be tailored using optional parameters like language and political
486
486
  # views.
487
487
  #
488
+ # For more information, see [Autocomplete][1] in the *Amazon Location
489
+ # Service Developer Guide*.
490
+ #
491
+ #
492
+ #
493
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/autocomplete.html
494
+ #
488
495
  # @option params [required, String] :query_text
489
496
  # The free-form text query to match addresses against. This is usually a
490
497
  # partially typed address from an end user in an address box or form.
@@ -496,11 +503,13 @@ module Aws::GeoPlaces
496
503
  # @option params [Integer] :max_results
497
504
  # An optional limit for the number of results returned in a single call.
498
505
  #
506
+ # Default value: 5
507
+ #
499
508
  # @option params [Array<Float>] :bias_position
500
509
  # The position in longitude and latitude that the results should be
501
510
  # close to. Typically, place results returned are ranked higher the
502
511
  # closer they are to this position. Stored in `[lng, lat]` and in the
503
- # WSG84 format.
512
+ # WGS 84 format.
504
513
  #
505
514
  # <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle` are
506
515
  # mutually exclusive.
@@ -612,7 +621,7 @@ module Aws::GeoPlaces
612
621
  # resp.pricing_bucket #=> String
613
622
  # resp.result_items #=> Array
614
623
  # resp.result_items[0].place_id #=> String
615
- # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
624
+ # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress"
616
625
  # resp.result_items[0].title #=> String
617
626
  # resp.result_items[0].address.label #=> String
618
627
  # resp.result_items[0].address.country.code_2 #=> String
@@ -644,6 +653,7 @@ module Aws::GeoPlaces
644
653
  # resp.result_items[0].address.building #=> String
645
654
  # resp.result_items[0].address.secondary_address_components #=> Array
646
655
  # resp.result_items[0].address.secondary_address_components[0].number #=> String
656
+ # resp.result_items[0].address.secondary_address_components[0].designator #=> String
647
657
  # resp.result_items[0].distance #=> Integer
648
658
  # resp.result_items[0].language #=> String
649
659
  # resp.result_items[0].political_view #=> String
@@ -738,14 +748,17 @@ module Aws::GeoPlaces
738
748
  # additional features such as time zone information and the inclusion of
739
749
  # political views.
740
750
  #
751
+ # For more information, see [Geocode][1] in the *Amazon Location Service
752
+ # Developer Guide*.
753
+ #
754
+ #
755
+ #
756
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/geocode.html
757
+ #
741
758
  # @option params [String] :query_text
742
759
  # The free-form text query to match addresses against. This is usually a
743
760
  # partially typed address from an end user in an address box or form.
744
761
  #
745
- # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
746
- #
747
- # </note>
748
- #
749
762
  # @option params [Types::GeocodeQueryComponents] :query_components
750
763
  # A structured free text query allows you to search for places by the
751
764
  # name or text representation of specific properties of the place.
@@ -753,16 +766,13 @@ module Aws::GeoPlaces
753
766
  # @option params [Integer] :max_results
754
767
  # An optional limit for the number of results returned in a single call.
755
768
  #
769
+ # Default value: 20
770
+ #
756
771
  # @option params [Array<Float>] :bias_position
757
772
  # The position, in longitude and latitude, that the results should be
758
773
  # close to. Typically, place results returned are ranked higher the
759
774
  # closer they are to this position. Stored in `[lng, lat]` and in the
760
- # WSG84 format.
761
- #
762
- # <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle` are
763
- # mutually exclusive.
764
- #
765
- # </note>
775
+ # WGS 84 format.
766
776
  #
767
777
  # @option params [Types::GeocodeFilter] :filter
768
778
  # A structure which contains a set of inclusion/exclusion properties
@@ -844,7 +854,7 @@ module Aws::GeoPlaces
844
854
  # resp.pricing_bucket #=> String
845
855
  # resp.result_items #=> Array
846
856
  # resp.result_items[0].place_id #=> String
847
- # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
857
+ # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress"
848
858
  # resp.result_items[0].title #=> String
849
859
  # resp.result_items[0].address.label #=> String
850
860
  # resp.result_items[0].address.country.code_2 #=> String
@@ -876,6 +886,7 @@ module Aws::GeoPlaces
876
886
  # resp.result_items[0].address.building #=> String
877
887
  # resp.result_items[0].address.secondary_address_components #=> Array
878
888
  # resp.result_items[0].address.secondary_address_components[0].number #=> String
889
+ # resp.result_items[0].address.secondary_address_components[0].designator #=> String
879
890
  # resp.result_items[0].address_number_corrected #=> Boolean
880
891
  # resp.result_items[0].postal_code_details #=> Array
881
892
  # resp.result_items[0].postal_code_details[0].postal_code #=> String
@@ -1025,6 +1036,7 @@ module Aws::GeoPlaces
1025
1036
  # resp.result_items[0].intersections[0].address.building #=> String
1026
1037
  # resp.result_items[0].intersections[0].address.secondary_address_components #=> Array
1027
1038
  # resp.result_items[0].intersections[0].address.secondary_address_components[0].number #=> String
1039
+ # resp.result_items[0].intersections[0].address.secondary_address_components[0].designator #=> String
1028
1040
  # resp.result_items[0].intersections[0].position #=> Array
1029
1041
  # resp.result_items[0].intersections[0].position[0] #=> Float
1030
1042
  # resp.result_items[0].intersections[0].distance #=> Integer
@@ -1035,7 +1047,7 @@ module Aws::GeoPlaces
1035
1047
  # resp.result_items[0].intersections[0].access_points[0].position #=> Array
1036
1048
  # resp.result_items[0].intersections[0].access_points[0].position[0] #=> Float
1037
1049
  # resp.result_items[0].main_address.place_id #=> String
1038
- # 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"
1050
+ # 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", "InferredSecondaryAddress"
1039
1051
  # resp.result_items[0].main_address.title #=> String
1040
1052
  # resp.result_items[0].main_address.address.label #=> String
1041
1053
  # resp.result_items[0].main_address.address.country.code_2 #=> String
@@ -1067,6 +1079,7 @@ module Aws::GeoPlaces
1067
1079
  # resp.result_items[0].main_address.address.building #=> String
1068
1080
  # resp.result_items[0].main_address.address.secondary_address_components #=> Array
1069
1081
  # resp.result_items[0].main_address.address.secondary_address_components[0].number #=> String
1082
+ # resp.result_items[0].main_address.address.secondary_address_components[0].designator #=> String
1070
1083
  # resp.result_items[0].main_address.position #=> Array
1071
1084
  # resp.result_items[0].main_address.position[0] #=> Float
1072
1085
  # resp.result_items[0].main_address.access_points #=> Array
@@ -1074,7 +1087,7 @@ module Aws::GeoPlaces
1074
1087
  # resp.result_items[0].main_address.access_points[0].position[0] #=> Float
1075
1088
  # resp.result_items[0].secondary_addresses #=> Array
1076
1089
  # resp.result_items[0].secondary_addresses[0].place_id #=> String
1077
- # 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"
1090
+ # 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", "InferredSecondaryAddress"
1078
1091
  # resp.result_items[0].secondary_addresses[0].title #=> String
1079
1092
  # resp.result_items[0].secondary_addresses[0].address.label #=> String
1080
1093
  # resp.result_items[0].secondary_addresses[0].address.country.code_2 #=> String
@@ -1106,6 +1119,7 @@ module Aws::GeoPlaces
1106
1119
  # resp.result_items[0].secondary_addresses[0].address.building #=> String
1107
1120
  # resp.result_items[0].secondary_addresses[0].address.secondary_address_components #=> Array
1108
1121
  # resp.result_items[0].secondary_addresses[0].address.secondary_address_components[0].number #=> String
1122
+ # resp.result_items[0].secondary_addresses[0].address.secondary_address_components[0].designator #=> String
1109
1123
  # resp.result_items[0].secondary_addresses[0].position #=> Array
1110
1124
  # resp.result_items[0].secondary_addresses[0].position[0] #=> Float
1111
1125
  # resp.result_items[0].secondary_addresses[0].access_points #=> Array
@@ -1124,6 +1138,13 @@ module Aws::GeoPlaces
1124
1138
  # `GetPlace` finds a place by its unique ID. A `PlaceId` is returned by
1125
1139
  # other place operations.
1126
1140
  #
1141
+ # For more information, see [GetPlace][1] in the *Amazon Location
1142
+ # Service Developer Guide*.
1143
+ #
1144
+ #
1145
+ #
1146
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/get-place.html
1147
+ #
1127
1148
  # @option params [required, String] :place_id
1128
1149
  # The `PlaceId` of the place you wish to receive the information for.
1129
1150
  #
@@ -1204,7 +1225,7 @@ module Aws::GeoPlaces
1204
1225
  # @example Response structure
1205
1226
  #
1206
1227
  # resp.place_id #=> String
1207
- # resp.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
1228
+ # resp.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress"
1208
1229
  # resp.title #=> String
1209
1230
  # resp.pricing_bucket #=> String
1210
1231
  # resp.address.label #=> String
@@ -1237,6 +1258,7 @@ module Aws::GeoPlaces
1237
1258
  # resp.address.building #=> String
1238
1259
  # resp.address.secondary_address_components #=> Array
1239
1260
  # resp.address.secondary_address_components[0].number #=> String
1261
+ # resp.address.secondary_address_components[0].designator #=> String
1240
1262
  # resp.address_number_corrected #=> Boolean
1241
1263
  # resp.postal_code_details #=> Array
1242
1264
  # resp.postal_code_details[0].postal_code #=> String
@@ -1360,7 +1382,7 @@ module Aws::GeoPlaces
1360
1382
  # resp.phonemes.address.street[0].language #=> String
1361
1383
  # resp.phonemes.address.street[0].preferred #=> Boolean
1362
1384
  # resp.main_address.place_id #=> String
1363
- # resp.main_address.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
1385
+ # resp.main_address.place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress"
1364
1386
  # resp.main_address.title #=> String
1365
1387
  # resp.main_address.address.label #=> String
1366
1388
  # resp.main_address.address.country.code_2 #=> String
@@ -1392,6 +1414,7 @@ module Aws::GeoPlaces
1392
1414
  # resp.main_address.address.building #=> String
1393
1415
  # resp.main_address.address.secondary_address_components #=> Array
1394
1416
  # resp.main_address.address.secondary_address_components[0].number #=> String
1417
+ # resp.main_address.address.secondary_address_components[0].designator #=> String
1395
1418
  # resp.main_address.position #=> Array
1396
1419
  # resp.main_address.position[0] #=> Float
1397
1420
  # resp.main_address.access_points #=> Array
@@ -1399,7 +1422,7 @@ module Aws::GeoPlaces
1399
1422
  # resp.main_address.access_points[0].position[0] #=> Float
1400
1423
  # resp.secondary_addresses #=> Array
1401
1424
  # resp.secondary_addresses[0].place_id #=> String
1402
- # resp.secondary_addresses[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
1425
+ # resp.secondary_addresses[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress"
1403
1426
  # resp.secondary_addresses[0].title #=> String
1404
1427
  # resp.secondary_addresses[0].address.label #=> String
1405
1428
  # resp.secondary_addresses[0].address.country.code_2 #=> String
@@ -1431,6 +1454,7 @@ module Aws::GeoPlaces
1431
1454
  # resp.secondary_addresses[0].address.building #=> String
1432
1455
  # resp.secondary_addresses[0].address.secondary_address_components #=> Array
1433
1456
  # resp.secondary_addresses[0].address.secondary_address_components[0].number #=> String
1457
+ # resp.secondary_addresses[0].address.secondary_address_components[0].designator #=> String
1434
1458
  # resp.secondary_addresses[0].position #=> Array
1435
1459
  # resp.secondary_addresses[0].position[0] #=> Float
1436
1460
  # resp.secondary_addresses[0].access_points #=> Array
@@ -1454,10 +1478,18 @@ module Aws::GeoPlaces
1454
1478
  # can also provide additional features such as time zone information and
1455
1479
  # the inclusion of political views.
1456
1480
  #
1481
+ # For more information, see [Reverse Geocode][1] in the *Amazon Location
1482
+ # Service Developer Guide*.
1483
+ #
1484
+ #
1485
+ #
1486
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/reverse-geocode.html
1487
+ #
1457
1488
  # @option params [required, Array<Float>] :query_position
1458
- # The position, in `[lng, lat]` for which you are querying nearby
1459
- # results for. Results closer to the position will be ranked higher then
1460
- # results further away from the position
1489
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
1490
+ # latitude\] for which you are querying nearby results for. Results
1491
+ # closer to the position will be ranked higher then results further away
1492
+ # from the position
1461
1493
  #
1462
1494
  # @option params [Integer] :query_radius
1463
1495
  # The maximum distance in meters from the QueryPosition from which a
@@ -1466,6 +1498,8 @@ module Aws::GeoPlaces
1466
1498
  # @option params [Integer] :max_results
1467
1499
  # An optional limit for the number of results returned in a single call.
1468
1500
  #
1501
+ # Default value: 1
1502
+ #
1469
1503
  # @option params [Types::ReverseGeocodeFilter] :filter
1470
1504
  # A structure which contains a set of inclusion/exclusion properties
1471
1505
  # that results must possess in order to be returned as a result.
@@ -1509,6 +1543,13 @@ module Aws::GeoPlaces
1509
1543
  # Optional: The API key to be used for authorization. Either an API key
1510
1544
  # or valid SigV4 signature must be provided when making a request.
1511
1545
  #
1546
+ # @option params [Float] :heading
1547
+ # The heading in degrees from true north in a navigation context. The
1548
+ # heading is measured as the angle clockwise from the North direction.
1549
+ #
1550
+ # Example: North is `0` degrees, East is `90` degrees, South is `180`
1551
+ # degrees, and West is `270` degrees.
1552
+ #
1512
1553
  # @return [Types::ReverseGeocodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1513
1554
  #
1514
1555
  # * {Types::ReverseGeocodeResponse#pricing_bucket #pricing_bucket} => String
@@ -1528,6 +1569,7 @@ module Aws::GeoPlaces
1528
1569
  # political_view: "CountryCode",
1529
1570
  # intended_use: "SingleUse", # accepts SingleUse, Storage
1530
1571
  # key: "ApiKey",
1572
+ # heading: 1.0,
1531
1573
  # })
1532
1574
  #
1533
1575
  # @example Response structure
@@ -1535,7 +1577,7 @@ module Aws::GeoPlaces
1535
1577
  # resp.pricing_bucket #=> String
1536
1578
  # resp.result_items #=> Array
1537
1579
  # resp.result_items[0].place_id #=> String
1538
- # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
1580
+ # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress"
1539
1581
  # resp.result_items[0].title #=> String
1540
1582
  # resp.result_items[0].address.label #=> String
1541
1583
  # resp.result_items[0].address.country.code_2 #=> String
@@ -1567,6 +1609,7 @@ module Aws::GeoPlaces
1567
1609
  # resp.result_items[0].address.building #=> String
1568
1610
  # resp.result_items[0].address.secondary_address_components #=> Array
1569
1611
  # resp.result_items[0].address.secondary_address_components[0].number #=> String
1612
+ # resp.result_items[0].address.secondary_address_components[0].designator #=> String
1570
1613
  # resp.result_items[0].address_number_corrected #=> Boolean
1571
1614
  # resp.result_items[0].postal_code_details #=> Array
1572
1615
  # resp.result_items[0].postal_code_details[0].postal_code #=> String
@@ -1628,6 +1671,7 @@ module Aws::GeoPlaces
1628
1671
  # resp.result_items[0].intersections[0].address.building #=> String
1629
1672
  # resp.result_items[0].intersections[0].address.secondary_address_components #=> Array
1630
1673
  # resp.result_items[0].intersections[0].address.secondary_address_components[0].number #=> String
1674
+ # resp.result_items[0].intersections[0].address.secondary_address_components[0].designator #=> String
1631
1675
  # resp.result_items[0].intersections[0].position #=> Array
1632
1676
  # resp.result_items[0].intersections[0].position[0] #=> Float
1633
1677
  # resp.result_items[0].intersections[0].distance #=> Integer
@@ -1654,10 +1698,18 @@ module Aws::GeoPlaces
1654
1698
  # type, contact, opening hours. Also, the API can return phonemes, time
1655
1699
  # zones and more based on requested parameters.
1656
1700
  #
1701
+ # For more information, see [Search Nearby][1] in the *Amazon Location
1702
+ # Service Developer Guide*.
1703
+ #
1704
+ #
1705
+ #
1706
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/search-nearby.html
1707
+ #
1657
1708
  # @option params [required, Array<Float>] :query_position
1658
- # The position, in `[lng, lat]` for which you are querying nearby
1659
- # results for. Results closer to the position will be ranked higher then
1660
- # results further away from the position
1709
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
1710
+ # latitude\] for which you are querying nearby results for. Results
1711
+ # closer to the position will be ranked higher then results further away
1712
+ # from the position
1661
1713
  #
1662
1714
  # @option params [Integer] :query_radius
1663
1715
  # The maximum distance in meters from the QueryPosition from which a
@@ -1670,6 +1722,8 @@ module Aws::GeoPlaces
1670
1722
  # @option params [Integer] :max_results
1671
1723
  # An optional limit for the number of results returned in a single call.
1672
1724
  #
1725
+ # Default value: 20
1726
+ #
1673
1727
  # @option params [Types::SearchNearbyFilter] :filter
1674
1728
  # A structure which contains a set of inclusion/exclusion properties
1675
1729
  # that results must possess in order to be returned as a result.
@@ -1752,7 +1806,7 @@ module Aws::GeoPlaces
1752
1806
  # resp.pricing_bucket #=> String
1753
1807
  # resp.result_items #=> Array
1754
1808
  # resp.result_items[0].place_id #=> String
1755
- # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
1809
+ # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress"
1756
1810
  # resp.result_items[0].title #=> String
1757
1811
  # resp.result_items[0].address.label #=> String
1758
1812
  # resp.result_items[0].address.country.code_2 #=> String
@@ -1784,6 +1838,7 @@ module Aws::GeoPlaces
1784
1838
  # resp.result_items[0].address.building #=> String
1785
1839
  # resp.result_items[0].address.secondary_address_components #=> Array
1786
1840
  # resp.result_items[0].address.secondary_address_components[0].number #=> String
1841
+ # resp.result_items[0].address.secondary_address_components[0].designator #=> String
1787
1842
  # resp.result_items[0].address_number_corrected #=> Boolean
1788
1843
  # resp.result_items[0].position #=> Array
1789
1844
  # resp.result_items[0].position[0] #=> Float
@@ -1916,11 +1971,19 @@ module Aws::GeoPlaces
1916
1971
  # complete a follow-up query suggested from the `Suggest` API via a
1917
1972
  # query id.
1918
1973
  #
1974
+ # For more information, see [Search Text][1] in the *Amazon Location
1975
+ # Service Developer Guide*.
1976
+ #
1977
+ #
1978
+ #
1979
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/search-text.html
1980
+ #
1919
1981
  # @option params [String] :query_text
1920
1982
  # The free-form text query to match addresses against. This is usually a
1921
1983
  # partially typed address from an end user in an address box or form.
1922
1984
  #
1923
- # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
1985
+ # <note markdown="1"> Exactly one of the following fields must be set: `QueryText` or
1986
+ # `QueryId`.
1924
1987
  #
1925
1988
  # </note>
1926
1989
  #
@@ -1929,21 +1992,24 @@ module Aws::GeoPlaces
1929
1992
  # the SearchText API will preform a SearchText query with the improved
1930
1993
  # query terms for the original query made to the suggest API.
1931
1994
  #
1932
- # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
1995
+ # <note markdown="1"> Exactly one of the following fields must be set: `QueryText` or
1996
+ # `QueryId`.
1933
1997
  #
1934
1998
  # </note>
1935
1999
  #
1936
2000
  # @option params [Integer] :max_results
1937
2001
  # An optional limit for the number of results returned in a single call.
1938
2002
  #
2003
+ # Default value: 20
2004
+ #
1939
2005
  # @option params [Array<Float>] :bias_position
1940
2006
  # The position, in longitude and latitude, that the results should be
1941
2007
  # close to. Typically, place results returned are ranked higher the
1942
2008
  # closer they are to this position. Stored in `[lng, lat]` and in the
1943
- # WSG84 format.
2009
+ # WGS 84 format.
1944
2010
  #
1945
- # <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle` are
1946
- # mutually exclusive.
2011
+ # <note markdown="1"> Exactly one of the following fields must be set: `BiasPosition`,
2012
+ # `Filter.BoundingBox`, or `Filter.Circle`.
1947
2013
  #
1948
2014
  # </note>
1949
2015
  #
@@ -2028,7 +2094,7 @@ module Aws::GeoPlaces
2028
2094
  # resp.pricing_bucket #=> String
2029
2095
  # resp.result_items #=> Array
2030
2096
  # resp.result_items[0].place_id #=> String
2031
- # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress"
2097
+ # resp.result_items[0].place_type #=> String, one of "Country", "Region", "SubRegion", "Locality", "District", "SubDistrict", "PostalCode", "Block", "SubBlock", "Intersection", "Street", "PointOfInterest", "PointAddress", "InterpolatedAddress", "SecondaryAddress", "InferredSecondaryAddress"
2032
2098
  # resp.result_items[0].title #=> String
2033
2099
  # resp.result_items[0].address.label #=> String
2034
2100
  # resp.result_items[0].address.country.code_2 #=> String
@@ -2060,6 +2126,7 @@ module Aws::GeoPlaces
2060
2126
  # resp.result_items[0].address.building #=> String
2061
2127
  # resp.result_items[0].address.secondary_address_components #=> Array
2062
2128
  # resp.result_items[0].address.secondary_address_components[0].number #=> String
2129
+ # resp.result_items[0].address.secondary_address_components[0].designator #=> String
2063
2130
  # resp.result_items[0].address_number_corrected #=> Boolean
2064
2131
  # resp.result_items[0].position #=> Array
2065
2132
  # resp.result_items[0].position[0] #=> Float
@@ -2200,17 +2267,26 @@ module Aws::GeoPlaces
2200
2267
  # features like phonemes and timezones. The response includes refined
2201
2268
  # query terms and detailed place information.
2202
2269
  #
2270
+ # For more information, see [Suggest][1] in the *Amazon Location Service
2271
+ # Developer Guide*.
2272
+ #
2273
+ #
2274
+ #
2275
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/suggest.html
2276
+ #
2203
2277
  # @option params [required, String] :query_text
2204
2278
  # The free-form text query to match addresses against. This is usually a
2205
2279
  # partially typed address from an end user in an address box or form.
2206
2280
  #
2207
- # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
2281
+ # <note markdown="1"> The fields `QueryText` and `QueryID` are mutually exclusive.
2208
2282
  #
2209
2283
  # </note>
2210
2284
  #
2211
2285
  # @option params [Integer] :max_results
2212
2286
  # An optional limit for the number of results returned in a single call.
2213
2287
  #
2288
+ # Default value: 20
2289
+ #
2214
2290
  # @option params [Integer] :max_query_refinements
2215
2291
  # Maximum number of query terms to be returned for use with a search
2216
2292
  # text query.
@@ -2219,7 +2295,7 @@ module Aws::GeoPlaces
2219
2295
  # The position, in longitude and latitude, that the results should be
2220
2296
  # close to. Typically, place results returned are ranked higher the
2221
2297
  # closer they are to this position. Stored in `[lng, lat]` and in the
2222
- # WSG84 format.
2298
+ # WGS 84 format.
2223
2299
  #
2224
2300
  # <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle` are
2225
2301
  # mutually exclusive.
@@ -2292,7 +2368,7 @@ module Aws::GeoPlaces
2292
2368
  # resp.result_items[0].title #=> String
2293
2369
  # resp.result_items[0].suggest_result_item_type #=> String, one of "Place", "Query"
2294
2370
  # resp.result_items[0].place.place_id #=> String
2295
- # 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"
2371
+ # 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", "InferredSecondaryAddress"
2296
2372
  # resp.result_items[0].place.address.label #=> String
2297
2373
  # resp.result_items[0].place.address.country.code_2 #=> String
2298
2374
  # resp.result_items[0].place.address.country.code_3 #=> String
@@ -2323,6 +2399,7 @@ module Aws::GeoPlaces
2323
2399
  # resp.result_items[0].place.address.building #=> String
2324
2400
  # resp.result_items[0].place.address.secondary_address_components #=> Array
2325
2401
  # resp.result_items[0].place.address.secondary_address_components[0].number #=> String
2402
+ # resp.result_items[0].place.address.secondary_address_components[0].designator #=> String
2326
2403
  # resp.result_items[0].place.position #=> Array
2327
2404
  # resp.result_items[0].place.position[0] #=> Float
2328
2405
  # resp.result_items[0].place.distance #=> Integer
@@ -2437,7 +2514,7 @@ module Aws::GeoPlaces
2437
2514
  tracer: tracer
2438
2515
  )
2439
2516
  context[:gem_name] = 'aws-sdk-geoplaces'
2440
- context[:gem_version] = '1.16.0'
2517
+ context[:gem_version] = '1.17.0'
2441
2518
  Seahorse::Client::Request.new(handlers, context)
2442
2519
  end
2443
2520
 
@@ -120,6 +120,7 @@ module Aws::GeoPlaces
120
120
  GetPlaceResponse = Shapes::StructureShape.new(name: 'GetPlaceResponse')
121
121
  GetPlaceResponsePlaceIdString = Shapes::StringShape.new(name: 'GetPlaceResponsePlaceIdString')
122
122
  GetPlaceResponseTitleString = Shapes::StringShape.new(name: 'GetPlaceResponseTitleString')
123
+ Heading = Shapes::FloatShape.new(name: 'Heading')
123
124
  Highlight = Shapes::StructureShape.new(name: 'Highlight')
124
125
  HighlightEndIndexInteger = Shapes::IntegerShape.new(name: 'HighlightEndIndexInteger')
125
126
  HighlightList = Shapes::ListShape.new(name: 'HighlightList')
@@ -226,6 +227,7 @@ module Aws::GeoPlaces
226
227
  SearchTextResultItemPlaceIdString = Shapes::StringShape.new(name: 'SearchTextResultItemPlaceIdString')
227
228
  SearchTextResultItemTitleString = Shapes::StringShape.new(name: 'SearchTextResultItemTitleString')
228
229
  SecondaryAddressComponent = Shapes::StructureShape.new(name: 'SecondaryAddressComponent')
230
+ SecondaryAddressComponentDesignatorString = Shapes::StringShape.new(name: 'SecondaryAddressComponentDesignatorString')
229
231
  SecondaryAddressComponentList = Shapes::ListShape.new(name: 'SecondaryAddressComponentList')
230
232
  SecondaryAddressComponentMatchScore = Shapes::StructureShape.new(name: 'SecondaryAddressComponentMatchScore')
231
233
  SecondaryAddressComponentMatchScoreList = Shapes::ListShape.new(name: 'SecondaryAddressComponentMatchScoreList')
@@ -694,6 +696,7 @@ module Aws::GeoPlaces
694
696
  ReverseGeocodeRequest.add_member(:political_view, Shapes::ShapeRef.new(shape: CountryCode, location_name: "PoliticalView"))
695
697
  ReverseGeocodeRequest.add_member(:intended_use, Shapes::ShapeRef.new(shape: ReverseGeocodeIntendedUse, location_name: "IntendedUse"))
696
698
  ReverseGeocodeRequest.add_member(:key, Shapes::ShapeRef.new(shape: ApiKey, location: "querystring", location_name: "key"))
699
+ ReverseGeocodeRequest.add_member(:heading, Shapes::ShapeRef.new(shape: Heading, location_name: "Heading"))
697
700
  ReverseGeocodeRequest.struct_class = Types::ReverseGeocodeRequest
698
701
 
699
702
  ReverseGeocodeResponse.add_member(:pricing_bucket, Shapes::ShapeRef.new(shape: String, required: true, location: "header", location_name: "x-amz-geo-pricing-bucket"))
@@ -818,6 +821,7 @@ module Aws::GeoPlaces
818
821
  SearchTextResultItemList.member = Shapes::ShapeRef.new(shape: SearchTextResultItem)
819
822
 
820
823
  SecondaryAddressComponent.add_member(:number, Shapes::ShapeRef.new(shape: SecondaryAddressComponentNumberString, required: true, location_name: "Number"))
824
+ SecondaryAddressComponent.add_member(:designator, Shapes::ShapeRef.new(shape: SecondaryAddressComponentDesignatorString, location_name: "Designator"))
821
825
  SecondaryAddressComponent.struct_class = Types::SecondaryAddressComponent
822
826
 
823
827
  SecondaryAddressComponentList.member = Shapes::ShapeRef.new(shape: SecondaryAddressComponent)
@@ -27,7 +27,8 @@ module Aws::GeoPlaces
27
27
  # a vehicle.
28
28
  #
29
29
  # @!attribute [rw] position
30
- # The position, in longitude and latitude.
30
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
31
+ # latitude\].
31
32
  # @return [Array<Float>]
32
33
  #
33
34
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AccessPoint AWS API Documentation
@@ -143,6 +144,13 @@ module Aws::GeoPlaces
143
144
  # Components that correspond to secondary identifiers on an Address.
144
145
  # Secondary address components include information such as Suite or
145
146
  # Unit Number, Building, or Floor.
147
+ #
148
+ # <note markdown="1"> Coverage for `Address.SecondaryAddressComponents` is available in
149
+ # the following countries:
150
+ #
151
+ # AUS, CAN, NZL, USA, PRI
152
+ #
153
+ # </note>
146
154
  # @return [Array<Types::SecondaryAddressComponent>]
147
155
  #
148
156
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Address AWS API Documentation
@@ -236,6 +244,12 @@ module Aws::GeoPlaces
236
244
  #
237
245
  # @!attribute [rw] secondary_address_components
238
246
  # Match scores for the secondary address components in the result.
247
+ #
248
+ # <note markdown="1"> Coverage for this functionality is available in the following
249
+ # countries: AUS, AUT, BRA, CAN, ESP, FRA, GBR, IDN, IND, NZL, TUR,
250
+ # TWN, USA.
251
+ #
252
+ # </note>
239
253
  # @return [Array<Types::SecondaryAddressComponentMatchScore>]
240
254
  #
241
255
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AddressComponentMatchScores AWS API Documentation
@@ -488,13 +502,15 @@ module Aws::GeoPlaces
488
502
  # @!attribute [rw] max_results
489
503
  # An optional limit for the number of results returned in a single
490
504
  # call.
505
+ #
506
+ # Default value: 5
491
507
  # @return [Integer]
492
508
  #
493
509
  # @!attribute [rw] bias_position
494
510
  # The position in longitude and latitude that the results should be
495
511
  # close to. Typically, place results returned are ranked higher the
496
512
  # closer they are to this position. Stored in `[lng, lat]` and in the
497
- # WSG84 format.
513
+ # WGS 84 format.
498
514
  #
499
515
  # <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle`
500
516
  # are mutually exclusive.
@@ -863,8 +879,8 @@ module Aws::GeoPlaces
863
879
  # The `Circle` that all results must be in.
864
880
  #
865
881
  # @!attribute [rw] center
866
- # The center position, in longitude and latitude, of the
867
- # `FilterCircle`.
882
+ # The center position in World Geodetic System (WGS 84) format:
883
+ # \[longitude, latitude\].
868
884
  # @return [Array<Float>]
869
885
  #
870
886
  # @!attribute [rw] radius
@@ -1013,6 +1029,13 @@ module Aws::GeoPlaces
1013
1029
  #
1014
1030
  # @!attribute [rw] secondary_address_components
1015
1031
  # Parsed secondary address components from the provided query text.
1032
+ #
1033
+ # <note markdown="1"> Coverage for `ParsedQuery.Address.SecondaryAddressComponents` is
1034
+ # available in the following countries:
1035
+ #
1036
+ # AUS, AUT, BRA, CAN, ESP, FRA, GBR, HKG, IDN, IND, NZL, TUR, TWN, USA
1037
+ #
1038
+ # </note>
1016
1039
  # @return [Array<Types::ParsedQuerySecondaryAddressComponent>]
1017
1040
  #
1018
1041
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeParsedQueryAddressComponents AWS API Documentation
@@ -1096,10 +1119,6 @@ module Aws::GeoPlaces
1096
1119
  # The free-form text query to match addresses against. This is usually
1097
1120
  # a partially typed address from an end user in an address box or
1098
1121
  # form.
1099
- #
1100
- # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
1101
- #
1102
- # </note>
1103
1122
  # @return [String]
1104
1123
  #
1105
1124
  # @!attribute [rw] query_components
@@ -1110,18 +1129,15 @@ module Aws::GeoPlaces
1110
1129
  # @!attribute [rw] max_results
1111
1130
  # An optional limit for the number of results returned in a single
1112
1131
  # call.
1132
+ #
1133
+ # Default value: 20
1113
1134
  # @return [Integer]
1114
1135
  #
1115
1136
  # @!attribute [rw] bias_position
1116
1137
  # The position, in longitude and latitude, that the results should be
1117
1138
  # close to. Typically, place results returned are ranked higher the
1118
1139
  # closer they are to this position. Stored in `[lng, lat]` and in the
1119
- # WSG84 format.
1120
- #
1121
- # <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle`
1122
- # are mutually exclusive.
1123
- #
1124
- # </note>
1140
+ # WGS 84 format.
1125
1141
  # @return [Array<Float>]
1126
1142
  #
1127
1143
  # @!attribute [rw] filter
@@ -1192,7 +1208,8 @@ module Aws::GeoPlaces
1192
1208
  end
1193
1209
 
1194
1210
  # @!attribute [rw] pricing_bucket
1195
- # The pricing bucket for which the query is charged at.
1211
+ # The pricing bucket for which the query is charged at, or the maximum
1212
+ # pricing bucket when the query is charged per item within the query.
1196
1213
  #
1197
1214
  # For more information on pricing, please visit [Amazon Location
1198
1215
  # Service Pricing][1].
@@ -1243,7 +1260,8 @@ module Aws::GeoPlaces
1243
1260
  # @return [Array<Types::PostalCodeDetails>]
1244
1261
  #
1245
1262
  # @!attribute [rw] position
1246
- # The position in longitude and latitude.
1263
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
1264
+ # latitude\].
1247
1265
  # @return [Array<Float>]
1248
1266
  #
1249
1267
  # @!attribute [rw] distance
@@ -1267,7 +1285,8 @@ module Aws::GeoPlaces
1267
1285
  # @return [Array<Types::FoodType>]
1268
1286
  #
1269
1287
  # @!attribute [rw] access_points
1270
- # Position of the access point represented by longitude and latitude.
1288
+ # Position of the access point in World Geodetic System (WGS 84)
1289
+ # format: \[longitude, latitude\].
1271
1290
  # @return [Array<Types::AccessPoint>]
1272
1291
  #
1273
1292
  # @!attribute [rw] time_zone
@@ -1302,6 +1321,11 @@ module Aws::GeoPlaces
1302
1321
  # All secondary addresses that are associated with a main address. A
1303
1322
  # secondary address is one that includes secondary designators, such
1304
1323
  # as a Suite or Unit Number, Building, or Floor information.
1324
+ #
1325
+ # <note markdown="1"> Coverage for this functionality is available in the following
1326
+ # countries: AUS, CAN, NZL, USA, PRI.
1327
+ #
1328
+ # </note>
1305
1329
  # @return [Array<Types::RelatedPlace>]
1306
1330
  #
1307
1331
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeResultItem AWS API Documentation
@@ -1429,7 +1453,8 @@ module Aws::GeoPlaces
1429
1453
  # @return [Array<Types::PostalCodeDetails>]
1430
1454
  #
1431
1455
  # @!attribute [rw] position
1432
- # The position, in longitude and latitude.
1456
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
1457
+ # latitude\].
1433
1458
  # @return [Array<Float>]
1434
1459
  #
1435
1460
  # @!attribute [rw] map_view
@@ -1461,7 +1486,8 @@ module Aws::GeoPlaces
1461
1486
  # @return [Array<Types::OpeningHours>]
1462
1487
  #
1463
1488
  # @!attribute [rw] access_points
1464
- # Position of the access point in `(lng,lat)`.
1489
+ # Position of the access point in World Geodetic System (WGS 84)
1490
+ # format: \[longitude, latitude\].
1465
1491
  # @return [Array<Types::AccessPoint>]
1466
1492
  #
1467
1493
  # @!attribute [rw] access_restrictions
@@ -1494,6 +1520,11 @@ module Aws::GeoPlaces
1494
1520
  # All secondary addresses that are associated with a main address. A
1495
1521
  # secondary address is one that includes secondary designators, such
1496
1522
  # as a Suite or Unit Number, Building, or Floor information.
1523
+ #
1524
+ # <note markdown="1"> Coverage for this functionality is available in the following
1525
+ # countries: AUS, CAN, NZL, USA, PRI.
1526
+ #
1527
+ # </note>
1497
1528
  # @return [Array<Types::RelatedPlace>]
1498
1529
  #
1499
1530
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GetPlaceResponse AWS API Documentation
@@ -1579,7 +1610,8 @@ module Aws::GeoPlaces
1579
1610
  # @return [Types::Address]
1580
1611
  #
1581
1612
  # @!attribute [rw] position
1582
- # The position, in longitude and latitude.
1613
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
1614
+ # latitude\].
1583
1615
  # @return [Array<Float>]
1584
1616
  #
1585
1617
  # @!attribute [rw] distance
@@ -1600,7 +1632,8 @@ module Aws::GeoPlaces
1600
1632
  # @return [Array<Float>]
1601
1633
  #
1602
1634
  # @!attribute [rw] access_points
1603
- # Position of the access point represented by longitude and latitude.
1635
+ # Position of the access point in World Geodetic System (WGS 84)
1636
+ # format: \[longitude, latitude\].
1604
1637
  # @return [Array<Types::AccessPoint>]
1605
1638
  #
1606
1639
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Intersection AWS API Documentation
@@ -1952,11 +1985,13 @@ module Aws::GeoPlaces
1952
1985
  # @return [Types::Address]
1953
1986
  #
1954
1987
  # @!attribute [rw] position
1955
- # The position, in longitude and latitude.
1988
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
1989
+ # latitude\].
1956
1990
  # @return [Array<Float>]
1957
1991
  #
1958
1992
  # @!attribute [rw] access_points
1959
- # Position of the access point represented by longitude and latitude.
1993
+ # Position of the access point in World Geodetic System (WGS 84)
1994
+ # format: \[longitude, latitude\].
1960
1995
  # @return [Array<Types::AccessPoint>]
1961
1996
  #
1962
1997
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/RelatedPlace AWS API Documentation
@@ -1987,9 +2022,10 @@ module Aws::GeoPlaces
1987
2022
  end
1988
2023
 
1989
2024
  # @!attribute [rw] query_position
1990
- # The position, in `[lng, lat]` for which you are querying nearby
1991
- # results for. Results closer to the position will be ranked higher
1992
- # then results further away from the position
2025
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
2026
+ # latitude\] for which you are querying nearby results for. Results
2027
+ # closer to the position will be ranked higher then results further
2028
+ # away from the position
1993
2029
  # @return [Array<Float>]
1994
2030
  #
1995
2031
  # @!attribute [rw] query_radius
@@ -2000,6 +2036,8 @@ module Aws::GeoPlaces
2000
2036
  # @!attribute [rw] max_results
2001
2037
  # An optional limit for the number of results returned in a single
2002
2038
  # call.
2039
+ #
2040
+ # Default value: 1
2003
2041
  # @return [Integer]
2004
2042
  #
2005
2043
  # @!attribute [rw] filter
@@ -2052,6 +2090,14 @@ module Aws::GeoPlaces
2052
2090
  # key or valid SigV4 signature must be provided when making a request.
2053
2091
  # @return [String]
2054
2092
  #
2093
+ # @!attribute [rw] heading
2094
+ # The heading in degrees from true north in a navigation context. The
2095
+ # heading is measured as the angle clockwise from the North direction.
2096
+ #
2097
+ # Example: North is `0` degrees, East is `90` degrees, South is `180`
2098
+ # degrees, and West is `270` degrees.
2099
+ # @return [Float]
2100
+ #
2055
2101
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ReverseGeocodeRequest AWS API Documentation
2056
2102
  #
2057
2103
  class ReverseGeocodeRequest < Struct.new(
@@ -2063,8 +2109,9 @@ module Aws::GeoPlaces
2063
2109
  :language,
2064
2110
  :political_view,
2065
2111
  :intended_use,
2066
- :key)
2067
- SENSITIVE = [:query_position, :query_radius, :political_view, :key]
2112
+ :key,
2113
+ :heading)
2114
+ SENSITIVE = [:query_position, :query_radius, :political_view, :key, :heading]
2068
2115
  include Aws::Structure
2069
2116
  end
2070
2117
 
@@ -2120,7 +2167,8 @@ module Aws::GeoPlaces
2120
2167
  # @return [Array<Types::PostalCodeDetails>]
2121
2168
  #
2122
2169
  # @!attribute [rw] position
2123
- # The position in longitude and latitude.
2170
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
2171
+ # latitude\].
2124
2172
  # @return [Array<Float>]
2125
2173
  #
2126
2174
  # @!attribute [rw] distance
@@ -2144,7 +2192,8 @@ module Aws::GeoPlaces
2144
2192
  # @return [Array<Types::FoodType>]
2145
2193
  #
2146
2194
  # @!attribute [rw] access_points
2147
- # Position of the access point represented by longitude and latitude.
2195
+ # Position of the access point in World Geodetic System (WGS 84)
2196
+ # format: \[longitude, latitude\].
2148
2197
  # @return [Array<Types::AccessPoint>]
2149
2198
  #
2150
2199
  # @!attribute [rw] time_zone
@@ -2241,9 +2290,10 @@ module Aws::GeoPlaces
2241
2290
  end
2242
2291
 
2243
2292
  # @!attribute [rw] query_position
2244
- # The position, in `[lng, lat]` for which you are querying nearby
2245
- # results for. Results closer to the position will be ranked higher
2246
- # then results further away from the position
2293
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
2294
+ # latitude\] for which you are querying nearby results for. Results
2295
+ # closer to the position will be ranked higher then results further
2296
+ # away from the position
2247
2297
  # @return [Array<Float>]
2248
2298
  #
2249
2299
  # @!attribute [rw] query_radius
@@ -2258,6 +2308,8 @@ module Aws::GeoPlaces
2258
2308
  # @!attribute [rw] max_results
2259
2309
  # An optional limit for the number of results returned in a single
2260
2310
  # call.
2311
+ #
2312
+ # Default value: 20
2261
2313
  # @return [Integer]
2262
2314
  #
2263
2315
  # @!attribute [rw] filter
@@ -2385,7 +2437,8 @@ module Aws::GeoPlaces
2385
2437
  # @return [Boolean]
2386
2438
  #
2387
2439
  # @!attribute [rw] position
2388
- # The position in longitude and latitude.
2440
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
2441
+ # latitude\].
2389
2442
  # @return [Array<Float>]
2390
2443
  #
2391
2444
  # @!attribute [rw] distance
@@ -2421,7 +2474,8 @@ module Aws::GeoPlaces
2421
2474
  # @return [Array<Types::OpeningHours>]
2422
2475
  #
2423
2476
  # @!attribute [rw] access_points
2424
- # Position of the access point represent by longitude and latitude.
2477
+ # Position of the access point in World Geodetic System (WGS 84)
2478
+ # format: \[longitude, latitude\].
2425
2479
  # @return [Array<Types::AccessPoint>]
2426
2480
  #
2427
2481
  # @!attribute [rw] access_restrictions
@@ -2507,7 +2561,8 @@ module Aws::GeoPlaces
2507
2561
  # a partially typed address from an end user in an address box or
2508
2562
  # form.
2509
2563
  #
2510
- # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
2564
+ # <note markdown="1"> Exactly one of the following fields must be set: `QueryText` or
2565
+ # `QueryId`.
2511
2566
  #
2512
2567
  # </note>
2513
2568
  # @return [String]
@@ -2517,7 +2572,8 @@ module Aws::GeoPlaces
2517
2572
  # the SearchText API will preform a SearchText query with the improved
2518
2573
  # query terms for the original query made to the suggest API.
2519
2574
  #
2520
- # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
2575
+ # <note markdown="1"> Exactly one of the following fields must be set: `QueryText` or
2576
+ # `QueryId`.
2521
2577
  #
2522
2578
  # </note>
2523
2579
  # @return [String]
@@ -2525,16 +2581,18 @@ module Aws::GeoPlaces
2525
2581
  # @!attribute [rw] max_results
2526
2582
  # An optional limit for the number of results returned in a single
2527
2583
  # call.
2584
+ #
2585
+ # Default value: 20
2528
2586
  # @return [Integer]
2529
2587
  #
2530
2588
  # @!attribute [rw] bias_position
2531
2589
  # The position, in longitude and latitude, that the results should be
2532
2590
  # close to. Typically, place results returned are ranked higher the
2533
2591
  # closer they are to this position. Stored in `[lng, lat]` and in the
2534
- # WSG84 format.
2592
+ # WGS 84 format.
2535
2593
  #
2536
- # <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle`
2537
- # are mutually exclusive.
2594
+ # <note markdown="1"> Exactly one of the following fields must be set: `BiasPosition`,
2595
+ # `Filter.BoundingBox`, or `Filter.Circle`.
2538
2596
  #
2539
2597
  # </note>
2540
2598
  # @return [Array<Float>]
@@ -2665,7 +2723,8 @@ module Aws::GeoPlaces
2665
2723
  # @return [Boolean]
2666
2724
  #
2667
2725
  # @!attribute [rw] position
2668
- # The position, in longitude and latitude.
2726
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
2727
+ # latitude\].
2669
2728
  # @return [Array<Float>]
2670
2729
  #
2671
2730
  # @!attribute [rw] distance
@@ -2701,7 +2760,8 @@ module Aws::GeoPlaces
2701
2760
  # @return [Array<Types::OpeningHours>]
2702
2761
  #
2703
2762
  # @!attribute [rw] access_points
2704
- # Position of the access point represent by longitude and latitude.
2763
+ # Position of the access point in World Geodetic System (WGS 84)
2764
+ # format: \[longitude, latitude\].
2705
2765
  # @return [Array<Types::AccessPoint>]
2706
2766
  #
2707
2767
  # @!attribute [rw] access_restrictions
@@ -2758,11 +2818,18 @@ module Aws::GeoPlaces
2758
2818
  # Number that uniquely identifies a secondary address.
2759
2819
  # @return [String]
2760
2820
  #
2821
+ # @!attribute [rw] designator
2822
+ # The designator of the secondary address component.
2823
+ #
2824
+ # Example: `Apt`.
2825
+ # @return [String]
2826
+ #
2761
2827
  # @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SecondaryAddressComponent AWS API Documentation
2762
2828
  #
2763
2829
  class SecondaryAddressComponent < Struct.new(
2764
- :number)
2765
- SENSITIVE = [:number]
2830
+ :number,
2831
+ :designator)
2832
+ SENSITIVE = [:number, :designator]
2766
2833
  include Aws::Structure
2767
2834
  end
2768
2835
 
@@ -2976,7 +3043,8 @@ module Aws::GeoPlaces
2976
3043
  # @return [Types::Address]
2977
3044
  #
2978
3045
  # @!attribute [rw] position
2979
- # The position, in longitude and latitude.
3046
+ # The position in World Geodetic System (WGS 84) format: \[longitude,
3047
+ # latitude\].
2980
3048
  # @return [Array<Float>]
2981
3049
  #
2982
3050
  # @!attribute [rw] distance
@@ -3004,7 +3072,8 @@ module Aws::GeoPlaces
3004
3072
  # @return [Array<Types::BusinessChain>]
3005
3073
  #
3006
3074
  # @!attribute [rw] access_points
3007
- # Position of the access point represent by longitude and latitude.
3075
+ # Position of the access point in World Geodetic System (WGS 84)
3076
+ # format: \[longitude, latitude\].
3008
3077
  # @return [Array<Types::AccessPoint>]
3009
3078
  #
3010
3079
  # @!attribute [rw] access_restrictions
@@ -3065,7 +3134,7 @@ module Aws::GeoPlaces
3065
3134
  #
3066
3135
  #
3067
3136
  #
3068
- # [1]: https://docs.aws.amazon.com/latest/APIReference/API_geoplaces_SearchText.html
3137
+ # [1]: https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchText.html
3069
3138
  # @return [String]
3070
3139
  #
3071
3140
  # @!attribute [rw] query_type
@@ -3088,7 +3157,7 @@ module Aws::GeoPlaces
3088
3157
  # a partially typed address from an end user in an address box or
3089
3158
  # form.
3090
3159
  #
3091
- # <note markdown="1"> The fields `QueryText`, and `QueryID` are mutually exclusive.
3160
+ # <note markdown="1"> The fields `QueryText` and `QueryID` are mutually exclusive.
3092
3161
  #
3093
3162
  # </note>
3094
3163
  # @return [String]
@@ -3096,6 +3165,8 @@ module Aws::GeoPlaces
3096
3165
  # @!attribute [rw] max_results
3097
3166
  # An optional limit for the number of results returned in a single
3098
3167
  # call.
3168
+ #
3169
+ # Default value: 20
3099
3170
  # @return [Integer]
3100
3171
  #
3101
3172
  # @!attribute [rw] max_query_refinements
@@ -3107,7 +3178,7 @@ module Aws::GeoPlaces
3107
3178
  # The position, in longitude and latitude, that the results should be
3108
3179
  # close to. Typically, place results returned are ranked higher the
3109
3180
  # closer they are to this position. Stored in `[lng, lat]` and in the
3110
- # WSG84 format.
3181
+ # WGS 84 format.
3111
3182
  #
3112
3183
  # <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle`
3113
3184
  # are mutually exclusive.
@@ -54,7 +54,7 @@ module Aws::GeoPlaces
54
54
  autoload :EndpointProvider, 'aws-sdk-geoplaces/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-geoplaces/endpoints'
56
56
 
57
- GEM_VERSION = '1.16.0'
57
+ GEM_VERSION = '1.17.0'
58
58
 
59
59
  end
60
60
 
data/sig/client.rbs CHANGED
@@ -141,7 +141,7 @@ module Aws
141
141
  interface _GetPlaceResponseSuccess
142
142
  include ::Seahorse::Client::_ResponseSuccess[Types::GetPlaceResponse]
143
143
  def place_id: () -> ::String
144
- def place_type: () -> ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
144
+ def place_type: () -> ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
145
145
  def title: () -> ::String
146
146
  def pricing_bucket: () -> ::String
147
147
  def address: () -> Types::Address
@@ -190,7 +190,8 @@ module Aws
190
190
  ?language: ::String,
191
191
  ?political_view: ::String,
192
192
  ?intended_use: ("SingleUse" | "Storage"),
193
- ?key: ::String
193
+ ?key: ::String,
194
+ ?heading: ::Float
194
195
  ) -> _ReverseGeocodeResponseSuccess
195
196
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ReverseGeocodeResponseSuccess
196
197
 
data/sig/types.rbs CHANGED
@@ -128,7 +128,7 @@ module Aws::GeoPlaces
128
128
 
129
129
  class AutocompleteResultItem
130
130
  attr_accessor place_id: ::String
131
- attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
131
+ attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
132
132
  attr_accessor title: ::String
133
133
  attr_accessor address: Types::Address
134
134
  attr_accessor distance: ::Integer
@@ -262,7 +262,7 @@ module Aws::GeoPlaces
262
262
 
263
263
  class GeocodeResultItem
264
264
  attr_accessor place_id: ::String
265
- attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
265
+ attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
266
266
  attr_accessor title: ::String
267
267
  attr_accessor address: Types::Address
268
268
  attr_accessor address_number_corrected: bool
@@ -295,7 +295,7 @@ module Aws::GeoPlaces
295
295
 
296
296
  class GetPlaceResponse
297
297
  attr_accessor place_id: ::String
298
- attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
298
+ attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
299
299
  attr_accessor title: ::String
300
300
  attr_accessor pricing_bucket: ::String
301
301
  attr_accessor address: Types::Address
@@ -424,7 +424,7 @@ module Aws::GeoPlaces
424
424
 
425
425
  class RelatedPlace
426
426
  attr_accessor place_id: ::String
427
- attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
427
+ attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
428
428
  attr_accessor title: ::String
429
429
  attr_accessor address: Types::Address
430
430
  attr_accessor position: ::Array[::Float]
@@ -447,7 +447,8 @@ module Aws::GeoPlaces
447
447
  attr_accessor political_view: ::String
448
448
  attr_accessor intended_use: ("SingleUse" | "Storage")
449
449
  attr_accessor key: ::String
450
- SENSITIVE: [:query_position, :query_radius, :political_view, :key]
450
+ attr_accessor heading: ::Float
451
+ SENSITIVE: [:query_position, :query_radius, :political_view, :key, :heading]
451
452
  end
452
453
 
453
454
  class ReverseGeocodeResponse
@@ -458,7 +459,7 @@ module Aws::GeoPlaces
458
459
 
459
460
  class ReverseGeocodeResultItem
460
461
  attr_accessor place_id: ::String
461
- attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
462
+ attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
462
463
  attr_accessor title: ::String
463
464
  attr_accessor address: Types::Address
464
465
  attr_accessor address_number_corrected: bool
@@ -510,7 +511,7 @@ module Aws::GeoPlaces
510
511
 
511
512
  class SearchNearbyResultItem
512
513
  attr_accessor place_id: ::String
513
- attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
514
+ attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
514
515
  attr_accessor title: ::String
515
516
  attr_accessor address: Types::Address
516
517
  attr_accessor address_number_corrected: bool
@@ -561,7 +562,7 @@ module Aws::GeoPlaces
561
562
 
562
563
  class SearchTextResultItem
563
564
  attr_accessor place_id: ::String
564
- attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
565
+ attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
565
566
  attr_accessor title: ::String
566
567
  attr_accessor address: Types::Address
567
568
  attr_accessor address_number_corrected: bool
@@ -583,7 +584,8 @@ module Aws::GeoPlaces
583
584
 
584
585
  class SecondaryAddressComponent
585
586
  attr_accessor number: ::String
586
- SENSITIVE: [:number]
587
+ attr_accessor designator: ::String
588
+ SENSITIVE: [:number, :designator]
587
589
  end
588
590
 
589
591
  class SecondaryAddressComponentMatchScore
@@ -635,7 +637,7 @@ module Aws::GeoPlaces
635
637
 
636
638
  class SuggestPlaceResult
637
639
  attr_accessor place_id: ::String
638
- attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress")
640
+ attr_accessor place_type: ("Country" | "Region" | "SubRegion" | "Locality" | "District" | "SubDistrict" | "PostalCode" | "Block" | "SubBlock" | "Intersection" | "Street" | "PointOfInterest" | "PointAddress" | "InterpolatedAddress" | "SecondaryAddress" | "InferredSecondaryAddress")
639
641
  attr_accessor address: Types::Address
640
642
  attr_accessor position: ::Array[::Float]
641
643
  attr_accessor distance: ::Integer
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-geoplaces
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.16.0
4
+ version: 1.17.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services