@aws-sdk/types 3.266.1 → 3.271.0

package/dist-cjs/dns.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HostAddressType = void 0;
+var HostAddressType;
+(function (HostAddressType) {
+    HostAddressType["AAAA"] = "AAAA";
+    HostAddressType["A"] = "A";
+})(HostAddressType = exports.HostAddressType || (exports.HostAddressType = {}));

package/dist-cjs/index.js

@@ -8,6 +8,7 @@ tslib_1.__exportStar(require("./client"), exports);
 tslib_1.__exportStar(require("./command"), exports);
 tslib_1.__exportStar(require("./credentials"), exports);
 tslib_1.__exportStar(require("./crypto"), exports);
+tslib_1.__exportStar(require("./dns"), exports);
 tslib_1.__exportStar(require("./endpoint"), exports);
 tslib_1.__exportStar(require("./eventStream"), exports);
 tslib_1.__exportStar(require("./http"), exports);

package/dist-es/dns.js

@@ -0,0 +1,5 @@
+export var HostAddressType;
+(function (HostAddressType) {
+    HostAddressType["AAAA"] = "AAAA";
+    HostAddressType["A"] = "A";
+})(HostAddressType || (HostAddressType = {}));

package/dist-es/index.js

@@ -5,6 +5,7 @@ export * from "./client";
 export * from "./command";
 export * from "./credentials";
 export * from "./crypto";
+export * from "./dns";
 export * from "./endpoint";
 export * from "./eventStream";
 export * from "./http";

package/dist-types/dns.d.ts

@@ -0,0 +1,75 @@
+/**
+ * DNS record types
+ */
+export declare enum HostAddressType {
+    /**
+     * IPv6
+     */
+    AAAA = "AAAA",
+    /**
+     * IPv4
+     */
+    A = "A"
+}
+export interface HostAddress {
+    /**
+     * The {@link HostAddressType} of the host address.
+     */
+    addressType: HostAddressType;
+    /**
+     * The resolved numerical address represented as a
+     * string.
+     */
+    address: string;
+    /**
+     * The host name the {@link address} was resolved from.
+     */
+    hostName: string;
+    /**
+     * The service record of {@link hostName}.
+     */
+    service?: string;
+}
+export interface HostResolverArguments {
+    /**
+     * The host name to resolve.
+     */
+    hostName: string;
+    /**
+     * The service record of {@link hostName}.
+     */
+    service?: string;
+}
+/**
+ * Host Resolver interface for DNS queries
+ */
+export interface HostResolver {
+    /**
+     * Resolves the address(es) for {@link HostResolverArguments} and returns a
+     * list of addresses with (most likely) two addresses, one {@link HostAddressType.AAAA}
+     * and one {@link HostAddressType.A}. Calls to this function will likely alter
+     * the cache (if implemented) so that if there's multiple addresses, a different
+     * set will be returned on the next call.
+     * In the case of multi-answer, still only a maximum of two records should be
+     * returned. The resolver implementation is responsible for caching and rotation
+     * of the multiple addresses that get returned.
+     * Implementations don't have to explictly call getaddrinfo(), they can use
+     * high level abstractions provided in their language runtimes/libraries.
+     * @param args arguments with host name query addresses for
+     * @returns promise with a list of {@link HostAddress}
+     */
+    resolveAddress(args: HostResolverArguments): Promise<HostAddress[]>;
+    /**
+     * Reports a failure on a {@link HostAddress} so that the cache (if implemented)
+     * can accomodate the failure and likely not return the address until it recovers.
+     * @param addr host address to report a failure on
+     */
+    reportFailureOnAddress(addr: HostAddress): void;
+    /**
+     * Empties the cache (if implemented) for a {@link HostResolverArguments.hostName}.
+     * If {@link HostResolverArguments.hostName} is not provided, the cache (if
+     * implemented) is emptied for all host names.
+     * @param args optional arguments to empty the cache for
+     */
+    purgeCache(args?: HostResolverArguments): void;
+}

package/dist-types/index.d.ts

@@ -5,6 +5,7 @@ export * from "./client";
 export * from "./command";
 export * from "./credentials";
 export * from "./crypto";
+export * from "./dns";
 export * from "./endpoint";
 export * from "./eventStream";
 export * from "./http";

package/dist-types/ts3.4/dns.d.ts

@@ -0,0 +1,19 @@
+export declare enum HostAddressType {
+  AAAA = "AAAA",
+  A = "A",
+}
+export interface HostAddress {
+  addressType: HostAddressType;
+  address: string;
+  hostName: string;
+  service?: string;
+}
+export interface HostResolverArguments {
+  hostName: string;
+  service?: string;
+}
+export interface HostResolver {
+  resolveAddress(args: HostResolverArguments): Promise<HostAddress[]>;
+  reportFailureOnAddress(addr: HostAddress): void;
+  purgeCache(args?: HostResolverArguments): void;
+}

package/dist-types/ts3.4/index.d.ts

@@ -5,6 +5,7 @@ export * from "./client";
 export * from "./command";
 export * from "./credentials";
 export * from "./crypto";
+export * from "./dns";
 export * from "./endpoint";
 export * from "./eventStream";
 export * from "./http";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/types",
-  "version": "3.266.1",
+  "version": "3.271.0",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",