aws-sdk-locationservice 1.42.0 → 1.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f21f441ef594da351249f1b8f0c7c7fee98bf52c2860a0cde938626bb31d767
-  data.tar.gz: ea22d8aa9e97ace9ddcbb693edadbb6b1e4958aaed2e5b4b4401da87cead4d0f
+  metadata.gz: 93e9fe61b27c4450689cf2675904d8df7550dff97541dbdeff5875d7789b2e3e
+  data.tar.gz: d4d2c0cc017600f225d45ffb864d70fcf2b9db0e5e12b7b2388cbd1e703bbbae
 SHA512:
-  metadata.gz: 12cb78aee0779d4a2a764a45fc024cb2080f5a56d643936716786f785f95641feec541feeb10e64beb4e313d23b67d3978cc6f6e17ee0a43f4136d992d3ce2fb
-  data.tar.gz: 05af8631c541ac1c1351eadd10650bd3886454880ae0a50ff0c8c1ff2558bba0f873f36043a834850ff2208faf311fd917d706e6afc6f14bdf9ffd5d9c1b47ef
+  metadata.gz: f5047b6482d2b2dfd4ef976d5ea70ebb37ec1a90053168dac5916cc293a951a7e11773f060ffad763716d8fd8581debbd27eb6e1ed5ee1092526c931c3bfc968
+  data.tar.gz: e14e84d16379acff2d4d28d83b62859d1374c38818c91f9289d5f92ed9e0dd9575d25ff614c961dfae0feb6b35e78aeb3b00276e180d4b861ac58abc47637652

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.44.0 (2023-12-29)
+------------------
+
+* Feature - This release introduces a new parameter to bypasses an API key's expiry conditions and delete the key.
+
+1.43.0 (2023-12-12)
+------------------
+
+* Feature - This release 1)  adds sub-municipality field in Places API for searching and getting places information, and 2) allows optimizing route calculation based on expected arrival time.
+
 1.42.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.42.0
+1.44.0

data/lib/aws-sdk-locationservice/client.rb

@@ -812,6 +812,15 @@ module Aws::LocationService
     # [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
     # [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
     #
+    # @option params [Time,DateTime,Date,Integer,String] :arrival_time
+    #   Specifies the desired time of arrival. Uses the given time to
+    #   calculate the route. Otherwise, the best time of day to travel with
+    #   the best traffic conditions is used to calculate the route.
+    #
+    #   <note markdown="1"> ArrivalTime is not supported Esri.
+    #
+    #    </note>
+    #
     # @option params [required, String] :calculator_name
     #   The name of the route calculator resource that you want to use to
     #   calculate the route.
@@ -858,11 +867,6 @@ module Aws::LocationService
     #   calculate the route. Otherwise, the best time of day to travel with
     #   the best traffic conditions is used to calculate the route.
     #
-    #   <note markdown="1"> Setting a departure time in the past returns a `400
-    #   ValidationException` error.
-    #
-    #    </note>
-    #
     #   * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
     #     `2020–07-2T12:15:20.000Z+01:00`
     #
@@ -912,6 +916,9 @@ module Aws::LocationService
     #
     #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
     #
+    # @option params [String] :optimize_for
+    #   Specifies the distance to optimize for when calculating a route.
+    #
     # @option params [String] :travel_mode
     #   Specifies the mode of transport when calculating a route. Used in
     #   estimating the speed of travel and road compatibility. You can choose
@@ -986,6 +993,7 @@ module Aws::LocationService
     # @example Request syntax with placeholder values
     #
     #   resp = client.calculate_route({
+    #     arrival_time: Time.now,
     #     calculator_name: "ResourceName", # required
     #     car_mode_options: {
     #       avoid_ferries: false,
@@ -998,6 +1006,7 @@ module Aws::LocationService
     #     distance_unit: "Kilometers", # accepts Kilometers, Miles
     #     include_leg_geometry: false,
     #     key: "ApiKey",
+    #     optimize_for: "FastestRoute", # accepts FastestRoute, ShortestRoute
     #     travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle
     #     truck_mode_options: {
     #       avoid_ferries: false,
@@ -2060,6 +2069,20 @@ module Aws::LocationService
     # Deletes the specified API key. The API key must have been deactivated
     # more than 90 days previously.
     #
+    # @option params [Boolean] :force_delete
+    #   ForceDelete bypasses an API key's expiry conditions and deletes the
+    #   key. Set the parameter `true` to delete the key or to `false` to not
+    #   preemptively delete the API key.
+    #
+    #   Valid values: `true`, or `false`.
+    #
+    #   Required: No
+    #
+    #   <note markdown="1"> This action is irreversible. Only use ForceDelete if you are certain
+    #   the key is no longer in use.
+    #
+    #    </note>
+    #
     # @option params [required, String] :key_name
     #   The name of the API key to delete.
     #
@@ -2068,6 +2091,7 @@ module Aws::LocationService
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_key({
+    #     force_delete: false,
     #     key_name: "ResourceName", # required
     #   })
     #
@@ -3066,6 +3090,7 @@ module Aws::LocationService
     #   resp.place.postal_code #=> String
     #   resp.place.region #=> String
     #   resp.place.street #=> String
+    #   resp.place.sub_municipality #=> String
     #   resp.place.sub_region #=> String
     #   resp.place.supplemental_categories #=> Array
     #   resp.place.supplemental_categories[0] #=> String
@@ -3086,7 +3111,7 @@ module Aws::LocationService
     # A batch request to retrieve all device positions.
     #
     # @option params [Types::TrackingFilterGeometry] :filter_geometry
-    #   The geomerty used to filter device positions.
+    #   The geometry used to filter device positions.
     #
     # @option params [Integer] :max_results
     #   An optional limit for the number of entries returned in a single call.
@@ -3745,6 +3770,7 @@ module Aws::LocationService
     #   resp.results[0].place.postal_code #=> String
     #   resp.results[0].place.region #=> String
     #   resp.results[0].place.street #=> String
+    #   resp.results[0].place.sub_municipality #=> String
     #   resp.results[0].place.sub_region #=> String
     #   resp.results[0].place.supplemental_categories #=> Array
     #   resp.results[0].place.supplemental_categories[0] #=> String
@@ -4095,6 +4121,7 @@ module Aws::LocationService
     #   resp.results[0].place.postal_code #=> String
     #   resp.results[0].place.region #=> String
     #   resp.results[0].place.street #=> String
+    #   resp.results[0].place.sub_municipality #=> String
     #   resp.results[0].place.sub_region #=> String
     #   resp.results[0].place.supplemental_categories #=> Array
     #   resp.results[0].place.supplemental_categories[0] #=> String
@@ -4590,7 +4617,7 @@ module Aws::LocationService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-locationservice'
-      context[:gem_version] = '1.42.0'
+      context[:gem_version] = '1.44.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-locationservice/client_api.rb

@@ -220,6 +220,7 @@ module Aws::LocationService
     MapConfiguration = Shapes::StructureShape.new(name: 'MapConfiguration')
     MapConfigurationUpdate = Shapes::StructureShape.new(name: 'MapConfigurationUpdate')
     MapStyle = Shapes::StringShape.new(name: 'MapStyle')
+    OptimizationMode = Shapes::StringShape.new(name: 'OptimizationMode')
     Place = Shapes::StructureShape.new(name: 'Place')
     PlaceCategory = Shapes::StringShape.new(name: 'PlaceCategory')
     PlaceCategoryList = Shapes::ListShape.new(name: 'PlaceCategoryList')
@@ -490,6 +491,7 @@ module Aws::LocationService
     CalculateRouteMatrixSummary.add_member(:route_count, Shapes::ShapeRef.new(shape: CalculateRouteMatrixSummaryRouteCountInteger, required: true, location_name: "RouteCount"))
     CalculateRouteMatrixSummary.struct_class = Types::CalculateRouteMatrixSummary
 
+    CalculateRouteRequest.add_member(:arrival_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ArrivalTime"))
     CalculateRouteRequest.add_member(:calculator_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location: "uri", location_name: "CalculatorName"))
     CalculateRouteRequest.add_member(:car_mode_options, Shapes::ShapeRef.new(shape: CalculateRouteCarModeOptions, location_name: "CarModeOptions"))
     CalculateRouteRequest.add_member(:depart_now, Shapes::ShapeRef.new(shape: Boolean, location_name: "DepartNow"))
@@ -499,6 +501,7 @@ module Aws::LocationService
     CalculateRouteRequest.add_member(:distance_unit, Shapes::ShapeRef.new(shape: DistanceUnit, location_name: "DistanceUnit"))
     CalculateRouteRequest.add_member(:include_leg_geometry, Shapes::ShapeRef.new(shape: Boolean, location_name: "IncludeLegGeometry"))
     CalculateRouteRequest.add_member(:key, Shapes::ShapeRef.new(shape: ApiKey, location: "querystring", location_name: "key"))
+    CalculateRouteRequest.add_member(:optimize_for, Shapes::ShapeRef.new(shape: OptimizationMode, location_name: "OptimizeFor"))
     CalculateRouteRequest.add_member(:travel_mode, Shapes::ShapeRef.new(shape: TravelMode, location_name: "TravelMode"))
     CalculateRouteRequest.add_member(:truck_mode_options, Shapes::ShapeRef.new(shape: CalculateRouteTruckModeOptions, location_name: "TruckModeOptions"))
     CalculateRouteRequest.add_member(:waypoint_positions, Shapes::ShapeRef.new(shape: CalculateRouteRequestWaypointPositionsList, location_name: "WaypointPositions"))
@@ -620,6 +623,7 @@ module Aws::LocationService
 
     DeleteGeofenceCollectionResponse.struct_class = Types::DeleteGeofenceCollectionResponse
 
+    DeleteKeyRequest.add_member(:force_delete, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "forceDelete"))
     DeleteKeyRequest.add_member(:key_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location: "uri", location_name: "KeyName"))
     DeleteKeyRequest.struct_class = Types::DeleteKeyRequest
 
@@ -1058,6 +1062,7 @@ module Aws::LocationService
     Place.add_member(:postal_code, Shapes::ShapeRef.new(shape: String, location_name: "PostalCode"))
     Place.add_member(:region, Shapes::ShapeRef.new(shape: String, location_name: "Region"))
     Place.add_member(:street, Shapes::ShapeRef.new(shape: String, location_name: "Street"))
+    Place.add_member(:sub_municipality, Shapes::ShapeRef.new(shape: String, location_name: "SubMunicipality"))
     Place.add_member(:sub_region, Shapes::ShapeRef.new(shape: String, location_name: "SubRegion"))
     Place.add_member(:supplemental_categories, Shapes::ShapeRef.new(shape: PlaceSupplementalCategoryList, location_name: "SupplementalCategories"))
     Place.add_member(:time_zone, Shapes::ShapeRef.new(shape: TimeZone, location_name: "TimeZone"))

data/lib/aws-sdk-locationservice/types.rb

@@ -120,7 +120,7 @@ module Aws::LocationService
     #
     #   * Other than wildcards, you must include the full ARN, including the
     #     `arn`, `partition`, `service`, `region`, `account-id` and
-    #     `resource-id`, delimited by colons (:).
+    #     `resource-id` delimited by colons (:).
     #
     #   * No spaces allowed, even with wildcards. For example,
     #     `arn:aws:geo:region:account-id:map/ExampleMap*`.
@@ -888,6 +888,16 @@ module Aws::LocationService
       include Aws::Structure
     end
 
+    # @!attribute [rw] arrival_time
+    #   Specifies the desired time of arrival. Uses the given time to
+    #   calculate the route. Otherwise, the best time of day to travel with
+    #   the best traffic conditions is used to calculate the route.
+    #
+    #   <note markdown="1"> ArrivalTime is not supported Esri.
+    #
+    #    </note>
+    #   @return [Time]
+    #
     # @!attribute [rw] calculator_name
     #   The name of the route calculator resource that you want to use to
     #   calculate the route.
@@ -938,11 +948,6 @@ module Aws::LocationService
     #   calculate the route. Otherwise, the best time of day to travel with
     #   the best traffic conditions is used to calculate the route.
     #
-    #   <note markdown="1"> Setting a departure time in the past returns a `400
-    #   ValidationException` error.
-    #
-    #    </note>
-    #
     #   * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
     #     `2020–07-2T12:15:20.000Z+01:00`
     #
@@ -997,6 +1002,10 @@ module Aws::LocationService
     #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
     #   @return [String]
     #
+    # @!attribute [rw] optimize_for
+    #   Specifies the distance to optimize for when calculating a route.
+    #   @return [String]
+    #
     # @!attribute [rw] travel_mode
     #   Specifies the mode of transport when calculating a route. Used in
     #   estimating the speed of travel and road compatibility. You can
@@ -1069,6 +1078,7 @@ module Aws::LocationService
     # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteRequest AWS API Documentation
     #
     class CalculateRouteRequest < Struct.new(
+      :arrival_time,
       :calculator_name,
       :car_mode_options,
       :depart_now,
@@ -1078,6 +1088,7 @@ module Aws::LocationService
       :distance_unit,
       :include_leg_geometry,
       :key,
+      :optimize_for,
       :travel_mode,
       :truck_mode_options,
       :waypoint_positions)
@@ -2115,6 +2126,21 @@ module Aws::LocationService
     #
     class DeleteGeofenceCollectionResponse < Aws::EmptyStructure; end
 
+    # @!attribute [rw] force_delete
+    #   ForceDelete bypasses an API key's expiry conditions and deletes the
+    #   key. Set the parameter `true` to delete the key or to `false` to not
+    #   preemptively delete the API key.
+    #
+    #   Valid values: `true`, or `false`.
+    #
+    #   Required: No
+    #
+    #   <note markdown="1"> This action is irreversible. Only use ForceDelete if you are certain
+    #   the key is no longer in use.
+    #
+    #    </note>
+    #   @return [Boolean]
+    #
     # @!attribute [rw] key_name
     #   The name of the API key to delete.
     #   @return [String]
@@ -2122,6 +2148,7 @@ module Aws::LocationService
     # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKeyRequest AWS API Documentation
     #
     class DeleteKeyRequest < Struct.new(
+      :force_delete,
       :key_name)
       SENSITIVE = []
       include Aws::Structure
@@ -3656,7 +3683,7 @@ module Aws::LocationService
     end
 
     # @!attribute [rw] filter_geometry
-    #   The geomerty used to filter device positions.
+    #   The geometry used to filter device positions.
     #   @return [Types::TrackingFilterGeometry]
     #
     # @!attribute [rw] max_results
@@ -4802,6 +4829,16 @@ module Aws::LocationService
     #   `Main Street`.
     #   @return [String]
     #
+    # @!attribute [rw] sub_municipality
+    #   An area that's part of a larger municipality. For example,
+    #   `Blissville ` is a submunicipality in the Queen County in New York.
+    #
+    #   <note markdown="1"> This property supported by Esri and OpenData. The Esri property is
+    #   `district`, and the OpenData property is `borough`.
+    #
+    #    </note>
+    #   @return [String]
+    #
     # @!attribute [rw] sub_region
     #   A county, or an area that's part of a larger region. For example,
     #   `Metro Vancouver`.
@@ -4850,6 +4887,7 @@ module Aws::LocationService
       :postal_code,
       :region,
       :street,
+      :sub_municipality,
       :sub_region,
       :supplemental_categories,
       :time_zone,

data/lib/aws-sdk-locationservice.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-locationservice/customizations'
 # @!group service
 module Aws::LocationService
 
-  GEM_VERSION = '1.42.0'
+  GEM_VERSION = '1.44.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-locationservice
 version: !ruby/object:Gem::Version
-  version: 1.42.0
+  version: 1.44.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core