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