@aws-sdk/types 3.35.0 → 3.40.0

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

@@ -1,23 +1,15 @@
 import { Endpoint } from "./http";
 import { RequestHandler } from "./transfer";
 import { Decoder, Encoder, Provider } from "./util";
-/**
- * Interface for object requires an Endpoint set.
- */
+
 export interface EndpointBearer {
     endpoint: Provider<Endpoint>;
 }
 export interface StreamCollector {
-    /**
-     * 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>;
 }
-/**
- * Request and Response serde util functions and settings for AWS services
- */
+
 export interface SerdeContext extends EndpointBearer {
     base64Encoder: Encoder;
     base64Decoder: Decoder;
@@ -28,22 +20,10 @@ export interface SerdeContext extends EndpointBearer {
     disableHostPrefix: boolean;
 }
 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> {
-    /**
-     * 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>;
 }

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

@@ -1,45 +1,22 @@
 import { MetadataBearer } from "./response";
-/**
- * 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 declare type DocumentType = null | boolean | number | string | DocumentType[] | {
     [prop: string]: DocumentType;
 };
-/**
- * A structure shape with the error trait.
- * https://awslabs.github.io/smithy/spec/core.html#retryable-trait
- */
+
 export interface RetryableTrait {
-    /**
-     * Indicates that the error is a retryable throttling error.
-     */
+    
     readonly throttling?: boolean;
 }
-/**
- * Type that is implemented by all Smithy shapes marked with the
- * error trait.
- */
+
 export interface SmithyException {
-    /**
-     * 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;
 }
 export declare type SdkError = Error & Partial<SmithyException> & Partial<MetadataBearer>;

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

@@ -1,91 +1,40 @@
 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.
- */
+
 export declare type DateInput = number | string | Date;
 export interface SigningArguments {
-    /**
-     * 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;
 }
 export interface RequestSigningArguments extends SigningArguments {
-    /**
-     * 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>;
 }
 export interface RequestPresigningArguments extends RequestSigningArguments {
-    /**
-     * 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>;
 }
 export interface EventSigningArguments extends SigningArguments {
     priorSignature: string;
 }
 export interface RequestPresigner {
-    /**
-     * 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>;
 }
-/**
- * An object that signs request objects with AWS credentials using one of the
- * AWS authentication protocols.
- */
+
 export interface RequestSigner {
-    /**
-     * Sign the provided request for immediate dispatch.
-     */
+    
     sign(requestToSign: HttpRequest, options?: RequestSigningArguments): Promise<HttpRequest>;
 }
 export interface StringSigner {
-    /**
-     * 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>;
 }
 export interface FormattedEvent {
@@ -93,8 +42,6 @@ export interface FormattedEvent {
     payload: Uint8Array;
 }
 export interface EventSigner {
-    /**
-     * Sign the individual event of the event stream.
-     */
+    
     sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>;
 }

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

@@ -2,11 +2,7 @@ export declare type RequestHandlerOutput<ResponseType> = {
     response: ResponseType;
 };
 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>>;

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

@@ -1,74 +1,34 @@
 import { Endpoint } from "./http";
 import { FinalizeHandler, FinalizeHandlerArguments, FinalizeHandlerOutput } from "./middleware";
 import { MetadataBearer } from "./response";
-/**
- * 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;
 }
-/**
- * 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;
 }
-/**
- * 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>;
 }
-/**
- * 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;
 }
-/**
- * Interface that specifies the retry behavior
- */
+
 export interface RetryStrategy {
-    /**
-     * 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>>;
 }
-/**
- * Parses a URL in string form into an Endpoint object.
- */
+
 export interface UrlParser {
     (url: string): Endpoint;
 }
-/**
- * Object containing regionalization information of
- * AWS services.
- */
+
 export interface RegionInfo {
     hostname: string;
     partition: string;
@@ -76,25 +36,21 @@ export interface RegionInfo {
     signingService?: string;
     signingRegion?: string;
 }
-/**
- * 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 RegionInfoProviderOptions {
+    
+    useDualstackEndpoint: boolean;
+    
+    useFipsEndpoint: boolean;
+}
+
 export interface RegionInfoProvider {
-    (region: string, options?: any): Promise<RegionInfo | undefined>;
+    (region: string, options?: RegionInfoProviderOptions): Promise<RegionInfo | undefined>;
 }
-/**
- * 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
+     string,
+     string
 ];
-/**
- * User agent data that to be put into the request's user
- * agent.
- */
+
 export declare type UserAgent = UserAgentPair[];

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

@@ -1,32 +1,15 @@
 import { AbortController } from "./abort";
 export interface WaiterConfiguration<Client> {
-    /**
-     * 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;
 }

package/dist-types/util.d.ts

@@ -76,6 +76,21 @@ export interface RegionInfo {
     signingService?: string;
     signingRegion?: string;
 }
+/**
+ * Options to pass when calling {@link RegionInfoProvider}
+ */
+export interface RegionInfoProviderOptions {
+    /**
+     * Enables IPv6/IPv4 dualstack endpoint.
+     * @default false
+     */
+    useDualstackEndpoint: boolean;
+    /**
+     * Enables FIPS compatible endpoints.
+     * @default false
+     */
+    useFipsEndpoint: boolean;
+}
 /**
  * Function returns designated service's regionalization
  * information from given region. Each service client
@@ -83,7 +98,7 @@ export interface RegionInfo {
  * to provide the default values of related configurations
  */
 export interface RegionInfoProvider {
-    (region: string, options?: any): Promise<RegionInfo | undefined>;
+    (region: string, options?: RegionInfoProviderOptions): Promise<RegionInfo | undefined>;
 }
 /**
  * A tuple that represents an API name and optional version

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/types",
-  "version": "3.35.0",
+  "version": "3.40.0",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
@@ -31,6 +31,9 @@
       ]
     }
   },
+  "files": [
+    "dist-*"
+  ],
   "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/types",
   "repository": {
     "type": "git",

package/src/abort.d.ts

@@ -1,42 +0,0 @@
-export interface AbortHandler {
-  (this: AbortSignal, ev: any): any;
-}
-/**
- * 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 {
-  /**
-   * 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 | null;
-}
-/**
- * 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 {
-  /**
-   * 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;
-}

package/src/abort.ts

@@ -1,46 +0,0 @@
-export interface AbortHandler {
-  (this: AbortSignal, ev: any): any;
-}
-
-/**
- * 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 {
-  /**
-   * 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 | null;
-}
-
-/**
- * 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 {
-  /**
-   * 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;
-}

package/src/client.d.ts

@@ -1,34 +0,0 @@
-import { Command } from "./command";
-import { MiddlewareStack } from "./middleware";
-import { MetadataBearer } from "./response";
-/**
- * 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;
-}
-/**
- * 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 {};

package/src/client.ts

@@ -1,35 +0,0 @@
-import { Command } from "./command";
-import { MiddlewareStack } from "./middleware";
-import { MetadataBearer } from "./response";
-
-/**
- * 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;
-}
-
-/**
- * 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;
-}

package/src/command.d.ts

@@ -1,17 +0,0 @@
-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>;
-}

package/src/command.ts

@@ -1,18 +0,0 @@
-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>;
-}

package/src/credentials.d.ts

@@ -1,24 +0,0 @@
-import { Provider } from "./util";
-/**
- * An object representing temporary or permanent AWS credentials.
- */
-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 declare type CredentialProvider = Provider<Credentials>;