From 544eec6570886b7afb20368466604925a81dded4 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 12 Jan 2024 19:39:53 +0000 Subject: [PATCH] docs(client-location): Location SDK documentation update. Added missing fonts to the MapConfiguration data type. Updated note for the SubMunicipality property in the place data type. --- .../client-location/src/models/models_0.ts | 135 +++++++++++++----- codegen/sdk-codegen/aws-models/location.json | 18 +-- 2 files changed, 110 insertions(+), 43 deletions(-) diff --git a/clients/client-location/src/models/models_0.ts b/clients/client-location/src/models/models_0.ts index 868690bfc6bbb..3b830f6435cb8 100644 --- a/clients/client-location/src/models/models_0.ts +++ b/clients/client-location/src/models/models_0.ts @@ -2528,9 +2528,11 @@ export interface MapConfiguration { * *

Valid HERE @@ -2569,31 +2571,12 @@ export interface MapConfiguration { *

*

Valid GrabMaps map styles:

* @@ -4956,6 +4959,37 @@ export interface GetPlaceRequest { /** * @public *

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:

+ * */ PlaceId: string | undefined; @@ -5131,7 +5165,7 @@ export interface Place { *

For addresses with a UnitNumber, the type of unit. For example, * Apartment.

* - *

Returned only for a place index that uses Esri as a data provider.

+ *

This property is returned only for a place index that uses Esri as a data provider.

* */ UnitType?: string; @@ -5141,7 +5175,7 @@ export interface Place { *

For addresses with multiple units, the unit identifier. Can include numbers and * letters, for example 3B or Unit 123.

* - *

Returned only for a place index that uses Esri or Grab as a data provider. Is + *

This property is returned only for a place index that uses Esri or Grab as a data provider. It is * not returned for SearchPlaceIndexForPosition.

* */ @@ -5165,11 +5199,12 @@ export interface Place { /** * @public - *

An area that's part of a larger municipality. For example, Blissville + *

An area that's part of a larger municipality. For example, Blissville * is a submunicipality in the Queen County in New York.

* - *

This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

+ *

This property is only returned for a place index that uses Esri as a data provider. The property is represented as a district.

* + *

For more information about data providers, see Amazon Location Service data providers.

*/ SubMunicipality?: string; } @@ -5748,10 +5783,11 @@ export interface MapConfigurationUpdate { /** * @public - *

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. + *

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. * Default is unset.

* - *

Not all map resources or styles support custom layers. See Custom Layers for more information.

+ *

Currenlty only VectorEsriNavigation supports CustomLayers. + * For more information, see Custom Layers.

* */ CustomLayers?: string[]; @@ -6117,6 +6153,37 @@ export interface SearchForSuggestionsResult { * PlaceId is returned by place indexes that use Esri, Grab, or HERE * as data providers.

* + *

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:

+ * */ PlaceId?: string; diff --git a/codegen/sdk-codegen/aws-models/location.json b/codegen/sdk-codegen/aws-models/location.json index 6292ad96af6e0..4bc46b0a0b2ae 100644 --- a/codegen/sdk-codegen/aws-models/location.json +++ b/codegen/sdk-codegen/aws-models/location.json @@ -4012,7 +4012,7 @@ "FontStack": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid font stacks for Esri styles:

\n \n

Valid font stacks for HERE Technologies styles:

\n \n

Valid font stacks for GrabMaps styles:

\n \n

Valid font stacks for Open Data styles:

\n \n \n

The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.

\n ", + "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid font stacks for Esri styles:

\n \n

Valid font stacks for HERE Technologies styles:

\n \n

Valid font stacks for GrabMaps styles:

\n \n

Valid font stacks for Open Data styles:

\n \n \n

The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4405,7 +4405,7 @@ "PlaceId": { "target": "com.amazonaws.location#PlaceId", "traits": { - "smithy.api#documentation": "

The identifier of the place to find.

", + "smithy.api#documentation": "

The identifier of the place to find.

\n

While you can use PlaceID in subsequent requests, \n PlaceID is not intended to be a permanent \n identifier and the ID can change between consecutive API calls. \n Please see the following PlaceID behaviour for each data provider:

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6572,7 +6572,7 @@ "Style": { "target": "com.amazonaws.location#MapStyle", "traits": { - "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n \n

Valid HERE\n Technologies map styles:

\n \n

Valid GrabMaps map styles:

\n \n \n

Grab provides maps only for countries in Southeast Asia, and is only available \n in the Asia Pacific (Singapore) Region (ap-southeast-1).\n For more information, see GrabMaps countries and area covered.

\n \n

Valid Open Data map styles:

\n ", + "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n \n

Valid HERE\n Technologies map styles:

\n \n

Valid GrabMaps map styles:

\n \n \n

Grab provides maps only for countries in Southeast Asia, and is only available \n in the Asia Pacific (Singapore) Region (ap-southeast-1).\n For more information, see GrabMaps countries and area covered.

\n \n

Valid Open Data map styles:

\n ", "smithy.api#required": {} } }, @@ -6586,7 +6586,7 @@ "target": "com.amazonaws.location#CustomLayerList", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

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.\nDefault is unset.

\n \n

Not all map resources or styles support custom layers. See Custom Layers for more information.

\n " + "smithy.api#documentation": "

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.\nDefault is unset.

\n \n

Currenlty only VectorEsriNavigation supports CustomLayers. \nFor more information, see Custom Layers.

\n " } } }, @@ -6607,7 +6607,7 @@ "target": "com.amazonaws.location#CustomLayerList", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

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.\nDefault is unset.

\n \n

Not all map resources or styles support custom layers. See Custom Layers for more information.

\n " + "smithy.api#documentation": "

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.\nDefault is unset.

\n \n

Currenlty only VectorEsriNavigation supports CustomLayers. \nFor more information, see Custom Layers.

\n " } } }, @@ -6762,13 +6762,13 @@ "UnitType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

For addresses with a UnitNumber, the type of unit. For example,\n Apartment.

\n \n

Returned only for a place index that uses Esri as a data provider.

\n " + "smithy.api#documentation": "

For addresses with a UnitNumber, the type of unit. For example,\n Apartment.

\n \n

This property is returned only for a place index that uses Esri as a data provider.

\n " } }, "UnitNumber": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

For addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B or Unit 123.

\n \n

Returned only for a place index that uses Esri or Grab as a data provider. Is \n not returned for SearchPlaceIndexForPosition.

\n " + "smithy.api#documentation": "

For addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B or Unit 123.

\n \n

This property is returned only for a place index that uses Esri or Grab as a data provider. It is \n not returned for SearchPlaceIndexForPosition.

\n " } }, "Categories": { @@ -6786,7 +6786,7 @@ "SubMunicipality": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

An area that's part of a larger municipality. For example, Blissville \n is a submunicipality in the Queen County in New York.

\n \n

This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

\n " + "smithy.api#documentation": "

An area that's part of a larger municipality. For example, Blissville \n is a submunicipality in the Queen County in New York.

\n \n

This property is only returned for a place index that uses Esri as a data provider. The property is represented as a district.

\n \n

For more information about data providers, see Amazon Location Service data providers.

" } } }, @@ -7343,7 +7343,7 @@ "PlaceId": { "target": "com.amazonaws.location#PlaceId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Place. You can use this with the GetPlace\n operation to find the place again later, or to get full information for the Place.

\n

The GetPlace request must use the same PlaceIndex \n resource as the SearchPlaceIndexForSuggestions that generated the Place \n ID.

\n \n

For SearchPlaceIndexForSuggestions operations, the\n PlaceId is returned by place indexes that use Esri, Grab, or HERE\n as data providers.

\n " + "smithy.api#documentation": "

The unique identifier of the Place. You can use this with the GetPlace\n operation to find the place again later, or to get full information for the Place.

\n

The GetPlace request must use the same PlaceIndex \n resource as the SearchPlaceIndexForSuggestions that generated the Place \n ID.

\n \n

For SearchPlaceIndexForSuggestions operations, the\n PlaceId is returned by place indexes that use Esri, Grab, or HERE\n as data providers.

\n \n

While you can use PlaceID in subsequent requests, \n PlaceID is not intended to be a permanent \n identifier and the ID can change between consecutive API calls. \n Please see the following PlaceID behaviour for each data provider:

\n " } }, "Categories": {