@aws-sdk/types 3.272.0 → 3.290.0

package/dist-cjs/identity/Identity.js

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

package/dist-es/identity/Identity.js

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

package/dist-types/abort.d.ts

@@ -1,7 +1,12 @@
+/**
+ * @public
+ */
 export interface AbortHandler {
     (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.
  *
@@ -19,6 +24,8 @@ export interface AbortSignal {
     onabort: AbortHandler | 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

package/dist-types/auth.d.ts

@@ -1,4 +1,6 @@
 /**
+ * @internal
+ *
  * Authentication schemes represent a way that the service will authenticate the customer’s identity.
  */
 export interface AuthScheme {
@@ -25,6 +27,9 @@ export interface AuthScheme {
     signingScope?: never;
     properties: Record<string, unknown>;
 }
+/**
+ * @internal
+ */
 export interface HttpAuthDefinition {
     /**
      * Defines the location of where the Auth is serialized.
@@ -41,6 +46,9 @@ export interface HttpAuthDefinition {
      */
     scheme?: string;
 }
+/**
+ * @internal
+ */
 export declare enum HttpAuthLocation {
     HEADER = "header",
     QUERY = "query"

package/dist-types/checksum.d.ts

@@ -1,5 +1,7 @@
 import { SourceData } from "./crypto";
 /**
+ * @public
+ *
  * An object that provides a checksum of data provided in chunks to `update`.
  * The checksum may be performed incrementally as chunks are received or all
  * at once when the checksum is finalized, depending on the underlying
@@ -50,6 +52,8 @@ export interface Checksum {
     update(chunk: Uint8Array): void;
 }
 /**
+ * @public
+ *
  * A constructor for a Checksum 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.

package/dist-types/client.d.ts

@@ -2,6 +2,8 @@ import { Command } from "./command";
 import { MiddlewareStack } from "./middleware";
 import { MetadataBearer } from "./response";
 /**
+ * @public
+ *
  * function definition for different overrides of client's 'send' function.
  */
 interface InvokeFunction<InputTypes extends object, OutputTypes extends MetadataBearer, ResolvedClientConfiguration> {

package/dist-types/command.d.ts

@@ -1,5 +1,8 @@
 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> {
     readonly input: InputType;
     readonly middlewareStack: MiddlewareStack<InputType, OutputType>;

package/dist-types/credentials.d.ts

@@ -1,6 +1,8 @@
 import { AwsCredentialIdentity } from "./identity";
 import { Provider } from "./util";
 /**
+ * @public
+ *
  * An object representing temporary or permanent AWS credentials.
  *
  * @deprecated Use {@AwsCredentialIdentity}
@@ -8,6 +10,8 @@ import { Provider } from "./util";
 export interface Credentials extends AwsCredentialIdentity {
 }
 /**
+ * @public
+ *
  * @deprecated Use {@AwsCredentialIdentityProvider}
  */
 export declare type CredentialProvider = Provider<Credentials>;

package/dist-types/crypto.d.ts

@@ -1,5 +1,10 @@
+/**
+ * @public
+ */
 export declare 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.
@@ -23,6 +28,8 @@ export interface 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.
@@ -33,6 +40,8 @@ export interface HashConstructor {
     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.
@@ -41,6 +50,8 @@ export interface StreamHasher<StreamType = any> {
     (hashCtor: HashConstructor, stream: StreamType): Promise<Uint8Array>;
 }
 /**
+ * @public
+ *
  * A function that returns a promise fulfilled with bytes from a
  * cryptographically secure pseudorandom number generator.
  */

package/dist-types/dns.d.ts

@@ -1,4 +1,6 @@
 /**
+ * @public
+ *
  * DNS record types
  */
 export declare enum HostAddressType {
@@ -11,6 +13,9 @@ export declare enum HostAddressType {
      */
     A = "A"
 }
+/**
+ * @public
+ */
 export interface HostAddress {
     /**
      * The {@link HostAddressType} of the host address.
@@ -30,6 +35,9 @@ export interface HostAddress {
      */
     service?: string;
 }
+/**
+ * @public
+ */
 export interface HostResolverArguments {
     /**
      * The host name to resolve.
@@ -41,6 +49,8 @@ export interface HostResolverArguments {
     service?: string;
 }
 /**
+ * @public
+ *
  * Host Resolver interface for DNS queries
  */
 export interface HostResolver {

package/dist-types/endpoint.d.ts

@@ -1,4 +1,7 @@
 import { AuthScheme } from "./auth";
+/**
+ * @public
+ */
 export interface EndpointPartition {
     name: string;
     dnsSuffix: string;
@@ -6,6 +9,9 @@ export interface EndpointPartition {
     supportsFIPS: boolean;
     supportsDualStack: boolean;
 }
+/**
+ * @public
+ */
 export interface EndpointARN {
     partition: string;
     service: string;
@@ -13,10 +19,16 @@ export interface EndpointARN {
     accountId: string;
     resourceId: Array<string>;
 }
+/**
+ * @public
+ */
 export declare enum EndpointURLScheme {
     HTTP = "http",
     HTTPS = "https"
 }
+/**
+ * @public
+ */
 export interface EndpointURL {
     /**
      * The URL scheme such as http or https.
@@ -41,9 +53,15 @@ export interface EndpointURL {
      */
     isIp: boolean;
 }
+/**
+ * @public
+ */
 export declare type EndpointObjectProperty = string | boolean | {
     [key: string]: EndpointObjectProperty;
 } | EndpointObjectProperty[];
+/**
+ * @public
+ */
 export interface EndpointV2 {
     url: URL;
     properties?: {
@@ -51,6 +69,9 @@ export interface EndpointV2 {
     } & Record<string, EndpointObjectProperty>;
     headers?: Record<string, string[]>;
 }
+/**
+ * @public
+ */
 export declare type EndpointParameters = {
     [name: string]: undefined | string | boolean;
 };

package/dist-types/eventStream.d.ts

@@ -2,6 +2,8 @@ import { HttpRequest } from "./http";
 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.
@@ -10,68 +12,112 @@ export interface Message {
     headers: MessageHeaders;
     body: Uint8Array;
 }
+/**
+ * @public
+ */
 export declare type MessageHeaders = Record<string, MessageHeaderValue>;
+/**
+ * @public
+ */
 export interface BooleanHeaderValue {
     type: "boolean";
     value: boolean;
 }
+/**
+ * @public
+ */
 export interface ByteHeaderValue {
     type: "byte";
     value: number;
 }
+/**
+ * @public
+ */
 export interface ShortHeaderValue {
     type: "short";
     value: number;
 }
+/**
+ * @public
+ */
 export interface IntegerHeaderValue {
     type: "integer";
     value: number;
 }
+/**
+ * @public
+ */
 export interface LongHeaderValue {
     type: "long";
     value: Int64;
 }
+/**
+ * @public
+ */
 export interface BinaryHeaderValue {
     type: "binary";
     value: Uint8Array;
 }
+/**
+ * @public
+ */
 export interface StringHeaderValue {
     type: "string";
     value: string;
 }
+/**
+ * @public
+ */
 export interface TimestampHeaderValue {
     type: "timestamp";
     value: Date;
 }
+/**
+ * @public
+ */
 export interface UuidHeaderValue {
     type: "uuid";
     value: string;
 }
+/**
+ * @public
+ */
 export declare type MessageHeaderValue = BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue;
+/**
+ * @public
+ */
 export interface Int64 {
     readonly bytes: Uint8Array;
     valueOf: () => number;
     toString: () => string;
 }
 /**
+ * @public
+ *
  * Util functions for serializing or deserializing event stream
  */
 export interface EventStreamSerdeContext {
     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>;
 }
 /**
+ * @public
+ *
  * A function that serializes modeled shape into binary stream message.
  */
 export interface EventStreamMarshallerSerFn<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.
  */
@@ -79,18 +125,33 @@ export interface EventStreamMarshaller<StreamType = any> {
     deserialize: EventStreamMarshallerDeserFn<StreamType>;
     serialize: EventStreamMarshallerSerFn<StreamType>;
 }
+/**
+ * @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;
 }

package/dist-types/http.d.ts

@@ -1,5 +1,7 @@
 import { AbortSignal } from "./abort";
 /**
+ * @public
+ *
  * A collection of key/value pairs with case-insensitive keys.
  */
 export interface Headers extends Map<string, string> {
@@ -20,6 +22,8 @@ export interface Headers extends Map<string, string> {
     withoutHeader(headerName: string): Headers;
 }
 /**
+ * @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
  * `, `.
@@ -36,23 +40,33 @@ export interface Headers extends Map<string, string> {
  * 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.
+ *
+ * @deprecated Replaced by implementation Fields in @aws-sdk/protocol-http.
  */
 export declare 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;
+ *
+ * @deprecated Replaced by implementation HttpRequest/HttpResponse in @aws-sdk/protocol-http.
  */
 export interface HttpMessage {
     headers: HeaderBag;
     body?: any;
 }
 /**
+ * @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 declare type QueryParameterBag = Record<string, string | Array<string> | null>;
 /**
+ * @public
+ *
  * @deprecated use EndpointV2 from @aws-sdk/types.
  */
 export interface Endpoint {
@@ -63,13 +77,19 @@ export interface Endpoint {
     query?: QueryParameterBag;
 }
 /**
+ * @public
+ *
  * Interface an HTTP request class. Contains
  * addressing information in addition to standard message properties.
+ *
+ * @deprecated Replaced by implementation HttpRequest in @aws-sdk/protocol-http.
  */
 export interface HttpRequest extends HttpMessage, Endpoint {
     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.
  */
@@ -77,6 +97,8 @@ export interface HttpResponse extends HttpMessage {
     statusCode: number;
 }
 /**
+ * @public
+ *
  * Represents HTTP message whose body has been resolved to a string. This is
  * used in parsing http message.
  */
@@ -84,6 +106,8 @@ export interface ResolvedHttpResponse extends HttpResponse {
     body: string;
 }
 /**
+ * @public
+ *
  * Represents the options that may be passed to an Http Handler.
  */
 export interface HttpHandlerOptions {

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

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

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

@@ -1,4 +1,7 @@
 import { Identity, IdentityProvider } from "./Identity";
+/**
+ * @public
+ */
 export interface AwsCredentialIdentity extends Identity {
     /**
      * AWS access key ID
@@ -14,4 +17,7 @@ export interface AwsCredentialIdentity extends Identity {
      */
     readonly sessionToken?: string;
 }
+/**
+ * @public
+ */
 export declare type AwsCredentialIdentityProvider = IdentityProvider<AwsCredentialIdentity>;

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

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

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

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

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

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

package/dist-types/logger.d.ts

@@ -1,4 +1,6 @@
 /**
+ * @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.
@@ -8,6 +10,8 @@
  */
 export declare 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 {
@@ -15,6 +19,8 @@ export interface LoggerOptions {
     logLevel?: LogLevel;
 }
 /**
+ * @public
+ *
  * Represents a logger object that is available in HandlerExecutionContext
  * throughout the middleware stack.
  */