@aws-sdk/client-geo-maps 3.683.0

package/dist-types/commands/GetTileCommand.d.ts

@@ -0,0 +1,98 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { Uint8ArrayBlobAdapter } from "@smithy/util-stream";
+import { GeoMapsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoMapsClient";
+import { GetTileRequest, GetTileResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetTileCommand}.
+ */
+export interface GetTileCommandInput extends GetTileRequest {
+}
+/**
+ * @public
+ */
+export type GetTileCommandOutputType = Omit<GetTileResponse, "Blob"> & {
+    Blob?: Uint8ArrayBlobAdapter;
+};
+/**
+ * @public
+ *
+ * The output of {@link GetTileCommand}.
+ */
+export interface GetTileCommandOutput extends GetTileCommandOutputType, __MetadataBearer {
+}
+declare const GetTileCommand_base: {
+    new (input: GetTileCommandInput): import("@smithy/smithy-client").CommandImpl<GetTileCommandInput, GetTileCommandOutput, GeoMapsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetTileCommandInput): import("@smithy/smithy-client").CommandImpl<GetTileCommandInput, GetTileCommandOutput, GeoMapsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <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>
+ * @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)
+ *  <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link GeoMapsServiceException}
+ * <p>Base exception class for all service exceptions from GeoMaps service.</p>
+ *
+ * @public
+ */
+export declare class GetTileCommand extends GetTileCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetTileRequest;
+            output: GetTileResponse;
+        };
+        sdk: {
+            input: GetTileCommandInput;
+            output: GetTileCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./GetGlyphsCommand";
+export * from "./GetSpritesCommand";
+export * from "./GetStaticMapCommand";
+export * from "./GetStyleDescriptorCommand";
+export * from "./GetTileCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,40 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+    region?: string | Provider<string>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+    readonly UseDualStack: {
+        readonly type: "builtInParams";
+        readonly name: "useDualstackEndpoint";
+    };
+};
+export interface EndpointParameters extends __EndpointParameters {
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+    Region?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface GeoMapsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,41 @@
+/**
+ * <p>
+ *          Integrate high-quality base map data into your applications using
+ *          <a href="https://maplibre.org">MapLibre</a>. Capabilities include:
+ *      </p>
+ *          <ul>
+ *             <li>
+ *                <p>Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.</p>
+ *             </li>
+ *             <li>
+ *                <p>Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.</p>
+ *             </li>
+ *             <li>
+ *                <p>Generation of static map images for scenarios where interactive maps aren't suitable, such as:</p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Embedding in emails or documents</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Displaying in low-bandwidth environments</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Creating printable maps</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Enhancing application performance by reducing client-side rendering</p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *          </ul>
+ *
+ * @packageDocumentation
+ */
+export * from "./GeoMapsClient";
+export * from "./GeoMaps";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { GeoMapsExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./models";
+export { GeoMapsServiceException } from "./models/GeoMapsServiceException";

package/dist-types/models/GeoMapsServiceException.d.ts

@@ -0,0 +1,14 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from GeoMaps service.
+ */
+export declare class GeoMapsServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";