aws-sdk-locationservice 1.16.0 → 1.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +305 -191
- data/lib/aws-sdk-locationservice/client_api.rb +104 -28
- data/lib/aws-sdk-locationservice/types.rb +389 -263
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +4 -4
@@ -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/
|
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/
|
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/
|
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/
|
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
|
@@ -1060,41 +1320,12 @@ module Aws::LocationService
|
|
1060
1320
|
# @return [String]
|
1061
1321
|
#
|
1062
1322
|
# @!attribute [rw] pricing_plan
|
1063
|
-
#
|
1064
|
-
#
|
1065
|
-
#
|
1066
|
-
# For additional details and restrictions on each pricing plan option,
|
1067
|
-
# see the [Amazon Location Service pricing page][1].
|
1068
|
-
#
|
1069
|
-
#
|
1070
|
-
#
|
1071
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1323
|
+
# No longer used. If included, the only allowed value is
|
1324
|
+
# `RequestBasedUsage`.
|
1072
1325
|
# @return [String]
|
1073
1326
|
#
|
1074
1327
|
# @!attribute [rw] pricing_plan_data_source
|
1075
|
-
#
|
1076
|
-
#
|
1077
|
-
# * Required value for the following pricing plans:
|
1078
|
-
# `MobileAssetTracking `\| `MobileAssetManagement`
|
1079
|
-
#
|
1080
|
-
# ^
|
1081
|
-
#
|
1082
|
-
# For more information about [Data Providers][1], and [Pricing
|
1083
|
-
# plans][2], see the Amazon Location Service product page.
|
1084
|
-
#
|
1085
|
-
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to
|
1086
|
-
# calculate billing for your geofence collection. Your data won't be
|
1087
|
-
# shared with the data provider, and will remain in your AWS account
|
1088
|
-
# or Region unless you move it.
|
1089
|
-
#
|
1090
|
-
# </note>
|
1091
|
-
#
|
1092
|
-
# Valid Values: `Esri `\| `Here`
|
1093
|
-
#
|
1094
|
-
#
|
1095
|
-
#
|
1096
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
1097
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
1328
|
+
# This parameter is no longer used.
|
1098
1329
|
# @return [String]
|
1099
1330
|
#
|
1100
1331
|
# @!attribute [rw] tags
|
@@ -1203,15 +1434,8 @@ module Aws::LocationService
|
|
1203
1434
|
# @return [String]
|
1204
1435
|
#
|
1205
1436
|
# @!attribute [rw] pricing_plan
|
1206
|
-
#
|
1207
|
-
#
|
1208
|
-
#
|
1209
|
-
# For additional details and restrictions on each pricing plan option,
|
1210
|
-
# see [Amazon Location Service pricing][1].
|
1211
|
-
#
|
1212
|
-
#
|
1213
|
-
#
|
1214
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1437
|
+
# No longer used. If included, the only allowed value is
|
1438
|
+
# `RequestBasedUsage`.
|
1215
1439
|
# @return [String]
|
1216
1440
|
#
|
1217
1441
|
# @!attribute [rw] tags
|
@@ -1356,15 +1580,8 @@ module Aws::LocationService
|
|
1356
1580
|
# @return [String]
|
1357
1581
|
#
|
1358
1582
|
# @!attribute [rw] pricing_plan
|
1359
|
-
#
|
1360
|
-
#
|
1361
|
-
#
|
1362
|
-
# For additional details and restrictions on each pricing plan option,
|
1363
|
-
# see [Amazon Location Service pricing][1].
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
#
|
1367
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1583
|
+
# No longer used. If included, the only allowed value is
|
1584
|
+
# `RequestBasedUsage`.
|
1368
1585
|
# @return [String]
|
1369
1586
|
#
|
1370
1587
|
# @!attribute [rw] tags
|
@@ -1501,15 +1718,8 @@ module Aws::LocationService
|
|
1501
1718
|
# @return [String]
|
1502
1719
|
#
|
1503
1720
|
# @!attribute [rw] pricing_plan
|
1504
|
-
#
|
1505
|
-
#
|
1506
|
-
#
|
1507
|
-
# For additional details and restrictions on each pricing plan option,
|
1508
|
-
# see [Amazon Location Service pricing][1].
|
1509
|
-
#
|
1510
|
-
#
|
1511
|
-
#
|
1512
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1721
|
+
# No longer used. If included, the only allowed value is
|
1722
|
+
# `RequestBasedUsage`.
|
1513
1723
|
# @return [String]
|
1514
1724
|
#
|
1515
1725
|
# @!attribute [rw] tags
|
@@ -1653,41 +1863,12 @@ module Aws::LocationService
|
|
1653
1863
|
# @return [String]
|
1654
1864
|
#
|
1655
1865
|
# @!attribute [rw] pricing_plan
|
1656
|
-
#
|
1657
|
-
#
|
1658
|
-
#
|
1659
|
-
# For additional details and restrictions on each pricing plan option,
|
1660
|
-
# see [Amazon Location Service pricing][1].
|
1661
|
-
#
|
1662
|
-
#
|
1663
|
-
#
|
1664
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1866
|
+
# No longer used. If included, the only allowed value is
|
1867
|
+
# `RequestBasedUsage`.
|
1665
1868
|
# @return [String]
|
1666
1869
|
#
|
1667
1870
|
# @!attribute [rw] pricing_plan_data_source
|
1668
|
-
#
|
1669
|
-
#
|
1670
|
-
# * Required value for the following pricing plans:
|
1671
|
-
# `MobileAssetTracking `\| `MobileAssetManagement`
|
1672
|
-
#
|
1673
|
-
# ^
|
1674
|
-
#
|
1675
|
-
# For more information about [Data Providers][1], and [Pricing
|
1676
|
-
# plans][2], see the Amazon Location Service product page.
|
1677
|
-
#
|
1678
|
-
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to
|
1679
|
-
# calculate billing for your tracker resource. Your data will not be
|
1680
|
-
# shared with the data provider, and will remain in your AWS account
|
1681
|
-
# or Region unless you move it.
|
1682
|
-
#
|
1683
|
-
# </note>
|
1684
|
-
#
|
1685
|
-
# Valid values: `Esri` \| `Here`
|
1686
|
-
#
|
1687
|
-
#
|
1688
|
-
#
|
1689
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
1690
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
1871
|
+
# This parameter is no longer used.
|
1691
1872
|
# @return [String]
|
1692
1873
|
#
|
1693
1874
|
# @!attribute [rw] tags
|
@@ -1993,18 +2174,11 @@ module Aws::LocationService
|
|
1993
2174
|
# @return [String]
|
1994
2175
|
#
|
1995
2176
|
# @!attribute [rw] pricing_plan
|
1996
|
-
#
|
1997
|
-
#
|
1998
|
-
# For additional details and restrictions on each pricing plan option,
|
1999
|
-
# see the [Amazon Location Service pricing page][1].
|
2000
|
-
#
|
2001
|
-
#
|
2002
|
-
#
|
2003
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
2177
|
+
# No longer used. Always returns `RequestBasedUsage`.
|
2004
2178
|
# @return [String]
|
2005
2179
|
#
|
2006
2180
|
# @!attribute [rw] pricing_plan_data_source
|
2007
|
-
#
|
2181
|
+
# No longer used. Always returns an empty string.
|
2008
2182
|
# @return [String]
|
2009
2183
|
#
|
2010
2184
|
# @!attribute [rw] tags
|
@@ -2090,9 +2264,7 @@ module Aws::LocationService
|
|
2090
2264
|
# @return [String]
|
2091
2265
|
#
|
2092
2266
|
# @!attribute [rw] pricing_plan
|
2093
|
-
#
|
2094
|
-
#
|
2095
|
-
# <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`.
|
2096
2268
|
# @return [String]
|
2097
2269
|
#
|
2098
2270
|
# @!attribute [rw] tags
|
@@ -2191,14 +2363,7 @@ module Aws::LocationService
|
|
2191
2363
|
# @return [String]
|
2192
2364
|
#
|
2193
2365
|
# @!attribute [rw] pricing_plan
|
2194
|
-
#
|
2195
|
-
#
|
2196
|
-
# For additional details and restrictions on each pricing plan option,
|
2197
|
-
# see [Amazon Location Service pricing][1].
|
2198
|
-
#
|
2199
|
-
#
|
2200
|
-
#
|
2201
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
2366
|
+
# No longer used. Always returns `RequestBasedUsage`.
|
2202
2367
|
# @return [String]
|
2203
2368
|
#
|
2204
2369
|
# @!attribute [rw] tags
|
@@ -2297,15 +2462,7 @@ module Aws::LocationService
|
|
2297
2462
|
# @return [String]
|
2298
2463
|
#
|
2299
2464
|
# @!attribute [rw] pricing_plan
|
2300
|
-
#
|
2301
|
-
# resource.
|
2302
|
-
#
|
2303
|
-
# For additional details and restrictions on each pricing plan option,
|
2304
|
-
# see [Amazon Location Service pricing][1].
|
2305
|
-
#
|
2306
|
-
#
|
2307
|
-
#
|
2308
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
2465
|
+
# Always returns `RequestBasedUsage`.
|
2309
2466
|
# @return [String]
|
2310
2467
|
#
|
2311
2468
|
# @!attribute [rw] tags
|
@@ -2386,18 +2543,11 @@ module Aws::LocationService
|
|
2386
2543
|
# @return [String]
|
2387
2544
|
#
|
2388
2545
|
# @!attribute [rw] pricing_plan
|
2389
|
-
#
|
2390
|
-
#
|
2391
|
-
# For additional details and restrictions on each pricing plan option,
|
2392
|
-
# see [Amazon Location Service pricing][1].
|
2393
|
-
#
|
2394
|
-
#
|
2395
|
-
#
|
2396
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
2546
|
+
# Always returns `RequestBasedUsage`.
|
2397
2547
|
# @return [String]
|
2398
2548
|
#
|
2399
2549
|
# @!attribute [rw] pricing_plan_data_source
|
2400
|
-
#
|
2550
|
+
# No longer used. Always returns an empty string.
|
2401
2551
|
# @return [String]
|
2402
2552
|
#
|
2403
2553
|
# @!attribute [rw] tags
|
@@ -3144,7 +3294,7 @@ module Aws::LocationService
|
|
3144
3294
|
#
|
3145
3295
|
#
|
3146
3296
|
#
|
3147
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/
|
3297
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
3148
3298
|
#
|
3149
3299
|
# @!attribute [rw] distance
|
3150
3300
|
# The distance between the leg's `StartPosition` and `EndPosition`
|
@@ -3173,7 +3323,7 @@ module Aws::LocationService
|
|
3173
3323
|
#
|
3174
3324
|
#
|
3175
3325
|
#
|
3176
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/
|
3326
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html
|
3177
3327
|
# @return [Array<Float>]
|
3178
3328
|
#
|
3179
3329
|
# @!attribute [rw] geometry
|
@@ -3191,7 +3341,7 @@ module Aws::LocationService
|
|
3191
3341
|
#
|
3192
3342
|
#
|
3193
3343
|
#
|
3194
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/
|
3344
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
3195
3345
|
# @return [Array<Float>]
|
3196
3346
|
#
|
3197
3347
|
# @!attribute [rw] steps
|
@@ -3408,18 +3558,11 @@ module Aws::LocationService
|
|
3408
3558
|
# @return [String]
|
3409
3559
|
#
|
3410
3560
|
# @!attribute [rw] pricing_plan
|
3411
|
-
#
|
3412
|
-
#
|
3413
|
-
# For additional details and restrictions on each pricing plan option,
|
3414
|
-
# see the [Amazon Location Service pricing page][1].
|
3415
|
-
#
|
3416
|
-
#
|
3417
|
-
#
|
3418
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3561
|
+
# No longer used. Always returns `RequestBasedUsage`.
|
3419
3562
|
# @return [String]
|
3420
3563
|
#
|
3421
3564
|
# @!attribute [rw] pricing_plan_data_source
|
3422
|
-
#
|
3565
|
+
# No longer used. Always returns an empty string.
|
3423
3566
|
# @return [String]
|
3424
3567
|
#
|
3425
3568
|
# @!attribute [rw] update_time
|
@@ -3622,14 +3765,7 @@ module Aws::LocationService
|
|
3622
3765
|
# @return [String]
|
3623
3766
|
#
|
3624
3767
|
# @!attribute [rw] pricing_plan
|
3625
|
-
#
|
3626
|
-
#
|
3627
|
-
# For additional details and restrictions on each pricing plan option,
|
3628
|
-
# see [Amazon Location Service pricing][1].
|
3629
|
-
#
|
3630
|
-
#
|
3631
|
-
#
|
3632
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3768
|
+
# No longer used. Always returns `RequestBasedUsage`.
|
3633
3769
|
# @return [String]
|
3634
3770
|
#
|
3635
3771
|
# @!attribute [rw] update_time
|
@@ -3741,14 +3877,7 @@ module Aws::LocationService
|
|
3741
3877
|
# @return [String]
|
3742
3878
|
#
|
3743
3879
|
# @!attribute [rw] pricing_plan
|
3744
|
-
#
|
3745
|
-
#
|
3746
|
-
# For additional details and restrictions on each pricing plan option,
|
3747
|
-
# see [Amazon Location Service pricing][1].
|
3748
|
-
#
|
3749
|
-
#
|
3750
|
-
#
|
3751
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3880
|
+
# No longer used. Always returns `RequestBasedUsage`.
|
3752
3881
|
# @return [String]
|
3753
3882
|
#
|
3754
3883
|
# @!attribute [rw] update_time
|
@@ -3863,14 +3992,7 @@ module Aws::LocationService
|
|
3863
3992
|
# @return [String]
|
3864
3993
|
#
|
3865
3994
|
# @!attribute [rw] pricing_plan
|
3866
|
-
#
|
3867
|
-
#
|
3868
|
-
# For additional details and restrictions on each pricing plan option,
|
3869
|
-
# see [Amazon Location Service pricing][1].
|
3870
|
-
#
|
3871
|
-
#
|
3872
|
-
#
|
3873
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3995
|
+
# Always returns `RequestBasedUsage`.
|
3874
3996
|
# @return [String]
|
3875
3997
|
#
|
3876
3998
|
# @!attribute [rw] update_time
|
@@ -4069,18 +4191,11 @@ module Aws::LocationService
|
|
4069
4191
|
# @return [String]
|
4070
4192
|
#
|
4071
4193
|
# @!attribute [rw] pricing_plan
|
4072
|
-
#
|
4073
|
-
#
|
4074
|
-
# For additional details and restrictions on each pricing plan option,
|
4075
|
-
# see [Amazon Location Service pricing][1].
|
4076
|
-
#
|
4077
|
-
#
|
4078
|
-
#
|
4079
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
4194
|
+
# Always returns `RequestBasedUsage`.
|
4080
4195
|
# @return [String]
|
4081
4196
|
#
|
4082
4197
|
# @!attribute [rw] pricing_plan_data_source
|
4083
|
-
#
|
4198
|
+
# No longer used. Always returns an empty string.
|
4084
4199
|
# @return [String]
|
4085
4200
|
#
|
4086
4201
|
# @!attribute [rw] tracker_name
|
@@ -4405,6 +4520,89 @@ module Aws::LocationService
|
|
4405
4520
|
include Aws::Structure
|
4406
4521
|
end
|
4407
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
|
+
|
4408
4606
|
# Contains a search result from a position search query that is run on a
|
4409
4607
|
# place index resource.
|
4410
4608
|
#
|
@@ -5335,39 +5533,12 @@ module Aws::LocationService
|
|
5335
5533
|
# @return [String]
|
5336
5534
|
#
|
5337
5535
|
# @!attribute [rw] pricing_plan
|
5338
|
-
#
|
5339
|
-
#
|
5340
|
-
# For more information about each pricing plan option restrictions,
|
5341
|
-
# see [Amazon Location Service pricing][1].
|
5342
|
-
#
|
5343
|
-
#
|
5344
|
-
#
|
5345
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
5536
|
+
# No longer used. If included, the only allowed value is
|
5537
|
+
# `RequestBasedUsage`.
|
5346
5538
|
# @return [String]
|
5347
5539
|
#
|
5348
5540
|
# @!attribute [rw] pricing_plan_data_source
|
5349
|
-
#
|
5350
|
-
#
|
5351
|
-
# A required value for the following pricing plans:
|
5352
|
-
# `MobileAssetTracking`\| `MobileAssetManagement`
|
5353
|
-
#
|
5354
|
-
# For more information about [data providers][1] and [pricing
|
5355
|
-
# plans][2], see the Amazon Location Service product page.
|
5356
|
-
#
|
5357
|
-
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
5358
|
-
# request.
|
5359
|
-
#
|
5360
|
-
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
5361
|
-
# billing for your geofence collection. Your data won't be shared
|
5362
|
-
# with the data provider, and will remain in your AWS account and
|
5363
|
-
# Region unless you move it.
|
5364
|
-
#
|
5365
|
-
# </note>
|
5366
|
-
#
|
5367
|
-
#
|
5368
|
-
#
|
5369
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
5370
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
5541
|
+
# This parameter is no longer used.
|
5371
5542
|
# @return [String]
|
5372
5543
|
#
|
5373
5544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollectionRequest AWS API Documentation
|
@@ -5432,14 +5603,8 @@ module Aws::LocationService
|
|
5432
5603
|
# @return [String]
|
5433
5604
|
#
|
5434
5605
|
# @!attribute [rw] pricing_plan
|
5435
|
-
#
|
5436
|
-
#
|
5437
|
-
# For more information about each pricing plan option restrictions,
|
5438
|
-
# see [Amazon Location Service pricing][1].
|
5439
|
-
#
|
5440
|
-
#
|
5441
|
-
#
|
5442
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
5606
|
+
# No longer used. If included, the only allowed value is
|
5607
|
+
# `RequestBasedUsage`.
|
5443
5608
|
# @return [String]
|
5444
5609
|
#
|
5445
5610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMapRequest AWS API Documentation
|
@@ -5509,14 +5674,8 @@ module Aws::LocationService
|
|
5509
5674
|
# @return [String]
|
5510
5675
|
#
|
5511
5676
|
# @!attribute [rw] pricing_plan
|
5512
|
-
#
|
5513
|
-
#
|
5514
|
-
# For more information about each pricing plan option restrictions,
|
5515
|
-
# see [Amazon Location Service pricing][1].
|
5516
|
-
#
|
5517
|
-
#
|
5518
|
-
#
|
5519
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
5677
|
+
# No longer used. If included, the only allowed value is
|
5678
|
+
# `RequestBasedUsage`.
|
5520
5679
|
# @return [String]
|
5521
5680
|
#
|
5522
5681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndexRequest AWS API Documentation
|
@@ -5581,14 +5740,8 @@ module Aws::LocationService
|
|
5581
5740
|
# @return [String]
|
5582
5741
|
#
|
5583
5742
|
# @!attribute [rw] pricing_plan
|
5584
|
-
#
|
5585
|
-
#
|
5586
|
-
# For more information about each pricing plan option restrictions,
|
5587
|
-
# see [Amazon Location Service pricing][1].
|
5588
|
-
#
|
5589
|
-
#
|
5590
|
-
#
|
5591
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
5743
|
+
# No longer used. If included, the only allowed value is
|
5744
|
+
# `RequestBasedUsage`.
|
5592
5745
|
# @return [String]
|
5593
5746
|
#
|
5594
5747
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculatorRequest AWS API Documentation
|
@@ -5679,39 +5832,12 @@ module Aws::LocationService
|
|
5679
5832
|
# @return [String]
|
5680
5833
|
#
|
5681
5834
|
# @!attribute [rw] pricing_plan
|
5682
|
-
#
|
5683
|
-
#
|
5684
|
-
# For more information about each pricing plan option restrictions,
|
5685
|
-
# see [Amazon Location Service pricing][1].
|
5686
|
-
#
|
5687
|
-
#
|
5688
|
-
#
|
5689
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
5835
|
+
# No longer used. If included, the only allowed value is
|
5836
|
+
# `RequestBasedUsage`.
|
5690
5837
|
# @return [String]
|
5691
5838
|
#
|
5692
5839
|
# @!attribute [rw] pricing_plan_data_source
|
5693
|
-
#
|
5694
|
-
#
|
5695
|
-
# A required value for the following pricing plans:
|
5696
|
-
# `MobileAssetTracking`\| `MobileAssetManagement`
|
5697
|
-
#
|
5698
|
-
# For more information about [data providers][1] and [pricing
|
5699
|
-
# plans][2], see the Amazon Location Service product page
|
5700
|
-
#
|
5701
|
-
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
5702
|
-
# request.
|
5703
|
-
#
|
5704
|
-
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
5705
|
-
# billing for your tracker resource. Your data won't be shared with
|
5706
|
-
# the data provider, and will remain in your AWS account and Region
|
5707
|
-
# unless you move it.
|
5708
|
-
#
|
5709
|
-
# </note>
|
5710
|
-
#
|
5711
|
-
#
|
5712
|
-
#
|
5713
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
5714
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
5840
|
+
# This parameter is no longer used.
|
5715
5841
|
# @return [String]
|
5716
5842
|
#
|
5717
5843
|
# @!attribute [rw] tracker_name
|