aws-sdk-locationservice 1.45.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89b887ffbf70ed73ca56dfd7471cf23db5687f29b1a19c9505e703d623e00978
-  data.tar.gz: 24f1436231d0e73d48673c540578ec43c54d46c4e4ba0efa7b3798e9386c51ff
+  metadata.gz: 50d10f2df8a87cd6dc89c24da763dc7d959c71167a1c12ef3430550f9c76ed9a
+  data.tar.gz: df2115307c58372f9756273a277a78df90a684e511cf8da1ac327ce3ac91da70
 SHA512:
-  metadata.gz: f58c229bca8693df274b0527fbac1559e35f2e802fbd6fb4d1c31175867f10a263051d75e59a057a8a74318decb8c9bccd4bd7464f0946bf09733341ff8cd50e
-  data.tar.gz: 0cfb7d458b030ef2ac04422adb97b0a10b3b9d2d3efb5520ae601155cc019685524a1aa5ebf728f516c1df8cb103ebf5d5297c30471bc67f127d2d48f595ddba
+  metadata.gz: 84e3bb5a514858952df9c8129eafd882de2e6aa548834f228166f1d663fbf669ef90efee51da15ddbc626ec849b8821c1c3e22999f6031c7c237e9af2c953c91
+  data.tar.gz: 4738535da3571069d033b1bad2a5f4a030c944c87c7e8231fb485b88c14fae89a1d1a51b85b496e3aad175e45d224174c283347c90cb2692f7e8e28403770b2d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.46.0 (2024-01-12)
+------------------
+
+* Feature - Location SDK documentation update. Added missing fonts to the MapConfiguration data type. Updated note for the SubMunicipality property in the place data type.
+
 1.45.0 (2024-01-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.45.0
+1.46.0

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

@@ -2755,7 +2755,7 @@ module Aws::LocationService
     #     Bold`
     #
     #   * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial
-    #     Bold`
+    #     Bold` \| `Arial Unicode MS Bold` \| `Arial Unicode MS Regular`
     #
     #   Valid font stacks for [HERE Technologies][2] styles:
     #
@@ -3065,6 +3065,39 @@ module Aws::LocationService
     # @option params [required, String] :place_id
     #   The identifier of the place to find.
     #
+    #   While you can use PlaceID in subsequent requests, PlaceID is not
+    #   intended to be a permanent identifier and the ID can change between
+    #   consecutive API calls. Please see the following PlaceID behaviour for
+    #   each data provider:
+    #
+    #   * Esri: Place IDs will change every quarter at a minimum. The typical
+    #     time period for these changes would be March, June, September, and
+    #     December. Place IDs might also change between the typical quarterly
+    #     change but that will be much less frequent.
+    #
+    #   * HERE: We recommend that you cache data for no longer than a week to
+    #     keep your data data fresh. You can assume that less than 1% ID
+    #     shifts will release over release which is approximately 1 - 2 times
+    #     per week.
+    #
+    #   * Grab: Place IDs can expire or become invalid in the following
+    #     situations.
+    #
+    #     * Data operations: The POI may be removed from Grab POI database by
+    #       Grab Map Ops based on the ground-truth, such as being closed in
+    #       the real world, being detected as a duplicate POI, or having
+    #       incorrect information. Grab will synchronize data to the Waypoint
+    #       environment on weekly basis.
+    #
+    #     * Interpolated POI: Interpolated POI is a temporary POI generated in
+    #       real time when serving a request, and it will be marked as derived
+    #       in the `place.result_type` field in the response. The information
+    #       of interpolated POIs will be retained for at least 30 days, which
+    #       means that within 30 days, you are able to obtain POI details by
+    #       Place ID from Place Details API. After 30 days, the interpolated
+    #       POIs(both Place ID and details) may expire and inaccessible from
+    #       the Places Details API.
+    #
     # @return [Types::GetPlaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetPlaceResponse#place #place} => Types::Place
@@ -4621,7 +4654,7 @@ module Aws::LocationService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-locationservice'
-      context[:gem_version] = '1.45.0'
+      context[:gem_version] = '1.46.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -3219,7 +3219,7 @@ module Aws::LocationService
     #     Bold`
     #
     #   * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial
-    #     Bold`
+    #     Bold` \| `Arial Unicode MS Bold` \| `Arial Unicode MS Regular`
     #
     #   Valid font stacks for [HERE Technologies][2] styles:
     #
@@ -3527,6 +3527,39 @@ module Aws::LocationService
     #
     # @!attribute [rw] place_id
     #   The identifier of the place to find.
+    #
+    #   While you can use PlaceID in subsequent requests, PlaceID is not
+    #   intended to be a permanent identifier and the ID can change between
+    #   consecutive API calls. Please see the following PlaceID behaviour
+    #   for each data provider:
+    #
+    #   * Esri: Place IDs will change every quarter at a minimum. The
+    #     typical time period for these changes would be March, June,
+    #     September, and December. Place IDs might also change between the
+    #     typical quarterly change but that will be much less frequent.
+    #
+    #   * HERE: We recommend that you cache data for no longer than a week
+    #     to keep your data data fresh. You can assume that less than 1% ID
+    #     shifts will release over release which is approximately 1 - 2
+    #     times per week.
+    #
+    #   * Grab: Place IDs can expire or become invalid in the following
+    #     situations.
+    #
+    #     * Data operations: The POI may be removed from Grab POI database
+    #       by Grab Map Ops based on the ground-truth, such as being closed
+    #       in the real world, being detected as a duplicate POI, or having
+    #       incorrect information. Grab will synchronize data to the
+    #       Waypoint environment on weekly basis.
+    #
+    #     * Interpolated POI: Interpolated POI is a temporary POI generated
+    #       in real time when serving a request, and it will be marked as
+    #       derived in the `place.result_type` field in the response. The
+    #       information of interpolated POIs will be retained for at least
+    #       30 days, which means that within 30 days, you are able to obtain
+    #       POI details by Place ID from Place Details API. After 30 days,
+    #       the interpolated POIs(both Place ID and details) may expire and
+    #       inaccessible from the Places Details API.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlaceRequest AWS API Documentation
@@ -4585,13 +4618,17 @@ module Aws::LocationService
     # @!attribute [rw] custom_layers
     #   Specifies the custom layers for the style. Leave unset to not enable
     #   any custom layer, or, for styles that support custom layers, you can
-    #   enable layer(s), such as POI layer for the VectorEsriNavigation
+    #   enable layer(s), such as `POI` layer for the VectorEsriNavigation
     #   style. Default is `unset`.
     #
-    #   <note markdown="1"> Not all map resources or styles support custom layers. See Custom
-    #   Layers for more information.
+    #   <note markdown="1"> Currenlty only `VectorEsriNavigation` supports CustomLayers. For
+    #   more information, see [Custom Layers][1].
     #
     #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers
     #   @return [Array<String>]
     #
     # @!attribute [rw] political_view
@@ -4616,10 +4653,15 @@ module Aws::LocationService
     #
     #   Valid [Esri map styles][1]:
     #
-    #   * `VectorEsriDarkGrayCanvas` – The Esri Dark Gray Canvas map style.
-    #     A vector basemap with a dark gray, neutral background with minimal
-    #     colors, labels, and features that's designed to draw attention to
-    #     your thematic content.
+    #   * `VectorEsriNavigation` – The Esri Navigation map style, which
+    #     provides a detailed basemap for the world symbolized with a custom
+    #     navigation map style that's designed for use during the day in
+    #     mobile devices. It also includes a richer set of places, such as
+    #     shops, services, restaurants, attractions, and other points of
+    #     interest. Enable the `POI` layer by setting it in CustomLayers to
+    #     leverage the additional places data.
+    #
+    #
     #
     #   * `RasterEsriImagery` – The Esri Imagery map style. A raster basemap
     #     that provides one meter or better satellite and aerial imagery in
@@ -4639,33 +4681,18 @@ module Aws::LocationService
     #     Esri street map style. The vector tile layer is similar in content
     #     and style to the World Street Map raster map.
     #
-    #   * `VectorEsriNavigation` – The Esri Navigation map style, which
-    #     provides a detailed basemap for the world symbolized with a custom
-    #     navigation map style that's designed for use during the day in
-    #     mobile devices.
+    #   * `VectorEsriDarkGrayCanvas` – The Esri Dark Gray Canvas map style.
+    #     A vector basemap with a dark gray, neutral background with minimal
+    #     colors, labels, and features that's designed to draw attention to
+    #     your thematic content.
     #
     #   Valid [HERE Technologies map styles][2]:
     #
-    #   * `VectorHereContrast` – The HERE Contrast (Berlin) map style is a
-    #     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
     #     designed map of Japan.
     #
-    #   * `VectorHereExploreTruck` – A global map containing truck
-    #     restrictions and attributes (e.g. width / height / HAZMAT)
-    #     symbolized with highlighted segments and icons on top of HERE
-    #     Explore to support use cases within transport and logistics.
-    #
     #   * `RasterHereExploreSatellite` – A global map containing high
     #     resolution satellite imagery.
     #
@@ -4681,6 +4708,21 @@ module Aws::LocationService
     #
     #      </note>
     #
+    #   * `VectorHereContrast` – The HERE Contrast (Berlin) map style is a
+    #     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>
+    #
+    #   * `VectorHereExploreTruck` – A global map containing truck
+    #     restrictions and attributes (e.g. width / height / HAZMAT)
+    #     symbolized with highlighted segments and icons on top of HERE
+    #     Explore to support use cases within transport and logistics.
+    #
     #   Valid [GrabMaps map styles][3]:
     #
     #   * `VectorGrabStandardLight` – The Grab Standard Light map style
@@ -4744,13 +4786,17 @@ module Aws::LocationService
     # @!attribute [rw] custom_layers
     #   Specifies the custom layers for the style. Leave unset to not enable
     #   any custom layer, or, for styles that support custom layers, you can
-    #   enable layer(s), such as POI layer for the VectorEsriNavigation
+    #   enable layer(s), such as `POI` layer for the VectorEsriNavigation
     #   style. Default is `unset`.
     #
-    #   <note markdown="1"> Not all map resources or styles support custom layers. See Custom
-    #   Layers for more information.
+    #   <note markdown="1"> Currenlty only `VectorEsriNavigation` supports CustomLayers. For
+    #   more information, see [Custom Layers][1].
     #
     #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers
     #   @return [Array<String>]
     #
     # @!attribute [rw] political_view
@@ -4857,12 +4903,19 @@ module Aws::LocationService
     #
     # @!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.
+    #   `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 markdown="1"> This property is only returned for a place index that uses Esri as a
+    #   data provider. The property is represented as a `district`.
     #
     #    </note>
+    #
+    #   For more information about data providers, see [Amazon Location
+    #   Service data providers][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
     #   @return [String]
     #
     # @!attribute [rw] sub_region
@@ -4884,8 +4937,9 @@ module Aws::LocationService
     #   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 or Grab as a data
-    #   provider. Is not returned for `SearchPlaceIndexForPosition`.
+    #   <note markdown="1"> This property is returned only for a place index that uses Esri or
+    #   Grab as a data provider. It is not returned for
+    #   `SearchPlaceIndexForPosition`.
     #
     #    </note>
     #   @return [String]
@@ -4894,7 +4948,8 @@ module Aws::LocationService
     #   For addresses with a `UnitNumber`, the type of unit. For example,
     #   `Apartment`.
     #
-    #   <note markdown="1"> Returned only for a place index that uses Esri as a data provider.
+    #   <note markdown="1"> This property is returned only for a place index that uses Esri as a
+    #   data provider.
     #
     #    </note>
     #   @return [String]
@@ -5196,6 +5251,39 @@ module Aws::LocationService
     #   providers.
     #
     #    </note>
+    #
+    #   While you can use PlaceID in subsequent requests, PlaceID is not
+    #   intended to be a permanent identifier and the ID can change between
+    #   consecutive API calls. Please see the following PlaceID behaviour
+    #   for each data provider:
+    #
+    #   * Esri: Place IDs will change every quarter at a minimum. The
+    #     typical time period for these changes would be March, June,
+    #     September, and December. Place IDs might also change between the
+    #     typical quarterly change but that will be much less frequent.
+    #
+    #   * HERE: We recommend that you cache data for no longer than a week
+    #     to keep your data data fresh. You can assume that less than 1% ID
+    #     shifts will release over release which is approximately 1 - 2
+    #     times per week.
+    #
+    #   * Grab: Place IDs can expire or become invalid in the following
+    #     situations.
+    #
+    #     * Data operations: The POI may be removed from Grab POI database
+    #       by Grab Map Ops based on the ground-truth, such as being closed
+    #       in the real world, being detected as a duplicate POI, or having
+    #       incorrect information. Grab will synchronize data to the
+    #       Waypoint environment on weekly basis.
+    #
+    #     * Interpolated POI: Interpolated POI is a temporary POI generated
+    #       in real time when serving a request, and it will be marked as
+    #       derived in the `place.result_type` field in the response. The
+    #       information of interpolated POIs will be retained for at least
+    #       30 days, which means that within 30 days, you are able to obtain
+    #       POI details by Place ID from Place Details API. After 30 days,
+    #       the interpolated POIs(both Place ID and details) may expire and
+    #       inaccessible from the Places Details API.
     #   @return [String]
     #
     # @!attribute [rw] supplemental_categories

data/lib/aws-sdk-locationservice.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-locationservice
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -72,7 +72,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-locationservice
   changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-locationservice/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon Location Service
 test_files: []