@aws-sdk/types 3.35.0 → 3.40.0

package/src/shapes.ts

@@ -1,50 +0,0 @@
-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 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 type SdkError = Error & Partial<SmithyException> & Partial<MetadataBearer>;

package/src/signature.d.ts

@@ -1,100 +0,0 @@
-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 {
-  headers: Uint8Array;
-  payload: Uint8Array;
-}
-export interface EventSigner {
-  /**
-   * Sign the individual event of the event stream.
-   */
-  sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>;
-}

package/src/signature.ts

@@ -1,113 +0,0 @@
-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 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 {
-  headers: Uint8Array;
-  payload: Uint8Array;
-}
-export interface EventSigner {
-  /**
-   * Sign the individual event of the event stream.
-   */
-  sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>;
-}

package/src/transfer.d.ts

@@ -1,16 +0,0 @@
-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>>;
-}
-export interface RequestHandlerMetadata {
-  handlerProtocol: string;
-}

package/src/transfer.ts

@@ -1,18 +0,0 @@
-export 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>>;
-}
-
-export interface RequestHandlerMetadata {
-  // This infers request handler's protocol
-  // valid values are stated: https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
-  handlerProtocol: string;
-}

package/src/util.d.ts

@@ -1,100 +0,0 @@
-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;
-  path?: string;
-  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 RegionInfoProvider {
-  (region: string, options?: any): 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];
-/**
- * User agent data that to be put into the request's user
- * agent.
- */
-export declare type UserAgent = UserAgentPair[];

package/src/util.ts

@@ -1,115 +0,0 @@
-import { Endpoint } from "./http";
-import {
-  FinalizeHandler,
-  FinalizeHandlerArguments,
-  FinalizeHandlerOutput,
-  HandlerExecutionContext,
-} 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;
-  path?: string;
-  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 RegionInfoProvider {
-  (region: string, options?: any): Promise<RegionInfo | undefined>;
-}
-
-/**
- * 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];
-
-/**
- * User agent data that to be put into the request's user
- * agent.
- */
-export type UserAgent = UserAgentPair[];

package/src/waiter.d.ts

@@ -1,32 +0,0 @@
-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/src/waiter.ts

@@ -1,38 +0,0 @@
-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/tsconfig.cjs.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "dist-cjs",
-    "rootDir": "src"
-  },
-  "extends": "../../tsconfig.cjs.json",
-  "include": ["src/"]
-}

package/tsconfig.es.json

@@ -1,10 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "lib": ["es5", "es2015.promise", "es2015.collection", "es2015.iterable", "es2015.symbol.wellknown"],
-    "outDir": "dist-es",
-    "rootDir": "src"
-  },
-  "extends": "../../tsconfig.es.json",
-  "include": ["src/"]
-}

package/tsconfig.types.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "declarationDir": "dist-types",
-    "rootDir": "src"
-  },
-  "extends": "../../tsconfig.types.json",
-  "include": ["src/"]
-}