@aws-sdk/types 3.208.0 → 3.215.0

package/dist-cjs/identity/AnonymousIdentity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/identity/AwsCredentialIdentity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/identity/Identity.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;

package/dist-cjs/identity/LoginIdentity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/identity/TokenIdentity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/identity/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./AnonymousIdentity"), exports);
+tslib_1.__exportStar(require("./AwsCredentialIdentity"), exports);
+tslib_1.__exportStar(require("./Identity"), exports);
+tslib_1.__exportStar(require("./LoginIdentity"), exports);
+tslib_1.__exportStar(require("./TokenIdentity"), exports);

package/dist-cjs/index.js

@@ -10,6 +10,7 @@ tslib_1.__exportStar(require("./crypto"), exports);
 tslib_1.__exportStar(require("./endpoint"), exports);
 tslib_1.__exportStar(require("./eventStream"), exports);
 tslib_1.__exportStar(require("./http"), exports);
+tslib_1.__exportStar(require("./identity"), exports);
 tslib_1.__exportStar(require("./logger"), exports);
 tslib_1.__exportStar(require("./middleware"), exports);
 tslib_1.__exportStar(require("./pagination"), exports);

package/dist-es/identity/AnonymousIdentity.js

@@ -0,0 +1 @@
+export {};

package/dist-es/identity/AwsCredentialIdentity.js

@@ -0,0 +1 @@
+export {};

package/dist-es/identity/Identity.js

@@ -0,0 +1,2 @@
+;
+export {};

package/dist-es/identity/LoginIdentity.js

@@ -0,0 +1 @@
+export {};

package/dist-es/identity/TokenIdentity.js

@@ -0,0 +1 @@
+export {};

package/dist-es/identity/index.js

@@ -0,0 +1,5 @@
+export * from "./AnonymousIdentity";
+export * from "./AwsCredentialIdentity";
+export * from "./Identity";
+export * from "./LoginIdentity";
+export * from "./TokenIdentity";

package/dist-es/index.js

@@ -7,6 +7,7 @@ export * from "./crypto";
 export * from "./endpoint";
 export * from "./eventStream";
 export * from "./http";
+export * from "./identity";
 export * from "./logger";
 export * from "./middleware";
 export * from "./pagination";

package/dist-types/credentials.d.ts

@@ -1,26 +1,13 @@
+import { AwsCredentialIdentity } from "./identity";
 import { Provider } from "./util";
-export interface AwsCredentialIdentity {
-    /**
-     * A {Date} when the identity or credential will no longer be accepted.
-     */
-    readonly expiration?: Date;
-}
 /**
  * An object representing temporary or permanent AWS credentials.
+ *
+ * @deprecated Use {@AwsCredentialIdentity}
  */
 export interface Credentials extends AwsCredentialIdentity {
-    /**
-     * AWS access key ID
-     */
-    readonly accessKeyId: string;
-    /**
-     * AWS secret access key
-     */
-    readonly secretAccessKey: string;
-    /**
-     * A security or session token to use with these credentials. Usually
-     * present for temporary credentials.
-     */
-    readonly sessionToken?: string;
 }
+/**
+ * @deprecated Use {@AwsCredentialIdentityProvider}
+ */
 export declare type CredentialProvider = Provider<Credentials>;

package/dist-types/identity/AnonymousIdentity.d.ts

@@ -0,0 +1,3 @@
+import { Identity } from "./Identity";
+export interface AnonymousIdentity extends Identity {
+}

package/dist-types/identity/AwsCredentialIdentity.d.ts

@@ -0,0 +1,17 @@
+import { Identity, IdentityProvider } from "./Identity";
+export interface AwsCredentialIdentity extends Identity {
+    /**
+     * AWS access key ID
+     */
+    readonly accessKeyId: string;
+    /**
+     * AWS secret access key
+     */
+    readonly secretAccessKey: string;
+    /**
+     * A security or session token to use with these credentials. Usually
+     * present for temporary credentials.
+     */
+    readonly sessionToken?: string;
+}
+export declare type AwsCredentialIdentityProvider = IdentityProvider<AwsCredentialIdentity>;

package/dist-types/identity/Identity.d.ts

@@ -0,0 +1,9 @@
+export interface Identity {
+    /**
+     * A {Date} when the identity or credential will no longer be accepted.
+     */
+    readonly expiration?: Date;
+}
+export interface IdentityProvider<IdentityT extends Identity> {
+    (identityProperties?: Record<string, any>): Promise<IdentityT>;
+}

package/dist-types/identity/LoginIdentity.d.ts

@@ -0,0 +1,12 @@
+import { Identity, IdentityProvider } from "./Identity";
+export interface LoginIdentity extends Identity {
+    /**
+     * Identity username
+     */
+    readonly username: string;
+    /**
+     * Identity password
+     */
+    readonly password: string;
+}
+export declare type LoginIdentityProvider = IdentityProvider<LoginIdentity>;

package/dist-types/identity/TokenIdentity.d.ts

@@ -0,0 +1,8 @@
+import { Identity, IdentityProvider } from "./Identity";
+export interface TokenIdentity extends Identity {
+    /**
+     * The literal token string
+     */
+    readonly token: string;
+}
+export declare type TokenIdentityProvider = IdentityProvider<TokenIdentity>;

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

@@ -0,0 +1,5 @@
+export * from "./AnonymousIdentity";
+export * from "./AwsCredentialIdentity";
+export * from "./Identity";
+export * from "./LoginIdentity";
+export * from "./TokenIdentity";

package/dist-types/index.d.ts

@@ -7,6 +7,7 @@ export * from "./crypto";
 export * from "./endpoint";
 export * from "./eventStream";
 export * from "./http";
+export * from "./identity";
 export * from "./logger";
 export * from "./middleware";
 export * from "./pagination";

package/dist-types/shapes.d.ts

@@ -13,7 +13,7 @@ export declare type DocumentType = null | boolean | number | string | DocumentTy
 };
 /**
  * A structure shape with the error trait.
- * https://awslabs.github.io/smithy/spec/core.html#retryable-trait
+ * https://smithy.io/2.0/spec/behavior-traits.html#smithy-api-retryable-trait
  */
 export interface RetryableTrait {
     /**

package/dist-types/token.d.ts

@@ -1,16 +1,13 @@
+import { TokenIdentity } from "./identity";
 import { Provider } from "./util";
 /**
  * An object representing temporary or permanent AWS token.
+ *
+ * @deprecated Use {@TokenIdentity}
  */
-export interface Token {
-    /**
-     *The literal token string
-     */
-    readonly token: string;
-    /**
-     * A {Date} when these token will no longer be accepted.
-     * When expiration is not defined, the token is assumed to be permanent.
-     */
-    readonly expiration?: Date;
+export interface Token extends TokenIdentity {
 }
+/**
+ * @deprecated Use {@TokenIdentityProvider}
+ */
 export declare type TokenProvider = Provider<Token>;

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

@@ -1,10 +1,4 @@
+import { AwsCredentialIdentity } from "./identity";
 import { Provider } from "./util";
-export interface AwsCredentialIdentity {
-  readonly expiration?: Date;
-}
-export interface Credentials extends AwsCredentialIdentity {
-  readonly accessKeyId: string;
-  readonly secretAccessKey: string;
-  readonly sessionToken?: string;
-}
+export interface Credentials extends AwsCredentialIdentity {}
 export declare type CredentialProvider = Provider<Credentials>;

package/dist-types/ts3.4/identity/AnonymousIdentity.d.ts

@@ -0,0 +1,2 @@
+import { Identity } from "./Identity";
+export interface AnonymousIdentity extends Identity {}

package/dist-types/ts3.4/identity/AwsCredentialIdentity.d.ts

@@ -0,0 +1,8 @@
+import { Identity, IdentityProvider } from "./Identity";
+export interface AwsCredentialIdentity extends Identity {
+  readonly accessKeyId: string;
+  readonly secretAccessKey: string;
+  readonly sessionToken?: string;
+}
+export declare type AwsCredentialIdentityProvider =
+  IdentityProvider<AwsCredentialIdentity>;

package/dist-types/ts3.4/identity/Identity.d.ts

@@ -0,0 +1,6 @@
+export interface Identity {
+  readonly expiration?: Date;
+}
+export interface IdentityProvider<IdentityT extends Identity> {
+  (identityProperties?: Record<string, any>): Promise<IdentityT>;
+}

package/dist-types/ts3.4/identity/LoginIdentity.d.ts

@@ -0,0 +1,6 @@
+import { Identity, IdentityProvider } from "./Identity";
+export interface LoginIdentity extends Identity {
+  readonly username: string;
+  readonly password: string;
+}
+export declare type LoginIdentityProvider = IdentityProvider<LoginIdentity>;

package/dist-types/ts3.4/identity/TokenIdentity.d.ts

@@ -0,0 +1,5 @@
+import { Identity, IdentityProvider } from "./Identity";
+export interface TokenIdentity extends Identity {
+  readonly token: string;
+}
+export declare type TokenIdentityProvider = IdentityProvider<TokenIdentity>;

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

@@ -0,0 +1,5 @@
+export * from "./AnonymousIdentity";
+export * from "./AwsCredentialIdentity";
+export * from "./Identity";
+export * from "./LoginIdentity";
+export * from "./TokenIdentity";

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

@@ -7,6 +7,7 @@ export * from "./crypto";
 export * from "./endpoint";
 export * from "./eventStream";
 export * from "./http";
+export * from "./identity";
 export * from "./logger";
 export * from "./middleware";
 export * from "./pagination";

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

@@ -1,6 +1,4 @@
+import { TokenIdentity } from "./identity";
 import { Provider } from "./util";
-export interface Token {
-  readonly token: string;
-  readonly expiration?: Date;
-}
+export interface Token extends TokenIdentity {}
 export declare type TokenProvider = Provider<Token>;

package/package.json

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