@aws-sdk/types 1.0.0-rc.8 → 3.4.1

package/{dist/es → types/ts3.4}/pagination.d.ts

@@ -1,14 +1,14 @@
-import { Client } from "./client";
-/**
- * Expected type definition of a paginator.
- */
-export declare type Paginator<T> = AsyncGenerator<T, T, unknown>;
-/**
- * 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?: string;
-}
+import { Client } from "./client";
+/**
+ * Expected type definition of a paginator.
+ */
+export declare type Paginator<T> = AsyncGenerator<T, T, unknown>;
+/**
+ * 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;
+}

package/{dist/es → types/ts3.4}/response.d.ts

@@ -1,39 +1,34 @@
-import { HeaderBag } from "./http";
-export interface ResponseMetadata {
-    /**
-     * The status code of the last HTTP response received for this operation.
-     */
-    httpStatusCode?: number;
-    /**
-     * The headers of the last HTTP response received for this operation.
-     */
-    httpHeaders?: HeaderBag;
-    /**
-     * 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;
-}
-export interface MetadataBearer {
-    /**
-     * Metadata pertaining to this request.
-     */
-    $metadata: ResponseMetadata;
-}
+export interface ResponseMetadata {
+    /**
+     * 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;
+}
+export interface MetadataBearer {
+    /**
+     * Metadata pertaining to this request.
+     */
+    $metadata: ResponseMetadata;
+}

package/{dist/es → types/ts3.4}/serde.d.ts

@@ -1,49 +1,49 @@
-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;
-    utf8Encoder: Encoder;
-    utf8Decoder: Decoder;
-    streamCollector: StreamCollector;
-    requestHandler: RequestHandler<any, any>;
-    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>;
-}
+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;
+    utf8Encoder: Encoder;
+    utf8Decoder: Decoder;
+    streamCollector: StreamCollector;
+    requestHandler: RequestHandler<any, any>;
+    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/es → types/ts3.4}/signature.d.ts

@@ -1,100 +1,100 @@
-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>;
-}
+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/{dist/es → types/ts3.4}/transfer.d.ts

@@ -1,16 +1,16 @@
-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;
-}
+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/{dist/es → types/ts3.4}/util.d.ts

@@ -1,83 +1,100 @@
-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 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>;
-}
+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/{dist/cjs → types}/util.d.ts

@@ -48,6 +48,10 @@ export interface BodyLengthCalculator {
  * 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.
@@ -81,3 +85,13 @@ export interface RegionInfo {
 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[];