aws-sdk-locationservice 1.14.0 → 1.18.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -621,6 +621,266 @@ module Aws::LocationService
621
621
  include Aws::Structure
622
622
  end
623
623
 
624
+ # @note When making an API call, you may pass CalculateRouteMatrixRequest
625
+ # data as a hash:
626
+ #
627
+ # {
628
+ # calculator_name: "ResourceName", # required
629
+ # car_mode_options: {
630
+ # avoid_ferries: false,
631
+ # avoid_tolls: false,
632
+ # },
633
+ # depart_now: false,
634
+ # departure_positions: [ # required
635
+ # [1.0],
636
+ # ],
637
+ # departure_time: Time.now,
638
+ # destination_positions: [ # required
639
+ # [1.0],
640
+ # ],
641
+ # distance_unit: "Kilometers", # accepts Kilometers, Miles
642
+ # travel_mode: "Car", # accepts Car, Truck, Walking
643
+ # truck_mode_options: {
644
+ # avoid_ferries: false,
645
+ # avoid_tolls: false,
646
+ # dimensions: {
647
+ # height: 1.0,
648
+ # length: 1.0,
649
+ # unit: "Meters", # accepts Meters, Feet
650
+ # width: 1.0,
651
+ # },
652
+ # weight: {
653
+ # total: 1.0,
654
+ # unit: "Kilograms", # accepts Kilograms, Pounds
655
+ # },
656
+ # },
657
+ # }
658
+ #
659
+ # @!attribute [rw] calculator_name
660
+ # The name of the route calculator resource that you want to use to
661
+ # calculate the route matrix.
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] car_mode_options
665
+ # Specifies route preferences when traveling by `Car`, such as
666
+ # avoiding routes that use ferries or tolls.
667
+ #
668
+ # Requirements: `TravelMode` must be specified as `Car`.
669
+ # @return [Types::CalculateRouteCarModeOptions]
670
+ #
671
+ # @!attribute [rw] depart_now
672
+ # Sets the time of departure as the current time. Uses the current
673
+ # time to calculate the route matrix. You can't set both
674
+ # `DepartureTime` and `DepartNow`. If neither is set, the best time of
675
+ # day to travel with the best traffic conditions is used to calculate
676
+ # the route matrix.
677
+ #
678
+ # Default Value: `false`
679
+ #
680
+ # Valid Values: `false` \| `true`
681
+ # @return [Boolean]
682
+ #
683
+ # @!attribute [rw] departure_positions
684
+ # The list of departure (origin) positions for the route matrix. An
685
+ # array of points, each of which is itself a 2-value array defined in
686
+ # [WGS 84][1] format: `[longitude, latitude]`. For example,
687
+ # `[-123.115, 49.285]`.
688
+ #
689
+ # Depending on the data provider selected in the route calculator
690
+ # resource there may be additional restrictions on the inputs you can
691
+ # choose. See [ Position restrictions][2] in the *Amazon Location
692
+ # Service Developer Guide*.
693
+ #
694
+ # <note markdown="1"> For route calculators that use Esri as the data provider, if you
695
+ # specify a departure that's not located on a road, Amazon Location [
696
+ # moves the position to the nearest road][3]. The snapped value is
697
+ # available in the result in `SnappedDeparturePositions`.
698
+ #
699
+ # </note>
700
+ #
701
+ # Valid Values: `[-180 to 180,-90 to 90]`
702
+ #
703
+ #
704
+ #
705
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
706
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
707
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
708
+ # @return [Array<Array<Float>>]
709
+ #
710
+ # @!attribute [rw] departure_time
711
+ # Specifies the desired time of departure. Uses the given time to
712
+ # calculate the route matrix. You can't set both `DepartureTime` and
713
+ # `DepartNow`. If neither is set, the best time of day to travel with
714
+ # the best traffic conditions is used to calculate the route matrix.
715
+ #
716
+ # <note markdown="1"> Setting a departure time in the past returns a `400
717
+ # ValidationException` error.
718
+ #
719
+ # </note>
720
+ #
721
+ # * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
722
+ # `2020–07-2T12:15:20.000Z+01:00`
723
+ #
724
+ # ^
725
+ #
726
+ #
727
+ #
728
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
729
+ # @return [Time]
730
+ #
731
+ # @!attribute [rw] destination_positions
732
+ # The list of destination positions for the route matrix. An array of
733
+ # points, each of which is itself a 2-value array defined in [WGS
734
+ # 84][1] format: `[longitude, latitude]`. For example, `[-122.339,
735
+ # 47.615]`
736
+ #
737
+ # Depending on the data provider selected in the route calculator
738
+ # resource there may be additional restrictions on the inputs you can
739
+ # choose. See [ Position restrictions][2] in the *Amazon Location
740
+ # Service Developer Guide*.
741
+ #
742
+ # <note markdown="1"> For route calculators that use Esri as the data provider, if you
743
+ # specify a destination that's not located on a road, Amazon Location
744
+ # [ moves the position to the nearest road][3]. The snapped value is
745
+ # available in the result in `SnappedDestinationPositions`.
746
+ #
747
+ # </note>
748
+ #
749
+ # Valid Values: `[-180 to 180,-90 to 90]`
750
+ #
751
+ #
752
+ #
753
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
754
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
755
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
756
+ # @return [Array<Array<Float>>]
757
+ #
758
+ # @!attribute [rw] distance_unit
759
+ # Set the unit system to specify the distance.
760
+ #
761
+ # Default Value: `Kilometers`
762
+ # @return [String]
763
+ #
764
+ # @!attribute [rw] travel_mode
765
+ # Specifies the mode of transport when calculating a route. Used in
766
+ # estimating the speed of travel and road compatibility.
767
+ #
768
+ # The `TravelMode` you specify also determines how you specify route
769
+ # preferences:
770
+ #
771
+ # * If traveling by `Car` use the `CarModeOptions` parameter.
772
+ #
773
+ # * If traveling by `Truck` use the `TruckModeOptions` parameter.
774
+ #
775
+ # Default Value: `Car`
776
+ # @return [String]
777
+ #
778
+ # @!attribute [rw] truck_mode_options
779
+ # Specifies route preferences when traveling by `Truck`, such as
780
+ # avoiding routes that use ferries or tolls, and truck specifications
781
+ # to consider when choosing an optimal road.
782
+ #
783
+ # Requirements: `TravelMode` must be specified as `Truck`.
784
+ # @return [Types::CalculateRouteTruckModeOptions]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrixRequest AWS API Documentation
787
+ #
788
+ class CalculateRouteMatrixRequest < Struct.new(
789
+ :calculator_name,
790
+ :car_mode_options,
791
+ :depart_now,
792
+ :departure_positions,
793
+ :departure_time,
794
+ :destination_positions,
795
+ :distance_unit,
796
+ :travel_mode,
797
+ :truck_mode_options)
798
+ SENSITIVE = []
799
+ include Aws::Structure
800
+ end
801
+
802
+ # Returns the result of the route matrix calculation.
803
+ #
804
+ # @!attribute [rw] route_matrix
805
+ # The calculated route matrix containing the results for all pairs of
806
+ # `DeparturePositions` to `DestinationPositions`. Each row corresponds
807
+ # to one entry in `DeparturePositions`. Each entry in the row
808
+ # corresponds to the route from that entry in `DeparturePositions` to
809
+ # an entry in `DestinationPositions`.
810
+ # @return [Array<Array<Types::RouteMatrixEntry>>]
811
+ #
812
+ # @!attribute [rw] snapped_departure_positions
813
+ # For routes calculated using an Esri route calculator resource,
814
+ # departure positions are snapped to the closest road. For Esri route
815
+ # calculator resources, this returns the list of departure/origin
816
+ # positions used for calculation of the `RouteMatrix`.
817
+ # @return [Array<Array<Float>>]
818
+ #
819
+ # @!attribute [rw] snapped_destination_positions
820
+ # The list of destination positions for the route matrix used for
821
+ # calculation of the `RouteMatrix`.
822
+ # @return [Array<Array<Float>>]
823
+ #
824
+ # @!attribute [rw] summary
825
+ # Contains information about the route matrix, `DataSource`,
826
+ # `DistanceUnit`, `RouteCount` and `ErrorCount`.
827
+ # @return [Types::CalculateRouteMatrixSummary]
828
+ #
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrixResponse AWS API Documentation
830
+ #
831
+ class CalculateRouteMatrixResponse < Struct.new(
832
+ :route_matrix,
833
+ :snapped_departure_positions,
834
+ :snapped_destination_positions,
835
+ :summary)
836
+ SENSITIVE = []
837
+ include Aws::Structure
838
+ end
839
+
840
+ # A summary of the calculated route matrix.
841
+ #
842
+ # @!attribute [rw] data_source
843
+ # The data provider of traffic and road network data used to calculate
844
+ # the routes. Indicates one of the available providers:
845
+ #
846
+ # * `Esri`
847
+ #
848
+ # * `Here`
849
+ #
850
+ # For more information about data providers, see [Amazon Location
851
+ # Service data providers][1].
852
+ #
853
+ #
854
+ #
855
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
856
+ # @return [String]
857
+ #
858
+ # @!attribute [rw] distance_unit
859
+ # The unit of measurement for route distances.
860
+ # @return [String]
861
+ #
862
+ # @!attribute [rw] error_count
863
+ # The count of error results in the route matrix. If this number is 0,
864
+ # all routes were calculated successfully.
865
+ # @return [Integer]
866
+ #
867
+ # @!attribute [rw] route_count
868
+ # The count of cells in the route matrix. Equal to the number of
869
+ # `DeparturePositions` multiplied by the number of
870
+ # `DestinationPositions`.
871
+ # @return [Integer]
872
+ #
873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrixSummary AWS API Documentation
874
+ #
875
+ class CalculateRouteMatrixSummary < Struct.new(
876
+ :data_source,
877
+ :distance_unit,
878
+ :error_count,
879
+ :route_count)
880
+ SENSITIVE = []
881
+ include Aws::Structure
882
+ end
883
+
624
884
  # @note When making an API call, you may pass CalculateRouteRequest
625
885
  # data as a hash:
626
886
  #
@@ -698,7 +958,7 @@ module Aws::LocationService
698
958
  #
699
959
  #
700
960
  # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
701
- # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
961
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
702
962
  # @return [Array<Float>]
703
963
  #
704
964
  # @!attribute [rw] departure_time
@@ -739,7 +999,7 @@ module Aws::LocationService
739
999
  #
740
1000
  #
741
1001
  # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
742
- # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
1002
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
743
1003
  # @return [Array<Float>]
744
1004
  #
745
1005
  # @!attribute [rw] distance_unit
@@ -761,7 +1021,7 @@ module Aws::LocationService
761
1021
  # Specifies the mode of transport when calculating a route. Used in
762
1022
  # estimating the speed of travel and road compatibility.
763
1023
  #
764
- # The `TravelMode` you specify determines how you specify route
1024
+ # The `TravelMode` you specify also determines how you specify route
765
1025
  # preferences:
766
1026
  #
767
1027
  # * If traveling by `Car` use the `CarModeOptions` parameter.
@@ -806,7 +1066,7 @@ module Aws::LocationService
806
1066
  #
807
1067
  #
808
1068
  #
809
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
1069
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
810
1070
  # @return [Array<Array<Float>>]
811
1071
  #
812
1072
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteRequest AWS API Documentation
@@ -857,7 +1117,7 @@ module Aws::LocationService
857
1117
  #
858
1118
  #
859
1119
  #
860
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
1120
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
861
1121
  # @return [Array<Types::Leg>]
862
1122
  #
863
1123
  # @!attribute [rw] summary
@@ -1026,7 +1286,7 @@ module Aws::LocationService
1026
1286
  # collection_name: "ResourceName", # required
1027
1287
  # description: "ResourceDescription",
1028
1288
  # kms_key_id: "KmsKeyId",
1029
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1289
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1030
1290
  # pricing_plan_data_source: "String",
1031
1291
  # tags: {
1032
1292
  # "TagKey" => "TagValue",
@@ -1060,40 +1320,12 @@ module Aws::LocationService
1060
1320
  # @return [String]
1061
1321
  #
1062
1322
  # @!attribute [rw] pricing_plan
1063
- # Specifies the pricing plan for the geofence collection.
1064
- #
1065
- # For additional details and restrictions on each pricing plan option,
1066
- # see the [Amazon Location Service pricing page][1].
1067
- #
1068
- #
1069
- #
1070
- # [1]: https://aws.amazon.com/location/pricing/
1323
+ # No longer used. If included, the only allowed value is
1324
+ # `RequestBasedUsage`.
1071
1325
  # @return [String]
1072
1326
  #
1073
1327
  # @!attribute [rw] pricing_plan_data_source
1074
- # Specifies the data provider for the geofence collection.
1075
- #
1076
- # * Required value for the following pricing plans:
1077
- # `MobileAssetTracking `\| `MobileAssetManagement`
1078
- #
1079
- # ^
1080
- #
1081
- # For more information about [Data Providers][1], and [Pricing
1082
- # plans][2], see the Amazon Location Service product page.
1083
- #
1084
- # <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to
1085
- # calculate billing for your geofence collection. Your data won't be
1086
- # shared with the data provider, and will remain in your AWS account
1087
- # or Region unless you move it.
1088
- #
1089
- # </note>
1090
- #
1091
- # Valid Values: `Esri `\| `Here`
1092
- #
1093
- #
1094
- #
1095
- # [1]: https://aws.amazon.com/location/data-providers/
1096
- # [2]: https://aws.amazon.com/location/pricing/
1328
+ # This parameter is no longer used.
1097
1329
  # @return [String]
1098
1330
  #
1099
1331
  # @!attribute [rw] tags
@@ -1174,7 +1406,7 @@ module Aws::LocationService
1174
1406
  # },
1175
1407
  # description: "ResourceDescription",
1176
1408
  # map_name: "ResourceName", # required
1177
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1409
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1178
1410
  # tags: {
1179
1411
  # "TagKey" => "TagValue",
1180
1412
  # },
@@ -1202,14 +1434,8 @@ module Aws::LocationService
1202
1434
  # @return [String]
1203
1435
  #
1204
1436
  # @!attribute [rw] pricing_plan
1205
- # Specifies the pricing plan for your map resource.
1206
- #
1207
- # For additional details and restrictions on each pricing plan option,
1208
- # see [Amazon Location Service pricing][1].
1209
- #
1210
- #
1211
- #
1212
- # [1]: https://aws.amazon.com/location/pricing/
1437
+ # No longer used. If included, the only allowed value is
1438
+ # `RequestBasedUsage`.
1213
1439
  # @return [String]
1214
1440
  #
1215
1441
  # @!attribute [rw] tags
@@ -1289,7 +1515,7 @@ module Aws::LocationService
1289
1515
  # },
1290
1516
  # description: "ResourceDescription",
1291
1517
  # index_name: "ResourceName", # required
1292
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1518
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1293
1519
  # tags: {
1294
1520
  # "TagKey" => "TagValue",
1295
1521
  # },
@@ -1354,14 +1580,8 @@ module Aws::LocationService
1354
1580
  # @return [String]
1355
1581
  #
1356
1582
  # @!attribute [rw] pricing_plan
1357
- # Specifies the pricing plan for your place index resource.
1358
- #
1359
- # For additional details and restrictions on each pricing plan option,
1360
- # see [Amazon Location Service pricing][1].
1361
- #
1362
- #
1363
- #
1364
- # [1]: https://aws.amazon.com/location/pricing/
1583
+ # No longer used. If included, the only allowed value is
1584
+ # `RequestBasedUsage`.
1365
1585
  # @return [String]
1366
1586
  #
1367
1587
  # @!attribute [rw] tags
@@ -1441,7 +1661,7 @@ module Aws::LocationService
1441
1661
  # calculator_name: "ResourceName", # required
1442
1662
  # data_source: "String", # required
1443
1663
  # description: "ResourceDescription",
1444
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1664
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1445
1665
  # tags: {
1446
1666
  # "TagKey" => "TagValue",
1447
1667
  # },
@@ -1498,14 +1718,8 @@ module Aws::LocationService
1498
1718
  # @return [String]
1499
1719
  #
1500
1720
  # @!attribute [rw] pricing_plan
1501
- # Specifies the pricing plan for your route calculator resource.
1502
- #
1503
- # For additional details and restrictions on each pricing plan option,
1504
- # see [Amazon Location Service pricing][1].
1505
- #
1506
- #
1507
- #
1508
- # [1]: https://aws.amazon.com/location/pricing/
1721
+ # No longer used. If included, the only allowed value is
1722
+ # `RequestBasedUsage`.
1509
1723
  # @return [String]
1510
1724
  #
1511
1725
  # @!attribute [rw] tags
@@ -1595,7 +1809,7 @@ module Aws::LocationService
1595
1809
  # description: "ResourceDescription",
1596
1810
  # kms_key_id: "KmsKeyId",
1597
1811
  # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
1598
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1812
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1599
1813
  # pricing_plan_data_source: "String",
1600
1814
  # tags: {
1601
1815
  # "TagKey" => "TagValue",
@@ -1649,40 +1863,12 @@ module Aws::LocationService
1649
1863
  # @return [String]
1650
1864
  #
1651
1865
  # @!attribute [rw] pricing_plan
1652
- # Specifies the pricing plan for the tracker resource.
1653
- #
1654
- # For additional details and restrictions on each pricing plan option,
1655
- # see [Amazon Location Service pricing][1].
1656
- #
1657
- #
1658
- #
1659
- # [1]: https://aws.amazon.com/location/pricing/
1866
+ # No longer used. If included, the only allowed value is
1867
+ # `RequestBasedUsage`.
1660
1868
  # @return [String]
1661
1869
  #
1662
1870
  # @!attribute [rw] pricing_plan_data_source
1663
- # Specifies the data provider for the tracker resource.
1664
- #
1665
- # * Required value for the following pricing plans:
1666
- # `MobileAssetTracking `\| `MobileAssetManagement`
1667
- #
1668
- # ^
1669
- #
1670
- # For more information about [Data Providers][1], and [Pricing
1671
- # plans][2], see the Amazon Location Service product page.
1672
- #
1673
- # <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to
1674
- # calculate billing for your tracker resource. Your data will not be
1675
- # shared with the data provider, and will remain in your AWS account
1676
- # or Region unless you move it.
1677
- #
1678
- # </note>
1679
- #
1680
- # Valid values: `Esri` \| `Here`
1681
- #
1682
- #
1683
- #
1684
- # [1]: https://aws.amazon.com/location/data-providers/
1685
- # [2]: https://aws.amazon.com/location/pricing/
1871
+ # This parameter is no longer used.
1686
1872
  # @return [String]
1687
1873
  #
1688
1874
  # @!attribute [rw] tags
@@ -1988,18 +2174,11 @@ module Aws::LocationService
1988
2174
  # @return [String]
1989
2175
  #
1990
2176
  # @!attribute [rw] pricing_plan
1991
- # The pricing plan selected for the specified geofence collection.
1992
- #
1993
- # For additional details and restrictions on each pricing plan option,
1994
- # see the [Amazon Location Service pricing page][1].
1995
- #
1996
- #
1997
- #
1998
- # [1]: https://aws.amazon.com/location/pricing/
2177
+ # No longer used. Always returns `RequestBasedUsage`.
1999
2178
  # @return [String]
2000
2179
  #
2001
2180
  # @!attribute [rw] pricing_plan_data_source
2002
- # The specified data provider for the geofence collection.
2181
+ # No longer used. Always returns an empty string.
2003
2182
  # @return [String]
2004
2183
  #
2005
2184
  # @!attribute [rw] tags
@@ -2085,9 +2264,7 @@ module Aws::LocationService
2085
2264
  # @return [String]
2086
2265
  #
2087
2266
  # @!attribute [rw] pricing_plan
2088
- # The pricing plan selected for the specified map resource.
2089
- #
2090
- # <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>
2267
+ # No longer used. Always returns `RequestBasedUsage`.
2091
2268
  # @return [String]
2092
2269
  #
2093
2270
  # @!attribute [rw] tags
@@ -2186,14 +2363,7 @@ module Aws::LocationService
2186
2363
  # @return [String]
2187
2364
  #
2188
2365
  # @!attribute [rw] pricing_plan
2189
- # The pricing plan selected for the specified place index resource.
2190
- #
2191
- # For additional details and restrictions on each pricing plan option,
2192
- # see [Amazon Location Service pricing][1].
2193
- #
2194
- #
2195
- #
2196
- # [1]: https://aws.amazon.com/location/pricing/
2366
+ # No longer used. Always returns `RequestBasedUsage`.
2197
2367
  # @return [String]
2198
2368
  #
2199
2369
  # @!attribute [rw] tags
@@ -2292,15 +2462,7 @@ module Aws::LocationService
2292
2462
  # @return [String]
2293
2463
  #
2294
2464
  # @!attribute [rw] pricing_plan
2295
- # The pricing plan selected for the specified route calculator
2296
- # resource.
2297
- #
2298
- # For additional details and restrictions on each pricing plan option,
2299
- # see [Amazon Location Service pricing][1].
2300
- #
2301
- #
2302
- #
2303
- # [1]: https://aws.amazon.com/location/pricing/
2465
+ # Always returns `RequestBasedUsage`.
2304
2466
  # @return [String]
2305
2467
  #
2306
2468
  # @!attribute [rw] tags
@@ -2381,18 +2543,11 @@ module Aws::LocationService
2381
2543
  # @return [String]
2382
2544
  #
2383
2545
  # @!attribute [rw] pricing_plan
2384
- # The pricing plan selected for the specified tracker resource.
2385
- #
2386
- # For additional details and restrictions on each pricing plan option,
2387
- # see [Amazon Location Service pricing][1].
2388
- #
2389
- #
2390
- #
2391
- # [1]: https://aws.amazon.com/location/pricing/
2546
+ # Always returns `RequestBasedUsage`.
2392
2547
  # @return [String]
2393
2548
  #
2394
2549
  # @!attribute [rw] pricing_plan_data_source
2395
- # The specified data provider for the tracker resource.
2550
+ # No longer used. Always returns an empty string.
2396
2551
  # @return [String]
2397
2552
  #
2398
2553
  # @!attribute [rw] tags
@@ -3139,7 +3294,7 @@ module Aws::LocationService
3139
3294
  #
3140
3295
  #
3141
3296
  #
3142
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
3297
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
3143
3298
  #
3144
3299
  # @!attribute [rw] distance
3145
3300
  # The distance between the leg's `StartPosition` and `EndPosition`
@@ -3168,7 +3323,7 @@ module Aws::LocationService
3168
3323
  #
3169
3324
  #
3170
3325
  #
3171
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
3326
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html
3172
3327
  # @return [Array<Float>]
3173
3328
  #
3174
3329
  # @!attribute [rw] geometry
@@ -3186,7 +3341,7 @@ module Aws::LocationService
3186
3341
  #
3187
3342
  #
3188
3343
  #
3189
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
3344
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
3190
3345
  # @return [Array<Float>]
3191
3346
  #
3192
3347
  # @!attribute [rw] steps
@@ -3403,18 +3558,11 @@ module Aws::LocationService
3403
3558
  # @return [String]
3404
3559
  #
3405
3560
  # @!attribute [rw] pricing_plan
3406
- # The pricing plan for the specified geofence collection.
3407
- #
3408
- # For additional details and restrictions on each pricing plan option,
3409
- # see the [Amazon Location Service pricing page][1].
3410
- #
3411
- #
3412
- #
3413
- # [1]: https://aws.amazon.com/location/pricing/
3561
+ # No longer used. Always returns `RequestBasedUsage`.
3414
3562
  # @return [String]
3415
3563
  #
3416
3564
  # @!attribute [rw] pricing_plan_data_source
3417
- # The specified data provider for the geofence collection.
3565
+ # No longer used. Always returns an empty string.
3418
3566
  # @return [String]
3419
3567
  #
3420
3568
  # @!attribute [rw] update_time
@@ -3617,14 +3765,7 @@ module Aws::LocationService
3617
3765
  # @return [String]
3618
3766
  #
3619
3767
  # @!attribute [rw] pricing_plan
3620
- # The pricing plan for the specified map resource.
3621
- #
3622
- # For additional details and restrictions on each pricing plan option,
3623
- # see [Amazon Location Service pricing][1].
3624
- #
3625
- #
3626
- #
3627
- # [1]: https://aws.amazon.com/location/pricing/
3768
+ # No longer used. Always returns `RequestBasedUsage`.
3628
3769
  # @return [String]
3629
3770
  #
3630
3771
  # @!attribute [rw] update_time
@@ -3736,14 +3877,7 @@ module Aws::LocationService
3736
3877
  # @return [String]
3737
3878
  #
3738
3879
  # @!attribute [rw] pricing_plan
3739
- # The pricing plan for the specified place index resource.
3740
- #
3741
- # For additional details and restrictions on each pricing plan option,
3742
- # see [Amazon Location Service pricing][1].
3743
- #
3744
- #
3745
- #
3746
- # [1]: https://aws.amazon.com/location/pricing/
3880
+ # No longer used. Always returns `RequestBasedUsage`.
3747
3881
  # @return [String]
3748
3882
  #
3749
3883
  # @!attribute [rw] update_time
@@ -3858,14 +3992,7 @@ module Aws::LocationService
3858
3992
  # @return [String]
3859
3993
  #
3860
3994
  # @!attribute [rw] pricing_plan
3861
- # The pricing plan for the specified route calculator resource.
3862
- #
3863
- # For additional details and restrictions on each pricing plan option,
3864
- # see [Amazon Location Service pricing][1].
3865
- #
3866
- #
3867
- #
3868
- # [1]: https://aws.amazon.com/location/pricing/
3995
+ # Always returns `RequestBasedUsage`.
3869
3996
  # @return [String]
3870
3997
  #
3871
3998
  # @!attribute [rw] update_time
@@ -4064,18 +4191,11 @@ module Aws::LocationService
4064
4191
  # @return [String]
4065
4192
  #
4066
4193
  # @!attribute [rw] pricing_plan
4067
- # The pricing plan for the specified tracker resource.
4068
- #
4069
- # For additional details and restrictions on each pricing plan option,
4070
- # see [Amazon Location Service pricing][1].
4071
- #
4072
- #
4073
- #
4074
- # [1]: https://aws.amazon.com/location/pricing/
4194
+ # Always returns `RequestBasedUsage`.
4075
4195
  # @return [String]
4076
4196
  #
4077
4197
  # @!attribute [rw] pricing_plan_data_source
4078
- # The specified data provider for the tracker resource.
4198
+ # No longer used. Always returns an empty string.
4079
4199
  # @return [String]
4080
4200
  #
4081
4201
  # @!attribute [rw] tracker_name
@@ -4400,6 +4520,89 @@ module Aws::LocationService
4400
4520
  include Aws::Structure
4401
4521
  end
4402
4522
 
4523
+ # The result for one `SnappedDeparturePosition`
4524
+ # `SnappedDestinationPosition` pair.
4525
+ #
4526
+ # @!attribute [rw] distance
4527
+ # The total distance of travel for the route.
4528
+ # @return [Float]
4529
+ #
4530
+ # @!attribute [rw] duration_seconds
4531
+ # The expected duration of travel for the route.
4532
+ # @return [Float]
4533
+ #
4534
+ # @!attribute [rw] error
4535
+ # An error corresponding to the calculation of a route between the
4536
+ # `DeparturePosition` and `DestinationPosition`.
4537
+ # @return [Types::RouteMatrixEntryError]
4538
+ #
4539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/RouteMatrixEntry AWS API Documentation
4540
+ #
4541
+ class RouteMatrixEntry < Struct.new(
4542
+ :distance,
4543
+ :duration_seconds,
4544
+ :error)
4545
+ SENSITIVE = []
4546
+ include Aws::Structure
4547
+ end
4548
+
4549
+ # An error corresponding to the calculation of a route between the
4550
+ # `DeparturePosition` and `DestinationPosition`.
4551
+ #
4552
+ # The error code can be one of the following:
4553
+ #
4554
+ # * `RouteNotFound` - Unable to find a valid route with the given
4555
+ # parameters.
4556
+ #
4557
+ # ^
4558
+ # ^
4559
+ #
4560
+ # * `RouteTooLong` - Route calculation went beyond the maximum size of a
4561
+ # route and was terminated before completion.
4562
+ #
4563
+ # ^
4564
+ # ^
4565
+ #
4566
+ # * `PositionsNotFound` - One or more of the input positions were not
4567
+ # found on the route network.
4568
+ #
4569
+ # ^
4570
+ # ^
4571
+ #
4572
+ # * `DestinationPositionNotFound` - The destination position was not
4573
+ # found on the route network.
4574
+ #
4575
+ # ^
4576
+ # ^
4577
+ #
4578
+ # * `DeparturePositionNotFound` - The departure position was not found
4579
+ # on the route network.
4580
+ #
4581
+ # ^
4582
+ # ^
4583
+ #
4584
+ # * `OtherValidationError` - The given inputs were not valid or a route
4585
+ # was not found. More information is given in the error `Message`
4586
+ #
4587
+ # ^
4588
+ #
4589
+ # @!attribute [rw] code
4590
+ # The type of error which occurred for the route calculation.
4591
+ # @return [String]
4592
+ #
4593
+ # @!attribute [rw] message
4594
+ # A message about the error that occurred for the route calculation.
4595
+ # @return [String]
4596
+ #
4597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/RouteMatrixEntryError AWS API Documentation
4598
+ #
4599
+ class RouteMatrixEntryError < Struct.new(
4600
+ :code,
4601
+ :message)
4602
+ SENSITIVE = []
4603
+ include Aws::Structure
4604
+ end
4605
+
4403
4606
  # Contains a search result from a position search query that is run on a
4404
4607
  # place index resource.
4405
4608
  #
@@ -5330,39 +5533,12 @@ module Aws::LocationService
5330
5533
  # @return [String]
5331
5534
  #
5332
5535
  # @!attribute [rw] pricing_plan
5333
- # Updates the pricing plan for the geofence collection.
5334
- #
5335
- # For more information about each pricing plan option restrictions,
5336
- # see [Amazon Location Service pricing][1].
5337
- #
5338
- #
5339
- #
5340
- # [1]: https://aws.amazon.com/location/pricing/
5536
+ # No longer used. If included, the only allowed value is
5537
+ # `RequestBasedUsage`.
5341
5538
  # @return [String]
5342
5539
  #
5343
5540
  # @!attribute [rw] pricing_plan_data_source
5344
- # Updates the data provider for the geofence collection.
5345
- #
5346
- # A required value for the following pricing plans:
5347
- # `MobileAssetTracking`\| `MobileAssetManagement`
5348
- #
5349
- # For more information about [data providers][1] and [pricing
5350
- # plans][2], see the Amazon Location Service product page.
5351
- #
5352
- # <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
5353
- # request.
5354
- #
5355
- # Amazon Location Service uses `PricingPlanDataSource` to calculate
5356
- # billing for your geofence collection. Your data won't be shared
5357
- # with the data provider, and will remain in your AWS account and
5358
- # Region unless you move it.
5359
- #
5360
- # </note>
5361
- #
5362
- #
5363
- #
5364
- # [1]: https://aws.amazon.com/location/data-providers/
5365
- # [2]: https://aws.amazon.com/location/pricing/
5541
+ # This parameter is no longer used.
5366
5542
  # @return [String]
5367
5543
  #
5368
5544
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollectionRequest AWS API Documentation
@@ -5427,14 +5603,8 @@ module Aws::LocationService
5427
5603
  # @return [String]
5428
5604
  #
5429
5605
  # @!attribute [rw] pricing_plan
5430
- # Updates the pricing plan for the map resource.
5431
- #
5432
- # For more information about each pricing plan option restrictions,
5433
- # see [Amazon Location Service pricing][1].
5434
- #
5435
- #
5436
- #
5437
- # [1]: https://aws.amazon.com/location/pricing/
5606
+ # No longer used. If included, the only allowed value is
5607
+ # `RequestBasedUsage`.
5438
5608
  # @return [String]
5439
5609
  #
5440
5610
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMapRequest AWS API Documentation
@@ -5504,14 +5674,8 @@ module Aws::LocationService
5504
5674
  # @return [String]
5505
5675
  #
5506
5676
  # @!attribute [rw] pricing_plan
5507
- # Updates the pricing plan for the place index resource.
5508
- #
5509
- # For more information about each pricing plan option restrictions,
5510
- # see [Amazon Location Service pricing][1].
5511
- #
5512
- #
5513
- #
5514
- # [1]: https://aws.amazon.com/location/pricing/
5677
+ # No longer used. If included, the only allowed value is
5678
+ # `RequestBasedUsage`.
5515
5679
  # @return [String]
5516
5680
  #
5517
5681
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndexRequest AWS API Documentation
@@ -5576,14 +5740,8 @@ module Aws::LocationService
5576
5740
  # @return [String]
5577
5741
  #
5578
5742
  # @!attribute [rw] pricing_plan
5579
- # Updates the pricing plan for the route calculator resource.
5580
- #
5581
- # For more information about each pricing plan option restrictions,
5582
- # see [Amazon Location Service pricing][1].
5583
- #
5584
- #
5585
- #
5586
- # [1]: https://aws.amazon.com/location/pricing/
5743
+ # No longer used. If included, the only allowed value is
5744
+ # `RequestBasedUsage`.
5587
5745
  # @return [String]
5588
5746
  #
5589
5747
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculatorRequest AWS API Documentation
@@ -5674,39 +5832,12 @@ module Aws::LocationService
5674
5832
  # @return [String]
5675
5833
  #
5676
5834
  # @!attribute [rw] pricing_plan
5677
- # Updates the pricing plan for the tracker resource.
5678
- #
5679
- # For more information about each pricing plan option restrictions,
5680
- # see [Amazon Location Service pricing][1].
5681
- #
5682
- #
5683
- #
5684
- # [1]: https://aws.amazon.com/location/pricing/
5835
+ # No longer used. If included, the only allowed value is
5836
+ # `RequestBasedUsage`.
5685
5837
  # @return [String]
5686
5838
  #
5687
5839
  # @!attribute [rw] pricing_plan_data_source
5688
- # Updates the data provider for the tracker resource.
5689
- #
5690
- # A required value for the following pricing plans:
5691
- # `MobileAssetTracking`\| `MobileAssetManagement`
5692
- #
5693
- # For more information about [data providers][1] and [pricing
5694
- # plans][2], see the Amazon Location Service product page
5695
- #
5696
- # <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
5697
- # request.
5698
- #
5699
- # Amazon Location Service uses `PricingPlanDataSource` to calculate
5700
- # billing for your tracker resource. Your data won't be shared with
5701
- # the data provider, and will remain in your AWS account and Region
5702
- # unless you move it.
5703
- #
5704
- # </note>
5705
- #
5706
- #
5707
- #
5708
- # [1]: https://aws.amazon.com/location/data-providers/
5709
- # [2]: https://aws.amazon.com/location/pricing/
5840
+ # This parameter is no longer used.
5710
5841
  # @return [String]
5711
5842
  #
5712
5843
  # @!attribute [rw] tracker_name