Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@trivikr-test/types

Package Overview
Dependencies
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@trivikr-test/types - npm Package Compare versions

Comparing version 3.170.0 to 3.347.0

dist-cjs/auth.js
dist-cjs/checksum.js
dist-cjs/connection/config.js
dist-cjs/connection/index.js
dist-cjs/connection/manager.js
dist-cjs/connection/pool.js
dist-cjs/dns.js
dist-cjs/encode.js
dist-cjs/identity/AnonymousIdentity.js
dist-cjs/identity/AwsCredentialIdentity.js
dist-cjs/identity/Identity.js
dist-cjs/identity/index.js
dist-cjs/identity/LoginIdentity.js
dist-cjs/identity/TokenIdentity.js
dist-cjs/request.js
dist-cjs/retry.js
dist-cjs/uri.js
dist-es/auth.js
dist-es/checksum.js
dist-es/connection/config.js
dist-es/connection/index.js
dist-es/connection/manager.js
dist-es/connection/pool.js
dist-es/dns.js
dist-es/encode.js
dist-es/identity/AnonymousIdentity.js
dist-es/identity/AwsCredentialIdentity.js
dist-es/identity/Identity.js
dist-es/identity/index.js
dist-es/identity/LoginIdentity.js
dist-es/identity/TokenIdentity.js
dist-es/request.js
dist-es/retry.js
dist-es/uri.js
dist-types/auth.d.ts
dist-types/checksum.d.ts
dist-types/connection/config.d.ts
dist-types/connection/index.d.ts
dist-types/connection/manager.d.ts
dist-types/connection/pool.d.ts
dist-types/dns.d.ts
dist-types/encode.d.ts
dist-types/identity/AnonymousIdentity.d.ts
dist-types/identity/AwsCredentialIdentity.d.ts
dist-types/identity/Identity.d.ts
dist-types/identity/index.d.ts
dist-types/identity/LoginIdentity.d.ts
dist-types/identity/TokenIdentity.d.ts
dist-types/request.d.ts
dist-types/retry.d.ts
dist-types/ts3.4/auth.d.ts
dist-types/ts3.4/checksum.d.ts
dist-types/ts3.4/connection/config.d.ts
dist-types/ts3.4/connection/index.d.ts
dist-types/ts3.4/connection/manager.d.ts
dist-types/ts3.4/connection/pool.d.ts
dist-types/ts3.4/dns.d.ts
dist-types/ts3.4/encode.d.ts
dist-types/ts3.4/identity/AnonymousIdentity.d.ts
dist-types/ts3.4/identity/AwsCredentialIdentity.d.ts
dist-types/ts3.4/identity/Identity.d.ts
dist-types/ts3.4/identity/index.d.ts
dist-types/ts3.4/identity/LoginIdentity.d.ts
dist-types/ts3.4/identity/TokenIdentity.d.ts
dist-types/ts3.4/request.d.ts
dist-types/ts3.4/retry.d.ts
dist-types/ts3.4/uri.d.ts
dist-types/uri.d.ts

9

dist-cjs/index.js

@@ -5,9 +5,15 @@ "use strict";

tslib_1.__exportStar(require("./abort"), exports);
tslib_1.__exportStar(require("./auth"), exports);
tslib_1.__exportStar(require("./checksum"), exports);
tslib_1.__exportStar(require("./client"), exports);
tslib_1.__exportStar(require("./command"), exports);
tslib_1.__exportStar(require("./connection"), exports);
tslib_1.__exportStar(require("./credentials"), exports);
tslib_1.__exportStar(require("./crypto"), exports);
tslib_1.__exportStar(require("./dns"), exports);
tslib_1.__exportStar(require("./encode"), 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);

@@ -17,3 +23,5 @@ tslib_1.__exportStar(require("./middleware"), exports);

tslib_1.__exportStar(require("./profile"), exports);
tslib_1.__exportStar(require("./request"), exports);
tslib_1.__exportStar(require("./response"), exports);
tslib_1.__exportStar(require("./retry"), exports);
tslib_1.__exportStar(require("./serde"), exports);

@@ -25,3 +33,4 @@ tslib_1.__exportStar(require("./shapes"), exports);

tslib_1.__exportStar(require("./transfer"), exports);
tslib_1.__exportStar(require("./uri"), exports);
tslib_1.__exportStar(require("./util"), exports);
tslib_1.__exportStar(require("./waiter"), exports);

7

dist-cjs/transfer.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RequestHandlerProtocol = void 0;
var RequestHandlerProtocol;
(function (RequestHandlerProtocol) {
RequestHandlerProtocol["HTTP_0_9"] = "http/0.9";
RequestHandlerProtocol["HTTP_1_0"] = "http/1.0";
RequestHandlerProtocol["TDS_8_0"] = "tds/8.0";
})(RequestHandlerProtocol = exports.RequestHandlerProtocol || (exports.RequestHandlerProtocol = {}));

9

dist-es/index.js
export * from "./abort";
export * from "./auth";
export * from "./checksum";
export * from "./client";
export * from "./command";
export * from "./connection";
export * from "./credentials";
export * from "./crypto";
export * from "./dns";
export * from "./encode";
export * from "./endpoint";
export * from "./eventStream";
export * from "./http";
export * from "./identity";
export * from "./logger";

@@ -13,3 +19,5 @@ export * from "./middleware";

export * from "./profile";
export * from "./request";
export * from "./response";
export * from "./retry";
export * from "./serde";

@@ -21,3 +29,4 @@ export * from "./shapes";

export * from "./transfer";
export * from "./uri";
export * from "./util";
export * from "./waiter";

7

dist-es/transfer.js

@@ -1,1 +0,6 @@

export {};
export var RequestHandlerProtocol;
(function (RequestHandlerProtocol) {
RequestHandlerProtocol["HTTP_0_9"] = "http/0.9";
RequestHandlerProtocol["HTTP_1_0"] = "http/1.0";
RequestHandlerProtocol["TDS_8_0"] = "tds/8.0";
})(RequestHandlerProtocol || (RequestHandlerProtocol = {}));

11

dist-types/abort.d.ts

@@ -0,1 +1,4 @@

/**
* @public
*/
export interface AbortHandler {

@@ -5,2 +8,4 @@ (this: AbortSignal, ev: any): any;

/**
* @public
*
* Holders of an AbortSignal object may query if the associated operation has

@@ -20,5 +25,7 @@ * been aborted and register an onabort handler.

*/
onabort: AbortHandler | null;
onabort: AbortHandler | Function | null;
}
/**
* @public
*
* The AWS SDK uses a Controller/Signal model to allow for cooperative

@@ -36,3 +43,3 @@ * cancellation of asynchronous operations. When initiating such an operation,

* An object that reports whether the action associated with this
* {AbortController} has been cancelled.
* `AbortController` has been cancelled.
*/

@@ -39,0 +46,0 @@ readonly signal: AbortSignal;

2

dist-types/client.d.ts

@@ -5,2 +5,4 @@ import { Command } from "./command";

/**
* @public
*
* function definition for different overrides of client's 'send' function.

@@ -7,0 +9,0 @@ */

3

dist-types/command.d.ts
import { Handler, MiddlewareStack } from "./middleware";
import { MetadataBearer } from "./response";
/**
* @public
*/
export interface Command<ClientInput extends object, InputType extends ClientInput, ClientOutput extends MetadataBearer, OutputType extends ClientOutput, ResolvedConfiguration> {

@@ -4,0 +7,0 @@ readonly input: InputType;

31

dist-types/credentials.d.ts

@@ -0,24 +1,17 @@

import { AwsCredentialIdentity } from "./identity";
import { Provider } from "./util";
/**
* @public
*
* An object representing temporary or permanent AWS credentials.
*
* @deprecated Use {@link AwsCredentialIdentity}
*/
export interface Credentials {
/**
* 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;
/**
* A {Date} when these credentials will no longer be accepted.
*/
readonly expiration?: Date;
export interface Credentials extends AwsCredentialIdentity {
}
export declare type CredentialProvider = Provider<Credentials>;
/**
* @public
*
* @deprecated Use {@link AwsCredentialIdentityProvider}
*/
export type CredentialProvider = Provider<Credentials>;

17

dist-types/crypto.d.ts

@@ -1,6 +0,13 @@

export declare type SourceData = string | ArrayBuffer | ArrayBufferView;
/**
* @public
*/
export type SourceData = string | ArrayBuffer | ArrayBufferView;
/**
* @public
*
* An object that provides a hash of data provided in chunks to `update`. The
* hash may be performed incrementally as chunks are received or all at once
* when the hash is finalized, depending on the underlying implementation.
*
* @deprecated use {@link Checksum}
*/

@@ -24,5 +31,9 @@ export interface Hash {

/**
* @public
*
* A constructor for a hash that may be used to calculate an HMAC. Implementing
* classes should not directly hold the provided key in memory beyond the
* lexical scope of the constructor.
*
* @deprecated use {@link ChecksumConstructor}
*/

@@ -33,2 +44,4 @@ export interface HashConstructor {

/**
* @public
*
* A function that calculates the hash of a data stream. Determining the hash

@@ -42,2 +55,4 @@ * will consume the stream, so only replayable streams should be provided to an

/**
* @public
*
* A function that returns a promise fulfilled with bytes from a

@@ -44,0 +59,0 @@ * cryptographically secure pseudorandom number generator.

31

dist-types/endpoint.d.ts

@@ -0,1 +1,5 @@

import { AuthScheme } from "./auth";
/**
* @public
*/
export interface EndpointPartition {

@@ -8,2 +12,5 @@ name: string;

}
/**
* @public
*/
export interface EndpointARN {

@@ -16,2 +23,5 @@ partition: string;

}
/**
* @public
*/
export declare enum EndpointURLScheme {

@@ -21,2 +31,5 @@ HTTP = "http",

}
/**
* @public
*/
export interface EndpointURL {

@@ -46,9 +59,23 @@ /**

}
export declare type EndpointObjectProperty = string | boolean | {
/**
* @public
*/
export type EndpointObjectProperty = string | boolean | {
[key: string]: EndpointObjectProperty;
} | EndpointObjectProperty[];
/**
* @public
*/
export interface EndpointV2 {
url: URL;
properties?: Record<string, EndpointObjectProperty>;
properties?: {
authSchemes?: AuthScheme[];
} & Record<string, EndpointObjectProperty>;
headers?: Record<string, string[]>;
}
/**
* @public
*/
export type EndpointParameters = {
[name: string]: undefined | string | boolean;
};

88

dist-types/eventStream.d.ts

@@ -5,2 +5,4 @@ import { HttpRequest } from "./http";

/**
* @public
*
* An event stream message. The headers and body properties will always be

@@ -14,40 +16,26 @@ * defined, with empty headers represented as an object with no keys and an

}
export declare type MessageHeaders = Record<string, MessageHeaderValue>;
export interface BooleanHeaderValue {
type: "boolean";
value: boolean;
}
export interface ByteHeaderValue {
type: "byte";
value: number;
}
export interface ShortHeaderValue {
type: "short";
value: number;
}
export interface IntegerHeaderValue {
type: "integer";
value: number;
}
export interface LongHeaderValue {
type: "long";
value: Int64;
}
export interface BinaryHeaderValue {
type: "binary";
value: Uint8Array;
}
export interface StringHeaderValue {
type: "string";
value: string;
}
export interface TimestampHeaderValue {
type: "timestamp";
value: Date;
}
export interface UuidHeaderValue {
type: "uuid";
value: string;
}
export declare type MessageHeaderValue = BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue;
/**
* @public
*/
export type MessageHeaders = Record<string, MessageHeaderValue>;
type HeaderValue<K extends string, V> = {
type: K;
value: V;
};
export type BooleanHeaderValue = HeaderValue<"boolean", boolean>;
export type ByteHeaderValue = HeaderValue<"byte", number>;
export type ShortHeaderValue = HeaderValue<"short", number>;
export type IntegerHeaderValue = HeaderValue<"integer", number>;
export type LongHeaderValue = HeaderValue<"long", Int64>;
export type BinaryHeaderValue = HeaderValue<"binary", Uint8Array>;
export type StringHeaderValue = HeaderValue<"string", string>;
export type TimestampHeaderValue = HeaderValue<"timestamp", Date>;
export type UuidHeaderValue = HeaderValue<"uuid", string>;
/**
* @public
*/
export type MessageHeaderValue = BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue;
/**
* @public
*/
export interface Int64 {

@@ -59,2 +47,4 @@ readonly bytes: Uint8Array;

/**
* @public
*
* Util functions for serializing or deserializing event stream

@@ -66,2 +56,4 @@ */

/**
* @public
*
* A function which deserializes binary event stream message into modeled shape.

@@ -73,2 +65,4 @@ */

/**
* @public
*
* A function that serializes modeled shape into binary stream message.

@@ -80,2 +74,4 @@ */

/**
* @public
*
* An interface which provides functions for serializing and deserializing binary event stream

@@ -88,16 +84,32 @@ * to/from corresponsing modeled shape.

}
/**
* @public
*/
export interface EventStreamRequestSigner {
sign(request: HttpRequest): Promise<HttpRequest>;
}
/**
* @public
*/
export interface EventStreamPayloadHandler {
handle: <Input extends object, Output extends MetadataBearer>(next: FinalizeHandler<Input, Output>, args: FinalizeHandlerArguments<Input>, context?: HandlerExecutionContext) => Promise<FinalizeHandlerOutput<Output>>;
}
/**
* @public
*/
export interface EventStreamPayloadHandlerProvider {
(options: any): EventStreamPayloadHandler;
}
/**
* @public
*/
export interface EventStreamSerdeProvider {
(options: any): EventStreamMarshaller;
}
/**
* @public
*/
export interface EventStreamSignerProvider {
(options: any): EventStreamRequestSigner;
}
export {};

42

dist-types/http.d.ts
import { AbortSignal } from "./abort";
import { URI } from "./uri";
/**
* @public
*
* A collection of key/value pairs with case-insensitive keys.

@@ -10,4 +13,4 @@ */

*
* @param headerName The name of the header to add or overwrite
* @param headerValue The value to which the header should be set
* @param headerName - The name of the header to add or overwrite
* @param headerValue - The value to which the header should be set
*/

@@ -19,3 +22,3 @@ withHeader(headerName: string, headerValue: string): Headers;

*
* @param headerName The name of the header to remove
* @param headerName - The name of the header to remove
*/

@@ -25,2 +28,4 @@ withoutHeader(headerName: string): Headers;

/**
* @public
*
* A mapping of header names to string values. Multiple values for the same

@@ -34,2 +39,3 @@ * header should be represented as a single string with values separated by

*
* ```json
* {

@@ -39,2 +45,3 @@ * 'x-amz-date': '2000-01-01T00:00:00Z',

* }
* ```
*

@@ -45,4 +52,6 @@ * The SDK may at any point during processing remove one of the object

*/
export declare type HeaderBag = Record<string, string>;
export type HeaderBag = Record<string, string>;
/**
* @public
*
* Represents an HTTP message with headers and an optional static or streaming

@@ -56,2 +65,4 @@ * body. bode: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;

/**
* @public
*
* A mapping of query parameter names to strings or arrays of strings, with the

@@ -61,3 +72,8 @@ * second being used when a parameter contains a list of values. Value can be set

*/
export declare type QueryParameterBag = Record<string, string | Array<string> | null>;
export type QueryParameterBag = Record<string, string | Array<string> | null>;
/**
* @public
*
* @deprecated use {@link EndpointV2} from `@aws-sdk/types`.
*/
export interface Endpoint {

@@ -71,9 +87,13 @@ protocol: string;

/**
* @public
*
* Interface an HTTP request class. Contains
* addressing information in addition to standard message properties.
*/
export interface HttpRequest extends HttpMessage, Endpoint {
export interface HttpRequest extends HttpMessage, URI {
method: string;
}
/**
* @public
*
* Represents an HTTP message as received in reply to a request. Contains a

@@ -84,4 +104,7 @@ * numeric status code in addition to standard message properties.

statusCode: number;
reason?: string;
}
/**
* @public
*
* Represents HTTP message whose body has been resolved to a string. This is

@@ -94,2 +117,4 @@ * used in parsing http message.

/**
* @public
*
* Represents the options that may be passed to an Http Handler.

@@ -99,2 +124,7 @@ */

abortSignal?: AbortSignal;
/**
* The maximum time in milliseconds that the connection phase of a request
* may take before the connection attempt is abandoned.
*/
requestTimeout?: number;
}

9

dist-types/index.d.ts
export * from "./abort";
export * from "./auth";
export * from "./checksum";
export * from "./client";
export * from "./command";
export * from "./connection";
export * from "./credentials";
export * from "./crypto";
export * from "./dns";
export * from "./encode";
export * from "./endpoint";
export * from "./eventStream";
export * from "./http";
export * from "./identity";
export * from "./logger";

@@ -13,3 +19,5 @@ export * from "./middleware";

export * from "./profile";
export * from "./request";
export * from "./response";
export * from "./retry";
export * from "./serde";

@@ -21,3 +29,4 @@ export * from "./shapes";

export * from "./transfer";
export * from "./uri";
export * from "./util";
export * from "./waiter";

19

dist-types/logger.d.ts
/**
* @public
*
* A list of logger's log level. These levels are sorted in

@@ -6,7 +8,9 @@ * order of increasing severity. Each log level includes itself and all

*
* @example new Logger({logLevel: 'warn'}) will print all the warn and error
* @example `new Logger({logLevel: 'warn'})` will print all the warn and error
* message.
*/
export declare type LogLevel = "all" | "log" | "info" | "warn" | "error" | "off";
export type LogLevel = "all" | "trace" | "debug" | "log" | "info" | "warn" | "error" | "off";
/**
* @public
*
* An object consumed by Logger constructor to initiate a logger object.

@@ -19,2 +23,4 @@ */

/**
* @public
*
* Represents a logger object that is available in HandlerExecutionContext

@@ -24,6 +30,7 @@ * throughout the middleware stack.

export interface Logger {
debug(...content: any[]): void;
info(...content: any[]): void;
warn(...content: any[]): void;
error(...content: any[]): void;
trace?: (...content: any[]) => void;
debug: (...content: any[]) => void;
info: (...content: any[]) => void;
warn: (...content: any[]) => void;
error: (...content: any[]) => void;
}

177

dist-types/middleware.d.ts

@@ -0,3 +1,8 @@

import { AuthScheme, HttpAuthDefinition } from "./auth";
import { EndpointV2 } from "./endpoint";
import { Logger } from "./logger";
import { UserAgent } from "./util";
/**
* @public
*/
export interface InitializeHandlerArguments<Input extends object> {

@@ -10,5 +15,11 @@ /**

}
/**
* @public
*/
export interface InitializeHandlerOutput<Output extends object> extends DeserializeHandlerOutput<Output> {
output: Output;
}
/**
* @public
*/
export interface SerializeHandlerArguments<Input extends object> extends InitializeHandlerArguments<Input> {

@@ -25,8 +36,20 @@ /**

}
/**
* @public
*/
export interface SerializeHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
}
/**
* @public
*/
export interface BuildHandlerArguments<Input extends object> extends FinalizeHandlerArguments<Input> {
}
/**
* @public
*/
export interface BuildHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
}
/**
* @public
*/
export interface FinalizeHandlerArguments<Input extends object> extends SerializeHandlerArguments<Input> {

@@ -38,6 +61,15 @@ /**

}
/**
* @public
*/
export interface FinalizeHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
}
/**
* @public
*/
export interface DeserializeHandlerArguments<Input extends object> extends FinalizeHandlerArguments<Input> {
}
/**
* @public
*/
export interface DeserializeHandlerOutput<Output extends object> {

@@ -55,2 +87,5 @@ /**

}
/**
* @public
*/
export interface InitializeHandler<Input extends object, Output extends object> {

@@ -60,3 +95,3 @@ /**

*
* @param args An object containing a input to the command as well as any
* @param args - An object containing a input to the command as well as any
* associated or previously generated execution artifacts.

@@ -66,3 +101,9 @@ */

}
export declare type Handler<Input extends object, Output extends object> = InitializeHandler<Input, Output>;
/**
* @public
*/
export type Handler<Input extends object, Output extends object> = InitializeHandler<Input, Output>;
/**
* @public
*/
export interface SerializeHandler<Input extends object, Output extends object> {

@@ -72,3 +113,3 @@ /**

*
* @param args An object containing a input to the command as well as any
* @param args - An object containing a input to the command as well as any
* associated or previously generated execution artifacts.

@@ -78,2 +119,5 @@ */

}
/**
* @public
*/
export interface FinalizeHandler<Input extends object, Output extends object> {

@@ -83,3 +127,3 @@ /**

*
* @param args An object containing a input to the command as well as any
* @param args - An object containing a input to the command as well as any
* associated or previously generated execution artifacts.

@@ -89,5 +133,11 @@ */

}
/**
* @public
*/
export interface BuildHandler<Input extends object, Output extends object> {
(args: BuildHandlerArguments<Input>): Promise<BuildHandlerOutput<Output>>;
}
/**
* @public
*/
export interface DeserializeHandler<Input extends object, Output extends object> {

@@ -97,3 +147,5 @@ (args: DeserializeHandlerArguments<Input>): Promise<DeserializeHandlerOutput<Output>>;

/**
* A factory function that creates functions implementing the {Handler}
* @public
*
* A factory function that creates functions implementing the `Handler`
* interface.

@@ -103,6 +155,6 @@ */

/**
* @param next The handler to invoke after this middleware has operated on
* @param next - The handler to invoke after this middleware has operated on
* the user input and before this middleware operates on the output.
*
* @param context Invariant data and functions for use by the handler.
* @param context - Invariant data and functions for use by the handler.
*/

@@ -112,3 +164,5 @@ (next: InitializeHandler<Input, Output>, context: HandlerExecutionContext): InitializeHandler<Input, Output>;

/**
* A factory function that creates functions implementing the {BuildHandler}
* @public
*
* A factory function that creates functions implementing the `BuildHandler`
* interface.

@@ -118,6 +172,6 @@ */

/**
* @param next The handler to invoke after this middleware has operated on
* @param next - The handler to invoke after this middleware has operated on
* the user input and before this middleware operates on the output.
*
* @param context Invariant data and functions for use by the handler.
* @param context - Invariant data and functions for use by the handler.
*/

@@ -127,3 +181,5 @@ (next: SerializeHandler<Input, Output>, context: HandlerExecutionContext): SerializeHandler<Input, Output>;

/**
* A factory function that creates functions implementing the {FinalizeHandler}
* @public
*
* A factory function that creates functions implementing the `FinalizeHandler`
* interface.

@@ -133,17 +189,28 @@ */

/**
* @param next The handler to invoke after this middleware has operated on
* @param next - The handler to invoke after this middleware has operated on
* the user input and before this middleware operates on the output.
*
* @param context Invariant data and functions for use by the handler.
* @param context - Invariant data and functions for use by the handler.
*/
(next: FinalizeHandler<Input, Output>, context: HandlerExecutionContext): FinalizeHandler<Input, Output>;
}
/**
* @public
*/
export interface BuildMiddleware<Input extends object, Output extends object> {
(next: BuildHandler<Input, Output>, context: HandlerExecutionContext): BuildHandler<Input, Output>;
}
/**
* @public
*/
export interface DeserializeMiddleware<Input extends object, Output extends object> {
(next: DeserializeHandler<Input, Output>, context: HandlerExecutionContext): DeserializeHandler<Input, Output>;
}
export declare type MiddlewareType<Input extends object, Output extends object> = InitializeMiddleware<Input, Output> | SerializeMiddleware<Input, Output> | BuildMiddleware<Input, Output> | FinalizeRequestMiddleware<Input, Output> | DeserializeMiddleware<Input, Output>;
/**
* @public
*/
export type MiddlewareType<Input extends object, Output extends object> = InitializeMiddleware<Input, Output> | SerializeMiddleware<Input, Output> | BuildMiddleware<Input, Output> | FinalizeRequestMiddleware<Input, Output> | DeserializeMiddleware<Input, Output>;
/**
* @public
*
* A factory function that creates the terminal handler atop which a middleware

@@ -155,4 +222,13 @@ * stack sits.

}
export declare type Step = "initialize" | "serialize" | "build" | "finalizeRequest" | "deserialize";
export declare type Priority = "high" | "normal" | "low";
/**
* @public
*/
export type Step = "initialize" | "serialize" | "build" | "finalizeRequest" | "deserialize";
/**
* @public
*/
export type Priority = "high" | "normal" | "low";
/**
* @public
*/
export interface HandlerOptions {

@@ -186,3 +262,3 @@ /**

*
* @default 'initialize'
* @defaultValue 'initialize'
*/

@@ -206,2 +282,5 @@ step?: Step;

}
/**
* @public
*/
export interface AbsoluteLocation {

@@ -212,7 +291,13 @@ /**

*
* @default 'normal'
* @defaultValue 'normal'
*/
priority?: Priority;
}
export declare type Relation = "before" | "after";
/**
* @public
*/
export type Relation = "before" | "after";
/**
* @public
*/
export interface RelativeLocation {

@@ -228,15 +313,33 @@ /**

}
export declare type RelativeMiddlewareOptions = RelativeLocation & Omit<HandlerOptions, "step">;
/**
* @public
*/
export type RelativeMiddlewareOptions = RelativeLocation & Omit<HandlerOptions, "step">;
/**
* @public
*/
export interface InitializeHandlerOptions extends HandlerOptions {
step?: "initialize";
}
/**
* @public
*/
export interface SerializeHandlerOptions extends HandlerOptions {
step: "serialize";
}
/**
* @public
*/
export interface BuildHandlerOptions extends HandlerOptions {
step: "build";
}
/**
* @public
*/
export interface FinalizeRequestHandlerOptions extends HandlerOptions {
step: "finalizeRequest";
}
/**
* @public
*/
export interface DeserializeHandlerOptions extends HandlerOptions {

@@ -246,2 +349,4 @@ step: "deserialize";

/**
* @public
*
* A stack storing middleware. It can be resolved into a handler. It supports 2

@@ -324,2 +429,8 @@ * approaches for adding middleware:

/**
* Returns a list of the current order of middleware in the stack.
* This does not execute the middleware functions, nor does it
* provide a reference to the stack itself.
*/
identify(): string[];
/**
* Builds a single handler function from zero or more middleware classes and

@@ -337,2 +448,4 @@ * a core handler. The core handler is meant to send command objects to AWS

/**
* @public
*
* Data and helper objects that are not expected to change from one execution of

@@ -353,4 +466,28 @@ * a composed handler to another.

userAgent?: UserAgent;
/**
* Resolved by the endpointMiddleware function of `@aws-sdk/middleware-endpoint`
* in the serialization stage.
*/
endpointV2?: EndpointV2;
/**
* Set at the same time as endpointV2.
*/
authSchemes?: AuthScheme[];
/**
* The current auth configuration that has been set by any auth middleware and
* that will prevent from being set more than once.
*/
currentAuthConfig?: HttpAuthDefinition;
/**
* Used by DynamoDbDocumentClient.
*/
dynamoDbDocumentClientOptions?: Partial<{
overrideInputFilterSensitiveLog(...args: any[]): string | void;
overrideOutputFilterSensitiveLog(...args: any[]): string | void;
}>;
[key: string]: any;
}
/**
* @public
*/
export interface Pluggable<Input extends object, Output extends object> {

@@ -357,0 +494,0 @@ /**

6

dist-types/pagination.d.ts
import { Client } from "./client";
/**
* @public
*
* Expected type definition of a paginator.
*/
export declare type Paginator<T> = AsyncGenerator<T, T, unknown>;
export type Paginator<T> = AsyncGenerator<T, T, unknown>;
/**
* @public
*
* Expected paginator configuration passed to an operation. Services will extend

@@ -8,0 +12,0 @@ * this interface definition and may type client further.

17

dist-types/profile.d.ts

@@ -1,8 +0,19 @@

export declare type IniSection = Record<string, string | undefined>;
/**
* @deprecated: Please use IniSection
* @public
*/
export type IniSection = Record<string, string | undefined>;
/**
* @public
*
* @deprecated Please use {@link IniSection}
*/
export interface Profile extends IniSection {
}
export declare type ParsedIniData = Record<string, IniSection>;
/**
* @public
*/
export type ParsedIniData = Record<string, IniSection>;
/**
* @public
*/
export interface SharedConfigFiles {

@@ -9,0 +20,0 @@ credentialsFile: ParsedIniData;

12

dist-types/response.d.ts

@@ -0,1 +1,4 @@

/**
* @internal
*/
export interface ResponseMetadata {

@@ -29,2 +32,5 @@ /**

}
/**
* @public
*/
export interface MetadataBearer {

@@ -36,1 +42,7 @@ /**

}
/**
* @internal
*/
export interface Response {
body: any;
}

74

dist-types/serde.d.ts

@@ -5,2 +5,4 @@ import { Endpoint } from "./http";

/**
* @public
*
* Interface for object requires an Endpoint set.

@@ -11,2 +13,5 @@ */

}
/**
* @public
*/
export interface StreamCollector {

@@ -16,3 +21,3 @@ /**

*
* @param stream The low-level native stream from browser or Nodejs runtime
* @param stream - The low-level native stream from browser or Nodejs runtime
*/

@@ -22,2 +27,4 @@ (stream: any): Promise<Uint8Array>;

/**
* @public
*
* Request and Response serde util functions and settings for AWS services

@@ -34,2 +41,5 @@ */

}
/**
* @public
*/
export interface RequestSerializer<Request, Context extends EndpointBearer = any> {

@@ -39,8 +49,11 @@ /**

*
* @param input The user input to serialize.
* @param input - The user input to serialize.
*
* @param context Context containing runtime-specific util functions.
* @param context - Context containing runtime-specific util functions.
*/
(input: any, context: Context): Promise<Request>;
}
/**
* @public
*/
export interface ResponseDeserializer<OutputType, ResponseType = any, Context = any> {

@@ -50,5 +63,5 @@ /**

*
* @param output The HTTP response received from the service
* @param output - The HTTP response received from the service
*
* @param context context containing runtime-specific util functions.
* @param context - context containing runtime-specific util functions.
*/

@@ -58,13 +71,23 @@ (output: ResponseType, context: Context): Promise<OutputType>;

/**
* Declare ReadableStream in case dom.d.ts is not added to the tsconfig lib causing
* ReadableStream interface is not defined. For developers with dom.d.ts added,
* the ReadableStream interface will be merged correctly.
* @public
*
* This is also required for any clients with streaming interface where ReadableStream
* type is also referred. The type is only declared here once since this @trivikr-test/types
* is depended by all @trivikr-test packages.
* Declare DOM interfaces in case dom.d.ts is not added to the tsconfig lib, causing
* interfaces to not be defined. For developers with dom.d.ts added, the interfaces will
* be merged correctly.
*
* This is also required for any clients with streaming interfaces where the corresponding
* types are also referred. The type is only declared here once since this `@aws-sdk/types`
* is depended by all `@aws-sdk` packages.
*/
declare global {
/**
* @public
*/
export interface ReadableStream {
}
/**
* @public
*/
export interface Blob {
}
}

@@ -82,5 +105,32 @@ /**

/**
* @public
*
* The type describing a runtime-specific stream implementation with mix-in
* utility functions.
*/
export declare type SdkStream<BaseStream> = BaseStream & SdkStreamMixin;
export type SdkStream<BaseStream> = BaseStream & SdkStreamMixin;
/**
* @public
*
* Indicates that the member of type T with
* key StreamKey have been extended
* with the SdkStreamMixin helper methods.
*/
export type WithSdkStreamMixin<T, StreamKey extends keyof T> = {
[key in keyof T]: key extends StreamKey ? SdkStream<T[StreamKey]> : T[key];
};
/**
* Interface for internal function to inject stream utility functions
* implementation
*
* @internal
*/
export interface SdkStreamMixinInjector {
(stream: unknown): SdkStreamMixin;
}
/**
* @internal
*/
export interface SdkStreamSerdeContext {
sdkStreamMixin: SdkStreamMixinInjector;
}

26

dist-types/shapes.d.ts
import { HttpResponse } from "./http";
import { MetadataBearer } from "./response";
/**
* @public
*
* A document type represents an untyped JSON-like value.

@@ -11,8 +13,10 @@ *

*/
export declare type DocumentType = null | boolean | number | string | DocumentType[] | {
export type DocumentType = null | boolean | number | string | DocumentType[] | {
[prop: string]: DocumentType;
};
/**
* @public
*
* 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
*/

@@ -26,2 +30,4 @@ export interface RetryableTrait {

/**
* @public
*
* Type that is implemented by all Smithy shapes marked with the

@@ -54,4 +60,16 @@ * error trait.

/**
* @deprecated
* @public
*
* @deprecated See {@link https://aws.amazon.com/blogs/developer/service-error-handling-modular-aws-sdk-js/}
*
* This type should not be used in your application.
* Users of the AWS SDK for JavaScript v3 service clients should prefer to
* use the specific Exception classes corresponding to each operation.
* These can be found as code in the deserializer for the operation's Command class,
* or as declarations in the service model file in codegen/sdk-codegen/aws-models.
*
* If no exceptions are enumerated by a particular Command operation,
* the base exception for the service should be used. Each client exports
* a base ServiceException prefixed with the service name.
*/
export declare type SdkError = Error & Partial<SmithyException> & Partial<MetadataBearer>;
export type SdkError = Error & Partial<SmithyException> & Partial<MetadataBearer>;

60

dist-types/signature.d.ts

@@ -0,7 +1,13 @@

import { Message } from "./eventStream";
import { HttpRequest } from "./http";
/**
* A {Date} object, a unix (epoch) timestamp in seconds, or a string that can be
* understood by the JavaScript {Date} constructor.
* @public
*
* A `Date` object, a unix (epoch) timestamp in seconds, or a string that can be
* understood by the JavaScript `Date` constructor.
*/
export declare type DateInput = number | string | Date;
export type DateInput = number | string | Date;
/**
* @public
*/
export interface SigningArguments {

@@ -26,2 +32,5 @@ /**

}
/**
* @public
*/
export interface RequestSigningArguments extends SigningArguments {

@@ -44,2 +53,5 @@ /**

}
/**
* @public
*/
export interface RequestPresigningArguments extends RequestSigningArguments {

@@ -61,5 +73,11 @@ /**

}
/**
* @public
*/
export interface EventSigningArguments extends SigningArguments {
priorSignature: string;
}
/**
* @public
*/
export interface RequestPresigner {

@@ -72,4 +90,4 @@ /**

*
* @param requestToSign The request that should be signed.
* @param options Additional signing options.
* @param requestToSign - The request that should be signed.
* @param options - Additional signing options.
*/

@@ -79,2 +97,4 @@ presign(requestToSign: HttpRequest, options?: RequestPresigningArguments): Promise<HttpRequest>;

/**
* @public
*
* An object that signs request objects with AWS credentials using one of the

@@ -89,2 +109,5 @@ * AWS authentication protocols.

}
/**
* @public
*/
export interface StringSigner {

@@ -97,2 +120,5 @@ /**

}
/**
* @public
*/
export interface FormattedEvent {

@@ -102,2 +128,5 @@ headers: Uint8Array;

}
/**
* @public
*/
export interface EventSigner {

@@ -109,1 +138,22 @@ /**

}
/**
* @public
*/
export interface SignableMessage {
message: Message;
priorSignature: string;
}
/**
* @public
*/
export interface SignedMessage {
message: Message;
signature: string;
}
/**
* @public
*/
export interface MessageSigner {
signMessage(message: SignableMessage, args: SigningArguments): Promise<SignedMessage>;
sign(event: SignableMessage, options: SigningArguments): Promise<SignedMessage>;
}

8

dist-types/stream.d.ts

@@ -0,7 +1,11 @@

import { ChecksumConstructor } from "./checksum";
import { HashConstructor, StreamHasher } from "./crypto";
import { BodyLengthCalculator, Encoder } from "./util";
/**
* @public
*/
export interface GetAwsChunkedEncodingStreamOptions {
base64Encoder?: Encoder;
bodyLengthChecker: BodyLengthCalculator;
checksumAlgorithmFn?: HashConstructor;
checksumAlgorithmFn?: ChecksumConstructor | HashConstructor;
checksumLocationName?: string;

@@ -11,2 +15,4 @@ streamHasher?: StreamHasher;

/**
* @public
*
* A function that returns Readable Stream which follows aws-chunked encoding stream.

@@ -13,0 +19,0 @@ * It optionally adds checksum if options are provided.

23

dist-types/token.d.ts

@@ -0,16 +1,17 @@

import { TokenIdentity } from "./identity";
import { Provider } from "./util";
/**
* @public
*
* An object representing temporary or permanent AWS token.
*
* @deprecated Use {@link 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 {
}
export declare type TokenProvider = Provider<Token>;
/**
* @public
*
* @deprecated Use {@link TokenIdentityProvider}
*/
export type TokenProvider = Provider<Token>;

21

dist-types/transfer.d.ts

@@ -1,4 +0,10 @@

export declare type RequestHandlerOutput<ResponseType> = {
/**
* @public
*/
export type RequestHandlerOutput<ResponseType> = {
response: ResponseType;
};
/**
* @public
*/
export interface RequestHandler<RequestType, ResponseType, HandlerOptions = {}> {

@@ -14,4 +20,15 @@ /**

}
/**
* @public
*/
export interface RequestHandlerMetadata {
handlerProtocol: string;
handlerProtocol: RequestHandlerProtocol | string;
}
export declare enum RequestHandlerProtocol {
HTTP_0_9 = "http/0.9",
HTTP_1_0 = "http/1.0",
TDS_8_0 = "tds/8.0"
}
export interface RequestContext {
destination: URL;
}

52

dist-types/ts3.4/abort.d.ts

@@ -0,15 +1,49 @@

/**
* @public
*/
export interface AbortHandler {
(this: AbortSignal, ev: any): any;
(this: AbortSignal, ev: any): any;
}
/**
* @public
*
* Holders of an AbortSignal object may query if the associated operation has
* been aborted and register an onabort handler.
*
* @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
*/
export interface AbortSignal {
readonly aborted: boolean;
onabort: AbortHandler | null;
/**
* Whether the action represented by this signal has been cancelled.
*/
readonly aborted: boolean;
/**
* A function to be invoked when the action represented by this signal has
* been cancelled.
*/
onabort: AbortHandler | Function | null;
}
/**
* @public
*
* The AWS SDK uses a Controller/Signal model to allow for cooperative
* cancellation of asynchronous operations. When initiating such an operation,
* the caller can create an AbortController and then provide linked signal to
* subtasks. This allows a single source to communicate to multiple consumers
* that an action has been aborted without dictating how that cancellation
* should be handled.
*
* @see https://developer.mozilla.org/en-US/docs/Web/API/AbortController
*/
export interface AbortController {
readonly signal: AbortSignal;
abort(): void;
/**
* An object that reports whether the action associated with this
* `AbortController` has been cancelled.
*/
readonly signal: AbortSignal;
/**
* Declares the operation associated with this AbortController to have been
* cancelled.
*/
abort(): void;
}

67

dist-types/ts3.4/client.d.ts
import { Command } from "./command";
import { MiddlewareStack } from "./middleware";
import { MetadataBearer } from "./response";
interface InvokeFunction<
InputTypes extends object,
OutputTypes extends MetadataBearer,
ResolvedClientConfiguration
> {
<InputType extends InputTypes, OutputType extends OutputTypes>(
command: Command<
InputTypes,
InputType,
OutputTypes,
OutputType,
ResolvedClientConfiguration
>,
options?: any
): Promise<OutputType>;
<InputType extends InputTypes, OutputType extends OutputTypes>(
command: Command<
InputTypes,
InputType,
OutputTypes,
OutputType,
ResolvedClientConfiguration
>,
options: any,
cb: (err: any, data?: OutputType) => void
): void;
<InputType extends InputTypes, OutputType extends OutputTypes>(
command: Command<
InputTypes,
InputType,
OutputTypes,
OutputType,
ResolvedClientConfiguration
>,
options?: any,
cb?: (err: any, data?: OutputType) => void
): Promise<OutputType> | void;
/**
* @public
*
* function definition for different overrides of client's 'send' function.
*/
interface InvokeFunction<InputTypes extends object, OutputTypes extends MetadataBearer, ResolvedClientConfiguration> {
<InputType extends InputTypes, OutputType extends OutputTypes>(command: Command<InputTypes, InputType, OutputTypes, OutputType, ResolvedClientConfiguration>, options?: any): Promise<OutputType>;
<InputType extends InputTypes, OutputType extends OutputTypes>(command: Command<InputTypes, InputType, OutputTypes, OutputType, ResolvedClientConfiguration>, options: any, cb: (err: any, data?: OutputType) => void): void;
<InputType extends InputTypes, OutputType extends OutputTypes>(command: Command<InputTypes, InputType, OutputTypes, OutputType, ResolvedClientConfiguration>, options?: any, cb?: (err: any, data?: OutputType) => void): Promise<OutputType> | void;
}
export interface Client<
Input extends object,
Output extends MetadataBearer,
ResolvedClientConfiguration
> {
readonly config: ResolvedClientConfiguration;
middlewareStack: MiddlewareStack<Input, Output>;
send: InvokeFunction<Input, Output, ResolvedClientConfiguration>;
destroy: () => void;
/**
* A general interface for service clients, idempotent to browser or node clients
* This type corresponds to SmithyClient(https://github.com/aws/aws-sdk-js-v3/blob/main/packages/smithy-client/src/client.ts).
* It's provided for using without importing the SmithyClient class.
*/
export interface Client<Input extends object, Output extends MetadataBearer, ResolvedClientConfiguration> {
readonly config: ResolvedClientConfiguration;
middlewareStack: MiddlewareStack<Input, Output>;
send: InvokeFunction<Input, Output, ResolvedClientConfiguration>;
destroy: () => void;
}
export {};

21

dist-types/ts3.4/command.d.ts
import { Handler, MiddlewareStack } from "./middleware";
import { MetadataBearer } from "./response";
export interface Command<
ClientInput extends object,
InputType extends ClientInput,
ClientOutput extends MetadataBearer,
OutputType extends ClientOutput,
ResolvedConfiguration
> {
readonly input: InputType;
readonly middlewareStack: MiddlewareStack<InputType, OutputType>;
resolveMiddleware(
stack: MiddlewareStack<ClientInput, ClientOutput>,
configuration: ResolvedConfiguration,
options: any
): Handler<InputType, OutputType>;
/**
* @public
*/
export interface Command<ClientInput extends object, InputType extends ClientInput, ClientOutput extends MetadataBearer, OutputType extends ClientOutput, ResolvedConfiguration> {
readonly input: InputType;
readonly middlewareStack: MiddlewareStack<InputType, OutputType>;
resolveMiddleware(stack: MiddlewareStack<ClientInput, ClientOutput>, configuration: ResolvedConfiguration, options: any): Handler<InputType, OutputType>;
}

25

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

@@ -0,12 +1,17 @@

import { AwsCredentialIdentity } from "./identity";
import { Provider } from "./util";
export interface Credentials {
readonly accessKeyId: string;
readonly secretAccessKey: string;
readonly sessionToken?: string;
readonly expiration?: Date;
/**
* @public
*
* An object representing temporary or permanent AWS credentials.
*
* @deprecated Use {@link AwsCredentialIdentity}
*/
export interface Credentials extends AwsCredentialIdentity {
}
export declare type CredentialProvider = Provider<Credentials>;
/**
* @public
*
* @deprecated Use {@link AwsCredentialIdentityProvider}
*/
export type CredentialProvider = Provider<Credentials>;

63

dist-types/ts3.4/crypto.d.ts

@@ -1,19 +0,60 @@

export declare type SourceData = string | ArrayBuffer | ArrayBufferView;
/**
* @public
*/
export type SourceData = string | ArrayBuffer | ArrayBufferView;
/**
* @public
*
* An object that provides a hash of data provided in chunks to `update`. The
* hash may be performed incrementally as chunks are received or all at once
* when the hash is finalized, depending on the underlying implementation.
*
* @deprecated use {@link Checksum}
*/
export interface Hash {
update(toHash: SourceData, encoding?: "utf8" | "ascii" | "latin1"): void;
digest(): Promise<Uint8Array>;
/**
* Adds a chunk of data to the hash. If a buffer is provided, the `encoding`
* argument will be ignored. If a string is provided without a specified
* encoding, implementations must assume UTF-8 encoding.
*
* Not all encodings are supported on all platforms, though all must support
* UTF-8.
*/
update(toHash: SourceData, encoding?: "utf8" | "ascii" | "latin1"): void;
/**
* Finalizes the hash and provides a promise that will be fulfilled with the
* raw bytes of the calculated hash.
*/
digest(): Promise<Uint8Array>;
}
/**
* @public
*
* A constructor for a hash that may be used to calculate an HMAC. Implementing
* classes should not directly hold the provided key in memory beyond the
* lexical scope of the constructor.
*
* @deprecated use {@link ChecksumConstructor}
*/
export interface HashConstructor {
new (secret?: SourceData): Hash;
new (secret?: SourceData): Hash;
}
/**
* @public
*
* A function that calculates the hash of a data stream. Determining the hash
* will consume the stream, so only replayable streams should be provided to an
* implementation of this interface.
*/
export interface StreamHasher<StreamType = any> {
(hashCtor: HashConstructor, stream: StreamType): Promise<Uint8Array>;
(hashCtor: HashConstructor, stream: StreamType): Promise<Uint8Array>;
}
/**
* @public
*
* A function that returns a promise fulfilled with bytes from a
* cryptographically secure pseudorandom number generator.
*/
export interface randomValues {
(byteLength: number): Promise<Uint8Array>;
(byteLength: number): Promise<Uint8Array>;
}

98

dist-types/ts3.4/endpoint.d.ts

@@ -0,41 +1,77 @@

import { AuthScheme } from "./auth";
/**
* @public
*/
export interface EndpointPartition {
name: string;
dnsSuffix: string;
dualStackDnsSuffix: string;
supportsFIPS: boolean;
supportsDualStack: boolean;
name: string;
dnsSuffix: string;
dualStackDnsSuffix: string;
supportsFIPS: boolean;
supportsDualStack: boolean;
}
/**
* @public
*/
export interface EndpointARN {
partition: string;
service: string;
region: string;
accountId: string;
resourceId: Array<string>;
partition: string;
service: string;
region: string;
accountId: string;
resourceId: Array<string>;
}
/**
* @public
*/
export declare enum EndpointURLScheme {
HTTP = "http",
HTTPS = "https",
HTTP = "http",
HTTPS = "https"
}
/**
* @public
*/
export interface EndpointURL {
scheme: EndpointURLScheme;
authority: string;
path: string;
normalizedPath: string;
isIp: boolean;
/**
* The URL scheme such as http or https.
*/
scheme: EndpointURLScheme;
/**
* The authority is the host and optional port component of the URL.
*/
authority: string;
/**
* The parsed path segment of the URL.
* This value is as-is as provided by the user.
*/
path: string;
/**
* The parsed path segment of the URL.
* This value is guranteed to start and end with a "/".
*/
normalizedPath: string;
/**
* A boolean indicating whether the authority is an IP address.
*/
isIp: boolean;
}
export declare type EndpointObjectProperty =
| string
| boolean
| {
[key: string]: EndpointObjectProperty;
}
| EndpointObjectProperty[];
/**
* @public
*/
export type EndpointObjectProperty = string | boolean | {
[key: string]: EndpointObjectProperty;
} | EndpointObjectProperty[];
/**
* @public
*/
export interface EndpointV2 {
url: URL;
properties?: Record<string, EndpointObjectProperty>;
headers?: Record<string, string[]>;
url: URL;
properties?: {
authSchemes?: AuthScheme[];
} & Record<string, EndpointObjectProperty>;
headers?: Record<string, string[]>;
}
/**
* @public
*/
export type EndpointParameters = {
[name: string]: undefined | string | boolean;
};

164

dist-types/ts3.4/eventStream.d.ts
import { HttpRequest } from "./http";
import {
FinalizeHandler,
FinalizeHandlerArguments,
FinalizeHandlerOutput,
HandlerExecutionContext,
} from "./middleware";
import { FinalizeHandler, FinalizeHandlerArguments, FinalizeHandlerOutput, HandlerExecutionContext } from "./middleware";
import { MetadataBearer } from "./response";
/**
* @public
*
* An event stream message. The headers and body properties will always be
* defined, with empty headers represented as an object with no keys and an
* empty body represented as a zero-length Uint8Array.
*/
export interface Message {
headers: MessageHeaders;
body: Uint8Array;
headers: MessageHeaders;
body: Uint8Array;
}
export declare type MessageHeaders = Record<string, MessageHeaderValue>;
export interface BooleanHeaderValue {
type: "boolean";
value: boolean;
}
export interface ByteHeaderValue {
type: "byte";
value: number;
}
export interface ShortHeaderValue {
type: "short";
value: number;
}
export interface IntegerHeaderValue {
type: "integer";
value: number;
}
export interface LongHeaderValue {
type: "long";
value: Int64;
}
export interface BinaryHeaderValue {
type: "binary";
value: Uint8Array;
}
export interface StringHeaderValue {
type: "string";
value: string;
}
export interface TimestampHeaderValue {
type: "timestamp";
value: Date;
}
export interface UuidHeaderValue {
type: "uuid";
value: string;
}
export declare type MessageHeaderValue =
| BooleanHeaderValue
| ByteHeaderValue
| ShortHeaderValue
| IntegerHeaderValue
| LongHeaderValue
| BinaryHeaderValue
| StringHeaderValue
| TimestampHeaderValue
| UuidHeaderValue;
/**
* @public
*/
export type MessageHeaders = Record<string, MessageHeaderValue>;
type HeaderValue<K extends string, V> = {
type: K;
value: V;
};
export type BooleanHeaderValue = HeaderValue<"boolean", boolean>;
export type ByteHeaderValue = HeaderValue<"byte", number>;
export type ShortHeaderValue = HeaderValue<"short", number>;
export type IntegerHeaderValue = HeaderValue<"integer", number>;
export type LongHeaderValue = HeaderValue<"long", Int64>;
export type BinaryHeaderValue = HeaderValue<"binary", Uint8Array>;
export type StringHeaderValue = HeaderValue<"string", string>;
export type TimestampHeaderValue = HeaderValue<"timestamp", Date>;
export type UuidHeaderValue = HeaderValue<"uuid", string>;
/**
* @public
*/
export type MessageHeaderValue = BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue;
/**
* @public
*/
export interface Int64 {
readonly bytes: Uint8Array;
valueOf: () => number;
toString: () => string;
readonly bytes: Uint8Array;
valueOf: () => number;
toString: () => string;
}
/**
* @public
*
* Util functions for serializing or deserializing event stream
*/
export interface EventStreamSerdeContext {
eventStreamMarshaller: EventStreamMarshaller;
eventStreamMarshaller: EventStreamMarshaller;
}
/**
* @public
*
* A function which deserializes binary event stream message into modeled shape.
*/
export interface EventStreamMarshallerDeserFn<StreamType> {
<T>(
body: StreamType,
deserializer: (input: Record<string, Message>) => Promise<T>
): AsyncIterable<T>;
<T>(body: StreamType, deserializer: (input: Record<string, Message>) => Promise<T>): AsyncIterable<T>;
}
/**
* @public
*
* A function that serializes modeled shape into binary stream message.
*/
export interface EventStreamMarshallerSerFn<StreamType> {
<T>(input: AsyncIterable<T>, serializer: (event: T) => Message): StreamType;
<T>(input: AsyncIterable<T>, serializer: (event: T) => Message): StreamType;
}
/**
* @public
*
* An interface which provides functions for serializing and deserializing binary event stream
* to/from corresponsing modeled shape.
*/
export interface EventStreamMarshaller<StreamType = any> {
deserialize: EventStreamMarshallerDeserFn<StreamType>;
serialize: EventStreamMarshallerSerFn<StreamType>;
deserialize: EventStreamMarshallerDeserFn<StreamType>;
serialize: EventStreamMarshallerSerFn<StreamType>;
}
/**
* @public
*/
export interface EventStreamRequestSigner {
sign(request: HttpRequest): Promise<HttpRequest>;
sign(request: HttpRequest): Promise<HttpRequest>;
}
/**
* @public
*/
export interface EventStreamPayloadHandler {
handle: <Input extends object, Output extends MetadataBearer>(
next: FinalizeHandler<Input, Output>,
args: FinalizeHandlerArguments<Input>,
context?: HandlerExecutionContext
) => Promise<FinalizeHandlerOutput<Output>>;
handle: <Input extends object, Output extends MetadataBearer>(next: FinalizeHandler<Input, Output>, args: FinalizeHandlerArguments<Input>, context?: HandlerExecutionContext) => Promise<FinalizeHandlerOutput<Output>>;
}
/**
* @public
*/
export interface EventStreamPayloadHandlerProvider {
(options: any): EventStreamPayloadHandler;
(options: any): EventStreamPayloadHandler;
}
/**
* @public
*/
export interface EventStreamSerdeProvider {
(options: any): EventStreamMarshaller;
(options: any): EventStreamMarshaller;
}
/**
* @public
*/
export interface EventStreamSignerProvider {
(options: any): EventStreamRequestSigner;
(options: any): EventStreamRequestSigner;
}
export {};

132

dist-types/ts3.4/http.d.ts
import { AbortSignal } from "./abort";
import { URI } from "./uri";
/**
* @public
*
* A collection of key/value pairs with case-insensitive keys.
*/
export interface Headers extends Map<string, string> {
withHeader(headerName: string, headerValue: string): Headers;
withoutHeader(headerName: string): Headers;
/**
* Returns a new instance of Headers with the specified header set to the
* provided value. Does not modify the original Headers instance.
*
* @param headerName - The name of the header to add or overwrite
* @param headerValue - The value to which the header should be set
*/
withHeader(headerName: string, headerValue: string): Headers;
/**
* Returns a new instance of Headers without the specified header. Does not
* modify the original Headers instance.
*
* @param headerName - The name of the header to remove
*/
withoutHeader(headerName: string): Headers;
}
export declare type HeaderBag = Record<string, string>;
/**
* @public
*
* A mapping of header names to string values. Multiple values for the same
* header should be represented as a single string with values separated by
* `, `.
*
* Keys should be considered case insensitive, even if this is not enforced by a
* particular implementation. For example, given the following HeaderBag, where
* keys differ only in case:
*
* ```json
* {
* 'x-amz-date': '2000-01-01T00:00:00Z',
* 'X-Amz-Date': '2001-01-01T00:00:00Z'
* }
* ```
*
* The SDK may at any point during processing remove one of the object
* properties in favor of the other. The headers may or may not be combined, and
* the SDK will not deterministically select which header candidate to use.
*/
export type HeaderBag = Record<string, string>;
/**
* @public
*
* Represents an HTTP message with headers and an optional static or streaming
* body. bode: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;
*/
export interface HttpMessage {
headers: HeaderBag;
body?: any;
headers: HeaderBag;
body?: any;
}
export declare type QueryParameterBag = Record<
string,
string | Array<string> | null
>;
/**
* @public
*
* A mapping of query parameter names to strings or arrays of strings, with the
* second being used when a parameter contains a list of values. Value can be set
* to null when query is not in key-value pairs shape
*/
export type QueryParameterBag = Record<string, string | Array<string> | null>;
/**
* @public
*
* @deprecated use {@link EndpointV2} from `@aws-sdk/types`.
*/
export interface Endpoint {
protocol: string;
hostname: string;
port?: number;
path: string;
query?: QueryParameterBag;
protocol: string;
hostname: string;
port?: number;
path: string;
query?: QueryParameterBag;
}
export interface HttpRequest extends HttpMessage, Endpoint {
method: string;
/**
* @public
*
* Interface an HTTP request class. Contains
* addressing information in addition to standard message properties.
*/
export interface HttpRequest extends HttpMessage, URI {
method: string;
}
/**
* @public
*
* Represents an HTTP message as received in reply to a request. Contains a
* numeric status code in addition to standard message properties.
*/
export interface HttpResponse extends HttpMessage {
statusCode: number;
statusCode: number;
reason?: string;
}
/**
* @public
*
* Represents HTTP message whose body has been resolved to a string. This is
* used in parsing http message.
*/
export interface ResolvedHttpResponse extends HttpResponse {
body: string;
body: string;
}
/**
* @public
*
* Represents the options that may be passed to an Http Handler.
*/
export interface HttpHandlerOptions {
abortSignal?: AbortSignal;
abortSignal?: AbortSignal;
/**
* The maximum time in milliseconds that the connection phase of a request
* may take before the connection attempt is abandoned.
*/
requestTimeout?: number;
}

9

dist-types/ts3.4/index.d.ts
export * from "./abort";
export * from "./auth";
export * from "./checksum";
export * from "./client";
export * from "./command";
export * from "./connection";
export * from "./credentials";
export * from "./crypto";
export * from "./dns";
export * from "./encode";
export * from "./endpoint";
export * from "./eventStream";
export * from "./http";
export * from "./identity";
export * from "./logger";

@@ -13,3 +19,5 @@ export * from "./middleware";

export * from "./profile";
export * from "./request";
export * from "./response";
export * from "./retry";
export * from "./serde";

@@ -21,3 +29,4 @@ export * from "./shapes";

export * from "./transfer";
export * from "./uri";
export * from "./util";
export * from "./waiter";

44

dist-types/ts3.4/logger.d.ts

@@ -1,19 +0,33 @@

export declare type LogLevel =
| "all"
| "log"
| "info"
| "warn"
| "error"
| "off";
/**
* @public
*
* A list of logger's log level. These levels are sorted in
* order of increasing severity. Each log level includes itself and all
* the levels behind itself.
*
* @example `new Logger({logLevel: 'warn'})` will print all the warn and error
* message.
*/
export type LogLevel = "all" | "trace" | "debug" | "log" | "info" | "warn" | "error" | "off";
/**
* @public
*
* An object consumed by Logger constructor to initiate a logger object.
*/
export interface LoggerOptions {
logger?: Logger;
logLevel?: LogLevel;
logger?: Logger;
logLevel?: LogLevel;
}
/**
* @public
*
* Represents a logger object that is available in HandlerExecutionContext
* throughout the middleware stack.
*/
export interface Logger {
debug(...content: any[]): void;
info(...content: any[]): void;
warn(...content: any[]): void;
error(...content: any[]): void;
trace?: (...content: any[]) => void;
debug: (...content: any[]) => void;
info: (...content: any[]) => void;
warn: (...content: any[]) => void;
error: (...content: any[]) => void;
}

609

dist-types/ts3.4/middleware.d.ts

@@ -0,226 +1,475 @@

import { AuthScheme, HttpAuthDefinition } from "./auth";
import { EndpointV2 } from "./endpoint";
import { Logger } from "./logger";
import { UserAgent } from "./util";
/**
* @public
*/
export interface InitializeHandlerArguments<Input extends object> {
input: Input;
/**
* User input to a command. Reflects the userland representation of the
* union of data types the command can effectively handle.
*/
input: Input;
}
export interface InitializeHandlerOutput<Output extends object>
extends DeserializeHandlerOutput<Output> {
output: Output;
/**
* @public
*/
export interface InitializeHandlerOutput<Output extends object> extends DeserializeHandlerOutput<Output> {
output: Output;
}
export interface SerializeHandlerArguments<Input extends object>
extends InitializeHandlerArguments<Input> {
request?: unknown;
/**
* @public
*/
export interface SerializeHandlerArguments<Input extends object> extends InitializeHandlerArguments<Input> {
/**
* The user input serialized as a request object. The request object is unknown,
* so you cannot modify it directly. When work with request, you need to guard its
* type to e.g. HttpRequest with 'instanceof' operand
*
* During the build phase of the execution of a middleware stack, a built
* request may or may not be available.
*/
request?: unknown;
}
export interface SerializeHandlerOutput<Output extends object>
extends InitializeHandlerOutput<Output> {}
export interface BuildHandlerArguments<Input extends object>
extends FinalizeHandlerArguments<Input> {}
export interface BuildHandlerOutput<Output extends object>
extends InitializeHandlerOutput<Output> {}
export interface FinalizeHandlerArguments<Input extends object>
extends SerializeHandlerArguments<Input> {
request: unknown;
/**
* @public
*/
export interface SerializeHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
}
export interface FinalizeHandlerOutput<Output extends object>
extends InitializeHandlerOutput<Output> {}
export interface DeserializeHandlerArguments<Input extends object>
extends FinalizeHandlerArguments<Input> {}
/**
* @public
*/
export interface BuildHandlerArguments<Input extends object> extends FinalizeHandlerArguments<Input> {
}
/**
* @public
*/
export interface BuildHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
}
/**
* @public
*/
export interface FinalizeHandlerArguments<Input extends object> extends SerializeHandlerArguments<Input> {
/**
* The user input serialized as a request.
*/
request: unknown;
}
/**
* @public
*/
export interface FinalizeHandlerOutput<Output extends object> extends InitializeHandlerOutput<Output> {
}
/**
* @public
*/
export interface DeserializeHandlerArguments<Input extends object> extends FinalizeHandlerArguments<Input> {
}
/**
* @public
*/
export interface DeserializeHandlerOutput<Output extends object> {
response: unknown;
output?: Output;
/**
* The raw response object from runtime is deserialized to structured output object.
* The response object is unknown so you cannot modify it directly. When work with
* response, you need to guard its type to e.g. HttpResponse with 'instanceof' operand.
*
* During the deserialize phase of the execution of a middleware stack, a deserialized
* response may or may not be available
*/
response: unknown;
output?: Output;
}
export interface InitializeHandler<
Input extends object,
Output extends object
> {
(args: InitializeHandlerArguments<Input>): Promise<
InitializeHandlerOutput<Output>
>;
/**
* @public
*/
export interface InitializeHandler<Input extends object, Output extends object> {
/**
* Asynchronously converts an input object into an output object.
*
* @param args - An object containing a input to the command as well as any
* associated or previously generated execution artifacts.
*/
(args: InitializeHandlerArguments<Input>): Promise<InitializeHandlerOutput<Output>>;
}
export declare type Handler<
Input extends object,
Output extends object
> = InitializeHandler<Input, Output>;
/**
* @public
*/
export type Handler<Input extends object, Output extends object> = InitializeHandler<Input, Output>;
/**
* @public
*/
export interface SerializeHandler<Input extends object, Output extends object> {
(args: SerializeHandlerArguments<Input>): Promise<
SerializeHandlerOutput<Output>
>;
/**
* Asynchronously converts an input object into an output object.
*
* @param args - An object containing a input to the command as well as any
* associated or previously generated execution artifacts.
*/
(args: SerializeHandlerArguments<Input>): Promise<SerializeHandlerOutput<Output>>;
}
/**
* @public
*/
export interface FinalizeHandler<Input extends object, Output extends object> {
(args: FinalizeHandlerArguments<Input>): Promise<
FinalizeHandlerOutput<Output>
>;
/**
* Asynchronously converts an input object into an output object.
*
* @param args - An object containing a input to the command as well as any
* associated or previously generated execution artifacts.
*/
(args: FinalizeHandlerArguments<Input>): Promise<FinalizeHandlerOutput<Output>>;
}
/**
* @public
*/
export interface BuildHandler<Input extends object, Output extends object> {
(args: BuildHandlerArguments<Input>): Promise<BuildHandlerOutput<Output>>;
(args: BuildHandlerArguments<Input>): Promise<BuildHandlerOutput<Output>>;
}
export interface DeserializeHandler<
Input extends object,
Output extends object
> {
(args: DeserializeHandlerArguments<Input>): Promise<
DeserializeHandlerOutput<Output>
>;
/**
* @public
*/
export interface DeserializeHandler<Input extends object, Output extends object> {
(args: DeserializeHandlerArguments<Input>): Promise<DeserializeHandlerOutput<Output>>;
}
export interface InitializeMiddleware<
Input extends object,
Output extends object
> {
(
next: InitializeHandler<Input, Output>,
context: HandlerExecutionContext
): InitializeHandler<Input, Output>;
/**
* @public
*
* A factory function that creates functions implementing the `Handler`
* interface.
*/
export interface InitializeMiddleware<Input extends object, Output extends object> {
/**
* @param next - The handler to invoke after this middleware has operated on
* the user input and before this middleware operates on the output.
*
* @param context - Invariant data and functions for use by the handler.
*/
(next: InitializeHandler<Input, Output>, context: HandlerExecutionContext): InitializeHandler<Input, Output>;
}
export interface SerializeMiddleware<
Input extends object,
Output extends object
> {
(
next: SerializeHandler<Input, Output>,
context: HandlerExecutionContext
): SerializeHandler<Input, Output>;
/**
* @public
*
* A factory function that creates functions implementing the `BuildHandler`
* interface.
*/
export interface SerializeMiddleware<Input extends object, Output extends object> {
/**
* @param next - The handler to invoke after this middleware has operated on
* the user input and before this middleware operates on the output.
*
* @param context - Invariant data and functions for use by the handler.
*/
(next: SerializeHandler<Input, Output>, context: HandlerExecutionContext): SerializeHandler<Input, Output>;
}
export interface FinalizeRequestMiddleware<
Input extends object,
Output extends object
> {
(
next: FinalizeHandler<Input, Output>,
context: HandlerExecutionContext
): FinalizeHandler<Input, Output>;
/**
* @public
*
* A factory function that creates functions implementing the `FinalizeHandler`
* interface.
*/
export interface FinalizeRequestMiddleware<Input extends object, Output extends object> {
/**
* @param next - The handler to invoke after this middleware has operated on
* the user input and before this middleware operates on the output.
*
* @param context - Invariant data and functions for use by the handler.
*/
(next: FinalizeHandler<Input, Output>, context: HandlerExecutionContext): FinalizeHandler<Input, Output>;
}
/**
* @public
*/
export interface BuildMiddleware<Input extends object, Output extends object> {
(
next: BuildHandler<Input, Output>,
context: HandlerExecutionContext
): BuildHandler<Input, Output>;
(next: BuildHandler<Input, Output>, context: HandlerExecutionContext): BuildHandler<Input, Output>;
}
export interface DeserializeMiddleware<
Input extends object,
Output extends object
> {
(
next: DeserializeHandler<Input, Output>,
context: HandlerExecutionContext
): DeserializeHandler<Input, Output>;
/**
* @public
*/
export interface DeserializeMiddleware<Input extends object, Output extends object> {
(next: DeserializeHandler<Input, Output>, context: HandlerExecutionContext): DeserializeHandler<Input, Output>;
}
export declare type MiddlewareType<
Input extends object,
Output extends object
> =
| InitializeMiddleware<Input, Output>
| SerializeMiddleware<Input, Output>
| BuildMiddleware<Input, Output>
| FinalizeRequestMiddleware<Input, Output>
| DeserializeMiddleware<Input, Output>;
/**
* @public
*/
export type MiddlewareType<Input extends object, Output extends object> = InitializeMiddleware<Input, Output> | SerializeMiddleware<Input, Output> | BuildMiddleware<Input, Output> | FinalizeRequestMiddleware<Input, Output> | DeserializeMiddleware<Input, Output>;
/**
* @public
*
* A factory function that creates the terminal handler atop which a middleware
* stack sits.
*/
export interface Terminalware {
<Input extends object, Output extends object>(
context: HandlerExecutionContext
): DeserializeHandler<Input, Output>;
<Input extends object, Output extends object>(context: HandlerExecutionContext): DeserializeHandler<Input, Output>;
}
export declare type Step =
| "initialize"
| "serialize"
| "build"
| "finalizeRequest"
| "deserialize";
export declare type Priority = "high" | "normal" | "low";
/**
* @public
*/
export type Step = "initialize" | "serialize" | "build" | "finalizeRequest" | "deserialize";
/**
* @public
*/
export type Priority = "high" | "normal" | "low";
/**
* @public
*/
export interface HandlerOptions {
step?: Step;
tags?: Array<string>;
name?: string;
override?: boolean;
/**
* Handlers are ordered using a "step" that describes the stage of command
* execution at which the handler will be executed. The available steps are:
*
* - initialize: The input is being prepared. Examples of typical
* initialization tasks include injecting default options computing
* derived parameters.
* - serialize: The input is complete and ready to be serialized. Examples
* of typical serialization tasks include input validation and building
* an HTTP request from user input.
* - build: The input has been serialized into an HTTP request, but that
* request may require further modification. Any request alterations
* will be applied to all retries. Examples of typical build tasks
* include injecting HTTP headers that describe a stable aspect of the
* request, such as `Content-Length` or a body checksum.
* - finalizeRequest: The request is being prepared to be sent over the wire. The
* request in this stage should already be semantically complete and
* should therefore only be altered as match the recipient's
* expectations. Examples of typical finalization tasks include request
* signing and injecting hop-by-hop headers.
* - deserialize: The response has arrived, the middleware here will deserialize
* the raw response object to structured response
*
* Unlike initialization and build handlers, which are executed once
* per operation execution, finalization and deserialize handlers will be
* executed foreach HTTP request sent.
*
* @defaultValue 'initialize'
*/
step?: Step;
/**
* A list of strings to any that identify the general purpose or important
* characteristics of a given handler.
*/
tags?: Array<string>;
/**
* A unique name to refer to a middleware
*/
name?: string;
/**
* A flag to override the existing middleware with the same name. Without
* setting it, adding middleware with duplicated name will throw an exception.
* @internal
*/
override?: boolean;
}
/**
* @public
*/
export interface AbsoluteLocation {
priority?: Priority;
/**
* By default middleware will be added to individual step in un-guaranteed order.
* In the case that
*
* @defaultValue 'normal'
*/
priority?: Priority;
}
export declare type Relation = "before" | "after";
/**
* @public
*/
export type Relation = "before" | "after";
/**
* @public
*/
export interface RelativeLocation {
relation: Relation;
toMiddleware: string;
/**
* Specify the relation to be before or after a know middleware.
*/
relation: Relation;
/**
* A known middleware name to indicate inserting middleware's location.
*/
toMiddleware: string;
}
export declare type RelativeMiddlewareOptions = RelativeLocation &
Pick<HandlerOptions, Exclude<keyof HandlerOptions, "step">>;
/**
* @public
*/
export type RelativeMiddlewareOptions = RelativeLocation & Pick<HandlerOptions, Exclude<keyof HandlerOptions, "step">>;
/**
* @public
*/
export interface InitializeHandlerOptions extends HandlerOptions {
step?: "initialize";
step?: "initialize";
}
/**
* @public
*/
export interface SerializeHandlerOptions extends HandlerOptions {
step: "serialize";
step: "serialize";
}
/**
* @public
*/
export interface BuildHandlerOptions extends HandlerOptions {
step: "build";
step: "build";
}
/**
* @public
*/
export interface FinalizeRequestHandlerOptions extends HandlerOptions {
step: "finalizeRequest";
step: "finalizeRequest";
}
/**
* @public
*/
export interface DeserializeHandlerOptions extends HandlerOptions {
step: "deserialize";
step: "deserialize";
}
export interface MiddlewareStack<Input extends object, Output extends object>
extends Pluggable<Input, Output> {
add(
middleware: InitializeMiddleware<Input, Output>,
options?: InitializeHandlerOptions & AbsoluteLocation
): void;
add(
middleware: SerializeMiddleware<Input, Output>,
options: SerializeHandlerOptions & AbsoluteLocation
): void;
add(
middleware: BuildMiddleware<Input, Output>,
options: BuildHandlerOptions & AbsoluteLocation
): void;
add(
middleware: FinalizeRequestMiddleware<Input, Output>,
options: FinalizeRequestHandlerOptions & AbsoluteLocation
): void;
add(
middleware: DeserializeMiddleware<Input, Output>,
options: DeserializeHandlerOptions & AbsoluteLocation
): void;
addRelativeTo(
middleware: MiddlewareType<Input, Output>,
options: RelativeMiddlewareOptions
): void;
use(pluggable: Pluggable<Input, Output>): void;
clone(): MiddlewareStack<Input, Output>;
remove(toRemove: MiddlewareType<Input, Output> | string): boolean;
removeByTag(toRemove: string): boolean;
concat<InputType extends Input, OutputType extends Output>(
from: MiddlewareStack<InputType, OutputType>
): MiddlewareStack<InputType, OutputType>;
resolve<InputType extends Input, OutputType extends Output>(
handler: DeserializeHandler<InputType, OutputType>,
context: HandlerExecutionContext
): InitializeHandler<InputType, OutputType>;
/**
* @public
*
* A stack storing middleware. It can be resolved into a handler. It supports 2
* approaches for adding middleware:
* 1. Adding middleware to specific step with `add()`. The order of middleware
* added into same step is determined by order of adding them. If one middleware
* needs to be executed at the front of the step or at the end of step, set
* `priority` options to `high` or `low`.
* 2. Adding middleware to location relative to known middleware with `addRelativeTo()`.
* This is useful when given middleware must be executed before or after specific
* middleware(`toMiddleware`). You can add a middleware relatively to another
* middleware which also added relatively. But eventually, this relative middleware
* chain **must** be 'anchored' by a middleware that added using `add()` API
* with absolute `step` and `priority`. This mothod will throw if specified
* `toMiddleware` is not found.
*/
export interface MiddlewareStack<Input extends object, Output extends object> extends Pluggable<Input, Output> {
/**
* Add middleware to the stack to be executed during the "initialize" step,
* optionally specifying a priority, tags and name
*/
add(middleware: InitializeMiddleware<Input, Output>, options?: InitializeHandlerOptions & AbsoluteLocation): void;
/**
* Add middleware to the stack to be executed during the "serialize" step,
* optionally specifying a priority, tags and name
*/
add(middleware: SerializeMiddleware<Input, Output>, options: SerializeHandlerOptions & AbsoluteLocation): void;
/**
* Add middleware to the stack to be executed during the "build" step,
* optionally specifying a priority, tags and name
*/
add(middleware: BuildMiddleware<Input, Output>, options: BuildHandlerOptions & AbsoluteLocation): void;
/**
* Add middleware to the stack to be executed during the "finalizeRequest" step,
* optionally specifying a priority, tags and name
*/
add(middleware: FinalizeRequestMiddleware<Input, Output>, options: FinalizeRequestHandlerOptions & AbsoluteLocation): void;
/**
* Add middleware to the stack to be executed during the "deserialize" step,
* optionally specifying a priority, tags and name
*/
add(middleware: DeserializeMiddleware<Input, Output>, options: DeserializeHandlerOptions & AbsoluteLocation): void;
/**
* Add middleware to a stack position before or after a known middleware，optionally
* specifying name and tags.
*/
addRelativeTo(middleware: MiddlewareType<Input, Output>, options: RelativeMiddlewareOptions): void;
/**
* Apply a customization function to mutate the middleware stack, often
* used for customizations that requires mutating multiple middleware.
*/
use(pluggable: Pluggable<Input, Output>): void;
/**
* Create a shallow clone of this stack. Step bindings and handler priorities
* and tags are preserved in the copy.
*/
clone(): MiddlewareStack<Input, Output>;
/**
* Removes middleware from the stack.
*
* If a string is provided, it will be treated as middleware name. If a middleware
* is inserted with the given name, it will be removed.
*
* If a middleware class is provided, all usages thereof will be removed.
*/
remove(toRemove: MiddlewareType<Input, Output> | string): boolean;
/**
* Removes middleware that contains given tag
*
* Multiple middleware will potentially be removed
*/
removeByTag(toRemove: string): boolean;
/**
* Create a stack containing the middlewares in this stack as well as the
* middlewares in the `from` stack. Neither source is modified, and step
* bindings and handler priorities and tags are preserved in the copy.
*/
concat<InputType extends Input, OutputType extends Output>(from: MiddlewareStack<InputType, OutputType>): MiddlewareStack<InputType, OutputType>;
/**
* Returns a list of the current order of middleware in the stack.
* This does not execute the middleware functions, nor does it
* provide a reference to the stack itself.
*/
identify(): string[];
/**
* Builds a single handler function from zero or more middleware classes and
* a core handler. The core handler is meant to send command objects to AWS
* services and return promises that will resolve with the operation result
* or be rejected with an error.
*
* When a composed handler is invoked, the arguments will pass through all
* middleware in a defined order, and the return from the innermost handler
* will pass through all middleware in the reverse of that order.
*/
resolve<InputType extends Input, OutputType extends Output>(handler: DeserializeHandler<InputType, OutputType>, context: HandlerExecutionContext): InitializeHandler<InputType, OutputType>;
}
/**
* @public
*
* Data and helper objects that are not expected to change from one execution of
* a composed handler to another.
*/
export interface HandlerExecutionContext {
logger?: Logger;
userAgent?: UserAgent;
[key: string]: any;
/**
* A logger that may be invoked by any handler during execution of an
* operation.
*/
logger?: Logger;
/**
* Additional user agent that inferred by middleware. It can be used to save
* the internal user agent sections without overriding the `customUserAgent`
* config in clients.
*/
userAgent?: UserAgent;
/**
* Resolved by the endpointMiddleware function of `@aws-sdk/middleware-endpoint`
* in the serialization stage.
*/
endpointV2?: EndpointV2;
/**
* Set at the same time as endpointV2.
*/
authSchemes?: AuthScheme[];
/**
* The current auth configuration that has been set by any auth middleware and
* that will prevent from being set more than once.
*/
currentAuthConfig?: HttpAuthDefinition;
/**
* Used by DynamoDbDocumentClient.
*/
dynamoDbDocumentClientOptions?: Partial<{
overrideInputFilterSensitiveLog(...args: any[]): string | void;
overrideOutputFilterSensitiveLog(...args: any[]): string | void;
}>;
[key: string]: any;
}
/**
* @public
*/
export interface Pluggable<Input extends object, Output extends object> {
applyToStack: (stack: MiddlewareStack<Input, Output>) => void;
/**
* A function that mutate the passed in middleware stack. Functions implementing
* this interface can add, remove, modify existing middleware stack from clients
* or commands
*/
applyToStack: (stack: MiddlewareStack<Input, Output>) => void;
}

31

dist-types/ts3.4/pagination.d.ts
import { Client } from "./client";
export declare type Paginator<T> = AsyncGenerator<T, T, unknown>;
/**
* @public
*
* Expected type definition of a paginator.
*/
export type Paginator<T> = AsyncGenerator<T, T, unknown>;
/**
* @public
*
* Expected paginator configuration passed to an operation. Services will extend
* this interface definition and may type client further.
*/
export interface PaginationConfiguration {
client: Client<any, any, any>;
pageSize?: number;
startingToken?: any;
stopOnSameToken?: boolean;
client: Client<any, any, any>;
pageSize?: number;
startingToken?: any;
/**
* For some APIs, such as CloudWatchLogs events, the next page token will always
* be present.
*
* When true, this config field will have the paginator stop when the token doesn't change
* instead of when it is not present.
*/
stopOnSameToken?: boolean;
}

26

dist-types/ts3.4/profile.d.ts

@@ -1,8 +0,22 @@

export declare type IniSection = Record<string, string | undefined>;
export interface Profile extends IniSection {}
export declare type ParsedIniData = Record<string, IniSection>;
/**
* @public
*/
export type IniSection = Record<string, string | undefined>;
/**
* @public
*
* @deprecated Please use {@link IniSection}
*/
export interface Profile extends IniSection {
}
/**
* @public
*/
export type ParsedIniData = Record<string, IniSection>;
/**
* @public
*/
export interface SharedConfigFiles {
credentialsFile: ParsedIniData;
configFile: ParsedIniData;
credentialsFile: ParsedIniData;
configFile: ParsedIniData;
}

54

dist-types/ts3.4/response.d.ts

@@ -0,16 +1,46 @@

/**
* @internal
*/
export interface ResponseMetadata {
httpStatusCode?: number;
requestId?: string;
extendedRequestId?: string;
cfId?: string;
attempts?: number;
totalRetryDelay?: number;
/**
* The status code of the last HTTP response received for this operation.
*/
httpStatusCode?: number;
/**
* A unique identifier for the last request sent for this operation. Often
* requested by AWS service teams to aid in debugging.
*/
requestId?: string;
/**
* A secondary identifier for the last request sent. Used for debugging.
*/
extendedRequestId?: string;
/**
* A tertiary identifier for the last request sent. Used for debugging.
*/
cfId?: string;
/**
* The number of times this operation was attempted.
*/
attempts?: number;
/**
* The total amount of time (in milliseconds) that was spent waiting between
* retry attempts.
*/
totalRetryDelay?: number;
}
/**
* @public
*/
export interface MetadataBearer {
$metadata: ResponseMetadata;
/**
* Metadata pertaining to this request.
*/
$metadata: ResponseMetadata;
}
/**
* @internal
*/
export interface Response {
body: any;
}

142

dist-types/ts3.4/serde.d.ts
import { Endpoint } from "./http";
import { RequestHandler } from "./transfer";
import { Decoder, Encoder, Provider } from "./util";
/**
* @public
*
* Interface for object requires an Endpoint set.
*/
export interface EndpointBearer {
endpoint: Provider<Endpoint>;
endpoint: Provider<Endpoint>;
}
/**
* @public
*/
export interface StreamCollector {
(stream: any): Promise<Uint8Array>;
/**
* A function that converts a stream into an array of bytes.
*
* @param stream - The low-level native stream from browser or Nodejs runtime
*/
(stream: any): Promise<Uint8Array>;
}
/**
* @public
*
* Request and Response serde util functions and settings for AWS services
*/
export interface SerdeContext extends EndpointBearer {
base64Encoder: Encoder;
base64Decoder: Decoder;
utf8Encoder: Encoder;
utf8Decoder: Decoder;
streamCollector: StreamCollector;
requestHandler: RequestHandler<any, any>;
disableHostPrefix: boolean;
base64Encoder: Encoder;
base64Decoder: Decoder;
utf8Encoder: Encoder;
utf8Decoder: Decoder;
streamCollector: StreamCollector;
requestHandler: RequestHandler<any, any>;
disableHostPrefix: boolean;
}
export interface RequestSerializer<
Request,
Context extends EndpointBearer = any
> {
(input: any, context: Context): Promise<Request>;
/**
* @public
*/
export interface RequestSerializer<Request, Context extends EndpointBearer = any> {
/**
* Converts the provided `input` into a request object
*
* @param input - The user input to serialize.
*
* @param context - Context containing runtime-specific util functions.
*/
(input: any, context: Context): Promise<Request>;
}
export interface ResponseDeserializer<
OutputType,
ResponseType = any,
Context = any
> {
(output: ResponseType, context: Context): Promise<OutputType>;
/**
* @public
*/
export interface ResponseDeserializer<OutputType, ResponseType = any, Context = any> {
/**
* Converts the output of an operation into JavaScript types.
*
* @param output - The HTTP response received from the service
*
* @param context - context containing runtime-specific util functions.
*/
(output: ResponseType, context: Context): Promise<OutputType>;
}
/**
* @public
*
* Declare DOM interfaces in case dom.d.ts is not added to the tsconfig lib, causing
* interfaces to not be defined. For developers with dom.d.ts added, the interfaces will
* be merged correctly.
*
* This is also required for any clients with streaming interfaces where the corresponding
* types are also referred. The type is only declared here once since this `@aws-sdk/types`
* is depended by all `@aws-sdk` packages.
*/
declare global {
export interface ReadableStream {}
/**
* @public
*/
export interface ReadableStream {
}
/**
* @public
*/
export interface Blob {
}
}
/**
* The interface contains mix-in utility functions to transfer the runtime-specific
* stream implementation to specified format. Each stream can ONLY be transformed
* once.
*/
export interface SdkStreamMixin {
transformToByteArray: () => Promise<Uint8Array>;
transformToString: (encoding?: string) => Promise<string>;
transformToWebStream: () => ReadableStream;
transformToByteArray: () => Promise<Uint8Array>;
transformToString: (encoding?: string) => Promise<string>;
transformToWebStream: () => ReadableStream;
}
export declare type SdkStream<BaseStream> = BaseStream & SdkStreamMixin;
/**
* @public
*
* The type describing a runtime-specific stream implementation with mix-in
* utility functions.
*/
export type SdkStream<BaseStream> = BaseStream & SdkStreamMixin;
/**
* @public
*
* Indicates that the member of type T with
* key StreamKey have been extended
* with the SdkStreamMixin helper methods.
*/
export type WithSdkStreamMixin<T, StreamKey extends keyof T> = {
[key in keyof T]: key extends StreamKey ? SdkStream<T[StreamKey]> : T[key];
};
/**
* Interface for internal function to inject stream utility functions
* implementation
*
* @internal
*/
export interface SdkStreamMixinInjector {
(stream: unknown): SdkStreamMixin;
}
/**
* @internal
*/
export interface SdkStreamSerdeContext {
sdkStreamMixin: SdkStreamMixinInjector;
}

92

dist-types/ts3.4/shapes.d.ts
import { HttpResponse } from "./http";
import { MetadataBearer } from "./response";
export declare type DocumentType =
| null
| boolean
| number
| string
| DocumentType[]
| {
[prop: string]: DocumentType;
};
/**
* @public
*
* A document type represents an untyped JSON-like value.
*
* Not all protocols support document types, and the serialization format of a
* document type is protocol specific. All JSON protocols SHOULD support
* document types and they SHOULD serialize document types inline as normal
* JSON values.
*/
export type DocumentType = null | boolean | number | string | DocumentType[] | {
[prop: string]: DocumentType;
};
/**
* @public
*
* A structure shape with the error trait.
* https://smithy.io/2.0/spec/behavior-traits.html#smithy-api-retryable-trait
*/
export interface RetryableTrait {
readonly throttling?: boolean;
/**
* Indicates that the error is a retryable throttling error.
*/
readonly throttling?: boolean;
}
/**
* @public
*
* Type that is implemented by all Smithy shapes marked with the
* error trait.
* @deprecated
*/
export interface SmithyException {
readonly name: string;
readonly $fault: "client" | "server";
readonly $service?: string;
readonly $retryable?: RetryableTrait;
readonly $response?: HttpResponse;
/**
* The shape ID name of the exception.
*/
readonly name: string;
/**
* Whether the client or server are at fault.
*/
readonly $fault: "client" | "server";
/**
* The service that encountered the exception.
*/
readonly $service?: string;
/**
* Indicates that an error MAY be retried by the client.
*/
readonly $retryable?: RetryableTrait;
/**
* Reference to low-level HTTP response object.
*/
readonly $response?: HttpResponse;
}
export declare type SdkError = Error &
Partial<SmithyException> &
Partial<MetadataBearer>;
/**
* @public
*
* @deprecated See {@link https://aws.amazon.com/blogs/developer/service-error-handling-modular-aws-sdk-js/}
*
* This type should not be used in your application.
* Users of the AWS SDK for JavaScript v3 service clients should prefer to
* use the specific Exception classes corresponding to each operation.
* These can be found as code in the deserializer for the operation's Command class,
* or as declarations in the service model file in codegen/sdk-codegen/aws-models.
*
* If no exceptions are enumerated by a particular Command operation,
* the base exception for the service should be used. Each client exports
* a base ServiceException prefixed with the service name.
*/
export type SdkError = Error & Partial<SmithyException> & Partial<MetadataBearer>;

158

dist-types/ts3.4/signature.d.ts

@@ -0,46 +1,150 @@

import { Message } from "./eventStream";
import { HttpRequest } from "./http";
export declare type DateInput = number | string | Date;
/**
* @public
*
* A `Date` object, a unix (epoch) timestamp in seconds, or a string that can be
* understood by the JavaScript `Date` constructor.
*/
export type DateInput = number | string | Date;
/**
* @public
*/
export interface SigningArguments {
signingDate?: DateInput;
signingService?: string;
signingRegion?: string;
/**
* The date and time to be used as signature metadata. This value should be
* a Date object, a unix (epoch) timestamp, or a string that can be
* understood by the JavaScript `Date` constructor.If not supplied, the
* value returned by `new Date()` will be used.
*/
signingDate?: DateInput;
/**
* The service signing name. It will override the service name of the signer
* in current invocation
*/
signingService?: string;
/**
* The region name to sign the request. It will override the signing region of the
* signer in current invocation
*/
signingRegion?: string;
}
/**
* @public
*/
export interface RequestSigningArguments extends SigningArguments {
unsignableHeaders?: Set<string>;
signableHeaders?: Set<string>;
/**
* A set of strings whose members represents headers that cannot be signed.
* All headers in the provided request will have their names converted to
* lower case and then checked for existence in the unsignableHeaders set.
*/
unsignableHeaders?: Set<string>;
/**
* A set of strings whose members represents headers that should be signed.
* Any values passed here will override those provided via unsignableHeaders,
* allowing them to be signed.
*
* All headers in the provided request will have their names converted to
* lower case before signing.
*/
signableHeaders?: Set<string>;
}
/**
* @public
*/
export interface RequestPresigningArguments extends RequestSigningArguments {
expiresIn?: number;
unhoistableHeaders?: Set<string>;
/**
* The number of seconds before the presigned URL expires
*/
expiresIn?: number;
/**
* A set of strings whose representing headers that should not be hoisted
* to presigned request's query string. If not supplied, the presigner
* moves all the AWS-specific headers (starting with `x-amz-`) to the request
* query string. If supplied, these headers remain in the presigned request's
* header.
* All headers in the provided request will have their names converted to
* lower case and then checked for existence in the unhoistableHeaders set.
*/
unhoistableHeaders?: Set<string>;
}
/**
* @public
*/
export interface EventSigningArguments extends SigningArguments {
priorSignature: string;
priorSignature: string;
}
/**
* @public
*/
export interface RequestPresigner {
presign(
requestToSign: HttpRequest,
options?: RequestPresigningArguments
): Promise<HttpRequest>;
/**
* Signs a request for future use.
*
* The request will be valid until either the provided `expiration` time has
* passed or the underlying credentials have expired.
*
* @param requestToSign - The request that should be signed.
* @param options - Additional signing options.
*/
presign(requestToSign: HttpRequest, options?: RequestPresigningArguments): Promise<HttpRequest>;
}
/**
* @public
*
* An object that signs request objects with AWS credentials using one of the
* AWS authentication protocols.
*/
export interface RequestSigner {
sign(
requestToSign: HttpRequest,
options?: RequestSigningArguments
): Promise<HttpRequest>;
/**
* Sign the provided request for immediate dispatch.
*/
sign(requestToSign: HttpRequest, options?: RequestSigningArguments): Promise<HttpRequest>;
}
/**
* @public
*/
export interface StringSigner {
sign(stringToSign: string, options?: SigningArguments): Promise<string>;
/**
* Sign the provided `stringToSign` for use outside of the context of
* request signing. Typical uses include signed policy generation.
*/
sign(stringToSign: string, options?: SigningArguments): Promise<string>;
}
/**
* @public
*/
export interface FormattedEvent {
headers: Uint8Array;
payload: Uint8Array;
headers: Uint8Array;
payload: Uint8Array;
}
/**
* @public
*/
export interface EventSigner {
sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>;
/**
* Sign the individual event of the event stream.
*/
sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>;
}
/**
* @public
*/
export interface SignableMessage {
message: Message;
priorSignature: string;
}
/**
* @public
*/
export interface SignedMessage {
message: Message;
signature: string;
}
/**
* @public
*/
export interface MessageSigner {
signMessage(message: SignableMessage, args: SigningArguments): Promise<SignedMessage>;
sign(event: SignableMessage, options: SigningArguments): Promise<SignedMessage>;
}

26

dist-types/ts3.4/stream.d.ts

@@ -0,16 +1,22 @@

import { ChecksumConstructor } from "./checksum";
import { HashConstructor, StreamHasher } from "./crypto";
import { BodyLengthCalculator, Encoder } from "./util";
/**
* @public
*/
export interface GetAwsChunkedEncodingStreamOptions {
base64Encoder?: Encoder;
bodyLengthChecker: BodyLengthCalculator;
checksumAlgorithmFn?: HashConstructor;
checksumLocationName?: string;
streamHasher?: StreamHasher;
base64Encoder?: Encoder;
bodyLengthChecker: BodyLengthCalculator;
checksumAlgorithmFn?: ChecksumConstructor | HashConstructor;
checksumLocationName?: string;
streamHasher?: StreamHasher;
}
/**
* @public
*
* A function that returns Readable Stream which follows aws-chunked encoding stream.
* It optionally adds checksum if options are provided.
*/
export interface GetAwsChunkedEncodingStream<StreamType = any> {
(
readableStream: StreamType,
options: GetAwsChunkedEncodingStreamOptions
): StreamType;
(readableStream: StreamType, options: GetAwsChunkedEncodingStreamOptions): StreamType;
}

21

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

@@ -0,8 +1,17 @@

import { TokenIdentity } from "./identity";
import { Provider } from "./util";
export interface Token {
readonly token: string;
readonly expiration?: Date;
/**
* @public
*
* An object representing temporary or permanent AWS token.
*
* @deprecated Use {@link TokenIdentity}
*/
export interface Token extends TokenIdentity {
}
export declare type TokenProvider = Provider<Token>;
/**
* @public
*
* @deprecated Use {@link TokenIdentityProvider}
*/
export type TokenProvider = Provider<Token>;

43

dist-types/ts3.4/transfer.d.ts

@@ -1,18 +0,33 @@

export declare type RequestHandlerOutput<ResponseType> = {
response: ResponseType;
/**
* @public
*/
export type RequestHandlerOutput<ResponseType> = {
response: ResponseType;
};
export interface RequestHandler<
RequestType,
ResponseType,
HandlerOptions = {}
> {
metadata?: RequestHandlerMetadata;
destroy?: () => void;
handle: (
request: RequestType,
handlerOptions?: HandlerOptions
) => Promise<RequestHandlerOutput<ResponseType>>;
/**
* @public
*/
export interface RequestHandler<RequestType, ResponseType, HandlerOptions = {}> {
/**
* metadata contains information of a handler. For example
* 'h2' refers this handler is for handling HTTP/2 requests,
* whereas 'h1' refers handling HTTP1 requests
*/
metadata?: RequestHandlerMetadata;
destroy?: () => void;
handle: (request: RequestType, handlerOptions?: HandlerOptions) => Promise<RequestHandlerOutput<ResponseType>>;
}
/**
* @public
*/
export interface RequestHandlerMetadata {
handlerProtocol: string;
handlerProtocol: RequestHandlerProtocol | string;
}
export declare enum RequestHandlerProtocol {
HTTP_0_9 = "http/0.9",
HTTP_1_0 = "http/1.0",
TDS_8_0 = "tds/8.0"
}
export interface RequestContext {
destination: URL;
}

178

dist-types/ts3.4/util.d.ts
import { Endpoint } from "./http";
import {
FinalizeHandler,
FinalizeHandlerArguments,
FinalizeHandlerOutput,
} from "./middleware";
import { FinalizeHandler, FinalizeHandlerArguments, FinalizeHandlerOutput } from "./middleware";
import { MetadataBearer } from "./response";
/**
* @public
*
* A function that, given a TypedArray of bytes, can produce a string
* representation thereof.
*
* @example An encoder function that converts bytes to hexadecimal
* representation would return `'deadbeef'` when given
* `new Uint8Array([0xde, 0xad, 0xbe, 0xef])`.
*/
export interface Encoder {
(input: Uint8Array): string;
(input: Uint8Array): string;
}
/**
* @public
*
* A function that, given a string, can derive the bytes represented by that
* string.
*
* @example A decoder function that converts bytes to hexadecimal
* representation would return `new Uint8Array([0xde, 0xad, 0xbe, 0xef])` when
* given the string `'deadbeef'`.
*/
export interface Decoder {
(input: string): Uint8Array;
(input: string): Uint8Array;
}
/**
* @public
*
* A function that, when invoked, returns a promise that will be fulfilled with
* a value of type T.
*
* @example A function that reads credentials from shared SDK configuration
* files, assuming roles and collecting MFA tokens as necessary.
*/
export interface Provider<T> {
(): Promise<T>;
(): Promise<T>;
}
/**
* @public
*
* A function that, when invoked, returns a promise that will be fulfilled with
* a value of type T. It memoizes the result from the previous invocation
* instead of calling the underlying resources every time.
*
* You can force the provider to refresh the memoized value by invoke the
* function with optional parameter hash with `forceRefresh` boolean key and
* value `true`.
*
* @example A function that reads credentials from IMDS service that could
* return expired credentials. The SDK will keep using the expired credentials
* until an unretryable service error requiring a force refresh of the
* credentials.
*/
export interface MemoizedProvider<T> {
(options?: { forceRefresh?: boolean }): Promise<T>;
(options?: {
forceRefresh?: boolean;
}): Promise<T>;
}
/**
* @public
*
* A function that, given a request body, determines the
* length of the body. This is used to determine the Content-Length
* that should be sent with a request.
*
* @example A function that reads a file stream and calculates
* the size of the file.
*/
export interface BodyLengthCalculator {
(body: any): number | undefined;
(body: any): number | undefined;
}
/**
* @public
*
* Interface that specifies the retry behavior
*/
export interface RetryStrategy {
mode?: string;
retry: <Input extends object, Output extends MetadataBearer>(
next: FinalizeHandler<Input, Output>,
args: FinalizeHandlerArguments<Input>
) => Promise<FinalizeHandlerOutput<Output>>;
/**
* The retry mode describing how the retry strategy control the traffic flow.
*/
mode?: string;
/**
* the retry behavior the will invoke the next handler and handle the retry accordingly.
* This function should also update the $metadata from the response accordingly.
* @see {@link ResponseMetadata}
*/
retry: <Input extends object, Output extends MetadataBearer>(next: FinalizeHandler<Input, Output>, args: FinalizeHandlerArguments<Input>) => Promise<FinalizeHandlerOutput<Output>>;
}
/**
* @public
*
* Parses a URL in string form into an Endpoint object.
*/
export interface UrlParser {
(url: string): Endpoint;
(url: string | URL): Endpoint;
}
/**
* @public
*
* Object containing regionalization information of
* AWS services.
*/
export interface RegionInfo {
hostname: string;
partition: string;
path?: string;
signingService?: string;
signingRegion?: string;
hostname: string;
partition: string;
path?: string;
signingService?: string;
signingRegion?: string;
}
/**
* @public
*
* Options to pass when calling {@link RegionInfoProvider}
*/
export interface RegionInfoProviderOptions {
useDualstackEndpoint: boolean;
useFipsEndpoint: boolean;
/**
* Enables IPv6/IPv4 dualstack endpoint.
* @defaultValue false
*/
useDualstackEndpoint: boolean;
/**
* Enables FIPS compatible endpoints.
* @defaultValue false
*/
useFipsEndpoint: boolean;
}
/**
* @public
*
* Function returns designated service's regionalization
* information from given region. Each service client
* comes with its regionalization provider. it serves
* to provide the default values of related configurations
*/
export interface RegionInfoProvider {
(region: string, options?: RegionInfoProviderOptions): Promise<
RegionInfo | undefined
>;
(region: string, options?: RegionInfoProviderOptions): Promise<RegionInfo | undefined>;
}
export declare type UserAgentPair = [string, string];
export declare type UserAgent = UserAgentPair[];
/**
* @public
*
* A tuple that represents an API name and optional version
* of a library built using the AWS SDK.
*/
export type UserAgentPair = [
/*name*/ string,
/*version*/ string
];
/**
* @public
*
* User agent data that to be put into the request's user
* agent.
*/
export type UserAgent = UserAgentPair[];

43

dist-types/ts3.4/waiter.d.ts
import { AbortController } from "./abort";
/**
* @public
*/
export interface WaiterConfiguration<Client> {
client: Client;
maxWaitTime: number;
abortController?: AbortController;
abortSignal?: AbortController["signal"];
minDelay?: number;
maxDelay?: number;
/**
* Required service client
*/
client: Client;
/**
* The amount of time in seconds a user is willing to wait for a waiter to complete.
*/
maxWaitTime: number;
/**
* @deprecated Use abortSignal
* Abort controller. Used for ending the waiter early.
*/
abortController?: AbortController;
/**
* Abort Signal. Used for ending the waiter early.
*/
abortSignal?: AbortController["signal"];
/**
* The minimum amount of time to delay between retries in seconds. This is the
* floor of the exponential backoff. This value defaults to service default
* if not specified. This value MUST be less than or equal to maxDelay and greater than 0.
*/
minDelay?: number;
/**
* The maximum amount of time to delay between retries in seconds. This is the
* ceiling of the exponential backoff. This value defaults to service default
* if not specified. If specified, this value MUST be greater than or equal to 1.
*/
maxDelay?: number;
}

38

dist-types/util.d.ts

@@ -5,2 +5,4 @@ import { Endpoint } from "./http";

/**
* @public
*
* A function that, given a TypedArray of bytes, can produce a string

@@ -10,4 +12,4 @@ * representation thereof.

* @example An encoder function that converts bytes to hexadecimal
* representation would return `'deadbeef'` when given `new
* Uint8Array([0xde, 0xad, 0xbe, 0xef])`.
* representation would return `'deadbeef'` when given
* `new Uint8Array([0xde, 0xad, 0xbe, 0xef])`.
*/

@@ -18,2 +20,4 @@ export interface Encoder {

/**
* @public
*
* A function that, given a string, can derive the bytes represented by that

@@ -30,2 +34,4 @@ * string.

/**
* @public
*
* A function that, when invoked, returns a promise that will be fulfilled with

@@ -41,2 +47,4 @@ * a value of type T.

/**
* @public
*
* A function that, when invoked, returns a promise that will be fulfilled with

@@ -61,2 +69,4 @@ * a value of type T. It memoizes the result from the previous invocation

/**
* @public
*
* A function that, given a request body, determines the

@@ -73,2 +83,4 @@ * length of the body. This is used to determine the Content-Length

/**
* @public
*
* Interface that specifies the retry behavior

@@ -89,8 +101,12 @@ */

/**
* @public
*
* Parses a URL in string form into an Endpoint object.
*/
export interface UrlParser {
(url: string): Endpoint;
(url: string | URL): Endpoint;
}
/**
* @public
*
* Object containing regionalization information of

@@ -107,2 +123,4 @@ * AWS services.

/**
* @public
*
* Options to pass when calling {@link RegionInfoProvider}

@@ -113,3 +131,3 @@ */

* Enables IPv6/IPv4 dualstack endpoint.
* @default false
* @defaultValue false
*/

@@ -119,3 +137,3 @@ useDualstackEndpoint: boolean;

* Enables FIPS compatible endpoints.
* @default false
* @defaultValue false
*/

@@ -125,2 +143,4 @@ useFipsEndpoint: boolean;

/**
* @public
*
* Function returns designated service's regionalization

@@ -135,10 +155,14 @@ * information from given region. Each service client

/**
* @public
*
* A tuple that represents an API name and optional version
* of a library built using the AWS SDK.
*/
export declare type UserAgentPair = [name: string, version?: string];
export type UserAgentPair = [name: string, version?: string];
/**
* @public
*
* User agent data that to be put into the request's user
* agent.
*/
export declare type UserAgent = UserAgentPair[];
export type UserAgent = UserAgentPair[];

3

dist-types/waiter.d.ts
import { AbortController } from "./abort";
/**
* @public
*/
export interface WaiterConfiguration<Client> {

@@ -3,0 +6,0 @@ /**

19

package.json
{
"name": "@trivikr-test/types",
"version": "3.170.0",
"version": "3.347.0",
"main": "./dist-cjs/index.js",

@@ -16,3 +16,4 @@ "module": "./dist-es/index.js",

"clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
"test": "exit 0"
"extract:docs": "api-extractor run --local",
"test": "tsc -p tsconfig.test.json"
},

@@ -25,3 +26,3 @@ "author": {

"engines": {
"node": ">= 12.0.0"
"node": ">=14.0.0"
},

@@ -36,3 +37,3 @@ "typesVersions": {

"files": [
"dist-*"
"dist-*/**"
],

@@ -45,2 +46,5 @@ "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/types",

},
"dependencies": {
"tslib": "^2.5.0"
},
"devDependencies": {

@@ -51,5 +55,8 @@ "@tsconfig/recommended": "1.0.1",

"rimraf": "3.0.2",
"typedoc": "0.19.2",
"typescript": "~4.6.2"
"typedoc": "0.23.23",
"typescript": "~4.9.5"
},
"typedoc": {
"entryPoint": "src/index.ts"
}
}

5

README.md

@@ -1,1 +0,4 @@

Please refer [README.md](https://github.com/aws/aws-sdk-js-v3/blob/v3.170.0/packages/types/README.md) for v3.170.0.
# @aws-sdk/types
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/types/latest.svg)](https://www.npmjs.com/package/@aws-sdk/types)
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/types.svg)](https://www.npmjs.com/package/@aws-sdk/types)
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc