aws-sdk-locationservice 1.3.0 → 1.7.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice.rb +1 -1
- data/lib/aws-sdk-locationservice/client.rb +1317 -205
- data/lib/aws-sdk-locationservice/client_api.rb +564 -0
- data/lib/aws-sdk-locationservice/errors.rb +16 -0
- data/lib/aws-sdk-locationservice/types.rb +3689 -1608
- metadata +5 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 18cc6b23a5d9316944dc6ca8256cffa4917881fc67eb40dfd0fe59bfe07140ad
|
4
|
+
data.tar.gz: 2d071d551ea7ccc50f2a70236382ad5f06db6c1b5ac3be4ceae9ce8bbdd45a2e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8e93c50bb17d87ef767fe9cf48e89faa0d7ca0dd04c368043e07ea7c52cb8164ce46c9116ef43148eca41ab0362388d7c913813bc4a0690acb07c2aaedf72bce
|
7
|
+
data.tar.gz: e81e60b8741004381da1db4c63d428bfd95936f315a947a25ba0093bd1376365dde4215f7c0eb3f4d18e6b88810c48dbd7b36170c366ad7b626db6ccdb71c162
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.7.0 (2021-07-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.6.0 (2021-07-28)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.5.0 (2021-07-19)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Add five new API operations: UpdateGeofenceCollection, UpdateMap, UpdatePlaceIndex, UpdateRouteCalculator, UpdateTracker.
|
18
|
+
|
19
|
+
1.4.0 (2021-05-28)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Adds support for calculation of routes, resource tagging and customer provided KMS keys.
|
23
|
+
|
4
24
|
1.3.0 (2021-03-29)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.7.0
|
@@ -331,6 +331,9 @@ module Aws::LocationService
|
|
331
331
|
# resource. This allows the tracker resource to communicate location
|
332
332
|
# data to the linked geofence collection.
|
333
333
|
#
|
334
|
+
# You can associate up to five geofence collections to each tracker
|
335
|
+
# resource.
|
336
|
+
#
|
334
337
|
# <note markdown="1"> Currently not supported — Cross-account configurations, such as
|
335
338
|
# creating associations between a tracker resource in one account and a
|
336
339
|
# geofence collection in another account.
|
@@ -343,7 +346,7 @@ module Aws::LocationService
|
|
343
346
|
# resource across all AWS.
|
344
347
|
#
|
345
348
|
# * Format example:
|
346
|
-
# `arn:
|
349
|
+
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
|
347
350
|
#
|
348
351
|
# ^
|
349
352
|
#
|
@@ -369,10 +372,50 @@ module Aws::LocationService
|
|
369
372
|
req.send_request(options)
|
370
373
|
end
|
371
374
|
|
375
|
+
# Deletes the position history of one or more devices from a tracker
|
376
|
+
# resource.
|
377
|
+
#
|
378
|
+
# @option params [required, Array<String>] :device_ids
|
379
|
+
# Devices whose position history you want to delete.
|
380
|
+
#
|
381
|
+
# * For example, for two devices: `“DeviceIds” : [DeviceId1,DeviceId2]`
|
382
|
+
#
|
383
|
+
# ^
|
384
|
+
#
|
385
|
+
# @option params [required, String] :tracker_name
|
386
|
+
# The name of the tracker resource to delete the device position history
|
387
|
+
# from.
|
388
|
+
#
|
389
|
+
# @return [Types::BatchDeleteDevicePositionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
390
|
+
#
|
391
|
+
# * {Types::BatchDeleteDevicePositionHistoryResponse#errors #errors} => Array<Types::BatchDeleteDevicePositionHistoryError>
|
392
|
+
#
|
393
|
+
# @example Request syntax with placeholder values
|
394
|
+
#
|
395
|
+
# resp = client.batch_delete_device_position_history({
|
396
|
+
# device_ids: ["Id"], # required
|
397
|
+
# tracker_name: "ResourceName", # required
|
398
|
+
# })
|
399
|
+
#
|
400
|
+
# @example Response structure
|
401
|
+
#
|
402
|
+
# resp.errors #=> Array
|
403
|
+
# resp.errors[0].device_id #=> String
|
404
|
+
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
405
|
+
# resp.errors[0].error.message #=> String
|
406
|
+
#
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteDevicePositionHistory AWS API Documentation
|
408
|
+
#
|
409
|
+
# @overload batch_delete_device_position_history(params = {})
|
410
|
+
# @param [Hash] params ({})
|
411
|
+
def batch_delete_device_position_history(params = {}, options = {})
|
412
|
+
req = build_request(:batch_delete_device_position_history, params)
|
413
|
+
req.send_request(options)
|
414
|
+
end
|
415
|
+
|
372
416
|
# Deletes a batch of geofences from a geofence collection.
|
373
417
|
#
|
374
|
-
# <note markdown="1"> This
|
375
|
-
# action.
|
418
|
+
# <note markdown="1"> This operation deletes the resource permanently.
|
376
419
|
#
|
377
420
|
# </note>
|
378
421
|
#
|
@@ -410,12 +453,21 @@ module Aws::LocationService
|
|
410
453
|
end
|
411
454
|
|
412
455
|
# Evaluates device positions against the geofence geometries from a
|
413
|
-
# given geofence collection.
|
414
|
-
#
|
415
|
-
#
|
456
|
+
# given geofence collection.
|
457
|
+
#
|
458
|
+
# This operation always returns an empty response because geofences are
|
459
|
+
# asynchronously evaluated. The evaluation determines if the device has
|
460
|
+
# entered or exited a geofenced area, and then publishes one of the
|
461
|
+
# following events to Amazon EventBridge:
|
416
462
|
#
|
417
|
-
#
|
418
|
-
#
|
463
|
+
# * `ENTER` if Amazon Location determines that the tracked device has
|
464
|
+
# entered a geofenced area.
|
465
|
+
#
|
466
|
+
# * `EXIT` if Amazon Location determines that the tracked device has
|
467
|
+
# exited a geofenced area.
|
468
|
+
#
|
469
|
+
# <note markdown="1"> The last geofence that a device was observed within is tracked for 30
|
470
|
+
# days after the most recent device position update.
|
419
471
|
#
|
420
472
|
# </note>
|
421
473
|
#
|
@@ -461,7 +513,7 @@ module Aws::LocationService
|
|
461
513
|
req.send_request(options)
|
462
514
|
end
|
463
515
|
|
464
|
-
#
|
516
|
+
# Lists the latest device positions for requested devices.
|
465
517
|
#
|
466
518
|
# @option params [required, Array<String>] :device_ids
|
467
519
|
# Devices whose position you want to retrieve.
|
@@ -509,7 +561,8 @@ module Aws::LocationService
|
|
509
561
|
end
|
510
562
|
|
511
563
|
# A batch request for storing geofence geometries into a given geofence
|
512
|
-
# collection
|
564
|
+
# collection, or updates the geometry of an existing geofence if a
|
565
|
+
# geofence ID is included in the request.
|
513
566
|
#
|
514
567
|
# @option params [required, String] :collection_name
|
515
568
|
# The geofence collection storing the geofences.
|
@@ -565,8 +618,8 @@ module Aws::LocationService
|
|
565
618
|
# device position and position history.
|
566
619
|
#
|
567
620
|
# <note markdown="1"> Only one position update is stored per sample time. Location data is
|
568
|
-
# sampled at a fixed rate of one position per 30-second interval
|
569
|
-
# retained for
|
621
|
+
# sampled at a fixed rate of one position per 30-second interval and
|
622
|
+
# retained for 30 days before it's deleted.
|
570
623
|
#
|
571
624
|
# </note>
|
572
625
|
#
|
@@ -610,6 +663,249 @@ module Aws::LocationService
|
|
610
663
|
req.send_request(options)
|
611
664
|
end
|
612
665
|
|
666
|
+
# [Calculates a route][1] given the following required parameters:
|
667
|
+
# `DeparturePostiton` and `DestinationPosition`. Requires that you first
|
668
|
+
# [create a route calculator resource][2]
|
669
|
+
#
|
670
|
+
# By default, a request that doesn't specify a departure time uses the
|
671
|
+
# best time of day to travel with the best traffic conditions when
|
672
|
+
# calculating the route.
|
673
|
+
#
|
674
|
+
# Additional options include:
|
675
|
+
#
|
676
|
+
# * [Specifying a departure time][3] using either `DepartureTime` or
|
677
|
+
# `DepartureNow`. This calculates a route based on predictive traffic
|
678
|
+
# data at the given time.
|
679
|
+
#
|
680
|
+
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartureNow` in a
|
681
|
+
# single request. Specifying both parameters returns an error message.
|
682
|
+
#
|
683
|
+
# </note>
|
684
|
+
#
|
685
|
+
# * [Specifying a travel mode][4] using TravelMode. This lets you
|
686
|
+
# specify an additional route preference such as `CarModeOptions` if
|
687
|
+
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
688
|
+
#
|
689
|
+
#
|
690
|
+
#
|
691
|
+
#
|
692
|
+
#
|
693
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html
|
694
|
+
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
|
695
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#departure-time
|
696
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#travel-mode
|
697
|
+
#
|
698
|
+
# @option params [required, String] :calculator_name
|
699
|
+
# The name of the route calculator resource that you want to use to
|
700
|
+
# calculate a route.
|
701
|
+
#
|
702
|
+
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
703
|
+
# Specifies route preferences when traveling by `Car`, such as avoiding
|
704
|
+
# routes that use ferries or tolls.
|
705
|
+
#
|
706
|
+
# Requirements: `TravelMode` must be specified as `Car`.
|
707
|
+
#
|
708
|
+
# @option params [Boolean] :depart_now
|
709
|
+
# Sets the time of departure as the current time. Uses the current time
|
710
|
+
# to calculate a route. Otherwise, the best time of day to travel with
|
711
|
+
# the best traffic conditions is used to calculate the route.
|
712
|
+
#
|
713
|
+
# Default Value: `false`
|
714
|
+
#
|
715
|
+
# Valid Values: `false` \| `true`
|
716
|
+
#
|
717
|
+
# @option params [required, Array<Float>] :departure_position
|
718
|
+
# The start position for the route. Defined in [WGS 84][1] format:
|
719
|
+
# `[longitude, latitude]`.
|
720
|
+
#
|
721
|
+
# * For example, `[-123.115, 49.285]`
|
722
|
+
#
|
723
|
+
# ^
|
724
|
+
#
|
725
|
+
# <note markdown="1"> If you specify a departure that's not located on a road, Amazon
|
726
|
+
# Location [moves the position to the nearest road][2].
|
727
|
+
#
|
728
|
+
# </note>
|
729
|
+
#
|
730
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
731
|
+
#
|
732
|
+
#
|
733
|
+
#
|
734
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
735
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
736
|
+
#
|
737
|
+
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
738
|
+
# Specifies the desired time of departure. Uses the given time to
|
739
|
+
# calculate a route. Otherwise, the best time of day to travel with the
|
740
|
+
# best traffic conditions is used to calculate the route.
|
741
|
+
#
|
742
|
+
# <note markdown="1"> Setting a departure time in the past returns a `400
|
743
|
+
# ValidationException` error.
|
744
|
+
#
|
745
|
+
# </note>
|
746
|
+
#
|
747
|
+
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
748
|
+
# `2020–07-2T12:15:20.000Z+01:00`
|
749
|
+
#
|
750
|
+
# ^
|
751
|
+
#
|
752
|
+
#
|
753
|
+
#
|
754
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
755
|
+
#
|
756
|
+
# @option params [required, Array<Float>] :destination_position
|
757
|
+
# The finish position for the route. Defined in [WGS 84][1] format:
|
758
|
+
# `[longitude, latitude]`.
|
759
|
+
#
|
760
|
+
# * For example, `[-122.339, 47.615]`
|
761
|
+
#
|
762
|
+
# ^
|
763
|
+
#
|
764
|
+
# <note markdown="1"> If you specify a destination that's not located on a road, Amazon
|
765
|
+
# Location [moves the position to the nearest road][2].
|
766
|
+
#
|
767
|
+
# </note>
|
768
|
+
#
|
769
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
770
|
+
#
|
771
|
+
#
|
772
|
+
#
|
773
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
774
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
775
|
+
#
|
776
|
+
# @option params [String] :distance_unit
|
777
|
+
# Set the unit system to specify the distance.
|
778
|
+
#
|
779
|
+
# Default Value: `Kilometers`
|
780
|
+
#
|
781
|
+
# @option params [Boolean] :include_leg_geometry
|
782
|
+
# Set to include the geometry details in the result for each path
|
783
|
+
# between a pair of positions.
|
784
|
+
#
|
785
|
+
# Default Value: `false`
|
786
|
+
#
|
787
|
+
# Valid Values: `false` \| `true`
|
788
|
+
#
|
789
|
+
# @option params [String] :travel_mode
|
790
|
+
# Specifies the mode of transport when calculating a route. Used in
|
791
|
+
# estimating the speed of travel and road compatibility.
|
792
|
+
#
|
793
|
+
# The `TravelMode` you specify determines how you specify route
|
794
|
+
# preferences:
|
795
|
+
#
|
796
|
+
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
797
|
+
#
|
798
|
+
# * If traveling by `Truck` use the `TruckModeOptions` parameter.
|
799
|
+
#
|
800
|
+
# Default Value: `Car`
|
801
|
+
#
|
802
|
+
# @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
|
803
|
+
# Specifies route preferences when traveling by `Truck`, such as
|
804
|
+
# avoiding routes that use ferries or tolls, and truck specifications to
|
805
|
+
# consider when choosing an optimal road.
|
806
|
+
#
|
807
|
+
# Requirements: `TravelMode` must be specified as `Truck`.
|
808
|
+
#
|
809
|
+
# @option params [Array<Array>] :waypoint_positions
|
810
|
+
# Specifies an ordered list of up to 23 intermediate positions to
|
811
|
+
# include along a route between the departure position and destination
|
812
|
+
# position.
|
813
|
+
#
|
814
|
+
# * For example, from the `DeparturePosition` `[-123.115, 49.285]`, the
|
815
|
+
# route follows the order that the waypoint positions are given
|
816
|
+
# `[[-122.757, 49.0021],[-122.349, 47.620]]`
|
817
|
+
#
|
818
|
+
# ^
|
819
|
+
#
|
820
|
+
# <note markdown="1"> If you specify a waypoint position that's not located on a road,
|
821
|
+
# Amazon Location [moves the position to the nearest road][1].
|
822
|
+
#
|
823
|
+
# Specifying more than 23 waypoints returns a `400 ValidationException`
|
824
|
+
# error.
|
825
|
+
#
|
826
|
+
# </note>
|
827
|
+
#
|
828
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
829
|
+
#
|
830
|
+
#
|
831
|
+
#
|
832
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
|
833
|
+
#
|
834
|
+
# @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
835
|
+
#
|
836
|
+
# * {Types::CalculateRouteResponse#legs #legs} => Array<Types::Leg>
|
837
|
+
# * {Types::CalculateRouteResponse#summary #summary} => Types::CalculateRouteSummary
|
838
|
+
#
|
839
|
+
# @example Request syntax with placeholder values
|
840
|
+
#
|
841
|
+
# resp = client.calculate_route({
|
842
|
+
# calculator_name: "ResourceName", # required
|
843
|
+
# car_mode_options: {
|
844
|
+
# avoid_ferries: false,
|
845
|
+
# avoid_tolls: false,
|
846
|
+
# },
|
847
|
+
# depart_now: false,
|
848
|
+
# departure_position: [1.0], # required
|
849
|
+
# departure_time: Time.now,
|
850
|
+
# destination_position: [1.0], # required
|
851
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
852
|
+
# include_leg_geometry: false,
|
853
|
+
# travel_mode: "Car", # accepts Car, Truck, Walking
|
854
|
+
# truck_mode_options: {
|
855
|
+
# avoid_ferries: false,
|
856
|
+
# avoid_tolls: false,
|
857
|
+
# dimensions: {
|
858
|
+
# height: 1.0,
|
859
|
+
# length: 1.0,
|
860
|
+
# unit: "Meters", # accepts Meters, Feet
|
861
|
+
# width: 1.0,
|
862
|
+
# },
|
863
|
+
# weight: {
|
864
|
+
# total: 1.0,
|
865
|
+
# unit: "Kilograms", # accepts Kilograms, Pounds
|
866
|
+
# },
|
867
|
+
# },
|
868
|
+
# waypoint_positions: [
|
869
|
+
# [1.0],
|
870
|
+
# ],
|
871
|
+
# })
|
872
|
+
#
|
873
|
+
# @example Response structure
|
874
|
+
#
|
875
|
+
# resp.legs #=> Array
|
876
|
+
# resp.legs[0].distance #=> Float
|
877
|
+
# resp.legs[0].duration_seconds #=> Float
|
878
|
+
# resp.legs[0].end_position #=> Array
|
879
|
+
# resp.legs[0].end_position[0] #=> Float
|
880
|
+
# resp.legs[0].geometry.line_string #=> Array
|
881
|
+
# resp.legs[0].geometry.line_string[0] #=> Array
|
882
|
+
# resp.legs[0].geometry.line_string[0][0] #=> Float
|
883
|
+
# resp.legs[0].start_position #=> Array
|
884
|
+
# resp.legs[0].start_position[0] #=> Float
|
885
|
+
# resp.legs[0].steps #=> Array
|
886
|
+
# resp.legs[0].steps[0].distance #=> Float
|
887
|
+
# resp.legs[0].steps[0].duration_seconds #=> Float
|
888
|
+
# resp.legs[0].steps[0].end_position #=> Array
|
889
|
+
# resp.legs[0].steps[0].end_position[0] #=> Float
|
890
|
+
# resp.legs[0].steps[0].geometry_offset #=> Integer
|
891
|
+
# resp.legs[0].steps[0].start_position #=> Array
|
892
|
+
# resp.legs[0].steps[0].start_position[0] #=> Float
|
893
|
+
# resp.summary.data_source #=> String
|
894
|
+
# resp.summary.distance #=> Float
|
895
|
+
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
896
|
+
# resp.summary.duration_seconds #=> Float
|
897
|
+
# resp.summary.route_b_box #=> Array
|
898
|
+
# resp.summary.route_b_box[0] #=> Float
|
899
|
+
#
|
900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRoute AWS API Documentation
|
901
|
+
#
|
902
|
+
# @overload calculate_route(params = {})
|
903
|
+
# @param [Hash] params ({})
|
904
|
+
def calculate_route(params = {}, options = {})
|
905
|
+
req = build_request(:calculate_route, params)
|
906
|
+
req.send_request(options)
|
907
|
+
end
|
908
|
+
|
613
909
|
# Creates a geofence collection, which manages and stores geofences.
|
614
910
|
#
|
615
911
|
# @option params [required, String] :collection_name
|
@@ -617,7 +913,7 @@ module Aws::LocationService
|
|
617
913
|
#
|
618
914
|
# Requirements:
|
619
915
|
#
|
620
|
-
# * Contain only alphanumeric characters (A–Z, a–z, 0
|
916
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
621
917
|
# periods (.), and underscores (\_).
|
622
918
|
#
|
623
919
|
# * Must be a unique geofence collection name.
|
@@ -627,8 +923,16 @@ module Aws::LocationService
|
|
627
923
|
# @option params [String] :description
|
628
924
|
# An optional description for the geofence collection.
|
629
925
|
#
|
926
|
+
# @option params [String] :kms_key_id
|
927
|
+
# A key identifier for an [AWS KMS customer managed key][1]. Enter a key
|
928
|
+
# ID, key ARN, alias name, or alias ARN.
|
929
|
+
#
|
930
|
+
#
|
931
|
+
#
|
932
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
933
|
+
#
|
630
934
|
# @option params [required, String] :pricing_plan
|
631
|
-
# Specifies the pricing plan for
|
935
|
+
# Specifies the pricing plan for the geofence collection.
|
632
936
|
#
|
633
937
|
# For additional details and restrictions on each pricing plan option,
|
634
938
|
# see the [Amazon Location Service pricing page][1].
|
@@ -638,19 +942,49 @@ module Aws::LocationService
|
|
638
942
|
# [1]: https://aws.amazon.com/location/pricing/
|
639
943
|
#
|
640
944
|
# @option params [String] :pricing_plan_data_source
|
641
|
-
# Specifies the
|
642
|
-
# (MAT) or the Mobile Asset Management (MAM) pricing plan is selected.
|
945
|
+
# Specifies the data provider for the geofence collection.
|
643
946
|
#
|
644
|
-
#
|
645
|
-
#
|
646
|
-
#
|
647
|
-
#
|
947
|
+
# * Required value for the following pricing plans: `MobileAssetTracking
|
948
|
+
# `\| `MobileAssetManagement`
|
949
|
+
#
|
950
|
+
# ^
|
951
|
+
#
|
952
|
+
# For more information about [Data Providers][1], and [Pricing
|
953
|
+
# plans][2], see the Amazon Location Service product page.
|
954
|
+
#
|
955
|
+
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
|
956
|
+
# billing for your geofence collection. Your data won't be shared with
|
957
|
+
# the data provider, and will remain in your AWS account or Region
|
958
|
+
# unless you move it.
|
959
|
+
#
|
960
|
+
# </note>
|
648
961
|
#
|
649
962
|
# Valid Values: `Esri `\| `Here`
|
650
963
|
#
|
651
964
|
#
|
652
965
|
#
|
653
|
-
# [1]: https://aws.amazon.com/location/
|
966
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
967
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
968
|
+
#
|
969
|
+
# @option params [Hash<String,String>] :tags
|
970
|
+
# Applies one or more tags to the geofence collection. A tag is a
|
971
|
+
# key-value pair helps manage, identify, search, and filter your
|
972
|
+
# resources by labelling them.
|
973
|
+
#
|
974
|
+
# Format: `"key" : "value"`
|
975
|
+
#
|
976
|
+
# Restrictions:
|
977
|
+
#
|
978
|
+
# * Maximum 50 tags per resource
|
979
|
+
#
|
980
|
+
# * Each resource tag must be unique with a maximum of one value.
|
981
|
+
#
|
982
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
983
|
+
#
|
984
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
985
|
+
#
|
986
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
987
|
+
# characters: + - = . \_ : / @.
|
654
988
|
#
|
655
989
|
# @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
656
990
|
#
|
@@ -663,8 +997,12 @@ module Aws::LocationService
|
|
663
997
|
# resp = client.create_geofence_collection({
|
664
998
|
# collection_name: "ResourceName", # required
|
665
999
|
# description: "ResourceDescription",
|
1000
|
+
# kms_key_id: "KmsKeyId",
|
666
1001
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
667
1002
|
# pricing_plan_data_source: "String",
|
1003
|
+
# tags: {
|
1004
|
+
# "TagKey" => "TagValue",
|
1005
|
+
# },
|
668
1006
|
# })
|
669
1007
|
#
|
670
1008
|
# @example Response structure
|
@@ -685,17 +1023,6 @@ module Aws::LocationService
|
|
685
1023
|
# Creates a map resource in your AWS account, which provides map tiles
|
686
1024
|
# of different styles sourced from global location data providers.
|
687
1025
|
#
|
688
|
-
# <note markdown="1"> By using Maps, you agree that AWS may transmit your API queries to
|
689
|
-
# your selected third party provider for processing, which may be
|
690
|
-
# outside the AWS region you are currently using. For more information,
|
691
|
-
# see the [AWS Service Terms][1] for Amazon Location Service.
|
692
|
-
#
|
693
|
-
# </note>
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
697
|
-
# [1]: https://aws.amazon.com/service-terms/
|
698
|
-
#
|
699
1026
|
# @option params [required, Types::MapConfiguration] :configuration
|
700
1027
|
# Specifies the map style selected from an available data provider.
|
701
1028
|
#
|
@@ -724,6 +1051,26 @@ module Aws::LocationService
|
|
724
1051
|
#
|
725
1052
|
# [1]: https://aws.amazon.com/location/pricing/
|
726
1053
|
#
|
1054
|
+
# @option params [Hash<String,String>] :tags
|
1055
|
+
# Applies one or more tags to the map resource. A tag is a key-value
|
1056
|
+
# pair helps manage, identify, search, and filter your resources by
|
1057
|
+
# labelling them.
|
1058
|
+
#
|
1059
|
+
# Format: `"key" : "value"`
|
1060
|
+
#
|
1061
|
+
# Restrictions:
|
1062
|
+
#
|
1063
|
+
# * Maximum 50 tags per resource
|
1064
|
+
#
|
1065
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1066
|
+
#
|
1067
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1068
|
+
#
|
1069
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1070
|
+
#
|
1071
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1072
|
+
# characters: + - = . \_ : / @.
|
1073
|
+
#
|
727
1074
|
# @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
728
1075
|
#
|
729
1076
|
# * {Types::CreateMapResponse#create_time #create_time} => Time
|
@@ -739,6 +1086,9 @@ module Aws::LocationService
|
|
739
1086
|
# description: "ResourceDescription",
|
740
1087
|
# map_name: "ResourceName", # required
|
741
1088
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1089
|
+
# tags: {
|
1090
|
+
# "TagKey" => "TagValue",
|
1091
|
+
# },
|
742
1092
|
# })
|
743
1093
|
#
|
744
1094
|
# @example Response structure
|
@@ -756,65 +1106,65 @@ module Aws::LocationService
|
|
756
1106
|
req.send_request(options)
|
757
1107
|
end
|
758
1108
|
|
759
|
-
# Creates a
|
760
|
-
#
|
761
|
-
# provider.
|
762
|
-
#
|
763
|
-
# <note markdown="1"> By using Places, you agree that AWS may transmit your API queries to
|
764
|
-
# your selected third party provider for processing, which may be
|
765
|
-
# outside the AWS region you are currently using.
|
766
|
-
#
|
767
|
-
# Because of licensing limitations, you may not use HERE to store
|
768
|
-
# results for locations in Japan. For more information, see the [AWS
|
769
|
-
# Service Terms][1] for Amazon Location Service.
|
770
|
-
#
|
771
|
-
# </note>
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
# [1]: https://aws.amazon.com/service-terms/
|
1109
|
+
# Creates a place index resource in your AWS account, which supports
|
1110
|
+
# functions with geospatial data sourced from your chosen data provider.
|
776
1111
|
#
|
777
1112
|
# @option params [required, String] :data_source
|
778
1113
|
# Specifies the data provider of geospatial data.
|
779
1114
|
#
|
780
1115
|
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
781
|
-
# example, entering `HERE`
|
1116
|
+
# example, entering `HERE` returns an error.
|
782
1117
|
#
|
783
1118
|
# </note>
|
784
1119
|
#
|
785
1120
|
# Valid values include:
|
786
1121
|
#
|
787
|
-
# * `Esri`
|
1122
|
+
# * `Esri` – For additional information about [Esri][1]'s coverage in
|
1123
|
+
# your region of interest, see [Esri details on geocoding
|
1124
|
+
# coverage][2].
|
788
1125
|
#
|
789
|
-
# * `Here`
|
1126
|
+
# * `Here` – For additional information about [HERE Technologies][3]'s
|
1127
|
+
# coverage in your region of interest, see [HERE details on goecoding
|
1128
|
+
# coverage][4].
|
790
1129
|
#
|
791
|
-
#
|
792
|
-
#
|
1130
|
+
# Place index resources using HERE Technologies as a data provider
|
1131
|
+
# can't [store results][5] for locations in Japan. For more
|
1132
|
+
# information, see the [AWS Service Terms][6] for Amazon Location
|
1133
|
+
# Service.
|
793
1134
|
#
|
1135
|
+
# For additional information , see [Data providers][7] on the *Amazon
|
1136
|
+
# Location Service Developer Guide*.
|
794
1137
|
#
|
795
1138
|
#
|
796
|
-
#
|
1139
|
+
#
|
1140
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
1141
|
+
# [2]: https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm
|
1142
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
1143
|
+
# [4]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html
|
1144
|
+
# [5]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html
|
1145
|
+
# [6]: https://aws.amazon.com/service-terms/
|
1146
|
+
# [7]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
797
1147
|
#
|
798
1148
|
# @option params [Types::DataSourceConfiguration] :data_source_configuration
|
799
|
-
# Specifies the data storage option
|
1149
|
+
# Specifies the data storage option requesting Places.
|
800
1150
|
#
|
801
1151
|
# @option params [String] :description
|
802
|
-
# The optional description for the
|
1152
|
+
# The optional description for the place index resource.
|
803
1153
|
#
|
804
1154
|
# @option params [required, String] :index_name
|
805
|
-
# The name of the
|
1155
|
+
# The name of the place index resource.
|
806
1156
|
#
|
807
1157
|
# Requirements:
|
808
1158
|
#
|
809
|
-
# * Contain only alphanumeric characters (A
|
1159
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
810
1160
|
# periods (.), and underscores (\_).
|
811
1161
|
#
|
812
|
-
# * Must be a unique
|
1162
|
+
# * Must be a unique place index resource name.
|
813
1163
|
#
|
814
1164
|
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
815
1165
|
#
|
816
1166
|
# @option params [required, String] :pricing_plan
|
817
|
-
# Specifies the pricing plan for your
|
1167
|
+
# Specifies the pricing plan for your place index resource.
|
818
1168
|
#
|
819
1169
|
# For additional details and restrictions on each pricing plan option,
|
820
1170
|
# see the [Amazon Location Service pricing page][1].
|
@@ -823,6 +1173,26 @@ module Aws::LocationService
|
|
823
1173
|
#
|
824
1174
|
# [1]: https://aws.amazon.com/location/pricing/
|
825
1175
|
#
|
1176
|
+
# @option params [Hash<String,String>] :tags
|
1177
|
+
# Applies one or more tags to the place index resource. A tag is a
|
1178
|
+
# key-value pair helps manage, identify, search, and filter your
|
1179
|
+
# resources by labelling them.
|
1180
|
+
#
|
1181
|
+
# Format: `"key" : "value"`
|
1182
|
+
#
|
1183
|
+
# Restrictions:
|
1184
|
+
#
|
1185
|
+
# * Maximum 50 tags per resource
|
1186
|
+
#
|
1187
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1188
|
+
#
|
1189
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1190
|
+
#
|
1191
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1192
|
+
#
|
1193
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1194
|
+
# characters: + - = . \_ : / @.
|
1195
|
+
#
|
826
1196
|
# @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
827
1197
|
#
|
828
1198
|
# * {Types::CreatePlaceIndexResponse#create_time #create_time} => Time
|
@@ -839,6 +1209,9 @@ module Aws::LocationService
|
|
839
1209
|
# description: "ResourceDescription",
|
840
1210
|
# index_name: "ResourceName", # required
|
841
1211
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1212
|
+
# tags: {
|
1213
|
+
# "TagKey" => "TagValue",
|
1214
|
+
# },
|
842
1215
|
# })
|
843
1216
|
#
|
844
1217
|
# @example Response structure
|
@@ -856,101 +1229,261 @@ module Aws::LocationService
|
|
856
1229
|
req.send_request(options)
|
857
1230
|
end
|
858
1231
|
|
859
|
-
# Creates a
|
860
|
-
#
|
1232
|
+
# Creates a route calculator resource in your AWS account.
|
1233
|
+
#
|
1234
|
+
# You can send requests to a route calculator resource to estimate
|
1235
|
+
# travel time, distance, and get directions. A route calculator sources
|
1236
|
+
# traffic and road network data from your chosen data provider.
|
1237
|
+
#
|
1238
|
+
# @option params [required, String] :calculator_name
|
1239
|
+
# The name of the route calculator resource.
|
1240
|
+
#
|
1241
|
+
# Requirements:
|
1242
|
+
#
|
1243
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-),
|
1244
|
+
# periods (.), and underscores (\_).
|
1245
|
+
#
|
1246
|
+
# * Must be a unique Route calculator resource name.
|
1247
|
+
#
|
1248
|
+
# * No spaces allowed. For example, `ExampleRouteCalculator`.
|
1249
|
+
#
|
1250
|
+
# @option params [required, String] :data_source
|
1251
|
+
# Specifies the data provider of traffic and road network data.
|
1252
|
+
#
|
1253
|
+
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1254
|
+
# example, entering `HERE` returns an error.
|
1255
|
+
#
|
1256
|
+
# </note>
|
1257
|
+
#
|
1258
|
+
# Valid values include:
|
1259
|
+
#
|
1260
|
+
# * `Esri` – For additional information about [Esri][1]'s coverage in
|
1261
|
+
# your region of interest, see [Esri details on street networks and
|
1262
|
+
# traffic coverage][2].
|
1263
|
+
#
|
1264
|
+
# * `Here` – For additional information about [HERE Technologies][3]'s
|
1265
|
+
# coverage in your region of interest, see [HERE car routing
|
1266
|
+
# coverage][4] and [HERE truck routing coverage][5].
|
1267
|
+
#
|
1268
|
+
# For additional information , see [Data providers][6] on the *Amazon
|
1269
|
+
# Location Service Developer Guide*.
|
1270
|
+
#
|
1271
|
+
#
|
1272
|
+
#
|
1273
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
1274
|
+
# [2]: https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm
|
1275
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
1276
|
+
# [4]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html
|
1277
|
+
# [5]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html
|
1278
|
+
# [6]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
861
1279
|
#
|
862
1280
|
# @option params [String] :description
|
863
|
-
#
|
1281
|
+
# The optional description for the route calculator resource.
|
864
1282
|
#
|
865
1283
|
# @option params [required, String] :pricing_plan
|
866
|
-
# Specifies the pricing plan for your
|
1284
|
+
# Specifies the pricing plan for your route calculator resource.
|
867
1285
|
#
|
868
1286
|
# For additional details and restrictions on each pricing plan option,
|
869
|
-
# see
|
1287
|
+
# see [Amazon Location Service pricing][1].
|
870
1288
|
#
|
871
1289
|
#
|
872
1290
|
#
|
873
1291
|
# [1]: https://aws.amazon.com/location/pricing/
|
874
1292
|
#
|
875
|
-
# @option params [String] :
|
876
|
-
#
|
877
|
-
#
|
878
|
-
#
|
879
|
-
# Billing is determined by the resource usage, the associated pricing
|
880
|
-
# plan, and data source that was specified. For more information about
|
881
|
-
# each pricing plan option and restrictions, see the [Amazon Location
|
882
|
-
# Service pricing page][1].
|
1293
|
+
# @option params [Hash<String,String>] :tags
|
1294
|
+
# Applies one or more tags to the route calculator resource. A tag is a
|
1295
|
+
# key-value pair helps manage, identify, search, and filter your
|
1296
|
+
# resources by labelling them.
|
883
1297
|
#
|
884
|
-
#
|
1298
|
+
# * For example: \\\{ `"tag1" : "value1"`, `"tag2" : "value2"`\\}
|
885
1299
|
#
|
1300
|
+
# ^
|
886
1301
|
#
|
1302
|
+
# Format: `"key" : "value"`
|
887
1303
|
#
|
888
|
-
#
|
1304
|
+
# Restrictions:
|
889
1305
|
#
|
890
|
-
#
|
891
|
-
# The name for the tracker resource.
|
1306
|
+
# * Maximum 50 tags per resource
|
892
1307
|
#
|
893
|
-
#
|
1308
|
+
# * Each resource tag must be unique with a maximum of one value.
|
894
1309
|
#
|
895
|
-
# *
|
896
|
-
# periods (.), and underscores (\_).
|
1310
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
897
1311
|
#
|
898
|
-
# *
|
1312
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
899
1313
|
#
|
900
|
-
# *
|
1314
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1315
|
+
# characters: + - = . \_ : / @.
|
901
1316
|
#
|
902
|
-
# @return [Types::
|
1317
|
+
# @return [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
903
1318
|
#
|
904
|
-
# * {Types::
|
905
|
-
# * {Types::
|
906
|
-
# * {Types::
|
1319
|
+
# * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
1320
|
+
# * {Types::CreateRouteCalculatorResponse#calculator_name #calculator_name} => String
|
1321
|
+
# * {Types::CreateRouteCalculatorResponse#create_time #create_time} => Time
|
907
1322
|
#
|
908
1323
|
# @example Request syntax with placeholder values
|
909
1324
|
#
|
910
|
-
# resp = client.
|
1325
|
+
# resp = client.create_route_calculator({
|
1326
|
+
# calculator_name: "ResourceName", # required
|
1327
|
+
# data_source: "String", # required
|
911
1328
|
# description: "ResourceDescription",
|
912
1329
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
913
|
-
#
|
914
|
-
#
|
1330
|
+
# tags: {
|
1331
|
+
# "TagKey" => "TagValue",
|
1332
|
+
# },
|
915
1333
|
# })
|
916
1334
|
#
|
917
1335
|
# @example Response structure
|
918
1336
|
#
|
1337
|
+
# resp.calculator_arn #=> String
|
1338
|
+
# resp.calculator_name #=> String
|
919
1339
|
# resp.create_time #=> Time
|
920
|
-
# resp.tracker_arn #=> String
|
921
|
-
# resp.tracker_name #=> String
|
922
1340
|
#
|
923
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/
|
1341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculator AWS API Documentation
|
924
1342
|
#
|
925
|
-
# @overload
|
1343
|
+
# @overload create_route_calculator(params = {})
|
926
1344
|
# @param [Hash] params ({})
|
927
|
-
def
|
928
|
-
req = build_request(:
|
1345
|
+
def create_route_calculator(params = {}, options = {})
|
1346
|
+
req = build_request(:create_route_calculator, params)
|
929
1347
|
req.send_request(options)
|
930
1348
|
end
|
931
1349
|
|
932
|
-
#
|
1350
|
+
# Creates a tracker resource in your AWS account, which lets you
|
1351
|
+
# retrieve current and historical location of devices.
|
933
1352
|
#
|
934
|
-
#
|
935
|
-
#
|
936
|
-
# resource, the devices will no longer be monitored.
|
1353
|
+
# @option params [String] :description
|
1354
|
+
# An optional description for the tracker resource.
|
937
1355
|
#
|
938
|
-
#
|
1356
|
+
# @option params [String] :kms_key_id
|
1357
|
+
# A key identifier for an [AWS KMS customer managed key][1]. Enter a key
|
1358
|
+
# ID, key ARN, alias name, or alias ARN.
|
939
1359
|
#
|
940
|
-
# @option params [required, String] :collection_name
|
941
|
-
# The name of the geofence collection to be deleted.
|
942
1360
|
#
|
943
|
-
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
944
1361
|
#
|
945
|
-
#
|
1362
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
946
1363
|
#
|
947
|
-
#
|
948
|
-
#
|
949
|
-
# })
|
1364
|
+
# @option params [required, String] :pricing_plan
|
1365
|
+
# Specifies the pricing plan for the tracker resource.
|
950
1366
|
#
|
951
|
-
#
|
1367
|
+
# For additional details and restrictions on each pricing plan option,
|
1368
|
+
# see the [Amazon Location Service pricing page][1].
|
952
1369
|
#
|
953
|
-
#
|
1370
|
+
#
|
1371
|
+
#
|
1372
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
1373
|
+
#
|
1374
|
+
# @option params [String] :pricing_plan_data_source
|
1375
|
+
# Specifies the data provider for the tracker resource.
|
1376
|
+
#
|
1377
|
+
# * Required value for the following pricing plans: `MobileAssetTracking
|
1378
|
+
# `\| `MobileAssetManagement`
|
1379
|
+
#
|
1380
|
+
# ^
|
1381
|
+
#
|
1382
|
+
# For more information about [Data Providers][1], and [Pricing
|
1383
|
+
# plans][2], see the Amazon Location Service product page.
|
1384
|
+
#
|
1385
|
+
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
|
1386
|
+
# billing for your tracker resource. Your data will not be shared with
|
1387
|
+
# the data provider, and will remain in your AWS account or Region
|
1388
|
+
# unless you move it.
|
1389
|
+
#
|
1390
|
+
# </note>
|
1391
|
+
#
|
1392
|
+
# Valid Values: `Esri` \| `Here`
|
1393
|
+
#
|
1394
|
+
#
|
1395
|
+
#
|
1396
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
1397
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
1398
|
+
#
|
1399
|
+
# @option params [Hash<String,String>] :tags
|
1400
|
+
# Applies one or more tags to the tracker resource. A tag is a key-value
|
1401
|
+
# pair helps manage, identify, search, and filter your resources by
|
1402
|
+
# labelling them.
|
1403
|
+
#
|
1404
|
+
# Format: `"key" : "value"`
|
1405
|
+
#
|
1406
|
+
# Restrictions:
|
1407
|
+
#
|
1408
|
+
# * Maximum 50 tags per resource
|
1409
|
+
#
|
1410
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1411
|
+
#
|
1412
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1413
|
+
#
|
1414
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1415
|
+
#
|
1416
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1417
|
+
# characters: + - = . \_ : / @.
|
1418
|
+
#
|
1419
|
+
# @option params [required, String] :tracker_name
|
1420
|
+
# The name for the tracker resource.
|
1421
|
+
#
|
1422
|
+
# Requirements:
|
1423
|
+
#
|
1424
|
+
# * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-),
|
1425
|
+
# periods (.), and underscores (\_).
|
1426
|
+
#
|
1427
|
+
# * Must be a unique tracker resource name.
|
1428
|
+
#
|
1429
|
+
# * No spaces allowed. For example, `ExampleTracker`.
|
1430
|
+
#
|
1431
|
+
# @return [Types::CreateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1432
|
+
#
|
1433
|
+
# * {Types::CreateTrackerResponse#create_time #create_time} => Time
|
1434
|
+
# * {Types::CreateTrackerResponse#tracker_arn #tracker_arn} => String
|
1435
|
+
# * {Types::CreateTrackerResponse#tracker_name #tracker_name} => String
|
1436
|
+
#
|
1437
|
+
# @example Request syntax with placeholder values
|
1438
|
+
#
|
1439
|
+
# resp = client.create_tracker({
|
1440
|
+
# description: "ResourceDescription",
|
1441
|
+
# kms_key_id: "KmsKeyId",
|
1442
|
+
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1443
|
+
# pricing_plan_data_source: "String",
|
1444
|
+
# tags: {
|
1445
|
+
# "TagKey" => "TagValue",
|
1446
|
+
# },
|
1447
|
+
# tracker_name: "ResourceName", # required
|
1448
|
+
# })
|
1449
|
+
#
|
1450
|
+
# @example Response structure
|
1451
|
+
#
|
1452
|
+
# resp.create_time #=> Time
|
1453
|
+
# resp.tracker_arn #=> String
|
1454
|
+
# resp.tracker_name #=> String
|
1455
|
+
#
|
1456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateTracker AWS API Documentation
|
1457
|
+
#
|
1458
|
+
# @overload create_tracker(params = {})
|
1459
|
+
# @param [Hash] params ({})
|
1460
|
+
def create_tracker(params = {}, options = {})
|
1461
|
+
req = build_request(:create_tracker, params)
|
1462
|
+
req.send_request(options)
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
# Deletes a geofence collection from your AWS account.
|
1466
|
+
#
|
1467
|
+
# <note markdown="1"> This operation deletes the resource permanently. If the geofence
|
1468
|
+
# collection is the target of a tracker resource, the devices will no
|
1469
|
+
# longer be monitored.
|
1470
|
+
#
|
1471
|
+
# </note>
|
1472
|
+
#
|
1473
|
+
# @option params [required, String] :collection_name
|
1474
|
+
# The name of the geofence collection to be deleted.
|
1475
|
+
#
|
1476
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1477
|
+
#
|
1478
|
+
# @example Request syntax with placeholder values
|
1479
|
+
#
|
1480
|
+
# resp = client.delete_geofence_collection({
|
1481
|
+
# collection_name: "ResourceName", # required
|
1482
|
+
# })
|
1483
|
+
#
|
1484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteGeofenceCollection AWS API Documentation
|
1485
|
+
#
|
1486
|
+
# @overload delete_geofence_collection(params = {})
|
954
1487
|
# @param [Hash] params ({})
|
955
1488
|
def delete_geofence_collection(params = {}, options = {})
|
956
1489
|
req = build_request(:delete_geofence_collection, params)
|
@@ -959,9 +1492,8 @@ module Aws::LocationService
|
|
959
1492
|
|
960
1493
|
# Deletes a map resource from your AWS account.
|
961
1494
|
#
|
962
|
-
# <note markdown="1"> This
|
963
|
-
#
|
964
|
-
# render.
|
1495
|
+
# <note markdown="1"> This operation deletes the resource permanently. If the map is being
|
1496
|
+
# used in an application, the map may not render.
|
965
1497
|
#
|
966
1498
|
# </note>
|
967
1499
|
#
|
@@ -985,15 +1517,14 @@ module Aws::LocationService
|
|
985
1517
|
req.send_request(options)
|
986
1518
|
end
|
987
1519
|
|
988
|
-
# Deletes a
|
1520
|
+
# Deletes a place index resource from your AWS account.
|
989
1521
|
#
|
990
|
-
# <note markdown="1"> This
|
991
|
-
# action.
|
1522
|
+
# <note markdown="1"> This operation deletes the resource permanently.
|
992
1523
|
#
|
993
1524
|
# </note>
|
994
1525
|
#
|
995
1526
|
# @option params [required, String] :index_name
|
996
|
-
# The name of the
|
1527
|
+
# The name of the place index resource to be deleted.
|
997
1528
|
#
|
998
1529
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
999
1530
|
#
|
@@ -1012,12 +1543,37 @@ module Aws::LocationService
|
|
1012
1543
|
req.send_request(options)
|
1013
1544
|
end
|
1014
1545
|
|
1546
|
+
# Deletes a route calculator resource from your AWS account.
|
1547
|
+
#
|
1548
|
+
# <note markdown="1"> This operation deletes the resource permanently.
|
1549
|
+
#
|
1550
|
+
# </note>
|
1551
|
+
#
|
1552
|
+
# @option params [required, String] :calculator_name
|
1553
|
+
# The name of the route calculator resource to be deleted.
|
1554
|
+
#
|
1555
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1556
|
+
#
|
1557
|
+
# @example Request syntax with placeholder values
|
1558
|
+
#
|
1559
|
+
# resp = client.delete_route_calculator({
|
1560
|
+
# calculator_name: "ResourceName", # required
|
1561
|
+
# })
|
1562
|
+
#
|
1563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteRouteCalculator AWS API Documentation
|
1564
|
+
#
|
1565
|
+
# @overload delete_route_calculator(params = {})
|
1566
|
+
# @param [Hash] params ({})
|
1567
|
+
def delete_route_calculator(params = {}, options = {})
|
1568
|
+
req = build_request(:delete_route_calculator, params)
|
1569
|
+
req.send_request(options)
|
1570
|
+
end
|
1571
|
+
|
1015
1572
|
# Deletes a tracker resource from your AWS account.
|
1016
1573
|
#
|
1017
|
-
# <note markdown="1"> This
|
1018
|
-
#
|
1019
|
-
#
|
1020
|
-
# applications.
|
1574
|
+
# <note markdown="1"> This operation deletes the resource permanently. If the tracker
|
1575
|
+
# resource is in use, you may encounter an error. Make sure that the
|
1576
|
+
# target resource isn't a dependency for your applications.
|
1021
1577
|
#
|
1022
1578
|
# </note>
|
1023
1579
|
#
|
@@ -1052,8 +1608,10 @@ module Aws::LocationService
|
|
1052
1608
|
# * {Types::DescribeGeofenceCollectionResponse#collection_name #collection_name} => String
|
1053
1609
|
# * {Types::DescribeGeofenceCollectionResponse#create_time #create_time} => Time
|
1054
1610
|
# * {Types::DescribeGeofenceCollectionResponse#description #description} => String
|
1611
|
+
# * {Types::DescribeGeofenceCollectionResponse#kms_key_id #kms_key_id} => String
|
1055
1612
|
# * {Types::DescribeGeofenceCollectionResponse#pricing_plan #pricing_plan} => String
|
1056
1613
|
# * {Types::DescribeGeofenceCollectionResponse#pricing_plan_data_source #pricing_plan_data_source} => String
|
1614
|
+
# * {Types::DescribeGeofenceCollectionResponse#tags #tags} => Hash<String,String>
|
1057
1615
|
# * {Types::DescribeGeofenceCollectionResponse#update_time #update_time} => Time
|
1058
1616
|
#
|
1059
1617
|
# @example Request syntax with placeholder values
|
@@ -1068,8 +1626,11 @@ module Aws::LocationService
|
|
1068
1626
|
# resp.collection_name #=> String
|
1069
1627
|
# resp.create_time #=> Time
|
1070
1628
|
# resp.description #=> String
|
1629
|
+
# resp.kms_key_id #=> String
|
1071
1630
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1072
1631
|
# resp.pricing_plan_data_source #=> String
|
1632
|
+
# resp.tags #=> Hash
|
1633
|
+
# resp.tags["TagKey"] #=> String
|
1073
1634
|
# resp.update_time #=> Time
|
1074
1635
|
#
|
1075
1636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollection AWS API Documentation
|
@@ -1095,6 +1656,7 @@ module Aws::LocationService
|
|
1095
1656
|
# * {Types::DescribeMapResponse#map_arn #map_arn} => String
|
1096
1657
|
# * {Types::DescribeMapResponse#map_name #map_name} => String
|
1097
1658
|
# * {Types::DescribeMapResponse#pricing_plan #pricing_plan} => String
|
1659
|
+
# * {Types::DescribeMapResponse#tags #tags} => Hash<String,String>
|
1098
1660
|
# * {Types::DescribeMapResponse#update_time #update_time} => Time
|
1099
1661
|
#
|
1100
1662
|
# @example Request syntax with placeholder values
|
@@ -1112,6 +1674,8 @@ module Aws::LocationService
|
|
1112
1674
|
# resp.map_arn #=> String
|
1113
1675
|
# resp.map_name #=> String
|
1114
1676
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1677
|
+
# resp.tags #=> Hash
|
1678
|
+
# resp.tags["TagKey"] #=> String
|
1115
1679
|
# resp.update_time #=> Time
|
1116
1680
|
#
|
1117
1681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMap AWS API Documentation
|
@@ -1123,10 +1687,10 @@ module Aws::LocationService
|
|
1123
1687
|
req.send_request(options)
|
1124
1688
|
end
|
1125
1689
|
|
1126
|
-
# Retrieves the
|
1690
|
+
# Retrieves the place index resource details.
|
1127
1691
|
#
|
1128
1692
|
# @option params [required, String] :index_name
|
1129
|
-
# The name of the
|
1693
|
+
# The name of the place index resource.
|
1130
1694
|
#
|
1131
1695
|
# @return [Types::DescribePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1132
1696
|
#
|
@@ -1137,6 +1701,7 @@ module Aws::LocationService
|
|
1137
1701
|
# * {Types::DescribePlaceIndexResponse#index_arn #index_arn} => String
|
1138
1702
|
# * {Types::DescribePlaceIndexResponse#index_name #index_name} => String
|
1139
1703
|
# * {Types::DescribePlaceIndexResponse#pricing_plan #pricing_plan} => String
|
1704
|
+
# * {Types::DescribePlaceIndexResponse#tags #tags} => Hash<String,String>
|
1140
1705
|
# * {Types::DescribePlaceIndexResponse#update_time #update_time} => Time
|
1141
1706
|
#
|
1142
1707
|
# @example Request syntax with placeholder values
|
@@ -1154,6 +1719,8 @@ module Aws::LocationService
|
|
1154
1719
|
# resp.index_arn #=> String
|
1155
1720
|
# resp.index_name #=> String
|
1156
1721
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1722
|
+
# resp.tags #=> Hash
|
1723
|
+
# resp.tags["TagKey"] #=> String
|
1157
1724
|
# resp.update_time #=> Time
|
1158
1725
|
#
|
1159
1726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndex AWS API Documentation
|
@@ -1165,6 +1732,49 @@ module Aws::LocationService
|
|
1165
1732
|
req.send_request(options)
|
1166
1733
|
end
|
1167
1734
|
|
1735
|
+
# Retrieves the route calculator resource details.
|
1736
|
+
#
|
1737
|
+
# @option params [required, String] :calculator_name
|
1738
|
+
# The name of the route calculator resource.
|
1739
|
+
#
|
1740
|
+
# @return [Types::DescribeRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1741
|
+
#
|
1742
|
+
# * {Types::DescribeRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
1743
|
+
# * {Types::DescribeRouteCalculatorResponse#calculator_name #calculator_name} => String
|
1744
|
+
# * {Types::DescribeRouteCalculatorResponse#create_time #create_time} => Time
|
1745
|
+
# * {Types::DescribeRouteCalculatorResponse#data_source #data_source} => String
|
1746
|
+
# * {Types::DescribeRouteCalculatorResponse#description #description} => String
|
1747
|
+
# * {Types::DescribeRouteCalculatorResponse#pricing_plan #pricing_plan} => String
|
1748
|
+
# * {Types::DescribeRouteCalculatorResponse#tags #tags} => Hash<String,String>
|
1749
|
+
# * {Types::DescribeRouteCalculatorResponse#update_time #update_time} => Time
|
1750
|
+
#
|
1751
|
+
# @example Request syntax with placeholder values
|
1752
|
+
#
|
1753
|
+
# resp = client.describe_route_calculator({
|
1754
|
+
# calculator_name: "ResourceName", # required
|
1755
|
+
# })
|
1756
|
+
#
|
1757
|
+
# @example Response structure
|
1758
|
+
#
|
1759
|
+
# resp.calculator_arn #=> String
|
1760
|
+
# resp.calculator_name #=> String
|
1761
|
+
# resp.create_time #=> Time
|
1762
|
+
# resp.data_source #=> String
|
1763
|
+
# resp.description #=> String
|
1764
|
+
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1765
|
+
# resp.tags #=> Hash
|
1766
|
+
# resp.tags["TagKey"] #=> String
|
1767
|
+
# resp.update_time #=> Time
|
1768
|
+
#
|
1769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeRouteCalculator AWS API Documentation
|
1770
|
+
#
|
1771
|
+
# @overload describe_route_calculator(params = {})
|
1772
|
+
# @param [Hash] params ({})
|
1773
|
+
def describe_route_calculator(params = {}, options = {})
|
1774
|
+
req = build_request(:describe_route_calculator, params)
|
1775
|
+
req.send_request(options)
|
1776
|
+
end
|
1777
|
+
|
1168
1778
|
# Retrieves the tracker resource details.
|
1169
1779
|
#
|
1170
1780
|
# @option params [required, String] :tracker_name
|
@@ -1174,8 +1784,10 @@ module Aws::LocationService
|
|
1174
1784
|
#
|
1175
1785
|
# * {Types::DescribeTrackerResponse#create_time #create_time} => Time
|
1176
1786
|
# * {Types::DescribeTrackerResponse#description #description} => String
|
1787
|
+
# * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String
|
1177
1788
|
# * {Types::DescribeTrackerResponse#pricing_plan #pricing_plan} => String
|
1178
1789
|
# * {Types::DescribeTrackerResponse#pricing_plan_data_source #pricing_plan_data_source} => String
|
1790
|
+
# * {Types::DescribeTrackerResponse#tags #tags} => Hash<String,String>
|
1179
1791
|
# * {Types::DescribeTrackerResponse#tracker_arn #tracker_arn} => String
|
1180
1792
|
# * {Types::DescribeTrackerResponse#tracker_name #tracker_name} => String
|
1181
1793
|
# * {Types::DescribeTrackerResponse#update_time #update_time} => Time
|
@@ -1190,8 +1802,11 @@ module Aws::LocationService
|
|
1190
1802
|
#
|
1191
1803
|
# resp.create_time #=> Time
|
1192
1804
|
# resp.description #=> String
|
1805
|
+
# resp.kms_key_id #=> String
|
1193
1806
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1194
1807
|
# resp.pricing_plan_data_source #=> String
|
1808
|
+
# resp.tags #=> Hash
|
1809
|
+
# resp.tags["TagKey"] #=> String
|
1195
1810
|
# resp.tracker_arn #=> String
|
1196
1811
|
# resp.tracker_name #=> String
|
1197
1812
|
# resp.update_time #=> Time
|
@@ -1220,7 +1835,7 @@ module Aws::LocationService
|
|
1220
1835
|
# a resource across all AWS.
|
1221
1836
|
#
|
1222
1837
|
# * Format example:
|
1223
|
-
# `arn:
|
1838
|
+
# `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
|
1224
1839
|
#
|
1225
1840
|
# ^
|
1226
1841
|
#
|
@@ -1248,7 +1863,7 @@ module Aws::LocationService
|
|
1248
1863
|
# Retrieves a device's most recent position according to its sample
|
1249
1864
|
# time.
|
1250
1865
|
#
|
1251
|
-
# <note markdown="1"> Device positions are deleted after
|
1866
|
+
# <note markdown="1"> Device positions are deleted after 30 days.
|
1252
1867
|
#
|
1253
1868
|
# </note>
|
1254
1869
|
#
|
@@ -1292,7 +1907,7 @@ module Aws::LocationService
|
|
1292
1907
|
# Retrieves the device position history from a tracker resource within a
|
1293
1908
|
# specified range of time.
|
1294
1909
|
#
|
1295
|
-
# <note markdown="1"> Device positions are deleted after
|
1910
|
+
# <note markdown="1"> Device positions are deleted after 30 days.
|
1296
1911
|
#
|
1297
1912
|
# </note>
|
1298
1913
|
#
|
@@ -1424,11 +2039,40 @@ module Aws::LocationService
|
|
1424
2039
|
#
|
1425
2040
|
# @option params [required, String] :font_stack
|
1426
2041
|
# A comma-separated list of fonts to load glyphs from in order of
|
1427
|
-
# preference
|
2042
|
+
# preference. For example, `Noto Sans Regular, Arial Unicode`.
|
2043
|
+
#
|
2044
|
+
# Valid fonts for [Esri][1] styles:
|
2045
|
+
#
|
2046
|
+
# * VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` \| `Ubuntu Medium`
|
2047
|
+
# \| `Ubuntu Italic` \| `Ubuntu Regular` \| `Ubuntu Bold`
|
2048
|
+
#
|
2049
|
+
# * VectorEsriLightGrayCanvas – `Ubuntu Italic` \| `Ubuntu Regular` \|
|
2050
|
+
# `Ubuntu Light` \| `Ubuntu Bold`
|
2051
|
+
#
|
2052
|
+
# * VectorEsriTopographic – `Noto Sans Italic` \| `Noto Sans Regular` \|
|
2053
|
+
# `Noto Sans Bold` \| `Noto Serif Regular` \| `Roboto Condensed Light
|
2054
|
+
# Italic`
|
2055
|
+
#
|
2056
|
+
# * VectorEsriStreets – `Arial Regular` \| `Arial Italic` \| `Arial
|
2057
|
+
# Bold`
|
2058
|
+
#
|
2059
|
+
# * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial
|
2060
|
+
# Bold`
|
2061
|
+
#
|
2062
|
+
# Valid fonts for [HERE Technologies][2] styles:
|
2063
|
+
#
|
2064
|
+
# * `VectorHereBerlin` – `Fira GO Regular` \| `Fira GO Bold`
|
2065
|
+
#
|
2066
|
+
# ^
|
2067
|
+
#
|
2068
|
+
#
|
2069
|
+
#
|
2070
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
|
2071
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
|
1428
2072
|
#
|
1429
2073
|
# @option params [required, String] :font_unicode_range
|
1430
2074
|
# A Unicode range of characters to download glyphs for. Each response
|
1431
|
-
# will contain 256 characters. For example, 0
|
2075
|
+
# will contain 256 characters. For example, 0–255 includes all
|
1432
2076
|
# characters from range `U+0000` to `00FF`. Must be aligned to multiples
|
1433
2077
|
# of 256.
|
1434
2078
|
#
|
@@ -1546,7 +2190,7 @@ module Aws::LocationService
|
|
1546
2190
|
end
|
1547
2191
|
|
1548
2192
|
# Retrieves a vector data tile from the map resource. Map tiles are used
|
1549
|
-
# by clients to render a map.
|
2193
|
+
# by clients to render a map. they're addressed using a grid
|
1550
2194
|
# arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
|
1551
2195
|
#
|
1552
2196
|
# The origin (0, 0) is the top left of the map. Increasing the zoom
|
@@ -1594,6 +2238,55 @@ module Aws::LocationService
|
|
1594
2238
|
req.send_request(options, &block)
|
1595
2239
|
end
|
1596
2240
|
|
2241
|
+
# A batch request to retrieve all device positions.
|
2242
|
+
#
|
2243
|
+
# @option params [Integer] :max_results
|
2244
|
+
# An optional limit for the number of entries returned in a single call.
|
2245
|
+
#
|
2246
|
+
# Default value: `100`
|
2247
|
+
#
|
2248
|
+
# @option params [String] :next_token
|
2249
|
+
# The pagination token specifying which page of results to return in the
|
2250
|
+
# response. If no token is provided, the default page is the first page.
|
2251
|
+
#
|
2252
|
+
# Default value: `null`
|
2253
|
+
#
|
2254
|
+
# @option params [required, String] :tracker_name
|
2255
|
+
# The tracker resource containing the requested devices.
|
2256
|
+
#
|
2257
|
+
# @return [Types::ListDevicePositionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2258
|
+
#
|
2259
|
+
# * {Types::ListDevicePositionsResponse#entries #data.entries} => Array<Types::ListDevicePositionsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
2260
|
+
# * {Types::ListDevicePositionsResponse#next_token #next_token} => String
|
2261
|
+
#
|
2262
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2263
|
+
#
|
2264
|
+
# @example Request syntax with placeholder values
|
2265
|
+
#
|
2266
|
+
# resp = client.list_device_positions({
|
2267
|
+
# max_results: 1,
|
2268
|
+
# next_token: "Token",
|
2269
|
+
# tracker_name: "ResourceName", # required
|
2270
|
+
# })
|
2271
|
+
#
|
2272
|
+
# @example Response structure
|
2273
|
+
#
|
2274
|
+
# resp.data.entries #=> Array
|
2275
|
+
# resp.data.entries[0].device_id #=> String
|
2276
|
+
# resp.data.entries[0].position #=> Array
|
2277
|
+
# resp.data.entries[0].position[0] #=> Float
|
2278
|
+
# resp.data.entries[0].sample_time #=> Time
|
2279
|
+
# resp.next_token #=> String
|
2280
|
+
#
|
2281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositions AWS API Documentation
|
2282
|
+
#
|
2283
|
+
# @overload list_device_positions(params = {})
|
2284
|
+
# @param [Hash] params ({})
|
2285
|
+
def list_device_positions(params = {}, options = {})
|
2286
|
+
req = build_request(:list_device_positions, params)
|
2287
|
+
req.send_request(options)
|
2288
|
+
end
|
2289
|
+
|
1597
2290
|
# Lists geofence collections in your AWS account.
|
1598
2291
|
#
|
1599
2292
|
# @option params [Integer] :max_results
|
@@ -1610,7 +2303,7 @@ module Aws::LocationService
|
|
1610
2303
|
#
|
1611
2304
|
# @return [Types::ListGeofenceCollectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1612
2305
|
#
|
1613
|
-
# * {Types::ListGeofenceCollectionsResponse#entries #entries} => Array<Types::ListGeofenceCollectionsResponseEntry>
|
2306
|
+
# * {Types::ListGeofenceCollectionsResponse#entries #data.entries} => Array<Types::ListGeofenceCollectionsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1614
2307
|
# * {Types::ListGeofenceCollectionsResponse#next_token #next_token} => String
|
1615
2308
|
#
|
1616
2309
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1624,13 +2317,13 @@ module Aws::LocationService
|
|
1624
2317
|
#
|
1625
2318
|
# @example Response structure
|
1626
2319
|
#
|
1627
|
-
# resp.entries #=> Array
|
1628
|
-
# resp.entries[0].collection_name #=> String
|
1629
|
-
# resp.entries[0].create_time #=> Time
|
1630
|
-
# resp.entries[0].description #=> String
|
1631
|
-
# resp.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1632
|
-
# resp.entries[0].pricing_plan_data_source #=> String
|
1633
|
-
# resp.entries[0].update_time #=> Time
|
2320
|
+
# resp.data.entries #=> Array
|
2321
|
+
# resp.data.entries[0].collection_name #=> String
|
2322
|
+
# resp.data.entries[0].create_time #=> Time
|
2323
|
+
# resp.data.entries[0].description #=> String
|
2324
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2325
|
+
# resp.data.entries[0].pricing_plan_data_source #=> String
|
2326
|
+
# resp.data.entries[0].update_time #=> Time
|
1634
2327
|
# resp.next_token #=> String
|
1635
2328
|
#
|
1636
2329
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofenceCollections AWS API Documentation
|
@@ -1655,7 +2348,7 @@ module Aws::LocationService
|
|
1655
2348
|
#
|
1656
2349
|
# @return [Types::ListGeofencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1657
2350
|
#
|
1658
|
-
# * {Types::ListGeofencesResponse#entries #entries} => Array<Types::ListGeofenceResponseEntry>
|
2351
|
+
# * {Types::ListGeofencesResponse#entries #data.entries} => Array<Types::ListGeofenceResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1659
2352
|
# * {Types::ListGeofencesResponse#next_token #next_token} => String
|
1660
2353
|
#
|
1661
2354
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1669,15 +2362,15 @@ module Aws::LocationService
|
|
1669
2362
|
#
|
1670
2363
|
# @example Response structure
|
1671
2364
|
#
|
1672
|
-
# resp.entries #=> Array
|
1673
|
-
# resp.entries[0].create_time #=> Time
|
1674
|
-
# resp.entries[0].geofence_id #=> String
|
1675
|
-
# resp.entries[0].geometry.polygon #=> Array
|
1676
|
-
# resp.entries[0].geometry.polygon[0] #=> Array
|
1677
|
-
# resp.entries[0].geometry.polygon[0][0] #=> Array
|
1678
|
-
# resp.entries[0].geometry.polygon[0][0][0] #=> Float
|
1679
|
-
# resp.entries[0].status #=> String
|
1680
|
-
# resp.entries[0].update_time #=> Time
|
2365
|
+
# resp.data.entries #=> Array
|
2366
|
+
# resp.data.entries[0].create_time #=> Time
|
2367
|
+
# resp.data.entries[0].geofence_id #=> String
|
2368
|
+
# resp.data.entries[0].geometry.polygon #=> Array
|
2369
|
+
# resp.data.entries[0].geometry.polygon[0] #=> Array
|
2370
|
+
# resp.data.entries[0].geometry.polygon[0][0] #=> Array
|
2371
|
+
# resp.data.entries[0].geometry.polygon[0][0][0] #=> Float
|
2372
|
+
# resp.data.entries[0].status #=> String
|
2373
|
+
# resp.data.entries[0].update_time #=> Time
|
1681
2374
|
# resp.next_token #=> String
|
1682
2375
|
#
|
1683
2376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofences AWS API Documentation
|
@@ -1705,7 +2398,7 @@ module Aws::LocationService
|
|
1705
2398
|
#
|
1706
2399
|
# @return [Types::ListMapsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1707
2400
|
#
|
1708
|
-
# * {Types::ListMapsResponse#entries #entries} => Array<Types::ListMapsResponseEntry>
|
2401
|
+
# * {Types::ListMapsResponse#entries #data.entries} => Array<Types::ListMapsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1709
2402
|
# * {Types::ListMapsResponse#next_token #next_token} => String
|
1710
2403
|
#
|
1711
2404
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1719,13 +2412,13 @@ module Aws::LocationService
|
|
1719
2412
|
#
|
1720
2413
|
# @example Response structure
|
1721
2414
|
#
|
1722
|
-
# resp.entries #=> Array
|
1723
|
-
# resp.entries[0].create_time #=> Time
|
1724
|
-
# resp.entries[0].data_source #=> String
|
1725
|
-
# resp.entries[0].description #=> String
|
1726
|
-
# resp.entries[0].map_name #=> String
|
1727
|
-
# resp.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1728
|
-
# resp.entries[0].update_time #=> Time
|
2415
|
+
# resp.data.entries #=> Array
|
2416
|
+
# resp.data.entries[0].create_time #=> Time
|
2417
|
+
# resp.data.entries[0].data_source #=> String
|
2418
|
+
# resp.data.entries[0].description #=> String
|
2419
|
+
# resp.data.entries[0].map_name #=> String
|
2420
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2421
|
+
# resp.data.entries[0].update_time #=> Time
|
1729
2422
|
# resp.next_token #=> String
|
1730
2423
|
#
|
1731
2424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListMaps AWS API Documentation
|
@@ -1737,7 +2430,7 @@ module Aws::LocationService
|
|
1737
2430
|
req.send_request(options)
|
1738
2431
|
end
|
1739
2432
|
|
1740
|
-
# Lists
|
2433
|
+
# Lists place index resources in your AWS account.
|
1741
2434
|
#
|
1742
2435
|
# @option params [Integer] :max_results
|
1743
2436
|
# An optional limit for the maximum number of results returned in a
|
@@ -1753,7 +2446,7 @@ module Aws::LocationService
|
|
1753
2446
|
#
|
1754
2447
|
# @return [Types::ListPlaceIndexesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1755
2448
|
#
|
1756
|
-
# * {Types::ListPlaceIndexesResponse#entries #entries} => Array<Types::ListPlaceIndexesResponseEntry>
|
2449
|
+
# * {Types::ListPlaceIndexesResponse#entries #data.entries} => Array<Types::ListPlaceIndexesResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1757
2450
|
# * {Types::ListPlaceIndexesResponse#next_token #next_token} => String
|
1758
2451
|
#
|
1759
2452
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1767,13 +2460,13 @@ module Aws::LocationService
|
|
1767
2460
|
#
|
1768
2461
|
# @example Response structure
|
1769
2462
|
#
|
1770
|
-
# resp.entries #=> Array
|
1771
|
-
# resp.entries[0].create_time #=> Time
|
1772
|
-
# resp.entries[0].data_source #=> String
|
1773
|
-
# resp.entries[0].description #=> String
|
1774
|
-
# resp.entries[0].index_name #=> String
|
1775
|
-
# resp.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1776
|
-
# resp.entries[0].update_time #=> Time
|
2463
|
+
# resp.data.entries #=> Array
|
2464
|
+
# resp.data.entries[0].create_time #=> Time
|
2465
|
+
# resp.data.entries[0].data_source #=> String
|
2466
|
+
# resp.data.entries[0].description #=> String
|
2467
|
+
# resp.data.entries[0].index_name #=> String
|
2468
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2469
|
+
# resp.data.entries[0].update_time #=> Time
|
1777
2470
|
# resp.next_token #=> String
|
1778
2471
|
#
|
1779
2472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexes AWS API Documentation
|
@@ -1785,6 +2478,89 @@ module Aws::LocationService
|
|
1785
2478
|
req.send_request(options)
|
1786
2479
|
end
|
1787
2480
|
|
2481
|
+
# Lists route calculator resources in your AWS account.
|
2482
|
+
#
|
2483
|
+
# @option params [Integer] :max_results
|
2484
|
+
# An optional maximum number of results returned in a single call.
|
2485
|
+
#
|
2486
|
+
# Default Value: `100`
|
2487
|
+
#
|
2488
|
+
# @option params [String] :next_token
|
2489
|
+
# The pagination token specifying which page of results to return in the
|
2490
|
+
# response. If no token is provided, the default page is the first page.
|
2491
|
+
#
|
2492
|
+
# Default Value: `null`
|
2493
|
+
#
|
2494
|
+
# @return [Types::ListRouteCalculatorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2495
|
+
#
|
2496
|
+
# * {Types::ListRouteCalculatorsResponse#entries #data.entries} => Array<Types::ListRouteCalculatorsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
2497
|
+
# * {Types::ListRouteCalculatorsResponse#next_token #next_token} => String
|
2498
|
+
#
|
2499
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2500
|
+
#
|
2501
|
+
# @example Request syntax with placeholder values
|
2502
|
+
#
|
2503
|
+
# resp = client.list_route_calculators({
|
2504
|
+
# max_results: 1,
|
2505
|
+
# next_token: "Token",
|
2506
|
+
# })
|
2507
|
+
#
|
2508
|
+
# @example Response structure
|
2509
|
+
#
|
2510
|
+
# resp.data.entries #=> Array
|
2511
|
+
# resp.data.entries[0].calculator_name #=> String
|
2512
|
+
# resp.data.entries[0].create_time #=> Time
|
2513
|
+
# resp.data.entries[0].data_source #=> String
|
2514
|
+
# resp.data.entries[0].description #=> String
|
2515
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2516
|
+
# resp.data.entries[0].update_time #=> Time
|
2517
|
+
# resp.next_token #=> String
|
2518
|
+
#
|
2519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListRouteCalculators AWS API Documentation
|
2520
|
+
#
|
2521
|
+
# @overload list_route_calculators(params = {})
|
2522
|
+
# @param [Hash] params ({})
|
2523
|
+
def list_route_calculators(params = {}, options = {})
|
2524
|
+
req = build_request(:list_route_calculators, params)
|
2525
|
+
req.send_request(options)
|
2526
|
+
end
|
2527
|
+
|
2528
|
+
# Returns a list of tags that are applied to the specified Amazon
|
2529
|
+
# Location resource.
|
2530
|
+
#
|
2531
|
+
# @option params [required, String] :resource_arn
|
2532
|
+
# The Amazon Resource Name (ARN) of the resource whose tags you want to
|
2533
|
+
# retrieve.
|
2534
|
+
#
|
2535
|
+
# * Format example:
|
2536
|
+
# `arn:aws:geo:region:account-id:resourcetype/ExampleResource`
|
2537
|
+
#
|
2538
|
+
# ^
|
2539
|
+
#
|
2540
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2541
|
+
#
|
2542
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
2543
|
+
#
|
2544
|
+
# @example Request syntax with placeholder values
|
2545
|
+
#
|
2546
|
+
# resp = client.list_tags_for_resource({
|
2547
|
+
# resource_arn: "Arn", # required
|
2548
|
+
# })
|
2549
|
+
#
|
2550
|
+
# @example Response structure
|
2551
|
+
#
|
2552
|
+
# resp.tags #=> Hash
|
2553
|
+
# resp.tags["TagKey"] #=> String
|
2554
|
+
#
|
2555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTagsForResource AWS API Documentation
|
2556
|
+
#
|
2557
|
+
# @overload list_tags_for_resource(params = {})
|
2558
|
+
# @param [Hash] params ({})
|
2559
|
+
def list_tags_for_resource(params = {}, options = {})
|
2560
|
+
req = build_request(:list_tags_for_resource, params)
|
2561
|
+
req.send_request(options)
|
2562
|
+
end
|
2563
|
+
|
1788
2564
|
# Lists geofence collections currently associated to the given tracker
|
1789
2565
|
# resource.
|
1790
2566
|
#
|
@@ -1850,7 +2626,7 @@ module Aws::LocationService
|
|
1850
2626
|
#
|
1851
2627
|
# @return [Types::ListTrackersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1852
2628
|
#
|
1853
|
-
# * {Types::ListTrackersResponse#entries #entries} => Array<Types::ListTrackersResponseEntry>
|
2629
|
+
# * {Types::ListTrackersResponse#entries #data.entries} => Array<Types::ListTrackersResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
1854
2630
|
# * {Types::ListTrackersResponse#next_token #next_token} => String
|
1855
2631
|
#
|
1856
2632
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
@@ -1864,13 +2640,13 @@ module Aws::LocationService
|
|
1864
2640
|
#
|
1865
2641
|
# @example Response structure
|
1866
2642
|
#
|
1867
|
-
# resp.entries #=> Array
|
1868
|
-
# resp.entries[0].create_time #=> Time
|
1869
|
-
# resp.entries[0].description #=> String
|
1870
|
-
# resp.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1871
|
-
# resp.entries[0].pricing_plan_data_source #=> String
|
1872
|
-
# resp.entries[0].tracker_name #=> String
|
1873
|
-
# resp.entries[0].update_time #=> Time
|
2643
|
+
# resp.data.entries #=> Array
|
2644
|
+
# resp.data.entries[0].create_time #=> Time
|
2645
|
+
# resp.data.entries[0].description #=> String
|
2646
|
+
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2647
|
+
# resp.data.entries[0].pricing_plan_data_source #=> String
|
2648
|
+
# resp.data.entries[0].tracker_name #=> String
|
2649
|
+
# resp.data.entries[0].update_time #=> Time
|
1874
2650
|
# resp.next_token #=> String
|
1875
2651
|
#
|
1876
2652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListTrackers AWS API Documentation
|
@@ -1942,22 +2718,8 @@ module Aws::LocationService
|
|
1942
2718
|
# Allows you to search for Places or points of interest near a given
|
1943
2719
|
# position.
|
1944
2720
|
#
|
1945
|
-
# <note markdown="1"> By using Places, you agree that AWS may transmit your API queries to
|
1946
|
-
# your selected third party provider for processing, which may be
|
1947
|
-
# outside the AWS region you are currently using.
|
1948
|
-
#
|
1949
|
-
# Because of licensing limitations, you may not use HERE to store
|
1950
|
-
# results for locations in Japan. For more information, see the [AWS
|
1951
|
-
# Service Terms][1] for Amazon Location Service.
|
1952
|
-
#
|
1953
|
-
# </note>
|
1954
|
-
#
|
1955
|
-
#
|
1956
|
-
#
|
1957
|
-
# [1]: https://aws.amazon.com/service-terms/
|
1958
|
-
#
|
1959
2721
|
# @option params [required, String] :index_name
|
1960
|
-
# The name of the
|
2722
|
+
# The name of the place index resource you want to use for the search.
|
1961
2723
|
#
|
1962
2724
|
# @option params [Integer] :max_results
|
1963
2725
|
# An optional paramer. The maximum number of results returned per
|
@@ -2028,22 +2790,6 @@ module Aws::LocationService
|
|
2028
2790
|
#
|
2029
2791
|
# </note>
|
2030
2792
|
#
|
2031
|
-
# <note markdown="1"> By using Places, you agree that AWS may transmit your API queries to
|
2032
|
-
# your selected third party provider for processing, which may be
|
2033
|
-
# outside the AWS region you are currently using.
|
2034
|
-
#
|
2035
|
-
# Also, when using HERE as your data provider, you may not (a) use HERE
|
2036
|
-
# Places for Asset Management, or (b) select the `Storage` option for
|
2037
|
-
# the `IntendedUse` parameter when requesting Places in Japan. For more
|
2038
|
-
# information, see the [AWS Service Terms][1] for Amazon Location
|
2039
|
-
# Service.
|
2040
|
-
#
|
2041
|
-
# </note>
|
2042
|
-
#
|
2043
|
-
#
|
2044
|
-
#
|
2045
|
-
# [1]: https://aws.amazon.com/service-terms/
|
2046
|
-
#
|
2047
2793
|
# @option params [Array<Float>] :bias_position
|
2048
2794
|
# Searches for results closest to the given position. An optional
|
2049
2795
|
# parameter defined by longitude, and latitude.
|
@@ -2092,7 +2838,7 @@ module Aws::LocationService
|
|
2092
2838
|
# [1]: https://www.iso.org/iso-3166-country-codes.html
|
2093
2839
|
#
|
2094
2840
|
# @option params [required, String] :index_name
|
2095
|
-
# The name of the
|
2841
|
+
# The name of the place index resource you want to use for the search.
|
2096
2842
|
#
|
2097
2843
|
# @option params [Integer] :max_results
|
2098
2844
|
# An optional parameter. The maximum number of results returned per
|
@@ -2155,6 +2901,372 @@ module Aws::LocationService
|
|
2155
2901
|
req.send_request(options)
|
2156
2902
|
end
|
2157
2903
|
|
2904
|
+
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
2905
|
+
# Location Service resource.
|
2906
|
+
#
|
2907
|
+
# <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p>
|
2908
|
+
#
|
2909
|
+
# @option params [required, String] :resource_arn
|
2910
|
+
# The Amazon Resource Name (ARN) of the resource whose tags you want to
|
2911
|
+
# update.
|
2912
|
+
#
|
2913
|
+
# * Format example:
|
2914
|
+
# `arn:aws:geo:region:account-id:resourcetype/ExampleResource`
|
2915
|
+
#
|
2916
|
+
# ^
|
2917
|
+
#
|
2918
|
+
# @option params [required, Hash<String,String>] :tags
|
2919
|
+
# Tags that have been applied to the specified resource. Tags are mapped
|
2920
|
+
# from the tag key to the tag value: `"TagKey" : "TagValue"`.
|
2921
|
+
#
|
2922
|
+
# * Format example: `\{"tag1" : "value1", "tag2" : "value2"\} `
|
2923
|
+
#
|
2924
|
+
# ^
|
2925
|
+
#
|
2926
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2927
|
+
#
|
2928
|
+
# @example Request syntax with placeholder values
|
2929
|
+
#
|
2930
|
+
# resp = client.tag_resource({
|
2931
|
+
# resource_arn: "Arn", # required
|
2932
|
+
# tags: { # required
|
2933
|
+
# "TagKey" => "TagValue",
|
2934
|
+
# },
|
2935
|
+
# })
|
2936
|
+
#
|
2937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResource AWS API Documentation
|
2938
|
+
#
|
2939
|
+
# @overload tag_resource(params = {})
|
2940
|
+
# @param [Hash] params ({})
|
2941
|
+
def tag_resource(params = {}, options = {})
|
2942
|
+
req = build_request(:tag_resource, params)
|
2943
|
+
req.send_request(options)
|
2944
|
+
end
|
2945
|
+
|
2946
|
+
# Removes one or more tags from the specified Amazon Location resource.
|
2947
|
+
#
|
2948
|
+
# @option params [required, String] :resource_arn
|
2949
|
+
# The Amazon Resource Name (ARN) of the resource from which you want to
|
2950
|
+
# remove tags.
|
2951
|
+
#
|
2952
|
+
# * Format example:
|
2953
|
+
# `arn:aws:geo:region:account-id:resourcetype/ExampleResource`
|
2954
|
+
#
|
2955
|
+
# ^
|
2956
|
+
#
|
2957
|
+
# @option params [required, Array<String>] :tag_keys
|
2958
|
+
# The list of tag keys to remove from the specified resource.
|
2959
|
+
#
|
2960
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2961
|
+
#
|
2962
|
+
# @example Request syntax with placeholder values
|
2963
|
+
#
|
2964
|
+
# resp = client.untag_resource({
|
2965
|
+
# resource_arn: "Arn", # required
|
2966
|
+
# tag_keys: ["String"], # required
|
2967
|
+
# })
|
2968
|
+
#
|
2969
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResource AWS API Documentation
|
2970
|
+
#
|
2971
|
+
# @overload untag_resource(params = {})
|
2972
|
+
# @param [Hash] params ({})
|
2973
|
+
def untag_resource(params = {}, options = {})
|
2974
|
+
req = build_request(:untag_resource, params)
|
2975
|
+
req.send_request(options)
|
2976
|
+
end
|
2977
|
+
|
2978
|
+
# Updates the specified properties of a given geofence collection.
|
2979
|
+
#
|
2980
|
+
# @option params [required, String] :collection_name
|
2981
|
+
# The name of the geofence collection to update.
|
2982
|
+
#
|
2983
|
+
# @option params [String] :description
|
2984
|
+
# Updates the description for the geofence collection.
|
2985
|
+
#
|
2986
|
+
# @option params [String] :pricing_plan
|
2987
|
+
# Updates the pricing plan for the geofence collection.
|
2988
|
+
#
|
2989
|
+
# For more information about each pricing plan option restrictions, see
|
2990
|
+
# [Amazon Location Service pricing][1].
|
2991
|
+
#
|
2992
|
+
#
|
2993
|
+
#
|
2994
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
2995
|
+
#
|
2996
|
+
# @option params [String] :pricing_plan_data_source
|
2997
|
+
# Updates the data provider for the geofence collection.
|
2998
|
+
#
|
2999
|
+
# A required value for the following pricing plans:
|
3000
|
+
# `MobileAssetTracking`\| `MobileAssetManagement`
|
3001
|
+
#
|
3002
|
+
# For more information about [data providers][1] and [pricing plans][2],
|
3003
|
+
# see the Amazon Location Service product page.
|
3004
|
+
#
|
3005
|
+
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
3006
|
+
# request.
|
3007
|
+
#
|
3008
|
+
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
3009
|
+
# billing for your geofence collection. Your data won't be shared with
|
3010
|
+
# the data provider, and will remain in your AWS account and Region
|
3011
|
+
# unless you move it.
|
3012
|
+
#
|
3013
|
+
# </note>
|
3014
|
+
#
|
3015
|
+
#
|
3016
|
+
#
|
3017
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
3018
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
3019
|
+
#
|
3020
|
+
# @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3021
|
+
#
|
3022
|
+
# * {Types::UpdateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
3023
|
+
# * {Types::UpdateGeofenceCollectionResponse#collection_name #collection_name} => String
|
3024
|
+
# * {Types::UpdateGeofenceCollectionResponse#update_time #update_time} => Time
|
3025
|
+
#
|
3026
|
+
# @example Request syntax with placeholder values
|
3027
|
+
#
|
3028
|
+
# resp = client.update_geofence_collection({
|
3029
|
+
# collection_name: "ResourceName", # required
|
3030
|
+
# description: "ResourceDescription",
|
3031
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3032
|
+
# pricing_plan_data_source: "String",
|
3033
|
+
# })
|
3034
|
+
#
|
3035
|
+
# @example Response structure
|
3036
|
+
#
|
3037
|
+
# resp.collection_arn #=> String
|
3038
|
+
# resp.collection_name #=> String
|
3039
|
+
# resp.update_time #=> Time
|
3040
|
+
#
|
3041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollection AWS API Documentation
|
3042
|
+
#
|
3043
|
+
# @overload update_geofence_collection(params = {})
|
3044
|
+
# @param [Hash] params ({})
|
3045
|
+
def update_geofence_collection(params = {}, options = {})
|
3046
|
+
req = build_request(:update_geofence_collection, params)
|
3047
|
+
req.send_request(options)
|
3048
|
+
end
|
3049
|
+
|
3050
|
+
# Updates the specified properties of a given map resource.
|
3051
|
+
#
|
3052
|
+
# @option params [String] :description
|
3053
|
+
# Updates the description for the map resource.
|
3054
|
+
#
|
3055
|
+
# @option params [required, String] :map_name
|
3056
|
+
# The name of the map resource to update.
|
3057
|
+
#
|
3058
|
+
# @option params [String] :pricing_plan
|
3059
|
+
# Updates the pricing plan for the map resource.
|
3060
|
+
#
|
3061
|
+
# For more information about each pricing plan option restrictions, see
|
3062
|
+
# [Amazon Location Service pricing][1].
|
3063
|
+
#
|
3064
|
+
#
|
3065
|
+
#
|
3066
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3067
|
+
#
|
3068
|
+
# @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3069
|
+
#
|
3070
|
+
# * {Types::UpdateMapResponse#map_arn #map_arn} => String
|
3071
|
+
# * {Types::UpdateMapResponse#map_name #map_name} => String
|
3072
|
+
# * {Types::UpdateMapResponse#update_time #update_time} => Time
|
3073
|
+
#
|
3074
|
+
# @example Request syntax with placeholder values
|
3075
|
+
#
|
3076
|
+
# resp = client.update_map({
|
3077
|
+
# description: "ResourceDescription",
|
3078
|
+
# map_name: "ResourceName", # required
|
3079
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3080
|
+
# })
|
3081
|
+
#
|
3082
|
+
# @example Response structure
|
3083
|
+
#
|
3084
|
+
# resp.map_arn #=> String
|
3085
|
+
# resp.map_name #=> String
|
3086
|
+
# resp.update_time #=> Time
|
3087
|
+
#
|
3088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMap AWS API Documentation
|
3089
|
+
#
|
3090
|
+
# @overload update_map(params = {})
|
3091
|
+
# @param [Hash] params ({})
|
3092
|
+
def update_map(params = {}, options = {})
|
3093
|
+
req = build_request(:update_map, params)
|
3094
|
+
req.send_request(options)
|
3095
|
+
end
|
3096
|
+
|
3097
|
+
# Updates the specified properties of a given place index resource.
|
3098
|
+
#
|
3099
|
+
# @option params [Types::DataSourceConfiguration] :data_source_configuration
|
3100
|
+
# Updates the data storage option for the place index resource.
|
3101
|
+
#
|
3102
|
+
# @option params [String] :description
|
3103
|
+
# Updates the description for the place index resource.
|
3104
|
+
#
|
3105
|
+
# @option params [required, String] :index_name
|
3106
|
+
# The name of the place index resource to update.
|
3107
|
+
#
|
3108
|
+
# @option params [String] :pricing_plan
|
3109
|
+
# Updates the pricing plan for the place index resource.
|
3110
|
+
#
|
3111
|
+
# For more information about each pricing plan option restrictions, see
|
3112
|
+
# [Amazon Location Service pricing][1].
|
3113
|
+
#
|
3114
|
+
#
|
3115
|
+
#
|
3116
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3117
|
+
#
|
3118
|
+
# @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3119
|
+
#
|
3120
|
+
# * {Types::UpdatePlaceIndexResponse#index_arn #index_arn} => String
|
3121
|
+
# * {Types::UpdatePlaceIndexResponse#index_name #index_name} => String
|
3122
|
+
# * {Types::UpdatePlaceIndexResponse#update_time #update_time} => Time
|
3123
|
+
#
|
3124
|
+
# @example Request syntax with placeholder values
|
3125
|
+
#
|
3126
|
+
# resp = client.update_place_index({
|
3127
|
+
# data_source_configuration: {
|
3128
|
+
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
3129
|
+
# },
|
3130
|
+
# description: "ResourceDescription",
|
3131
|
+
# index_name: "ResourceName", # required
|
3132
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3133
|
+
# })
|
3134
|
+
#
|
3135
|
+
# @example Response structure
|
3136
|
+
#
|
3137
|
+
# resp.index_arn #=> String
|
3138
|
+
# resp.index_name #=> String
|
3139
|
+
# resp.update_time #=> Time
|
3140
|
+
#
|
3141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndex AWS API Documentation
|
3142
|
+
#
|
3143
|
+
# @overload update_place_index(params = {})
|
3144
|
+
# @param [Hash] params ({})
|
3145
|
+
def update_place_index(params = {}, options = {})
|
3146
|
+
req = build_request(:update_place_index, params)
|
3147
|
+
req.send_request(options)
|
3148
|
+
end
|
3149
|
+
|
3150
|
+
# Updates the specified properties for a given route calculator
|
3151
|
+
# resource.
|
3152
|
+
#
|
3153
|
+
# @option params [required, String] :calculator_name
|
3154
|
+
# The name of the route calculator resource to update.
|
3155
|
+
#
|
3156
|
+
# @option params [String] :description
|
3157
|
+
# Updates the description for the route calculator resource.
|
3158
|
+
#
|
3159
|
+
# @option params [String] :pricing_plan
|
3160
|
+
# Updates the pricing plan for the route calculator resource.
|
3161
|
+
#
|
3162
|
+
# For more information about each pricing plan option restrictions, see
|
3163
|
+
# [Amazon Location Service pricing][1].
|
3164
|
+
#
|
3165
|
+
#
|
3166
|
+
#
|
3167
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3168
|
+
#
|
3169
|
+
# @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3170
|
+
#
|
3171
|
+
# * {Types::UpdateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
3172
|
+
# * {Types::UpdateRouteCalculatorResponse#calculator_name #calculator_name} => String
|
3173
|
+
# * {Types::UpdateRouteCalculatorResponse#update_time #update_time} => Time
|
3174
|
+
#
|
3175
|
+
# @example Request syntax with placeholder values
|
3176
|
+
#
|
3177
|
+
# resp = client.update_route_calculator({
|
3178
|
+
# calculator_name: "ResourceName", # required
|
3179
|
+
# description: "ResourceDescription",
|
3180
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3181
|
+
# })
|
3182
|
+
#
|
3183
|
+
# @example Response structure
|
3184
|
+
#
|
3185
|
+
# resp.calculator_arn #=> String
|
3186
|
+
# resp.calculator_name #=> String
|
3187
|
+
# resp.update_time #=> Time
|
3188
|
+
#
|
3189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculator AWS API Documentation
|
3190
|
+
#
|
3191
|
+
# @overload update_route_calculator(params = {})
|
3192
|
+
# @param [Hash] params ({})
|
3193
|
+
def update_route_calculator(params = {}, options = {})
|
3194
|
+
req = build_request(:update_route_calculator, params)
|
3195
|
+
req.send_request(options)
|
3196
|
+
end
|
3197
|
+
|
3198
|
+
# Updates the specified properties of a given tracker resource.
|
3199
|
+
#
|
3200
|
+
# @option params [String] :description
|
3201
|
+
# Updates the description for the tracker resource.
|
3202
|
+
#
|
3203
|
+
# @option params [String] :pricing_plan
|
3204
|
+
# Updates the pricing plan for the tracker resource.
|
3205
|
+
#
|
3206
|
+
# For more information about each pricing plan option restrictions, see
|
3207
|
+
# [Amazon Location Service pricing][1].
|
3208
|
+
#
|
3209
|
+
#
|
3210
|
+
#
|
3211
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
3212
|
+
#
|
3213
|
+
# @option params [String] :pricing_plan_data_source
|
3214
|
+
# Updates the data provider for the tracker resource.
|
3215
|
+
#
|
3216
|
+
# A required value for the following pricing plans:
|
3217
|
+
# `MobileAssetTracking`\| `MobileAssetManagement`
|
3218
|
+
#
|
3219
|
+
# For more information about [data providers][1] and [pricing plans][2],
|
3220
|
+
# see the Amazon Location Service product page
|
3221
|
+
#
|
3222
|
+
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
3223
|
+
# request.
|
3224
|
+
#
|
3225
|
+
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
3226
|
+
# billing for your tracker resource. Your data won't be shared with the
|
3227
|
+
# data provider, and will remain in your AWS account and Region unless
|
3228
|
+
# you move it.
|
3229
|
+
#
|
3230
|
+
# </note>
|
3231
|
+
#
|
3232
|
+
#
|
3233
|
+
#
|
3234
|
+
# [1]: https://aws.amazon.com/location/data-providers/
|
3235
|
+
# [2]: https://aws.amazon.com/location/pricing/
|
3236
|
+
#
|
3237
|
+
# @option params [required, String] :tracker_name
|
3238
|
+
# The name of the tracker resource to update.
|
3239
|
+
#
|
3240
|
+
# @return [Types::UpdateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3241
|
+
#
|
3242
|
+
# * {Types::UpdateTrackerResponse#tracker_arn #tracker_arn} => String
|
3243
|
+
# * {Types::UpdateTrackerResponse#tracker_name #tracker_name} => String
|
3244
|
+
# * {Types::UpdateTrackerResponse#update_time #update_time} => Time
|
3245
|
+
#
|
3246
|
+
# @example Request syntax with placeholder values
|
3247
|
+
#
|
3248
|
+
# resp = client.update_tracker({
|
3249
|
+
# description: "ResourceDescription",
|
3250
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3251
|
+
# pricing_plan_data_source: "String",
|
3252
|
+
# tracker_name: "ResourceName", # required
|
3253
|
+
# })
|
3254
|
+
#
|
3255
|
+
# @example Response structure
|
3256
|
+
#
|
3257
|
+
# resp.tracker_arn #=> String
|
3258
|
+
# resp.tracker_name #=> String
|
3259
|
+
# resp.update_time #=> Time
|
3260
|
+
#
|
3261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateTracker AWS API Documentation
|
3262
|
+
#
|
3263
|
+
# @overload update_tracker(params = {})
|
3264
|
+
# @param [Hash] params ({})
|
3265
|
+
def update_tracker(params = {}, options = {})
|
3266
|
+
req = build_request(:update_tracker, params)
|
3267
|
+
req.send_request(options)
|
3268
|
+
end
|
3269
|
+
|
2158
3270
|
# @!endgroup
|
2159
3271
|
|
2160
3272
|
# @param params ({})
|
@@ -2168,7 +3280,7 @@ module Aws::LocationService
|
|
2168
3280
|
params: params,
|
2169
3281
|
config: config)
|
2170
3282
|
context[:gem_name] = 'aws-sdk-locationservice'
|
2171
|
-
context[:gem_version] = '1.
|
3283
|
+
context[:gem_version] = '1.7.0'
|
2172
3284
|
Seahorse::Client::Request.new(handlers, context)
|
2173
3285
|
end
|
2174
3286
|
|