Skip to content

Commit b1a3440

Browse files
author
awstools
committed
feat(client-geo-maps): Provide support for vector map styles in the GetStaticMap operation.
1 parent d530758 commit b1a3440

File tree

13 files changed

+748
-124
lines changed

13 files changed

+748
-124
lines changed

‎clients/client-geo-maps/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@
66

77
AWS SDK for JavaScript GeoMaps Client for Node.js, Browser and React Native.
88

9-
<p>
10-
Integrate high-quality base map data into your applications using
11-
<a href="https://maplibre.org">MapLibre</a>. Capabilities include:
12-
</p>
9+
<p> Integrate high-quality base map data into your applications using <a href="https://maplibre.org">MapLibre</a>. Capabilities include: </p>
1310
<ul>
1411
<li>
15-
<p>Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.</p>
12+
<p>Access to comprehensive base map data, allowing you to tailor the map display to
13+
your specific needs.</p>
1614
</li>
1715
<li>
18-
<p>Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.</p>
16+
<p>Multiple pre-designed map styles suited for various application types, such as
17+
navigation, logistics, or data visualization.</p>
1918
</li>
2019
<li>
21-
<p>Generation of static map images for scenarios where interactive maps aren't suitable, such as:</p>
20+
<p>Generation of static map images for scenarios where interactive maps aren't
21+
suitable, such as:</p>
2222
<ul>
2323
<li>
2424
<p>Embedding in emails or documents</p>

‎clients/client-geo-maps/src/GeoMaps.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,19 +89,19 @@ export interface GeoMaps {
8989
}
9090

9191
/**
92-
* <p>
93-
* Integrate high-quality base map data into your applications using
94-
* <a href="https://maplibre.org">MapLibre</a>. Capabilities include:
95-
* </p>
92+
* <p> Integrate high-quality base map data into your applications using <a href="https://maplibre.org">MapLibre</a>. Capabilities include: </p>
9693
* <ul>
9794
* <li>
98-
* <p>Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.</p>
95+
* <p>Access to comprehensive base map data, allowing you to tailor the map display to
96+
* your specific needs.</p>
9997
* </li>
10098
* <li>
101-
* <p>Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.</p>
99+
* <p>Multiple pre-designed map styles suited for various application types, such as
100+
* navigation, logistics, or data visualization.</p>
102101
* </li>
103102
* <li>
104-
* <p>Generation of static map images for scenarios where interactive maps aren't suitable, such as:</p>
103+
* <p>Generation of static map images for scenarios where interactive maps aren't
104+
* suitable, such as:</p>
105105
* <ul>
106106
* <li>
107107
* <p>Embedding in emails or documents</p>

‎clients/client-geo-maps/src/GeoMapsClient.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -280,19 +280,19 @@ export type GeoMapsClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
280280
export interface GeoMapsClientResolvedConfig extends GeoMapsClientResolvedConfigType {}
281281

282282
/**
283-
* <p>
284-
* Integrate high-quality base map data into your applications using
285-
* <a href="https://maplibre.org">MapLibre</a>. Capabilities include:
286-
* </p>
283+
* <p> Integrate high-quality base map data into your applications using <a href="https://maplibre.org">MapLibre</a>. Capabilities include: </p>
287284
* <ul>
288285
* <li>
289-
* <p>Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.</p>
286+
* <p>Access to comprehensive base map data, allowing you to tailor the map display to
287+
* your specific needs.</p>
290288
* </li>
291289
* <li>
292-
* <p>Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.</p>
290+
* <p>Multiple pre-designed map styles suited for various application types, such as
291+
* navigation, logistics, or data visualization.</p>
293292
* </li>
294293
* <li>
295-
* <p>Generation of static map images for scenarios where interactive maps aren't suitable, such as:</p>
294+
* <p>Generation of static map images for scenarios where interactive maps aren't
295+
* suitable, such as:</p>
296296
* <ul>
297297
* <li>
298298
* <p>Embedding in emails or documents</p>

‎clients/client-geo-maps/src/commands/GetGlyphsCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ export type GetGlyphsCommandOutputType = Omit<GetGlyphsResponse, "Blob"> & {
3636
export interface GetGlyphsCommandOutput extends GetGlyphsCommandOutputType, __MetadataBearer {}
3737

3838
/**
39-
* <p>Returns the map's glyphs.</p>
39+
* <p>
40+
* <code>GetGlyphs</code> returns the map's glyphs.</p>
4041
* @example
4142
* Use a bare-bones client and the command you need to make an API call.
4243
* ```javascript

‎clients/client-geo-maps/src/commands/GetSpritesCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ export type GetSpritesCommandOutputType = Omit<GetSpritesResponse, "Blob"> & {
3636
export interface GetSpritesCommandOutput extends GetSpritesCommandOutputType, __MetadataBearer {}
3737

3838
/**
39-
* <p>Returns the map's sprites.</p>
39+
* <p>
40+
* <code>GetSprites</code> returns the map's sprites.</p>
4041
* @example
4142
* Use a bare-bones client and the command you need to make an API call.
4243
* ```javascript

‎clients/client-geo-maps/src/commands/GetStaticMapCommand.ts

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@ export type GetStaticMapCommandOutputType = Omit<GetStaticMapResponse, "Blob"> &
3636
export interface GetStaticMapCommandOutput extends GetStaticMapCommandOutputType, __MetadataBearer {}
3737

3838
/**
39-
* <p>Provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots.</p>
39+
* <p>
40+
* <code>GetStaticMap</code> provides high-quality static map images with customizable
41+
* options. You can modify the map's appearance and overlay additional information. It's an
42+
* ideal solution for applications requiring tailored static map snapshots.</p>
4043
* @example
4144
* Use a bare-bones client and the command you need to make an API call.
4245
* ```javascript
@@ -47,11 +50,17 @@ export interface GetStaticMapCommandOutput extends GetStaticMapCommandOutputType
4750
* BoundingBox: "STRING_VALUE",
4851
* BoundedPositions: "STRING_VALUE",
4952
* Center: "STRING_VALUE",
53+
* ColorScheme: "STRING_VALUE",
5054
* CompactOverlay: "STRING_VALUE",
55+
* CropLabels: true || false,
5156
* GeoJsonOverlay: "STRING_VALUE",
5257
* Height: Number("int"), // required
5358
* Key: "STRING_VALUE",
59+
* LabelSize: "STRING_VALUE",
60+
* Language: "STRING_VALUE",
5461
* Padding: Number("int"),
62+
* PoliticalView: "STRING_VALUE",
63+
* PointsOfInterests: "STRING_VALUE",
5564
* Radius: Number("long"),
5665
* FileName: "STRING_VALUE", // required
5766
* ScaleBarUnit: "STRING_VALUE",
@@ -78,10 +87,12 @@ export interface GetStaticMapCommandOutput extends GetStaticMapCommandOutputType
7887
* @see {@link GeoMapsClientResolvedConfig | config} for GeoMapsClient's `config` shape.
7988
*
8089
* @throws {@link AccessDeniedException} (client fault)
81-
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
90+
* <p>The request was denied because of insufficient access or permissions. Check with an
91+
* administrator to verify your permissions.</p>
8292
*
8393
* @throws {@link InternalServerException} (server fault)
84-
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
94+
* <p>The request processing has failed because of an unknown error, exception or
95+
* failure.</p>
8596
*
8697
* @throws {@link ThrottlingException} (client fault)
8798
* <p>The request was denied due to request throttling.</p>

‎clients/client-geo-maps/src/commands/GetStyleDescriptorCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ export type GetStyleDescriptorCommandOutputType = Omit<GetStyleDescriptorRespons
4040
export interface GetStyleDescriptorCommandOutput extends GetStyleDescriptorCommandOutputType, __MetadataBearer {}
4141

4242
/**
43-
* <p>Returns information about the style.</p>
43+
* <p>
44+
* <code>GetStyleDescriptor</code> returns information about the style.</p>
4445
* @example
4546
* Use a bare-bones client and the command you need to make an API call.
4647
* ```javascript

‎clients/client-geo-maps/src/commands/GetTileCommand.ts

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@ export type GetTileCommandOutputType = Omit<GetTileResponse, "Blob"> & {
3636
export interface GetTileCommandOutput extends GetTileCommandOutputType, __MetadataBearer {}
3737

3838
/**
39-
* <p>Returns a tile. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.</p>
39+
* <p>
40+
* <code>GetTile</code> returns a tile. Map tiles are used by clients to render a map.
41+
* they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom)
42+
* level.</p>
4043
* @example
4144
* Use a bare-bones client and the command you need to make an API call.
4245
* ```javascript
@@ -69,10 +72,12 @@ export interface GetTileCommandOutput extends GetTileCommandOutputType, __Metada
6972
* @see {@link GeoMapsClientResolvedConfig | config} for GeoMapsClient's `config` shape.
7073
*
7174
* @throws {@link AccessDeniedException} (client fault)
72-
* <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
75+
* <p>The request was denied because of insufficient access or permissions. Check with an
76+
* administrator to verify your permissions.</p>
7377
*
7478
* @throws {@link InternalServerException} (server fault)
75-
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
79+
* <p>The request processing has failed because of an unknown error, exception or
80+
* failure.</p>
7681
*
7782
* @throws {@link ThrottlingException} (client fault)
7883
* <p>The request was denied due to request throttling.</p>

‎clients/client-geo-maps/src/endpoint/ruleset.ts

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,36 @@ import { RuleSetObject } from "@smithy/types";
66
or see "smithy.rules#endpointRuleSet"
77
in codegen/sdk-codegen/aws-models/geo-maps.json */
88

9-
const u="required",
10-
v="fn",
11-
w="argv",
12-
x="ref";
9+
const y="required",
10+
z="fn",
11+
A="argv",
12+
B="ref",
13+
C="url",
14+
D="properties",
15+
E="headers";
1316
const a=true,
1417
b="isSet",
1518
c="booleanEquals",
1619
d="error",
1720
e="endpoint",
1821
f="tree",
1922
g="PartitionResult",
20-
h={[u]:true,"default":false,"type":"Boolean"},
21-
i={[u]:false,"type":"String"},
22-
j={[x]:"Endpoint"},
23-
k={[v]:c,[w]:[{[x]:"UseFIPS"},true]},
24-
l={[v]:c,[w]:[{[x]:"UseDualStack"},true]},
23+
h={[y]:true,"default":false,"type":"Boolean"},
24+
i={[y]:false,"type":"String"},
25+
j={[B]:"Endpoint"},
26+
k={[z]:c,[A]:[{[B]:"UseFIPS"},true]},
27+
l={[z]:c,[A]:[{[B]:"UseDualStack"},true]},
2528
m={},
26-
n={[v]:"stringEquals",[w]:[{[v]:"getAttr",[w]:[{[x]:g},"name"]},"aws"]},
27-
o={[v]:c,[w]:[{[x]:"UseFIPS"},false]},
28-
p={[v]:c,[w]:[{[x]:"UseDualStack"},false]},
29-
q={[v]:"stringEquals",[w]:[{[v]:"getAttr",[w]:[{[x]:g},"name"]},"aws-us-gov"]},
30-
r={[v]:"getAttr",[w]:[{[x]:g},"supportsFIPS"]},
31-
s={[v]:c,[w]:[true,{[v]:"getAttr",[w]:[{[x]:g},"supportsDualStack"]}]},
32-
t=[{[x]:"Region"}];
33-
const _data={version:"1.0",parameters:{UseDualStack:h,UseFIPS:h,Endpoint:i,Region:i},rules:[{conditions:[{[v]:b,[w]:[j]}],rules:[{conditions:[k],error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{rules:[{conditions:[l],error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f}],type:f},{rules:[{conditions:[{[v]:b,[w]:t}],rules:[{conditions:[{[v]:"aws.partition",[w]:t,assign:g}],rules:[{conditions:[n,o,p],endpoint:{url:"https://maps.geo.{Region}.{PartitionResult#dnsSuffix}/v2",properties:m,headers:m},type:e},{conditions:[n,k,l],endpoint:{url:"https://maps.geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}/v2",properties:m,headers:m},type:e},{conditions:[n,k,p],endpoint:{url:"https://maps.geo-fips.{Region}.{PartitionResult#dnsSuffix}/v2",properties:m,headers:m},type:e},{conditions:[n,o,l],endpoint:{url:"https://maps.geo.{Region}.{PartitionResult#dualStackDnsSuffix}/v2",properties:m,headers:m},type:e},{conditions:[q,o,p],endpoint:{url:"https://maps.geo.{Region}.us-gov.{PartitionResult#dnsSuffix}/v2",properties:m,headers:m},type:e},{conditions:[q,k,l],endpoint:{url:"https://maps.geo-fips.{Region}.us-gov.{PartitionResult#dualStackDnsSuffix}/v2",properties:m,headers:m},type:e},{conditions:[q,k,p],endpoint:{url:"https://maps.geo-fips.{Region}.us-gov.{PartitionResult#dnsSuffix}/v2",properties:m,headers:m},type:e},{conditions:[q,o,l],endpoint:{url:"https://maps.geo.{Region}.us-gov.{PartitionResult#dualStackDnsSuffix}/v2",properties:m,headers:m},type:e},{conditions:[k,l],rules:[{conditions:[{[v]:c,[w]:[a,r]},s],rules:[{endpoint:{url:"https://geo-maps-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:[k,p],rules:[{conditions:[{[v]:c,[w]:[r,a]}],rules:[{endpoint:{url:"https://geo-maps-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:[o,l],rules:[{conditions:[s],rules:[{endpoint:{url:"https://geo-maps.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://geo-maps.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}],type:f}]};
29+
n={[z]:"stringEquals",[A]:[{[z]:"getAttr",[A]:[{[B]:g},"name"]},"aws"]},
30+
o={[z]:c,[A]:[{[B]:"UseFIPS"},false]},
31+
p={[z]:c,[A]:[{[B]:"UseDualStack"},false]},
32+
q={[C]:"https://maps.geo.{Region}.{PartitionResult#dnsSuffix}/v2",[D]:{},[E]:{}},
33+
r={[C]:"https://maps.geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}/v2",[D]:{},[E]:{}},
34+
s={[C]:"https://maps.geo-fips.{Region}.{PartitionResult#dnsSuffix}/v2",[D]:{},[E]:{}},
35+
t={[C]:"https://maps.geo.{Region}.{PartitionResult#dualStackDnsSuffix}/v2",[D]:{},[E]:{}},
36+
u={[z]:"stringEquals",[A]:[{[z]:"getAttr",[A]:[{[B]:g},"name"]},"aws-us-gov"]},
37+
v={[z]:"getAttr",[A]:[{[B]:g},"supportsFIPS"]},
38+
w={[z]:c,[A]:[true,{[z]:"getAttr",[A]:[{[B]:g},"supportsDualStack"]}]},
39+
x=[{[B]:"Region"}];
40+
const _data={version:"1.0",parameters:{UseDualStack:h,UseFIPS:h,Endpoint:i,Region:i},rules:[{conditions:[{[z]:b,[A]:[j]}],rules:[{conditions:[k],error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{rules:[{conditions:[l],error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{[C]:j,[D]:m,[E]:m},type:e}],type:f}],type:f},{rules:[{conditions:[{[z]:b,[A]:x}],rules:[{conditions:[{[z]:"aws.partition",[A]:x,assign:g}],rules:[{conditions:[n,o,p],endpoint:q,type:e},{conditions:[n,k,l],endpoint:r,type:e},{conditions:[n,k,p],endpoint:s,type:e},{conditions:[n,o,l],endpoint:t,type:e},{conditions:[u,o,p],endpoint:q,type:e},{conditions:[u,k,l],endpoint:r,type:e},{conditions:[u,k,p],endpoint:s,type:e},{conditions:[u,o,l],endpoint:t,type:e},{conditions:[k,l],rules:[{conditions:[{[z]:c,[A]:[a,v]},w],rules:[{endpoint:{[C]:"https://geo-maps-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[D]:m,[E]:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:[k,p],rules:[{conditions:[{[z]:c,[A]:[v,a]}],rules:[{endpoint:{[C]:"https://geo-maps-fips.{Region}.{PartitionResult#dnsSuffix}",[D]:m,[E]:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:[o,l],rules:[{conditions:[w],rules:[{endpoint:{[C]:"https://geo-maps.{Region}.{PartitionResult#dualStackDnsSuffix}",[D]:m,[E]:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{[C]:"https://geo-maps.{Region}.{PartitionResult#dnsSuffix}",[D]:m,[E]:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}],type:f}]};
3441
export const ruleSet: RuleSetObject = _data;

‎clients/client-geo-maps/src/index.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>
5-
* Integrate high-quality base map data into your applications using
6-
* <a href="https://maplibre.org">MapLibre</a>. Capabilities include:
7-
* </p>
4+
* <p> Integrate high-quality base map data into your applications using <a href="https://maplibre.org">MapLibre</a>. Capabilities include: </p>
85
* <ul>
96
* <li>
10-
* <p>Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.</p>
7+
* <p>Access to comprehensive base map data, allowing you to tailor the map display to
8+
* your specific needs.</p>
119
* </li>
1210
* <li>
13-
* <p>Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.</p>
11+
* <p>Multiple pre-designed map styles suited for various application types, such as
12+
* navigation, logistics, or data visualization.</p>
1413
* </li>
1514
* <li>
16-
* <p>Generation of static map images for scenarios where interactive maps aren't suitable, such as:</p>
15+
* <p>Generation of static map images for scenarios where interactive maps aren't
16+
* suitable, such as:</p>
1717
* <ul>
1818
* <li>
1919
* <p>Embedding in emails or documents</p>

0 commit comments

Comments
 (0)