Skip to content

Commit

Permalink
docs(client-location): Location SDK documentation update. Added missi…
Browse files Browse the repository at this point in the history 
…ng fonts to the MapConfiguration data type. Updated note for the SubMunicipality property in the place data type.
  • Loading branch information
awstools committed Jan 12, 2024
1 parent 1c20e12 commit 544eec6
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 43 deletions.
135 changes: 101 additions & 34 deletions clients/client-location/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2528,9 +2528,11 @@ export interface MapConfiguration {
* <ul>
* <li>
* <p>
* <code>VectorEsriDarkGrayCanvas</code> – 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. </p>
* <code>VectorEsriNavigation</code> – 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 <code>POI</code> layer by setting it in CustomLayers to leverage the additional places data.</p>
* <p/>
* </li>
* <li>
* <p>
Expand Down Expand Up @@ -2559,41 +2561,22 @@ export interface MapConfiguration {
* </li>
* <li>
* <p>
* <code>VectorEsriNavigation</code> – 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.</p>
* <code>VectorEsriDarkGrayCanvas</code> – 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. </p>
* </li>
* </ul>
* <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
* Technologies map styles</a>:</p>
* <ul>
* <li>
* <p>
* <code>VectorHereContrast</code> – The HERE Contrast (Berlin) map style is a
* high contrast
* detailed base map of the world that blends 3D and 2D rendering.</p>
* <note>
* <p>The <code>VectorHereContrast</code> style has been renamed from
* <code>VectorHereBerlin</code>.
* <code>VectorHereBerlin</code> has been deprecated, but will continue to work in
* applications that use it.</p>
* </note>
* </li>
* <li>
* <p>
* <code>VectorHereExplore</code> – 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.</p>
* </li>
* <li>
* <p>
* <code>VectorHereExploreTruck</code> – 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.</p>
* </li>
* <li>
* <p>
* <code>RasterHereExploreSatellite</code> – A global map containing high
* resolution satellite imagery.</p>
* </li>
Expand All @@ -2610,6 +2593,25 @@ export interface MapConfiguration {
* retrieved.</p>
* </note>
* </li>
* <li>
* <p>
* <code>VectorHereContrast</code> – The HERE Contrast (Berlin) map style is a
* high contrast
* detailed base map of the world that blends 3D and 2D rendering.</p>
* <note>
* <p>The <code>VectorHereContrast</code> style has been renamed from
* <code>VectorHereBerlin</code>.
* <code>VectorHereBerlin</code> has been deprecated, but will continue to work in
* applications that use it.</p>
* </note>
* </li>
* <li>
* <p>
* <code>VectorHereExploreTruck</code> – 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.</p>
* </li>
* </ul>
* <p>Valid <a href="https://docs.aws.amazon.com/location/latest/developerguide/grab.html">GrabMaps map styles</a>:</p>
* <ul>
Expand Down Expand Up @@ -2683,10 +2685,11 @@ export interface MapConfiguration {

/**
* @public
* <p>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 style.
* <p>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 <code>POI</code> layer for the VectorEsriNavigation style.
* Default is <code>unset</code>.</p>
* <note>
* <p>Not all map resources or styles support custom layers. See Custom Layers for more information.</p>
* <p>Currenlty only <code>VectorEsriNavigation</code> supports CustomLayers.
* For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers">Custom Layers</a>.</p>
* </note>
*/
CustomLayers?: string[];
Expand Down Expand Up @@ -4669,7 +4672,7 @@ export interface GetMapGlyphsRequest {
* </li>
* <li>
* <p>VectorEsriNavigation – <code>Arial Regular</code> | <code>Arial Italic</code>
* | <code>Arial Bold</code>
* | <code>Arial Bold</code> | <code>Arial Unicode MS Bold</code> | <code>Arial Unicode MS Regular</code>
* </p>
* </li>
* </ul>
Expand Down Expand Up @@ -4956,6 +4959,37 @@ export interface GetPlaceRequest {
/**
* @public
* <p>The identifier of the place to find.</p>
* <p>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:</p>
* <ul>
* <li>
* <p>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.</p>
* </li>
* <li>
* <p>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.</p>
* </li>
* <li>
* <p>Grab: Place IDs can expire or become invalid in the following situations.</p>
* <ul>
* <li>
* <p>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.</p>
* </li>
* <li>
* <p>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 <code>place.result_type</code> 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.</p>
* </li>
* </ul>
* </li>
* </ul>
*/
PlaceId: string | undefined;

Expand Down Expand Up @@ -5131,7 +5165,7 @@ export interface Place {
* <p>For addresses with a <code>UnitNumber</code>, the type of unit. For example,
* <code>Apartment</code>.</p>
* <note>
* <p>Returned only for a place index that uses Esri as a data provider.</p>
* <p>This property is returned only for a place index that uses Esri as a data provider.</p>
* </note>
*/
UnitType?: string;
Expand All @@ -5141,7 +5175,7 @@ export interface Place {
* <p>For addresses with multiple units, the unit identifier. Can include numbers and
* letters, for example <code>3B</code> or <code>Unit 123</code>.</p>
* <note>
* <p>Returned only for a place index that uses Esri or Grab as a data provider. Is
* <p>This property is returned only for a place index that uses Esri or Grab as a data provider. It is
* not returned for <code>SearchPlaceIndexForPosition</code>.</p>
* </note>
*/
Expand All @@ -5165,11 +5199,12 @@ export interface Place {

/**
* @public
* <p>An area that's part of a larger municipality. For example, <code>Blissville </code>
* <p>An area that's part of a larger municipality. For example, <code>Blissville</code>
* is a submunicipality in the Queen County in New York.</p>
* <note>
* <p>This property supported by Esri and OpenData. The Esri property is <code>district</code>, and the OpenData property is <code>borough</code>.</p>
* <p>This property is only returned for a place index that uses Esri as a data provider. The property is represented as a <code>district</code>.</p>
* </note>
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
*/
SubMunicipality?: string;
}
Expand Down Expand Up @@ -5748,10 +5783,11 @@ export interface MapConfigurationUpdate {

/**
* @public
* <p>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 style.
* <p>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 <code>POI</code> layer for the VectorEsriNavigation style.
* Default is <code>unset</code>.</p>
* <note>
* <p>Not all map resources or styles support custom layers. See Custom Layers for more information.</p>
* <p>Currenlty only <code>VectorEsriNavigation</code> supports CustomLayers.
* For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers">Custom Layers</a>.</p>
* </note>
*/
CustomLayers?: string[];
Expand Down Expand Up @@ -6117,6 +6153,37 @@ export interface SearchForSuggestionsResult {
* <code>PlaceId</code> is returned by place indexes that use Esri, Grab, or HERE
* as data providers.</p>
* </note>
* <p>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:</p>
* <ul>
* <li>
* <p>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.</p>
* </li>
* <li>
* <p>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.</p>
* </li>
* <li>
* <p>Grab: Place IDs can expire or become invalid in the following situations.</p>
* <ul>
* <li>
* <p>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.</p>
* </li>
* <li>
* <p>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 <code>place.result_type</code> 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.</p>
* </li>
* </ul>
* </li>
* </ul>
*/
PlaceId?: string;

Expand Down
Loading

0 comments on commit 544eec6

Please sign in to comment.