@aws-sdk/client-s3/dist-types/ts3.4/runtimeConfig.d.ts

AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native

import { NodeHttpHandler as RequestHandler } from "@smithy/node-http-handler";
import { S3ClientConfig } from "./S3Client";
export declare const getRuntimeConfig: (config: S3ClientConfig) => {
  runtime: string;
  defaultsMode: import("@smithy/types").Provider<
    import("@smithy/core/client").ResolvedDefaultsMode
  >;
  authSchemePreference: string[] | import("@smithy/types").Provider<string[]>;
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
  credentialDefaultProvider:
    | ((input: any) => import("@smithy/types").AwsCredentialIdentityProvider)
    | ((
        init?: import("@aws-sdk/credential-provider-node").DefaultProviderInit,
      ) => import("@aws-sdk/credential-provider-node").MemoizedRuntimeConfigAwsCredentialIdentityProvider);
  defaultUserAgentProvider: (
    config?: import("@aws-sdk/core/client").PreviouslyResolved,
  ) => Promise<import("@smithy/types").UserAgent>;
  disableS3ExpressSessionAuth: boolean | import("@smithy/types").Provider<boolean | undefined>;
  eventStreamSerdeProvider: import("@smithy/types").EventStreamSerdeProvider;
  maxAttempts: number | import("@smithy/types").Provider<number>;
  region: string | import("@smithy/types").Provider<string>;
  requestChecksumCalculation:
    | import("@aws-sdk/checksums/flexible-checksums").RequestChecksumCalculation
    | import("@smithy/types").Provider<
        import("@aws-sdk/checksums/flexible-checksums").RequestChecksumCalculation
      >;
  requestHandler: RequestHandler | import("@smithy/core/protocols").HttpHandler<any>;
  responseChecksumValidation:
    | import("@aws-sdk/checksums/flexible-checksums").ResponseChecksumValidation
    | import("@smithy/types").Provider<
        import("@aws-sdk/checksums/flexible-checksums").ResponseChecksumValidation
      >;
  retryMode: string | import("@smithy/types").Provider<string>;
  sigv4aSigningRegionSet: string[] | import("@smithy/types").Provider<string[] | undefined>;
  streamCollector: (
    stream: import("stream").Readable | import("stream/web").ReadableStream | ReadableStream | Blob,
  ) => Promise<Uint8Array>;
  streamHasher:
    | import("@smithy/types").StreamHasher<import("stream").Readable>
    | import("@smithy/types").StreamHasher<Blob>;
  useArnRegion: boolean | import("@smithy/types").Provider<boolean | undefined>;
  useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
  useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
  userAgentAppId: string | import("@smithy/types").Provider<string | undefined>;
  cacheMiddleware?: boolean | undefined;
  protocol:
    | import("@smithy/types").ClientProtocol<any, any>
    | import("@smithy/types").ClientProtocolCtor<any, any>
    | typeof import("@aws-sdk/middleware-sdk-s3/s3").S3RestXmlProtocol;
  protocolSettings: {
    defaultNamespace?: string;
    [setting: string]: unknown;
  };
  apiVersion: string;
  sha256: import("@smithy/types").HashConstructor;
  urlParser: import("@smithy/types").UrlParser;
  base64Decoder: import("@smithy/types").Decoder;
  base64Encoder: (_input: Uint8Array | string) => string;
  utf8Decoder: import("@smithy/types").Decoder;
  utf8Encoder: (input: Uint8Array | string) => string;
  disableHostPrefix: boolean;
  serviceId: string;
  profile?: string;
  md5: import("@smithy/types").HashConstructor;
  sha1: import("@smithy/types").HashConstructor;
  getAwsChunkedEncodingStream:
    | import("@smithy/types").GetAwsChunkedEncodingStream<any>
    | typeof import("@smithy/core/serde").getAwsChunkedEncodingStream;
  logger: import("@smithy/types").Logger;
  extensions: import("./runtimeExtensions").RuntimeExtension[];
  signingEscapePath: boolean;
  sdkStreamMixin: import("@smithy/types").SdkStreamMixinInjector;
  customUserAgent?: string | import("@smithy/types").UserAgent;
  requestStreamBufferSize?: number | false;
  checksumAlgorithms?: {
    CRC32?: import("@smithy/types").ChecksumConstructor;
    CRC32C?: import("@smithy/types").ChecksumConstructor;
    CRC64NVME?: import("@smithy/types").ChecksumConstructor;
    SHA1?: import("@smithy/types").ChecksumConstructor;
    SHA256?: import("@smithy/types").ChecksumConstructor;
  } & {
    [algorithmId: string]: import("@smithy/types").ChecksumConstructor;
  };
  retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2;
  endpoint?:
    | ((
        | string
        | import("@smithy/types").Endpoint
        | import("@smithy/types").Provider<import("@smithy/types").Endpoint>
        | import("@smithy/types").EndpointV2
        | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>
      ) &
        (
          | string
          | import("@smithy/types").Provider<string>
          | import("@smithy/types").Endpoint
          | import("@smithy/types").Provider<import("@smithy/types").Endpoint>
          | import("@smithy/types").EndpointV2
          | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>
        ))
    | undefined;
  endpointProvider: (
    endpointParams: import("./endpoint/EndpointParameters").EndpointParameters,
    context?: {
      logger?: import("@smithy/types").Logger;
    },
  ) => import("@smithy/types").EndpointV2;
  tls?: boolean;
  ignoreConfiguredEndpointUrls?: boolean;
  serviceConfiguredEndpoint?: never;
  httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
  httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").S3HttpAuthSchemeProvider;
  credentials?:
    | import("@smithy/types").AwsCredentialIdentity
    | import("@smithy/types").AwsCredentialIdentityProvider;
  signer?:
    | import("@smithy/types").RequestSigner
    | ((
        authScheme?: import("@smithy/types").AuthScheme,
      ) => Promise<import("@smithy/types").RequestSigner>);
  systemClockOffset?: number;
  signingRegion?: string;
  signerConstructor:
    | typeof import("@aws-sdk/signature-v4-multi-region").SignatureV4MultiRegion
    | (new (
        options: import("@smithy/signature-v4").SignatureV4Init &
          import("@smithy/signature-v4").SignatureV4CryptoInit,
      ) => import("@smithy/types").RequestSigner);
  disableClockSkewCorrection?: boolean | import("@smithy/types").Provider<boolean>;
  forcePathStyle?:
    | (boolean & (boolean | import("@smithy/types").Provider<boolean | undefined>))
    | undefined;
  useAccelerateEndpoint?:
    | (boolean & (boolean | import("@smithy/types").Provider<boolean | undefined>))
    | undefined;
  disableMultiregionAccessPoints?:
    | (boolean & (boolean | import("@smithy/types").Provider<boolean | undefined>))
    | undefined;
  followRegionRedirects?: boolean;
  s3ExpressIdentityProvider?: import("@aws-sdk/middleware-sdk-s3/s3").S3ExpressIdentityProvider;
  bucketEndpoint?: boolean;
  expectContinueHeader?: boolean | number;
  clientContextParams?: {
    disableS3ExpressSessionAuth?:
      | boolean
      | undefined
      | import("@smithy/types").Provider<boolean | undefined>;
  };
  useGlobalEndpoint?: boolean | undefined | import("@smithy/types").Provider<boolean | undefined>;
};