/// import * as __aws_sdk_types from "@aws-sdk/types"; import * as _stream from "stream"; import { OutputTypesUnion } from "./types/OutputTypesUnion"; export interface S3Configuration { /** * The function that will be used to convert a base64-encoded string to a byte array */ base64Decoder?: __aws_sdk_types.Decoder; /** * The function that will be used to convert binary data to a base64-encoded string */ base64Encoder?: __aws_sdk_types.Encoder; /** * Whether the provided endpoint addresses an individual bucket. */ bucketEndpoint?: boolean; /** * The credentials used to sign requests. * * If no static credentials are supplied, the SDK will attempt to credentials from known environment variables, from shared configuration and credentials files, and from the EC2 Instance Metadata Service, in that order. */ credentials?: __aws_sdk_types.Credentials | __aws_sdk_types.Provider<__aws_sdk_types.Credentials>; /** * A function that determines how long (in milliseconds) the SDK should wait before retrying a request */ delayDecider?: __aws_sdk_types.DelayDecider; /** * Whether body signing should be disabled. Body signing can only be disabled when using HTTPS */ disableBodySigning?: boolean; /** * The fully qualified endpoint of the webservice. This is only required when using a custom endpoint (for example, when using a local version of S3). */ endpoint?: string | __aws_sdk_types.HttpEndpoint | __aws_sdk_types.Provider<__aws_sdk_types.HttpEndpoint>; /** * The endpoint provider to call if no endpoint is provided */ endpointProvider?: any; /** * Whether to force path style URLs for S3 objects (e.g., https://s3.amazonaws.com// instead of https://.s3.amazonaws.com/ */ forcePathStyle?: boolean; /** * The handler to use as the core of the client's middleware stack */ handler?: __aws_sdk_types.Terminalware; /** * The HTTP handler to use */ httpHandler?: __aws_sdk_types.HttpHandler<_stream.Readable>; /** * The maximum number of redirects to follow for a service request. Set to `0` to disable retries. */ maxRedirects?: number; /** * The maximum number of times requests that encounter potentially transient failures should be retried */ maxRetries?: number; /** * A constructor for a class implementing the @aws-sdk/types.Hash interface that computes the MD5 checksum of a string or binary buffer */ md5?: { new (): __aws_sdk_types.Hash; }; /** * The configuration profile to use. */ profile?: string; /** * The AWS region to which this client will send requests */ region?: string | __aws_sdk_types.Provider; /** * A function that determines whether an error is retryable */ retryDecider?: __aws_sdk_types.RetryDecider; /** * A constructor for a class implementing the @aws-sdk/types.Hash interface that computes the SHA-256 HMAC or checksum of a string or binary buffer */ sha256?: __aws_sdk_types.HashConstructor; /** * The signer to use when signing requests. */ signer?: __aws_sdk_types.RequestSigner; /** * The service name with which to sign requests. */ signingName?: string; /** * Whether SSL is enabled for requests. */ sslEnabled?: boolean; /** * A function that converts a stream into an array of bytes. */ streamCollector?: __aws_sdk_types.StreamCollector<_stream.Readable>; /** * A function that, given a hash constructor and a stream, calculates the hash of the streamed value */ streamHasher?: __aws_sdk_types.StreamHasher<_stream.Readable>; /** * The function that will be used to convert strings into HTTP endpoints */ urlParser?: __aws_sdk_types.UrlParser; /** * Whether to use the S3 Transfer Acceleration endpoint by default */ useAccelerateEndpoint?: boolean; /** * Enables IPv6/IPv4 dualstack endpoint. When a DNS lookup is performed on an endpoint of this type, it returns an “A” record with an IPv4 address and an “AAAA” record with an IPv6 address. In most cases the network stack in the client environment will automatically prefer the AAAA record and make a connection using the IPv6 address. Note, however, that currently on Windows, the IPv4 address will be preferred. */ useDualstackEndpoint?: boolean; /** * The function that will be used to convert a UTF8-encoded string to a byte array */ utf8Decoder?: __aws_sdk_types.Decoder; /** * The function that will be used to convert binary data to a UTF-8 encoded string */ utf8Encoder?: __aws_sdk_types.Encoder; } export interface S3ResolvableConfiguration extends S3Configuration { /** * Whether the HTTP handler was injected by the user and should thus not be destroyed when this client is */ _user_injected_http_handler: any; /** * A function that can calculate the length of a request body. */ bodyLengthChecker: (body: any) => number | undefined; /** * The parser to use when converting HTTP responses to SDK output types */ parser: __aws_sdk_types.ResponseParser<_stream.Readable>; /** * The serializer to use when converting SDK input to HTTP requests */ serializer: __aws_sdk_types.Provider<__aws_sdk_types.RequestSerializer<_stream.Readable>>; } export interface S3ResolvedConfiguration extends S3Configuration, __aws_sdk_types.ClientResolvedConfigurationBase { _user_injected_http_handler: boolean; base64Decoder: __aws_sdk_types.Decoder; base64Encoder: __aws_sdk_types.Encoder; bodyLengthChecker: (body: any) => number | undefined; bucketEndpoint: boolean; credentials: __aws_sdk_types.Provider<__aws_sdk_types.Credentials>; disableBodySigning: boolean; endpoint: __aws_sdk_types.Provider<__aws_sdk_types.HttpEndpoint>; endpointProvider: any; forcePathStyle: boolean; handler: __aws_sdk_types.Terminalware; httpHandler: __aws_sdk_types.HttpHandler<_stream.Readable>; maxRedirects: number; maxRetries: number; md5: { new (): __aws_sdk_types.Hash; }; parser: __aws_sdk_types.ResponseParser<_stream.Readable>; region: __aws_sdk_types.Provider; serializer: __aws_sdk_types.Provider<__aws_sdk_types.RequestSerializer<_stream.Readable>>; sha256: __aws_sdk_types.HashConstructor; signer: __aws_sdk_types.RequestSigner; signingName: string; sslEnabled: boolean; streamCollector: __aws_sdk_types.StreamCollector<_stream.Readable>; streamHasher: __aws_sdk_types.StreamHasher<_stream.Readable>; urlParser: __aws_sdk_types.UrlParser; useAccelerateEndpoint: boolean; useDualstackEndpoint: boolean; utf8Decoder: __aws_sdk_types.Decoder; utf8Encoder: __aws_sdk_types.Encoder; } export declare const configurationProperties: __aws_sdk_types.ConfigurationDefinition;