diff --git a/clients/client-geo-maps/.gitignore b/clients/client-geo-maps/.gitignore new file mode 100644 index 000000000000..54f14c9aef25 --- /dev/null +++ b/clients/client-geo-maps/.gitignore @@ -0,0 +1,9 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +/dist-* +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/clients/client-geo-maps/LICENSE b/clients/client-geo-maps/LICENSE new file mode 100644 index 000000000000..1349aa7c9923 --- /dev/null +++ b/clients/client-geo-maps/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/clients/client-geo-maps/README.md b/clients/client-geo-maps/README.md new file mode 100644 index 000000000000..5a193055458d --- /dev/null +++ b/clients/client-geo-maps/README.md @@ -0,0 +1,273 @@ + + +# @aws-sdk/client-geo-maps + +## Description + +AWS SDK for JavaScript GeoMaps Client for Node.js, Browser and React Native. + +
+Integrate high-quality base map data into your applications using +MapLibre. Capabilities include: +
+Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.
+Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.
+Generation of static map images for scenarios where interactive maps aren't suitable, such as:
+Embedding in emails or documents
+Displaying in low-bandwidth environments
+Creating printable maps
+Enhancing application performance by reducing client-side rendering
++ * Integrate high-quality base map data into your applications using + * MapLibre. Capabilities include: + *
+ *Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.
+ *Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.
+ *Generation of static map images for scenarios where interactive maps aren't suitable, such as:
+ *Embedding in emails or documents
+ *Displaying in low-bandwidth environments
+ *Creating printable maps
+ *Enhancing application performance by reducing client-side rendering
+ *+ * Integrate high-quality base map data into your applications using + * MapLibre. Capabilities include: + *
+ *Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.
+ *Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.
+ *Generation of static map images for scenarios where interactive maps aren't suitable, such as:
+ *Embedding in emails or documents
+ *Displaying in low-bandwidth environments
+ *Creating printable maps
+ *Enhancing application performance by reducing client-side rendering
+ *Returns the map's glyphs.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GeoMapsClient, GetGlyphsCommand } from "@aws-sdk/client-geo-maps"; // ES Modules import + * // const { GeoMapsClient, GetGlyphsCommand } = require("@aws-sdk/client-geo-maps"); // CommonJS import + * const client = new GeoMapsClient(config); + * const input = { // GetGlyphsRequest + * FontStack: "STRING_VALUE", // required + * FontUnicodeRange: "STRING_VALUE", // required + * }; + * const command = new GetGlyphsCommand(input); + * const response = await client.send(command); + * // { // GetGlyphsResponse + * // Blob: new Uint8Array(), + * // ContentType: "STRING_VALUE", + * // CacheControl: "STRING_VALUE", + * // ETag: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetGlyphsCommandInput - {@link GetGlyphsCommandInput} + * @returns {@link GetGlyphsCommandOutput} + * @see {@link GetGlyphsCommandInput} for command's `input` shape. + * @see {@link GetGlyphsCommandOutput} for command's `response` shape. + * @see {@link GeoMapsClientResolvedConfig | config} for GeoMapsClient's `config` shape. + * + * @throws {@link GeoMapsServiceException} + *Base exception class for all service exceptions from GeoMaps service.
+ * + * @public + */ +export class GetGlyphsCommand extends $Command + .classBuilder< + GetGlyphsCommandInput, + GetGlyphsCommandOutput, + GeoMapsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: GeoMapsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("MapsService", "GetGlyphs", {}) + .n("GeoMapsClient", "GetGlyphsCommand") + .f(void 0, void 0) + .ser(se_GetGlyphsCommand) + .de(de_GetGlyphsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetGlyphsRequest; + output: GetGlyphsResponse; + }; + sdk: { + input: GetGlyphsCommandInput; + output: GetGlyphsCommandOutput; + }; + }; +} diff --git a/clients/client-geo-maps/src/commands/GetSpritesCommand.ts b/clients/client-geo-maps/src/commands/GetSpritesCommand.ts new file mode 100644 index 000000000000..3a2e49e1ed48 --- /dev/null +++ b/clients/client-geo-maps/src/commands/GetSpritesCommand.ts @@ -0,0 +1,106 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; +import { Uint8ArrayBlobAdapter } from "@smithy/util-stream"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GeoMapsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoMapsClient"; +import { GetSpritesRequest, GetSpritesResponse } from "../models/models_0"; +import { de_GetSpritesCommand, se_GetSpritesCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetSpritesCommand}. + */ +export interface GetSpritesCommandInput extends GetSpritesRequest {} +/** + * @public + */ +export type GetSpritesCommandOutputType = OmitReturns the map's sprites.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GeoMapsClient, GetSpritesCommand } from "@aws-sdk/client-geo-maps"; // ES Modules import + * // const { GeoMapsClient, GetSpritesCommand } = require("@aws-sdk/client-geo-maps"); // CommonJS import + * const client = new GeoMapsClient(config); + * const input = { // GetSpritesRequest + * FileName: "STRING_VALUE", // required + * Style: "STRING_VALUE", // required + * ColorScheme: "STRING_VALUE", // required + * Variant: "STRING_VALUE", // required + * }; + * const command = new GetSpritesCommand(input); + * const response = await client.send(command); + * // { // GetSpritesResponse + * // Blob: new Uint8Array(), + * // ContentType: "STRING_VALUE", + * // CacheControl: "STRING_VALUE", + * // ETag: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetSpritesCommandInput - {@link GetSpritesCommandInput} + * @returns {@link GetSpritesCommandOutput} + * @see {@link GetSpritesCommandInput} for command's `input` shape. + * @see {@link GetSpritesCommandOutput} for command's `response` shape. + * @see {@link GeoMapsClientResolvedConfig | config} for GeoMapsClient's `config` shape. + * + * @throws {@link GeoMapsServiceException} + *Base exception class for all service exceptions from GeoMaps service.
+ * + * @public + */ +export class GetSpritesCommand extends $Command + .classBuilder< + GetSpritesCommandInput, + GetSpritesCommandOutput, + GeoMapsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: GeoMapsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("MapsService", "GetSprites", {}) + .n("GeoMapsClient", "GetSpritesCommand") + .f(void 0, void 0) + .ser(se_GetSpritesCommand) + .de(de_GetSpritesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetSpritesRequest; + output: GetSpritesResponse; + }; + sdk: { + input: GetSpritesCommandInput; + output: GetSpritesCommandOutput; + }; + }; +} diff --git a/clients/client-geo-maps/src/commands/GetStaticMapCommand.ts b/clients/client-geo-maps/src/commands/GetStaticMapCommand.ts new file mode 100644 index 000000000000..6cf868f3bc2b --- /dev/null +++ b/clients/client-geo-maps/src/commands/GetStaticMapCommand.ts @@ -0,0 +1,129 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; +import { Uint8ArrayBlobAdapter } from "@smithy/util-stream"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GeoMapsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoMapsClient"; +import { GetStaticMapRequest, GetStaticMapRequestFilterSensitiveLog, GetStaticMapResponse } from "../models/models_0"; +import { de_GetStaticMapCommand, se_GetStaticMapCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetStaticMapCommand}. + */ +export interface GetStaticMapCommandInput extends GetStaticMapRequest {} +/** + * @public + */ +export type GetStaticMapCommandOutputType = OmitProvides 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GeoMapsClient, GetStaticMapCommand } from "@aws-sdk/client-geo-maps"; // ES Modules import + * // const { GeoMapsClient, GetStaticMapCommand } = require("@aws-sdk/client-geo-maps"); // CommonJS import + * const client = new GeoMapsClient(config); + * const input = { // GetStaticMapRequest + * BoundingBox: "STRING_VALUE", + * BoundedPositions: "STRING_VALUE", + * Center: "STRING_VALUE", + * CompactOverlay: "STRING_VALUE", + * GeoJsonOverlay: "STRING_VALUE", + * Height: Number("int"), // required + * Key: "STRING_VALUE", + * Padding: Number("int"), + * Radius: Number("long"), + * FileName: "STRING_VALUE", // required + * ScaleBarUnit: "STRING_VALUE", + * Style: "STRING_VALUE", + * Width: Number("int"), // required + * Zoom: Number("float"), + * }; + * const command = new GetStaticMapCommand(input); + * const response = await client.send(command); + * // { // GetStaticMapResponse + * // Blob: new Uint8Array(), + * // ContentType: "STRING_VALUE", + * // CacheControl: "STRING_VALUE", + * // ETag: "STRING_VALUE", + * // PricingBucket: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param GetStaticMapCommandInput - {@link GetStaticMapCommandInput} + * @returns {@link GetStaticMapCommandOutput} + * @see {@link GetStaticMapCommandInput} for command's `input` shape. + * @see {@link GetStaticMapCommandOutput} for command's `response` shape. + * @see {@link GeoMapsClientResolvedConfig | config} for GeoMapsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link GeoMapsServiceException} + *Base exception class for all service exceptions from GeoMaps service.
+ * + * @public + */ +export class GetStaticMapCommand extends $Command + .classBuilder< + GetStaticMapCommandInput, + GetStaticMapCommandOutput, + GeoMapsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: GeoMapsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("MapsService", "GetStaticMap", {}) + .n("GeoMapsClient", "GetStaticMapCommand") + .f(GetStaticMapRequestFilterSensitiveLog, void 0) + .ser(se_GetStaticMapCommand) + .de(de_GetStaticMapCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetStaticMapRequest; + output: GetStaticMapResponse; + }; + sdk: { + input: GetStaticMapCommandInput; + output: GetStaticMapCommandOutput; + }; + }; +} diff --git a/clients/client-geo-maps/src/commands/GetStyleDescriptorCommand.ts b/clients/client-geo-maps/src/commands/GetStyleDescriptorCommand.ts new file mode 100644 index 000000000000..c63d2da26df9 --- /dev/null +++ b/clients/client-geo-maps/src/commands/GetStyleDescriptorCommand.ts @@ -0,0 +1,110 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; +import { Uint8ArrayBlobAdapter } from "@smithy/util-stream"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GeoMapsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoMapsClient"; +import { + GetStyleDescriptorRequest, + GetStyleDescriptorRequestFilterSensitiveLog, + GetStyleDescriptorResponse, +} from "../models/models_0"; +import { de_GetStyleDescriptorCommand, se_GetStyleDescriptorCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetStyleDescriptorCommand}. + */ +export interface GetStyleDescriptorCommandInput extends GetStyleDescriptorRequest {} +/** + * @public + */ +export type GetStyleDescriptorCommandOutputType = OmitReturns information about the style.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GeoMapsClient, GetStyleDescriptorCommand } from "@aws-sdk/client-geo-maps"; // ES Modules import + * // const { GeoMapsClient, GetStyleDescriptorCommand } = require("@aws-sdk/client-geo-maps"); // CommonJS import + * const client = new GeoMapsClient(config); + * const input = { // GetStyleDescriptorRequest + * Style: "STRING_VALUE", // required + * ColorScheme: "STRING_VALUE", + * PoliticalView: "STRING_VALUE", + * Key: "STRING_VALUE", + * }; + * const command = new GetStyleDescriptorCommand(input); + * const response = await client.send(command); + * // { // GetStyleDescriptorResponse + * // Blob: new Uint8Array(), + * // ContentType: "STRING_VALUE", + * // CacheControl: "STRING_VALUE", + * // ETag: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetStyleDescriptorCommandInput - {@link GetStyleDescriptorCommandInput} + * @returns {@link GetStyleDescriptorCommandOutput} + * @see {@link GetStyleDescriptorCommandInput} for command's `input` shape. + * @see {@link GetStyleDescriptorCommandOutput} for command's `response` shape. + * @see {@link GeoMapsClientResolvedConfig | config} for GeoMapsClient's `config` shape. + * + * @throws {@link GeoMapsServiceException} + *Base exception class for all service exceptions from GeoMaps service.
+ * + * @public + */ +export class GetStyleDescriptorCommand extends $Command + .classBuilder< + GetStyleDescriptorCommandInput, + GetStyleDescriptorCommandOutput, + GeoMapsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: GeoMapsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("MapsService", "GetStyleDescriptor", {}) + .n("GeoMapsClient", "GetStyleDescriptorCommand") + .f(GetStyleDescriptorRequestFilterSensitiveLog, void 0) + .ser(se_GetStyleDescriptorCommand) + .de(de_GetStyleDescriptorCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetStyleDescriptorRequest; + output: GetStyleDescriptorResponse; + }; + sdk: { + input: GetStyleDescriptorCommandInput; + output: GetStyleDescriptorCommandOutput; + }; + }; +} diff --git a/clients/client-geo-maps/src/commands/GetTileCommand.ts b/clients/client-geo-maps/src/commands/GetTileCommand.ts new file mode 100644 index 000000000000..abda0d9ebed9 --- /dev/null +++ b/clients/client-geo-maps/src/commands/GetTileCommand.ts @@ -0,0 +1,120 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; +import { Uint8ArrayBlobAdapter } from "@smithy/util-stream"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GeoMapsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoMapsClient"; +import { GetTileRequest, GetTileRequestFilterSensitiveLog, GetTileResponse } from "../models/models_0"; +import { de_GetTileCommand, se_GetTileCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetTileCommand}. + */ +export interface GetTileCommandInput extends GetTileRequest {} +/** + * @public + */ +export type GetTileCommandOutputType = OmitReturns 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GeoMapsClient, GetTileCommand } from "@aws-sdk/client-geo-maps"; // ES Modules import + * // const { GeoMapsClient, GetTileCommand } = require("@aws-sdk/client-geo-maps"); // CommonJS import + * const client = new GeoMapsClient(config); + * const input = { // GetTileRequest + * Tileset: "STRING_VALUE", // required + * Z: "STRING_VALUE", // required + * X: "STRING_VALUE", // required + * Y: "STRING_VALUE", // required + * Key: "STRING_VALUE", + * }; + * const command = new GetTileCommand(input); + * const response = await client.send(command); + * // { // GetTileResponse + * // Blob: new Uint8Array(), + * // ContentType: "STRING_VALUE", + * // CacheControl: "STRING_VALUE", + * // ETag: "STRING_VALUE", + * // PricingBucket: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param GetTileCommandInput - {@link GetTileCommandInput} + * @returns {@link GetTileCommandOutput} + * @see {@link GetTileCommandInput} for command's `input` shape. + * @see {@link GetTileCommandOutput} for command's `response` shape. + * @see {@link GeoMapsClientResolvedConfig | config} for GeoMapsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link GeoMapsServiceException} + *Base exception class for all service exceptions from GeoMaps service.
+ * + * @public + */ +export class GetTileCommand extends $Command + .classBuilder< + GetTileCommandInput, + GetTileCommandOutput, + GeoMapsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: GeoMapsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("MapsService", "GetTile", {}) + .n("GeoMapsClient", "GetTileCommand") + .f(GetTileRequestFilterSensitiveLog, void 0) + .ser(se_GetTileCommand) + .de(de_GetTileCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetTileRequest; + output: GetTileResponse; + }; + sdk: { + input: GetTileCommandInput; + output: GetTileCommandOutput; + }; + }; +} diff --git a/clients/client-geo-maps/src/commands/index.ts b/clients/client-geo-maps/src/commands/index.ts new file mode 100644 index 000000000000..8d8596a3aa8a --- /dev/null +++ b/clients/client-geo-maps/src/commands/index.ts @@ -0,0 +1,6 @@ +// smithy-typescript generated code +export * from "./GetGlyphsCommand"; +export * from "./GetSpritesCommand"; +export * from "./GetStaticMapCommand"; +export * from "./GetStyleDescriptorCommand"; +export * from "./GetTileCommand"; diff --git a/clients/client-geo-maps/src/endpoint/EndpointParameters.ts b/clients/client-geo-maps/src/endpoint/EndpointParameters.ts new file mode 100644 index 000000000000..d00847cc0ef0 --- /dev/null +++ b/clients/client-geo-maps/src/endpoint/EndpointParameters.ts @@ -0,0 +1,41 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + useDualstackEndpoint?: boolean | Provider+ * Integrate high-quality base map data into your applications using + * MapLibre. Capabilities include: + *
+ *Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.
+ *Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.
+ *Generation of static map images for scenarios where interactive maps aren't suitable, such as:
+ *Embedding in emails or documents
+ *Displaying in low-bandwidth environments
+ *Creating printable maps
+ *Enhancing application performance by reducing client-side rendering
+ *The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
+ * @public + */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + Message: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeName of the FontStack
to retrieve.
Example: Amazon Ember Bold,Noto Sans Bold
.
The supported font stacks are as follows:
+ *Amazon Ember Bold
+ *Amazon Ember Bold Italic
+ *Amazon Ember Bold,Noto Sans Bold
+ *Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
+ *Amazon Ember Condensed RC BdItalic
+ *Amazon Ember Condensed RC Bold
+ *Amazon Ember Condensed RC Bold Italic
+ *Amazon Ember Condensed RC Bold,Noto Sans Bold
+ *Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold
+ *Amazon Ember Condensed RC Light
+ *Amazon Ember Condensed RC Light Italic
+ *Amazon Ember Condensed RC LtItalic
+ *Amazon Ember Condensed RC Regular
+ *Amazon Ember Condensed RC Regular Italic
+ *Amazon Ember Condensed RC Regular,Noto Sans Regular
+ *Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular
+ *Amazon Ember Condensed RC RgItalic
+ *Amazon Ember Condensed RC ThItalic
+ *Amazon Ember Condensed RC Thin
+ *Amazon Ember Condensed RC Thin Italic
+ *Amazon Ember Heavy
+ *Amazon Ember Heavy Italic
+ *Amazon Ember Light
+ *Amazon Ember Light Italic
+ *Amazon Ember Medium
+ *Amazon Ember Medium Italic
+ *Amazon Ember Medium,Noto Sans Medium
+ *Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
+ *Amazon Ember Regular
+ *Amazon Ember Regular Italic
+ *Amazon Ember Regular Italic,Noto Sans Italic
+ *Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular
+ *Amazon Ember Regular,Noto Sans Regular
+ *Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
+ *Amazon Ember Thin
+ *Amazon Ember Thin Italic
+ *AmazonEmberCdRC_Bd
+ *AmazonEmberCdRC_BdIt
+ *AmazonEmberCdRC_Lt
+ *AmazonEmberCdRC_LtIt
+ *AmazonEmberCdRC_Rg
+ *AmazonEmberCdRC_RgIt
+ *AmazonEmberCdRC_Th
+ *AmazonEmberCdRC_ThIt
+ *AmazonEmber_Bd
+ *AmazonEmber_BdIt
+ *AmazonEmber_He
+ *AmazonEmber_HeIt
+ *AmazonEmber_Lt
+ *AmazonEmber_LtIt
+ *AmazonEmber_Md
+ *AmazonEmber_MdIt
+ *AmazonEmber_Rg
+ *AmazonEmber_RgIt
+ *AmazonEmber_Th
+ *AmazonEmber_ThIt
+ *Noto Sans Black
+ *Noto Sans Black Italic
+ *Noto Sans Bold
+ *Noto Sans Bold Italic
+ *Noto Sans Extra Bold
+ *Noto Sans Extra Bold Italic
+ *Noto Sans Extra Light
+ *Noto Sans Extra Light Italic
+ *Noto Sans Italic
+ *Noto Sans Light
+ *Noto Sans Light Italic
+ *Noto Sans Medium
+ *Noto Sans Medium Italic
+ *Noto Sans Regular
+ *Noto Sans Semi Bold
+ *Noto Sans Semi Bold Italic
+ *Noto Sans Thin
+ *Noto Sans Thin Italic
+ *NotoSans-Bold
+ *NotoSans-Italic
+ *NotoSans-Medium
+ *NotoSans-Regular
+ *Open Sans Regular,Arial Unicode MS Regular
+ *A Unicode range of characters to download glyphs for. This must be aligned to multiples + * of 256.
+ *Example: 0-255.pdf
+ *
The Glyph, as a binary blob.
+ * @public + */ + Blob?: Uint8Array; + + /** + *Header that represents the format of the response. The response returns the following as the HTTP body.
+ * @public + */ + ContentType?: string; + + /** + *Header that instructs caching configuration for the client.
+ * @public + */ + CacheControl?: string; + + /** + *The glyph's Etag.
+ * @public + */ + ETag?: string; +} + +/** + * @public + * @enum + */ +export const MapStyle = { + HYBRID: "Hybrid", + MONOCHROME: "Monochrome", + SATELLITE: "Satellite", + STANDARD: "Standard", +} as const; + +/** + * @public + */ +export type MapStyle = (typeof MapStyle)[keyof typeof MapStyle]; + +/** + * @public + * @enum + */ +export const Variant = { + DEFAULT: "Default", +} as const; + +/** + * @public + */ +export type Variant = (typeof Variant)[keyof typeof Variant]; + +/** + * @public + */ +export interface GetSpritesRequest { + /** + *
+ * Sprites
API: The name of the sprite file to retrieve, following pattern
+ * sprites(@2x)?\.(png|json)
.
Example: sprites.png
+ *
Style specifies the desired map style for the Sprites
APIs.
Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.
+ *Example: Light
+ *
Default value: Light
+ *
Valid values for ColorScheme are case sensitive.
+ *Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.
+ *Example: Default
+ *
Valid values for Variant are case sensitive.
+ *The body of the sprite sheet or JSON offset file (image/png or application/json, + * depending on input).
+ * @public + */ + Blob?: Uint8Array; + + /** + *Header that represents the format of the response. The response returns the following as the HTTP body.
+ * @public + */ + ContentType?: string; + + /** + *Header that instructs caching configuration for the client.
+ * @public + */ + CacheControl?: string; + + /** + *The sprite's Etag.
+ * @public + */ + ETag?: string; +} + +/** + * @public + * @enum + */ +export const ScaleBarUnit = { + KILOMETERS: "Kilometers", + KILOMETERS_MILES: "KilometersMiles", + MILES: "Miles", + MILES_KILOMETERS: "MilesKilometers", +} as const; + +/** + * @public + */ +export type ScaleBarUnit = (typeof ScaleBarUnit)[keyof typeof ScaleBarUnit]; + +/** + * @public + * @enum + */ +export const StaticMapStyle = { + SATELLITE: "Satellite", +} as const; + +/** + * @public + */ +export type StaticMapStyle = (typeof StaticMapStyle)[keyof typeof StaticMapStyle]; + +/** + * @public + */ +export interface GetStaticMapRequest { + /** + *Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and + * north-easterly edges of the image. The underlying area becomes the view of the image.
+ *Example: -123.17075,49.26959,-123.08125,49.31429
+ * @public + */ + BoundingBox?: string; + + /** + *Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by + * a comma. The API will generate an image to encompass all of the provided coordinates.
+ *Cannot be used with Zoom
and or Radius
+ *
Example: 97.170451,78.039098,99.045536,27.176178
+ * @public + */ + BoundedPositions?: string; + + /** + *Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. + * This parameter requires that either zoom or radius is set.
+ *Cannot be used with Zoom
and or Radius
+ *
Example: 49.295,-123.108
+ * @public + */ + Center?: string; + + /** + *Takes in a string to draw geometries on the image. The input is a comma separated format as follows format:
+ * [Lon, Lat]
+ *
Example:
+ * line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B
+ *
Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.
+ *Takes in a string to draw geometries on the image. The input is a valid GeoJSON + * collection object.
+ *Example:
+ * \{"type":"FeatureCollection","features": [\{"type":"Feature","geometry":\{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]\},"properties": \{"color":"#00DD00"\}\}]\}
+ *
Specifies the height of the map image.
+ * @public + */ + Height: number | undefined; + + /** + *Optional: The API key to be used for authorization. Either an API key or valid SigV4 + * signature must be provided when making a request.
+ * @public + */ + Key?: string; + + /** + *Applies additional space (in pixels) around overlay feature to prevent them from being + * cut or obscured.
+ *Value for max and min is determined by:
+ *Min: 1
+ *
Max: min(height, width)/4
+ *
Example: 100
+ *
Used with center parameter, it specifies the zoom of the image where you can control it
+ * on a granular level. Takes in any value >= 1
.
Example: 1500
+ *
Cannot be used with Zoom
.
+ * Unit: Meters
+ *
The map scaling parameter to size the image, icons, and labels. It follows the pattern
+ * of ^map(@2x)?$
.
Example: map, map@2x
+ *
Displays a scale on the bottom right of the map image with the unit specified in the + * input.
+ *Example: KilometersMiles, Miles, Kilometers, MilesKilometers
+ *
Style specifies the desired map style for the Style
APIs.
Specifies the width of the map image.
+ * @public + */ + Width: number | undefined; + + /** + *Specifies the zoom level of the map image.
+ *Cannot be used with Radius
.
The blob represents a map image as a jpeg
for
+ * the GetStaticMap
API.
Header that represents the format of the response. The response returns the following as the HTTP body.
+ * @public + */ + ContentType?: string; + + /** + *Header that instructs caching configuration for the client.
+ * @public + */ + CacheControl?: string; + + /** + *The static map's Etag.
+ * @public + */ + ETag?: string; + + /** + *The pricing bucket for which the request is charged at.
+ * @public + */ + PricingBucket: string | undefined; +} + +/** + *The request processing has failed because of an unknown error, exception or failure.
+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + Message: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to request throttling.
+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = {}; + Message: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe input fails to satisfy the constraints specified by the Amazon Location service.
+ * @public + */ +export interface ValidationExceptionField { + /** + *The name of the resource.
+ * @public + */ + Name: string | undefined; + + /** + *The error message.
+ * @public + */ + Message: string | undefined; +} + +/** + * @public + * @enum + */ +export const ValidationExceptionReason = { + /** + * The input cannot be parsed. For example a required JSON document, ARN identifier, + * date value, or numeric field cannot be parsed. + * + */ + CANNOT_PARSE: "CannotParse", + /** + * The input is present and parsable, but it is otherwise invalid. For example, a + * required numeric argument is outside the allowed range. + * + */ + FIELD_VALIDATION_FAILED: "FieldValidationFailed", + /** + * The required input is missing. + */ + MISSING: "Missing", + /** + * The input is invalid but no more specific reason is applicable. + */ + OTHER: "Other", + /** + * No such field is supported. + */ + UNKNOWN_FIELD: "UnknownField", + /** + * No such operation is supported. + */ + UNKNOWN_OPERATION: "UnknownOperation", +} as const; + +/** + * @public + */ +export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason]; + +/** + *The input fails to satisfy the constraints specified by an AWS service.
+ * @public + */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + Message: string | undefined; + /** + *The field where thebb invalid entry was detected.
+ * @public + */ + Reason: ValidationExceptionReason | undefined; + + /** + *A message with the reason for the validation exception error.
+ * @public + */ + FieldList: ValidationExceptionField[] | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeStyle specifies the desired map style.
+ * @public + */ + Style: MapStyle | undefined; + + /** + *Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.
+ *Example: Light
+ *
Default value: Light
+ *
Valid values for ColorScheme are case sensitive.
+ *Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.
+ *The following political views are currently supported:
+ *
+ * ARG
: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands
+ * EGY
: Egypt's view on Bir Tawil
+ * IND
: India's view on Gilgit-Baltistan
+ * KEN
: Kenya's view on the Ilemi Triangle
+ * MAR
: Morocco's view on Western Sahara
+ * PAK
: Pakistan's view on Jammu and Kashmir and the Junagadh Area
+ * RUS
: Russia's view on Crimea
+ * SDN
: Sudan's view on the Halaib Triangle
+ * SRB
: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
+ * SUR
: Suriname's view on the Courantyne Headwaters and Lawa Headwaters
+ * SYR
: Syria's view on the Golan Heights
+ * TUR
: Turkey's view on Cyprus and Northern Cyprus
+ * TZA
: Tanzania's view on Lake Malawi
+ * URY
: Uruguay's view on Rincon de Artigas
+ * VNM
: Vietnam's view on the Paracel Islands and Spratly Islands
Optional: The API key to be used for authorization. Either an API key or valid SigV4 + * signature must be provided when making a request.
+ * @public + */ + Key?: string; +} + +/** + * @public + */ +export interface GetStyleDescriptorResponse { + /** + *This Blob contains the body of the style descriptor which is in application/json format.
+ * @public + */ + Blob?: Uint8Array; + + /** + *Header that represents the format of the response. The response returns the following as the HTTP body.
+ * @public + */ + ContentType?: string; + + /** + *Header that instructs caching configuration for the client.
+ * @public + */ + CacheControl?: string; + + /** + *The style descriptor's Etag.
+ * @public + */ + ETag?: string; +} + +/** + * @public + */ +export interface GetTileRequest { + /** + *Specifies the desired tile set.
+ *Valid Values: raster.satellite | vector.basemap
+ *
The zoom value for the map tile.
+ * @public + */ + Z: string | undefined; + + /** + *The X axis value for the map tile. Must be between 0 and 19.
+ * @public + */ + X: string | undefined; + + /** + *The Y axis value for the map tile.
+ * @public + */ + Y: string | undefined; + + /** + *Optional: The API key to be used for authorization. Either an API key or valid SigV4 + * signature must be provided when making a request.
+ * @public + */ + Key?: string; +} + +/** + * @public + */ +export interface GetTileResponse { + /** + *The blob represents a vector tile in mvt
format for the
+ * GetTile
API.
Header that represents the format of the response. The response returns the following as the HTTP body.
+ * @public + */ + ContentType?: string; + + /** + *Header that instructs caching configuration for the client.
+ * @public + */ + CacheControl?: string; + + /** + *The pricing bucket for which the request is charged at.
+ * @public + */ + ETag?: string; + + /** + *The pricing bucket for which the request is charged at.
+ * @public + */ + PricingBucket: string | undefined; +} + +/** + * @internal + */ +export const GetStaticMapRequestFilterSensitiveLog = (obj: GetStaticMapRequest): any => ({ + ...obj, + ...(obj.Key && { Key: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetStyleDescriptorRequestFilterSensitiveLog = (obj: GetStyleDescriptorRequest): any => ({ + ...obj, + ...(obj.Key && { Key: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetTileRequestFilterSensitiveLog = (obj: GetTileRequest): any => ({ + ...obj, + ...(obj.Key && { Key: SENSITIVE_STRING }), +}); diff --git a/clients/client-geo-maps/src/protocols/Aws_restJson1.ts b/clients/client-geo-maps/src/protocols/Aws_restJson1.ts new file mode 100644 index 000000000000..f23137b817a9 --- /dev/null +++ b/clients/client-geo-maps/src/protocols/Aws_restJson1.ts @@ -0,0 +1,434 @@ +// smithy-typescript generated code +import { loadRestJsonErrorCode, parseJsonBody as parseBody, parseJsonErrorBody as parseErrorBody } from "@aws-sdk/core"; +import { requestBuilder as rb } from "@smithy/core"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { + _json, + collectBody, + decorateServiceException as __decorateServiceException, + expectNonNull as __expectNonNull, + expectString as __expectString, + extendedEncodeURIComponent as __extendedEncodeURIComponent, + map, + resolvedPath as __resolvedPath, + take, + withBaseException, +} from "@smithy/smithy-client"; +import { + Endpoint as __Endpoint, + ResponseMetadata as __ResponseMetadata, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { GetGlyphsCommandInput, GetGlyphsCommandOutput } from "../commands/GetGlyphsCommand"; +import { GetSpritesCommandInput, GetSpritesCommandOutput } from "../commands/GetSpritesCommand"; +import { GetStaticMapCommandInput, GetStaticMapCommandOutput } from "../commands/GetStaticMapCommand"; +import { GetStyleDescriptorCommandInput, GetStyleDescriptorCommandOutput } from "../commands/GetStyleDescriptorCommand"; +import { GetTileCommandInput, GetTileCommandOutput } from "../commands/GetTileCommand"; +import { GeoMapsServiceException as __BaseException } from "../models/GeoMapsServiceException"; +import { + AccessDeniedException, + InternalServerException, + ThrottlingException, + ValidationException, + ValidationExceptionField, +} from "../models/models_0"; + +/** + * serializeAws_restJson1GetGlyphsCommand + */ +export const se_GetGlyphsCommand = async ( + input: GetGlyphsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/glyphs/{FontStack}/{FontUnicodeRange}"); + b.p("FontStack", () => input.FontStack!, "{FontStack}", false); + b.p("FontUnicodeRange", () => input.FontUnicodeRange!, "{FontUnicodeRange}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1GetSpritesCommand + */ +export const se_GetSpritesCommand = async ( + input: GetSpritesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/styles/{Style}/{ColorScheme}/{Variant}/sprites/{FileName}"); + b.p("FileName", () => input.FileName!, "{FileName}", false); + b.p("Style", () => input.Style!, "{Style}", false); + b.p("ColorScheme", () => input.ColorScheme!, "{ColorScheme}", false); + b.p("Variant", () => input.Variant!, "{Variant}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1GetStaticMapCommand + */ +export const se_GetStaticMapCommand = async ( + input: GetStaticMapCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/static/{FileName}"); + b.p("FileName", () => input.FileName!, "{FileName}", false); + const query: any = map({ + [_bb]: [, input[_BB]!], + [_bp]: [, input[_BP]!], + [_c]: [, input[_C]!], + [_co]: [, input[_CO]!], + [_go]: [, input[_GJO]!], + [_h]: [__expectNonNull(input.Height, `Height`) != null, () => input[_H]!.toString()], + [_k]: [, input[_K]!], + [_p]: [() => input.Padding !== void 0, () => input[_P]!.toString()], + [_r]: [() => input.Radius !== void 0, () => input[_R]!.toString()], + [_su]: [, input[_SBU]!], + [_s]: [, input[_S]!], + [_w]: [__expectNonNull(input.Width, `Width`) != null, () => input[_W]!.toString()], + [_z]: [() => input.Zoom !== void 0, () => (input[_Z]! % 1 == 0 ? input[_Z]! + ".0" : input[_Z]!.toString())], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1GetStyleDescriptorCommand + */ +export const se_GetStyleDescriptorCommand = async ( + input: GetStyleDescriptorCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/styles/{Style}/descriptor"); + b.p("Style", () => input.Style!, "{Style}", false); + const query: any = map({ + [_cs]: [, input[_CS]!], + [_pv]: [, input[_PV]!], + [_k]: [, input[_K]!], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1GetTileCommand + */ +export const se_GetTileCommand = async ( + input: GetTileCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/tiles/{Tileset}/{Z}/{X}/{Y}"); + b.p("Tileset", () => input.Tileset!, "{Tileset}", false); + b.p("Z", () => input.Z!, "{Z}", false); + b.p("X", () => input.X!, "{X}", false); + b.p("Y", () => input.Y!, "{Y}", false); + const query: any = map({ + [_k]: [, input[_K]!], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + +/** + * deserializeAws_restJson1GetGlyphsCommand + */ +export const de_GetGlyphsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseThe request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.geomaps#ApiKey": { + "type": "string", + "traits": { + "smithy.api#externalDocumentation": { + "Implementation Guide": "https://github.com/paseto-standard/paseto-spec/blob/master/docs/02-Implementation-Guide/03-Algorithm-Lucidity.md" + }, + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.geomaps#ColorScheme": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LIGHT", + "value": "Light" + }, + { + "name": "DARK", + "value": "Dark" + } + ] + } + }, + "com.amazonaws.geomaps#CompactOverlay": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7000 + } + } + }, + "com.amazonaws.geomaps#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + }, + "smithy.api#pattern": "^([A-Z]{2}|[A-Z]{3})$" + } + }, + "com.amazonaws.geomaps#DistanceMeters": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.geomaps#GeoJsonOverlay": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7000 + } + } + }, + "com.amazonaws.geomaps#GetGlyphs": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetGlyphsRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetGlyphsResponse" + }, + "traits": { + "smithy.api#documentation": "Returns the map's glyphs.
", + "smithy.api#http": { + "uri": "/glyphs/{FontStack}/{FontUnicodeRange}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetGlyphsSuccess", + "params": { + "FontStack": "Amazon Ember Regular", + "FontUnicodeRange": "0-255.pbf" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetGlyphsRequest": { + "type": "structure", + "members": { + "FontStack": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of the FontStack
to retrieve.
Example: Amazon Ember Bold,Noto Sans Bold
.
The supported font stacks are as follows:
\nAmazon Ember Bold
\nAmazon Ember Bold Italic
\nAmazon Ember Bold,Noto Sans Bold
\nAmazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
\nAmazon Ember Condensed RC BdItalic
\nAmazon Ember Condensed RC Bold
\nAmazon Ember Condensed RC Bold Italic
\nAmazon Ember Condensed RC Bold,Noto Sans Bold
\nAmazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold
\nAmazon Ember Condensed RC Light
\nAmazon Ember Condensed RC Light Italic
\nAmazon Ember Condensed RC LtItalic
\nAmazon Ember Condensed RC Regular
\nAmazon Ember Condensed RC Regular Italic
\nAmazon Ember Condensed RC Regular,Noto Sans Regular
\nAmazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular
\nAmazon Ember Condensed RC RgItalic
\nAmazon Ember Condensed RC ThItalic
\nAmazon Ember Condensed RC Thin
\nAmazon Ember Condensed RC Thin Italic
\nAmazon Ember Heavy
\nAmazon Ember Heavy Italic
\nAmazon Ember Light
\nAmazon Ember Light Italic
\nAmazon Ember Medium
\nAmazon Ember Medium Italic
\nAmazon Ember Medium,Noto Sans Medium
\nAmazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
\nAmazon Ember Regular
\nAmazon Ember Regular Italic
\nAmazon Ember Regular Italic,Noto Sans Italic
\nAmazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular
\nAmazon Ember Regular,Noto Sans Regular
\nAmazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
\nAmazon Ember Thin
\nAmazon Ember Thin Italic
\nAmazonEmberCdRC_Bd
\nAmazonEmberCdRC_BdIt
\nAmazonEmberCdRC_Lt
\nAmazonEmberCdRC_LtIt
\nAmazonEmberCdRC_Rg
\nAmazonEmberCdRC_RgIt
\nAmazonEmberCdRC_Th
\nAmazonEmberCdRC_ThIt
\nAmazonEmber_Bd
\nAmazonEmber_BdIt
\nAmazonEmber_He
\nAmazonEmber_HeIt
\nAmazonEmber_Lt
\nAmazonEmber_LtIt
\nAmazonEmber_Md
\nAmazonEmber_MdIt
\nAmazonEmber_Rg
\nAmazonEmber_RgIt
\nAmazonEmber_Th
\nAmazonEmber_ThIt
\nNoto Sans Black
\nNoto Sans Black Italic
\nNoto Sans Bold
\nNoto Sans Bold Italic
\nNoto Sans Extra Bold
\nNoto Sans Extra Bold Italic
\nNoto Sans Extra Light
\nNoto Sans Extra Light Italic
\nNoto Sans Italic
\nNoto Sans Light
\nNoto Sans Light Italic
\nNoto Sans Medium
\nNoto Sans Medium Italic
\nNoto Sans Regular
\nNoto Sans Semi Bold
\nNoto Sans Semi Bold Italic
\nNoto Sans Thin
\nNoto Sans Thin Italic
\nNotoSans-Bold
\nNotoSans-Italic
\nNotoSans-Medium
\nNotoSans-Regular
\nOpen Sans Regular,Arial Unicode MS Regular
\nA Unicode range of characters to download glyphs for. This must be aligned to multiples\n of 256.
\nExample: 0-255.pdf
\n
The Glyph, as a binary blob.
", + "smithy.api#httpPayload": {} + } + }, + "ContentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The glyph's Etag.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#GetSprites": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetSpritesRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetSpritesResponse" + }, + "traits": { + "smithy.api#documentation": "Returns the map's sprites.
", + "smithy.api#http": { + "uri": "/styles/{Style}/{ColorScheme}/{Variant}/sprites/{FileName}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetSpritesSuccess", + "params": { + "Style": "Standard", + "ColorScheme": "Light", + "Variant": "Default", + "FileName": "sprites.json" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetSpritesRequest": { + "type": "structure", + "members": { + "FileName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n Sprites
API: The name of the sprite file to retrieve, following pattern\n sprites(@2x)?\\.(png|json)
.
Example: sprites.png
\n
Style specifies the desired map style for the Sprites
APIs.
Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.
\nExample: Light
\n
Default value: Light
\n
Valid values for ColorScheme are case sensitive.
\nOptimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.
\nExample: Default
\n
Valid values for Variant are case sensitive.
\nThe body of the sprite sheet or JSON offset file (image/png or application/json,\n depending on input).
", + "smithy.api#httpPayload": {} + } + }, + "ContentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The sprite's Etag.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#GetStaticMap": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetStaticMapRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetStaticMapResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geomaps#AccessDeniedException" + }, + { + "target": "com.amazonaws.geomaps#InternalServerException" + }, + { + "target": "com.amazonaws.geomaps#ThrottlingException" + }, + { + "target": "com.amazonaws.geomaps#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "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.
", + "smithy.api#http": { + "uri": "/static/{FileName}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetStaticMapSuccess", + "params": { + "FileName": "map", + "Width": 800, + "Height": 900, + "Center": "-123.144847,49.303609", + "Style": "Satellite", + "Zoom": 10.0 + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetStaticMapRequest": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.geomaps#PositionListString", + "traits": { + "smithy.api#documentation": "Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and\n north-easterly edges of the image. The underlying area becomes the view of the image.
\nExample: -123.17075,49.26959,-123.08125,49.31429
", + "smithy.api#httpQuery": "bounding-box" + } + }, + "BoundedPositions": { + "target": "com.amazonaws.geomaps#PositionListString", + "traits": { + "smithy.api#documentation": "Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by\n a comma. The API will generate an image to encompass all of the provided coordinates.
\nCannot be used with Zoom
and or Radius
\n
Example: 97.170451,78.039098,99.045536,27.176178
", + "smithy.api#httpQuery": "bounded-positions" + } + }, + "Center": { + "target": "com.amazonaws.geomaps#PositionString", + "traits": { + "smithy.api#documentation": "Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image.\n This parameter requires that either zoom or radius is set.
\nCannot be used with Zoom
and or Radius
\n
Example: 49.295,-123.108
", + "smithy.api#httpQuery": "center" + } + }, + "CompactOverlay": { + "target": "com.amazonaws.geomaps#CompactOverlay", + "traits": { + "smithy.api#documentation": "Takes in a string to draw geometries on the image. The input is a comma separated format as follows format:\n [Lon, Lat]
\n
Example:\n line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B
\n
Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.
\nTakes in a string to draw geometries on the image. The input is a valid GeoJSON\n collection object.
\nExample:\n {\"type\":\"FeatureCollection\",\"features\": [{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPoint\",\"coordinates\": [[-90.076345,51.504107],[-0.074451,51.506892]]},\"properties\": {\"color\":\"#00DD00\"}}]}
\n
Specifies the height of the map image.
", + "smithy.api#httpQuery": "height", + "smithy.api#range": { + "min": 64, + "max": 1400 + }, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.geomaps#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + }, + "Padding": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Applies additional space (in pixels) around overlay feature to prevent them from being\n cut or obscured.
\nValue for max and min is determined by:
\nMin: 1
\n
Max: min(height, width)/4
\n
Example: 100
\n
Used with center parameter, it specifies the zoom of the image where you can control it\n on a granular level. Takes in any value >= 1
.
Example: 1500
\n
Cannot be used with Zoom
.
\n Unit: Meters
\n
The map scaling parameter to size the image, icons, and labels. It follows the pattern\n of ^map(@2x)?$
.
Example: map, map@2x
\n
Displays a scale on the bottom right of the map image with the unit specified in the\n input.
\nExample: KilometersMiles, Miles, Kilometers, MilesKilometers
\n
Style specifies the desired map style for the Style
APIs.
Specifies the width of the map image.
", + "smithy.api#httpQuery": "width", + "smithy.api#range": { + "min": 64, + "max": 1400 + }, + "smithy.api#required": {} + } + }, + "Zoom": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Specifies the zoom level of the map image.
\nCannot be used with Radius
.
The blob represents a map image as a jpeg
for\n the GetStaticMap
API.
Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The static map's Etag.
", + "smithy.api#httpHeader": "ETag" + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the request is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#GetStyleDescriptor": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetStyleDescriptorRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetStyleDescriptorResponse" + }, + "traits": { + "smithy.api#documentation": "Returns information about the style.
", + "smithy.api#http": { + "uri": "/styles/{Style}/descriptor", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetStyleDescriptorSuccess", + "params": { + "Style": "Standard" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetStyleDescriptorRequest": { + "type": "structure", + "members": { + "Style": { + "target": "com.amazonaws.geomaps#MapStyle", + "traits": { + "smithy.api#documentation": "Style specifies the desired map style.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ColorScheme": { + "target": "com.amazonaws.geomaps#ColorScheme", + "traits": { + "smithy.api#documentation": "Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.
\nExample: Light
\n
Default value: Light
\n
Valid values for ColorScheme are case sensitive.
\nSpecifies the political view using ISO 3166-2 or ISO 3166-3 country code format.
\nThe following political views are currently supported:
\n\n ARG
: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands
\n EGY
: Egypt's view on Bir Tawil
\n IND
: India's view on Gilgit-Baltistan
\n KEN
: Kenya's view on the Ilemi Triangle
\n MAR
: Morocco's view on Western Sahara
\n PAK
: Pakistan's view on Jammu and Kashmir and the Junagadh Area
\n RUS
: Russia's view on Crimea
\n SDN
: Sudan's view on the Halaib Triangle
\n SRB
: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
\n SUR
: Suriname's view on the Courantyne Headwaters and Lawa Headwaters
\n SYR
: Syria's view on the Golan Heights
\n TUR
: Turkey's view on Cyprus and Northern Cyprus
\n TZA
: Tanzania's view on Lake Malawi
\n URY
: Uruguay's view on Rincon de Artigas
\n VNM
: Vietnam's view on the Paracel Islands and Spratly Islands
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geomaps#GetStyleDescriptorResponse": { + "type": "structure", + "members": { + "Blob": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "This Blob contains the body of the style descriptor which is in application/json format.
", + "smithy.api#httpPayload": {} + } + }, + "ContentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The style descriptor's Etag.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#GetTile": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetTileRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetTileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geomaps#AccessDeniedException" + }, + { + "target": "com.amazonaws.geomaps#InternalServerException" + }, + { + "target": "com.amazonaws.geomaps#ThrottlingException" + }, + { + "target": "com.amazonaws.geomaps#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "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.
", + "smithy.api#http": { + "uri": "/tiles/{Tileset}/{Z}/{X}/{Y}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetTileSuccess", + "params": { + "Tileset": "vector.basemap", + "X": "5190", + "Y": "11218", + "Z": "15" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetTileRequest": { + "type": "structure", + "members": { + "Tileset": { + "target": "com.amazonaws.geomaps#Tileset", + "traits": { + "smithy.api#documentation": "Specifies the desired tile set.
\nValid Values: raster.satellite | vector.basemap
\n
The zoom value for the map tile.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "\\d+", + "smithy.api#required": {} + } + }, + "X": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The X axis value for the map tile. Must be between 0 and 19.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "\\d+", + "smithy.api#required": {} + } + }, + "Y": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Y axis value for the map tile.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "\\d+", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.geomaps#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geomaps#GetTileResponse": { + "type": "structure", + "members": { + "Blob": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The blob represents a vector tile in mvt
format for the\n GetTile
API.
Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the request is charged at.
", + "smithy.api#httpHeader": "ETag" + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the request is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.geomaps#MapStyle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STANDARD", + "value": "Standard" + }, + { + "name": "MONOCHROME", + "value": "Monochrome" + }, + { + "name": "HYBRID", + "value": "Hybrid" + }, + { + "name": "SATELLITE", + "value": "Satellite" + } + ] + } + }, + "com.amazonaws.geomaps#MapsService": { + "type": "service", + "version": "2020-11-19", + "resources": [ + { + "target": "com.amazonaws.geomaps#ProviderResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Geo Maps", + "arnNamespace": "geo-maps", + "cloudTrailEventSource": "geo-maps.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "geo-maps" + }, + "aws.endpoints#standardRegionalEndpoints": { + "partitionSpecialCases": { + "aws": [ + { + "endpoint": "https://maps.geo.{region}.{dnsSuffix}/v2" + }, + { + "endpoint": "https://maps.geo-fips.{region}.{dualStackDnsSuffix}/v2", + "fips": true, + "dualStack": true + }, + { + "endpoint": "https://maps.geo-fips.{region}.{dnsSuffix}/v2", + "fips": true, + "dualStack": false + }, + { + "endpoint": "https://maps.geo.{region}.{dualStackDnsSuffix}/v2", + "fips": false, + "dualStack": true + } + ], + "aws-us-gov": [ + { + "endpoint": "https://maps.geo.{region}.us-gov.{dnsSuffix}/v2" + }, + { + "endpoint": "https://maps.geo-fips.{region}.us-gov.{dualStackDnsSuffix}/v2", + "fips": true, + "dualStack": true + }, + { + "endpoint": "https://maps.geo-fips.{region}.us-gov.{dnsSuffix}/v2", + "fips": true, + "dualStack": false + }, + { + "endpoint": "https://maps.geo.{region}.us-gov.{dualStackDnsSuffix}/v2", + "fips": false, + "dualStack": true + } + ] + } + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": ["x-amz-content-sha256", "x-amz-user-agent", "content-type"], + "additionalExposedHeaders": [ + "age", + "date", + "x-amz-apigw-id", + "x-amz-cf-id", + "x-amz-cf-pop", + "x-amzn-requestid", + "x-amzn-trace-id", + "x-cache" + ] + }, + "smithy.api#documentation": "\n Integrate high-quality base map data into your applications using \n MapLibre. Capabilities include:\n
\nAccess to comprehensive base map data, allowing you to tailor the map display to your specific needs.
\nMultiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.
\nGeneration of static map images for scenarios where interactive maps aren't suitable, such as:
\nEmbedding in emails or documents
\nDisplaying in low-bandwidth environments
\nCreating printable maps
\nEnhancing application performance by reducing client-side rendering
\nThe request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.geomaps#Tileset": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-.\\w]+$" + } + }, + "com.amazonaws.geomaps#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.geomaps#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The field where thebb invalid entry was detected.
", + "smithy.api#jsonName": "reason", + "smithy.api#required": {} + } + }, + "FieldList": { + "target": "com.amazonaws.geomaps#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "A message with the reason for the validation exception error.
", + "smithy.api#jsonName": "fieldList", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.geomaps#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the resource.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the Amazon Location service.
" + } + }, + "com.amazonaws.geomaps#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.geomaps#ValidationExceptionField" + } + }, + "com.amazonaws.geomaps#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "UNKNOWN_OPERATION", + "value": "UnknownOperation", + "documentation": "No such operation is supported." + }, + { + "name": "MISSING", + "value": "Missing", + "documentation": "The required input is missing." + }, + { + "name": "CANNOT_PARSE", + "value": "CannotParse", + "documentation": " The input cannot be parsed. For example a required JSON document, ARN identifier,\n date value, or numeric field cannot be parsed.\n" + }, + { + "name": "FIELD_VALIDATION_FAILED", + "value": "FieldValidationFailed", + "documentation": " The input is present and parsable, but it is otherwise invalid. For example, a\n required numeric argument is outside the allowed range.\n" + }, + { + "name": "OTHER", + "value": "Other", + "documentation": "The input is invalid but no more specific reason is applicable." + }, + { + "name": "UNKNOWN_FIELD", + "value": "UnknownField", + "documentation": "No such field is supported." + } + ] + } + }, + "com.amazonaws.geomaps#Variant": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DEFAULT", + "value": "Default" + } + ] + } + } + } +}