aws-sdk-locationservice 1.50.0 → 1.52.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +1039 -863
- data/lib/aws-sdk-locationservice/client_api.rb +382 -212
- data/lib/aws-sdk-locationservice/endpoints.rb +28 -0
- data/lib/aws-sdk-locationservice/errors.rb +5 -5
- data/lib/aws-sdk-locationservice/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-locationservice/types.rb +2158 -1749
- data/lib/aws-sdk-locationservice.rb +1 -1
- data/sig/client.rbs +283 -202
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +327 -215
- metadata +4 -4
@@ -89,6 +89,11 @@ module Aws::LocationService
|
|
89
89
|
|
90
90
|
# @overload initialize(options)
|
91
91
|
# @param [Hash] options
|
92
|
+
#
|
93
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
94
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
95
|
+
# class name or an instance of a plugin class.
|
96
|
+
#
|
92
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
93
98
|
# Your AWS credentials. This can be an instance of any one of the
|
94
99
|
# following classes:
|
@@ -209,7 +214,6 @@ module Aws::LocationService
|
|
209
214
|
# 'https://example.com'
|
210
215
|
# 'http://example.com:123'
|
211
216
|
#
|
212
|
-
#
|
213
217
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
214
218
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
215
219
|
# for endpoint discovery enabled operations. Defaults to 1000.
|
@@ -298,7 +302,6 @@ module Aws::LocationService
|
|
298
302
|
# throttling. This is a provisional mode that may change behavior
|
299
303
|
# in the future.
|
300
304
|
#
|
301
|
-
#
|
302
305
|
# @option options [String] :sdk_ua_app_id
|
303
306
|
# A unique and opaque application ID that is appended to the
|
304
307
|
# User-Agent header as app/sdk_ua_app_id. It should have a
|
@@ -426,6 +429,10 @@ module Aws::LocationService
|
|
426
429
|
#
|
427
430
|
# </note>
|
428
431
|
#
|
432
|
+
# @option params [required, String] :tracker_name
|
433
|
+
# The name of the tracker resource to be associated with a geofence
|
434
|
+
# collection.
|
435
|
+
#
|
429
436
|
# @option params [required, String] :consumer_arn
|
430
437
|
# The Amazon Resource Name (ARN) for the geofence collection to be
|
431
438
|
# associated to tracker resource. Used when you need to specify a
|
@@ -436,17 +443,13 @@ module Aws::LocationService
|
|
436
443
|
#
|
437
444
|
# ^
|
438
445
|
#
|
439
|
-
# @option params [required, String] :tracker_name
|
440
|
-
# The name of the tracker resource to be associated with a geofence
|
441
|
-
# collection.
|
442
|
-
#
|
443
446
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
444
447
|
#
|
445
448
|
# @example Request syntax with placeholder values
|
446
449
|
#
|
447
450
|
# resp = client.associate_tracker_consumer({
|
448
|
-
# consumer_arn: "Arn", # required
|
449
451
|
# tracker_name: "ResourceName", # required
|
452
|
+
# consumer_arn: "Arn", # required
|
450
453
|
# })
|
451
454
|
#
|
452
455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/AssociateTrackerConsumer AWS API Documentation
|
@@ -461,6 +464,10 @@ module Aws::LocationService
|
|
461
464
|
# Deletes the position history of one or more devices from a tracker
|
462
465
|
# resource.
|
463
466
|
#
|
467
|
+
# @option params [required, String] :tracker_name
|
468
|
+
# The name of the tracker resource to delete the device position history
|
469
|
+
# from.
|
470
|
+
#
|
464
471
|
# @option params [required, Array<String>] :device_ids
|
465
472
|
# Devices whose position history you want to delete.
|
466
473
|
#
|
@@ -468,10 +475,6 @@ module Aws::LocationService
|
|
468
475
|
#
|
469
476
|
# ^
|
470
477
|
#
|
471
|
-
# @option params [required, String] :tracker_name
|
472
|
-
# The name of the tracker resource to delete the device position history
|
473
|
-
# from.
|
474
|
-
#
|
475
478
|
# @return [Types::BatchDeleteDevicePositionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
476
479
|
#
|
477
480
|
# * {Types::BatchDeleteDevicePositionHistoryResponse#errors #errors} => Array<Types::BatchDeleteDevicePositionHistoryError>
|
@@ -479,8 +482,8 @@ module Aws::LocationService
|
|
479
482
|
# @example Request syntax with placeholder values
|
480
483
|
#
|
481
484
|
# resp = client.batch_delete_device_position_history({
|
482
|
-
# device_ids: ["Id"], # required
|
483
485
|
# tracker_name: "ResourceName", # required
|
486
|
+
# device_ids: ["Id"], # required
|
484
487
|
# })
|
485
488
|
#
|
486
489
|
# @example Response structure
|
@@ -525,9 +528,9 @@ module Aws::LocationService
|
|
525
528
|
# @example Response structure
|
526
529
|
#
|
527
530
|
# resp.errors #=> Array
|
531
|
+
# resp.errors[0].geofence_id #=> String
|
528
532
|
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
529
533
|
# resp.errors[0].error.message #=> String
|
530
|
-
# resp.errors[0].geofence_id #=> String
|
531
534
|
#
|
532
535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteGeofence AWS API Documentation
|
533
536
|
#
|
@@ -585,15 +588,15 @@ module Aws::LocationService
|
|
585
588
|
# collection_name: "ResourceName", # required
|
586
589
|
# device_position_updates: [ # required
|
587
590
|
# {
|
591
|
+
# device_id: "Id", # required
|
592
|
+
# sample_time: Time.now, # required
|
593
|
+
# position: [1.0], # required
|
588
594
|
# accuracy: {
|
589
595
|
# horizontal: 1.0, # required
|
590
596
|
# },
|
591
|
-
# device_id: "Id", # required
|
592
|
-
# position: [1.0], # required
|
593
597
|
# position_properties: {
|
594
598
|
# "PropertyMapKeyString" => "PropertyMapValueString",
|
595
599
|
# },
|
596
|
-
# sample_time: Time.now, # required
|
597
600
|
# },
|
598
601
|
# ],
|
599
602
|
# })
|
@@ -602,9 +605,9 @@ module Aws::LocationService
|
|
602
605
|
#
|
603
606
|
# resp.errors #=> Array
|
604
607
|
# resp.errors[0].device_id #=> String
|
608
|
+
# resp.errors[0].sample_time #=> Time
|
605
609
|
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
606
610
|
# resp.errors[0].error.message #=> String
|
607
|
-
# resp.errors[0].sample_time #=> Time
|
608
611
|
#
|
609
612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchEvaluateGeofences AWS API Documentation
|
610
613
|
#
|
@@ -617,6 +620,9 @@ module Aws::LocationService
|
|
617
620
|
|
618
621
|
# Lists the latest device positions for requested devices.
|
619
622
|
#
|
623
|
+
# @option params [required, String] :tracker_name
|
624
|
+
# The tracker resource retrieving the device position.
|
625
|
+
#
|
620
626
|
# @option params [required, Array<String>] :device_ids
|
621
627
|
# Devices whose position you want to retrieve.
|
622
628
|
#
|
@@ -625,36 +631,33 @@ module Aws::LocationService
|
|
625
631
|
#
|
626
632
|
# ^
|
627
633
|
#
|
628
|
-
# @option params [required, String] :tracker_name
|
629
|
-
# The tracker resource retrieving the device position.
|
630
|
-
#
|
631
634
|
# @return [Types::BatchGetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
632
635
|
#
|
633
|
-
# * {Types::BatchGetDevicePositionResponse#device_positions #device_positions} => Array<Types::DevicePosition>
|
634
636
|
# * {Types::BatchGetDevicePositionResponse#errors #errors} => Array<Types::BatchGetDevicePositionError>
|
637
|
+
# * {Types::BatchGetDevicePositionResponse#device_positions #device_positions} => Array<Types::DevicePosition>
|
635
638
|
#
|
636
639
|
# @example Request syntax with placeholder values
|
637
640
|
#
|
638
641
|
# resp = client.batch_get_device_position({
|
639
|
-
# device_ids: ["Id"], # required
|
640
642
|
# tracker_name: "BatchGetDevicePositionRequestTrackerNameString", # required
|
643
|
+
# device_ids: ["Id"], # required
|
641
644
|
# })
|
642
645
|
#
|
643
646
|
# @example Response structure
|
644
647
|
#
|
648
|
+
# resp.errors #=> Array
|
649
|
+
# resp.errors[0].device_id #=> String
|
650
|
+
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
651
|
+
# resp.errors[0].error.message #=> String
|
645
652
|
# resp.device_positions #=> Array
|
646
|
-
# resp.device_positions[0].accuracy.horizontal #=> Float
|
647
653
|
# resp.device_positions[0].device_id #=> String
|
654
|
+
# resp.device_positions[0].sample_time #=> Time
|
655
|
+
# resp.device_positions[0].received_time #=> Time
|
648
656
|
# resp.device_positions[0].position #=> Array
|
649
657
|
# resp.device_positions[0].position[0] #=> Float
|
658
|
+
# resp.device_positions[0].accuracy.horizontal #=> Float
|
650
659
|
# resp.device_positions[0].position_properties #=> Hash
|
651
660
|
# resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
|
652
|
-
# resp.device_positions[0].received_time #=> Time
|
653
|
-
# resp.device_positions[0].sample_time #=> Time
|
654
|
-
# resp.errors #=> Array
|
655
|
-
# resp.errors[0].device_id #=> String
|
656
|
-
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
657
|
-
# resp.errors[0].error.message #=> String
|
658
661
|
#
|
659
662
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchGetDevicePosition AWS API Documentation
|
660
663
|
#
|
@@ -677,8 +680,8 @@ module Aws::LocationService
|
|
677
680
|
#
|
678
681
|
# @return [Types::BatchPutGeofenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
679
682
|
#
|
680
|
-
# * {Types::BatchPutGeofenceResponse#errors #errors} => Array<Types::BatchPutGeofenceError>
|
681
683
|
# * {Types::BatchPutGeofenceResponse#successes #successes} => Array<Types::BatchPutGeofenceSuccess>
|
684
|
+
# * {Types::BatchPutGeofenceResponse#errors #errors} => Array<Types::BatchPutGeofenceError>
|
682
685
|
#
|
683
686
|
# @example Request syntax with placeholder values
|
684
687
|
#
|
@@ -687,19 +690,20 @@ module Aws::LocationService
|
|
687
690
|
# entries: [ # required
|
688
691
|
# {
|
689
692
|
# geofence_id: "Id", # required
|
690
|
-
# geofence_properties: {
|
691
|
-
# "PropertyMapKeyString" => "PropertyMapValueString",
|
692
|
-
# },
|
693
693
|
# geometry: { # required
|
694
|
-
# circle: {
|
695
|
-
# center: [1.0], # required
|
696
|
-
# radius: 1.0, # required
|
697
|
-
# },
|
698
694
|
# polygon: [
|
699
695
|
# [
|
700
696
|
# [1.0],
|
701
697
|
# ],
|
702
698
|
# ],
|
699
|
+
# circle: {
|
700
|
+
# center: [1.0], # required
|
701
|
+
# radius: 1.0, # required
|
702
|
+
# },
|
703
|
+
# geobuf: "data",
|
704
|
+
# },
|
705
|
+
# geofence_properties: {
|
706
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
703
707
|
# },
|
704
708
|
# },
|
705
709
|
# ],
|
@@ -707,14 +711,14 @@ module Aws::LocationService
|
|
707
711
|
#
|
708
712
|
# @example Response structure
|
709
713
|
#
|
710
|
-
# resp.errors #=> Array
|
711
|
-
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
712
|
-
# resp.errors[0].error.message #=> String
|
713
|
-
# resp.errors[0].geofence_id #=> String
|
714
714
|
# resp.successes #=> Array
|
715
|
-
# resp.successes[0].create_time #=> Time
|
716
715
|
# resp.successes[0].geofence_id #=> String
|
716
|
+
# resp.successes[0].create_time #=> Time
|
717
717
|
# resp.successes[0].update_time #=> Time
|
718
|
+
# resp.errors #=> Array
|
719
|
+
# resp.errors[0].geofence_id #=> String
|
720
|
+
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
721
|
+
# resp.errors[0].error.message #=> String
|
718
722
|
#
|
719
723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchPutGeofence AWS API Documentation
|
720
724
|
#
|
@@ -771,15 +775,15 @@ module Aws::LocationService
|
|
771
775
|
# tracker_name: "ResourceName", # required
|
772
776
|
# updates: [ # required
|
773
777
|
# {
|
778
|
+
# device_id: "Id", # required
|
779
|
+
# sample_time: Time.now, # required
|
780
|
+
# position: [1.0], # required
|
774
781
|
# accuracy: {
|
775
782
|
# horizontal: 1.0, # required
|
776
783
|
# },
|
777
|
-
# device_id: "Id", # required
|
778
|
-
# position: [1.0], # required
|
779
784
|
# position_properties: {
|
780
785
|
# "PropertyMapKeyString" => "PropertyMapValueString",
|
781
786
|
# },
|
782
|
-
# sample_time: Time.now, # required
|
783
787
|
# },
|
784
788
|
# ],
|
785
789
|
# })
|
@@ -788,9 +792,9 @@ module Aws::LocationService
|
|
788
792
|
#
|
789
793
|
# resp.errors #=> Array
|
790
794
|
# resp.errors[0].device_id #=> String
|
795
|
+
# resp.errors[0].sample_time #=> Time
|
791
796
|
# resp.errors[0].error.code #=> String, one of "AccessDeniedError", "ConflictError", "InternalServerError", "ResourceNotFoundError", "ThrottlingError", "ValidationError"
|
792
797
|
# resp.errors[0].error.message #=> String
|
793
|
-
# resp.errors[0].sample_time #=> Time
|
794
798
|
#
|
795
799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchUpdateDevicePosition AWS API Documentation
|
796
800
|
#
|
@@ -837,34 +841,10 @@ module Aws::LocationService
|
|
837
841
|
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
|
838
842
|
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
|
839
843
|
#
|
840
|
-
# @option params [Time,DateTime,Date,Integer,String] :arrival_time
|
841
|
-
# Specifies the desired time of arrival. Uses the given time to
|
842
|
-
# calculate the route. Otherwise, the best time of day to travel with
|
843
|
-
# the best traffic conditions is used to calculate the route.
|
844
|
-
#
|
845
|
-
# <note markdown="1"> ArrivalTime is not supported Esri.
|
846
|
-
#
|
847
|
-
# </note>
|
848
|
-
#
|
849
844
|
# @option params [required, String] :calculator_name
|
850
845
|
# The name of the route calculator resource that you want to use to
|
851
846
|
# calculate the route.
|
852
847
|
#
|
853
|
-
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
854
|
-
# Specifies route preferences when traveling by `Car`, such as avoiding
|
855
|
-
# routes that use ferries or tolls.
|
856
|
-
#
|
857
|
-
# Requirements: `TravelMode` must be specified as `Car`.
|
858
|
-
#
|
859
|
-
# @option params [Boolean] :depart_now
|
860
|
-
# Sets the time of departure as the current time. Uses the current time
|
861
|
-
# to calculate a route. Otherwise, the best time of day to travel with
|
862
|
-
# the best traffic conditions is used to calculate the route.
|
863
|
-
#
|
864
|
-
# Default Value: `false`
|
865
|
-
#
|
866
|
-
# Valid Values: `false` \| `true`
|
867
|
-
#
|
868
848
|
# @option params [required, Array<Float>] :departure_position
|
869
849
|
# The start position for the route. Defined in [World Geodetic System
|
870
850
|
# (WGS 84)][1] format: `[longitude, latitude]`.
|
@@ -887,20 +867,6 @@ module Aws::LocationService
|
|
887
867
|
# [1]: https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84
|
888
868
|
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
889
869
|
#
|
890
|
-
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
891
|
-
# Specifies the desired time of departure. Uses the given time to
|
892
|
-
# calculate the route. Otherwise, the best time of day to travel with
|
893
|
-
# the best traffic conditions is used to calculate the route.
|
894
|
-
#
|
895
|
-
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
896
|
-
# `2020–07-2T12:15:20.000Z+01:00`
|
897
|
-
#
|
898
|
-
# ^
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
903
|
-
#
|
904
870
|
# @option params [required, Array<Float>] :destination_position
|
905
871
|
# The finish position for the route. Defined in [World Geodetic System
|
906
872
|
# (WGS 84)][1] format: `[longitude, latitude]`.
|
@@ -921,28 +887,34 @@ module Aws::LocationService
|
|
921
887
|
# [1]: https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84
|
922
888
|
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
923
889
|
#
|
924
|
-
# @option params [
|
925
|
-
#
|
890
|
+
# @option params [Array<Array>] :waypoint_positions
|
891
|
+
# Specifies an ordered list of up to 23 intermediate positions to
|
892
|
+
# include along a route between the departure position and destination
|
893
|
+
# position.
|
926
894
|
#
|
927
|
-
#
|
895
|
+
# * For example, from the `DeparturePosition` `[-123.115, 49.285]`, the
|
896
|
+
# route follows the order that the waypoint positions are given
|
897
|
+
# `[[-122.757, 49.0021],[-122.349, 47.620]]`
|
928
898
|
#
|
929
|
-
#
|
930
|
-
# Set to include the geometry details in the result for each path
|
931
|
-
# between a pair of positions.
|
899
|
+
# ^
|
932
900
|
#
|
933
|
-
#
|
901
|
+
# <note markdown="1"> If you specify a waypoint position that's not located on a road,
|
902
|
+
# Amazon Location [moves the position to the nearest road][1].
|
934
903
|
#
|
935
|
-
#
|
904
|
+
# Specifying more than 23 waypoints returns a `400 ValidationException`
|
905
|
+
# error.
|
936
906
|
#
|
937
|
-
#
|
938
|
-
#
|
907
|
+
# If Esri is the provider for your route calculator, specifying a route
|
908
|
+
# that is longer than 400 km returns a `400 RoutesValidationException`
|
909
|
+
# error.
|
939
910
|
#
|
911
|
+
# </note>
|
940
912
|
#
|
913
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
941
914
|
#
|
942
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
943
915
|
#
|
944
|
-
#
|
945
|
-
#
|
916
|
+
#
|
917
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
946
918
|
#
|
947
919
|
# @option params [String] :travel_mode
|
948
920
|
# Specifies the mode of transport when calculating a route. Used in
|
@@ -974,6 +946,48 @@ module Aws::LocationService
|
|
974
946
|
#
|
975
947
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
|
976
948
|
#
|
949
|
+
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
950
|
+
# Specifies the desired time of departure. Uses the given time to
|
951
|
+
# calculate the route. Otherwise, the best time of day to travel with
|
952
|
+
# the best traffic conditions is used to calculate the route.
|
953
|
+
#
|
954
|
+
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
955
|
+
# `2020–07-2T12:15:20.000Z+01:00`
|
956
|
+
#
|
957
|
+
# ^
|
958
|
+
#
|
959
|
+
#
|
960
|
+
#
|
961
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
962
|
+
#
|
963
|
+
# @option params [Boolean] :depart_now
|
964
|
+
# Sets the time of departure as the current time. Uses the current time
|
965
|
+
# to calculate a route. Otherwise, the best time of day to travel with
|
966
|
+
# the best traffic conditions is used to calculate the route.
|
967
|
+
#
|
968
|
+
# Default Value: `false`
|
969
|
+
#
|
970
|
+
# Valid Values: `false` \| `true`
|
971
|
+
#
|
972
|
+
# @option params [String] :distance_unit
|
973
|
+
# Set the unit system to specify the distance.
|
974
|
+
#
|
975
|
+
# Default Value: `Kilometers`
|
976
|
+
#
|
977
|
+
# @option params [Boolean] :include_leg_geometry
|
978
|
+
# Set to include the geometry details in the result for each path
|
979
|
+
# between a pair of positions.
|
980
|
+
#
|
981
|
+
# Default Value: `false`
|
982
|
+
#
|
983
|
+
# Valid Values: `false` \| `true`
|
984
|
+
#
|
985
|
+
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
986
|
+
# Specifies route preferences when traveling by `Car`, such as avoiding
|
987
|
+
# routes that use ferries or tolls.
|
988
|
+
#
|
989
|
+
# Requirements: `TravelMode` must be specified as `Car`.
|
990
|
+
#
|
977
991
|
# @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
|
978
992
|
# Specifies route preferences when traveling by `Truck`, such as
|
979
993
|
# avoiding routes that use ferries or tolls, and truck specifications to
|
@@ -981,34 +995,24 @@ module Aws::LocationService
|
|
981
995
|
#
|
982
996
|
# Requirements: `TravelMode` must be specified as `Truck`.
|
983
997
|
#
|
984
|
-
# @option params [
|
985
|
-
# Specifies
|
986
|
-
#
|
987
|
-
#
|
988
|
-
#
|
989
|
-
# * For example, from the `DeparturePosition` `[-123.115, 49.285]`, the
|
990
|
-
# route follows the order that the waypoint positions are given
|
991
|
-
# `[[-122.757, 49.0021],[-122.349, 47.620]]`
|
992
|
-
#
|
993
|
-
# ^
|
994
|
-
#
|
995
|
-
# <note markdown="1"> If you specify a waypoint position that's not located on a road,
|
996
|
-
# Amazon Location [moves the position to the nearest road][1].
|
997
|
-
#
|
998
|
-
# Specifying more than 23 waypoints returns a `400 ValidationException`
|
999
|
-
# error.
|
998
|
+
# @option params [Time,DateTime,Date,Integer,String] :arrival_time
|
999
|
+
# Specifies the desired time of arrival. Uses the given time to
|
1000
|
+
# calculate the route. Otherwise, the best time of day to travel with
|
1001
|
+
# the best traffic conditions is used to calculate the route.
|
1000
1002
|
#
|
1001
|
-
#
|
1002
|
-
# that is longer than 400 km returns a `400 RoutesValidationException`
|
1003
|
-
# error.
|
1003
|
+
# <note markdown="1"> ArrivalTime is not supported Esri.
|
1004
1004
|
#
|
1005
1005
|
# </note>
|
1006
1006
|
#
|
1007
|
-
#
|
1007
|
+
# @option params [String] :optimize_for
|
1008
|
+
# Specifies the distance to optimize for when calculating a route.
|
1009
|
+
#
|
1010
|
+
# @option params [String] :key
|
1011
|
+
# The optional [API key][1] to authorize the request.
|
1008
1012
|
#
|
1009
1013
|
#
|
1010
1014
|
#
|
1011
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/
|
1015
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
1012
1016
|
#
|
1013
1017
|
# @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1014
1018
|
#
|
@@ -1018,66 +1022,66 @@ module Aws::LocationService
|
|
1018
1022
|
# @example Request syntax with placeholder values
|
1019
1023
|
#
|
1020
1024
|
# resp = client.calculate_route({
|
1021
|
-
# arrival_time: Time.now,
|
1022
1025
|
# calculator_name: "ResourceName", # required
|
1023
|
-
# car_mode_options: {
|
1024
|
-
# avoid_ferries: false,
|
1025
|
-
# avoid_tolls: false,
|
1026
|
-
# },
|
1027
|
-
# depart_now: false,
|
1028
1026
|
# departure_position: [1.0], # required
|
1029
|
-
# departure_time: Time.now,
|
1030
1027
|
# destination_position: [1.0], # required
|
1028
|
+
# waypoint_positions: [
|
1029
|
+
# [1.0],
|
1030
|
+
# ],
|
1031
|
+
# travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle
|
1032
|
+
# departure_time: Time.now,
|
1033
|
+
# depart_now: false,
|
1031
1034
|
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
1032
1035
|
# include_leg_geometry: false,
|
1033
|
-
#
|
1034
|
-
#
|
1035
|
-
#
|
1036
|
+
# car_mode_options: {
|
1037
|
+
# avoid_ferries: false,
|
1038
|
+
# avoid_tolls: false,
|
1039
|
+
# },
|
1036
1040
|
# truck_mode_options: {
|
1037
1041
|
# avoid_ferries: false,
|
1038
1042
|
# avoid_tolls: false,
|
1039
1043
|
# dimensions: {
|
1040
|
-
# height: 1.0,
|
1041
1044
|
# length: 1.0,
|
1042
|
-
#
|
1045
|
+
# height: 1.0,
|
1043
1046
|
# width: 1.0,
|
1047
|
+
# unit: "Meters", # accepts Meters, Feet
|
1044
1048
|
# },
|
1045
1049
|
# weight: {
|
1046
1050
|
# total: 1.0,
|
1047
1051
|
# unit: "Kilograms", # accepts Kilograms, Pounds
|
1048
1052
|
# },
|
1049
1053
|
# },
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1054
|
+
# arrival_time: Time.now,
|
1055
|
+
# optimize_for: "FastestRoute", # accepts FastestRoute, ShortestRoute
|
1056
|
+
# key: "ApiKey",
|
1053
1057
|
# })
|
1054
1058
|
#
|
1055
1059
|
# @example Response structure
|
1056
1060
|
#
|
1057
1061
|
# resp.legs #=> Array
|
1058
|
-
# resp.legs[0].
|
1059
|
-
# resp.legs[0].
|
1062
|
+
# resp.legs[0].start_position #=> Array
|
1063
|
+
# resp.legs[0].start_position[0] #=> Float
|
1060
1064
|
# resp.legs[0].end_position #=> Array
|
1061
1065
|
# resp.legs[0].end_position[0] #=> Float
|
1066
|
+
# resp.legs[0].distance #=> Float
|
1067
|
+
# resp.legs[0].duration_seconds #=> Float
|
1062
1068
|
# resp.legs[0].geometry.line_string #=> Array
|
1063
1069
|
# resp.legs[0].geometry.line_string[0] #=> Array
|
1064
1070
|
# resp.legs[0].geometry.line_string[0][0] #=> Float
|
1065
|
-
# resp.legs[0].start_position #=> Array
|
1066
|
-
# resp.legs[0].start_position[0] #=> Float
|
1067
1071
|
# resp.legs[0].steps #=> Array
|
1068
|
-
# resp.legs[0].steps[0].
|
1069
|
-
# resp.legs[0].steps[0].
|
1072
|
+
# resp.legs[0].steps[0].start_position #=> Array
|
1073
|
+
# resp.legs[0].steps[0].start_position[0] #=> Float
|
1070
1074
|
# resp.legs[0].steps[0].end_position #=> Array
|
1071
1075
|
# resp.legs[0].steps[0].end_position[0] #=> Float
|
1076
|
+
# resp.legs[0].steps[0].distance #=> Float
|
1077
|
+
# resp.legs[0].steps[0].duration_seconds #=> Float
|
1072
1078
|
# resp.legs[0].steps[0].geometry_offset #=> Integer
|
1073
|
-
# resp.
|
1074
|
-
# resp.
|
1079
|
+
# resp.summary.route_b_box #=> Array
|
1080
|
+
# resp.summary.route_b_box[0] #=> Float
|
1075
1081
|
# resp.summary.data_source #=> String
|
1076
1082
|
# resp.summary.distance #=> Float
|
1077
|
-
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
1078
1083
|
# resp.summary.duration_seconds #=> Float
|
1079
|
-
# resp.summary.
|
1080
|
-
# resp.summary.route_b_box[0] #=> Float
|
1084
|
+
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
1081
1085
|
#
|
1082
1086
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRoute AWS API Documentation
|
1083
1087
|
#
|
@@ -1137,22 +1141,6 @@ module Aws::LocationService
|
|
1137
1141
|
# The name of the route calculator resource that you want to use to
|
1138
1142
|
# calculate the route matrix.
|
1139
1143
|
#
|
1140
|
-
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
1141
|
-
# Specifies route preferences when traveling by `Car`, such as avoiding
|
1142
|
-
# routes that use ferries or tolls.
|
1143
|
-
#
|
1144
|
-
# Requirements: `TravelMode` must be specified as `Car`.
|
1145
|
-
#
|
1146
|
-
# @option params [Boolean] :depart_now
|
1147
|
-
# Sets the time of departure as the current time. Uses the current time
|
1148
|
-
# to calculate the route matrix. You can't set both `DepartureTime` and
|
1149
|
-
# `DepartNow`. If neither is set, the best time of day to travel with
|
1150
|
-
# the best traffic conditions is used to calculate the route matrix.
|
1151
|
-
#
|
1152
|
-
# Default Value: `false`
|
1153
|
-
#
|
1154
|
-
# Valid Values: `false` \| `true`
|
1155
|
-
#
|
1156
1144
|
# @option params [required, Array<Array>] :departure_positions
|
1157
1145
|
# The list of departure (origin) positions for the route matrix. An
|
1158
1146
|
# array of points, each of which is itself a 2-value array defined in
|
@@ -1179,26 +1167,6 @@ module Aws::LocationService
|
|
1179
1167
|
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
|
1180
1168
|
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
1181
1169
|
#
|
1182
|
-
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
1183
|
-
# Specifies the desired time of departure. Uses the given time to
|
1184
|
-
# calculate the route matrix. You can't set both `DepartureTime` and
|
1185
|
-
# `DepartNow`. If neither is set, the best time of day to travel with
|
1186
|
-
# the best traffic conditions is used to calculate the route matrix.
|
1187
|
-
#
|
1188
|
-
# <note markdown="1"> Setting a departure time in the past returns a `400
|
1189
|
-
# ValidationException` error.
|
1190
|
-
#
|
1191
|
-
# </note>
|
1192
|
-
#
|
1193
|
-
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
1194
|
-
# `2020–07-2T12:15:20.000Z+01:00`
|
1195
|
-
#
|
1196
|
-
# ^
|
1197
|
-
#
|
1198
|
-
#
|
1199
|
-
#
|
1200
|
-
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1201
|
-
#
|
1202
1170
|
# @option params [required, Array<Array>] :destination_positions
|
1203
1171
|
# The list of destination positions for the route matrix. An array of
|
1204
1172
|
# points, each of which is itself a 2-value array defined in [WGS 84][1]
|
@@ -1224,18 +1192,6 @@ module Aws::LocationService
|
|
1224
1192
|
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
|
1225
1193
|
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
1226
1194
|
#
|
1227
|
-
# @option params [String] :distance_unit
|
1228
|
-
# Set the unit system to specify the distance.
|
1229
|
-
#
|
1230
|
-
# Default Value: `Kilometers`
|
1231
|
-
#
|
1232
|
-
# @option params [String] :key
|
1233
|
-
# The optional [API key][1] to authorize the request.
|
1234
|
-
#
|
1235
|
-
#
|
1236
|
-
#
|
1237
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
1238
|
-
#
|
1239
1195
|
# @option params [String] :travel_mode
|
1240
1196
|
# Specifies the mode of transport when calculating a route. Used in
|
1241
1197
|
# estimating the speed of travel and road compatibility.
|
@@ -1263,6 +1219,47 @@ module Aws::LocationService
|
|
1263
1219
|
#
|
1264
1220
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
|
1265
1221
|
#
|
1222
|
+
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
1223
|
+
# Specifies the desired time of departure. Uses the given time to
|
1224
|
+
# calculate the route matrix. You can't set both `DepartureTime` and
|
1225
|
+
# `DepartNow`. If neither is set, the best time of day to travel with
|
1226
|
+
# the best traffic conditions is used to calculate the route matrix.
|
1227
|
+
#
|
1228
|
+
# <note markdown="1"> Setting a departure time in the past returns a `400
|
1229
|
+
# ValidationException` error.
|
1230
|
+
#
|
1231
|
+
# </note>
|
1232
|
+
#
|
1233
|
+
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
1234
|
+
# `2020–07-2T12:15:20.000Z+01:00`
|
1235
|
+
#
|
1236
|
+
# ^
|
1237
|
+
#
|
1238
|
+
#
|
1239
|
+
#
|
1240
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1241
|
+
#
|
1242
|
+
# @option params [Boolean] :depart_now
|
1243
|
+
# Sets the time of departure as the current time. Uses the current time
|
1244
|
+
# to calculate the route matrix. You can't set both `DepartureTime` and
|
1245
|
+
# `DepartNow`. If neither is set, the best time of day to travel with
|
1246
|
+
# the best traffic conditions is used to calculate the route matrix.
|
1247
|
+
#
|
1248
|
+
# Default Value: `false`
|
1249
|
+
#
|
1250
|
+
# Valid Values: `false` \| `true`
|
1251
|
+
#
|
1252
|
+
# @option params [String] :distance_unit
|
1253
|
+
# Set the unit system to specify the distance.
|
1254
|
+
#
|
1255
|
+
# Default Value: `Kilometers`
|
1256
|
+
#
|
1257
|
+
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
1258
|
+
# Specifies route preferences when traveling by `Car`, such as avoiding
|
1259
|
+
# routes that use ferries or tolls.
|
1260
|
+
#
|
1261
|
+
# Requirements: `TravelMode` must be specified as `Car`.
|
1262
|
+
#
|
1266
1263
|
# @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
|
1267
1264
|
# Specifies route preferences when traveling by `Truck`, such as
|
1268
1265
|
# avoiding routes that use ferries or tolls, and truck specifications to
|
@@ -1270,6 +1267,13 @@ module Aws::LocationService
|
|
1270
1267
|
#
|
1271
1268
|
# Requirements: `TravelMode` must be specified as `Truck`.
|
1272
1269
|
#
|
1270
|
+
# @option params [String] :key
|
1271
|
+
# The optional [API key][1] to authorize the request.
|
1272
|
+
#
|
1273
|
+
#
|
1274
|
+
#
|
1275
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
1276
|
+
#
|
1273
1277
|
# @return [Types::CalculateRouteMatrixResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1274
1278
|
#
|
1275
1279
|
# * {Types::CalculateRouteMatrixResponse#route_matrix #route_matrix} => Array<Array<Types::RouteMatrixEntry>>
|
@@ -1281,35 +1285,35 @@ module Aws::LocationService
|
|
1281
1285
|
#
|
1282
1286
|
# resp = client.calculate_route_matrix({
|
1283
1287
|
# calculator_name: "ResourceName", # required
|
1284
|
-
# car_mode_options: {
|
1285
|
-
# avoid_ferries: false,
|
1286
|
-
# avoid_tolls: false,
|
1287
|
-
# },
|
1288
|
-
# depart_now: false,
|
1289
1288
|
# departure_positions: [ # required
|
1290
1289
|
# [1.0],
|
1291
1290
|
# ],
|
1292
|
-
# departure_time: Time.now,
|
1293
1291
|
# destination_positions: [ # required
|
1294
1292
|
# [1.0],
|
1295
1293
|
# ],
|
1296
|
-
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
1297
|
-
# key: "ApiKey",
|
1298
1294
|
# travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle
|
1295
|
+
# departure_time: Time.now,
|
1296
|
+
# depart_now: false,
|
1297
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
1298
|
+
# car_mode_options: {
|
1299
|
+
# avoid_ferries: false,
|
1300
|
+
# avoid_tolls: false,
|
1301
|
+
# },
|
1299
1302
|
# truck_mode_options: {
|
1300
1303
|
# avoid_ferries: false,
|
1301
1304
|
# avoid_tolls: false,
|
1302
1305
|
# dimensions: {
|
1303
|
-
# height: 1.0,
|
1304
1306
|
# length: 1.0,
|
1305
|
-
#
|
1307
|
+
# height: 1.0,
|
1306
1308
|
# width: 1.0,
|
1309
|
+
# unit: "Meters", # accepts Meters, Feet
|
1307
1310
|
# },
|
1308
1311
|
# weight: {
|
1309
1312
|
# total: 1.0,
|
1310
1313
|
# unit: "Kilograms", # accepts Kilograms, Pounds
|
1311
1314
|
# },
|
1312
1315
|
# },
|
1316
|
+
# key: "ApiKey",
|
1313
1317
|
# })
|
1314
1318
|
#
|
1315
1319
|
# @example Response structure
|
@@ -1327,9 +1331,9 @@ module Aws::LocationService
|
|
1327
1331
|
# resp.snapped_destination_positions[0] #=> Array
|
1328
1332
|
# resp.snapped_destination_positions[0][0] #=> Float
|
1329
1333
|
# resp.summary.data_source #=> String
|
1330
|
-
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
1331
|
-
# resp.summary.error_count #=> Integer
|
1332
1334
|
# resp.summary.route_count #=> Integer
|
1335
|
+
# resp.summary.error_count #=> Integer
|
1336
|
+
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
1333
1337
|
#
|
1334
1338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix AWS API Documentation
|
1335
1339
|
#
|
@@ -1354,17 +1358,6 @@ module Aws::LocationService
|
|
1354
1358
|
#
|
1355
1359
|
# * No spaces allowed. For example, `ExampleGeofenceCollection`.
|
1356
1360
|
#
|
1357
|
-
# @option params [String] :description
|
1358
|
-
# An optional description for the geofence collection.
|
1359
|
-
#
|
1360
|
-
# @option params [String] :kms_key_id
|
1361
|
-
# A key identifier for an [Amazon Web Services KMS customer managed
|
1362
|
-
# key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
|
1363
|
-
#
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1367
|
-
#
|
1368
1361
|
# @option params [String] :pricing_plan
|
1369
1362
|
# No longer used. If included, the only allowed value is
|
1370
1363
|
# `RequestBasedUsage`.
|
@@ -1372,6 +1365,9 @@ module Aws::LocationService
|
|
1372
1365
|
# @option params [String] :pricing_plan_data_source
|
1373
1366
|
# This parameter is no longer used.
|
1374
1367
|
#
|
1368
|
+
# @option params [String] :description
|
1369
|
+
# An optional description for the geofence collection.
|
1370
|
+
#
|
1375
1371
|
# @option params [Hash<String,String>] :tags
|
1376
1372
|
# Applies one or more tags to the geofence collection. A tag is a
|
1377
1373
|
# key-value pair helps manage, identify, search, and filter your
|
@@ -1394,29 +1390,37 @@ module Aws::LocationService
|
|
1394
1390
|
#
|
1395
1391
|
# * Cannot use "aws:" as a prefix for a key.
|
1396
1392
|
#
|
1393
|
+
# @option params [String] :kms_key_id
|
1394
|
+
# A key identifier for an [Amazon Web Services KMS customer managed
|
1395
|
+
# key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
|
1396
|
+
#
|
1397
|
+
#
|
1398
|
+
#
|
1399
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1400
|
+
#
|
1397
1401
|
# @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1398
1402
|
#
|
1399
|
-
# * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
1400
1403
|
# * {Types::CreateGeofenceCollectionResponse#collection_name #collection_name} => String
|
1404
|
+
# * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
1401
1405
|
# * {Types::CreateGeofenceCollectionResponse#create_time #create_time} => Time
|
1402
1406
|
#
|
1403
1407
|
# @example Request syntax with placeholder values
|
1404
1408
|
#
|
1405
1409
|
# resp = client.create_geofence_collection({
|
1406
1410
|
# collection_name: "ResourceName", # required
|
1407
|
-
# description: "ResourceDescription",
|
1408
|
-
# kms_key_id: "KmsKeyId",
|
1409
1411
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1410
1412
|
# pricing_plan_data_source: "String",
|
1413
|
+
# description: "ResourceDescription",
|
1411
1414
|
# tags: {
|
1412
1415
|
# "TagKey" => "TagValue",
|
1413
1416
|
# },
|
1417
|
+
# kms_key_id: "KmsKeyId",
|
1414
1418
|
# })
|
1415
1419
|
#
|
1416
1420
|
# @example Response structure
|
1417
1421
|
#
|
1418
|
-
# resp.collection_arn #=> String
|
1419
1422
|
# resp.collection_name #=> String
|
1423
|
+
# resp.collection_arn #=> String
|
1420
1424
|
# resp.create_time #=> Time
|
1421
1425
|
#
|
1422
1426
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollection AWS API Documentation
|
@@ -1440,18 +1444,6 @@ module Aws::LocationService
|
|
1440
1444
|
#
|
1441
1445
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
1442
1446
|
#
|
1443
|
-
# @option params [String] :description
|
1444
|
-
# An optional description for the API key resource.
|
1445
|
-
#
|
1446
|
-
# @option params [Time,DateTime,Date,Integer,String] :expire_time
|
1447
|
-
# The optional timestamp for when the API key resource will expire in [
|
1448
|
-
# ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. One of `NoExpiry` or
|
1449
|
-
# `ExpireTime` must be set.
|
1450
|
-
#
|
1451
|
-
#
|
1452
|
-
#
|
1453
|
-
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1454
|
-
#
|
1455
1447
|
# @option params [required, String] :key_name
|
1456
1448
|
# A custom name for the API key resource.
|
1457
1449
|
#
|
@@ -1464,13 +1456,25 @@ module Aws::LocationService
|
|
1464
1456
|
#
|
1465
1457
|
# * No spaces allowed. For example, `ExampleAPIKey`.
|
1466
1458
|
#
|
1459
|
+
# @option params [required, Types::ApiKeyRestrictions] :restrictions
|
1460
|
+
# The API key restrictions for the API key resource.
|
1461
|
+
#
|
1462
|
+
# @option params [String] :description
|
1463
|
+
# An optional description for the API key resource.
|
1464
|
+
#
|
1465
|
+
# @option params [Time,DateTime,Date,Integer,String] :expire_time
|
1466
|
+
# The optional timestamp for when the API key resource will expire in [
|
1467
|
+
# ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. One of `NoExpiry` or
|
1468
|
+
# `ExpireTime` must be set.
|
1469
|
+
#
|
1470
|
+
#
|
1471
|
+
#
|
1472
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1473
|
+
#
|
1467
1474
|
# @option params [Boolean] :no_expiry
|
1468
1475
|
# Optionally set to `true` to set no expiration time for the API key.
|
1469
1476
|
# One of `NoExpiry` or `ExpireTime` must be set.
|
1470
1477
|
#
|
1471
|
-
# @option params [required, Types::ApiKeyRestrictions] :restrictions
|
1472
|
-
# The API key restrictions for the API key resource.
|
1473
|
-
#
|
1474
1478
|
# @option params [Hash<String,String>] :tags
|
1475
1479
|
# Applies one or more tags to the map resource. A tag is a key-value
|
1476
1480
|
# pair that helps manage, identify, search, and filter your resources by
|
@@ -1495,23 +1499,23 @@ module Aws::LocationService
|
|
1495
1499
|
#
|
1496
1500
|
# @return [Types::CreateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1497
1501
|
#
|
1498
|
-
# * {Types::CreateKeyResponse#create_time #create_time} => Time
|
1499
1502
|
# * {Types::CreateKeyResponse#key #key} => String
|
1500
1503
|
# * {Types::CreateKeyResponse#key_arn #key_arn} => String
|
1501
1504
|
# * {Types::CreateKeyResponse#key_name #key_name} => String
|
1505
|
+
# * {Types::CreateKeyResponse#create_time #create_time} => Time
|
1502
1506
|
#
|
1503
1507
|
# @example Request syntax with placeholder values
|
1504
1508
|
#
|
1505
1509
|
# resp = client.create_key({
|
1506
|
-
# description: "ResourceDescription",
|
1507
|
-
# expire_time: Time.now,
|
1508
1510
|
# key_name: "ResourceName", # required
|
1509
|
-
# no_expiry: false,
|
1510
1511
|
# restrictions: { # required
|
1511
1512
|
# allow_actions: ["ApiKeyAction"], # required
|
1513
|
+
# allow_resources: ["GeoArnV2"], # required
|
1512
1514
|
# allow_referers: ["RefererPattern"],
|
1513
|
-
# allow_resources: ["GeoArn"], # required
|
1514
1515
|
# },
|
1516
|
+
# description: "ResourceDescription",
|
1517
|
+
# expire_time: Time.now,
|
1518
|
+
# no_expiry: false,
|
1515
1519
|
# tags: {
|
1516
1520
|
# "TagKey" => "TagValue",
|
1517
1521
|
# },
|
@@ -1519,10 +1523,10 @@ module Aws::LocationService
|
|
1519
1523
|
#
|
1520
1524
|
# @example Response structure
|
1521
1525
|
#
|
1522
|
-
# resp.create_time #=> Time
|
1523
1526
|
# resp.key #=> String
|
1524
1527
|
# resp.key_arn #=> String
|
1525
1528
|
# resp.key_name #=> String
|
1529
|
+
# resp.create_time #=> Time
|
1526
1530
|
#
|
1527
1531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateKey AWS API Documentation
|
1528
1532
|
#
|
@@ -1548,14 +1552,6 @@ module Aws::LocationService
|
|
1548
1552
|
#
|
1549
1553
|
# [1]: http://aws.amazon.com/service-terms
|
1550
1554
|
#
|
1551
|
-
# @option params [required, Types::MapConfiguration] :configuration
|
1552
|
-
# Specifies the `MapConfiguration`, including the map style, for the map
|
1553
|
-
# resource that you create. The map style defines the look of maps and
|
1554
|
-
# the data provider for your map resource.
|
1555
|
-
#
|
1556
|
-
# @option params [String] :description
|
1557
|
-
# An optional description for the map resource.
|
1558
|
-
#
|
1559
1555
|
# @option params [required, String] :map_name
|
1560
1556
|
# The name for the map resource.
|
1561
1557
|
#
|
@@ -1568,10 +1564,18 @@ module Aws::LocationService
|
|
1568
1564
|
#
|
1569
1565
|
# * No spaces allowed. For example, `ExampleMap`.
|
1570
1566
|
#
|
1567
|
+
# @option params [required, Types::MapConfiguration] :configuration
|
1568
|
+
# Specifies the `MapConfiguration`, including the map style, for the map
|
1569
|
+
# resource that you create. The map style defines the look of maps and
|
1570
|
+
# the data provider for your map resource.
|
1571
|
+
#
|
1571
1572
|
# @option params [String] :pricing_plan
|
1572
1573
|
# No longer used. If included, the only allowed value is
|
1573
1574
|
# `RequestBasedUsage`.
|
1574
1575
|
#
|
1576
|
+
# @option params [String] :description
|
1577
|
+
# An optional description for the map resource.
|
1578
|
+
#
|
1575
1579
|
# @option params [Hash<String,String>] :tags
|
1576
1580
|
# Applies one or more tags to the map resource. A tag is a key-value
|
1577
1581
|
# pair helps manage, identify, search, and filter your resources by
|
@@ -1596,21 +1600,21 @@ module Aws::LocationService
|
|
1596
1600
|
#
|
1597
1601
|
# @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1598
1602
|
#
|
1599
|
-
# * {Types::CreateMapResponse#create_time #create_time} => Time
|
1600
|
-
# * {Types::CreateMapResponse#map_arn #map_arn} => String
|
1601
1603
|
# * {Types::CreateMapResponse#map_name #map_name} => String
|
1604
|
+
# * {Types::CreateMapResponse#map_arn #map_arn} => String
|
1605
|
+
# * {Types::CreateMapResponse#create_time #create_time} => Time
|
1602
1606
|
#
|
1603
1607
|
# @example Request syntax with placeholder values
|
1604
1608
|
#
|
1605
1609
|
# resp = client.create_map({
|
1610
|
+
# map_name: "ResourceName", # required
|
1606
1611
|
# configuration: { # required
|
1607
|
-
# custom_layers: ["CustomLayer"],
|
1608
|
-
# political_view: "CountryCode3",
|
1609
1612
|
# style: "MapStyle", # required
|
1613
|
+
# political_view: "CountryCode3",
|
1614
|
+
# custom_layers: ["CustomLayer"],
|
1610
1615
|
# },
|
1611
|
-
# description: "ResourceDescription",
|
1612
|
-
# map_name: "ResourceName", # required
|
1613
1616
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1617
|
+
# description: "ResourceDescription",
|
1614
1618
|
# tags: {
|
1615
1619
|
# "TagKey" => "TagValue",
|
1616
1620
|
# },
|
@@ -1618,9 +1622,9 @@ module Aws::LocationService
|
|
1618
1622
|
#
|
1619
1623
|
# @example Response structure
|
1620
1624
|
#
|
1621
|
-
# resp.create_time #=> Time
|
1622
|
-
# resp.map_arn #=> String
|
1623
1625
|
# resp.map_name #=> String
|
1626
|
+
# resp.map_arn #=> String
|
1627
|
+
# resp.create_time #=> Time
|
1624
1628
|
#
|
1625
1629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMap AWS API Documentation
|
1626
1630
|
#
|
@@ -1649,8 +1653,20 @@ module Aws::LocationService
|
|
1649
1653
|
#
|
1650
1654
|
# [1]: http://aws.amazon.com/service-terms
|
1651
1655
|
#
|
1652
|
-
# @option params [required, String] :
|
1653
|
-
#
|
1656
|
+
# @option params [required, String] :index_name
|
1657
|
+
# The name of the place index resource.
|
1658
|
+
#
|
1659
|
+
# Requirements:
|
1660
|
+
#
|
1661
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
1662
|
+
# periods (.), and underscores (\_).
|
1663
|
+
#
|
1664
|
+
# * Must be a unique place index resource name.
|
1665
|
+
#
|
1666
|
+
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
1667
|
+
#
|
1668
|
+
# @option params [required, String] :data_source
|
1669
|
+
# Specifies the geospatial data provider for the new place index.
|
1654
1670
|
#
|
1655
1671
|
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1656
1672
|
# example, entering `HERE` returns an error.
|
@@ -1691,27 +1707,15 @@ module Aws::LocationService
|
|
1691
1707
|
# [8]: http://aws.amazon.com/service-terms/
|
1692
1708
|
# [9]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
1693
1709
|
#
|
1694
|
-
# @option params [
|
1695
|
-
#
|
1710
|
+
# @option params [String] :pricing_plan
|
1711
|
+
# No longer used. If included, the only allowed value is
|
1712
|
+
# `RequestBasedUsage`.
|
1696
1713
|
#
|
1697
1714
|
# @option params [String] :description
|
1698
1715
|
# The optional description for the place index resource.
|
1699
1716
|
#
|
1700
|
-
# @option params [
|
1701
|
-
#
|
1702
|
-
#
|
1703
|
-
# Requirements:
|
1704
|
-
#
|
1705
|
-
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
1706
|
-
# periods (.), and underscores (\_).
|
1707
|
-
#
|
1708
|
-
# * Must be a unique place index resource name.
|
1709
|
-
#
|
1710
|
-
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
1711
|
-
#
|
1712
|
-
# @option params [String] :pricing_plan
|
1713
|
-
# No longer used. If included, the only allowed value is
|
1714
|
-
# `RequestBasedUsage`.
|
1717
|
+
# @option params [Types::DataSourceConfiguration] :data_source_configuration
|
1718
|
+
# Specifies the data storage option requesting Places.
|
1715
1719
|
#
|
1716
1720
|
# @option params [Hash<String,String>] :tags
|
1717
1721
|
# Applies one or more tags to the place index resource. A tag is a
|
@@ -1738,20 +1742,20 @@ module Aws::LocationService
|
|
1738
1742
|
#
|
1739
1743
|
# @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1740
1744
|
#
|
1741
|
-
# * {Types::CreatePlaceIndexResponse#create_time #create_time} => Time
|
1742
|
-
# * {Types::CreatePlaceIndexResponse#index_arn #index_arn} => String
|
1743
1745
|
# * {Types::CreatePlaceIndexResponse#index_name #index_name} => String
|
1746
|
+
# * {Types::CreatePlaceIndexResponse#index_arn #index_arn} => String
|
1747
|
+
# * {Types::CreatePlaceIndexResponse#create_time #create_time} => Time
|
1744
1748
|
#
|
1745
1749
|
# @example Request syntax with placeholder values
|
1746
1750
|
#
|
1747
1751
|
# resp = client.create_place_index({
|
1752
|
+
# index_name: "ResourceName", # required
|
1748
1753
|
# data_source: "String", # required
|
1754
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1755
|
+
# description: "ResourceDescription",
|
1749
1756
|
# data_source_configuration: {
|
1750
1757
|
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
1751
1758
|
# },
|
1752
|
-
# description: "ResourceDescription",
|
1753
|
-
# index_name: "ResourceName", # required
|
1754
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1755
1759
|
# tags: {
|
1756
1760
|
# "TagKey" => "TagValue",
|
1757
1761
|
# },
|
@@ -1759,9 +1763,9 @@ module Aws::LocationService
|
|
1759
1763
|
#
|
1760
1764
|
# @example Response structure
|
1761
1765
|
#
|
1762
|
-
# resp.create_time #=> Time
|
1763
|
-
# resp.index_arn #=> String
|
1764
1766
|
# resp.index_name #=> String
|
1767
|
+
# resp.index_arn #=> String
|
1768
|
+
# resp.create_time #=> Time
|
1765
1769
|
#
|
1766
1770
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndex AWS API Documentation
|
1767
1771
|
#
|
@@ -1841,13 +1845,13 @@ module Aws::LocationService
|
|
1841
1845
|
# [7]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html
|
1842
1846
|
# [8]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
1843
1847
|
#
|
1844
|
-
# @option params [String] :description
|
1845
|
-
# The optional description for the route calculator resource.
|
1846
|
-
#
|
1847
1848
|
# @option params [String] :pricing_plan
|
1848
1849
|
# No longer used. If included, the only allowed value is
|
1849
1850
|
# `RequestBasedUsage`.
|
1850
1851
|
#
|
1852
|
+
# @option params [String] :description
|
1853
|
+
# The optional description for the route calculator resource.
|
1854
|
+
#
|
1851
1855
|
# @option params [Hash<String,String>] :tags
|
1852
1856
|
# Applies one or more tags to the route calculator resource. A tag is a
|
1853
1857
|
# key-value pair helps manage, identify, search, and filter your
|
@@ -1876,8 +1880,8 @@ module Aws::LocationService
|
|
1876
1880
|
#
|
1877
1881
|
# @return [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1878
1882
|
#
|
1879
|
-
# * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
1880
1883
|
# * {Types::CreateRouteCalculatorResponse#calculator_name #calculator_name} => String
|
1884
|
+
# * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
1881
1885
|
# * {Types::CreateRouteCalculatorResponse#create_time #create_time} => Time
|
1882
1886
|
#
|
1883
1887
|
# @example Request syntax with placeholder values
|
@@ -1885,8 +1889,8 @@ module Aws::LocationService
|
|
1885
1889
|
# resp = client.create_route_calculator({
|
1886
1890
|
# calculator_name: "ResourceName", # required
|
1887
1891
|
# data_source: "String", # required
|
1888
|
-
# description: "ResourceDescription",
|
1889
1892
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1893
|
+
# description: "ResourceDescription",
|
1890
1894
|
# tags: {
|
1891
1895
|
# "TagKey" => "TagValue",
|
1892
1896
|
# },
|
@@ -1894,8 +1898,8 @@ module Aws::LocationService
|
|
1894
1898
|
#
|
1895
1899
|
# @example Response structure
|
1896
1900
|
#
|
1897
|
-
# resp.calculator_arn #=> String
|
1898
1901
|
# resp.calculator_name #=> String
|
1902
|
+
# resp.calculator_arn #=> String
|
1899
1903
|
# resp.create_time #=> Time
|
1900
1904
|
#
|
1901
1905
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculator AWS API Documentation
|
@@ -1910,50 +1914,57 @@ module Aws::LocationService
|
|
1910
1914
|
# Creates a tracker resource in your Amazon Web Services account, which
|
1911
1915
|
# lets you retrieve current and historical location of devices.
|
1912
1916
|
#
|
1913
|
-
# @option params [String] :
|
1914
|
-
#
|
1917
|
+
# @option params [required, String] :tracker_name
|
1918
|
+
# The name for the tracker resource.
|
1915
1919
|
#
|
1916
|
-
#
|
1917
|
-
# Whether to enable position `UPDATE` events from this tracker to be
|
1918
|
-
# sent to EventBridge.
|
1920
|
+
# Requirements:
|
1919
1921
|
#
|
1920
|
-
#
|
1921
|
-
#
|
1922
|
-
# EventBridge.
|
1922
|
+
# * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-),
|
1923
|
+
# periods (.), and underscores (\_).
|
1923
1924
|
#
|
1924
|
-
#
|
1925
|
+
# * Must be a unique tracker resource name.
|
1925
1926
|
#
|
1926
|
-
#
|
1927
|
-
# Enables `GeospatialQueries` for a tracker that uses a [Amazon Web
|
1928
|
-
# Services KMS customer managed key][1].
|
1927
|
+
# * No spaces allowed. For example, `ExampleTracker`.
|
1929
1928
|
#
|
1930
|
-
#
|
1931
|
-
#
|
1929
|
+
# @option params [String] :pricing_plan
|
1930
|
+
# No longer used. If included, the only allowed value is
|
1931
|
+
# `RequestBasedUsage`.
|
1932
1932
|
#
|
1933
|
-
#
|
1934
|
-
# key
|
1935
|
-
#
|
1936
|
-
# your device positions will not be encrypted using the your KMS managed
|
1937
|
-
# key. The exact device position, however; is still encrypted using your
|
1938
|
-
# managed key.
|
1933
|
+
# @option params [String] :kms_key_id
|
1934
|
+
# A key identifier for an [Amazon Web Services KMS customer managed
|
1935
|
+
# key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
|
1939
1936
|
#
|
1940
|
-
# You can choose to opt-in to the Bounding Polygon Quseries feature.
|
1941
|
-
# This is done by setting the `KmsKeyEnableGeospatialQueries` parameter
|
1942
|
-
# to true when creating or updating a Tracker.
|
1943
1937
|
#
|
1944
|
-
# </note>
|
1945
1938
|
#
|
1939
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1946
1940
|
#
|
1941
|
+
# @option params [String] :pricing_plan_data_source
|
1942
|
+
# This parameter is no longer used.
|
1947
1943
|
#
|
1948
|
-
#
|
1944
|
+
# @option params [String] :description
|
1945
|
+
# An optional description for the tracker resource.
|
1949
1946
|
#
|
1950
|
-
# @option params [String] :
|
1951
|
-
#
|
1952
|
-
#
|
1947
|
+
# @option params [Hash<String,String>] :tags
|
1948
|
+
# Applies one or more tags to the tracker resource. A tag is a key-value
|
1949
|
+
# pair helps manage, identify, search, and filter your resources by
|
1950
|
+
# labelling them.
|
1953
1951
|
#
|
1952
|
+
# Format: `"key" : "value"`
|
1954
1953
|
#
|
1954
|
+
# Restrictions:
|
1955
1955
|
#
|
1956
|
-
#
|
1956
|
+
# * Maximum 50 tags per resource
|
1957
|
+
#
|
1958
|
+
# * Each resource tag must be unique with a maximum of one value.
|
1959
|
+
#
|
1960
|
+
# * Maximum key length: 128 Unicode characters in UTF-8
|
1961
|
+
#
|
1962
|
+
# * Maximum value length: 256 Unicode characters in UTF-8
|
1963
|
+
#
|
1964
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1965
|
+
# characters: + - = . \_ : / @.
|
1966
|
+
#
|
1967
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1957
1968
|
#
|
1958
1969
|
# @option params [String] :position_filtering
|
1959
1970
|
# Specifies the position filtering for the tracker resource.
|
@@ -1986,74 +1997,67 @@ module Aws::LocationService
|
|
1986
1997
|
# This field is optional. If not specified, the default value is
|
1987
1998
|
# `TimeBased`.
|
1988
1999
|
#
|
1989
|
-
# @option params [
|
1990
|
-
#
|
1991
|
-
#
|
1992
|
-
#
|
1993
|
-
# @option params [String] :pricing_plan_data_source
|
1994
|
-
# This parameter is no longer used.
|
1995
|
-
#
|
1996
|
-
# @option params [Hash<String,String>] :tags
|
1997
|
-
# Applies one or more tags to the tracker resource. A tag is a key-value
|
1998
|
-
# pair helps manage, identify, search, and filter your resources by
|
1999
|
-
# labelling them.
|
2000
|
-
#
|
2001
|
-
# Format: `"key" : "value"`
|
2002
|
-
#
|
2003
|
-
# Restrictions:
|
2004
|
-
#
|
2005
|
-
# * Maximum 50 tags per resource
|
2000
|
+
# @option params [Boolean] :event_bridge_enabled
|
2001
|
+
# Whether to enable position `UPDATE` events from this tracker to be
|
2002
|
+
# sent to EventBridge.
|
2006
2003
|
#
|
2007
|
-
#
|
2004
|
+
# <note markdown="1"> You do not need enable this feature to get `ENTER` and `EXIT` events
|
2005
|
+
# for geofences with this tracker. Those events are always sent to
|
2006
|
+
# EventBridge.
|
2008
2007
|
#
|
2009
|
-
#
|
2008
|
+
# </note>
|
2010
2009
|
#
|
2011
|
-
#
|
2010
|
+
# @option params [Boolean] :kms_key_enable_geospatial_queries
|
2011
|
+
# Enables `GeospatialQueries` for a tracker that uses a [Amazon Web
|
2012
|
+
# Services KMS customer managed key][1].
|
2012
2013
|
#
|
2013
|
-
#
|
2014
|
-
#
|
2014
|
+
# This parameter is only used if you are using a KMS customer managed
|
2015
|
+
# key.
|
2015
2016
|
#
|
2016
|
-
#
|
2017
|
+
# <note markdown="1"> If you wish to encrypt your data using your own KMS customer managed
|
2018
|
+
# key, then the Bounding Polygon Queries feature will be disabled by
|
2019
|
+
# default. This is because by using this feature, a representation of
|
2020
|
+
# your device positions will not be encrypted using the your KMS managed
|
2021
|
+
# key. The exact device position, however; is still encrypted using your
|
2022
|
+
# managed key.
|
2017
2023
|
#
|
2018
|
-
#
|
2019
|
-
#
|
2024
|
+
# You can choose to opt-in to the Bounding Polygon Quseries feature.
|
2025
|
+
# This is done by setting the `KmsKeyEnableGeospatialQueries` parameter
|
2026
|
+
# to true when creating or updating a Tracker.
|
2020
2027
|
#
|
2021
|
-
#
|
2028
|
+
# </note>
|
2022
2029
|
#
|
2023
|
-
# * Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-),
|
2024
|
-
# periods (.), and underscores (\_).
|
2025
2030
|
#
|
2026
|
-
# * Must be a unique tracker resource name.
|
2027
2031
|
#
|
2028
|
-
#
|
2032
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
2029
2033
|
#
|
2030
2034
|
# @return [Types::CreateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2031
2035
|
#
|
2032
|
-
# * {Types::CreateTrackerResponse#create_time #create_time} => Time
|
2033
|
-
# * {Types::CreateTrackerResponse#tracker_arn #tracker_arn} => String
|
2034
2036
|
# * {Types::CreateTrackerResponse#tracker_name #tracker_name} => String
|
2037
|
+
# * {Types::CreateTrackerResponse#tracker_arn #tracker_arn} => String
|
2038
|
+
# * {Types::CreateTrackerResponse#create_time #create_time} => Time
|
2035
2039
|
#
|
2036
2040
|
# @example Request syntax with placeholder values
|
2037
2041
|
#
|
2038
2042
|
# resp = client.create_tracker({
|
2039
|
-
#
|
2040
|
-
# event_bridge_enabled: false,
|
2041
|
-
# kms_key_enable_geospatial_queries: false,
|
2042
|
-
# kms_key_id: "KmsKeyId",
|
2043
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
2043
|
+
# tracker_name: "ResourceName", # required
|
2044
2044
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
2045
|
+
# kms_key_id: "KmsKeyId",
|
2045
2046
|
# pricing_plan_data_source: "String",
|
2047
|
+
# description: "ResourceDescription",
|
2046
2048
|
# tags: {
|
2047
2049
|
# "TagKey" => "TagValue",
|
2048
2050
|
# },
|
2049
|
-
#
|
2051
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
2052
|
+
# event_bridge_enabled: false,
|
2053
|
+
# kms_key_enable_geospatial_queries: false,
|
2050
2054
|
# })
|
2051
2055
|
#
|
2052
2056
|
# @example Response structure
|
2053
2057
|
#
|
2054
|
-
# resp.create_time #=> Time
|
2055
|
-
# resp.tracker_arn #=> String
|
2056
2058
|
# resp.tracker_name #=> String
|
2059
|
+
# resp.tracker_arn #=> String
|
2060
|
+
# resp.create_time #=> Time
|
2057
2061
|
#
|
2058
2062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateTracker AWS API Documentation
|
2059
2063
|
#
|
@@ -2095,6 +2099,9 @@ module Aws::LocationService
|
|
2095
2099
|
# Deletes the specified API key. The API key must have been deactivated
|
2096
2100
|
# more than 90 days previously.
|
2097
2101
|
#
|
2102
|
+
# @option params [required, String] :key_name
|
2103
|
+
# The name of the API key to delete.
|
2104
|
+
#
|
2098
2105
|
# @option params [Boolean] :force_delete
|
2099
2106
|
# ForceDelete bypasses an API key's expiry conditions and deletes the
|
2100
2107
|
# key. Set the parameter `true` to delete the key or to `false` to not
|
@@ -2109,16 +2116,13 @@ module Aws::LocationService
|
|
2109
2116
|
#
|
2110
2117
|
# </note>
|
2111
2118
|
#
|
2112
|
-
# @option params [required, String] :key_name
|
2113
|
-
# The name of the API key to delete.
|
2114
|
-
#
|
2115
2119
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2116
2120
|
#
|
2117
2121
|
# @example Request syntax with placeholder values
|
2118
2122
|
#
|
2119
2123
|
# resp = client.delete_key({
|
2120
|
-
# force_delete: false,
|
2121
2124
|
# key_name: "ResourceName", # required
|
2125
|
+
# force_delete: false,
|
2122
2126
|
# })
|
2123
2127
|
#
|
2124
2128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKey AWS API Documentation
|
@@ -2245,16 +2249,16 @@ module Aws::LocationService
|
|
2245
2249
|
#
|
2246
2250
|
# @return [Types::DescribeGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2247
2251
|
#
|
2248
|
-
# * {Types::DescribeGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
2249
2252
|
# * {Types::DescribeGeofenceCollectionResponse#collection_name #collection_name} => String
|
2250
|
-
# * {Types::DescribeGeofenceCollectionResponse#
|
2253
|
+
# * {Types::DescribeGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
2251
2254
|
# * {Types::DescribeGeofenceCollectionResponse#description #description} => String
|
2252
|
-
# * {Types::DescribeGeofenceCollectionResponse#geofence_count #geofence_count} => Integer
|
2253
|
-
# * {Types::DescribeGeofenceCollectionResponse#kms_key_id #kms_key_id} => String
|
2254
2255
|
# * {Types::DescribeGeofenceCollectionResponse#pricing_plan #pricing_plan} => String
|
2255
2256
|
# * {Types::DescribeGeofenceCollectionResponse#pricing_plan_data_source #pricing_plan_data_source} => String
|
2257
|
+
# * {Types::DescribeGeofenceCollectionResponse#kms_key_id #kms_key_id} => String
|
2256
2258
|
# * {Types::DescribeGeofenceCollectionResponse#tags #tags} => Hash<String,String>
|
2259
|
+
# * {Types::DescribeGeofenceCollectionResponse#create_time #create_time} => Time
|
2257
2260
|
# * {Types::DescribeGeofenceCollectionResponse#update_time #update_time} => Time
|
2261
|
+
# * {Types::DescribeGeofenceCollectionResponse#geofence_count #geofence_count} => Integer
|
2258
2262
|
#
|
2259
2263
|
# @example Request syntax with placeholder values
|
2260
2264
|
#
|
@@ -2264,17 +2268,17 @@ module Aws::LocationService
|
|
2264
2268
|
#
|
2265
2269
|
# @example Response structure
|
2266
2270
|
#
|
2267
|
-
# resp.collection_arn #=> String
|
2268
2271
|
# resp.collection_name #=> String
|
2269
|
-
# resp.
|
2272
|
+
# resp.collection_arn #=> String
|
2270
2273
|
# resp.description #=> String
|
2271
|
-
# resp.geofence_count #=> Integer
|
2272
|
-
# resp.kms_key_id #=> String
|
2273
2274
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2274
2275
|
# resp.pricing_plan_data_source #=> String
|
2276
|
+
# resp.kms_key_id #=> String
|
2275
2277
|
# resp.tags #=> Hash
|
2276
2278
|
# resp.tags["TagKey"] #=> String
|
2279
|
+
# resp.create_time #=> Time
|
2277
2280
|
# resp.update_time #=> Time
|
2281
|
+
# resp.geofence_count #=> Integer
|
2278
2282
|
#
|
2279
2283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeGeofenceCollection AWS API Documentation
|
2280
2284
|
#
|
@@ -2292,15 +2296,15 @@ module Aws::LocationService
|
|
2292
2296
|
#
|
2293
2297
|
# @return [Types::DescribeKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2294
2298
|
#
|
2295
|
-
# * {Types::DescribeKeyResponse#create_time #create_time} => Time
|
2296
|
-
# * {Types::DescribeKeyResponse#description #description} => String
|
2297
|
-
# * {Types::DescribeKeyResponse#expire_time #expire_time} => Time
|
2298
2299
|
# * {Types::DescribeKeyResponse#key #key} => String
|
2299
2300
|
# * {Types::DescribeKeyResponse#key_arn #key_arn} => String
|
2300
2301
|
# * {Types::DescribeKeyResponse#key_name #key_name} => String
|
2301
2302
|
# * {Types::DescribeKeyResponse#restrictions #restrictions} => Types::ApiKeyRestrictions
|
2302
|
-
# * {Types::DescribeKeyResponse#
|
2303
|
+
# * {Types::DescribeKeyResponse#create_time #create_time} => Time
|
2304
|
+
# * {Types::DescribeKeyResponse#expire_time #expire_time} => Time
|
2303
2305
|
# * {Types::DescribeKeyResponse#update_time #update_time} => Time
|
2306
|
+
# * {Types::DescribeKeyResponse#description #description} => String
|
2307
|
+
# * {Types::DescribeKeyResponse#tags #tags} => Hash<String,String>
|
2304
2308
|
#
|
2305
2309
|
# @example Request syntax with placeholder values
|
2306
2310
|
#
|
@@ -2310,21 +2314,21 @@ module Aws::LocationService
|
|
2310
2314
|
#
|
2311
2315
|
# @example Response structure
|
2312
2316
|
#
|
2313
|
-
# resp.create_time #=> Time
|
2314
|
-
# resp.description #=> String
|
2315
|
-
# resp.expire_time #=> Time
|
2316
2317
|
# resp.key #=> String
|
2317
2318
|
# resp.key_arn #=> String
|
2318
2319
|
# resp.key_name #=> String
|
2319
2320
|
# resp.restrictions.allow_actions #=> Array
|
2320
2321
|
# resp.restrictions.allow_actions[0] #=> String
|
2321
|
-
# resp.restrictions.allow_referers #=> Array
|
2322
|
-
# resp.restrictions.allow_referers[0] #=> String
|
2323
2322
|
# resp.restrictions.allow_resources #=> Array
|
2324
2323
|
# resp.restrictions.allow_resources[0] #=> String
|
2324
|
+
# resp.restrictions.allow_referers #=> Array
|
2325
|
+
# resp.restrictions.allow_referers[0] #=> String
|
2326
|
+
# resp.create_time #=> Time
|
2327
|
+
# resp.expire_time #=> Time
|
2328
|
+
# resp.update_time #=> Time
|
2329
|
+
# resp.description #=> String
|
2325
2330
|
# resp.tags #=> Hash
|
2326
2331
|
# resp.tags["TagKey"] #=> String
|
2327
|
-
# resp.update_time #=> Time
|
2328
2332
|
#
|
2329
2333
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeKey AWS API Documentation
|
2330
2334
|
#
|
@@ -2342,14 +2346,14 @@ module Aws::LocationService
|
|
2342
2346
|
#
|
2343
2347
|
# @return [Types::DescribeMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2344
2348
|
#
|
2345
|
-
# * {Types::DescribeMapResponse#configuration #configuration} => Types::MapConfiguration
|
2346
|
-
# * {Types::DescribeMapResponse#create_time #create_time} => Time
|
2347
|
-
# * {Types::DescribeMapResponse#data_source #data_source} => String
|
2348
|
-
# * {Types::DescribeMapResponse#description #description} => String
|
2349
|
-
# * {Types::DescribeMapResponse#map_arn #map_arn} => String
|
2350
2349
|
# * {Types::DescribeMapResponse#map_name #map_name} => String
|
2350
|
+
# * {Types::DescribeMapResponse#map_arn #map_arn} => String
|
2351
2351
|
# * {Types::DescribeMapResponse#pricing_plan #pricing_plan} => String
|
2352
|
+
# * {Types::DescribeMapResponse#data_source #data_source} => String
|
2353
|
+
# * {Types::DescribeMapResponse#configuration #configuration} => Types::MapConfiguration
|
2354
|
+
# * {Types::DescribeMapResponse#description #description} => String
|
2352
2355
|
# * {Types::DescribeMapResponse#tags #tags} => Hash<String,String>
|
2356
|
+
# * {Types::DescribeMapResponse#create_time #create_time} => Time
|
2353
2357
|
# * {Types::DescribeMapResponse#update_time #update_time} => Time
|
2354
2358
|
#
|
2355
2359
|
# @example Request syntax with placeholder values
|
@@ -2360,18 +2364,18 @@ module Aws::LocationService
|
|
2360
2364
|
#
|
2361
2365
|
# @example Response structure
|
2362
2366
|
#
|
2363
|
-
# resp.configuration.custom_layers #=> Array
|
2364
|
-
# resp.configuration.custom_layers[0] #=> String
|
2365
|
-
# resp.configuration.political_view #=> String
|
2366
|
-
# resp.configuration.style #=> String
|
2367
|
-
# resp.create_time #=> Time
|
2368
|
-
# resp.data_source #=> String
|
2369
|
-
# resp.description #=> String
|
2370
|
-
# resp.map_arn #=> String
|
2371
2367
|
# resp.map_name #=> String
|
2368
|
+
# resp.map_arn #=> String
|
2372
2369
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2370
|
+
# resp.data_source #=> String
|
2371
|
+
# resp.configuration.style #=> String
|
2372
|
+
# resp.configuration.political_view #=> String
|
2373
|
+
# resp.configuration.custom_layers #=> Array
|
2374
|
+
# resp.configuration.custom_layers[0] #=> String
|
2375
|
+
# resp.description #=> String
|
2373
2376
|
# resp.tags #=> Hash
|
2374
2377
|
# resp.tags["TagKey"] #=> String
|
2378
|
+
# resp.create_time #=> Time
|
2375
2379
|
# resp.update_time #=> Time
|
2376
2380
|
#
|
2377
2381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeMap AWS API Documentation
|
@@ -2390,15 +2394,15 @@ module Aws::LocationService
|
|
2390
2394
|
#
|
2391
2395
|
# @return [Types::DescribePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2392
2396
|
#
|
2397
|
+
# * {Types::DescribePlaceIndexResponse#index_name #index_name} => String
|
2398
|
+
# * {Types::DescribePlaceIndexResponse#index_arn #index_arn} => String
|
2399
|
+
# * {Types::DescribePlaceIndexResponse#pricing_plan #pricing_plan} => String
|
2400
|
+
# * {Types::DescribePlaceIndexResponse#description #description} => String
|
2393
2401
|
# * {Types::DescribePlaceIndexResponse#create_time #create_time} => Time
|
2402
|
+
# * {Types::DescribePlaceIndexResponse#update_time #update_time} => Time
|
2394
2403
|
# * {Types::DescribePlaceIndexResponse#data_source #data_source} => String
|
2395
2404
|
# * {Types::DescribePlaceIndexResponse#data_source_configuration #data_source_configuration} => Types::DataSourceConfiguration
|
2396
|
-
# * {Types::DescribePlaceIndexResponse#description #description} => String
|
2397
|
-
# * {Types::DescribePlaceIndexResponse#index_arn #index_arn} => String
|
2398
|
-
# * {Types::DescribePlaceIndexResponse#index_name #index_name} => String
|
2399
|
-
# * {Types::DescribePlaceIndexResponse#pricing_plan #pricing_plan} => String
|
2400
2405
|
# * {Types::DescribePlaceIndexResponse#tags #tags} => Hash<String,String>
|
2401
|
-
# * {Types::DescribePlaceIndexResponse#update_time #update_time} => Time
|
2402
2406
|
#
|
2403
2407
|
# @example Request syntax with placeholder values
|
2404
2408
|
#
|
@@ -2408,16 +2412,16 @@ module Aws::LocationService
|
|
2408
2412
|
#
|
2409
2413
|
# @example Response structure
|
2410
2414
|
#
|
2415
|
+
# resp.index_name #=> String
|
2416
|
+
# resp.index_arn #=> String
|
2417
|
+
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2418
|
+
# resp.description #=> String
|
2411
2419
|
# resp.create_time #=> Time
|
2420
|
+
# resp.update_time #=> Time
|
2412
2421
|
# resp.data_source #=> String
|
2413
2422
|
# resp.data_source_configuration.intended_use #=> String, one of "SingleUse", "Storage"
|
2414
|
-
# resp.description #=> String
|
2415
|
-
# resp.index_arn #=> String
|
2416
|
-
# resp.index_name #=> String
|
2417
|
-
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2418
2423
|
# resp.tags #=> Hash
|
2419
2424
|
# resp.tags["TagKey"] #=> String
|
2420
|
-
# resp.update_time #=> Time
|
2421
2425
|
#
|
2422
2426
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribePlaceIndex AWS API Documentation
|
2423
2427
|
#
|
@@ -2435,14 +2439,14 @@ module Aws::LocationService
|
|
2435
2439
|
#
|
2436
2440
|
# @return [Types::DescribeRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2437
2441
|
#
|
2438
|
-
# * {Types::DescribeRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
2439
2442
|
# * {Types::DescribeRouteCalculatorResponse#calculator_name #calculator_name} => String
|
2443
|
+
# * {Types::DescribeRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
2444
|
+
# * {Types::DescribeRouteCalculatorResponse#pricing_plan #pricing_plan} => String
|
2445
|
+
# * {Types::DescribeRouteCalculatorResponse#description #description} => String
|
2440
2446
|
# * {Types::DescribeRouteCalculatorResponse#create_time #create_time} => Time
|
2447
|
+
# * {Types::DescribeRouteCalculatorResponse#update_time #update_time} => Time
|
2441
2448
|
# * {Types::DescribeRouteCalculatorResponse#data_source #data_source} => String
|
2442
|
-
# * {Types::DescribeRouteCalculatorResponse#description #description} => String
|
2443
|
-
# * {Types::DescribeRouteCalculatorResponse#pricing_plan #pricing_plan} => String
|
2444
2449
|
# * {Types::DescribeRouteCalculatorResponse#tags #tags} => Hash<String,String>
|
2445
|
-
# * {Types::DescribeRouteCalculatorResponse#update_time #update_time} => Time
|
2446
2450
|
#
|
2447
2451
|
# @example Request syntax with placeholder values
|
2448
2452
|
#
|
@@ -2452,15 +2456,15 @@ module Aws::LocationService
|
|
2452
2456
|
#
|
2453
2457
|
# @example Response structure
|
2454
2458
|
#
|
2455
|
-
# resp.calculator_arn #=> String
|
2456
2459
|
# resp.calculator_name #=> String
|
2460
|
+
# resp.calculator_arn #=> String
|
2461
|
+
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2462
|
+
# resp.description #=> String
|
2457
2463
|
# resp.create_time #=> Time
|
2464
|
+
# resp.update_time #=> Time
|
2458
2465
|
# resp.data_source #=> String
|
2459
|
-
# resp.description #=> String
|
2460
|
-
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2461
2466
|
# resp.tags #=> Hash
|
2462
2467
|
# resp.tags["TagKey"] #=> String
|
2463
|
-
# resp.update_time #=> Time
|
2464
2468
|
#
|
2465
2469
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeRouteCalculator AWS API Documentation
|
2466
2470
|
#
|
@@ -2478,18 +2482,18 @@ module Aws::LocationService
|
|
2478
2482
|
#
|
2479
2483
|
# @return [Types::DescribeTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2480
2484
|
#
|
2481
|
-
# * {Types::DescribeTrackerResponse#
|
2485
|
+
# * {Types::DescribeTrackerResponse#tracker_name #tracker_name} => String
|
2486
|
+
# * {Types::DescribeTrackerResponse#tracker_arn #tracker_arn} => String
|
2482
2487
|
# * {Types::DescribeTrackerResponse#description #description} => String
|
2483
|
-
# * {Types::DescribeTrackerResponse#event_bridge_enabled #event_bridge_enabled} => Boolean
|
2484
|
-
# * {Types::DescribeTrackerResponse#kms_key_enable_geospatial_queries #kms_key_enable_geospatial_queries} => Boolean
|
2485
|
-
# * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String
|
2486
|
-
# * {Types::DescribeTrackerResponse#position_filtering #position_filtering} => String
|
2487
2488
|
# * {Types::DescribeTrackerResponse#pricing_plan #pricing_plan} => String
|
2488
2489
|
# * {Types::DescribeTrackerResponse#pricing_plan_data_source #pricing_plan_data_source} => String
|
2489
2490
|
# * {Types::DescribeTrackerResponse#tags #tags} => Hash<String,String>
|
2490
|
-
# * {Types::DescribeTrackerResponse#
|
2491
|
-
# * {Types::DescribeTrackerResponse#tracker_name #tracker_name} => String
|
2491
|
+
# * {Types::DescribeTrackerResponse#create_time #create_time} => Time
|
2492
2492
|
# * {Types::DescribeTrackerResponse#update_time #update_time} => Time
|
2493
|
+
# * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String
|
2494
|
+
# * {Types::DescribeTrackerResponse#position_filtering #position_filtering} => String
|
2495
|
+
# * {Types::DescribeTrackerResponse#event_bridge_enabled #event_bridge_enabled} => Boolean
|
2496
|
+
# * {Types::DescribeTrackerResponse#kms_key_enable_geospatial_queries #kms_key_enable_geospatial_queries} => Boolean
|
2493
2497
|
#
|
2494
2498
|
# @example Request syntax with placeholder values
|
2495
2499
|
#
|
@@ -2499,19 +2503,19 @@ module Aws::LocationService
|
|
2499
2503
|
#
|
2500
2504
|
# @example Response structure
|
2501
2505
|
#
|
2502
|
-
# resp.
|
2506
|
+
# resp.tracker_name #=> String
|
2507
|
+
# resp.tracker_arn #=> String
|
2503
2508
|
# resp.description #=> String
|
2504
|
-
# resp.event_bridge_enabled #=> Boolean
|
2505
|
-
# resp.kms_key_enable_geospatial_queries #=> Boolean
|
2506
|
-
# resp.kms_key_id #=> String
|
2507
|
-
# resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased"
|
2508
2509
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
2509
2510
|
# resp.pricing_plan_data_source #=> String
|
2510
2511
|
# resp.tags #=> Hash
|
2511
2512
|
# resp.tags["TagKey"] #=> String
|
2512
|
-
# resp.
|
2513
|
-
# resp.tracker_name #=> String
|
2513
|
+
# resp.create_time #=> Time
|
2514
2514
|
# resp.update_time #=> Time
|
2515
|
+
# resp.kms_key_id #=> String
|
2516
|
+
# resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased"
|
2517
|
+
# resp.event_bridge_enabled #=> Boolean
|
2518
|
+
# resp.kms_key_enable_geospatial_queries #=> Boolean
|
2515
2519
|
#
|
2516
2520
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeTracker AWS API Documentation
|
2517
2521
|
#
|
@@ -2531,6 +2535,9 @@ module Aws::LocationService
|
|
2531
2535
|
#
|
2532
2536
|
# </note>
|
2533
2537
|
#
|
2538
|
+
# @option params [required, String] :tracker_name
|
2539
|
+
# The name of the tracker resource to be dissociated from the consumer.
|
2540
|
+
#
|
2534
2541
|
# @option params [required, String] :consumer_arn
|
2535
2542
|
# The Amazon Resource Name (ARN) for the geofence collection to be
|
2536
2543
|
# disassociated from the tracker resource. Used when you need to specify
|
@@ -2541,16 +2548,13 @@ module Aws::LocationService
|
|
2541
2548
|
#
|
2542
2549
|
# ^
|
2543
2550
|
#
|
2544
|
-
# @option params [required, String] :tracker_name
|
2545
|
-
# The name of the tracker resource to be dissociated from the consumer.
|
2546
|
-
#
|
2547
2551
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2548
2552
|
#
|
2549
2553
|
# @example Request syntax with placeholder values
|
2550
2554
|
#
|
2551
2555
|
# resp = client.disassociate_tracker_consumer({
|
2552
|
-
# consumer_arn: "Arn", # required
|
2553
2556
|
# tracker_name: "ResourceName", # required
|
2557
|
+
# consumer_arn: "Arn", # required
|
2554
2558
|
# })
|
2555
2559
|
#
|
2556
2560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DisassociateTrackerConsumer AWS API Documentation
|
@@ -2562,6 +2566,106 @@ module Aws::LocationService
|
|
2562
2566
|
req.send_request(options)
|
2563
2567
|
end
|
2564
2568
|
|
2569
|
+
# Evaluates device positions against geofence geometries from a given
|
2570
|
+
# geofence collection. The event forecasts three states for which a
|
2571
|
+
# device can be in relative to a geofence:
|
2572
|
+
#
|
2573
|
+
# `ENTER`: If a device is outside of a geofence, but would breach the
|
2574
|
+
# fence if the device is moving at its current speed within time horizon
|
2575
|
+
# window.
|
2576
|
+
#
|
2577
|
+
# `EXIT`: If a device is inside of a geofence, but would breach the
|
2578
|
+
# fence if the device is moving at its current speed within time horizon
|
2579
|
+
# window.
|
2580
|
+
#
|
2581
|
+
# `IDLE`: If a device is inside of a geofence, and the device is not
|
2582
|
+
# moving.
|
2583
|
+
#
|
2584
|
+
# @option params [required, String] :collection_name
|
2585
|
+
# The name of the geofence collection.
|
2586
|
+
#
|
2587
|
+
# @option params [required, Types::ForecastGeofenceEventsDeviceState] :device_state
|
2588
|
+
# The device's state, including current position and speed.
|
2589
|
+
#
|
2590
|
+
# @option params [Float] :time_horizon_minutes
|
2591
|
+
# Specifies the time horizon in minutes for the forecasted events.
|
2592
|
+
#
|
2593
|
+
# @option params [String] :distance_unit
|
2594
|
+
# The distance unit used for the `NearestDistance` property returned in
|
2595
|
+
# a forecasted event. The measurement system must match for
|
2596
|
+
# `DistanceUnit` and `SpeedUnit`; if `Kilometers` is specified for
|
2597
|
+
# `DistanceUnit`, then `SpeedUnit` must be `KilometersPerHour`.
|
2598
|
+
#
|
2599
|
+
# Default Value: `Kilometers`
|
2600
|
+
#
|
2601
|
+
# @option params [String] :speed_unit
|
2602
|
+
# The speed unit for the device captured by the device state. The
|
2603
|
+
# measurement system must match for `DistanceUnit` and `SpeedUnit`; if
|
2604
|
+
# `Kilometers` is specified for `DistanceUnit`, then `SpeedUnit` must be
|
2605
|
+
# `KilometersPerHour`.
|
2606
|
+
#
|
2607
|
+
# Default Value: `KilometersPerHour`.
|
2608
|
+
#
|
2609
|
+
# @option params [String] :next_token
|
2610
|
+
# The pagination token specifying which page of results to return in the
|
2611
|
+
# response. If no token is provided, the default page is the first page.
|
2612
|
+
#
|
2613
|
+
# Default value: `null`
|
2614
|
+
#
|
2615
|
+
# @option params [Integer] :max_results
|
2616
|
+
# An optional limit for the number of resources returned in a single
|
2617
|
+
# call.
|
2618
|
+
#
|
2619
|
+
# Default value: `20`
|
2620
|
+
#
|
2621
|
+
# @return [Types::ForecastGeofenceEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2622
|
+
#
|
2623
|
+
# * {Types::ForecastGeofenceEventsResponse#forecasted_events #forecasted_events} => Array<Types::ForecastedEvent>
|
2624
|
+
# * {Types::ForecastGeofenceEventsResponse#next_token #next_token} => String
|
2625
|
+
# * {Types::ForecastGeofenceEventsResponse#distance_unit #distance_unit} => String
|
2626
|
+
# * {Types::ForecastGeofenceEventsResponse#speed_unit #speed_unit} => String
|
2627
|
+
#
|
2628
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2629
|
+
#
|
2630
|
+
# @example Request syntax with placeholder values
|
2631
|
+
#
|
2632
|
+
# resp = client.forecast_geofence_events({
|
2633
|
+
# collection_name: "ResourceName", # required
|
2634
|
+
# device_state: { # required
|
2635
|
+
# position: [1.0], # required
|
2636
|
+
# speed: 1.0,
|
2637
|
+
# },
|
2638
|
+
# time_horizon_minutes: 1.0,
|
2639
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
2640
|
+
# speed_unit: "KilometersPerHour", # accepts KilometersPerHour, MilesPerHour
|
2641
|
+
# next_token: "LargeToken",
|
2642
|
+
# max_results: 1,
|
2643
|
+
# })
|
2644
|
+
#
|
2645
|
+
# @example Response structure
|
2646
|
+
#
|
2647
|
+
# resp.forecasted_events #=> Array
|
2648
|
+
# resp.forecasted_events[0].event_id #=> String
|
2649
|
+
# resp.forecasted_events[0].geofence_id #=> String
|
2650
|
+
# resp.forecasted_events[0].is_device_in_geofence #=> Boolean
|
2651
|
+
# resp.forecasted_events[0].nearest_distance #=> Float
|
2652
|
+
# resp.forecasted_events[0].event_type #=> String, one of "ENTER", "EXIT", "IDLE"
|
2653
|
+
# resp.forecasted_events[0].forecasted_breach_time #=> Time
|
2654
|
+
# resp.forecasted_events[0].geofence_properties #=> Hash
|
2655
|
+
# resp.forecasted_events[0].geofence_properties["PropertyMapKeyString"] #=> String
|
2656
|
+
# resp.next_token #=> String
|
2657
|
+
# resp.distance_unit #=> String, one of "Kilometers", "Miles"
|
2658
|
+
# resp.speed_unit #=> String, one of "KilometersPerHour", "MilesPerHour"
|
2659
|
+
#
|
2660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ForecastGeofenceEvents AWS API Documentation
|
2661
|
+
#
|
2662
|
+
# @overload forecast_geofence_events(params = {})
|
2663
|
+
# @param [Hash] params ({})
|
2664
|
+
def forecast_geofence_events(params = {}, options = {})
|
2665
|
+
req = build_request(:forecast_geofence_events, params)
|
2666
|
+
req.send_request(options)
|
2667
|
+
end
|
2668
|
+
|
2565
2669
|
# Retrieves a device's most recent position according to its sample
|
2566
2670
|
# time.
|
2567
2671
|
#
|
@@ -2569,38 +2673,38 @@ module Aws::LocationService
|
|
2569
2673
|
#
|
2570
2674
|
# </note>
|
2571
2675
|
#
|
2572
|
-
# @option params [required, String] :device_id
|
2573
|
-
# The device whose position you want to retrieve.
|
2574
|
-
#
|
2575
2676
|
# @option params [required, String] :tracker_name
|
2576
2677
|
# The tracker resource receiving the position update.
|
2577
2678
|
#
|
2679
|
+
# @option params [required, String] :device_id
|
2680
|
+
# The device whose position you want to retrieve.
|
2681
|
+
#
|
2578
2682
|
# @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2579
2683
|
#
|
2580
|
-
# * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy
|
2581
2684
|
# * {Types::GetDevicePositionResponse#device_id #device_id} => String
|
2685
|
+
# * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time
|
2686
|
+
# * {Types::GetDevicePositionResponse#received_time #received_time} => Time
|
2582
2687
|
# * {Types::GetDevicePositionResponse#position #position} => Array<Float>
|
2688
|
+
# * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy
|
2583
2689
|
# * {Types::GetDevicePositionResponse#position_properties #position_properties} => Hash<String,String>
|
2584
|
-
# * {Types::GetDevicePositionResponse#received_time #received_time} => Time
|
2585
|
-
# * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time
|
2586
2690
|
#
|
2587
2691
|
# @example Request syntax with placeholder values
|
2588
2692
|
#
|
2589
2693
|
# resp = client.get_device_position({
|
2590
|
-
# device_id: "Id", # required
|
2591
2694
|
# tracker_name: "ResourceName", # required
|
2695
|
+
# device_id: "Id", # required
|
2592
2696
|
# })
|
2593
2697
|
#
|
2594
2698
|
# @example Response structure
|
2595
2699
|
#
|
2596
|
-
# resp.accuracy.horizontal #=> Float
|
2597
2700
|
# resp.device_id #=> String
|
2701
|
+
# resp.sample_time #=> Time
|
2702
|
+
# resp.received_time #=> Time
|
2598
2703
|
# resp.position #=> Array
|
2599
2704
|
# resp.position[0] #=> Float
|
2705
|
+
# resp.accuracy.horizontal #=> Float
|
2600
2706
|
# resp.position_properties #=> Hash
|
2601
2707
|
# resp.position_properties["PropertyMapKeyString"] #=> String
|
2602
|
-
# resp.received_time #=> Time
|
2603
|
-
# resp.sample_time #=> Time
|
2604
2708
|
#
|
2605
2709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePosition AWS API Documentation
|
2606
2710
|
#
|
@@ -2618,31 +2722,13 @@ module Aws::LocationService
|
|
2618
2722
|
#
|
2619
2723
|
# </note>
|
2620
2724
|
#
|
2725
|
+
# @option params [required, String] :tracker_name
|
2726
|
+
# The tracker resource receiving the request for the device position
|
2727
|
+
# history.
|
2728
|
+
#
|
2621
2729
|
# @option params [required, String] :device_id
|
2622
2730
|
# The device whose position history you want to retrieve.
|
2623
2731
|
#
|
2624
|
-
# @option params [Time,DateTime,Date,Integer,String] :end_time_exclusive
|
2625
|
-
# Specify the end time for the position history in [ ISO 8601][1]
|
2626
|
-
# format: `YYYY-MM-DDThh:mm:ss.sssZ`. By default, the value will be the
|
2627
|
-
# time that the request is made.
|
2628
|
-
#
|
2629
|
-
# Requirement:
|
2630
|
-
#
|
2631
|
-
# * The time specified for `EndTimeExclusive` must be after the time for
|
2632
|
-
# `StartTimeInclusive`.
|
2633
|
-
#
|
2634
|
-
# ^
|
2635
|
-
#
|
2636
|
-
#
|
2637
|
-
#
|
2638
|
-
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
2639
|
-
#
|
2640
|
-
# @option params [Integer] :max_results
|
2641
|
-
# An optional limit for the number of device positions returned in a
|
2642
|
-
# single call.
|
2643
|
-
#
|
2644
|
-
# Default value: `100`
|
2645
|
-
#
|
2646
2732
|
# @option params [String] :next_token
|
2647
2733
|
# The pagination token specifying which page of results to return in the
|
2648
2734
|
# response. If no token is provided, the default page is the first page.
|
@@ -2665,9 +2751,27 @@ module Aws::LocationService
|
|
2665
2751
|
#
|
2666
2752
|
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
2667
2753
|
#
|
2668
|
-
# @option params [
|
2669
|
-
#
|
2670
|
-
#
|
2754
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_time_exclusive
|
2755
|
+
# Specify the end time for the position history in [ ISO 8601][1]
|
2756
|
+
# format: `YYYY-MM-DDThh:mm:ss.sssZ`. By default, the value will be the
|
2757
|
+
# time that the request is made.
|
2758
|
+
#
|
2759
|
+
# Requirement:
|
2760
|
+
#
|
2761
|
+
# * The time specified for `EndTimeExclusive` must be after the time for
|
2762
|
+
# `StartTimeInclusive`.
|
2763
|
+
#
|
2764
|
+
# ^
|
2765
|
+
#
|
2766
|
+
#
|
2767
|
+
#
|
2768
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
2769
|
+
#
|
2770
|
+
# @option params [Integer] :max_results
|
2771
|
+
# An optional limit for the number of device positions returned in a
|
2772
|
+
# single call.
|
2773
|
+
#
|
2774
|
+
# Default value: `100`
|
2671
2775
|
#
|
2672
2776
|
# @return [Types::GetDevicePositionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2673
2777
|
#
|
@@ -2679,25 +2783,25 @@ module Aws::LocationService
|
|
2679
2783
|
# @example Request syntax with placeholder values
|
2680
2784
|
#
|
2681
2785
|
# resp = client.get_device_position_history({
|
2786
|
+
# tracker_name: "ResourceName", # required
|
2682
2787
|
# device_id: "Id", # required
|
2683
|
-
# end_time_exclusive: Time.now,
|
2684
|
-
# max_results: 1,
|
2685
2788
|
# next_token: "Token",
|
2686
2789
|
# start_time_inclusive: Time.now,
|
2687
|
-
#
|
2790
|
+
# end_time_exclusive: Time.now,
|
2791
|
+
# max_results: 1,
|
2688
2792
|
# })
|
2689
2793
|
#
|
2690
2794
|
# @example Response structure
|
2691
2795
|
#
|
2692
2796
|
# resp.device_positions #=> Array
|
2693
|
-
# resp.device_positions[0].accuracy.horizontal #=> Float
|
2694
2797
|
# resp.device_positions[0].device_id #=> String
|
2798
|
+
# resp.device_positions[0].sample_time #=> Time
|
2799
|
+
# resp.device_positions[0].received_time #=> Time
|
2695
2800
|
# resp.device_positions[0].position #=> Array
|
2696
2801
|
# resp.device_positions[0].position[0] #=> Float
|
2802
|
+
# resp.device_positions[0].accuracy.horizontal #=> Float
|
2697
2803
|
# resp.device_positions[0].position_properties #=> Hash
|
2698
2804
|
# resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
|
2699
|
-
# resp.device_positions[0].received_time #=> Time
|
2700
|
-
# resp.device_positions[0].sample_time #=> Time
|
2701
2805
|
# resp.next_token #=> String
|
2702
2806
|
#
|
2703
2807
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionHistory AWS API Documentation
|
@@ -2711,6 +2815,11 @@ module Aws::LocationService
|
|
2711
2815
|
|
2712
2816
|
# Retrieves the geofence details from a geofence collection.
|
2713
2817
|
#
|
2818
|
+
# <note markdown="1"> The returned geometry will always match the geometry format used when
|
2819
|
+
# the geofence was created.
|
2820
|
+
#
|
2821
|
+
# </note>
|
2822
|
+
#
|
2714
2823
|
# @option params [required, String] :collection_name
|
2715
2824
|
# The geofence collection storing the target geofence.
|
2716
2825
|
#
|
@@ -2719,12 +2828,12 @@ module Aws::LocationService
|
|
2719
2828
|
#
|
2720
2829
|
# @return [Types::GetGeofenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2721
2830
|
#
|
2722
|
-
# * {Types::GetGeofenceResponse#create_time #create_time} => Time
|
2723
2831
|
# * {Types::GetGeofenceResponse#geofence_id #geofence_id} => String
|
2724
|
-
# * {Types::GetGeofenceResponse#geofence_properties #geofence_properties} => Hash<String,String>
|
2725
2832
|
# * {Types::GetGeofenceResponse#geometry #geometry} => Types::GeofenceGeometry
|
2726
2833
|
# * {Types::GetGeofenceResponse#status #status} => String
|
2834
|
+
# * {Types::GetGeofenceResponse#create_time #create_time} => Time
|
2727
2835
|
# * {Types::GetGeofenceResponse#update_time #update_time} => Time
|
2836
|
+
# * {Types::GetGeofenceResponse#geofence_properties #geofence_properties} => Hash<String,String>
|
2728
2837
|
#
|
2729
2838
|
# @example Request syntax with placeholder values
|
2730
2839
|
#
|
@@ -2735,19 +2844,20 @@ module Aws::LocationService
|
|
2735
2844
|
#
|
2736
2845
|
# @example Response structure
|
2737
2846
|
#
|
2738
|
-
# resp.create_time #=> Time
|
2739
2847
|
# resp.geofence_id #=> String
|
2740
|
-
# resp.geofence_properties #=> Hash
|
2741
|
-
# resp.geofence_properties["PropertyMapKeyString"] #=> String
|
2742
|
-
# resp.geometry.circle.center #=> Array
|
2743
|
-
# resp.geometry.circle.center[0] #=> Float
|
2744
|
-
# resp.geometry.circle.radius #=> Float
|
2745
2848
|
# resp.geometry.polygon #=> Array
|
2746
2849
|
# resp.geometry.polygon[0] #=> Array
|
2747
2850
|
# resp.geometry.polygon[0][0] #=> Array
|
2748
2851
|
# resp.geometry.polygon[0][0][0] #=> Float
|
2852
|
+
# resp.geometry.circle.center #=> Array
|
2853
|
+
# resp.geometry.circle.center[0] #=> Float
|
2854
|
+
# resp.geometry.circle.radius #=> Float
|
2855
|
+
# resp.geometry.geobuf #=> String
|
2749
2856
|
# resp.status #=> String
|
2857
|
+
# resp.create_time #=> Time
|
2750
2858
|
# resp.update_time #=> Time
|
2859
|
+
# resp.geofence_properties #=> Hash
|
2860
|
+
# resp.geofence_properties["PropertyMapKeyString"] #=> String
|
2751
2861
|
#
|
2752
2862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetGeofence AWS API Documentation
|
2753
2863
|
#
|
@@ -2760,6 +2870,9 @@ module Aws::LocationService
|
|
2760
2870
|
|
2761
2871
|
# Retrieves glyphs used to display labels on a map.
|
2762
2872
|
#
|
2873
|
+
# @option params [required, String] :map_name
|
2874
|
+
# The map resource associated with the glyph file.
|
2875
|
+
#
|
2763
2876
|
# @option params [required, String] :font_stack
|
2764
2877
|
# A comma-separated list of fonts to load glyphs from in order of
|
2765
2878
|
# preference. For example, `Noto Sans Regular, Arial Unicode`.
|
@@ -2780,7 +2893,7 @@ module Aws::LocationService
|
|
2780
2893
|
# Bold`
|
2781
2894
|
#
|
2782
2895
|
# * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial
|
2783
|
-
# Bold`
|
2896
|
+
# Bold`
|
2784
2897
|
#
|
2785
2898
|
# Valid font stacks for [HERE Technologies][2] styles:
|
2786
2899
|
#
|
@@ -2843,29 +2956,26 @@ module Aws::LocationService
|
|
2843
2956
|
#
|
2844
2957
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
2845
2958
|
#
|
2846
|
-
# @option params [required, String] :map_name
|
2847
|
-
# The map resource associated with the glyph file.
|
2848
|
-
#
|
2849
2959
|
# @return [Types::GetMapGlyphsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2850
2960
|
#
|
2851
2961
|
# * {Types::GetMapGlyphsResponse#blob #blob} => IO
|
2852
|
-
# * {Types::GetMapGlyphsResponse#cache_control #cache_control} => String
|
2853
2962
|
# * {Types::GetMapGlyphsResponse#content_type #content_type} => String
|
2963
|
+
# * {Types::GetMapGlyphsResponse#cache_control #cache_control} => String
|
2854
2964
|
#
|
2855
2965
|
# @example Request syntax with placeholder values
|
2856
2966
|
#
|
2857
2967
|
# resp = client.get_map_glyphs({
|
2968
|
+
# map_name: "ResourceName", # required
|
2858
2969
|
# font_stack: "String", # required
|
2859
2970
|
# font_unicode_range: "GetMapGlyphsRequestFontUnicodeRangeString", # required
|
2860
2971
|
# key: "ApiKey",
|
2861
|
-
# map_name: "ResourceName", # required
|
2862
2972
|
# })
|
2863
2973
|
#
|
2864
2974
|
# @example Response structure
|
2865
2975
|
#
|
2866
2976
|
# resp.blob #=> IO
|
2867
|
-
# resp.cache_control #=> String
|
2868
2977
|
# resp.content_type #=> String
|
2978
|
+
# resp.cache_control #=> String
|
2869
2979
|
#
|
2870
2980
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapGlyphs AWS API Documentation
|
2871
2981
|
#
|
@@ -2880,6 +2990,9 @@ module Aws::LocationService
|
|
2880
2990
|
# sheet is a PNG image paired with a JSON document describing the
|
2881
2991
|
# offsets of individual icons that will be displayed on a rendered map.
|
2882
2992
|
#
|
2993
|
+
# @option params [required, String] :map_name
|
2994
|
+
# The map resource associated with the sprite file.
|
2995
|
+
#
|
2883
2996
|
# @option params [required, String] :file_name
|
2884
2997
|
# The name of the sprite file. Use the following file names for the sprite
|
2885
2998
|
# sheet:
|
@@ -2902,28 +3015,25 @@ module Aws::LocationService
|
|
2902
3015
|
#
|
2903
3016
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
2904
3017
|
#
|
2905
|
-
# @option params [required, String] :map_name
|
2906
|
-
# The map resource associated with the sprite file.
|
2907
|
-
#
|
2908
3018
|
# @return [Types::GetMapSpritesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2909
3019
|
#
|
2910
3020
|
# * {Types::GetMapSpritesResponse#blob #blob} => IO
|
2911
|
-
# * {Types::GetMapSpritesResponse#cache_control #cache_control} => String
|
2912
3021
|
# * {Types::GetMapSpritesResponse#content_type #content_type} => String
|
3022
|
+
# * {Types::GetMapSpritesResponse#cache_control #cache_control} => String
|
2913
3023
|
#
|
2914
3024
|
# @example Request syntax with placeholder values
|
2915
3025
|
#
|
2916
3026
|
# resp = client.get_map_sprites({
|
3027
|
+
# map_name: "ResourceName", # required
|
2917
3028
|
# file_name: "GetMapSpritesRequestFileNameString", # required
|
2918
3029
|
# key: "ApiKey",
|
2919
|
-
# map_name: "ResourceName", # required
|
2920
3030
|
# })
|
2921
3031
|
#
|
2922
3032
|
# @example Response structure
|
2923
3033
|
#
|
2924
3034
|
# resp.blob #=> IO
|
2925
|
-
# resp.cache_control #=> String
|
2926
3035
|
# resp.content_type #=> String
|
3036
|
+
# resp.cache_control #=> String
|
2927
3037
|
#
|
2928
3038
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapSprites AWS API Documentation
|
2929
3039
|
#
|
@@ -2941,6 +3051,9 @@ module Aws::LocationService
|
|
2941
3051
|
# data in, and the style for the data. Style descriptors follow the
|
2942
3052
|
# Mapbox Style Specification.
|
2943
3053
|
#
|
3054
|
+
# @option params [required, String] :map_name
|
3055
|
+
# The map resource to retrieve the style descriptor from.
|
3056
|
+
#
|
2944
3057
|
# @option params [String] :key
|
2945
3058
|
# The optional [API key][1] to authorize the request.
|
2946
3059
|
#
|
@@ -2948,27 +3061,24 @@ module Aws::LocationService
|
|
2948
3061
|
#
|
2949
3062
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
2950
3063
|
#
|
2951
|
-
# @option params [required, String] :map_name
|
2952
|
-
# The map resource to retrieve the style descriptor from.
|
2953
|
-
#
|
2954
3064
|
# @return [Types::GetMapStyleDescriptorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2955
3065
|
#
|
2956
3066
|
# * {Types::GetMapStyleDescriptorResponse#blob #blob} => IO
|
2957
|
-
# * {Types::GetMapStyleDescriptorResponse#cache_control #cache_control} => String
|
2958
3067
|
# * {Types::GetMapStyleDescriptorResponse#content_type #content_type} => String
|
3068
|
+
# * {Types::GetMapStyleDescriptorResponse#cache_control #cache_control} => String
|
2959
3069
|
#
|
2960
3070
|
# @example Request syntax with placeholder values
|
2961
3071
|
#
|
2962
3072
|
# resp = client.get_map_style_descriptor({
|
2963
|
-
# key: "ApiKey",
|
2964
3073
|
# map_name: "ResourceName", # required
|
3074
|
+
# key: "ApiKey",
|
2965
3075
|
# })
|
2966
3076
|
#
|
2967
3077
|
# @example Response structure
|
2968
3078
|
#
|
2969
3079
|
# resp.blob #=> IO
|
2970
|
-
# resp.cache_control #=> String
|
2971
3080
|
# resp.content_type #=> String
|
3081
|
+
# resp.cache_control #=> String
|
2972
3082
|
#
|
2973
3083
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptor AWS API Documentation
|
2974
3084
|
#
|
@@ -2988,46 +3098,46 @@ module Aws::LocationService
|
|
2988
3098
|
# data for the entire world at (0/0/0) will be split into 4 tiles at
|
2989
3099
|
# zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
|
2990
3100
|
#
|
2991
|
-
# @option params [String] :key
|
2992
|
-
# The optional [API key][1] to authorize the request.
|
2993
|
-
#
|
2994
|
-
#
|
2995
|
-
#
|
2996
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
2997
|
-
#
|
2998
3101
|
# @option params [required, String] :map_name
|
2999
3102
|
# The map resource to retrieve the map tiles from.
|
3000
3103
|
#
|
3104
|
+
# @option params [required, String] :z
|
3105
|
+
# The zoom value for the map tile.
|
3106
|
+
#
|
3001
3107
|
# @option params [required, String] :x
|
3002
3108
|
# The X axis value for the map tile.
|
3003
3109
|
#
|
3004
3110
|
# @option params [required, String] :y
|
3005
3111
|
# The Y axis value for the map tile.
|
3006
3112
|
#
|
3007
|
-
# @option params [
|
3008
|
-
# The
|
3113
|
+
# @option params [String] :key
|
3114
|
+
# The optional [API key][1] to authorize the request.
|
3115
|
+
#
|
3116
|
+
#
|
3117
|
+
#
|
3118
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3009
3119
|
#
|
3010
3120
|
# @return [Types::GetMapTileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3011
3121
|
#
|
3012
3122
|
# * {Types::GetMapTileResponse#blob #blob} => IO
|
3013
|
-
# * {Types::GetMapTileResponse#cache_control #cache_control} => String
|
3014
3123
|
# * {Types::GetMapTileResponse#content_type #content_type} => String
|
3124
|
+
# * {Types::GetMapTileResponse#cache_control #cache_control} => String
|
3015
3125
|
#
|
3016
3126
|
# @example Request syntax with placeholder values
|
3017
3127
|
#
|
3018
3128
|
# resp = client.get_map_tile({
|
3019
|
-
# key: "ApiKey",
|
3020
3129
|
# map_name: "ResourceName", # required
|
3130
|
+
# z: "GetMapTileRequestZString", # required
|
3021
3131
|
# x: "GetMapTileRequestXString", # required
|
3022
3132
|
# y: "GetMapTileRequestYString", # required
|
3023
|
-
#
|
3133
|
+
# key: "ApiKey",
|
3024
3134
|
# })
|
3025
3135
|
#
|
3026
3136
|
# @example Response structure
|
3027
3137
|
#
|
3028
3138
|
# resp.blob #=> IO
|
3029
|
-
# resp.cache_control #=> String
|
3030
3139
|
# resp.content_type #=> String
|
3140
|
+
# resp.cache_control #=> String
|
3031
3141
|
#
|
3032
3142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTile AWS API Documentation
|
3033
3143
|
#
|
@@ -3056,12 +3166,8 @@ module Aws::LocationService
|
|
3056
3166
|
# The name of the place index resource that you want to use for the
|
3057
3167
|
# search.
|
3058
3168
|
#
|
3059
|
-
# @option params [String] :
|
3060
|
-
# The
|
3061
|
-
#
|
3062
|
-
#
|
3063
|
-
#
|
3064
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3169
|
+
# @option params [required, String] :place_id
|
3170
|
+
# The identifier of the place to find.
|
3065
3171
|
#
|
3066
3172
|
# @option params [String] :language
|
3067
3173
|
# The preferred language used to return results. The value must be a
|
@@ -3087,41 +3193,12 @@ module Aws::LocationService
|
|
3087
3193
|
#
|
3088
3194
|
# [1]: https://tools.ietf.org/search/bcp47
|
3089
3195
|
#
|
3090
|
-
# @option params [
|
3091
|
-
# The
|
3196
|
+
# @option params [String] :key
|
3197
|
+
# The optional [API key][1] to authorize the request.
|
3198
|
+
#
|
3092
3199
|
#
|
3093
|
-
#
|
3094
|
-
#
|
3095
|
-
# consecutive API calls. Please see the following PlaceID behaviour for
|
3096
|
-
# each data provider:
|
3097
|
-
#
|
3098
|
-
# * Esri: Place IDs will change every quarter at a minimum. The typical
|
3099
|
-
# time period for these changes would be March, June, September, and
|
3100
|
-
# December. Place IDs might also change between the typical quarterly
|
3101
|
-
# change but that will be much less frequent.
|
3102
|
-
#
|
3103
|
-
# * HERE: We recommend that you cache data for no longer than a week to
|
3104
|
-
# keep your data data fresh. You can assume that less than 1% ID
|
3105
|
-
# shifts will release over release which is approximately 1 - 2 times
|
3106
|
-
# per week.
|
3107
|
-
#
|
3108
|
-
# * Grab: Place IDs can expire or become invalid in the following
|
3109
|
-
# situations.
|
3110
|
-
#
|
3111
|
-
# * Data operations: The POI may be removed from Grab POI database by
|
3112
|
-
# Grab Map Ops based on the ground-truth, such as being closed in
|
3113
|
-
# the real world, being detected as a duplicate POI, or having
|
3114
|
-
# incorrect information. Grab will synchronize data to the Waypoint
|
3115
|
-
# environment on weekly basis.
|
3116
|
-
#
|
3117
|
-
# * Interpolated POI: Interpolated POI is a temporary POI generated in
|
3118
|
-
# real time when serving a request, and it will be marked as derived
|
3119
|
-
# in the `place.result_type` field in the response. The information
|
3120
|
-
# of interpolated POIs will be retained for at least 30 days, which
|
3121
|
-
# means that within 30 days, you are able to obtain POI details by
|
3122
|
-
# Place ID from Place Details API. After 30 days, the interpolated
|
3123
|
-
# POIs(both Place ID and details) may expire and inaccessible from
|
3124
|
-
# the Places Details API.
|
3200
|
+
#
|
3201
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3125
3202
|
#
|
3126
3203
|
# @return [Types::GetPlaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3127
3204
|
#
|
@@ -3131,34 +3208,34 @@ module Aws::LocationService
|
|
3131
3208
|
#
|
3132
3209
|
# resp = client.get_place({
|
3133
3210
|
# index_name: "ResourceName", # required
|
3134
|
-
# key: "ApiKey",
|
3135
|
-
# language: "LanguageTag",
|
3136
3211
|
# place_id: "PlaceId", # required
|
3212
|
+
# language: "LanguageTag",
|
3213
|
+
# key: "ApiKey",
|
3137
3214
|
# })
|
3138
3215
|
#
|
3139
3216
|
# @example Response structure
|
3140
3217
|
#
|
3141
|
-
# resp.place.
|
3142
|
-
# resp.place.categories #=> Array
|
3143
|
-
# resp.place.categories[0] #=> String
|
3144
|
-
# resp.place.country #=> String
|
3218
|
+
# resp.place.label #=> String
|
3145
3219
|
# resp.place.geometry.point #=> Array
|
3146
3220
|
# resp.place.geometry.point[0] #=> Float
|
3147
|
-
# resp.place.
|
3148
|
-
# resp.place.label #=> String
|
3149
|
-
# resp.place.municipality #=> String
|
3150
|
-
# resp.place.neighborhood #=> String
|
3151
|
-
# resp.place.postal_code #=> String
|
3152
|
-
# resp.place.region #=> String
|
3221
|
+
# resp.place.address_number #=> String
|
3153
3222
|
# resp.place.street #=> String
|
3154
|
-
# resp.place.
|
3223
|
+
# resp.place.neighborhood #=> String
|
3224
|
+
# resp.place.municipality #=> String
|
3155
3225
|
# resp.place.sub_region #=> String
|
3156
|
-
# resp.place.
|
3157
|
-
# resp.place.
|
3226
|
+
# resp.place.region #=> String
|
3227
|
+
# resp.place.country #=> String
|
3228
|
+
# resp.place.postal_code #=> String
|
3229
|
+
# resp.place.interpolated #=> Boolean
|
3158
3230
|
# resp.place.time_zone.name #=> String
|
3159
3231
|
# resp.place.time_zone.offset #=> Integer
|
3160
|
-
# resp.place.unit_number #=> String
|
3161
3232
|
# resp.place.unit_type #=> String
|
3233
|
+
# resp.place.unit_number #=> String
|
3234
|
+
# resp.place.categories #=> Array
|
3235
|
+
# resp.place.categories[0] #=> String
|
3236
|
+
# resp.place.supplemental_categories #=> Array
|
3237
|
+
# resp.place.supplemental_categories[0] #=> String
|
3238
|
+
# resp.place.sub_municipality #=> String
|
3162
3239
|
#
|
3163
3240
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlace AWS API Documentation
|
3164
3241
|
#
|
@@ -3171,8 +3248,8 @@ module Aws::LocationService
|
|
3171
3248
|
|
3172
3249
|
# A batch request to retrieve all device positions.
|
3173
3250
|
#
|
3174
|
-
# @option params [
|
3175
|
-
# The
|
3251
|
+
# @option params [required, String] :tracker_name
|
3252
|
+
# The tracker resource containing the requested devices.
|
3176
3253
|
#
|
3177
3254
|
# @option params [Integer] :max_results
|
3178
3255
|
# An optional limit for the number of entries returned in a single call.
|
@@ -3185,8 +3262,8 @@ module Aws::LocationService
|
|
3185
3262
|
#
|
3186
3263
|
# Default value: `null`
|
3187
3264
|
#
|
3188
|
-
# @option params [
|
3189
|
-
# The
|
3265
|
+
# @option params [Types::TrackingFilterGeometry] :filter_geometry
|
3266
|
+
# The geometry used to filter device positions.
|
3190
3267
|
#
|
3191
3268
|
# @return [Types::ListDevicePositionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3192
3269
|
#
|
@@ -3198,6 +3275,9 @@ module Aws::LocationService
|
|
3198
3275
|
# @example Request syntax with placeholder values
|
3199
3276
|
#
|
3200
3277
|
# resp = client.list_device_positions({
|
3278
|
+
# tracker_name: "ResourceName", # required
|
3279
|
+
# max_results: 1,
|
3280
|
+
# next_token: "Token",
|
3201
3281
|
# filter_geometry: {
|
3202
3282
|
# polygon: [
|
3203
3283
|
# [
|
@@ -3205,21 +3285,18 @@ module Aws::LocationService
|
|
3205
3285
|
# ],
|
3206
3286
|
# ],
|
3207
3287
|
# },
|
3208
|
-
# max_results: 1,
|
3209
|
-
# next_token: "Token",
|
3210
|
-
# tracker_name: "ResourceName", # required
|
3211
3288
|
# })
|
3212
3289
|
#
|
3213
3290
|
# @example Response structure
|
3214
3291
|
#
|
3215
3292
|
# resp.data.entries #=> Array
|
3216
|
-
# resp.data.entries[0].accuracy.horizontal #=> Float
|
3217
3293
|
# resp.data.entries[0].device_id #=> String
|
3294
|
+
# resp.data.entries[0].sample_time #=> Time
|
3218
3295
|
# resp.data.entries[0].position #=> Array
|
3219
3296
|
# resp.data.entries[0].position[0] #=> Float
|
3297
|
+
# resp.data.entries[0].accuracy.horizontal #=> Float
|
3220
3298
|
# resp.data.entries[0].position_properties #=> Hash
|
3221
3299
|
# resp.data.entries[0].position_properties["PropertyMapKeyString"] #=> String
|
3222
|
-
# resp.data.entries[0].sample_time #=> Time
|
3223
3300
|
# resp.next_token #=> String
|
3224
3301
|
#
|
3225
3302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositions AWS API Documentation
|
@@ -3263,10 +3340,10 @@ module Aws::LocationService
|
|
3263
3340
|
#
|
3264
3341
|
# resp.data.entries #=> Array
|
3265
3342
|
# resp.data.entries[0].collection_name #=> String
|
3266
|
-
# resp.data.entries[0].create_time #=> Time
|
3267
3343
|
# resp.data.entries[0].description #=> String
|
3268
3344
|
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
3269
3345
|
# resp.data.entries[0].pricing_plan_data_source #=> String
|
3346
|
+
# resp.data.entries[0].create_time #=> Time
|
3270
3347
|
# resp.data.entries[0].update_time #=> Time
|
3271
3348
|
# resp.next_token #=> String
|
3272
3349
|
#
|
@@ -3284,18 +3361,18 @@ module Aws::LocationService
|
|
3284
3361
|
# @option params [required, String] :collection_name
|
3285
3362
|
# The name of the geofence collection storing the list of geofences.
|
3286
3363
|
#
|
3287
|
-
# @option params [Integer] :max_results
|
3288
|
-
# An optional limit for the number of geofences returned in a single
|
3289
|
-
# call.
|
3290
|
-
#
|
3291
|
-
# Default value: `100`
|
3292
|
-
#
|
3293
3364
|
# @option params [String] :next_token
|
3294
3365
|
# The pagination token specifying which page of results to return in the
|
3295
3366
|
# response. If no token is provided, the default page is the first page.
|
3296
3367
|
#
|
3297
3368
|
# Default value: `null`
|
3298
3369
|
#
|
3370
|
+
# @option params [Integer] :max_results
|
3371
|
+
# An optional limit for the number of geofences returned in a single
|
3372
|
+
# call.
|
3373
|
+
#
|
3374
|
+
# Default value: `100`
|
3375
|
+
#
|
3299
3376
|
# @return [Types::ListGeofencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3300
3377
|
#
|
3301
3378
|
# * {Types::ListGeofencesResponse#entries #data.entries} => Array<Types::ListGeofenceResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
@@ -3307,26 +3384,27 @@ module Aws::LocationService
|
|
3307
3384
|
#
|
3308
3385
|
# resp = client.list_geofences({
|
3309
3386
|
# collection_name: "ResourceName", # required
|
3387
|
+
# next_token: "LargeToken",
|
3310
3388
|
# max_results: 1,
|
3311
|
-
# next_token: "Token",
|
3312
3389
|
# })
|
3313
3390
|
#
|
3314
3391
|
# @example Response structure
|
3315
3392
|
#
|
3316
3393
|
# resp.data.entries #=> Array
|
3317
|
-
# resp.data.entries[0].create_time #=> Time
|
3318
3394
|
# resp.data.entries[0].geofence_id #=> String
|
3319
|
-
# resp.data.entries[0].geofence_properties #=> Hash
|
3320
|
-
# resp.data.entries[0].geofence_properties["PropertyMapKeyString"] #=> String
|
3321
|
-
# resp.data.entries[0].geometry.circle.center #=> Array
|
3322
|
-
# resp.data.entries[0].geometry.circle.center[0] #=> Float
|
3323
|
-
# resp.data.entries[0].geometry.circle.radius #=> Float
|
3324
3395
|
# resp.data.entries[0].geometry.polygon #=> Array
|
3325
3396
|
# resp.data.entries[0].geometry.polygon[0] #=> Array
|
3326
3397
|
# resp.data.entries[0].geometry.polygon[0][0] #=> Array
|
3327
3398
|
# resp.data.entries[0].geometry.polygon[0][0][0] #=> Float
|
3399
|
+
# resp.data.entries[0].geometry.circle.center #=> Array
|
3400
|
+
# resp.data.entries[0].geometry.circle.center[0] #=> Float
|
3401
|
+
# resp.data.entries[0].geometry.circle.radius #=> Float
|
3402
|
+
# resp.data.entries[0].geometry.geobuf #=> String
|
3328
3403
|
# resp.data.entries[0].status #=> String
|
3404
|
+
# resp.data.entries[0].create_time #=> Time
|
3329
3405
|
# resp.data.entries[0].update_time #=> Time
|
3406
|
+
# resp.data.entries[0].geofence_properties #=> Hash
|
3407
|
+
# resp.data.entries[0].geofence_properties["PropertyMapKeyString"] #=> String
|
3330
3408
|
# resp.next_token #=> String
|
3331
3409
|
#
|
3332
3410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListGeofences AWS API Documentation
|
@@ -3340,9 +3418,6 @@ module Aws::LocationService
|
|
3340
3418
|
|
3341
3419
|
# Lists API key resources in your Amazon Web Services account.
|
3342
3420
|
#
|
3343
|
-
# @option params [Types::ApiKeyFilter] :filter
|
3344
|
-
# Optionally filter the list to only `Active` or `Expired` API keys.
|
3345
|
-
#
|
3346
3421
|
# @option params [Integer] :max_results
|
3347
3422
|
# An optional limit for the number of resources returned in a single
|
3348
3423
|
# call.
|
@@ -3355,6 +3430,9 @@ module Aws::LocationService
|
|
3355
3430
|
#
|
3356
3431
|
# Default value: `null`
|
3357
3432
|
#
|
3433
|
+
# @option params [Types::ApiKeyFilter] :filter
|
3434
|
+
# Optionally filter the list to only `Active` or `Expired` API keys.
|
3435
|
+
#
|
3358
3436
|
# @return [Types::ListKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3359
3437
|
#
|
3360
3438
|
# * {Types::ListKeysResponse#entries #data.entries} => Array<Types::ListKeysResponseEntry> (This method conflicts with a method on Response, call it through the data member)
|
@@ -3365,26 +3443,26 @@ module Aws::LocationService
|
|
3365
3443
|
# @example Request syntax with placeholder values
|
3366
3444
|
#
|
3367
3445
|
# resp = client.list_keys({
|
3446
|
+
# max_results: 1,
|
3447
|
+
# next_token: "Token",
|
3368
3448
|
# filter: {
|
3369
3449
|
# key_status: "Active", # accepts Active, Expired
|
3370
3450
|
# },
|
3371
|
-
# max_results: 1,
|
3372
|
-
# next_token: "Token",
|
3373
3451
|
# })
|
3374
3452
|
#
|
3375
3453
|
# @example Response structure
|
3376
3454
|
#
|
3377
3455
|
# resp.data.entries #=> Array
|
3378
|
-
# resp.data.entries[0].create_time #=> Time
|
3379
|
-
# resp.data.entries[0].description #=> String
|
3380
|
-
# resp.data.entries[0].expire_time #=> Time
|
3381
3456
|
# resp.data.entries[0].key_name #=> String
|
3457
|
+
# resp.data.entries[0].expire_time #=> Time
|
3458
|
+
# resp.data.entries[0].description #=> String
|
3382
3459
|
# resp.data.entries[0].restrictions.allow_actions #=> Array
|
3383
3460
|
# resp.data.entries[0].restrictions.allow_actions[0] #=> String
|
3384
|
-
# resp.data.entries[0].restrictions.allow_referers #=> Array
|
3385
|
-
# resp.data.entries[0].restrictions.allow_referers[0] #=> String
|
3386
3461
|
# resp.data.entries[0].restrictions.allow_resources #=> Array
|
3387
3462
|
# resp.data.entries[0].restrictions.allow_resources[0] #=> String
|
3463
|
+
# resp.data.entries[0].restrictions.allow_referers #=> Array
|
3464
|
+
# resp.data.entries[0].restrictions.allow_referers[0] #=> String
|
3465
|
+
# resp.data.entries[0].create_time #=> Time
|
3388
3466
|
# resp.data.entries[0].update_time #=> Time
|
3389
3467
|
# resp.next_token #=> String
|
3390
3468
|
#
|
@@ -3428,11 +3506,11 @@ module Aws::LocationService
|
|
3428
3506
|
# @example Response structure
|
3429
3507
|
#
|
3430
3508
|
# resp.data.entries #=> Array
|
3431
|
-
# resp.data.entries[0].create_time #=> Time
|
3432
|
-
# resp.data.entries[0].data_source #=> String
|
3433
|
-
# resp.data.entries[0].description #=> String
|
3434
3509
|
# resp.data.entries[0].map_name #=> String
|
3510
|
+
# resp.data.entries[0].description #=> String
|
3511
|
+
# resp.data.entries[0].data_source #=> String
|
3435
3512
|
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
3513
|
+
# resp.data.entries[0].create_time #=> Time
|
3436
3514
|
# resp.data.entries[0].update_time #=> Time
|
3437
3515
|
# resp.next_token #=> String
|
3438
3516
|
#
|
@@ -3476,11 +3554,11 @@ module Aws::LocationService
|
|
3476
3554
|
# @example Response structure
|
3477
3555
|
#
|
3478
3556
|
# resp.data.entries #=> Array
|
3479
|
-
# resp.data.entries[0].create_time #=> Time
|
3480
|
-
# resp.data.entries[0].data_source #=> String
|
3481
|
-
# resp.data.entries[0].description #=> String
|
3482
3557
|
# resp.data.entries[0].index_name #=> String
|
3558
|
+
# resp.data.entries[0].description #=> String
|
3559
|
+
# resp.data.entries[0].data_source #=> String
|
3483
3560
|
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
3561
|
+
# resp.data.entries[0].create_time #=> Time
|
3484
3562
|
# resp.data.entries[0].update_time #=> Time
|
3485
3563
|
# resp.next_token #=> String
|
3486
3564
|
#
|
@@ -3524,10 +3602,10 @@ module Aws::LocationService
|
|
3524
3602
|
#
|
3525
3603
|
# resp.data.entries #=> Array
|
3526
3604
|
# resp.data.entries[0].calculator_name #=> String
|
3527
|
-
# resp.data.entries[0].create_time #=> Time
|
3528
|
-
# resp.data.entries[0].data_source #=> String
|
3529
3605
|
# resp.data.entries[0].description #=> String
|
3606
|
+
# resp.data.entries[0].data_source #=> String
|
3530
3607
|
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
3608
|
+
# resp.data.entries[0].create_time #=> Time
|
3531
3609
|
# resp.data.entries[0].update_time #=> Time
|
3532
3610
|
# resp.next_token #=> String
|
3533
3611
|
#
|
@@ -3579,6 +3657,10 @@ module Aws::LocationService
|
|
3579
3657
|
# Lists geofence collections currently associated to the given tracker
|
3580
3658
|
# resource.
|
3581
3659
|
#
|
3660
|
+
# @option params [required, String] :tracker_name
|
3661
|
+
# The tracker resource whose associated geofence collections you want to
|
3662
|
+
# list.
|
3663
|
+
#
|
3582
3664
|
# @option params [Integer] :max_results
|
3583
3665
|
# An optional limit for the number of resources returned in a single
|
3584
3666
|
# call.
|
@@ -3591,10 +3673,6 @@ module Aws::LocationService
|
|
3591
3673
|
#
|
3592
3674
|
# Default value: `null`
|
3593
3675
|
#
|
3594
|
-
# @option params [required, String] :tracker_name
|
3595
|
-
# The tracker resource whose associated geofence collections you want to
|
3596
|
-
# list.
|
3597
|
-
#
|
3598
3676
|
# @return [Types::ListTrackerConsumersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3599
3677
|
#
|
3600
3678
|
# * {Types::ListTrackerConsumersResponse#consumer_arns #consumer_arns} => Array<String>
|
@@ -3605,9 +3683,9 @@ module Aws::LocationService
|
|
3605
3683
|
# @example Request syntax with placeholder values
|
3606
3684
|
#
|
3607
3685
|
# resp = client.list_tracker_consumers({
|
3686
|
+
# tracker_name: "ResourceName", # required
|
3608
3687
|
# max_results: 1,
|
3609
3688
|
# next_token: "Token",
|
3610
|
-
# tracker_name: "ResourceName", # required
|
3611
3689
|
# })
|
3612
3690
|
#
|
3613
3691
|
# @example Response structure
|
@@ -3656,11 +3734,11 @@ module Aws::LocationService
|
|
3656
3734
|
# @example Response structure
|
3657
3735
|
#
|
3658
3736
|
# resp.data.entries #=> Array
|
3659
|
-
# resp.data.entries[0].
|
3737
|
+
# resp.data.entries[0].tracker_name #=> String
|
3660
3738
|
# resp.data.entries[0].description #=> String
|
3661
3739
|
# resp.data.entries[0].pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
3662
3740
|
# resp.data.entries[0].pricing_plan_data_source #=> String
|
3663
|
-
# resp.data.entries[0].
|
3741
|
+
# resp.data.entries[0].create_time #=> Time
|
3664
3742
|
# resp.data.entries[0].update_time #=> Time
|
3665
3743
|
# resp.next_token #=> String
|
3666
3744
|
#
|
@@ -3683,19 +3761,14 @@ module Aws::LocationService
|
|
3683
3761
|
# @option params [required, String] :geofence_id
|
3684
3762
|
# An identifier for the geofence. For example, `ExampleGeofence-1`.
|
3685
3763
|
#
|
3686
|
-
# @option params [Hash<String,String>] :geofence_properties
|
3687
|
-
# Associates one of more properties with the geofence. A property is a
|
3688
|
-
# key-value pair stored with the geofence and added to any geofence
|
3689
|
-
# event triggered with that geofence.
|
3690
|
-
#
|
3691
|
-
# Format: `"key" : "value"`
|
3692
|
-
#
|
3693
3764
|
# @option params [required, Types::GeofenceGeometry] :geometry
|
3694
|
-
# Contains the details to specify the position of the geofence. Can be
|
3695
|
-
#
|
3696
|
-
# error.
|
3765
|
+
# Contains the details to specify the position of the geofence. Can be a
|
3766
|
+
# polygon, a circle or a polygon encoded in Geobuf format. Including
|
3767
|
+
# multiple selections will return a validation error.
|
3697
3768
|
#
|
3698
|
-
# <note markdown="1">
|
3769
|
+
# <note markdown="1"> The [ geofence polygon][1] format supports a maximum of 1,000
|
3770
|
+
# vertices. The [Geofence Geobuf][1] format supports a maximum of
|
3771
|
+
# 100,000 vertices.
|
3699
3772
|
#
|
3700
3773
|
# </note>
|
3701
3774
|
#
|
@@ -3703,10 +3776,17 @@ module Aws::LocationService
|
|
3703
3776
|
#
|
3704
3777
|
# [1]: https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html
|
3705
3778
|
#
|
3779
|
+
# @option params [Hash<String,String>] :geofence_properties
|
3780
|
+
# Associates one of more properties with the geofence. A property is a
|
3781
|
+
# key-value pair stored with the geofence and added to any geofence
|
3782
|
+
# event triggered with that geofence.
|
3783
|
+
#
|
3784
|
+
# Format: `"key" : "value"`
|
3785
|
+
#
|
3706
3786
|
# @return [Types::PutGeofenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3707
3787
|
#
|
3708
|
-
# * {Types::PutGeofenceResponse#create_time #create_time} => Time
|
3709
3788
|
# * {Types::PutGeofenceResponse#geofence_id #geofence_id} => String
|
3789
|
+
# * {Types::PutGeofenceResponse#create_time #create_time} => Time
|
3710
3790
|
# * {Types::PutGeofenceResponse#update_time #update_time} => Time
|
3711
3791
|
#
|
3712
3792
|
# @example Request syntax with placeholder values
|
@@ -3714,26 +3794,27 @@ module Aws::LocationService
|
|
3714
3794
|
# resp = client.put_geofence({
|
3715
3795
|
# collection_name: "ResourceName", # required
|
3716
3796
|
# geofence_id: "Id", # required
|
3717
|
-
# geofence_properties: {
|
3718
|
-
# "PropertyMapKeyString" => "PropertyMapValueString",
|
3719
|
-
# },
|
3720
3797
|
# geometry: { # required
|
3721
|
-
# circle: {
|
3722
|
-
# center: [1.0], # required
|
3723
|
-
# radius: 1.0, # required
|
3724
|
-
# },
|
3725
3798
|
# polygon: [
|
3726
3799
|
# [
|
3727
3800
|
# [1.0],
|
3728
3801
|
# ],
|
3729
3802
|
# ],
|
3803
|
+
# circle: {
|
3804
|
+
# center: [1.0], # required
|
3805
|
+
# radius: 1.0, # required
|
3806
|
+
# },
|
3807
|
+
# geobuf: "data",
|
3808
|
+
# },
|
3809
|
+
# geofence_properties: {
|
3810
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
3730
3811
|
# },
|
3731
3812
|
# })
|
3732
3813
|
#
|
3733
3814
|
# @example Response structure
|
3734
3815
|
#
|
3735
|
-
# resp.create_time #=> Time
|
3736
3816
|
# resp.geofence_id #=> String
|
3817
|
+
# resp.create_time #=> Time
|
3737
3818
|
# resp.update_time #=> Time
|
3738
3819
|
#
|
3739
3820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PutGeofence AWS API Documentation
|
@@ -3752,12 +3833,21 @@ module Aws::LocationService
|
|
3752
3833
|
# @option params [required, String] :index_name
|
3753
3834
|
# The name of the place index resource you want to use for the search.
|
3754
3835
|
#
|
3755
|
-
# @option params [
|
3756
|
-
#
|
3836
|
+
# @option params [required, Array<Float>] :position
|
3837
|
+
# Specifies the longitude and latitude of the position to query.
|
3838
|
+
#
|
3839
|
+
# This parameter must contain a pair of numbers. The first number
|
3840
|
+
# represents the X coordinate, or longitude; the second number
|
3841
|
+
# represents the Y coordinate, or latitude.
|
3757
3842
|
#
|
3843
|
+
# For example, `[-123.1174, 49.2847]` represents a position with
|
3844
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
3758
3845
|
#
|
3846
|
+
# @option params [Integer] :max_results
|
3847
|
+
# An optional parameter. The maximum number of results returned per
|
3848
|
+
# request.
|
3759
3849
|
#
|
3760
|
-
#
|
3850
|
+
# Default value: `50`
|
3761
3851
|
#
|
3762
3852
|
# @option params [String] :language
|
3763
3853
|
# The preferred language used to return results. The value must be a
|
@@ -3783,68 +3873,59 @@ module Aws::LocationService
|
|
3783
3873
|
#
|
3784
3874
|
# [1]: https://tools.ietf.org/search/bcp47
|
3785
3875
|
#
|
3786
|
-
# @option params [
|
3787
|
-
#
|
3788
|
-
# request.
|
3789
|
-
#
|
3790
|
-
# Default value: `50`
|
3876
|
+
# @option params [String] :key
|
3877
|
+
# The optional [API key][1] to authorize the request.
|
3791
3878
|
#
|
3792
|
-
# @option params [required, Array<Float>] :position
|
3793
|
-
# Specifies the longitude and latitude of the position to query.
|
3794
3879
|
#
|
3795
|
-
# This parameter must contain a pair of numbers. The first number
|
3796
|
-
# represents the X coordinate, or longitude; the second number
|
3797
|
-
# represents the Y coordinate, or latitude.
|
3798
3880
|
#
|
3799
|
-
#
|
3800
|
-
# longitude `-123.1174` and latitude `49.2847`.
|
3881
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3801
3882
|
#
|
3802
3883
|
# @return [Types::SearchPlaceIndexForPositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3803
3884
|
#
|
3804
|
-
# * {Types::SearchPlaceIndexForPositionResponse#results #results} => Array<Types::SearchForPositionResult>
|
3805
3885
|
# * {Types::SearchPlaceIndexForPositionResponse#summary #summary} => Types::SearchPlaceIndexForPositionSummary
|
3886
|
+
# * {Types::SearchPlaceIndexForPositionResponse#results #results} => Array<Types::SearchForPositionResult>
|
3806
3887
|
#
|
3807
3888
|
# @example Request syntax with placeholder values
|
3808
3889
|
#
|
3809
3890
|
# resp = client.search_place_index_for_position({
|
3810
3891
|
# index_name: "ResourceName", # required
|
3811
|
-
# key: "ApiKey",
|
3812
|
-
# language: "LanguageTag",
|
3813
|
-
# max_results: 1,
|
3814
3892
|
# position: [1.0], # required
|
3893
|
+
# max_results: 1,
|
3894
|
+
# language: "LanguageTag",
|
3895
|
+
# key: "ApiKey",
|
3815
3896
|
# })
|
3816
3897
|
#
|
3817
3898
|
# @example Response structure
|
3818
3899
|
#
|
3819
|
-
# resp.
|
3820
|
-
# resp.
|
3821
|
-
# resp.
|
3822
|
-
# resp.
|
3823
|
-
# resp.
|
3824
|
-
# resp.results
|
3900
|
+
# resp.summary.position #=> Array
|
3901
|
+
# resp.summary.position[0] #=> Float
|
3902
|
+
# resp.summary.max_results #=> Integer
|
3903
|
+
# resp.summary.data_source #=> String
|
3904
|
+
# resp.summary.language #=> String
|
3905
|
+
# resp.results #=> Array
|
3906
|
+
# resp.results[0].place.label #=> String
|
3825
3907
|
# resp.results[0].place.geometry.point #=> Array
|
3826
3908
|
# resp.results[0].place.geometry.point[0] #=> Float
|
3827
|
-
# resp.results[0].place.
|
3828
|
-
# resp.results[0].place.label #=> String
|
3829
|
-
# resp.results[0].place.municipality #=> String
|
3830
|
-
# resp.results[0].place.neighborhood #=> String
|
3831
|
-
# resp.results[0].place.postal_code #=> String
|
3832
|
-
# resp.results[0].place.region #=> String
|
3909
|
+
# resp.results[0].place.address_number #=> String
|
3833
3910
|
# resp.results[0].place.street #=> String
|
3834
|
-
# resp.results[0].place.
|
3911
|
+
# resp.results[0].place.neighborhood #=> String
|
3912
|
+
# resp.results[0].place.municipality #=> String
|
3835
3913
|
# resp.results[0].place.sub_region #=> String
|
3836
|
-
# resp.results[0].place.
|
3837
|
-
# resp.results[0].place.
|
3914
|
+
# resp.results[0].place.region #=> String
|
3915
|
+
# resp.results[0].place.country #=> String
|
3916
|
+
# resp.results[0].place.postal_code #=> String
|
3917
|
+
# resp.results[0].place.interpolated #=> Boolean
|
3838
3918
|
# resp.results[0].place.time_zone.name #=> String
|
3839
3919
|
# resp.results[0].place.time_zone.offset #=> Integer
|
3840
|
-
# resp.results[0].place.unit_number #=> String
|
3841
3920
|
# resp.results[0].place.unit_type #=> String
|
3921
|
+
# resp.results[0].place.unit_number #=> String
|
3922
|
+
# resp.results[0].place.categories #=> Array
|
3923
|
+
# resp.results[0].place.categories[0] #=> String
|
3924
|
+
# resp.results[0].place.supplemental_categories #=> Array
|
3925
|
+
# resp.results[0].place.supplemental_categories[0] #=> String
|
3926
|
+
# resp.results[0].place.sub_municipality #=> String
|
3927
|
+
# resp.results[0].distance #=> Float
|
3842
3928
|
# resp.results[0].place_id #=> String
|
3843
|
-
# resp.summary.data_source #=> String
|
3844
|
-
# resp.summary.language #=> String
|
3845
|
-
# resp.summary.max_results #=> Integer
|
3846
|
-
# resp.summary.position #=> Array
|
3847
|
-
# resp.summary.position[0] #=> Float
|
3848
3929
|
#
|
3849
3930
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPosition AWS API Documentation
|
3850
3931
|
#
|
@@ -3870,6 +3951,13 @@ module Aws::LocationService
|
|
3870
3951
|
#
|
3871
3952
|
# </note>
|
3872
3953
|
#
|
3954
|
+
# @option params [required, String] :index_name
|
3955
|
+
# The name of the place index resource you want to use for the search.
|
3956
|
+
#
|
3957
|
+
# @option params [required, String] :text
|
3958
|
+
# The free-form partial text to use to generate place suggestions. For
|
3959
|
+
# example, `eiffel tow`.
|
3960
|
+
#
|
3873
3961
|
# @option params [Array<Float>] :bias_position
|
3874
3962
|
# An optional parameter that indicates a preference for place
|
3875
3963
|
# suggestions that are closer to a specified position.
|
@@ -3907,19 +3995,6 @@ module Aws::LocationService
|
|
3907
3995
|
#
|
3908
3996
|
# </note>
|
3909
3997
|
#
|
3910
|
-
# @option params [Array<String>] :filter_categories
|
3911
|
-
# A list of one or more Amazon Location categories to filter the
|
3912
|
-
# returned places. If you include more than one category, the results
|
3913
|
-
# will include results that match *any* of the categories listed.
|
3914
|
-
#
|
3915
|
-
# For more information about using categories, including a list of
|
3916
|
-
# Amazon Location categories, see [Categories and filtering][1], in the
|
3917
|
-
# *Amazon Location Service Developer Guide*.
|
3918
|
-
#
|
3919
|
-
#
|
3920
|
-
#
|
3921
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html
|
3922
|
-
#
|
3923
3998
|
# @option params [Array<String>] :filter_countries
|
3924
3999
|
# An optional parameter that limits the search results by returning only
|
3925
4000
|
# suggestions within the provided list of countries.
|
@@ -3933,15 +4008,11 @@ module Aws::LocationService
|
|
3933
4008
|
#
|
3934
4009
|
# [1]: https://www.iso.org/iso-3166-country-codes.html
|
3935
4010
|
#
|
3936
|
-
# @option params [
|
3937
|
-
#
|
3938
|
-
#
|
3939
|
-
# @option params [String] :key
|
3940
|
-
# The optional [API key][1] to authorize the request.
|
3941
|
-
#
|
3942
|
-
#
|
4011
|
+
# @option params [Integer] :max_results
|
4012
|
+
# An optional parameter. The maximum number of results returned per
|
4013
|
+
# request.
|
3943
4014
|
#
|
3944
|
-
#
|
4015
|
+
# The default: `5`
|
3945
4016
|
#
|
3946
4017
|
# @option params [String] :language
|
3947
4018
|
# The preferred language used to return results. The value must be a
|
@@ -3965,56 +4036,66 @@ module Aws::LocationService
|
|
3965
4036
|
#
|
3966
4037
|
# [1]: https://tools.ietf.org/search/bcp47
|
3967
4038
|
#
|
3968
|
-
# @option params [
|
3969
|
-
#
|
3970
|
-
#
|
4039
|
+
# @option params [Array<String>] :filter_categories
|
4040
|
+
# A list of one or more Amazon Location categories to filter the
|
4041
|
+
# returned places. If you include more than one category, the results
|
4042
|
+
# will include results that match *any* of the categories listed.
|
3971
4043
|
#
|
3972
|
-
#
|
4044
|
+
# For more information about using categories, including a list of
|
4045
|
+
# Amazon Location categories, see [Categories and filtering][1], in the
|
4046
|
+
# *Amazon Location Service Developer Guide*.
|
4047
|
+
#
|
4048
|
+
#
|
4049
|
+
#
|
4050
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html
|
4051
|
+
#
|
4052
|
+
# @option params [String] :key
|
4053
|
+
# The optional [API key][1] to authorize the request.
|
3973
4054
|
#
|
3974
|
-
#
|
3975
|
-
#
|
3976
|
-
#
|
4055
|
+
#
|
4056
|
+
#
|
4057
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
3977
4058
|
#
|
3978
4059
|
# @return [Types::SearchPlaceIndexForSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3979
4060
|
#
|
3980
|
-
# * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array<Types::SearchForSuggestionsResult>
|
3981
4061
|
# * {Types::SearchPlaceIndexForSuggestionsResponse#summary #summary} => Types::SearchPlaceIndexForSuggestionsSummary
|
4062
|
+
# * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array<Types::SearchForSuggestionsResult>
|
3982
4063
|
#
|
3983
4064
|
# @example Request syntax with placeholder values
|
3984
4065
|
#
|
3985
4066
|
# resp = client.search_place_index_for_suggestions({
|
4067
|
+
# index_name: "ResourceName", # required
|
4068
|
+
# text: "SearchPlaceIndexForSuggestionsRequestTextString", # required
|
3986
4069
|
# bias_position: [1.0],
|
3987
4070
|
# filter_b_box: [1.0],
|
4071
|
+
# filter_countries: ["CountryCode3"],
|
4072
|
+
# max_results: 1,
|
4073
|
+
# language: "LanguageTag",
|
3988
4074
|
# filter_categories: ["PlaceCategory"],
|
3989
|
-
# filter_countries: ["CountryCode"],
|
3990
|
-
# index_name: "ResourceName", # required
|
3991
4075
|
# key: "ApiKey",
|
3992
|
-
# language: "LanguageTag",
|
3993
|
-
# max_results: 1,
|
3994
|
-
# text: "SearchPlaceIndexForSuggestionsRequestTextString", # required
|
3995
4076
|
# })
|
3996
4077
|
#
|
3997
4078
|
# @example Response structure
|
3998
4079
|
#
|
3999
|
-
# resp.
|
4000
|
-
# resp.results[0].categories #=> Array
|
4001
|
-
# resp.results[0].categories[0] #=> String
|
4002
|
-
# resp.results[0].place_id #=> String
|
4003
|
-
# resp.results[0].supplemental_categories #=> Array
|
4004
|
-
# resp.results[0].supplemental_categories[0] #=> String
|
4005
|
-
# resp.results[0].text #=> String
|
4080
|
+
# resp.summary.text #=> String
|
4006
4081
|
# resp.summary.bias_position #=> Array
|
4007
4082
|
# resp.summary.bias_position[0] #=> Float
|
4008
|
-
# resp.summary.data_source #=> String
|
4009
4083
|
# resp.summary.filter_b_box #=> Array
|
4010
4084
|
# resp.summary.filter_b_box[0] #=> Float
|
4011
|
-
# resp.summary.filter_categories #=> Array
|
4012
|
-
# resp.summary.filter_categories[0] #=> String
|
4013
4085
|
# resp.summary.filter_countries #=> Array
|
4014
4086
|
# resp.summary.filter_countries[0] #=> String
|
4015
|
-
# resp.summary.language #=> String
|
4016
4087
|
# resp.summary.max_results #=> Integer
|
4017
|
-
# resp.summary.
|
4088
|
+
# resp.summary.data_source #=> String
|
4089
|
+
# resp.summary.language #=> String
|
4090
|
+
# resp.summary.filter_categories #=> Array
|
4091
|
+
# resp.summary.filter_categories[0] #=> String
|
4092
|
+
# resp.results #=> Array
|
4093
|
+
# resp.results[0].text #=> String
|
4094
|
+
# resp.results[0].place_id #=> String
|
4095
|
+
# resp.results[0].categories #=> Array
|
4096
|
+
# resp.results[0].categories[0] #=> String
|
4097
|
+
# resp.results[0].supplemental_categories #=> Array
|
4098
|
+
# resp.results[0].supplemental_categories[0] #=> String
|
4018
4099
|
#
|
4019
4100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions AWS API Documentation
|
4020
4101
|
#
|
@@ -4040,6 +4121,13 @@ module Aws::LocationService
|
|
4040
4121
|
#
|
4041
4122
|
# Search results are returned in order of highest to lowest relevance.
|
4042
4123
|
#
|
4124
|
+
# @option params [required, String] :index_name
|
4125
|
+
# The name of the place index resource you want to use for the search.
|
4126
|
+
#
|
4127
|
+
# @option params [required, String] :text
|
4128
|
+
# The address, name, city, or region to be used in the search in
|
4129
|
+
# free-form text format. For example, `123 Any Street`.
|
4130
|
+
#
|
4043
4131
|
# @option params [Array<Float>] :bias_position
|
4044
4132
|
# An optional parameter that indicates a preference for places that are
|
4045
4133
|
# closer to a specified position.
|
@@ -4077,19 +4165,6 @@ module Aws::LocationService
|
|
4077
4165
|
#
|
4078
4166
|
# </note>
|
4079
4167
|
#
|
4080
|
-
# @option params [Array<String>] :filter_categories
|
4081
|
-
# A list of one or more Amazon Location categories to filter the
|
4082
|
-
# returned places. If you include more than one category, the results
|
4083
|
-
# will include results that match *any* of the categories listed.
|
4084
|
-
#
|
4085
|
-
# For more information about using categories, including a list of
|
4086
|
-
# Amazon Location categories, see [Categories and filtering][1], in the
|
4087
|
-
# *Amazon Location Service Developer Guide*.
|
4088
|
-
#
|
4089
|
-
#
|
4090
|
-
#
|
4091
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html
|
4092
|
-
#
|
4093
4168
|
# @option params [Array<String>] :filter_countries
|
4094
4169
|
# An optional parameter that limits the search results by returning only
|
4095
4170
|
# places that are in a specified list of countries.
|
@@ -4103,15 +4178,11 @@ module Aws::LocationService
|
|
4103
4178
|
#
|
4104
4179
|
# [1]: https://www.iso.org/iso-3166-country-codes.html
|
4105
4180
|
#
|
4106
|
-
# @option params [
|
4107
|
-
#
|
4108
|
-
#
|
4109
|
-
# @option params [String] :key
|
4110
|
-
# The optional [API key][1] to authorize the request.
|
4111
|
-
#
|
4112
|
-
#
|
4181
|
+
# @option params [Integer] :max_results
|
4182
|
+
# An optional parameter. The maximum number of results returned per
|
4183
|
+
# request.
|
4113
4184
|
#
|
4114
|
-
#
|
4185
|
+
# The default: `50`
|
4115
4186
|
#
|
4116
4187
|
# @option params [String] :language
|
4117
4188
|
# The preferred language used to return results. The value must be a
|
@@ -4136,76 +4207,86 @@ module Aws::LocationService
|
|
4136
4207
|
#
|
4137
4208
|
# [1]: https://tools.ietf.org/search/bcp47
|
4138
4209
|
#
|
4139
|
-
# @option params [
|
4140
|
-
#
|
4141
|
-
#
|
4210
|
+
# @option params [Array<String>] :filter_categories
|
4211
|
+
# A list of one or more Amazon Location categories to filter the
|
4212
|
+
# returned places. If you include more than one category, the results
|
4213
|
+
# will include results that match *any* of the categories listed.
|
4142
4214
|
#
|
4143
|
-
#
|
4215
|
+
# For more information about using categories, including a list of
|
4216
|
+
# Amazon Location categories, see [Categories and filtering][1], in the
|
4217
|
+
# *Amazon Location Service Developer Guide*.
|
4144
4218
|
#
|
4145
|
-
#
|
4146
|
-
#
|
4147
|
-
#
|
4219
|
+
#
|
4220
|
+
#
|
4221
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html
|
4222
|
+
#
|
4223
|
+
# @option params [String] :key
|
4224
|
+
# The optional [API key][1] to authorize the request.
|
4225
|
+
#
|
4226
|
+
#
|
4227
|
+
#
|
4228
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
|
4148
4229
|
#
|
4149
4230
|
# @return [Types::SearchPlaceIndexForTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4150
4231
|
#
|
4151
|
-
# * {Types::SearchPlaceIndexForTextResponse#results #results} => Array<Types::SearchForTextResult>
|
4152
4232
|
# * {Types::SearchPlaceIndexForTextResponse#summary #summary} => Types::SearchPlaceIndexForTextSummary
|
4233
|
+
# * {Types::SearchPlaceIndexForTextResponse#results #results} => Array<Types::SearchForTextResult>
|
4153
4234
|
#
|
4154
4235
|
# @example Request syntax with placeholder values
|
4155
4236
|
#
|
4156
4237
|
# resp = client.search_place_index_for_text({
|
4238
|
+
# index_name: "ResourceName", # required
|
4239
|
+
# text: "SearchPlaceIndexForTextRequestTextString", # required
|
4157
4240
|
# bias_position: [1.0],
|
4158
4241
|
# filter_b_box: [1.0],
|
4242
|
+
# filter_countries: ["CountryCode3"],
|
4243
|
+
# max_results: 1,
|
4244
|
+
# language: "LanguageTag",
|
4159
4245
|
# filter_categories: ["PlaceCategory"],
|
4160
|
-
# filter_countries: ["CountryCode"],
|
4161
|
-
# index_name: "ResourceName", # required
|
4162
4246
|
# key: "ApiKey",
|
4163
|
-
# language: "LanguageTag",
|
4164
|
-
# max_results: 1,
|
4165
|
-
# text: "SearchPlaceIndexForTextRequestTextString", # required
|
4166
4247
|
# })
|
4167
4248
|
#
|
4168
4249
|
# @example Response structure
|
4169
4250
|
#
|
4170
|
-
# resp.
|
4171
|
-
# resp.results[0].distance #=> Float
|
4172
|
-
# resp.results[0].place.address_number #=> String
|
4173
|
-
# resp.results[0].place.categories #=> Array
|
4174
|
-
# resp.results[0].place.categories[0] #=> String
|
4175
|
-
# resp.results[0].place.country #=> String
|
4176
|
-
# resp.results[0].place.geometry.point #=> Array
|
4177
|
-
# resp.results[0].place.geometry.point[0] #=> Float
|
4178
|
-
# resp.results[0].place.interpolated #=> Boolean
|
4179
|
-
# resp.results[0].place.label #=> String
|
4180
|
-
# resp.results[0].place.municipality #=> String
|
4181
|
-
# resp.results[0].place.neighborhood #=> String
|
4182
|
-
# resp.results[0].place.postal_code #=> String
|
4183
|
-
# resp.results[0].place.region #=> String
|
4184
|
-
# resp.results[0].place.street #=> String
|
4185
|
-
# resp.results[0].place.sub_municipality #=> String
|
4186
|
-
# resp.results[0].place.sub_region #=> String
|
4187
|
-
# resp.results[0].place.supplemental_categories #=> Array
|
4188
|
-
# resp.results[0].place.supplemental_categories[0] #=> String
|
4189
|
-
# resp.results[0].place.time_zone.name #=> String
|
4190
|
-
# resp.results[0].place.time_zone.offset #=> Integer
|
4191
|
-
# resp.results[0].place.unit_number #=> String
|
4192
|
-
# resp.results[0].place.unit_type #=> String
|
4193
|
-
# resp.results[0].place_id #=> String
|
4194
|
-
# resp.results[0].relevance #=> Float
|
4251
|
+
# resp.summary.text #=> String
|
4195
4252
|
# resp.summary.bias_position #=> Array
|
4196
4253
|
# resp.summary.bias_position[0] #=> Float
|
4197
|
-
# resp.summary.data_source #=> String
|
4198
4254
|
# resp.summary.filter_b_box #=> Array
|
4199
4255
|
# resp.summary.filter_b_box[0] #=> Float
|
4200
|
-
# resp.summary.filter_categories #=> Array
|
4201
|
-
# resp.summary.filter_categories[0] #=> String
|
4202
4256
|
# resp.summary.filter_countries #=> Array
|
4203
4257
|
# resp.summary.filter_countries[0] #=> String
|
4204
|
-
# resp.summary.language #=> String
|
4205
4258
|
# resp.summary.max_results #=> Integer
|
4206
4259
|
# resp.summary.result_b_box #=> Array
|
4207
4260
|
# resp.summary.result_b_box[0] #=> Float
|
4208
|
-
# resp.summary.
|
4261
|
+
# resp.summary.data_source #=> String
|
4262
|
+
# resp.summary.language #=> String
|
4263
|
+
# resp.summary.filter_categories #=> Array
|
4264
|
+
# resp.summary.filter_categories[0] #=> String
|
4265
|
+
# resp.results #=> Array
|
4266
|
+
# resp.results[0].place.label #=> String
|
4267
|
+
# resp.results[0].place.geometry.point #=> Array
|
4268
|
+
# resp.results[0].place.geometry.point[0] #=> Float
|
4269
|
+
# resp.results[0].place.address_number #=> String
|
4270
|
+
# resp.results[0].place.street #=> String
|
4271
|
+
# resp.results[0].place.neighborhood #=> String
|
4272
|
+
# resp.results[0].place.municipality #=> String
|
4273
|
+
# resp.results[0].place.sub_region #=> String
|
4274
|
+
# resp.results[0].place.region #=> String
|
4275
|
+
# resp.results[0].place.country #=> String
|
4276
|
+
# resp.results[0].place.postal_code #=> String
|
4277
|
+
# resp.results[0].place.interpolated #=> Boolean
|
4278
|
+
# resp.results[0].place.time_zone.name #=> String
|
4279
|
+
# resp.results[0].place.time_zone.offset #=> Integer
|
4280
|
+
# resp.results[0].place.unit_type #=> String
|
4281
|
+
# resp.results[0].place.unit_number #=> String
|
4282
|
+
# resp.results[0].place.categories #=> Array
|
4283
|
+
# resp.results[0].place.categories[0] #=> String
|
4284
|
+
# resp.results[0].place.supplemental_categories #=> Array
|
4285
|
+
# resp.results[0].place.supplemental_categories[0] #=> String
|
4286
|
+
# resp.results[0].place.sub_municipality #=> String
|
4287
|
+
# resp.results[0].distance #=> Float
|
4288
|
+
# resp.results[0].relevance #=> Float
|
4289
|
+
# resp.results[0].place_id #=> String
|
4209
4290
|
#
|
4210
4291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForText AWS API Documentation
|
4211
4292
|
#
|
@@ -4321,9 +4402,6 @@ module Aws::LocationService
|
|
4321
4402
|
# @option params [required, String] :collection_name
|
4322
4403
|
# The name of the geofence collection to update.
|
4323
4404
|
#
|
4324
|
-
# @option params [String] :description
|
4325
|
-
# Updates the description for the geofence collection.
|
4326
|
-
#
|
4327
4405
|
# @option params [String] :pricing_plan
|
4328
4406
|
# No longer used. If included, the only allowed value is
|
4329
4407
|
# `RequestBasedUsage`.
|
@@ -4331,25 +4409,28 @@ module Aws::LocationService
|
|
4331
4409
|
# @option params [String] :pricing_plan_data_source
|
4332
4410
|
# This parameter is no longer used.
|
4333
4411
|
#
|
4412
|
+
# @option params [String] :description
|
4413
|
+
# Updates the description for the geofence collection.
|
4414
|
+
#
|
4334
4415
|
# @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4335
4416
|
#
|
4336
|
-
# * {Types::UpdateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
4337
4417
|
# * {Types::UpdateGeofenceCollectionResponse#collection_name #collection_name} => String
|
4418
|
+
# * {Types::UpdateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
4338
4419
|
# * {Types::UpdateGeofenceCollectionResponse#update_time #update_time} => Time
|
4339
4420
|
#
|
4340
4421
|
# @example Request syntax with placeholder values
|
4341
4422
|
#
|
4342
4423
|
# resp = client.update_geofence_collection({
|
4343
4424
|
# collection_name: "ResourceName", # required
|
4344
|
-
# description: "ResourceDescription",
|
4345
4425
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
4346
4426
|
# pricing_plan_data_source: "String",
|
4427
|
+
# description: "ResourceDescription",
|
4347
4428
|
# })
|
4348
4429
|
#
|
4349
4430
|
# @example Response structure
|
4350
4431
|
#
|
4351
|
-
# resp.collection_arn #=> String
|
4352
4432
|
# resp.collection_name #=> String
|
4433
|
+
# resp.collection_arn #=> String
|
4353
4434
|
# resp.update_time #=> Time
|
4354
4435
|
#
|
4355
4436
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollection AWS API Documentation
|
@@ -4363,6 +4444,9 @@ module Aws::LocationService
|
|
4363
4444
|
|
4364
4445
|
# Updates the specified properties of a given API key resource.
|
4365
4446
|
#
|
4447
|
+
# @option params [required, String] :key_name
|
4448
|
+
# The name of the API key resource to update.
|
4449
|
+
#
|
4366
4450
|
# @option params [String] :description
|
4367
4451
|
# Updates the description for the API key resource.
|
4368
4452
|
#
|
@@ -4374,6 +4458,10 @@ module Aws::LocationService
|
|
4374
4458
|
#
|
4375
4459
|
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
4376
4460
|
#
|
4461
|
+
# @option params [Boolean] :no_expiry
|
4462
|
+
# Whether the API key should expire. Set to `true` to set the API key to
|
4463
|
+
# have no expiration time.
|
4464
|
+
#
|
4377
4465
|
# @option params [Boolean] :force_update
|
4378
4466
|
# The boolean flag to be included for updating `ExpireTime` or
|
4379
4467
|
# `Restrictions` details.
|
@@ -4385,13 +4473,6 @@ module Aws::LocationService
|
|
4385
4473
|
#
|
4386
4474
|
# Default value: `False`
|
4387
4475
|
#
|
4388
|
-
# @option params [required, String] :key_name
|
4389
|
-
# The name of the API key resource to update.
|
4390
|
-
#
|
4391
|
-
# @option params [Boolean] :no_expiry
|
4392
|
-
# Whether the API key should expire. Set to `true` to set the API key to
|
4393
|
-
# have no expiration time.
|
4394
|
-
#
|
4395
4476
|
# @option params [Types::ApiKeyRestrictions] :restrictions
|
4396
4477
|
# Updates the API key restrictions for the API key resource.
|
4397
4478
|
#
|
@@ -4404,15 +4485,15 @@ module Aws::LocationService
|
|
4404
4485
|
# @example Request syntax with placeholder values
|
4405
4486
|
#
|
4406
4487
|
# resp = client.update_key({
|
4488
|
+
# key_name: "ResourceName", # required
|
4407
4489
|
# description: "ResourceDescription",
|
4408
4490
|
# expire_time: Time.now,
|
4409
|
-
# force_update: false,
|
4410
|
-
# key_name: "ResourceName", # required
|
4411
4491
|
# no_expiry: false,
|
4492
|
+
# force_update: false,
|
4412
4493
|
# restrictions: {
|
4413
4494
|
# allow_actions: ["ApiKeyAction"], # required
|
4495
|
+
# allow_resources: ["GeoArnV2"], # required
|
4414
4496
|
# allow_referers: ["RefererPattern"],
|
4415
|
-
# allow_resources: ["GeoArn"], # required
|
4416
4497
|
# },
|
4417
4498
|
# })
|
4418
4499
|
#
|
@@ -4433,13 +4514,6 @@ module Aws::LocationService
|
|
4433
4514
|
|
4434
4515
|
# Updates the specified properties of a given map resource.
|
4435
4516
|
#
|
4436
|
-
# @option params [Types::MapConfigurationUpdate] :configuration_update
|
4437
|
-
# Updates the parts of the map configuration that can be updated,
|
4438
|
-
# including the political view.
|
4439
|
-
#
|
4440
|
-
# @option params [String] :description
|
4441
|
-
# Updates the description for the map resource.
|
4442
|
-
#
|
4443
4517
|
# @option params [required, String] :map_name
|
4444
4518
|
# The name of the map resource to update.
|
4445
4519
|
#
|
@@ -4447,28 +4521,35 @@ module Aws::LocationService
|
|
4447
4521
|
# No longer used. If included, the only allowed value is
|
4448
4522
|
# `RequestBasedUsage`.
|
4449
4523
|
#
|
4524
|
+
# @option params [String] :description
|
4525
|
+
# Updates the description for the map resource.
|
4526
|
+
#
|
4527
|
+
# @option params [Types::MapConfigurationUpdate] :configuration_update
|
4528
|
+
# Updates the parts of the map configuration that can be updated,
|
4529
|
+
# including the political view.
|
4530
|
+
#
|
4450
4531
|
# @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4451
4532
|
#
|
4452
|
-
# * {Types::UpdateMapResponse#map_arn #map_arn} => String
|
4453
4533
|
# * {Types::UpdateMapResponse#map_name #map_name} => String
|
4534
|
+
# * {Types::UpdateMapResponse#map_arn #map_arn} => String
|
4454
4535
|
# * {Types::UpdateMapResponse#update_time #update_time} => Time
|
4455
4536
|
#
|
4456
4537
|
# @example Request syntax with placeholder values
|
4457
4538
|
#
|
4458
4539
|
# resp = client.update_map({
|
4540
|
+
# map_name: "ResourceName", # required
|
4541
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
4542
|
+
# description: "ResourceDescription",
|
4459
4543
|
# configuration_update: {
|
4460
|
-
# custom_layers: ["CustomLayer"],
|
4461
4544
|
# political_view: "CountryCode3OrEmpty",
|
4545
|
+
# custom_layers: ["CustomLayer"],
|
4462
4546
|
# },
|
4463
|
-
# description: "ResourceDescription",
|
4464
|
-
# map_name: "ResourceName", # required
|
4465
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
4466
4547
|
# })
|
4467
4548
|
#
|
4468
4549
|
# @example Response structure
|
4469
4550
|
#
|
4470
|
-
# resp.map_arn #=> String
|
4471
4551
|
# resp.map_name #=> String
|
4552
|
+
# resp.map_arn #=> String
|
4472
4553
|
# resp.update_time #=> Time
|
4473
4554
|
#
|
4474
4555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMap AWS API Documentation
|
@@ -4482,12 +4563,6 @@ module Aws::LocationService
|
|
4482
4563
|
|
4483
4564
|
# Updates the specified properties of a given place index resource.
|
4484
4565
|
#
|
4485
|
-
# @option params [Types::DataSourceConfiguration] :data_source_configuration
|
4486
|
-
# Updates the data storage option for the place index resource.
|
4487
|
-
#
|
4488
|
-
# @option params [String] :description
|
4489
|
-
# Updates the description for the place index resource.
|
4490
|
-
#
|
4491
4566
|
# @option params [required, String] :index_name
|
4492
4567
|
# The name of the place index resource to update.
|
4493
4568
|
#
|
@@ -4495,27 +4570,33 @@ module Aws::LocationService
|
|
4495
4570
|
# No longer used. If included, the only allowed value is
|
4496
4571
|
# `RequestBasedUsage`.
|
4497
4572
|
#
|
4573
|
+
# @option params [String] :description
|
4574
|
+
# Updates the description for the place index resource.
|
4575
|
+
#
|
4576
|
+
# @option params [Types::DataSourceConfiguration] :data_source_configuration
|
4577
|
+
# Updates the data storage option for the place index resource.
|
4578
|
+
#
|
4498
4579
|
# @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4499
4580
|
#
|
4500
|
-
# * {Types::UpdatePlaceIndexResponse#index_arn #index_arn} => String
|
4501
4581
|
# * {Types::UpdatePlaceIndexResponse#index_name #index_name} => String
|
4582
|
+
# * {Types::UpdatePlaceIndexResponse#index_arn #index_arn} => String
|
4502
4583
|
# * {Types::UpdatePlaceIndexResponse#update_time #update_time} => Time
|
4503
4584
|
#
|
4504
4585
|
# @example Request syntax with placeholder values
|
4505
4586
|
#
|
4506
4587
|
# resp = client.update_place_index({
|
4588
|
+
# index_name: "ResourceName", # required
|
4589
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
4590
|
+
# description: "ResourceDescription",
|
4507
4591
|
# data_source_configuration: {
|
4508
4592
|
# intended_use: "SingleUse", # accepts SingleUse, Storage
|
4509
4593
|
# },
|
4510
|
-
# description: "ResourceDescription",
|
4511
|
-
# index_name: "ResourceName", # required
|
4512
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
4513
4594
|
# })
|
4514
4595
|
#
|
4515
4596
|
# @example Response structure
|
4516
4597
|
#
|
4517
|
-
# resp.index_arn #=> String
|
4518
4598
|
# resp.index_name #=> String
|
4599
|
+
# resp.index_arn #=> String
|
4519
4600
|
# resp.update_time #=> Time
|
4520
4601
|
#
|
4521
4602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndex AWS API Documentation
|
@@ -4533,31 +4614,31 @@ module Aws::LocationService
|
|
4533
4614
|
# @option params [required, String] :calculator_name
|
4534
4615
|
# The name of the route calculator resource to update.
|
4535
4616
|
#
|
4536
|
-
# @option params [String] :description
|
4537
|
-
# Updates the description for the route calculator resource.
|
4538
|
-
#
|
4539
4617
|
# @option params [String] :pricing_plan
|
4540
4618
|
# No longer used. If included, the only allowed value is
|
4541
4619
|
# `RequestBasedUsage`.
|
4542
4620
|
#
|
4621
|
+
# @option params [String] :description
|
4622
|
+
# Updates the description for the route calculator resource.
|
4623
|
+
#
|
4543
4624
|
# @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4544
4625
|
#
|
4545
|
-
# * {Types::UpdateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
4546
4626
|
# * {Types::UpdateRouteCalculatorResponse#calculator_name #calculator_name} => String
|
4627
|
+
# * {Types::UpdateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
4547
4628
|
# * {Types::UpdateRouteCalculatorResponse#update_time #update_time} => Time
|
4548
4629
|
#
|
4549
4630
|
# @example Request syntax with placeholder values
|
4550
4631
|
#
|
4551
4632
|
# resp = client.update_route_calculator({
|
4552
4633
|
# calculator_name: "ResourceName", # required
|
4553
|
-
# description: "ResourceDescription",
|
4554
4634
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
4635
|
+
# description: "ResourceDescription",
|
4555
4636
|
# })
|
4556
4637
|
#
|
4557
4638
|
# @example Response structure
|
4558
4639
|
#
|
4559
|
-
# resp.calculator_arn #=> String
|
4560
4640
|
# resp.calculator_name #=> String
|
4641
|
+
# resp.calculator_arn #=> String
|
4561
4642
|
# resp.update_time #=> Time
|
4562
4643
|
#
|
4563
4644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculator AWS API Documentation
|
@@ -4571,29 +4652,18 @@ module Aws::LocationService
|
|
4571
4652
|
|
4572
4653
|
# Updates the specified properties of a given tracker resource.
|
4573
4654
|
#
|
4574
|
-
# @option params [String] :
|
4575
|
-
#
|
4576
|
-
#
|
4577
|
-
# @option params [Boolean] :event_bridge_enabled
|
4578
|
-
# Whether to enable position `UPDATE` events from this tracker to be
|
4579
|
-
# sent to EventBridge.
|
4580
|
-
#
|
4581
|
-
# <note markdown="1"> You do not need enable this feature to get `ENTER` and `EXIT` events
|
4582
|
-
# for geofences with this tracker. Those events are always sent to
|
4583
|
-
# EventBridge.
|
4584
|
-
#
|
4585
|
-
# </note>
|
4586
|
-
#
|
4587
|
-
# @option params [Boolean] :kms_key_enable_geospatial_queries
|
4588
|
-
# Enables `GeospatialQueries` for a tracker that uses a [Amazon Web
|
4589
|
-
# Services KMS customer managed key][1].
|
4590
|
-
#
|
4591
|
-
# This parameter is only used if you are using a KMS customer managed
|
4592
|
-
# key.
|
4655
|
+
# @option params [required, String] :tracker_name
|
4656
|
+
# The name of the tracker resource to update.
|
4593
4657
|
#
|
4658
|
+
# @option params [String] :pricing_plan
|
4659
|
+
# No longer used. If included, the only allowed value is
|
4660
|
+
# `RequestBasedUsage`.
|
4594
4661
|
#
|
4662
|
+
# @option params [String] :pricing_plan_data_source
|
4663
|
+
# This parameter is no longer used.
|
4595
4664
|
#
|
4596
|
-
#
|
4665
|
+
# @option params [String] :description
|
4666
|
+
# Updates the description for the tracker resource.
|
4597
4667
|
#
|
4598
4668
|
# @option params [String] :position_filtering
|
4599
4669
|
# Updates the position filtering for the tracker resource.
|
@@ -4623,38 +4693,49 @@ module Aws::LocationService
|
|
4623
4693
|
# and can help control costs by reducing the number of geofence
|
4624
4694
|
# evaluations.
|
4625
4695
|
#
|
4626
|
-
# @option params [
|
4627
|
-
#
|
4628
|
-
#
|
4696
|
+
# @option params [Boolean] :event_bridge_enabled
|
4697
|
+
# Whether to enable position `UPDATE` events from this tracker to be
|
4698
|
+
# sent to EventBridge.
|
4629
4699
|
#
|
4630
|
-
#
|
4631
|
-
#
|
4700
|
+
# <note markdown="1"> You do not need enable this feature to get `ENTER` and `EXIT` events
|
4701
|
+
# for geofences with this tracker. Those events are always sent to
|
4702
|
+
# EventBridge.
|
4632
4703
|
#
|
4633
|
-
#
|
4634
|
-
#
|
4704
|
+
# </note>
|
4705
|
+
#
|
4706
|
+
# @option params [Boolean] :kms_key_enable_geospatial_queries
|
4707
|
+
# Enables `GeospatialQueries` for a tracker that uses a [Amazon Web
|
4708
|
+
# Services KMS customer managed key][1].
|
4709
|
+
#
|
4710
|
+
# This parameter is only used if you are using a KMS customer managed
|
4711
|
+
# key.
|
4712
|
+
#
|
4713
|
+
#
|
4714
|
+
#
|
4715
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
4635
4716
|
#
|
4636
4717
|
# @return [Types::UpdateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4637
4718
|
#
|
4638
|
-
# * {Types::UpdateTrackerResponse#tracker_arn #tracker_arn} => String
|
4639
4719
|
# * {Types::UpdateTrackerResponse#tracker_name #tracker_name} => String
|
4720
|
+
# * {Types::UpdateTrackerResponse#tracker_arn #tracker_arn} => String
|
4640
4721
|
# * {Types::UpdateTrackerResponse#update_time #update_time} => Time
|
4641
4722
|
#
|
4642
4723
|
# @example Request syntax with placeholder values
|
4643
4724
|
#
|
4644
4725
|
# resp = client.update_tracker({
|
4726
|
+
# tracker_name: "ResourceName", # required
|
4727
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
4728
|
+
# pricing_plan_data_source: "String",
|
4645
4729
|
# description: "ResourceDescription",
|
4730
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
4646
4731
|
# event_bridge_enabled: false,
|
4647
4732
|
# kms_key_enable_geospatial_queries: false,
|
4648
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
4649
|
-
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
4650
|
-
# pricing_plan_data_source: "String",
|
4651
|
-
# tracker_name: "ResourceName", # required
|
4652
4733
|
# })
|
4653
4734
|
#
|
4654
4735
|
# @example Response structure
|
4655
4736
|
#
|
4656
|
-
# resp.tracker_arn #=> String
|
4657
4737
|
# resp.tracker_name #=> String
|
4738
|
+
# resp.tracker_arn #=> String
|
4658
4739
|
# resp.update_time #=> Time
|
4659
4740
|
#
|
4660
4741
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateTracker AWS API Documentation
|
@@ -4666,6 +4747,101 @@ module Aws::LocationService
|
|
4666
4747
|
req.send_request(options)
|
4667
4748
|
end
|
4668
4749
|
|
4750
|
+
# Verifies the integrity of the device's position by determining if it
|
4751
|
+
# was reported behind a proxy, and by comparing it to an inferred
|
4752
|
+
# position estimated based on the device's state.
|
4753
|
+
#
|
4754
|
+
# @option params [required, String] :tracker_name
|
4755
|
+
# The name of the tracker resource to be associated with verification
|
4756
|
+
# request.
|
4757
|
+
#
|
4758
|
+
# @option params [required, Types::DeviceState] :device_state
|
4759
|
+
# The device's state, including position, IP address, cell signals and
|
4760
|
+
# Wi-Fi access points.
|
4761
|
+
#
|
4762
|
+
# @option params [String] :distance_unit
|
4763
|
+
# The distance unit for the verification request.
|
4764
|
+
#
|
4765
|
+
# Default Value: `Kilometers`
|
4766
|
+
#
|
4767
|
+
# @return [Types::VerifyDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4768
|
+
#
|
4769
|
+
# * {Types::VerifyDevicePositionResponse#inferred_state #inferred_state} => Types::InferredState
|
4770
|
+
# * {Types::VerifyDevicePositionResponse#device_id #device_id} => String
|
4771
|
+
# * {Types::VerifyDevicePositionResponse#sample_time #sample_time} => Time
|
4772
|
+
# * {Types::VerifyDevicePositionResponse#received_time #received_time} => Time
|
4773
|
+
# * {Types::VerifyDevicePositionResponse#distance_unit #distance_unit} => String
|
4774
|
+
#
|
4775
|
+
# @example Request syntax with placeholder values
|
4776
|
+
#
|
4777
|
+
# resp = client.verify_device_position({
|
4778
|
+
# tracker_name: "ResourceName", # required
|
4779
|
+
# device_state: { # required
|
4780
|
+
# device_id: "Id", # required
|
4781
|
+
# sample_time: Time.now, # required
|
4782
|
+
# position: [1.0], # required
|
4783
|
+
# accuracy: {
|
4784
|
+
# horizontal: 1.0, # required
|
4785
|
+
# },
|
4786
|
+
# ipv_4_address: "DeviceStateIpv4AddressString",
|
4787
|
+
# wi_fi_access_points: [
|
4788
|
+
# {
|
4789
|
+
# mac_address: "WiFiAccessPointMacAddressString", # required
|
4790
|
+
# rss: 1, # required
|
4791
|
+
# },
|
4792
|
+
# ],
|
4793
|
+
# cell_signals: {
|
4794
|
+
# lte_cell_details: [ # required
|
4795
|
+
# {
|
4796
|
+
# cell_id: 1, # required
|
4797
|
+
# mcc: 1, # required
|
4798
|
+
# mnc: 1, # required
|
4799
|
+
# local_id: {
|
4800
|
+
# earfcn: 1, # required
|
4801
|
+
# pci: 1, # required
|
4802
|
+
# },
|
4803
|
+
# network_measurements: [
|
4804
|
+
# {
|
4805
|
+
# earfcn: 1, # required
|
4806
|
+
# cell_id: 1, # required
|
4807
|
+
# pci: 1, # required
|
4808
|
+
# rsrp: 1,
|
4809
|
+
# rsrq: 1.0,
|
4810
|
+
# },
|
4811
|
+
# ],
|
4812
|
+
# timing_advance: 1,
|
4813
|
+
# nr_capable: false,
|
4814
|
+
# rsrp: 1,
|
4815
|
+
# rsrq: 1.0,
|
4816
|
+
# tac: 1,
|
4817
|
+
# },
|
4818
|
+
# ],
|
4819
|
+
# },
|
4820
|
+
# },
|
4821
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
4822
|
+
# })
|
4823
|
+
#
|
4824
|
+
# @example Response structure
|
4825
|
+
#
|
4826
|
+
# resp.inferred_state.position #=> Array
|
4827
|
+
# resp.inferred_state.position[0] #=> Float
|
4828
|
+
# resp.inferred_state.accuracy.horizontal #=> Float
|
4829
|
+
# resp.inferred_state.deviation_distance #=> Float
|
4830
|
+
# resp.inferred_state.proxy_detected #=> Boolean
|
4831
|
+
# resp.device_id #=> String
|
4832
|
+
# resp.sample_time #=> Time
|
4833
|
+
# resp.received_time #=> Time
|
4834
|
+
# resp.distance_unit #=> String, one of "Kilometers", "Miles"
|
4835
|
+
#
|
4836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/VerifyDevicePosition AWS API Documentation
|
4837
|
+
#
|
4838
|
+
# @overload verify_device_position(params = {})
|
4839
|
+
# @param [Hash] params ({})
|
4840
|
+
def verify_device_position(params = {}, options = {})
|
4841
|
+
req = build_request(:verify_device_position, params)
|
4842
|
+
req.send_request(options)
|
4843
|
+
end
|
4844
|
+
|
4669
4845
|
# @!endgroup
|
4670
4846
|
|
4671
4847
|
# @param params ({})
|
@@ -4679,7 +4855,7 @@ module Aws::LocationService
|
|
4679
4855
|
params: params,
|
4680
4856
|
config: config)
|
4681
4857
|
context[:gem_name] = 'aws-sdk-locationservice'
|
4682
|
-
context[:gem_version] = '1.
|
4858
|
+
context[:gem_version] = '1.52.0'
|
4683
4859
|
Seahorse::Client::Request.new(handlers, context)
|
4684
4860
|
end
|
4685
4861
|
|