aws-sdk-locationservice 1.8.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -646,7 +646,7 @@ module Aws::LocationService
646
646
  #
647
647
  # @!attribute [rw] calculator_name
648
648
  # The name of the route calculator resource that you want to use to
649
- # calculate a route.
649
+ # calculate the route.
650
650
  # @return [String]
651
651
  #
652
652
  # @!attribute [rw] car_mode_options
@@ -675,7 +675,9 @@ module Aws::LocationService
675
675
  # ^
676
676
  #
677
677
  # <note markdown="1"> If you specify a departure that's not located on a road, Amazon
678
- # Location [moves the position to the nearest road][2].
678
+ # Location [moves the position to the nearest road][2]. If Esri is the
679
+ # provider for your route calculator, specifying a route that is
680
+ # longer than 400 km returns a `400 RoutesValidationException` error.
679
681
  #
680
682
  # </note>
681
683
  #
@@ -689,7 +691,7 @@ module Aws::LocationService
689
691
  #
690
692
  # @!attribute [rw] departure_time
691
693
  # Specifies the desired time of departure. Uses the given time to
692
- # calculate a route. Otherwise, the best time of day to travel with
694
+ # calculate the route. Otherwise, the best time of day to travel with
693
695
  # the best traffic conditions is used to calculate the route.
694
696
  #
695
697
  # <note markdown="1"> Setting a departure time in the past returns a `400
@@ -782,6 +784,10 @@ module Aws::LocationService
782
784
  # Specifying more than 23 waypoints returns a `400
783
785
  # ValidationException` error.
784
786
  #
787
+ # If Esri is the provider for your route calculator, specifying a
788
+ # route that is longer than 400 km returns a `400
789
+ # RoutesValidationException` error.
790
+ #
785
791
  # </note>
786
792
  #
787
793
  # Valid Values: `[-180 to 180,-90 to 90]`
@@ -878,15 +884,15 @@ module Aws::LocationService
878
884
  # The total distance covered by the route. The sum of the distance
879
885
  # travelled between every stop on the route.
880
886
  #
881
- # <note markdown="1"> The route `distance` can't be greater than 250 km. If the route
882
- # exceeds 250 km, the response returns a `400
883
- # RoutesValidationException` error.
887
+ # <note markdown="1"> If Esri is the data source for the route calculator, the route
888
+ # distance can’t be greater than 400 km. If the route exceeds 400 km,
889
+ # the response is a `400 RoutesValidationException` error.
884
890
  #
885
891
  # </note>
886
892
  # @return [Float]
887
893
  #
888
894
  # @!attribute [rw] distance_unit
889
- # The unit of measurement for the distance.
895
+ # The unit of measurement for route distances.
890
896
  # @return [String]
891
897
  #
892
898
  # @!attribute [rw] duration_seconds
@@ -912,8 +918,8 @@ module Aws::LocationService
912
918
  # * The third `bbox` position is the X coordinate, or longitude of the
913
919
  # upper northeast corner.
914
920
  #
915
- # * The fourth `bbox` position is the Y coordinate, or longitude of
916
- # the upper northeast corner.
921
+ # * The fourth `bbox` position is the Y coordinate, or latitude of the
922
+ # upper northeast corner.
917
923
  # @return [Array<Float>]
918
924
  #
919
925
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteSummary AWS API Documentation
@@ -1097,6 +1103,8 @@ module Aws::LocationService
1097
1103
  #
1098
1104
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1099
1105
  # characters: + - = . \_ : / @.
1106
+ #
1107
+ # * Cannot use "aws:" as a prefix for a key.
1100
1108
  # @return [Hash<String,String>]
1101
1109
  #
1102
1110
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollectionRequest AWS API Documentation
@@ -1185,7 +1193,7 @@ module Aws::LocationService
1185
1193
  # Specifies the pricing plan for your map resource.
1186
1194
  #
1187
1195
  # For additional details and restrictions on each pricing plan option,
1188
- # see the [Amazon Location Service pricing page][1].
1196
+ # see [Amazon Location Service pricing][1].
1189
1197
  #
1190
1198
  #
1191
1199
  #
@@ -1211,6 +1219,8 @@ module Aws::LocationService
1211
1219
  #
1212
1220
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1213
1221
  # characters: + - = . \_ : / @.
1222
+ #
1223
+ # * Cannot use "aws:" as a prefix for a key.
1214
1224
  # @return [Hash<String,String>]
1215
1225
  #
1216
1226
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMapRequest AWS API Documentation
@@ -1274,7 +1284,7 @@ module Aws::LocationService
1274
1284
  # }
1275
1285
  #
1276
1286
  # @!attribute [rw] data_source
1277
- # Specifies the data provider of geospatial data.
1287
+ # Specifies the geospatial data provider for the new place index.
1278
1288
  #
1279
1289
  # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
1280
1290
  # example, entering `HERE` returns an error.
@@ -1287,12 +1297,12 @@ module Aws::LocationService
1287
1297
  # your region of interest, see [Esri details on geocoding
1288
1298
  # coverage][2].
1289
1299
  #
1290
- # * `Here` – For additional information about [HERE
1291
- # Technologies][3]'s coverage in your region of interest, see [HERE
1292
- # details on goecoding coverage][4].
1300
+ # * `Here` – For additional information about [HERE Technologies][3]'
1301
+ # coverage in your region of interest, see [HERE details on
1302
+ # goecoding coverage][4].
1293
1303
  #
1294
- # Place index resources using HERE Technologies as a data provider
1295
- # can't [store results][5] for locations in Japan. For more
1304
+ # If you specify HERE Technologies (`Here`) as the data provider,
1305
+ # you may not [store results][5] for locations in Japan. For more
1296
1306
  # information, see the [AWS Service Terms][6] for Amazon Location
1297
1307
  # Service.
1298
1308
  #
@@ -1335,7 +1345,7 @@ module Aws::LocationService
1335
1345
  # Specifies the pricing plan for your place index resource.
1336
1346
  #
1337
1347
  # For additional details and restrictions on each pricing plan option,
1338
- # see the [Amazon Location Service pricing page][1].
1348
+ # see [Amazon Location Service pricing][1].
1339
1349
  #
1340
1350
  #
1341
1351
  #
@@ -1344,23 +1354,26 @@ module Aws::LocationService
1344
1354
  #
1345
1355
  # @!attribute [rw] tags
1346
1356
  # Applies one or more tags to the place index resource. A tag is a
1347
- # key-value pair helps manage, identify, search, and filter your
1348
- # resources by labelling them.
1357
+ # key-value pair that helps you manage, identify, search, and filter
1358
+ # your resources.
1349
1359
  #
1350
1360
  # Format: `"key" : "value"`
1351
1361
  #
1352
1362
  # Restrictions:
1353
1363
  #
1354
- # * Maximum 50 tags per resource
1364
+ # * Maximum 50 tags per resource.
1355
1365
  #
1356
- # * Each resource tag must be unique with a maximum of one value.
1366
+ # * Each tag key must be unique and must have exactly one associated
1367
+ # value.
1357
1368
  #
1358
- # * Maximum key length: 128 Unicode characters in UTF-8
1369
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1359
1370
  #
1360
- # * Maximum value length: 256 Unicode characters in UTF-8
1371
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1361
1372
  #
1362
1373
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1363
- # characters: + - = . \_ : / @.
1374
+ # characters: + - = . \_ : / @
1375
+ #
1376
+ # * Cannot use "aws:" as a prefix for a key.
1364
1377
  # @return [Hash<String,String>]
1365
1378
  #
1366
1379
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndexRequest AWS API Documentation
@@ -1439,7 +1452,9 @@ module Aws::LocationService
1439
1452
  # Specifies the data provider of traffic and road network data.
1440
1453
  #
1441
1454
  # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
1442
- # example, entering `HERE` returns an error.
1455
+ # example, entering `HERE` returns an error. Route calculators that
1456
+ # use Esri as a data source only calculate routes that are shorter
1457
+ # than 400 km.
1443
1458
  #
1444
1459
  # </note>
1445
1460
  #
@@ -1449,9 +1464,9 @@ module Aws::LocationService
1449
1464
  # your region of interest, see [Esri details on street networks and
1450
1465
  # traffic coverage][2].
1451
1466
  #
1452
- # * `Here` – For additional information about [HERE
1453
- # Technologies][3]'s coverage in your region of interest, see [HERE
1454
- # car routing coverage][4] and [HERE truck routing coverage][5].
1467
+ # * `Here` – For additional information about [HERE Technologies][3]'
1468
+ # coverage in your region of interest, see [HERE car routing
1469
+ # coverage][4] and [HERE truck routing coverage][5].
1455
1470
  #
1456
1471
  # For additional information , see [Data providers][6] on the *Amazon
1457
1472
  # Location Service Developer Guide*.
@@ -1504,6 +1519,8 @@ module Aws::LocationService
1504
1519
  #
1505
1520
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1506
1521
  # characters: + - = . \_ : / @.
1522
+ #
1523
+ # * Cannot use "aws:" as a prefix for a key.
1507
1524
  # @return [Hash<String,String>]
1508
1525
  #
1509
1526
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculatorRequest AWS API Documentation
@@ -1565,6 +1582,7 @@ module Aws::LocationService
1565
1582
  # {
1566
1583
  # description: "ResourceDescription",
1567
1584
  # kms_key_id: "KmsKeyId",
1585
+ # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
1568
1586
  # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1569
1587
  # pricing_plan_data_source: "String",
1570
1588
  # tags: {
@@ -1586,11 +1604,33 @@ module Aws::LocationService
1586
1604
  # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
1587
1605
  # @return [String]
1588
1606
  #
1607
+ # @!attribute [rw] position_filtering
1608
+ # Specifies the position filtering for the tracker resource.
1609
+ #
1610
+ # Valid values:
1611
+ #
1612
+ # * `TimeBased` - Location updates are evaluated against linked
1613
+ # geofence collections, but not every location update is stored. If
1614
+ # your update frequency is more often than 30 seconds, only one
1615
+ # update per 30 seconds is stored for each unique device ID.
1616
+ #
1617
+ # * `DistanceBased` - If the device has moved less than 30 m (98.4
1618
+ # ft), location updates are ignored. Location updates within this
1619
+ # area are neither evaluated against linked geofence collections,
1620
+ # nor stored. This helps control costs by reducing the number of
1621
+ # geofence evaluations and historical device positions to paginate
1622
+ # through. Distance-based filtering can also reduce the effects of
1623
+ # GPS noise when displaying device trajectories on a map.
1624
+ #
1625
+ # This field is optional. If not specified, the default value is
1626
+ # `TimeBased`.
1627
+ # @return [String]
1628
+ #
1589
1629
  # @!attribute [rw] pricing_plan
1590
1630
  # Specifies the pricing plan for the tracker resource.
1591
1631
  #
1592
1632
  # For additional details and restrictions on each pricing plan option,
1593
- # see the [Amazon Location Service pricing page][1].
1633
+ # see [Amazon Location Service pricing][1].
1594
1634
  #
1595
1635
  #
1596
1636
  #
@@ -1615,7 +1655,7 @@ module Aws::LocationService
1615
1655
  #
1616
1656
  # </note>
1617
1657
  #
1618
- # Valid Values: `Esri` \| `Here`
1658
+ # Valid values: `Esri` \| `Here`
1619
1659
  #
1620
1660
  #
1621
1661
  #
@@ -1642,6 +1682,8 @@ module Aws::LocationService
1642
1682
  #
1643
1683
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1644
1684
  # characters: + - = . \_ : / @.
1685
+ #
1686
+ # * Cannot use "aws:" as a prefix for a key.
1645
1687
  # @return [Hash<String,String>]
1646
1688
  #
1647
1689
  # @!attribute [rw] tracker_name
@@ -1662,6 +1704,7 @@ module Aws::LocationService
1662
1704
  class CreateTrackerRequest < Struct.new(
1663
1705
  :description,
1664
1706
  :kms_key_id,
1707
+ :position_filtering,
1665
1708
  :pricing_plan,
1666
1709
  :pricing_plan_data_source,
1667
1710
  :tags,
@@ -2022,7 +2065,7 @@ module Aws::LocationService
2022
2065
  # @!attribute [rw] pricing_plan
2023
2066
  # The pricing plan selected for the specified map resource.
2024
2067
  #
2025
- # <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing page</a>.</p>
2068
+ # <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2026
2069
  # @return [String]
2027
2070
  #
2028
2071
  # @!attribute [rw] tags
@@ -2083,15 +2126,15 @@ module Aws::LocationService
2083
2126
  # @return [Time]
2084
2127
  #
2085
2128
  # @!attribute [rw] data_source
2086
- # The data provider of geospatial data. Indicates one of the available
2087
- # providers:
2129
+ # The data provider of geospatial data. Values can be one of the
2130
+ # following:
2088
2131
  #
2089
2132
  # * `Esri`
2090
2133
  #
2091
2134
  # * `Here`
2092
2135
  #
2093
- # For additional details on data providers, see the [Amazon Location
2094
- # Service data providers page][1].
2136
+ # For more information about data providers, see [Amazon Location
2137
+ # Service data providers][1].
2095
2138
  #
2096
2139
  #
2097
2140
  #
@@ -2124,7 +2167,7 @@ module Aws::LocationService
2124
2167
  # The pricing plan selected for the specified place index resource.
2125
2168
  #
2126
2169
  # For additional details and restrictions on each pricing plan option,
2127
- # see the [Amazon Location Service pricing page][1].
2170
+ # see [Amazon Location Service pricing][1].
2128
2171
  #
2129
2172
  #
2130
2173
  #
@@ -2311,11 +2354,15 @@ module Aws::LocationService
2311
2354
  # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
2312
2355
  # @return [String]
2313
2356
  #
2357
+ # @!attribute [rw] position_filtering
2358
+ # The position filtering method of the tracker resource.
2359
+ # @return [String]
2360
+ #
2314
2361
  # @!attribute [rw] pricing_plan
2315
2362
  # The pricing plan selected for the specified tracker resource.
2316
2363
  #
2317
2364
  # For additional details and restrictions on each pricing plan option,
2318
- # see the [Amazon Location Service pricing page][1].
2365
+ # see [Amazon Location Service pricing][1].
2319
2366
  #
2320
2367
  #
2321
2368
  #
@@ -2359,6 +2406,7 @@ module Aws::LocationService
2359
2406
  :create_time,
2360
2407
  :description,
2361
2408
  :kms_key_id,
2409
+ :position_filtering,
2362
2410
  :pricing_plan,
2363
2411
  :pricing_plan_data_source,
2364
2412
  :tags,
@@ -2776,7 +2824,7 @@ module Aws::LocationService
2776
2824
  # A comma-separated list of fonts to load glyphs from in order of
2777
2825
  # preference. For example, `Noto Sans Regular, Arial Unicode`.
2778
2826
  #
2779
- # Valid fonts for [Esri][1] styles:
2827
+ # Valid fonts stacks for [Esri][1] styles:
2780
2828
  #
2781
2829
  # * VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` \| `Ubuntu
2782
2830
  # Medium` \| `Ubuntu Italic` \| `Ubuntu Regular` \| `Ubuntu Bold`
@@ -2794,9 +2842,9 @@ module Aws::LocationService
2794
2842
  # * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial
2795
2843
  # Bold`
2796
2844
  #
2797
- # Valid fonts for [HERE Technologies][2] styles:
2845
+ # Valid font stacks for [HERE Technologies][2] styles:
2798
2846
  #
2799
- # * `VectorHereBerlin` – `Fira GO Regular` \| `Fira GO Bold`
2847
+ # * VectorHereBerlin – `Fira GO Regular` \| `Fira GO Bold`
2800
2848
  #
2801
2849
  # ^
2802
2850
  #
@@ -3500,7 +3548,7 @@ module Aws::LocationService
3500
3548
  # The pricing plan for the specified map resource.
3501
3549
  #
3502
3550
  # For additional details and restrictions on each pricing plan option,
3503
- # see the [Amazon Location Service pricing page][1].
3551
+ # see [Amazon Location Service pricing][1].
3504
3552
  #
3505
3553
  #
3506
3554
  #
@@ -3566,9 +3614,9 @@ module Aws::LocationService
3566
3614
  # @return [Array<Types::ListPlaceIndexesResponseEntry>]
3567
3615
  #
3568
3616
  # @!attribute [rw] next_token
3569
- # A pagination token indicating there are additional pages available.
3570
- # You can use the token in a following request to fetch the next set
3571
- # of results.
3617
+ # A pagination token indicating that there are additional pages
3618
+ # available. You can use the token in a new request to fetch the next
3619
+ # page of results.
3572
3620
  # @return [String]
3573
3621
  #
3574
3622
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexesResponse AWS API Documentation
@@ -3592,15 +3640,15 @@ module Aws::LocationService
3592
3640
  # @return [Time]
3593
3641
  #
3594
3642
  # @!attribute [rw] data_source
3595
- # The data provider of geospatial data. Indicates one of the available
3596
- # providers:
3643
+ # The data provider of geospatial data. Values can be one of the
3644
+ # following:
3597
3645
  #
3598
3646
  # * `Esri`
3599
3647
  #
3600
3648
  # * `Here`
3601
3649
  #
3602
- # For additional details on data providers, see the [Amazon Location
3603
- # Service data providers page][1].
3650
+ # For more information about data providers, see [Amazon Location
3651
+ # Service data providers][1].
3604
3652
  #
3605
3653
  #
3606
3654
  #
@@ -3619,7 +3667,7 @@ module Aws::LocationService
3619
3667
  # The pricing plan for the specified place index resource.
3620
3668
  #
3621
3669
  # For additional details and restrictions on each pricing plan option,
3622
- # see the [Amazon Location Service pricing page][1].
3670
+ # see [Amazon Location Service pricing][1].
3623
3671
  #
3624
3672
  #
3625
3673
  #
@@ -3947,7 +3995,7 @@ module Aws::LocationService
3947
3995
  # The pricing plan for the specified tracker resource.
3948
3996
  #
3949
3997
  # For additional details and restrictions on each pricing plan option,
3950
- # see the [Amazon Location Service pricing page][1].
3998
+ # see [Amazon Location Service pricing][1].
3951
3999
  #
3952
4000
  #
3953
4001
  #
@@ -3995,13 +4043,8 @@ module Aws::LocationService
3995
4043
  #
3996
4044
  # @!attribute [rw] style
3997
4045
  # Specifies the map style selected from an available data provider.
3998
- # For additional information on each map style and to preview each map
3999
- # style, see [Esri map
4000
- # styles](location/latest/developerguide/esri.html#esri-map-styles)
4001
- # and [HERE map
4002
- # styles](location/latest/developerguide/HERE.html#HERE-map-styles).
4003
4046
  #
4004
- # Valid [Esri][1] styles:
4047
+ # Valid [Esri map styles][1]\:
4005
4048
  #
4006
4049
  # * `VectorEsriDarkGrayCanvas` – The Esri Dark Gray Canvas map style.
4007
4050
  # A vector basemap with a dark gray, neutral background with minimal
@@ -4031,7 +4074,7 @@ module Aws::LocationService
4031
4074
  # custom navigation map style that's designed for use during the
4032
4075
  # day in mobile devices.
4033
4076
  #
4034
- # Valid [HERE Technologies][2] styles:
4077
+ # Valid [HERE Technologies map styles][2]\:
4035
4078
  #
4036
4079
  # * `VectorHereBerlin` – The HERE Berlin map style is a high contrast
4037
4080
  # detailed base map of the world that blends 3D and 2D rendering.
@@ -4078,6 +4121,19 @@ module Aws::LocationService
4078
4121
  # Places uses a point geometry to specify a location or a Place.
4079
4122
  # @return [Types::PlaceGeometry]
4080
4123
  #
4124
+ # @!attribute [rw] interpolated
4125
+ # `True` if the result is interpolated from other known places.
4126
+ #
4127
+ # `False` if the Place is a known place.
4128
+ #
4129
+ # Not returned when the partner does not provide the information.
4130
+ #
4131
+ # For example, returns `False` for an address location that is found
4132
+ # in the partner data, but returns `True` if an address does not exist
4133
+ # in the partner data and its location is calculated by interpolating
4134
+ # between other known addresses.
4135
+ # @return [Boolean]
4136
+ #
4081
4137
  # @!attribute [rw] label
4082
4138
  # The full name and address of the point of interest such as a city,
4083
4139
  # region, or country. For example, `123 Any Street, Any Town, USA`.
@@ -4108,23 +4164,30 @@ module Aws::LocationService
4108
4164
  # @return [String]
4109
4165
  #
4110
4166
  # @!attribute [rw] sub_region
4111
- # A country, or an area that's part of a larger region . For example,
4167
+ # A country, or an area that's part of a larger region. For example,
4112
4168
  # `Metro Vancouver`.
4113
4169
  # @return [String]
4114
4170
  #
4171
+ # @!attribute [rw] time_zone
4172
+ # The time zone in which the `Place` is located. Returned only when
4173
+ # using Here as the selected partner.
4174
+ # @return [Types::TimeZone]
4175
+ #
4115
4176
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Place AWS API Documentation
4116
4177
  #
4117
4178
  class Place < Struct.new(
4118
4179
  :address_number,
4119
4180
  :country,
4120
4181
  :geometry,
4182
+ :interpolated,
4121
4183
  :label,
4122
4184
  :municipality,
4123
4185
  :neighborhood,
4124
4186
  :postal_code,
4125
4187
  :region,
4126
4188
  :street,
4127
- :sub_region)
4189
+ :sub_region,
4190
+ :time_zone)
4128
4191
  SENSITIVE = []
4129
4192
  include Aws::Structure
4130
4193
  end
@@ -4243,32 +4306,65 @@ module Aws::LocationService
4243
4306
  include Aws::Structure
4244
4307
  end
4245
4308
 
4246
- # Specifies a single point of interest, or Place as a result of a search
4247
- # query obtained from a dataset configured in the place index resource.
4309
+ # Contains a search result from a position search query that is run on a
4310
+ # place index resource.
4311
+ #
4312
+ # @!attribute [rw] distance
4313
+ # The distance in meters of a great-circle arc between the query
4314
+ # position and the result.
4315
+ #
4316
+ # <note markdown="1"> A great-circle arc is the shortest path on a sphere, in this case
4317
+ # the Earth. This returns the shortest distance between two locations.
4318
+ #
4319
+ # </note>
4320
+ # @return [Float]
4248
4321
  #
4249
4322
  # @!attribute [rw] place
4250
- # Contains details about the relevant point of interest.
4323
+ # Details about the search result, such as its address and position.
4251
4324
  # @return [Types::Place]
4252
4325
  #
4253
4326
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForPositionResult AWS API Documentation
4254
4327
  #
4255
4328
  class SearchForPositionResult < Struct.new(
4329
+ :distance,
4256
4330
  :place)
4257
4331
  SENSITIVE = []
4258
4332
  include Aws::Structure
4259
4333
  end
4260
4334
 
4261
- # Contains relevant Places returned by calling
4262
- # `SearchPlaceIndexForText`.
4335
+ # Contains a search result from a text search query that is run on a
4336
+ # place index resource.
4337
+ #
4338
+ # @!attribute [rw] distance
4339
+ # The distance in meters of a great-circle arc between the bias
4340
+ # position specified and the result. `Distance` will be returned only
4341
+ # if a bias position was specified in the query.
4342
+ #
4343
+ # <note markdown="1"> A great-circle arc is the shortest path on a sphere, in this case
4344
+ # the Earth. This returns the shortest distance between two locations.
4345
+ #
4346
+ # </note>
4347
+ # @return [Float]
4263
4348
  #
4264
4349
  # @!attribute [rw] place
4265
- # Contains details about the relevant point of interest.
4350
+ # Details about the search result, such as its address and position.
4266
4351
  # @return [Types::Place]
4267
4352
  #
4353
+ # @!attribute [rw] relevance
4354
+ # The relative confidence in the match for a result among the results
4355
+ # returned. For example, if more fields for an address match
4356
+ # (including house number, street, city, country/region, and postal
4357
+ # code), the relevance score is closer to 1.
4358
+ #
4359
+ # Returned only when the partner selected is Esri.
4360
+ # @return [Float]
4361
+ #
4268
4362
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForTextResult AWS API Documentation
4269
4363
  #
4270
4364
  class SearchForTextResult < Struct.new(
4271
- :place)
4365
+ :distance,
4366
+ :place,
4367
+ :relevance)
4272
4368
  SENSITIVE = []
4273
4369
  include Aws::Structure
4274
4370
  end
@@ -4278,6 +4374,7 @@ module Aws::LocationService
4278
4374
  #
4279
4375
  # {
4280
4376
  # index_name: "ResourceName", # required
4377
+ # language: "LanguageTag",
4281
4378
  # max_results: 1,
4282
4379
  # position: [1.0], # required
4283
4380
  # }
@@ -4286,28 +4383,43 @@ module Aws::LocationService
4286
4383
  # The name of the place index resource you want to use for the search.
4287
4384
  # @return [String]
4288
4385
  #
4386
+ # @!attribute [rw] language
4387
+ # The preferred language used to return results. The value must be a
4388
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4389
+ #
4390
+ # This setting affects the languages used in the results. It does not
4391
+ # change which results are returned. If the language is not specified,
4392
+ # or not supported for a particular result, the partner automatically
4393
+ # chooses a language for the result.
4394
+ #
4395
+ #
4396
+ #
4397
+ # [1]: https://tools.ietf.org/search/bcp47
4398
+ # @return [String]
4399
+ #
4289
4400
  # @!attribute [rw] max_results
4290
- # An optional paramer. The maximum number of results returned per
4401
+ # An optional parameter. The maximum number of results returned per
4291
4402
  # request.
4292
4403
  #
4293
4404
  # Default value: `50`
4294
4405
  # @return [Integer]
4295
4406
  #
4296
4407
  # @!attribute [rw] position
4297
- # Specifies a coordinate for the query defined by a longitude, and
4298
- # latitude.
4299
- #
4300
- # * The first position is the X coordinate, or longitude.
4408
+ # Specifies the longitude and latitude of the position to query.
4301
4409
  #
4302
- # * The second position is the Y coordinate, or latitude.
4410
+ # This parameter must contain a pair of numbers. The first number
4411
+ # represents the X coordinate, or longitude; the second number
4412
+ # represents the Y coordinate, or latitude.
4303
4413
  #
4304
- # For example, `position=xLongitude&position=yLatitude` .
4414
+ # For example, `[-123.1174, 49.2847]` represents a position with
4415
+ # longitude `-123.1174` and latitude `49.2847`.
4305
4416
  # @return [Array<Float>]
4306
4417
  #
4307
4418
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionRequest AWS API Documentation
4308
4419
  #
4309
4420
  class SearchPlaceIndexForPositionRequest < Struct.new(
4310
4421
  :index_name,
4422
+ :language,
4311
4423
  :max_results,
4312
4424
  :position)
4313
4425
  SENSITIVE = [:position]
@@ -4320,7 +4432,9 @@ module Aws::LocationService
4320
4432
  # @return [Array<Types::SearchForPositionResult>]
4321
4433
  #
4322
4434
  # @!attribute [rw] summary
4323
- # Contains a summary of the request.
4435
+ # Contains a summary of the request. Echoes the input values for
4436
+ # `Position`, `Language`, `MaxResults`, and the `DataSource` of the
4437
+ # place index.
4324
4438
  # @return [Types::SearchPlaceIndexForPositionSummary]
4325
4439
  #
4326
4440
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionResponse AWS API Documentation
@@ -4332,40 +4446,50 @@ module Aws::LocationService
4332
4446
  include Aws::Structure
4333
4447
  end
4334
4448
 
4335
- # A summary of the reverse geocoding request sent using
4336
- # `SearchPlaceIndexForPosition`.
4449
+ # A summary of the request sent by using `SearchPlaceIndexForPosition`.
4337
4450
  #
4338
4451
  # @!attribute [rw] data_source
4339
- # The data provider of geospatial data. Indicates one of the available
4340
- # providers:
4452
+ # The geospatial data provider attached to the place index resource
4453
+ # specified in the request. Values can be one of the following:
4341
4454
  #
4342
4455
  # * Esri
4343
4456
  #
4344
- # * HERE
4457
+ # * Here
4345
4458
  #
4346
- # For additional details on data providers, see the [Amazon Location
4347
- # Service data providers page][1].
4459
+ # For more information about data providers, see [Amazon Location
4460
+ # Service data providers][1].
4348
4461
  #
4349
4462
  #
4350
4463
  #
4351
4464
  # [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
4352
4465
  # @return [String]
4353
4466
  #
4467
+ # @!attribute [rw] language
4468
+ # The preferred language used to return results. Matches the language
4469
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4470
+ # example, `en` for English.
4471
+ #
4472
+ #
4473
+ #
4474
+ # [1]: https://tools.ietf.org/search/bcp47
4475
+ # @return [String]
4476
+ #
4354
4477
  # @!attribute [rw] max_results
4355
- # An optional parameter. The maximum number of results returned per
4478
+ # Contains the optional result count limit that is specified in the
4356
4479
  # request.
4357
4480
  #
4358
4481
  # Default value: `50`
4359
4482
  # @return [Integer]
4360
4483
  #
4361
4484
  # @!attribute [rw] position
4362
- # The position given in the reverse geocoding request.
4485
+ # The position specified in the request.
4363
4486
  # @return [Array<Float>]
4364
4487
  #
4365
4488
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionSummary AWS API Documentation
4366
4489
  #
4367
4490
  class SearchPlaceIndexForPositionSummary < Struct.new(
4368
4491
  :data_source,
4492
+ :language,
4369
4493
  :max_results,
4370
4494
  :position)
4371
4495
  SENSITIVE = [:position]
@@ -4380,52 +4504,56 @@ module Aws::LocationService
4380
4504
  # filter_b_box: [1.0],
4381
4505
  # filter_countries: ["CountryCode"],
4382
4506
  # index_name: "ResourceName", # required
4507
+ # language: "LanguageTag",
4383
4508
  # max_results: 1,
4384
4509
  # text: "SyntheticSearchPlaceIndexForTextRequestString", # required
4385
4510
  # }
4386
4511
  #
4387
4512
  # @!attribute [rw] bias_position
4388
- # Searches for results closest to the given position. An optional
4389
- # parameter defined by longitude, and latitude.
4513
+ # An optional parameter that indicates a preference for places that
4514
+ # are closer to a specified position.
4390
4515
  #
4391
- # * The first `bias` position is the X coordinate, or longitude.
4516
+ # If provided, this parameter must contain a pair of numbers. The
4517
+ # first number represents the X coordinate, or longitude; the second
4518
+ # number represents the Y coordinate, or latitude.
4392
4519
  #
4393
- # * The second `bias` position is the Y coordinate, or latitude.
4520
+ # For example, `[-123.1174, 49.2847]` represents the position with
4521
+ # longitude `-123.1174` and latitude `49.2847`.
4394
4522
  #
4395
- # For example, `bias=xLongitude&bias=yLatitude`.
4523
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
4524
+ # both options results in an error.
4525
+ #
4526
+ # </note>
4396
4527
  # @return [Array<Float>]
4397
4528
  #
4398
4529
  # @!attribute [rw] filter_b_box
4399
- # Filters the results by returning only Places within the provided
4400
- # bounding box. An optional parameter.
4401
- #
4402
- # The first 2 `bbox` parameters describe the lower southwest corner:
4403
- #
4404
- # * The first `bbox` position is the X coordinate or longitude of the
4405
- # lower southwest corner.
4406
- #
4407
- # * The second `bbox` position is the Y coordinate or latitude of the
4408
- # lower southwest corner.
4409
- #
4410
- # For example, `bbox=xLongitudeSW&bbox=yLatitudeSW`.
4530
+ # An optional parameter that limits the search results by returning
4531
+ # only places that are within the provided bounding box.
4411
4532
  #
4412
- # The next `bbox` parameters describe the upper northeast corner:
4533
+ # If provided, this parameter must contain a total of four consecutive
4534
+ # numbers in two pairs. The first pair of numbers represents the X and
4535
+ # Y coordinates (longitude and latitude, respectively) of the
4536
+ # southwest corner of the bounding box; the second pair of numbers
4537
+ # represents the X and Y coordinates (longitude and latitude,
4538
+ # respectively) of the northeast corner of the bounding box.
4413
4539
  #
4414
- # * The third `bbox` position is the X coordinate, or longitude of the
4415
- # upper northeast corner.
4540
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
4541
+ # bounding box where the southwest corner has longitude `-12.7935` and
4542
+ # latitude `-37.4835`, and the northeast corner has longitude
4543
+ # `-12.0684` and latitude `-36.9542`.
4416
4544
  #
4417
- # * The fourth `bbox` position is the Y coordinate, or longitude of
4418
- # the upper northeast corner.
4545
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
4546
+ # both options results in an error.
4419
4547
  #
4420
- # For example, `bbox=xLongitudeNE&bbox=yLatitudeNE`
4548
+ # </note>
4421
4549
  # @return [Array<Float>]
4422
4550
  #
4423
4551
  # @!attribute [rw] filter_countries
4424
- # Limits the search to the given a list of countries/regions. An
4425
- # optional parameter.
4552
+ # An optional parameter that limits the search results by returning
4553
+ # only places that are in a specified list of countries.
4426
4554
  #
4427
- # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
4428
- # uses three upper-case characters: `AUS`.
4555
+ # * Valid values include [ISO 3166][1] 3-digit country codes. For
4556
+ # example, Australia uses three upper-case characters: `AUS`.
4429
4557
  #
4430
4558
  # ^
4431
4559
  #
@@ -4438,6 +4566,20 @@ module Aws::LocationService
4438
4566
  # The name of the place index resource you want to use for the search.
4439
4567
  # @return [String]
4440
4568
  #
4569
+ # @!attribute [rw] language
4570
+ # The preferred language used to return results. The value must be a
4571
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4572
+ #
4573
+ # This setting affects the languages used in the results. It does not
4574
+ # change which results are returned. If the language is not specified,
4575
+ # or not supported for a particular result, the partner automatically
4576
+ # chooses a language for the result.
4577
+ #
4578
+ #
4579
+ #
4580
+ # [1]: https://tools.ietf.org/search/bcp47
4581
+ # @return [String]
4582
+ #
4441
4583
  # @!attribute [rw] max_results
4442
4584
  # An optional parameter. The maximum number of results returned per
4443
4585
  # request.
@@ -4446,7 +4588,7 @@ module Aws::LocationService
4446
4588
  # @return [Integer]
4447
4589
  #
4448
4590
  # @!attribute [rw] text
4449
- # The address, name, city, or region to be used in the search. In
4591
+ # The address, name, city, or region to be used in the search in
4450
4592
  # free-form text format. For example, `123 Any Street`.
4451
4593
  # @return [String]
4452
4594
  #
@@ -4457,6 +4599,7 @@ module Aws::LocationService
4457
4599
  :filter_b_box,
4458
4600
  :filter_countries,
4459
4601
  :index_name,
4602
+ :language,
4460
4603
  :max_results,
4461
4604
  :text)
4462
4605
  SENSITIVE = [:bias_position, :filter_b_box, :text]
@@ -4464,15 +4607,16 @@ module Aws::LocationService
4464
4607
  end
4465
4608
 
4466
4609
  # @!attribute [rw] results
4467
- # A list of Places closest to the specified position. Each result
4468
- # contains additional information about the specific point of
4469
- # interest.
4610
+ # A list of Places matching the input text. Each result contains
4611
+ # additional information about the specific point of interest.
4470
4612
  # @return [Array<Types::SearchForTextResult>]
4471
4613
  #
4472
4614
  # @!attribute [rw] summary
4473
- # Contains a summary of the request. Contains the `BiasPosition`,
4474
- # `DataSource`, `FilterBBox`, `FilterCountries`, `MaxResults`,
4475
- # `ResultBBox`, and `Text`.
4615
+ # Contains a summary of the request. Echoes the input values for
4616
+ # `BiasPosition`, `FilterBBox`, `FilterCountries`, `Language`,
4617
+ # `MaxResults`, and `Text`. Also includes the `DataSource` of the
4618
+ # place index and the bounding box, `ResultBBox`, which surrounds the
4619
+ # search results.
4476
4620
  # @return [Types::SearchPlaceIndexForTextSummary]
4477
4621
  #
4478
4622
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextResponse AWS API Documentation
@@ -4484,24 +4628,23 @@ module Aws::LocationService
4484
4628
  include Aws::Structure
4485
4629
  end
4486
4630
 
4487
- # A summary of the geocoding request sent using
4488
- # `SearchPlaceIndexForText`.
4631
+ # A summary of the request sent by using `SearchPlaceIndexForText`.
4489
4632
  #
4490
4633
  # @!attribute [rw] bias_position
4491
- # Contains the coordinates for the bias position entered in the
4492
- # geocoding request.
4634
+ # Contains the coordinates for the optional bias position specified in
4635
+ # the request.
4493
4636
  # @return [Array<Float>]
4494
4637
  #
4495
4638
  # @!attribute [rw] data_source
4496
- # The data provider of geospatial data. Indicates one of the available
4497
- # providers:
4639
+ # The geospatial data provider attached to the place index resource
4640
+ # specified in the request. Values can be one of the following:
4498
4641
  #
4499
4642
  # * Esri
4500
4643
  #
4501
- # * HERE
4644
+ # * Here
4502
4645
  #
4503
- # For additional details on data providers, see the [Amazon Location
4504
- # Service data providers page][1].
4646
+ # For more information about data providers, see [Amazon Location
4647
+ # Service data providers][1].
4505
4648
  #
4506
4649
  #
4507
4650
  #
@@ -4509,27 +4652,39 @@ module Aws::LocationService
4509
4652
  # @return [String]
4510
4653
  #
4511
4654
  # @!attribute [rw] filter_b_box
4512
- # Contains the coordinates for the optional bounding box coordinated
4513
- # entered in the geocoding request.
4655
+ # Contains the coordinates for the optional bounding box specified in
4656
+ # the request.
4514
4657
  # @return [Array<Float>]
4515
4658
  #
4516
4659
  # @!attribute [rw] filter_countries
4517
- # Contains the country filter entered in the geocoding request.
4660
+ # Contains the optional country filter specified in the request.
4518
4661
  # @return [Array<String>]
4519
4662
  #
4663
+ # @!attribute [rw] language
4664
+ # The preferred language used to return results. Matches the language
4665
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4666
+ # example, `en` for English.
4667
+ #
4668
+ #
4669
+ #
4670
+ # [1]: https://tools.ietf.org/search/bcp47
4671
+ # @return [String]
4672
+ #
4520
4673
  # @!attribute [rw] max_results
4521
- # Contains the maximum number of results indicated for the request.
4674
+ # Contains the optional result count limit specified in the request.
4522
4675
  # @return [Integer]
4523
4676
  #
4524
4677
  # @!attribute [rw] result_b_box
4525
- # A bounding box that contains the search results within the specified
4526
- # area indicated by `FilterBBox`. A subset of bounding box specified
4527
- # using `FilterBBox`.
4678
+ # The bounding box that fully contains all search results.
4679
+ #
4680
+ # <note markdown="1"> If you specified the optional `FilterBBox` parameter in the request,
4681
+ # `ResultBBox` is contained within `FilterBBox`.
4682
+ #
4683
+ # </note>
4528
4684
  # @return [Array<Float>]
4529
4685
  #
4530
4686
  # @!attribute [rw] text
4531
- # The address, name, city or region to be used in the geocoding
4532
- # request. In free-form text format. For example, `Vancouver`.
4687
+ # The search text specified in the request.
4533
4688
  # @return [String]
4534
4689
  #
4535
4690
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextSummary AWS API Documentation
@@ -4539,6 +4694,7 @@ module Aws::LocationService
4539
4694
  :data_source,
4540
4695
  :filter_b_box,
4541
4696
  :filter_countries,
4697
+ :language,
4542
4698
  :max_results,
4543
4699
  :result_b_box,
4544
4700
  :text)
@@ -4634,12 +4790,27 @@ module Aws::LocationService
4634
4790
  # @return [String]
4635
4791
  #
4636
4792
  # @!attribute [rw] tags
4637
- # Tags that have been applied to the specified resource. Tags are
4638
- # mapped from the tag key to the tag value: `"TagKey" : "TagValue"`.
4793
+ # Applies one or more tags to specific resource. A tag is a key-value
4794
+ # pair that helps you manage, identify, search, and filter your
4795
+ # resources.
4639
4796
  #
4640
- # * Format example: `\{"tag1" : "value1", "tag2" : "value2"\} `
4797
+ # Format: `"key" : "value"`
4641
4798
  #
4642
- # ^
4799
+ # Restrictions:
4800
+ #
4801
+ # * Maximum 50 tags per resource.
4802
+ #
4803
+ # * Each tag key must be unique and must have exactly one associated
4804
+ # value.
4805
+ #
4806
+ # * Maximum key length: 128 Unicode characters in UTF-8.
4807
+ #
4808
+ # * Maximum value length: 256 Unicode characters in UTF-8.
4809
+ #
4810
+ # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
4811
+ # characters: + - = . \_ : / @
4812
+ #
4813
+ # * Cannot use "aws:" as a prefix for a key.
4643
4814
  # @return [Hash<String,String>]
4644
4815
  #
4645
4816
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResourceRequest AWS API Documentation
@@ -4668,6 +4839,31 @@ module Aws::LocationService
4668
4839
  include Aws::Structure
4669
4840
  end
4670
4841
 
4842
+ # Information about a time zone. Includes the name of the time zone and
4843
+ # the offset from UTC in seconds.
4844
+ #
4845
+ # @!attribute [rw] name
4846
+ # The name of the time zone, following the [ IANA time zone
4847
+ # standard][1]. For example, `America/Los_Angeles`.
4848
+ #
4849
+ #
4850
+ #
4851
+ # [1]: https://www.iana.org/time-zones
4852
+ # @return [String]
4853
+ #
4854
+ # @!attribute [rw] offset
4855
+ # The time zone's offset, in seconds, from UTC.
4856
+ # @return [Integer]
4857
+ #
4858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TimeZone AWS API Documentation
4859
+ #
4860
+ class TimeZone < Struct.new(
4861
+ :name,
4862
+ :offset)
4863
+ SENSITIVE = []
4864
+ include Aws::Structure
4865
+ end
4866
+
4671
4867
  # Contains details about the truck dimensions in the unit of measurement
4672
4868
  # that you specify. Used to filter out roads that can't support or
4673
4869
  # allow the specified dimensions for requests that specify `TravelMode`
@@ -5117,6 +5313,7 @@ module Aws::LocationService
5117
5313
  #
5118
5314
  # {
5119
5315
  # description: "ResourceDescription",
5316
+ # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
5120
5317
  # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
5121
5318
  # pricing_plan_data_source: "String",
5122
5319
  # tracker_name: "ResourceName", # required
@@ -5126,6 +5323,25 @@ module Aws::LocationService
5126
5323
  # Updates the description for the tracker resource.
5127
5324
  # @return [String]
5128
5325
  #
5326
+ # @!attribute [rw] position_filtering
5327
+ # Updates the position filtering for the tracker resource.
5328
+ #
5329
+ # Valid values:
5330
+ #
5331
+ # * `TimeBased` - Location updates are evaluated against linked
5332
+ # geofence collections, but not every location update is stored. If
5333
+ # your update frequency is more often than 30 seconds, only one
5334
+ # update per 30 seconds is stored for each unique device ID.
5335
+ #
5336
+ # * `DistanceBased` - If the device has moved less than 30 m (98.4
5337
+ # ft), location updates are ignored. Location updates within this
5338
+ # distance are neither evaluated against linked geofence
5339
+ # collections, nor stored. This helps control costs by reducing the
5340
+ # number of geofence evaluations and device positions to retrieve.
5341
+ # Distance-based filtering can also reduce the jitter effect when
5342
+ # displaying device trajectory on a map.
5343
+ # @return [String]
5344
+ #
5129
5345
  # @!attribute [rw] pricing_plan
5130
5346
  # Updates the pricing plan for the tracker resource.
5131
5347
  #
@@ -5170,6 +5386,7 @@ module Aws::LocationService
5170
5386
  #
5171
5387
  class UpdateTrackerRequest < Struct.new(
5172
5388
  :description,
5389
+ :position_filtering,
5173
5390
  :pricing_plan,
5174
5391
  :pricing_plan_data_source,
5175
5392
  :tracker_name)