aws-sdk-locationservice 1.23.0 → 1.25.0

data/lib/aws-sdk-locationservice/plugins/endpoints.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+module Aws::LocationService
+  module Plugins
+    class Endpoints < Seahorse::Client::Plugin
+      option(
+        :endpoint_provider,
+        doc_type: 'Aws::LocationService::EndpointProvider',
+        docstring: 'The endpoint provider used to resolve endpoints. Any '\
+                   'object that responds to `#resolve_endpoint(parameters)` '\
+                   'where `parameters` is a Struct similar to '\
+                   '`Aws::LocationService::EndpointParameters`'
+      ) do |cfg|
+        Aws::LocationService::EndpointProvider.new
+      end
+
+      # @api private
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          # If endpoint was discovered, do not resolve or apply the endpoint.
+          unless context[:discovered_endpoint]
+            params = parameters_for_operation(context)
+            endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+            context.http_request.endpoint = endpoint.url
+            apply_endpoint_headers(context, endpoint.headers)
+          end
+
+          context[:endpoint_params] = params
+          context[:auth_scheme] =
+            Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+          @handler.call(context)
+        end
+
+        private
+
+        def apply_endpoint_headers(context, headers)
+          headers.each do |key, values|
+            value = values
+              .compact
+              .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+              .join(',')
+
+            context.http_request.headers[key] = value
+          end
+        end
+
+        def parameters_for_operation(context)
+          case context.operation_name
+          when :associate_tracker_consumer
+            Aws::LocationService::Endpoints::AssociateTrackerConsumer.build(context)
+          when :batch_delete_device_position_history
+            Aws::LocationService::Endpoints::BatchDeleteDevicePositionHistory.build(context)
+          when :batch_delete_geofence
+            Aws::LocationService::Endpoints::BatchDeleteGeofence.build(context)
+          when :batch_evaluate_geofences
+            Aws::LocationService::Endpoints::BatchEvaluateGeofences.build(context)
+          when :batch_get_device_position
+            Aws::LocationService::Endpoints::BatchGetDevicePosition.build(context)
+          when :batch_put_geofence
+            Aws::LocationService::Endpoints::BatchPutGeofence.build(context)
+          when :batch_update_device_position
+            Aws::LocationService::Endpoints::BatchUpdateDevicePosition.build(context)
+          when :calculate_route
+            Aws::LocationService::Endpoints::CalculateRoute.build(context)
+          when :calculate_route_matrix
+            Aws::LocationService::Endpoints::CalculateRouteMatrix.build(context)
+          when :create_geofence_collection
+            Aws::LocationService::Endpoints::CreateGeofenceCollection.build(context)
+          when :create_map
+            Aws::LocationService::Endpoints::CreateMap.build(context)
+          when :create_place_index
+            Aws::LocationService::Endpoints::CreatePlaceIndex.build(context)
+          when :create_route_calculator
+            Aws::LocationService::Endpoints::CreateRouteCalculator.build(context)
+          when :create_tracker
+            Aws::LocationService::Endpoints::CreateTracker.build(context)
+          when :delete_geofence_collection
+            Aws::LocationService::Endpoints::DeleteGeofenceCollection.build(context)
+          when :delete_map
+            Aws::LocationService::Endpoints::DeleteMap.build(context)
+          when :delete_place_index
+            Aws::LocationService::Endpoints::DeletePlaceIndex.build(context)
+          when :delete_route_calculator
+            Aws::LocationService::Endpoints::DeleteRouteCalculator.build(context)
+          when :delete_tracker
+            Aws::LocationService::Endpoints::DeleteTracker.build(context)
+          when :describe_geofence_collection
+            Aws::LocationService::Endpoints::DescribeGeofenceCollection.build(context)
+          when :describe_map
+            Aws::LocationService::Endpoints::DescribeMap.build(context)
+          when :describe_place_index
+            Aws::LocationService::Endpoints::DescribePlaceIndex.build(context)
+          when :describe_route_calculator
+            Aws::LocationService::Endpoints::DescribeRouteCalculator.build(context)
+          when :describe_tracker
+            Aws::LocationService::Endpoints::DescribeTracker.build(context)
+          when :disassociate_tracker_consumer
+            Aws::LocationService::Endpoints::DisassociateTrackerConsumer.build(context)
+          when :get_device_position
+            Aws::LocationService::Endpoints::GetDevicePosition.build(context)
+          when :get_device_position_history
+            Aws::LocationService::Endpoints::GetDevicePositionHistory.build(context)
+          when :get_geofence
+            Aws::LocationService::Endpoints::GetGeofence.build(context)
+          when :get_map_glyphs
+            Aws::LocationService::Endpoints::GetMapGlyphs.build(context)
+          when :get_map_sprites
+            Aws::LocationService::Endpoints::GetMapSprites.build(context)
+          when :get_map_style_descriptor
+            Aws::LocationService::Endpoints::GetMapStyleDescriptor.build(context)
+          when :get_map_tile
+            Aws::LocationService::Endpoints::GetMapTile.build(context)
+          when :get_place
+            Aws::LocationService::Endpoints::GetPlace.build(context)
+          when :list_device_positions
+            Aws::LocationService::Endpoints::ListDevicePositions.build(context)
+          when :list_geofence_collections
+            Aws::LocationService::Endpoints::ListGeofenceCollections.build(context)
+          when :list_geofences
+            Aws::LocationService::Endpoints::ListGeofences.build(context)
+          when :list_maps
+            Aws::LocationService::Endpoints::ListMaps.build(context)
+          when :list_place_indexes
+            Aws::LocationService::Endpoints::ListPlaceIndexes.build(context)
+          when :list_route_calculators
+            Aws::LocationService::Endpoints::ListRouteCalculators.build(context)
+          when :list_tags_for_resource
+            Aws::LocationService::Endpoints::ListTagsForResource.build(context)
+          when :list_tracker_consumers
+            Aws::LocationService::Endpoints::ListTrackerConsumers.build(context)
+          when :list_trackers
+            Aws::LocationService::Endpoints::ListTrackers.build(context)
+          when :put_geofence
+            Aws::LocationService::Endpoints::PutGeofence.build(context)
+          when :search_place_index_for_position
+            Aws::LocationService::Endpoints::SearchPlaceIndexForPosition.build(context)
+          when :search_place_index_for_suggestions
+            Aws::LocationService::Endpoints::SearchPlaceIndexForSuggestions.build(context)
+          when :search_place_index_for_text
+            Aws::LocationService::Endpoints::SearchPlaceIndexForText.build(context)
+          when :tag_resource
+            Aws::LocationService::Endpoints::TagResource.build(context)
+          when :untag_resource
+            Aws::LocationService::Endpoints::UntagResource.build(context)
+          when :update_geofence_collection
+            Aws::LocationService::Endpoints::UpdateGeofenceCollection.build(context)
+          when :update_map
+            Aws::LocationService::Endpoints::UpdateMap.build(context)
+          when :update_place_index
+            Aws::LocationService::Endpoints::UpdatePlaceIndex.build(context)
+          when :update_route_calculator
+            Aws::LocationService::Endpoints::UpdateRouteCalculator.build(context)
+          when :update_tracker
+            Aws::LocationService::Endpoints::UpdateTracker.build(context)
+          end
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Handler, step: :build, priority: 75)
+      end
+    end
+  end
+end

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

@@ -1456,7 +1456,9 @@ module Aws::LocationService
     #       }
     #
     # @!attribute [rw] configuration
-    #   Specifies the map style selected from an available data provider.
+    #   Specifies the `MapConfiguration`, including the map style, for the
+    #   map resource that you create. The map style defines the look of maps
+    #   and the data provider for your map resource.
     #   @return [Types::MapConfiguration]
     #
     # @!attribute [rw] description
@@ -1529,7 +1531,7 @@ module Aws::LocationService
     #   The Amazon Resource Name (ARN) for the map resource. Used to specify
     #   a resource across all AWS.
     #
-    #   * Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`
+    #   * Format example: `arn:aws:geo:region:account-id:map/ExampleMap`
     #
     #   ^
     #   @return [String]
@@ -2297,7 +2299,7 @@ module Aws::LocationService
     #   The Amazon Resource Name (ARN) for the map resource. Used to specify
     #   a resource across all AWS.
     #
-    #   * Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`
+    #   * Format example: `arn:aws:geo:region:account-id:map/ExampleMap`
     #
     #   ^
     #   @return [String]
@@ -2818,20 +2820,27 @@ module Aws::LocationService
     #   @return [Types::Circle]
     #
     # @!attribute [rw] polygon
-    #   An array of 1 or more linear rings. A linear ring is an array of 4
-    #   or more vertices, where the first and last vertex are the same to
-    #   form a closed boundary. Each vertex is a 2-dimensional point of the
-    #   form: `[longitude, latitude]`.
-    #
-    #   The first linear ring is an outer ring, describing the polygon's
-    #   boundary. Subsequent linear rings may be inner or outer rings to
-    #   describe holes and islands. Outer rings must list their vertices in
-    #   counter-clockwise order around the ring's center, where the left
-    #   side is the polygon's exterior. Inner rings must list their
-    #   vertices in clockwise order, where the left side is the polygon's
-    #   interior.
-    #
-    #   A geofence polygon can consist of between 4 and 1,000 vertices.
+    #   A polygon is a list of linear rings which are each made up of a list
+    #   of vertices.
+    #
+    #   Each vertex is a 2-dimensional point of the form: `[longitude,
+    #   latitude]`. This is represented as an array of doubles of length 2
+    #   (so `[double, double]`).
+    #
+    #   An array of 4 or more vertices, where the first and last vertex are
+    #   the same (to form a closed boundary), is called a linear ring. The
+    #   linear ring vertices must be listed in counter-clockwise order
+    #   around the ring’s interior. The linear ring is represented as an
+    #   array of vertices, or an array of arrays of doubles (`[[double,
+    #   double], ...]`).
+    #
+    #   A geofence consists of a single linear ring. To allow for future
+    #   expansion, the Polygon parameter takes an array of linear rings,
+    #   which is represented as an array of arrays of arrays of doubles
+    #   (`[[[double, double], ...], ...]`).
+    #
+    #   A linear ring for use in geofences can consist of between 4 and
+    #   1,000 vertices.
     #   @return [Array<Array<Array<Float>>>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GeofenceGeometry AWS API Documentation
@@ -3131,9 +3140,10 @@ module Aws::LocationService
     #
     #   * VectorHereContrast – `Fira GO Regular` \| `Fira GO Bold`
     #
-    #   * VectorHereExplore, VectorHereExploreTruck – `Firo GO Italic` \|
-    #     `Fira GO Map` \| `Fira GO Map Bold` \| `Noto Sans CJK JP Bold` \|
-    #     `Noto Sans CJK JP Light` \| `Noto Sans CJK JP Regular`
+    #   * VectorHereExplore, VectorHereExploreTruck,
+    #     HybridHereExploreSatellite – `Fira GO Italic` \| `Fira GO Map` \|
+    #     `Fira GO Map Bold` \| `Noto Sans CJK JP Bold` \| `Noto Sans CJK JP
+    #     Light` \| `Noto Sans CJK JP Regular`
     #
     #
     #
@@ -3195,8 +3205,8 @@ module Aws::LocationService
     #
     #   * `sprites@2x.png` for high pixel density displays
     #
-    #   For the JSON document contain image offsets. Use the following file
-    #   names:
+    #   For the JSON document containing image offsets. Use the following
+    #   file names:
     #
     #   * `sprites.json`
     #
@@ -3327,6 +3337,71 @@ module Aws::LocationService
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetPlaceRequest
+    #   data as a hash:
+    #
+    #       {
+    #         index_name: "ResourceName", # required
+    #         language: "LanguageTag",
+    #         place_id: "PlaceId", # required
+    #       }
+    #
+    # @!attribute [rw] index_name
+    #   The name of the place index resource that you want to use for the
+    #   search.
+    #   @return [String]
+    #
+    # @!attribute [rw] language
+    #   The preferred language used to return results. The value must be a
+    #   valid [BCP 47][1] language tag, for example, `en` for English.
+    #
+    #   This setting affects the languages used in the results, but not the
+    #   results themselves. If no language is specified, or not supported
+    #   for a particular result, the partner automatically chooses a
+    #   language for the result.
+    #
+    #   For an example, we'll use the Greek language. You search for a
+    #   location around Athens, Greece, with the `language` parameter set to
+    #   `en`. The `city` in the results will most likely be returned as
+    #   `Athens`.
+    #
+    #   If you set the `language` parameter to `el`, for Greek, then the
+    #   `city` in the results will more likely be returned as `Αθήνα`.
+    #
+    #   If the data provider does not have a value for Greek, the result
+    #   will be in a language that the provider does support.
+    #
+    #
+    #
+    #   [1]: https://tools.ietf.org/search/bcp47
+    #   @return [String]
+    #
+    # @!attribute [rw] place_id
+    #   The identifier of the place to find.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlaceRequest AWS API Documentation
+    #
+    class GetPlaceRequest < Struct.new(
+      :index_name,
+      :language,
+      :place_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] place
+    #   Details about the result, such as its address and position.
+    #   @return [Types::Place]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlaceResponse AWS API Documentation
+    #
+    class GetPlaceResponse < Struct.new(
+      :place)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The request has failed to process because of an unknown server error,
     # exception, or failure.
     #
@@ -4352,6 +4427,12 @@ module Aws::LocationService
     #     high contrast detailed base map of the world that blends 3D and 2D
     #     rendering.
     #
+    #     <note markdown="1"> The `VectorHereContrast` style has been renamed from
+    #     `VectorHereBerlin`. `VectorHereBerlin` has been deprecated, but
+    #     will continue to work in applications that use it.
+    #
+    #      </note>
+    #
     #   * `VectorHereExplore` – A default HERE map style containing a
     #     neutral, global map and its features including roads, buildings,
     #     landmarks, and water features. It also now includes a fully
@@ -4362,11 +4443,20 @@ module Aws::LocationService
     #     symbolized with highlighted segments and icons on top of HERE
     #     Explore to support use cases within transport and logistics.
     #
-    #   <note markdown="1"> The `VectorHereContrast` style has been renamed from
-    #   `VectorHereBerlin`. `VectorHereBerlin` has been deprecated, but will
-    #   continue to work in applications that use it.
+    #   * `RasterHereExploreSatellite` – A global map containing high
+    #     resolution satellite imagery.
     #
-    #    </note>
+    #   * `HybridHereExploreSatellite` – A global map displaying the road
+    #     network, street names, and city labels over satellite imagery.
+    #     This style will automatically retrieve both raster and vector
+    #     tiles, and your charges will be based on total tiles retrieved.
+    #
+    #     <note markdown="1"> Hybrid styles use both vector and raster tiles when rendering the
+    #     map that you see. This means that more tiles are retrieved than
+    #     when using either vector or raster tiles alone. Your charges will
+    #     include all tiles retrieved.
+    #
+    #      </note>
     #
     #
     #
@@ -4454,9 +4544,24 @@ module Aws::LocationService
     #
     # @!attribute [rw] time_zone
     #   The time zone in which the `Place` is located. Returned only when
-    #   using Here as the selected partner.
+    #   using HERE as the selected partner.
     #   @return [Types::TimeZone]
     #
+    # @!attribute [rw] unit_number
+    #   For addresses with multiple units, the unit identifier. Can include
+    #   numbers and letters, for example `3B` or `Unit 123`.
+    #
+    #   <note markdown="1"> Returned only for a place index that uses Esri as a data provider.
+    #   Is not returned for `SearchPlaceIndexForPosition`.
+    #
+    #    </note>
+    #   @return [String]
+    #
+    # @!attribute [rw] unit_type
+    #   For addresses with a `UnitNumber`, the type of unit. For example,
+    #   `Apartment`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Place AWS API Documentation
     #
     class Place < Struct.new(
@@ -4471,7 +4576,9 @@ module Aws::LocationService
       :region,
       :street,
       :sub_region,
-      :time_zone)
+      :time_zone,
+      :unit_number,
+      :unit_type)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4717,11 +4824,22 @@ module Aws::LocationService
     #   Details about the search result, such as its address and position.
     #   @return [Types::Place]
     #
+    # @!attribute [rw] place_id
+    #   The unique identifier of the place. You can use this with the
+    #   `GetPlace` operation to find the place again later.
+    #
+    #   <note markdown="1"> For `SearchPlaceIndexForPosition` operations, the `PlaceId` is
+    #   returned only by place indexes that use HERE as a data provider.
+    #
+    #    </note>
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForPositionResult AWS API Documentation
     #
     class SearchForPositionResult < Struct.new(
       :distance,
-      :place)
+      :place,
+      :place_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4729,6 +4847,16 @@ module Aws::LocationService
     # Contains a place suggestion resulting from a place suggestion query
     # that is run on a place index resource.
     #
+    # @!attribute [rw] place_id
+    #   The unique identifier of the place. You can use this with the
+    #   `GetPlace` operation to find the place again later.
+    #
+    #   <note markdown="1"> For `SearchPlaceIndexForSuggestions` operations, the `PlaceId` is
+    #   returned by place indexes that use HERE or Esri as data providers.
+    #
+    #    </note>
+    #   @return [String]
+    #
     # @!attribute [rw] text
     #   The text of the place suggestion, typically formatted as an address
     #   string.
@@ -4737,6 +4865,7 @@ module Aws::LocationService
     # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForSuggestionsResult AWS API Documentation
     #
     class SearchForSuggestionsResult < Struct.new(
+      :place_id,
       :text)
       SENSITIVE = []
       include Aws::Structure
@@ -4760,6 +4889,16 @@ module Aws::LocationService
     #   Details about the search result, such as its address and position.
     #   @return [Types::Place]
     #
+    # @!attribute [rw] place_id
+    #   The unique identifier of the place. You can use this with the
+    #   `GetPlace` operation to find the place again later.
+    #
+    #   <note markdown="1"> For `SearchPlaceIndexForText` operations, the `PlaceId` is returned
+    #   only by place indexes that use HERE as a data provider.
+    #
+    #    </note>
+    #   @return [String]
+    #
     # @!attribute [rw] relevance
     #   The relative confidence in the match for a result among the results
     #   returned. For example, if more fields for an address match
@@ -4774,6 +4913,7 @@ module Aws::LocationService
     class SearchForTextResult < Struct.new(
       :distance,
       :place,
+      :place_id,
       :relevance)
       SENSITIVE = []
       include Aws::Structure
@@ -5765,7 +5905,7 @@ module Aws::LocationService
     #   The Amazon Resource Name (ARN) of the updated map resource. Used to
     #   specify a resource across AWS.
     #
-    #   * Format example: `arn:aws:geo:region:account-id:maps/ExampleMap`
+    #   * Format example: `arn:aws:geo:region:account-id:map/ExampleMap`
     #
     #   ^
     #   @return [String]

data/lib/aws-sdk-locationservice.rb

@@ -13,9 +13,13 @@ require 'aws-sigv4'
 
 require_relative 'aws-sdk-locationservice/types'
 require_relative 'aws-sdk-locationservice/client_api'
+require_relative 'aws-sdk-locationservice/plugins/endpoints.rb'
 require_relative 'aws-sdk-locationservice/client'
 require_relative 'aws-sdk-locationservice/errors'
 require_relative 'aws-sdk-locationservice/resource'
+require_relative 'aws-sdk-locationservice/endpoint_parameters'
+require_relative 'aws-sdk-locationservice/endpoint_provider'
+require_relative 'aws-sdk-locationservice/endpoints'
 require_relative 'aws-sdk-locationservice/customizations'
 
 # This module provides support for Amazon Location Service. This module is available in the
@@ -48,6 +52,6 @@ require_relative 'aws-sdk-locationservice/customizations'
 # @!group service
 module Aws::LocationService
 
-  GEM_VERSION = '1.23.0'
+  GEM_VERSION = '1.25.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-locationservice
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.127.0
+        version: 3.165.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.127.0
+        version: 3.165.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,11 @@ files:
 - lib/aws-sdk-locationservice/client.rb
 - lib/aws-sdk-locationservice/client_api.rb
 - lib/aws-sdk-locationservice/customizations.rb
+- lib/aws-sdk-locationservice/endpoint_parameters.rb
+- lib/aws-sdk-locationservice/endpoint_provider.rb
+- lib/aws-sdk-locationservice/endpoints.rb
 - lib/aws-sdk-locationservice/errors.rb
+- lib/aws-sdk-locationservice/plugins/endpoints.rb
 - lib/aws-sdk-locationservice/resource.rb
 - lib/aws-sdk-locationservice/types.rb
 homepage: https://github.com/aws/aws-sdk-ruby