aws-sdk-locationservice 1.3.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice.rb +1 -1
- data/lib/aws-sdk-locationservice/client.rb +851 -113
- data/lib/aws-sdk-locationservice/client_api.rb +416 -0
- data/lib/aws-sdk-locationservice/types.rb +1625 -105
- metadata +3 -4
@@ -38,7 +38,7 @@ module Aws::LocationService
|
|
38
38
|
# resource across all AWS.
|
39
39
|
#
|
40
40
|
# * Format example:
|
41
|
-
# `arn:
|
41
|
+
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
|
42
42
|
#
|
43
43
|
# ^
|
44
44
|
# @return [String]
|
@@ -61,6 +61,70 @@ module Aws::LocationService
|
|
61
61
|
#
|
62
62
|
class AssociateTrackerConsumerResponse < Aws::EmptyStructure; end
|
63
63
|
|
64
|
+
# Contains the tracker resource details.
|
65
|
+
#
|
66
|
+
# @!attribute [rw] device_id
|
67
|
+
# The ID of the device for this position.
|
68
|
+
# @return [String]
|
69
|
+
#
|
70
|
+
# @!attribute [rw] error
|
71
|
+
# Contains the batch request error details associated with the
|
72
|
+
# request.
|
73
|
+
# @return [Types::BatchItemError]
|
74
|
+
#
|
75
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteDevicePositionHistoryError AWS API Documentation
|
76
|
+
#
|
77
|
+
class BatchDeleteDevicePositionHistoryError < Struct.new(
|
78
|
+
:device_id,
|
79
|
+
:error)
|
80
|
+
SENSITIVE = []
|
81
|
+
include Aws::Structure
|
82
|
+
end
|
83
|
+
|
84
|
+
# @note When making an API call, you may pass BatchDeleteDevicePositionHistoryRequest
|
85
|
+
# data as a hash:
|
86
|
+
#
|
87
|
+
# {
|
88
|
+
# device_ids: ["Id"], # required
|
89
|
+
# tracker_name: "ResourceName", # required
|
90
|
+
# }
|
91
|
+
#
|
92
|
+
# @!attribute [rw] device_ids
|
93
|
+
# Devices whose position history you want to delete.
|
94
|
+
#
|
95
|
+
# * For example, for two devices: `“DeviceIds” :
|
96
|
+
# [DeviceId1,DeviceId2]`
|
97
|
+
#
|
98
|
+
# ^
|
99
|
+
# @return [Array<String>]
|
100
|
+
#
|
101
|
+
# @!attribute [rw] tracker_name
|
102
|
+
# The name of the tracker resource to delete the device position
|
103
|
+
# history from.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteDevicePositionHistoryRequest AWS API Documentation
|
107
|
+
#
|
108
|
+
class BatchDeleteDevicePositionHistoryRequest < Struct.new(
|
109
|
+
:device_ids,
|
110
|
+
:tracker_name)
|
111
|
+
SENSITIVE = []
|
112
|
+
include Aws::Structure
|
113
|
+
end
|
114
|
+
|
115
|
+
# @!attribute [rw] errors
|
116
|
+
# Contains error details for each device history that failed to
|
117
|
+
# delete.
|
118
|
+
# @return [Array<Types::BatchDeleteDevicePositionHistoryError>]
|
119
|
+
#
|
120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteDevicePositionHistoryResponse AWS API Documentation
|
121
|
+
#
|
122
|
+
class BatchDeleteDevicePositionHistoryResponse < Struct.new(
|
123
|
+
:errors)
|
124
|
+
SENSITIVE = []
|
125
|
+
include Aws::Structure
|
126
|
+
end
|
127
|
+
|
64
128
|
# Contains error details for each geofence that failed to delete from
|
65
129
|
# the geofence collection.
|
66
130
|
#
|
@@ -509,6 +573,421 @@ module Aws::LocationService
|
|
509
573
|
include Aws::Structure
|
510
574
|
end
|
511
575
|
|
576
|
+
# Contains details about additional route preferences for requests that
|
577
|
+
# specify `TravelMode` as `Car`.
|
578
|
+
#
|
579
|
+
# @note When making an API call, you may pass CalculateRouteCarModeOptions
|
580
|
+
# data as a hash:
|
581
|
+
#
|
582
|
+
# {
|
583
|
+
# avoid_ferries: false,
|
584
|
+
# avoid_tolls: false,
|
585
|
+
# }
|
586
|
+
#
|
587
|
+
# @!attribute [rw] avoid_ferries
|
588
|
+
# Avoids ferries when calculating routes.
|
589
|
+
#
|
590
|
+
# Default Value: `false`
|
591
|
+
#
|
592
|
+
# Valid Values: `false` \| `true`
|
593
|
+
# @return [Boolean]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] avoid_tolls
|
596
|
+
# Avoids tolls when calculating routes.
|
597
|
+
#
|
598
|
+
# Default Value: `false`
|
599
|
+
#
|
600
|
+
# Valid Values: `false` \| `true`
|
601
|
+
# @return [Boolean]
|
602
|
+
#
|
603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteCarModeOptions AWS API Documentation
|
604
|
+
#
|
605
|
+
class CalculateRouteCarModeOptions < Struct.new(
|
606
|
+
:avoid_ferries,
|
607
|
+
:avoid_tolls)
|
608
|
+
SENSITIVE = []
|
609
|
+
include Aws::Structure
|
610
|
+
end
|
611
|
+
|
612
|
+
# @note When making an API call, you may pass CalculateRouteRequest
|
613
|
+
# data as a hash:
|
614
|
+
#
|
615
|
+
# {
|
616
|
+
# calculator_name: "ResourceName", # required
|
617
|
+
# car_mode_options: {
|
618
|
+
# avoid_ferries: false,
|
619
|
+
# avoid_tolls: false,
|
620
|
+
# },
|
621
|
+
# depart_now: false,
|
622
|
+
# departure_position: [1.0], # required
|
623
|
+
# departure_time: Time.now,
|
624
|
+
# destination_position: [1.0], # required
|
625
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
626
|
+
# include_leg_geometry: false,
|
627
|
+
# travel_mode: "Car", # accepts Car, Truck, Walking
|
628
|
+
# truck_mode_options: {
|
629
|
+
# avoid_ferries: false,
|
630
|
+
# avoid_tolls: false,
|
631
|
+
# dimensions: {
|
632
|
+
# height: 1.0,
|
633
|
+
# length: 1.0,
|
634
|
+
# unit: "Meters", # accepts Meters, Feet
|
635
|
+
# width: 1.0,
|
636
|
+
# },
|
637
|
+
# weight: {
|
638
|
+
# total: 1.0,
|
639
|
+
# unit: "Kilograms", # accepts Kilograms, Pounds
|
640
|
+
# },
|
641
|
+
# },
|
642
|
+
# waypoint_positions: [
|
643
|
+
# [1.0],
|
644
|
+
# ],
|
645
|
+
# }
|
646
|
+
#
|
647
|
+
# @!attribute [rw] calculator_name
|
648
|
+
# The name of the route calculator resource that you want to use to
|
649
|
+
# calculate a route.
|
650
|
+
# @return [String]
|
651
|
+
#
|
652
|
+
# @!attribute [rw] car_mode_options
|
653
|
+
# Specifies route preferences when traveling by `Car`, such as
|
654
|
+
# avoiding routes that use ferries or tolls.
|
655
|
+
#
|
656
|
+
# Requirements: `TravelMode` must be specified as `Car`.
|
657
|
+
# @return [Types::CalculateRouteCarModeOptions]
|
658
|
+
#
|
659
|
+
# @!attribute [rw] depart_now
|
660
|
+
# Sets the time of departure as the current time. Uses the current
|
661
|
+
# time to calculate a route. Otherwise, the best time of day to travel
|
662
|
+
# with the best traffic conditions is used to calculate the route.
|
663
|
+
#
|
664
|
+
# Default Value: `false`
|
665
|
+
#
|
666
|
+
# Valid Values: `false` \| `true`
|
667
|
+
# @return [Boolean]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] departure_position
|
670
|
+
# The start position for the route. Defined in [WGS 84][1] format:
|
671
|
+
# `[longitude, latitude]`.
|
672
|
+
#
|
673
|
+
# * For example, `[-123.115, 49.285]`
|
674
|
+
#
|
675
|
+
# ^
|
676
|
+
#
|
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].
|
679
|
+
#
|
680
|
+
# </note>
|
681
|
+
#
|
682
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
683
|
+
#
|
684
|
+
#
|
685
|
+
#
|
686
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
687
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
688
|
+
# @return [Array<Float>]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] departure_time
|
691
|
+
# Specifies the desired time of departure. Uses the given time to
|
692
|
+
# calculate a route. Otherwise, the best time of day to travel with
|
693
|
+
# the best traffic conditions is used to calculate the route.
|
694
|
+
#
|
695
|
+
# <note markdown="1"> Setting a departure time in the past returns a `400
|
696
|
+
# ValidationException` error.
|
697
|
+
#
|
698
|
+
# </note>
|
699
|
+
#
|
700
|
+
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
701
|
+
# `2020–07-2T12:15:20.000Z+01:00`
|
702
|
+
#
|
703
|
+
# ^
|
704
|
+
#
|
705
|
+
#
|
706
|
+
#
|
707
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
708
|
+
# @return [Time]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] destination_position
|
711
|
+
# The finish position for the route. Defined in [WGS 84][1] format:
|
712
|
+
# `[longitude, latitude]`.
|
713
|
+
#
|
714
|
+
# * For example, `[-122.339, 47.615]`
|
715
|
+
#
|
716
|
+
# ^
|
717
|
+
#
|
718
|
+
# <note markdown="1"> If you specify a destination that's not located on a road, Amazon
|
719
|
+
# Location [moves the position to the nearest road][2].
|
720
|
+
#
|
721
|
+
# </note>
|
722
|
+
#
|
723
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
724
|
+
#
|
725
|
+
#
|
726
|
+
#
|
727
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
728
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
729
|
+
# @return [Array<Float>]
|
730
|
+
#
|
731
|
+
# @!attribute [rw] distance_unit
|
732
|
+
# Set the unit system to specify the distance.
|
733
|
+
#
|
734
|
+
# Default Value: `Kilometers`
|
735
|
+
# @return [String]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] include_leg_geometry
|
738
|
+
# Set to include the geometry details in the result for each path
|
739
|
+
# between a pair of positions.
|
740
|
+
#
|
741
|
+
# Default Value: `false`
|
742
|
+
#
|
743
|
+
# Valid Values: `false` \| `true`
|
744
|
+
# @return [Boolean]
|
745
|
+
#
|
746
|
+
# @!attribute [rw] travel_mode
|
747
|
+
# Specifies the mode of transport when calculating a route. Used in
|
748
|
+
# estimating the speed of travel and road compatibility.
|
749
|
+
#
|
750
|
+
# The `TravelMode` you specify determines how you specify route
|
751
|
+
# preferences:
|
752
|
+
#
|
753
|
+
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
754
|
+
#
|
755
|
+
# * If traveling by `Truck` use the `TruckModeOptions` parameter.
|
756
|
+
#
|
757
|
+
# Default Value: `Car`
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] truck_mode_options
|
761
|
+
# Specifies route preferences when traveling by `Truck`, such as
|
762
|
+
# avoiding routes that use ferries or tolls, and truck specifications
|
763
|
+
# to consider when choosing an optimal road.
|
764
|
+
#
|
765
|
+
# Requirements: `TravelMode` must be specified as `Truck`.
|
766
|
+
# @return [Types::CalculateRouteTruckModeOptions]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] waypoint_positions
|
769
|
+
# Specifies an ordered list of up to 23 intermediate positions to
|
770
|
+
# include along a route between the departure position and destination
|
771
|
+
# position.
|
772
|
+
#
|
773
|
+
# * For example, from the `DeparturePosition` `[-123.115, 49.285]`,
|
774
|
+
# the route follows the order that the waypoint positions are given
|
775
|
+
# `[[-122.757, 49.0021],[-122.349, 47.620]]`
|
776
|
+
#
|
777
|
+
# ^
|
778
|
+
#
|
779
|
+
# <note markdown="1"> If you specify a waypoint position that's not located on a road,
|
780
|
+
# Amazon Location [moves the position to the nearest road][1].
|
781
|
+
#
|
782
|
+
# Specifying more than 23 waypoints returns a `400
|
783
|
+
# ValidationException` error.
|
784
|
+
#
|
785
|
+
# </note>
|
786
|
+
#
|
787
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
788
|
+
#
|
789
|
+
#
|
790
|
+
#
|
791
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
792
|
+
# @return [Array<Array<Float>>]
|
793
|
+
#
|
794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteRequest AWS API Documentation
|
795
|
+
#
|
796
|
+
class CalculateRouteRequest < Struct.new(
|
797
|
+
:calculator_name,
|
798
|
+
:car_mode_options,
|
799
|
+
:depart_now,
|
800
|
+
:departure_position,
|
801
|
+
:departure_time,
|
802
|
+
:destination_position,
|
803
|
+
:distance_unit,
|
804
|
+
:include_leg_geometry,
|
805
|
+
:travel_mode,
|
806
|
+
:truck_mode_options,
|
807
|
+
:waypoint_positions)
|
808
|
+
SENSITIVE = [:departure_position, :destination_position]
|
809
|
+
include Aws::Structure
|
810
|
+
end
|
811
|
+
|
812
|
+
# Returns the result of the route calculation. Metadata includes legs
|
813
|
+
# and route summary.
|
814
|
+
#
|
815
|
+
# @!attribute [rw] legs
|
816
|
+
# Contains details about each path between a pair of positions
|
817
|
+
# included along a route such as: `StartPosition`, `EndPosition`,
|
818
|
+
# `Distance`, `DurationSeconds`, `Geometry`, and `Steps`. The number
|
819
|
+
# of legs returned corresponds to one less than the total number of
|
820
|
+
# positions in the request.
|
821
|
+
#
|
822
|
+
# For example, a route with a departure position and destination
|
823
|
+
# position returns one leg with the positions [snapped to a nearby
|
824
|
+
# road][1]\:
|
825
|
+
#
|
826
|
+
# * The `StartPosition` is the departure position.
|
827
|
+
#
|
828
|
+
# * The `EndPosition` is the destination position.
|
829
|
+
#
|
830
|
+
# A route with a waypoint between the departure and destination
|
831
|
+
# position returns two legs with the positions snapped to a nearby
|
832
|
+
# road.:
|
833
|
+
#
|
834
|
+
# * Leg 1: The `StartPosition` is the departure position . The
|
835
|
+
# `EndPosition` is the waypoint positon.
|
836
|
+
#
|
837
|
+
# * Leg 2: The `StartPosition` is the waypoint position. The
|
838
|
+
# `EndPosition` is the destination position.
|
839
|
+
#
|
840
|
+
#
|
841
|
+
#
|
842
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
843
|
+
# @return [Array<Types::Leg>]
|
844
|
+
#
|
845
|
+
# @!attribute [rw] summary
|
846
|
+
# Contains information about the whole route, such as: `RouteBBox`,
|
847
|
+
# `DataSource`, `Distance`, `DistanceUnit`, and `DurationSeconds`
|
848
|
+
# @return [Types::CalculateRouteSummary]
|
849
|
+
#
|
850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteResponse AWS API Documentation
|
851
|
+
#
|
852
|
+
class CalculateRouteResponse < Struct.new(
|
853
|
+
:legs,
|
854
|
+
:summary)
|
855
|
+
SENSITIVE = []
|
856
|
+
include Aws::Structure
|
857
|
+
end
|
858
|
+
|
859
|
+
# A summary of the calculated route.
|
860
|
+
#
|
861
|
+
# @!attribute [rw] data_source
|
862
|
+
# The data provider of traffic and road network data used to calculate
|
863
|
+
# the route. Indicates one of the available providers:
|
864
|
+
#
|
865
|
+
# * `Esri`
|
866
|
+
#
|
867
|
+
# * `Here`
|
868
|
+
#
|
869
|
+
# For more information about data providers, see [Amazon Location
|
870
|
+
# Service data providers][1].
|
871
|
+
#
|
872
|
+
#
|
873
|
+
#
|
874
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
875
|
+
# @return [String]
|
876
|
+
#
|
877
|
+
# @!attribute [rw] distance
|
878
|
+
# The total distance covered by the route. The sum of the distance
|
879
|
+
# travelled between every stop on the route.
|
880
|
+
#
|
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.
|
884
|
+
#
|
885
|
+
# </note>
|
886
|
+
# @return [Float]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] distance_unit
|
889
|
+
# The unit of measurement for the distance.
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] duration_seconds
|
893
|
+
# The total travel time for the route measured in seconds. The sum of
|
894
|
+
# the travel time between every stop on the route.
|
895
|
+
# @return [Float]
|
896
|
+
#
|
897
|
+
# @!attribute [rw] route_b_box
|
898
|
+
# Specifies a geographical box surrounding a route. Used to zoom into
|
899
|
+
# a route when displaying it in a map. For example, `[min x, min y,
|
900
|
+
# max x, max y]`
|
901
|
+
#
|
902
|
+
# The first 2 `bbox` parameters describe the lower southwest corner:
|
903
|
+
#
|
904
|
+
# * The first `bbox` position is the X coordinate or longitude of the
|
905
|
+
# lower southwest corner.
|
906
|
+
#
|
907
|
+
# * The second `bbox` position is the Y coordinate or latitude of the
|
908
|
+
# lower southwest corner.
|
909
|
+
#
|
910
|
+
# The next 2 `bbox` parameters describe the upper northeast corner:
|
911
|
+
#
|
912
|
+
# * The third `bbox` position is the X coordinate, or longitude of the
|
913
|
+
# upper northeast corner.
|
914
|
+
#
|
915
|
+
# * The fourth `bbox` position is the Y coordinate, or longitude of
|
916
|
+
# the upper northeast corner.
|
917
|
+
# @return [Array<Float>]
|
918
|
+
#
|
919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteSummary AWS API Documentation
|
920
|
+
#
|
921
|
+
class CalculateRouteSummary < Struct.new(
|
922
|
+
:data_source,
|
923
|
+
:distance,
|
924
|
+
:distance_unit,
|
925
|
+
:duration_seconds,
|
926
|
+
:route_b_box)
|
927
|
+
SENSITIVE = [:route_b_box]
|
928
|
+
include Aws::Structure
|
929
|
+
end
|
930
|
+
|
931
|
+
# Contains details about additional route preferences for requests that
|
932
|
+
# specify `TravelMode` as `Truck`.
|
933
|
+
#
|
934
|
+
# @note When making an API call, you may pass CalculateRouteTruckModeOptions
|
935
|
+
# data as a hash:
|
936
|
+
#
|
937
|
+
# {
|
938
|
+
# avoid_ferries: false,
|
939
|
+
# avoid_tolls: false,
|
940
|
+
# dimensions: {
|
941
|
+
# height: 1.0,
|
942
|
+
# length: 1.0,
|
943
|
+
# unit: "Meters", # accepts Meters, Feet
|
944
|
+
# width: 1.0,
|
945
|
+
# },
|
946
|
+
# weight: {
|
947
|
+
# total: 1.0,
|
948
|
+
# unit: "Kilograms", # accepts Kilograms, Pounds
|
949
|
+
# },
|
950
|
+
# }
|
951
|
+
#
|
952
|
+
# @!attribute [rw] avoid_ferries
|
953
|
+
# Avoids ferries when calculating routes.
|
954
|
+
#
|
955
|
+
# Default Value: `false`
|
956
|
+
#
|
957
|
+
# Valid Values: `false` \| `true`
|
958
|
+
# @return [Boolean]
|
959
|
+
#
|
960
|
+
# @!attribute [rw] avoid_tolls
|
961
|
+
# Avoids ferries when calculating routes.
|
962
|
+
#
|
963
|
+
# Default Value: `false`
|
964
|
+
#
|
965
|
+
# Valid Values: `false` \| `true`
|
966
|
+
# @return [Boolean]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] dimensions
|
969
|
+
# Specifies the truck's dimension specifications including length,
|
970
|
+
# height, width, and unit of measurement. Used to avoid roads that
|
971
|
+
# can't support the truck's dimensions.
|
972
|
+
# @return [Types::TruckDimensions]
|
973
|
+
#
|
974
|
+
# @!attribute [rw] weight
|
975
|
+
# Specifies the truck's weight specifications including total weight
|
976
|
+
# and unit of measurement. Used to avoid roads that can't support the
|
977
|
+
# truck's weight.
|
978
|
+
# @return [Types::TruckWeight]
|
979
|
+
#
|
980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteTruckModeOptions AWS API Documentation
|
981
|
+
#
|
982
|
+
class CalculateRouteTruckModeOptions < Struct.new(
|
983
|
+
:avoid_ferries,
|
984
|
+
:avoid_tolls,
|
985
|
+
:dimensions,
|
986
|
+
:weight)
|
987
|
+
SENSITIVE = []
|
988
|
+
include Aws::Structure
|
989
|
+
end
|
990
|
+
|
512
991
|
# The request was unsuccessful due to a conflict.
|
513
992
|
#
|
514
993
|
# @!attribute [rw] message
|
@@ -528,8 +1007,12 @@ module Aws::LocationService
|
|
528
1007
|
# {
|
529
1008
|
# collection_name: "ResourceName", # required
|
530
1009
|
# description: "ResourceDescription",
|
1010
|
+
# kms_key_id: "KmsKeyId",
|
531
1011
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
532
1012
|
# pricing_plan_data_source: "String",
|
1013
|
+
# tags: {
|
1014
|
+
# "TagKey" => "TagValue",
|
1015
|
+
# },
|
533
1016
|
# }
|
534
1017
|
#
|
535
1018
|
# @!attribute [rw] collection_name
|
@@ -537,7 +1020,7 @@ module Aws::LocationService
|
|
537
1020
|
#
|
538
1021
|
# Requirements:
|
539
1022
|
#
|
540
|
-
# * Contain only alphanumeric characters (A–Z, a–z, 0
|
1023
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
541
1024
|
# periods (.), and underscores (\_).
|
542
1025
|
#
|
543
1026
|
# * Must be a unique geofence collection name.
|
@@ -549,8 +1032,17 @@ module Aws::LocationService
|
|
549
1032
|
# An optional description for the geofence collection.
|
550
1033
|
# @return [String]
|
551
1034
|
#
|
1035
|
+
# @!attribute [rw] kms_key_id
|
1036
|
+
# A key identifier for an [AWS KMS customer managed key][1]. Enter a
|
1037
|
+
# key ID, key ARN, alias name, or alias ARN.
|
1038
|
+
#
|
1039
|
+
#
|
1040
|
+
#
|
1041
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1042
|
+
# @return [String]
|
1043
|
+
#
|
552
1044
|
# @!attribute [rw] pricing_plan
|
553
|
-
# Specifies the pricing plan for
|
1045
|
+
# Specifies the pricing plan for the geofence collection.
|
554
1046
|
#
|
555
1047
|
# For additional details and restrictions on each pricing plan option,
|
556
1048
|
# see the [Amazon Location Service pricing page][1].
|
@@ -561,29 +1053,61 @@ module Aws::LocationService
|
|
561
1053
|
# @return [String]
|
562
1054
|
#
|
563
1055
|
# @!attribute [rw] pricing_plan_data_source
|
564
|
-
# Specifies the
|
565
|
-
#
|
566
|
-
#
|
1056
|
+
# Specifies the data provider for the geofence collection.
|
1057
|
+
#
|
1058
|
+
# * Required value for the following pricing plans:
|
1059
|
+
# `MobileAssetTracking `\| `MobileAssetManagement`
|
1060
|
+
#
|
1061
|
+
# ^
|
1062
|
+
#
|
1063
|
+
# For more information about [Data Providers][1], and [Pricing
|
1064
|
+
# plans][2], see the Amazon Location Service product page.
|
567
1065
|
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
1066
|
+
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to
|
1067
|
+
# calculate billing for your geofence collection. Your data won't be
|
1068
|
+
# shared with the data provider, and will remain in your AWS account
|
1069
|
+
# or Region unless you move it.
|
1070
|
+
#
|
1071
|
+
# </note>
|
572
1072
|
#
|
573
1073
|
# Valid Values: `Esri `\| `Here`
|
574
1074
|
#
|
575
1075
|
#
|
576
1076
|
#
|
577
|
-
# [1]: https://aws.amazon.com/location/
|
1077
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
1078
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
578
1079
|
# @return [String]
|
579
1080
|
#
|
1081
|
+
# @!attribute [rw] tags
|
1082
|
+
# Applies one or more tags to the geofence collection. A tag is a
|
1083
|
+
# key-value pair helps manage, identify, search, and filter your
|
1084
|
+
# resources by labelling them.
|
1085
|
+
#
|
1086
|
+
# Format: `"key" : "value"`
|
1087
|
+
#
|
1088
|
+
# Restrictions:
|
1089
|
+
#
|
1090
|
+
# * Maximum 50 tags per resource
|
1091
|
+
#
|
1092
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1093
|
+
#
|
1094
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1095
|
+
#
|
1096
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1097
|
+
#
|
1098
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1099
|
+
# characters: + - = . \_ : / @.
|
1100
|
+
# @return [Hash<String,String>]
|
1101
|
+
#
|
580
1102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollectionRequest AWS API Documentation
|
581
1103
|
#
|
582
1104
|
class CreateGeofenceCollectionRequest < Struct.new(
|
583
1105
|
:collection_name,
|
584
1106
|
:description,
|
1107
|
+
:kms_key_id,
|
585
1108
|
:pricing_plan,
|
586
|
-
:pricing_plan_data_source
|
1109
|
+
:pricing_plan_data_source,
|
1110
|
+
:tags)
|
587
1111
|
SENSITIVE = []
|
588
1112
|
include Aws::Structure
|
589
1113
|
end
|
@@ -591,6 +1115,11 @@ module Aws::LocationService
|
|
591
1115
|
# @!attribute [rw] collection_arn
|
592
1116
|
# The Amazon Resource Name (ARN) for the geofence collection resource.
|
593
1117
|
# Used when you need to specify a resource across all AWS.
|
1118
|
+
#
|
1119
|
+
# * Format example:
|
1120
|
+
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`
|
1121
|
+
#
|
1122
|
+
# ^
|
594
1123
|
# @return [String]
|
595
1124
|
#
|
596
1125
|
# @!attribute [rw] collection_name
|
@@ -626,6 +1155,9 @@ module Aws::LocationService
|
|
626
1155
|
# description: "ResourceDescription",
|
627
1156
|
# map_name: "ResourceName", # required
|
628
1157
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1158
|
+
# tags: {
|
1159
|
+
# "TagKey" => "TagValue",
|
1160
|
+
# },
|
629
1161
|
# }
|
630
1162
|
#
|
631
1163
|
# @!attribute [rw] configuration
|
@@ -660,13 +1192,35 @@ module Aws::LocationService
|
|
660
1192
|
# [1]: https://aws.amazon.com/location/pricing/
|
661
1193
|
# @return [String]
|
662
1194
|
#
|
1195
|
+
# @!attribute [rw] tags
|
1196
|
+
# Applies one or more tags to the map resource. A tag is a key-value
|
1197
|
+
# pair helps manage, identify, search, and filter your resources by
|
1198
|
+
# labelling them.
|
1199
|
+
#
|
1200
|
+
# Format: `"key" : "value"`
|
1201
|
+
#
|
1202
|
+
# Restrictions:
|
1203
|
+
#
|
1204
|
+
# * Maximum 50 tags per resource
|
1205
|
+
#
|
1206
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1207
|
+
#
|
1208
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1209
|
+
#
|
1210
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1211
|
+
#
|
1212
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1213
|
+
# characters: + - = . \_ : / @.
|
1214
|
+
# @return [Hash<String,String>]
|
1215
|
+
#
|
663
1216
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMapRequest AWS API Documentation
|
664
1217
|
#
|
665
1218
|
class CreateMapRequest < Struct.new(
|
666
1219
|
:configuration,
|
667
1220
|
:description,
|
668
1221
|
:map_name,
|
669
|
-
:pricing_plan
|
1222
|
+
:pricing_plan,
|
1223
|
+
:tags)
|
670
1224
|
SENSITIVE = []
|
671
1225
|
include Aws::Structure
|
672
1226
|
end
|
@@ -684,8 +1238,7 @@ module Aws::LocationService
|
|
684
1238
|
# The Amazon Resource Name (ARN) for the map resource. Used when you
|
685
1239
|
# need to specify a resource across all AWS.
|
686
1240
|
#
|
687
|
-
# * Format example:
|
688
|
-
# `arn:partition:service:region:account-id:resource-type:resource-id`
|
1241
|
+
# * Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`
|
689
1242
|
#
|
690
1243
|
# ^
|
691
1244
|
# @return [String]
|
@@ -715,6 +1268,9 @@ module Aws::LocationService
|
|
715
1268
|
# description: "ResourceDescription",
|
716
1269
|
# index_name: "ResourceName", # required
|
717
1270
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1271
|
+
# tags: {
|
1272
|
+
# "TagKey" => "TagValue",
|
1273
|
+
# },
|
718
1274
|
# }
|
719
1275
|
#
|
720
1276
|
# @!attribute [rw] data_source
|
@@ -731,12 +1287,19 @@ module Aws::LocationService
|
|
731
1287
|
#
|
732
1288
|
# * `Here`
|
733
1289
|
#
|
1290
|
+
# Place index resources using HERE as a data provider can't be used
|
1291
|
+
# to [store][1] results for locations in Japan. For more
|
1292
|
+
# information, see the [AWS Service Terms][2] for Amazon Location
|
1293
|
+
# Service.
|
1294
|
+
#
|
734
1295
|
# For additional details on data providers, see the [Amazon Location
|
735
|
-
# Service data providers page][
|
1296
|
+
# Service data providers page][3].
|
736
1297
|
#
|
737
1298
|
#
|
738
1299
|
#
|
739
|
-
# [1]: https://docs.aws.amazon.com/location/latest/
|
1300
|
+
# [1]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html
|
1301
|
+
# [2]: https://aws.amazon.com/service-terms/
|
1302
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
740
1303
|
# @return [String]
|
741
1304
|
#
|
742
1305
|
# @!attribute [rw] data_source_configuration
|
@@ -744,24 +1307,24 @@ module Aws::LocationService
|
|
744
1307
|
# @return [Types::DataSourceConfiguration]
|
745
1308
|
#
|
746
1309
|
# @!attribute [rw] description
|
747
|
-
# The optional description for the
|
1310
|
+
# The optional description for the place index resource.
|
748
1311
|
# @return [String]
|
749
1312
|
#
|
750
1313
|
# @!attribute [rw] index_name
|
751
|
-
# The name of the
|
1314
|
+
# The name of the place index resource.
|
752
1315
|
#
|
753
1316
|
# Requirements:
|
754
1317
|
#
|
755
|
-
# * Contain only alphanumeric characters (A
|
756
|
-
#
|
1318
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
1319
|
+
# periods (.), and underscores (\_).
|
757
1320
|
#
|
758
|
-
# * Must be a unique
|
1321
|
+
# * Must be a unique place index resource name.
|
759
1322
|
#
|
760
1323
|
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
761
1324
|
# @return [String]
|
762
1325
|
#
|
763
1326
|
# @!attribute [rw] pricing_plan
|
764
|
-
# Specifies the pricing plan for your
|
1327
|
+
# Specifies the pricing plan for your place index resource.
|
765
1328
|
#
|
766
1329
|
# For additional details and restrictions on each pricing plan option,
|
767
1330
|
# see the [Amazon Location Service pricing page][1].
|
@@ -771,6 +1334,27 @@ module Aws::LocationService
|
|
771
1334
|
# [1]: https://aws.amazon.com/location/pricing/
|
772
1335
|
# @return [String]
|
773
1336
|
#
|
1337
|
+
# @!attribute [rw] tags
|
1338
|
+
# Applies one or more tags to the place index resource. A tag is a
|
1339
|
+
# key-value pair helps manage, identify, search, and filter your
|
1340
|
+
# resources by labelling them.
|
1341
|
+
#
|
1342
|
+
# Format: `"key" : "value"`
|
1343
|
+
#
|
1344
|
+
# Restrictions:
|
1345
|
+
#
|
1346
|
+
# * Maximum 50 tags per resource
|
1347
|
+
#
|
1348
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1349
|
+
#
|
1350
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1351
|
+
#
|
1352
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1353
|
+
#
|
1354
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1355
|
+
# characters: + - = . \_ : / @.
|
1356
|
+
# @return [Hash<String,String>]
|
1357
|
+
#
|
774
1358
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndexRequest AWS API Documentation
|
775
1359
|
#
|
776
1360
|
class CreatePlaceIndexRequest < Struct.new(
|
@@ -778,13 +1362,14 @@ module Aws::LocationService
|
|
778
1362
|
:data_source_configuration,
|
779
1363
|
:description,
|
780
1364
|
:index_name,
|
781
|
-
:pricing_plan
|
1365
|
+
:pricing_plan,
|
1366
|
+
:tags)
|
782
1367
|
SENSITIVE = []
|
783
1368
|
include Aws::Structure
|
784
1369
|
end
|
785
1370
|
|
786
1371
|
# @!attribute [rw] create_time
|
787
|
-
# The timestamp for when the
|
1372
|
+
# The timestamp for when the place index resource was created in [ISO
|
788
1373
|
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
789
1374
|
#
|
790
1375
|
#
|
@@ -793,12 +1378,17 @@ module Aws::LocationService
|
|
793
1378
|
# @return [Time]
|
794
1379
|
#
|
795
1380
|
# @!attribute [rw] index_arn
|
796
|
-
# The Amazon Resource Name (ARN) for the
|
797
|
-
#
|
1381
|
+
# The Amazon Resource Name (ARN) for the place index resource. Used to
|
1382
|
+
# specify a resource across all AWS.
|
1383
|
+
#
|
1384
|
+
# * Format example:
|
1385
|
+
# `arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex`
|
1386
|
+
#
|
1387
|
+
# ^
|
798
1388
|
# @return [String]
|
799
1389
|
#
|
800
1390
|
# @!attribute [rw] index_name
|
801
|
-
# The name for the
|
1391
|
+
# The name for the place index resource.
|
802
1392
|
# @return [String]
|
803
1393
|
#
|
804
1394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndexResponse AWS API Documentation
|
@@ -811,13 +1401,154 @@ module Aws::LocationService
|
|
811
1401
|
include Aws::Structure
|
812
1402
|
end
|
813
1403
|
|
1404
|
+
# @note When making an API call, you may pass CreateRouteCalculatorRequest
|
1405
|
+
# data as a hash:
|
1406
|
+
#
|
1407
|
+
# {
|
1408
|
+
# calculator_name: "ResourceName", # required
|
1409
|
+
# data_source: "String", # required
|
1410
|
+
# description: "ResourceDescription",
|
1411
|
+
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1412
|
+
# tags: {
|
1413
|
+
# "TagKey" => "TagValue",
|
1414
|
+
# },
|
1415
|
+
# }
|
1416
|
+
#
|
1417
|
+
# @!attribute [rw] calculator_name
|
1418
|
+
# The name of the route calculator resource.
|
1419
|
+
#
|
1420
|
+
# Requirements:
|
1421
|
+
#
|
1422
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-),
|
1423
|
+
# periods (.), and underscores (\_).
|
1424
|
+
#
|
1425
|
+
# * Must be a unique Route calculator resource name.
|
1426
|
+
#
|
1427
|
+
# * No spaces allowed. For example, `ExampleRouteCalculator`.
|
1428
|
+
# @return [String]
|
1429
|
+
#
|
1430
|
+
# @!attribute [rw] data_source
|
1431
|
+
# Specifies the data provider of traffic and road network data.
|
1432
|
+
#
|
1433
|
+
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1434
|
+
# example, entering `HERE` returns an error.
|
1435
|
+
#
|
1436
|
+
# </note>
|
1437
|
+
#
|
1438
|
+
# Valid Values: `Esri` \| `Here`
|
1439
|
+
#
|
1440
|
+
# For more information about data providers, see [Amazon Location
|
1441
|
+
# Service data providers][1].
|
1442
|
+
#
|
1443
|
+
#
|
1444
|
+
#
|
1445
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
1446
|
+
# @return [String]
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] description
|
1449
|
+
# The optional description for the route calculator resource.
|
1450
|
+
# @return [String]
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] pricing_plan
|
1453
|
+
# Specifies the pricing plan for your route calculator resource.
|
1454
|
+
#
|
1455
|
+
# For additional details and restrictions on each pricing plan option,
|
1456
|
+
# see [Amazon Location Service pricing][1].
|
1457
|
+
#
|
1458
|
+
#
|
1459
|
+
#
|
1460
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
1461
|
+
# @return [String]
|
1462
|
+
#
|
1463
|
+
# @!attribute [rw] tags
|
1464
|
+
# Applies one or more tags to the route calculator resource. A tag is
|
1465
|
+
# a key-value pair helps manage, identify, search, and filter your
|
1466
|
+
# resources by labelling them.
|
1467
|
+
#
|
1468
|
+
# * For example: \\\{ `"tag1" : "value1"`, `"tag2" : "value2"`\\}
|
1469
|
+
#
|
1470
|
+
# ^
|
1471
|
+
#
|
1472
|
+
# Format: `"key" : "value"`
|
1473
|
+
#
|
1474
|
+
# Restrictions:
|
1475
|
+
#
|
1476
|
+
# * Maximum 50 tags per resource
|
1477
|
+
#
|
1478
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1479
|
+
#
|
1480
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1481
|
+
#
|
1482
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1483
|
+
#
|
1484
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1485
|
+
# characters: + - = . \_ : / @.
|
1486
|
+
# @return [Hash<String,String>]
|
1487
|
+
#
|
1488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculatorRequest AWS API Documentation
|
1489
|
+
#
|
1490
|
+
class CreateRouteCalculatorRequest < Struct.new(
|
1491
|
+
:calculator_name,
|
1492
|
+
:data_source,
|
1493
|
+
:description,
|
1494
|
+
:pricing_plan,
|
1495
|
+
:tags)
|
1496
|
+
SENSITIVE = []
|
1497
|
+
include Aws::Structure
|
1498
|
+
end
|
1499
|
+
|
1500
|
+
# @!attribute [rw] calculator_arn
|
1501
|
+
# The Amazon Resource Name (ARN) for the route calculator resource.
|
1502
|
+
# Use the ARN when you specify a resource across all AWS.
|
1503
|
+
#
|
1504
|
+
# * Format example:
|
1505
|
+
# `arn:aws:geo:region:account-id:route-calculator/ExampleCalculator`
|
1506
|
+
#
|
1507
|
+
# ^
|
1508
|
+
# @return [String]
|
1509
|
+
#
|
1510
|
+
# @!attribute [rw] calculator_name
|
1511
|
+
# The name of the route calculator resource.
|
1512
|
+
#
|
1513
|
+
# * For example, `ExampleRouteCalculator`.
|
1514
|
+
#
|
1515
|
+
# ^
|
1516
|
+
# @return [String]
|
1517
|
+
#
|
1518
|
+
# @!attribute [rw] create_time
|
1519
|
+
# The timestamp when the route calculator resource was created in [ISO
|
1520
|
+
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
1521
|
+
#
|
1522
|
+
# * For example, `2020–07-2T12:15:20.000Z+01:00`
|
1523
|
+
#
|
1524
|
+
# ^
|
1525
|
+
#
|
1526
|
+
#
|
1527
|
+
#
|
1528
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1529
|
+
# @return [Time]
|
1530
|
+
#
|
1531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculatorResponse AWS API Documentation
|
1532
|
+
#
|
1533
|
+
class CreateRouteCalculatorResponse < Struct.new(
|
1534
|
+
:calculator_arn,
|
1535
|
+
:calculator_name,
|
1536
|
+
:create_time)
|
1537
|
+
SENSITIVE = []
|
1538
|
+
include Aws::Structure
|
1539
|
+
end
|
1540
|
+
|
814
1541
|
# @note When making an API call, you may pass CreateTrackerRequest
|
815
1542
|
# data as a hash:
|
816
1543
|
#
|
817
1544
|
# {
|
818
1545
|
# description: "ResourceDescription",
|
1546
|
+
# kms_key_id: "KmsKeyId",
|
819
1547
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
820
1548
|
# pricing_plan_data_source: "String",
|
1549
|
+
# tags: {
|
1550
|
+
# "TagKey" => "TagValue",
|
1551
|
+
# },
|
821
1552
|
# tracker_name: "ResourceName", # required
|
822
1553
|
# }
|
823
1554
|
#
|
@@ -825,8 +1556,17 @@ module Aws::LocationService
|
|
825
1556
|
# An optional description for the tracker resource.
|
826
1557
|
# @return [String]
|
827
1558
|
#
|
1559
|
+
# @!attribute [rw] kms_key_id
|
1560
|
+
# A key identifier for an [AWS KMS customer managed key][1]. Enter a
|
1561
|
+
# key ID, key ARN, alias name, or alias ARN.
|
1562
|
+
#
|
1563
|
+
#
|
1564
|
+
#
|
1565
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1566
|
+
# @return [String]
|
1567
|
+
#
|
828
1568
|
# @!attribute [rw] pricing_plan
|
829
|
-
# Specifies the pricing plan for
|
1569
|
+
# Specifies the pricing plan for the tracker resource.
|
830
1570
|
#
|
831
1571
|
# For additional details and restrictions on each pricing plan option,
|
832
1572
|
# see the [Amazon Location Service pricing page][1].
|
@@ -837,22 +1577,52 @@ module Aws::LocationService
|
|
837
1577
|
# @return [String]
|
838
1578
|
#
|
839
1579
|
# @!attribute [rw] pricing_plan_data_source
|
840
|
-
# Specifies the
|
841
|
-
# Tracking (MAT) or the Mobile Asset Management (MAM) pricing plan is
|
842
|
-
# selected.
|
1580
|
+
# Specifies the data provider for the tracker resource.
|
843
1581
|
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
1582
|
+
# * Required value for the following pricing plans:
|
1583
|
+
# `MobileAssetTracking `\| `MobileAssetManagement`
|
1584
|
+
#
|
1585
|
+
# ^
|
1586
|
+
#
|
1587
|
+
# For more information about [Data Providers][1], and [Pricing
|
1588
|
+
# plans][2], see the Amazon Location Service product page.
|
1589
|
+
#
|
1590
|
+
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to
|
1591
|
+
# calculate billing for your tracker resource. Your data will not be
|
1592
|
+
# shared with the data provider, and will remain in your AWS account
|
1593
|
+
# or Region unless you move it.
|
1594
|
+
#
|
1595
|
+
# </note>
|
848
1596
|
#
|
849
1597
|
# Valid Values: `Esri` \| `Here`
|
850
1598
|
#
|
851
1599
|
#
|
852
1600
|
#
|
853
|
-
# [1]: https://aws.amazon.com/location/
|
1601
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
1602
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
854
1603
|
# @return [String]
|
855
1604
|
#
|
1605
|
+
# @!attribute [rw] tags
|
1606
|
+
# Applies one or more tags to the tracker resource. A tag is a
|
1607
|
+
# key-value pair helps manage, identify, search, and filter your
|
1608
|
+
# resources by labelling them.
|
1609
|
+
#
|
1610
|
+
# Format: `"key" : "value"`
|
1611
|
+
#
|
1612
|
+
# Restrictions:
|
1613
|
+
#
|
1614
|
+
# * Maximum 50 tags per resource
|
1615
|
+
#
|
1616
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1617
|
+
#
|
1618
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1619
|
+
#
|
1620
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1621
|
+
#
|
1622
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1623
|
+
# characters: + - = . \_ : / @.
|
1624
|
+
# @return [Hash<String,String>]
|
1625
|
+
#
|
856
1626
|
# @!attribute [rw] tracker_name
|
857
1627
|
# The name for the tracker resource.
|
858
1628
|
#
|
@@ -870,8 +1640,10 @@ module Aws::LocationService
|
|
870
1640
|
#
|
871
1641
|
class CreateTrackerRequest < Struct.new(
|
872
1642
|
:description,
|
1643
|
+
:kms_key_id,
|
873
1644
|
:pricing_plan,
|
874
1645
|
:pricing_plan_data_source,
|
1646
|
+
:tags,
|
875
1647
|
:tracker_name)
|
876
1648
|
SENSITIVE = []
|
877
1649
|
include Aws::Structure
|
@@ -889,6 +1661,11 @@ module Aws::LocationService
|
|
889
1661
|
# @!attribute [rw] tracker_arn
|
890
1662
|
# The Amazon Resource Name (ARN) for the tracker resource. Used when
|
891
1663
|
# you need to specify a resource across all AWS.
|
1664
|
+
#
|
1665
|
+
# * Format example:
|
1666
|
+
# `arn:aws:geo:region:account-id:tracker/ExampleTracker`
|
1667
|
+
#
|
1668
|
+
# ^
|
892
1669
|
# @return [String]
|
893
1670
|
#
|
894
1671
|
# @!attribute [rw] tracker_name
|
@@ -907,22 +1684,6 @@ module Aws::LocationService
|
|
907
1684
|
|
908
1685
|
# Specifies the data storage option chosen for requesting Places.
|
909
1686
|
#
|
910
|
-
# <note markdown="1"> By using Places, you agree that AWS may transmit your API queries to
|
911
|
-
# your selected third party provider for processing, which may be
|
912
|
-
# outside the AWS region you are currently using.
|
913
|
-
#
|
914
|
-
# Also, when using HERE as your data provider, you may not (a) use HERE
|
915
|
-
# Places for Asset Management, or (b) select the `Storage` option for
|
916
|
-
# the `IntendedUse` parameter when requesting Places in Japan. For more
|
917
|
-
# information, see the [AWS Service Terms][1] for Amazon Location
|
918
|
-
# Service.
|
919
|
-
#
|
920
|
-
# </note>
|
921
|
-
#
|
922
|
-
#
|
923
|
-
#
|
924
|
-
# [1]: https://aws.amazon.com/service-terms/
|
925
|
-
#
|
926
1687
|
# @note When making an API call, you may pass DataSourceConfiguration
|
927
1688
|
# data as a hash:
|
928
1689
|
#
|
@@ -941,6 +1702,10 @@ module Aws::LocationService
|
|
941
1702
|
# * `Storage` specifies that the result can be cached or stored in a
|
942
1703
|
# database.
|
943
1704
|
#
|
1705
|
+
# Place index resources using HERE as a data provider can't be
|
1706
|
+
# configured to store results for locations in Japan when choosing
|
1707
|
+
# `Storage` for the `IntendedUse` parameter.
|
1708
|
+
#
|
944
1709
|
# Default value: `SingleUse`
|
945
1710
|
# @return [String]
|
946
1711
|
#
|
@@ -1006,7 +1771,7 @@ module Aws::LocationService
|
|
1006
1771
|
# }
|
1007
1772
|
#
|
1008
1773
|
# @!attribute [rw] index_name
|
1009
|
-
# The name of the
|
1774
|
+
# The name of the place index resource to be deleted.
|
1010
1775
|
# @return [String]
|
1011
1776
|
#
|
1012
1777
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeletePlaceIndexRequest AWS API Documentation
|
@@ -1021,6 +1786,29 @@ module Aws::LocationService
|
|
1021
1786
|
#
|
1022
1787
|
class DeletePlaceIndexResponse < Aws::EmptyStructure; end
|
1023
1788
|
|
1789
|
+
# @note When making an API call, you may pass DeleteRouteCalculatorRequest
|
1790
|
+
# data as a hash:
|
1791
|
+
#
|
1792
|
+
# {
|
1793
|
+
# calculator_name: "ResourceName", # required
|
1794
|
+
# }
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] calculator_name
|
1797
|
+
# The name of the route calculator resource to be deleted.
|
1798
|
+
# @return [String]
|
1799
|
+
#
|
1800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteRouteCalculatorRequest AWS API Documentation
|
1801
|
+
#
|
1802
|
+
class DeleteRouteCalculatorRequest < Struct.new(
|
1803
|
+
:calculator_name)
|
1804
|
+
SENSITIVE = []
|
1805
|
+
include Aws::Structure
|
1806
|
+
end
|
1807
|
+
|
1808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteRouteCalculatorResponse AWS API Documentation
|
1809
|
+
#
|
1810
|
+
class DeleteRouteCalculatorResponse < Aws::EmptyStructure; end
|
1811
|
+
|
1024
1812
|
# @note When making an API call, you may pass DeleteTrackerRequest
|
1025
1813
|
# data as a hash:
|
1026
1814
|
#
|
@@ -1066,6 +1854,11 @@ module Aws::LocationService
|
|
1066
1854
|
# @!attribute [rw] collection_arn
|
1067
1855
|
# The Amazon Resource Name (ARN) for the geofence collection resource.
|
1068
1856
|
# Used when you need to specify a resource across all AWS.
|
1857
|
+
#
|
1858
|
+
# * Format example:
|
1859
|
+
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection`
|
1860
|
+
#
|
1861
|
+
# ^
|
1069
1862
|
# @return [String]
|
1070
1863
|
#
|
1071
1864
|
# @!attribute [rw] collection_name
|
@@ -1085,6 +1878,15 @@ module Aws::LocationService
|
|
1085
1878
|
# The optional description for the geofence collection.
|
1086
1879
|
# @return [String]
|
1087
1880
|
#
|
1881
|
+
# @!attribute [rw] kms_key_id
|
1882
|
+
# A key identifier for an [AWS KMS customer managed key][1] assigned
|
1883
|
+
# to the Amazon Location resource
|
1884
|
+
#
|
1885
|
+
#
|
1886
|
+
#
|
1887
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1888
|
+
# @return [String]
|
1889
|
+
#
|
1088
1890
|
# @!attribute [rw] pricing_plan
|
1089
1891
|
# The pricing plan selected for the specified geofence collection.
|
1090
1892
|
#
|
@@ -1097,10 +1899,13 @@ module Aws::LocationService
|
|
1097
1899
|
# @return [String]
|
1098
1900
|
#
|
1099
1901
|
# @!attribute [rw] pricing_plan_data_source
|
1100
|
-
# The data
|
1101
|
-
# pricing plan.
|
1902
|
+
# The specified data provider for the geofence collection.
|
1102
1903
|
# @return [String]
|
1103
1904
|
#
|
1905
|
+
# @!attribute [rw] tags
|
1906
|
+
# Displays the key, value pairs of tags associated with this resource.
|
1907
|
+
# @return [Hash<String,String>]
|
1908
|
+
#
|
1104
1909
|
# @!attribute [rw] update_time
|
1105
1910
|
# The timestamp for when the geofence collection was last updated in
|
1106
1911
|
# [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
|
@@ -1117,8 +1922,10 @@ module Aws::LocationService
|
|
1117
1922
|
:collection_name,
|
1118
1923
|
:create_time,
|
1119
1924
|
:description,
|
1925
|
+
:kms_key_id,
|
1120
1926
|
:pricing_plan,
|
1121
1927
|
:pricing_plan_data_source,
|
1928
|
+
:tags,
|
1122
1929
|
:update_time)
|
1123
1930
|
SENSITIVE = []
|
1124
1931
|
include Aws::Structure
|
@@ -1167,6 +1974,10 @@ module Aws::LocationService
|
|
1167
1974
|
# @!attribute [rw] map_arn
|
1168
1975
|
# The Amazon Resource Name (ARN) for the map resource. Used when you
|
1169
1976
|
# need to specify a resource across all AWS.
|
1977
|
+
#
|
1978
|
+
# * Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`
|
1979
|
+
#
|
1980
|
+
# ^
|
1170
1981
|
# @return [String]
|
1171
1982
|
#
|
1172
1983
|
# @!attribute [rw] map_name
|
@@ -1179,6 +1990,10 @@ module Aws::LocationService
|
|
1179
1990
|
# <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>
|
1180
1991
|
# @return [String]
|
1181
1992
|
#
|
1993
|
+
# @!attribute [rw] tags
|
1994
|
+
# Tags associated with the map resource.
|
1995
|
+
# @return [Hash<String,String>]
|
1996
|
+
#
|
1182
1997
|
# @!attribute [rw] update_time
|
1183
1998
|
# The timestamp for when the map resource was last update in [ISO
|
1184
1999
|
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
@@ -1198,6 +2013,7 @@ module Aws::LocationService
|
|
1198
2013
|
:map_arn,
|
1199
2014
|
:map_name,
|
1200
2015
|
:pricing_plan,
|
2016
|
+
:tags,
|
1201
2017
|
:update_time)
|
1202
2018
|
SENSITIVE = []
|
1203
2019
|
include Aws::Structure
|
@@ -1211,7 +2027,7 @@ module Aws::LocationService
|
|
1211
2027
|
# }
|
1212
2028
|
#
|
1213
2029
|
# @!attribute [rw] index_name
|
1214
|
-
# The name of the
|
2030
|
+
# The name of the place index resource.
|
1215
2031
|
# @return [String]
|
1216
2032
|
#
|
1217
2033
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndexRequest AWS API Documentation
|
@@ -1223,7 +2039,7 @@ module Aws::LocationService
|
|
1223
2039
|
end
|
1224
2040
|
|
1225
2041
|
# @!attribute [rw] create_time
|
1226
|
-
# The timestamp for when the
|
2042
|
+
# The timestamp for when the place index resource was created in [ISO
|
1227
2043
|
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
1228
2044
|
#
|
1229
2045
|
#
|
@@ -1252,20 +2068,25 @@ module Aws::LocationService
|
|
1252
2068
|
# @return [Types::DataSourceConfiguration]
|
1253
2069
|
#
|
1254
2070
|
# @!attribute [rw] description
|
1255
|
-
# The optional description for the
|
2071
|
+
# The optional description for the place index resource.
|
1256
2072
|
# @return [String]
|
1257
2073
|
#
|
1258
2074
|
# @!attribute [rw] index_arn
|
1259
|
-
# The Amazon Resource Name (ARN) for the
|
1260
|
-
#
|
2075
|
+
# The Amazon Resource Name (ARN) for the place index resource. Used to
|
2076
|
+
# specify a resource across all AWS.
|
2077
|
+
#
|
2078
|
+
# * Format example:
|
2079
|
+
# `arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex`
|
2080
|
+
#
|
2081
|
+
# ^
|
1261
2082
|
# @return [String]
|
1262
2083
|
#
|
1263
2084
|
# @!attribute [rw] index_name
|
1264
|
-
# The name of the
|
2085
|
+
# The name of the place index resource being described.
|
1265
2086
|
# @return [String]
|
1266
2087
|
#
|
1267
2088
|
# @!attribute [rw] pricing_plan
|
1268
|
-
# The pricing plan selected for the specified
|
2089
|
+
# The pricing plan selected for the specified place index resource.
|
1269
2090
|
#
|
1270
2091
|
# For additional details and restrictions on each pricing plan option,
|
1271
2092
|
# see the [Amazon Location Service pricing page][1].
|
@@ -1275,8 +2096,12 @@ module Aws::LocationService
|
|
1275
2096
|
# [1]: https://aws.amazon.com/location/pricing/
|
1276
2097
|
# @return [String]
|
1277
2098
|
#
|
2099
|
+
# @!attribute [rw] tags
|
2100
|
+
# Tags associated with place index resource.
|
2101
|
+
# @return [Hash<String,String>]
|
2102
|
+
#
|
1278
2103
|
# @!attribute [rw] update_time
|
1279
|
-
# The timestamp for when the
|
2104
|
+
# The timestamp for when the place index resource was last updated in
|
1280
2105
|
# [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
1281
2106
|
#
|
1282
2107
|
#
|
@@ -1294,6 +2119,117 @@ module Aws::LocationService
|
|
1294
2119
|
:index_arn,
|
1295
2120
|
:index_name,
|
1296
2121
|
:pricing_plan,
|
2122
|
+
:tags,
|
2123
|
+
:update_time)
|
2124
|
+
SENSITIVE = []
|
2125
|
+
include Aws::Structure
|
2126
|
+
end
|
2127
|
+
|
2128
|
+
# @note When making an API call, you may pass DescribeRouteCalculatorRequest
|
2129
|
+
# data as a hash:
|
2130
|
+
#
|
2131
|
+
# {
|
2132
|
+
# calculator_name: "ResourceName", # required
|
2133
|
+
# }
|
2134
|
+
#
|
2135
|
+
# @!attribute [rw] calculator_name
|
2136
|
+
# The name of the route calculator resource.
|
2137
|
+
# @return [String]
|
2138
|
+
#
|
2139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeRouteCalculatorRequest AWS API Documentation
|
2140
|
+
#
|
2141
|
+
class DescribeRouteCalculatorRequest < Struct.new(
|
2142
|
+
:calculator_name)
|
2143
|
+
SENSITIVE = []
|
2144
|
+
include Aws::Structure
|
2145
|
+
end
|
2146
|
+
|
2147
|
+
# @!attribute [rw] calculator_arn
|
2148
|
+
# The Amazon Resource Name (ARN) for the Route calculator resource.
|
2149
|
+
# Use the ARN when you specify a resource across AWS.
|
2150
|
+
#
|
2151
|
+
# * Format example:
|
2152
|
+
# `arn:aws:geo:region:account-id:route-calculator/ExampleCalculator`
|
2153
|
+
#
|
2154
|
+
# ^
|
2155
|
+
# @return [String]
|
2156
|
+
#
|
2157
|
+
# @!attribute [rw] calculator_name
|
2158
|
+
# The name of the route calculator resource being described.
|
2159
|
+
# @return [String]
|
2160
|
+
#
|
2161
|
+
# @!attribute [rw] create_time
|
2162
|
+
# The timestamp when the route calculator resource was created in [ISO
|
2163
|
+
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
2164
|
+
#
|
2165
|
+
# * For example, `2020–07-2T12:15:20.000Z+01:00`
|
2166
|
+
#
|
2167
|
+
# ^
|
2168
|
+
#
|
2169
|
+
#
|
2170
|
+
#
|
2171
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
2172
|
+
# @return [Time]
|
2173
|
+
#
|
2174
|
+
# @!attribute [rw] data_source
|
2175
|
+
# The data provider of traffic and road network data. Indicates one of
|
2176
|
+
# the available providers:
|
2177
|
+
#
|
2178
|
+
# * `Esri`
|
2179
|
+
#
|
2180
|
+
# * `Here`
|
2181
|
+
#
|
2182
|
+
# For more information about data providers, see [Amazon Location
|
2183
|
+
# Service data providers][1].
|
2184
|
+
#
|
2185
|
+
#
|
2186
|
+
#
|
2187
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
2188
|
+
# @return [String]
|
2189
|
+
#
|
2190
|
+
# @!attribute [rw] description
|
2191
|
+
# The optional description of the route calculator resource.
|
2192
|
+
# @return [String]
|
2193
|
+
#
|
2194
|
+
# @!attribute [rw] pricing_plan
|
2195
|
+
# The pricing plan selected for the specified route calculator
|
2196
|
+
# resource.
|
2197
|
+
#
|
2198
|
+
# For additional details and restrictions on each pricing plan option,
|
2199
|
+
# see [Amazon Location Service pricing][1].
|
2200
|
+
#
|
2201
|
+
#
|
2202
|
+
#
|
2203
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
2204
|
+
# @return [String]
|
2205
|
+
#
|
2206
|
+
# @!attribute [rw] tags
|
2207
|
+
# Tags associated with route calculator resource.
|
2208
|
+
# @return [Hash<String,String>]
|
2209
|
+
#
|
2210
|
+
# @!attribute [rw] update_time
|
2211
|
+
# The timestamp when the route calculator resource was last updated in
|
2212
|
+
# [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
2213
|
+
#
|
2214
|
+
# * For example, `2020–07-2T12:15:20.000Z+01:00`
|
2215
|
+
#
|
2216
|
+
# ^
|
2217
|
+
#
|
2218
|
+
#
|
2219
|
+
#
|
2220
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
2221
|
+
# @return [Time]
|
2222
|
+
#
|
2223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeRouteCalculatorResponse AWS API Documentation
|
2224
|
+
#
|
2225
|
+
class DescribeRouteCalculatorResponse < Struct.new(
|
2226
|
+
:calculator_arn,
|
2227
|
+
:calculator_name,
|
2228
|
+
:create_time,
|
2229
|
+
:data_source,
|
2230
|
+
:description,
|
2231
|
+
:pricing_plan,
|
2232
|
+
:tags,
|
1297
2233
|
:update_time)
|
1298
2234
|
SENSITIVE = []
|
1299
2235
|
include Aws::Structure
|
@@ -1331,6 +2267,15 @@ module Aws::LocationService
|
|
1331
2267
|
# The optional description for the tracker resource.
|
1332
2268
|
# @return [String]
|
1333
2269
|
#
|
2270
|
+
# @!attribute [rw] kms_key_id
|
2271
|
+
# A key identifier for an [AWS KMS customer managed key][1] assigned
|
2272
|
+
# to the Amazon Location resource.
|
2273
|
+
#
|
2274
|
+
#
|
2275
|
+
#
|
2276
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
2277
|
+
# @return [String]
|
2278
|
+
#
|
1334
2279
|
# @!attribute [rw] pricing_plan
|
1335
2280
|
# The pricing plan selected for the specified tracker resource.
|
1336
2281
|
#
|
@@ -1343,13 +2288,21 @@ module Aws::LocationService
|
|
1343
2288
|
# @return [String]
|
1344
2289
|
#
|
1345
2290
|
# @!attribute [rw] pricing_plan_data_source
|
1346
|
-
# The data
|
1347
|
-
# pricing plan.
|
2291
|
+
# The specified data provider for the tracker resource.
|
1348
2292
|
# @return [String]
|
1349
2293
|
#
|
2294
|
+
# @!attribute [rw] tags
|
2295
|
+
# The tags associated with the tracker resource.
|
2296
|
+
# @return [Hash<String,String>]
|
2297
|
+
#
|
1350
2298
|
# @!attribute [rw] tracker_arn
|
1351
2299
|
# The Amazon Resource Name (ARN) for the tracker resource. Used when
|
1352
2300
|
# you need to specify a resource across all AWS.
|
2301
|
+
#
|
2302
|
+
# * Format example:
|
2303
|
+
# `arn:aws:geo:region:account-id:tracker/ExampleTracker`
|
2304
|
+
#
|
2305
|
+
# ^
|
1353
2306
|
# @return [String]
|
1354
2307
|
#
|
1355
2308
|
# @!attribute [rw] tracker_name
|
@@ -1370,8 +2323,10 @@ module Aws::LocationService
|
|
1370
2323
|
class DescribeTrackerResponse < Struct.new(
|
1371
2324
|
:create_time,
|
1372
2325
|
:description,
|
2326
|
+
:kms_key_id,
|
1373
2327
|
:pricing_plan,
|
1374
2328
|
:pricing_plan_data_source,
|
2329
|
+
:tags,
|
1375
2330
|
:tracker_arn,
|
1376
2331
|
:tracker_name,
|
1377
2332
|
:update_time)
|
@@ -1475,7 +2430,7 @@ module Aws::LocationService
|
|
1475
2430
|
# specify a resource across all AWS.
|
1476
2431
|
#
|
1477
2432
|
# * Format example:
|
1478
|
-
# `arn:
|
2433
|
+
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
|
1479
2434
|
#
|
1480
2435
|
# ^
|
1481
2436
|
# @return [String]
|
@@ -1500,7 +2455,7 @@ module Aws::LocationService
|
|
1500
2455
|
|
1501
2456
|
# Contains the geofence geometry details.
|
1502
2457
|
#
|
1503
|
-
# <note markdown="1"> Amazon Location
|
2458
|
+
# <note markdown="1"> Amazon Location doesn't currently support polygons with holes,
|
1504
2459
|
# multipolygons, polygons that are wound clockwise, or that cross the
|
1505
2460
|
# antimeridian.
|
1506
2461
|
#
|
@@ -1789,7 +2744,7 @@ module Aws::LocationService
|
|
1789
2744
|
#
|
1790
2745
|
# @!attribute [rw] font_unicode_range
|
1791
2746
|
# A Unicode range of characters to download glyphs for. Each response
|
1792
|
-
# will contain 256 characters. For example, 0
|
2747
|
+
# will contain 256 characters. For example, 0–255 includes all
|
1793
2748
|
# characters from range `U+0000` to `00FF`. Must be aligned to
|
1794
2749
|
# multiples of 256.
|
1795
2750
|
# @return [String]
|
@@ -1955,35 +2910,241 @@ module Aws::LocationService
|
|
1955
2910
|
include Aws::Structure
|
1956
2911
|
end
|
1957
2912
|
|
1958
|
-
# @!attribute [rw] blob
|
1959
|
-
# Contains Mapbox Vector Tile (MVT) data.
|
1960
|
-
# @return [String]
|
2913
|
+
# @!attribute [rw] blob
|
2914
|
+
# Contains Mapbox Vector Tile (MVT) data.
|
2915
|
+
# @return [String]
|
2916
|
+
#
|
2917
|
+
# @!attribute [rw] content_type
|
2918
|
+
# The map tile's content type. For example,
|
2919
|
+
# `application/vnd.mapbox-vector-tile`.
|
2920
|
+
# @return [String]
|
2921
|
+
#
|
2922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTileResponse AWS API Documentation
|
2923
|
+
#
|
2924
|
+
class GetMapTileResponse < Struct.new(
|
2925
|
+
:blob,
|
2926
|
+
:content_type)
|
2927
|
+
SENSITIVE = []
|
2928
|
+
include Aws::Structure
|
2929
|
+
end
|
2930
|
+
|
2931
|
+
# The request has failed to process because of an unknown server error,
|
2932
|
+
# exception, or failure.
|
2933
|
+
#
|
2934
|
+
# @!attribute [rw] message
|
2935
|
+
# @return [String]
|
2936
|
+
#
|
2937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/InternalServerException AWS API Documentation
|
2938
|
+
#
|
2939
|
+
class InternalServerException < Struct.new(
|
2940
|
+
:message)
|
2941
|
+
SENSITIVE = []
|
2942
|
+
include Aws::Structure
|
2943
|
+
end
|
2944
|
+
|
2945
|
+
# Contains the calculated route's details for each path between a pair
|
2946
|
+
# of positions. The number of legs returned corresponds to one less than
|
2947
|
+
# the total number of positions in the request.
|
2948
|
+
#
|
2949
|
+
# For example, a route with a departure position and destination
|
2950
|
+
# position returns one leg with the positions [snapped to a nearby
|
2951
|
+
# road][1]\:
|
2952
|
+
#
|
2953
|
+
# * The `StartPosition` is the departure position.
|
2954
|
+
#
|
2955
|
+
# * The `EndPosition` is the destination position.
|
2956
|
+
#
|
2957
|
+
# A route with a waypoint between the departure and destination position
|
2958
|
+
# returns two legs with the positions snapped to a nearby road.:
|
2959
|
+
#
|
2960
|
+
# * Leg 1: The `StartPosition` is the departure position . The
|
2961
|
+
# `EndPosition` is the waypoint positon.
|
2962
|
+
#
|
2963
|
+
# * Leg 2: The `StartPosition` is the waypoint position. The
|
2964
|
+
# `EndPosition` is the destination position.
|
2965
|
+
#
|
2966
|
+
#
|
2967
|
+
#
|
2968
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
2969
|
+
#
|
2970
|
+
# @!attribute [rw] distance
|
2971
|
+
# The distance between the leg's `StartPosition` and `EndPosition`
|
2972
|
+
# along a calculated route.
|
2973
|
+
#
|
2974
|
+
# * The default measurement is `Kilometers` unless the request
|
2975
|
+
# specifies a `DistanceUnit` of `Miles`.
|
2976
|
+
#
|
2977
|
+
# ^
|
2978
|
+
# @return [Float]
|
2979
|
+
#
|
2980
|
+
# @!attribute [rw] duration_seconds
|
2981
|
+
# The estimated travel time between the leg's `StartPosition` and
|
2982
|
+
# `EndPosition`. The travel mode and departure time that you specify
|
2983
|
+
# in the request determines the calculated time.
|
2984
|
+
# @return [Float]
|
2985
|
+
#
|
2986
|
+
# @!attribute [rw] end_position
|
2987
|
+
# The terminating position of the leg. Follows the format
|
2988
|
+
# `[longitude,latitude]`.
|
2989
|
+
#
|
2990
|
+
# <note markdown="1"> If the `EndPosition` isn't located on a road, it's [snapped to a
|
2991
|
+
# nearby road][1].
|
2992
|
+
#
|
2993
|
+
# </note>
|
2994
|
+
#
|
2995
|
+
#
|
2996
|
+
#
|
2997
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
2998
|
+
# @return [Array<Float>]
|
2999
|
+
#
|
3000
|
+
# @!attribute [rw] geometry
|
3001
|
+
# Contains the calculated route's path as a linestring geometry.
|
3002
|
+
# @return [Types::LegGeometry]
|
3003
|
+
#
|
3004
|
+
# @!attribute [rw] start_position
|
3005
|
+
# The starting position of the leg. Follows the format
|
3006
|
+
# `[longitude,latitude]`.
|
3007
|
+
#
|
3008
|
+
# <note markdown="1"> If the `StartPosition` isn't located on a road, it's [snapped to a
|
3009
|
+
# nearby road][1].
|
3010
|
+
#
|
3011
|
+
# </note>
|
3012
|
+
#
|
3013
|
+
#
|
3014
|
+
#
|
3015
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
3016
|
+
# @return [Array<Float>]
|
3017
|
+
#
|
3018
|
+
# @!attribute [rw] steps
|
3019
|
+
# Contains a list of steps, which represent subsections of a leg. Each
|
3020
|
+
# step provides instructions for how to move to the next step in the
|
3021
|
+
# leg such as the step's start position, end position, travel
|
3022
|
+
# distance, travel duration, and geometry offset.
|
3023
|
+
# @return [Array<Types::Step>]
|
3024
|
+
#
|
3025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Leg AWS API Documentation
|
3026
|
+
#
|
3027
|
+
class Leg < Struct.new(
|
3028
|
+
:distance,
|
3029
|
+
:duration_seconds,
|
3030
|
+
:end_position,
|
3031
|
+
:geometry,
|
3032
|
+
:start_position,
|
3033
|
+
:steps)
|
3034
|
+
SENSITIVE = [:end_position, :start_position]
|
3035
|
+
include Aws::Structure
|
3036
|
+
end
|
3037
|
+
|
3038
|
+
# Contains the geometry details for each path between a pair of
|
3039
|
+
# positions. Used in plotting a route leg on a map.
|
3040
|
+
#
|
3041
|
+
# @!attribute [rw] line_string
|
3042
|
+
# An ordered list of positions used to plot a route on a map.
|
3043
|
+
#
|
3044
|
+
# The first position is closest to the start position for the leg, and
|
3045
|
+
# the last position is the closest to the end position for the leg.
|
3046
|
+
#
|
3047
|
+
# * For example, `[[-123.117, 49.284],[-123.115, 49.285],[-123.115,
|
3048
|
+
# 49.285]]`
|
3049
|
+
#
|
3050
|
+
# ^
|
3051
|
+
# @return [Array<Array<Float>>]
|
3052
|
+
#
|
3053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/LegGeometry AWS API Documentation
|
3054
|
+
#
|
3055
|
+
class LegGeometry < Struct.new(
|
3056
|
+
:line_string)
|
3057
|
+
SENSITIVE = []
|
3058
|
+
include Aws::Structure
|
3059
|
+
end
|
3060
|
+
|
3061
|
+
# @note When making an API call, you may pass ListDevicePositionsRequest
|
3062
|
+
# data as a hash:
|
3063
|
+
#
|
3064
|
+
# {
|
3065
|
+
# max_results: 1,
|
3066
|
+
# next_token: "Token",
|
3067
|
+
# tracker_name: "ResourceName", # required
|
3068
|
+
# }
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] max_results
|
3071
|
+
# An optional limit for the number of entries returned in a single
|
3072
|
+
# call.
|
3073
|
+
#
|
3074
|
+
# Default value: `100`
|
3075
|
+
# @return [Integer]
|
3076
|
+
#
|
3077
|
+
# @!attribute [rw] next_token
|
3078
|
+
# The pagination token specifying which page of results to return in
|
3079
|
+
# the response. If no token is provided, the default page is the first
|
3080
|
+
# page.
|
3081
|
+
#
|
3082
|
+
# Default value: `null`
|
3083
|
+
# @return [String]
|
3084
|
+
#
|
3085
|
+
# @!attribute [rw] tracker_name
|
3086
|
+
# The tracker resource containing the requested devices.
|
3087
|
+
# @return [String]
|
3088
|
+
#
|
3089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositionsRequest AWS API Documentation
|
3090
|
+
#
|
3091
|
+
class ListDevicePositionsRequest < Struct.new(
|
3092
|
+
:max_results,
|
3093
|
+
:next_token,
|
3094
|
+
:tracker_name)
|
3095
|
+
SENSITIVE = []
|
3096
|
+
include Aws::Structure
|
3097
|
+
end
|
3098
|
+
|
3099
|
+
# @!attribute [rw] entries
|
3100
|
+
# Contains details about each device's last known position. These
|
3101
|
+
# details includes the device ID, the time when the position was
|
3102
|
+
# sampled on the device, the time that the service received the
|
3103
|
+
# update, and the most recent coordinates.
|
3104
|
+
# @return [Array<Types::ListDevicePositionsResponseEntry>]
|
1961
3105
|
#
|
1962
|
-
# @!attribute [rw]
|
1963
|
-
#
|
1964
|
-
#
|
3106
|
+
# @!attribute [rw] next_token
|
3107
|
+
# A pagination token indicating there are additional pages available.
|
3108
|
+
# You can use the token in a following request to fetch the next set
|
3109
|
+
# of results.
|
1965
3110
|
# @return [String]
|
1966
3111
|
#
|
1967
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/
|
3112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositionsResponse AWS API Documentation
|
1968
3113
|
#
|
1969
|
-
class
|
1970
|
-
:
|
1971
|
-
:
|
3114
|
+
class ListDevicePositionsResponse < Struct.new(
|
3115
|
+
:entries,
|
3116
|
+
:next_token)
|
1972
3117
|
SENSITIVE = []
|
1973
3118
|
include Aws::Structure
|
1974
3119
|
end
|
1975
3120
|
|
1976
|
-
#
|
1977
|
-
# exception, or failure.
|
3121
|
+
# Contains the tracker resource details.
|
1978
3122
|
#
|
1979
|
-
# @!attribute [rw]
|
3123
|
+
# @!attribute [rw] device_id
|
3124
|
+
# The ID of the device for this position.
|
1980
3125
|
# @return [String]
|
1981
3126
|
#
|
1982
|
-
#
|
3127
|
+
# @!attribute [rw] position
|
3128
|
+
# The last known device position. Empty if no positions currently
|
3129
|
+
# stored.
|
3130
|
+
# @return [Array<Float>]
|
1983
3131
|
#
|
1984
|
-
|
1985
|
-
|
1986
|
-
|
3132
|
+
# @!attribute [rw] sample_time
|
3133
|
+
# The timestamp at which the device position was determined. Uses [
|
3134
|
+
# ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
3135
|
+
#
|
3136
|
+
#
|
3137
|
+
#
|
3138
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
3139
|
+
# @return [Time]
|
3140
|
+
#
|
3141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositionsResponseEntry AWS API Documentation
|
3142
|
+
#
|
3143
|
+
class ListDevicePositionsResponseEntry < Struct.new(
|
3144
|
+
:device_id,
|
3145
|
+
:position,
|
3146
|
+
:sample_time)
|
3147
|
+
SENSITIVE = [:position]
|
1987
3148
|
include Aws::Structure
|
1988
3149
|
end
|
1989
3150
|
|
@@ -2069,8 +3230,7 @@ module Aws::LocationService
|
|
2069
3230
|
# @return [String]
|
2070
3231
|
#
|
2071
3232
|
# @!attribute [rw] pricing_plan_data_source
|
2072
|
-
# The data
|
2073
|
-
# pricing plan.
|
3233
|
+
# The specified data provider for the geofence collection.
|
2074
3234
|
# @return [String]
|
2075
3235
|
#
|
2076
3236
|
# @!attribute [rw] update_time
|
@@ -2338,7 +3498,7 @@ module Aws::LocationService
|
|
2338
3498
|
end
|
2339
3499
|
|
2340
3500
|
# @!attribute [rw] entries
|
2341
|
-
# Lists the
|
3501
|
+
# Lists the place index resources that exist in your AWS account
|
2342
3502
|
# @return [Array<Types::ListPlaceIndexesResponseEntry>]
|
2343
3503
|
#
|
2344
3504
|
# @!attribute [rw] next_token
|
@@ -2356,10 +3516,10 @@ module Aws::LocationService
|
|
2356
3516
|
include Aws::Structure
|
2357
3517
|
end
|
2358
3518
|
|
2359
|
-
# A
|
3519
|
+
# A place index resource listed in your AWS account.
|
2360
3520
|
#
|
2361
3521
|
# @!attribute [rw] create_time
|
2362
|
-
# The timestamp for when the
|
3522
|
+
# The timestamp for when the place index resource was created in [ISO
|
2363
3523
|
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
2364
3524
|
#
|
2365
3525
|
#
|
@@ -2371,9 +3531,9 @@ module Aws::LocationService
|
|
2371
3531
|
# The data provider of geospatial data. Indicates one of the available
|
2372
3532
|
# providers:
|
2373
3533
|
#
|
2374
|
-
# * Esri
|
3534
|
+
# * `Esri`
|
2375
3535
|
#
|
2376
|
-
# *
|
3536
|
+
# * `Here`
|
2377
3537
|
#
|
2378
3538
|
# For additional details on data providers, see the [Amazon Location
|
2379
3539
|
# Service data providers page][1].
|
@@ -2384,15 +3544,15 @@ module Aws::LocationService
|
|
2384
3544
|
# @return [String]
|
2385
3545
|
#
|
2386
3546
|
# @!attribute [rw] description
|
2387
|
-
# The optional description for the
|
3547
|
+
# The optional description for the place index resource.
|
2388
3548
|
# @return [String]
|
2389
3549
|
#
|
2390
3550
|
# @!attribute [rw] index_name
|
2391
|
-
# The name of the
|
3551
|
+
# The name of the place index resource.
|
2392
3552
|
# @return [String]
|
2393
3553
|
#
|
2394
3554
|
# @!attribute [rw] pricing_plan
|
2395
|
-
# The pricing plan for the specified
|
3555
|
+
# The pricing plan for the specified place index resource.
|
2396
3556
|
#
|
2397
3557
|
# For additional details and restrictions on each pricing plan option,
|
2398
3558
|
# see the [Amazon Location Service pricing page][1].
|
@@ -2403,7 +3563,7 @@ module Aws::LocationService
|
|
2403
3563
|
# @return [String]
|
2404
3564
|
#
|
2405
3565
|
# @!attribute [rw] update_time
|
2406
|
-
# The timestamp for when the
|
3566
|
+
# The timestamp for when the place index resource was last updated in
|
2407
3567
|
# [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
2408
3568
|
#
|
2409
3569
|
#
|
@@ -2424,6 +3584,165 @@ module Aws::LocationService
|
|
2424
3584
|
include Aws::Structure
|
2425
3585
|
end
|
2426
3586
|
|
3587
|
+
# @note When making an API call, you may pass ListRouteCalculatorsRequest
|
3588
|
+
# data as a hash:
|
3589
|
+
#
|
3590
|
+
# {
|
3591
|
+
# max_results: 1,
|
3592
|
+
# next_token: "Token",
|
3593
|
+
# }
|
3594
|
+
#
|
3595
|
+
# @!attribute [rw] max_results
|
3596
|
+
# An optional maximum number of results returned in a single call.
|
3597
|
+
#
|
3598
|
+
# Default Value: `100`
|
3599
|
+
# @return [Integer]
|
3600
|
+
#
|
3601
|
+
# @!attribute [rw] next_token
|
3602
|
+
# The pagination token specifying which page of results to return in
|
3603
|
+
# the response. If no token is provided, the default page is the first
|
3604
|
+
# page.
|
3605
|
+
#
|
3606
|
+
# Default Value: `null`
|
3607
|
+
# @return [String]
|
3608
|
+
#
|
3609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListRouteCalculatorsRequest AWS API Documentation
|
3610
|
+
#
|
3611
|
+
class ListRouteCalculatorsRequest < Struct.new(
|
3612
|
+
:max_results,
|
3613
|
+
:next_token)
|
3614
|
+
SENSITIVE = []
|
3615
|
+
include Aws::Structure
|
3616
|
+
end
|
3617
|
+
|
3618
|
+
# @!attribute [rw] entries
|
3619
|
+
# Lists the route calculator resources that exist in your AWS account
|
3620
|
+
# @return [Array<Types::ListRouteCalculatorsResponseEntry>]
|
3621
|
+
#
|
3622
|
+
# @!attribute [rw] next_token
|
3623
|
+
# A pagination token indicating there are additional pages available.
|
3624
|
+
# You can use the token in a subsequent request to fetch the next set
|
3625
|
+
# of results.
|
3626
|
+
# @return [String]
|
3627
|
+
#
|
3628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListRouteCalculatorsResponse AWS API Documentation
|
3629
|
+
#
|
3630
|
+
class ListRouteCalculatorsResponse < Struct.new(
|
3631
|
+
:entries,
|
3632
|
+
:next_token)
|
3633
|
+
SENSITIVE = []
|
3634
|
+
include Aws::Structure
|
3635
|
+
end
|
3636
|
+
|
3637
|
+
# A route calculator resource listed in your AWS account.
|
3638
|
+
#
|
3639
|
+
# @!attribute [rw] calculator_name
|
3640
|
+
# The name of the route calculator resource.
|
3641
|
+
# @return [String]
|
3642
|
+
#
|
3643
|
+
# @!attribute [rw] create_time
|
3644
|
+
# The timestamp when the route calculator resource was created in [ISO
|
3645
|
+
# 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
3646
|
+
#
|
3647
|
+
# * For example, `2020–07-2T12:15:20.000Z+01:00`
|
3648
|
+
#
|
3649
|
+
# ^
|
3650
|
+
#
|
3651
|
+
#
|
3652
|
+
#
|
3653
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
3654
|
+
# @return [Time]
|
3655
|
+
#
|
3656
|
+
# @!attribute [rw] data_source
|
3657
|
+
# The data provider of traffic and road network data. Indicates one of
|
3658
|
+
# the available providers:
|
3659
|
+
#
|
3660
|
+
# * `Esri`
|
3661
|
+
#
|
3662
|
+
# * `Here`
|
3663
|
+
#
|
3664
|
+
# For more information about data providers, see [Amazon Location
|
3665
|
+
# Service data providers][1].
|
3666
|
+
#
|
3667
|
+
#
|
3668
|
+
#
|
3669
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
3670
|
+
# @return [String]
|
3671
|
+
#
|
3672
|
+
# @!attribute [rw] description
|
3673
|
+
# The optional description of the route calculator resource.
|
3674
|
+
# @return [String]
|
3675
|
+
#
|
3676
|
+
# @!attribute [rw] pricing_plan
|
3677
|
+
# The pricing plan for the specified route calculator resource.
|
3678
|
+
#
|
3679
|
+
# For additional details and restrictions on each pricing plan option,
|
3680
|
+
# see [Amazon Location Service pricing][1].
|
3681
|
+
#
|
3682
|
+
#
|
3683
|
+
#
|
3684
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3685
|
+
# @return [String]
|
3686
|
+
#
|
3687
|
+
# @!attribute [rw] update_time
|
3688
|
+
# The timestamp when the route calculator resource was last updated in
|
3689
|
+
# [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
3690
|
+
#
|
3691
|
+
# * For example, `2020–07-2T12:15:20.000Z+01:00`
|
3692
|
+
#
|
3693
|
+
# ^
|
3694
|
+
#
|
3695
|
+
#
|
3696
|
+
#
|
3697
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
3698
|
+
# @return [Time]
|
3699
|
+
#
|
3700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListRouteCalculatorsResponseEntry AWS API Documentation
|
3701
|
+
#
|
3702
|
+
class ListRouteCalculatorsResponseEntry < Struct.new(
|
3703
|
+
:calculator_name,
|
3704
|
+
:create_time,
|
3705
|
+
:data_source,
|
3706
|
+
:description,
|
3707
|
+
:pricing_plan,
|
3708
|
+
:update_time)
|
3709
|
+
SENSITIVE = []
|
3710
|
+
include Aws::Structure
|
3711
|
+
end
|
3712
|
+
|
3713
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
3714
|
+
# data as a hash:
|
3715
|
+
#
|
3716
|
+
# {
|
3717
|
+
# resource_arn: "Arn", # required
|
3718
|
+
# }
|
3719
|
+
#
|
3720
|
+
# @!attribute [rw] resource_arn
|
3721
|
+
# The Amazon Resource Name (ARN) of the resource whose tags you want
|
3722
|
+
# to retrieve.
|
3723
|
+
# @return [String]
|
3724
|
+
#
|
3725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTagsForResourceRequest AWS API Documentation
|
3726
|
+
#
|
3727
|
+
class ListTagsForResourceRequest < Struct.new(
|
3728
|
+
:resource_arn)
|
3729
|
+
SENSITIVE = []
|
3730
|
+
include Aws::Structure
|
3731
|
+
end
|
3732
|
+
|
3733
|
+
# @!attribute [rw] tags
|
3734
|
+
# The mapping from tag key to tag value for each tag associated with
|
3735
|
+
# the specified resource.
|
3736
|
+
# @return [Hash<String,String>]
|
3737
|
+
#
|
3738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTagsForResourceResponse AWS API Documentation
|
3739
|
+
#
|
3740
|
+
class ListTagsForResourceResponse < Struct.new(
|
3741
|
+
:tags)
|
3742
|
+
SENSITIVE = []
|
3743
|
+
include Aws::Structure
|
3744
|
+
end
|
3745
|
+
|
2427
3746
|
# @note When making an API call, you may pass ListTrackerConsumersRequest
|
2428
3747
|
# data as a hash:
|
2429
3748
|
#
|
@@ -2563,8 +3882,7 @@ module Aws::LocationService
|
|
2563
3882
|
# @return [String]
|
2564
3883
|
#
|
2565
3884
|
# @!attribute [rw] pricing_plan_data_source
|
2566
|
-
# The data
|
2567
|
-
# pricing plan.
|
3885
|
+
# The specified data provider for the tracker resource.
|
2568
3886
|
# @return [String]
|
2569
3887
|
#
|
2570
3888
|
# @!attribute [rw] tracker_name
|
@@ -2605,9 +3923,10 @@ module Aws::LocationService
|
|
2605
3923
|
# @!attribute [rw] style
|
2606
3924
|
# Specifies the map style selected from an available data provider.
|
2607
3925
|
#
|
2608
|
-
# Valid styles: `
|
2609
|
-
# `
|
2610
|
-
# `
|
3926
|
+
# Valid styles: `RasterEsriImagery`, `VectorEsriStreets`,
|
3927
|
+
# `VectorEsriTopographic`, `VectorEsriNavigation`,
|
3928
|
+
# `VectorEsriDarkGrayCanvas`, `VectorEsriLightGrayCanvas`,
|
3929
|
+
# `VectorHereBerlin`.
|
2611
3930
|
#
|
2612
3931
|
# <note markdown="1"> When using HERE as your data provider, and selecting the Style
|
2613
3932
|
# `VectorHereBerlin`, you may not use HERE Maps for Asset Management.
|
@@ -2814,7 +4133,7 @@ module Aws::LocationService
|
|
2814
4133
|
end
|
2815
4134
|
|
2816
4135
|
# Specifies a single point of interest, or Place as a result of a search
|
2817
|
-
# query obtained from a dataset configured in the
|
4136
|
+
# query obtained from a dataset configured in the place index resource.
|
2818
4137
|
#
|
2819
4138
|
# @!attribute [rw] place
|
2820
4139
|
# Contains details about the relevant point of interest.
|
@@ -2853,7 +4172,7 @@ module Aws::LocationService
|
|
2853
4172
|
# }
|
2854
4173
|
#
|
2855
4174
|
# @!attribute [rw] index_name
|
2856
|
-
# The name of the
|
4175
|
+
# The name of the place index resource you want to use for the search.
|
2857
4176
|
# @return [String]
|
2858
4177
|
#
|
2859
4178
|
# @!attribute [rw] max_results
|
@@ -3005,7 +4324,7 @@ module Aws::LocationService
|
|
3005
4324
|
# @return [Array<String>]
|
3006
4325
|
#
|
3007
4326
|
# @!attribute [rw] index_name
|
3008
|
-
# The name of the
|
4327
|
+
# The name of the place index resource you want to use for the search.
|
3009
4328
|
# @return [String]
|
3010
4329
|
#
|
3011
4330
|
# @!attribute [rw] max_results
|
@@ -3116,6 +4435,86 @@ module Aws::LocationService
|
|
3116
4435
|
include Aws::Structure
|
3117
4436
|
end
|
3118
4437
|
|
4438
|
+
# Represents an element of a leg within a route. A step contains
|
4439
|
+
# instructions for how to move to the next step in the leg.
|
4440
|
+
#
|
4441
|
+
# @!attribute [rw] distance
|
4442
|
+
# The travel distance between the step's `StartPosition` and
|
4443
|
+
# `EndPosition`.
|
4444
|
+
# @return [Float]
|
4445
|
+
#
|
4446
|
+
# @!attribute [rw] duration_seconds
|
4447
|
+
# The estimated travel time, in seconds, from the step's
|
4448
|
+
# `StartPosition` to the `EndPosition`. . The travel mode and
|
4449
|
+
# departure time that you specify in the request determines the
|
4450
|
+
# calculated time.
|
4451
|
+
# @return [Float]
|
4452
|
+
#
|
4453
|
+
# @!attribute [rw] end_position
|
4454
|
+
# The end position of a step. If the position the last step in the
|
4455
|
+
# leg, this position is the same as the end position of the leg.
|
4456
|
+
# @return [Array<Float>]
|
4457
|
+
#
|
4458
|
+
# @!attribute [rw] geometry_offset
|
4459
|
+
# Represents the start position, or index, in a sequence of steps
|
4460
|
+
# within the leg's line string geometry. For example, the index of
|
4461
|
+
# the first step in a leg geometry is `0`.
|
4462
|
+
#
|
4463
|
+
# Included in the response for queries that set `IncludeLegGeometry`
|
4464
|
+
# to `True`.
|
4465
|
+
# @return [Integer]
|
4466
|
+
#
|
4467
|
+
# @!attribute [rw] start_position
|
4468
|
+
# The starting position of a step. If the position is the first step
|
4469
|
+
# in the leg, this position is the same as the start position of the
|
4470
|
+
# leg.
|
4471
|
+
# @return [Array<Float>]
|
4472
|
+
#
|
4473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Step AWS API Documentation
|
4474
|
+
#
|
4475
|
+
class Step < Struct.new(
|
4476
|
+
:distance,
|
4477
|
+
:duration_seconds,
|
4478
|
+
:end_position,
|
4479
|
+
:geometry_offset,
|
4480
|
+
:start_position)
|
4481
|
+
SENSITIVE = [:end_position, :start_position]
|
4482
|
+
include Aws::Structure
|
4483
|
+
end
|
4484
|
+
|
4485
|
+
# @note When making an API call, you may pass TagResourceRequest
|
4486
|
+
# data as a hash:
|
4487
|
+
#
|
4488
|
+
# {
|
4489
|
+
# resource_arn: "Arn", # required
|
4490
|
+
# tags: { # required
|
4491
|
+
# "TagKey" => "TagValue",
|
4492
|
+
# },
|
4493
|
+
# }
|
4494
|
+
#
|
4495
|
+
# @!attribute [rw] resource_arn
|
4496
|
+
# The Amazon Resource Name (ARN) of the resource whose tags you want
|
4497
|
+
# to update.
|
4498
|
+
# @return [String]
|
4499
|
+
#
|
4500
|
+
# @!attribute [rw] tags
|
4501
|
+
# The mapping from tag key to tag value for each tag associated with
|
4502
|
+
# the specified resource.
|
4503
|
+
# @return [Hash<String,String>]
|
4504
|
+
#
|
4505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResourceRequest AWS API Documentation
|
4506
|
+
#
|
4507
|
+
class TagResourceRequest < Struct.new(
|
4508
|
+
:resource_arn,
|
4509
|
+
:tags)
|
4510
|
+
SENSITIVE = []
|
4511
|
+
include Aws::Structure
|
4512
|
+
end
|
4513
|
+
|
4514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResourceResponse AWS API Documentation
|
4515
|
+
#
|
4516
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
4517
|
+
|
3119
4518
|
# The request was denied due to request throttling.
|
3120
4519
|
#
|
3121
4520
|
# @!attribute [rw] message
|
@@ -3129,6 +4528,127 @@ module Aws::LocationService
|
|
3129
4528
|
include Aws::Structure
|
3130
4529
|
end
|
3131
4530
|
|
4531
|
+
# Contains details about the truck dimensions in the unit of measurement
|
4532
|
+
# that you specify. Used to filter out roads that can't support or
|
4533
|
+
# allow the specified dimensions for requests that specify `TravelMode`
|
4534
|
+
# as `Truck`.
|
4535
|
+
#
|
4536
|
+
# @note When making an API call, you may pass TruckDimensions
|
4537
|
+
# data as a hash:
|
4538
|
+
#
|
4539
|
+
# {
|
4540
|
+
# height: 1.0,
|
4541
|
+
# length: 1.0,
|
4542
|
+
# unit: "Meters", # accepts Meters, Feet
|
4543
|
+
# width: 1.0,
|
4544
|
+
# }
|
4545
|
+
#
|
4546
|
+
# @!attribute [rw] height
|
4547
|
+
# The height of the truck.
|
4548
|
+
#
|
4549
|
+
# * For example, `4.5`.
|
4550
|
+
#
|
4551
|
+
# ^
|
4552
|
+
# @return [Float]
|
4553
|
+
#
|
4554
|
+
# @!attribute [rw] length
|
4555
|
+
# The length of the truck.
|
4556
|
+
#
|
4557
|
+
# * For example, `15.5`.
|
4558
|
+
#
|
4559
|
+
# ^
|
4560
|
+
# @return [Float]
|
4561
|
+
#
|
4562
|
+
# @!attribute [rw] unit
|
4563
|
+
# Specifies the unit of measurement for the truck dimensions.
|
4564
|
+
#
|
4565
|
+
# Default Value: `Meters`
|
4566
|
+
# @return [String]
|
4567
|
+
#
|
4568
|
+
# @!attribute [rw] width
|
4569
|
+
# The width of the truck.
|
4570
|
+
#
|
4571
|
+
# * For example, `4.5`.
|
4572
|
+
#
|
4573
|
+
# ^
|
4574
|
+
# @return [Float]
|
4575
|
+
#
|
4576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TruckDimensions AWS API Documentation
|
4577
|
+
#
|
4578
|
+
class TruckDimensions < Struct.new(
|
4579
|
+
:height,
|
4580
|
+
:length,
|
4581
|
+
:unit,
|
4582
|
+
:width)
|
4583
|
+
SENSITIVE = []
|
4584
|
+
include Aws::Structure
|
4585
|
+
end
|
4586
|
+
|
4587
|
+
# Contains details about the truck's weight specifications. Used to
|
4588
|
+
# avoid roads that can't support or allow the total weight for requests
|
4589
|
+
# that specify `TravelMode` as `Truck`.
|
4590
|
+
#
|
4591
|
+
# @note When making an API call, you may pass TruckWeight
|
4592
|
+
# data as a hash:
|
4593
|
+
#
|
4594
|
+
# {
|
4595
|
+
# total: 1.0,
|
4596
|
+
# unit: "Kilograms", # accepts Kilograms, Pounds
|
4597
|
+
# }
|
4598
|
+
#
|
4599
|
+
# @!attribute [rw] total
|
4600
|
+
# The total weight of the truck.
|
4601
|
+
#
|
4602
|
+
# * For example, `3500`.
|
4603
|
+
#
|
4604
|
+
# ^
|
4605
|
+
# @return [Float]
|
4606
|
+
#
|
4607
|
+
# @!attribute [rw] unit
|
4608
|
+
# The unit of measurement to use for the truck weight.
|
4609
|
+
#
|
4610
|
+
# Default Value: `Kilograms`
|
4611
|
+
# @return [String]
|
4612
|
+
#
|
4613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TruckWeight AWS API Documentation
|
4614
|
+
#
|
4615
|
+
class TruckWeight < Struct.new(
|
4616
|
+
:total,
|
4617
|
+
:unit)
|
4618
|
+
SENSITIVE = []
|
4619
|
+
include Aws::Structure
|
4620
|
+
end
|
4621
|
+
|
4622
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
4623
|
+
# data as a hash:
|
4624
|
+
#
|
4625
|
+
# {
|
4626
|
+
# resource_arn: "Arn", # required
|
4627
|
+
# tag_keys: ["String"], # required
|
4628
|
+
# }
|
4629
|
+
#
|
4630
|
+
# @!attribute [rw] resource_arn
|
4631
|
+
# The Amazon Resource Name (ARN) of the resource from which you want
|
4632
|
+
# to remove tags.
|
4633
|
+
# @return [String]
|
4634
|
+
#
|
4635
|
+
# @!attribute [rw] tag_keys
|
4636
|
+
# The list of tag keys to remove from the resource.
|
4637
|
+
# @return [Array<String>]
|
4638
|
+
#
|
4639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResourceRequest AWS API Documentation
|
4640
|
+
#
|
4641
|
+
class UntagResourceRequest < Struct.new(
|
4642
|
+
:resource_arn,
|
4643
|
+
:tag_keys)
|
4644
|
+
SENSITIVE = []
|
4645
|
+
include Aws::Structure
|
4646
|
+
end
|
4647
|
+
|
4648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResourceResponse AWS API Documentation
|
4649
|
+
#
|
4650
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
4651
|
+
|
3132
4652
|
# The input failed to meet the constraints specified by the AWS service.
|
3133
4653
|
#
|
3134
4654
|
# @!attribute [rw] field_list
|