Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface S3ClientResolvedConfig

The resolved configuration interface of S3Client class. This is resolved and normalized from the constructor configuration interface.

Hierarchy

Properties

credentials: MemoizedProvider<AwsCredentialIdentity>

Resolved value for input config AwsAuthInputConfig.credentials This provider MAY memoize the loaded credentials for certain period. See MemoizedProvider for more information.

customUserAgent?: UserAgent

The custom user agent header that would be appended to default one

defaultSigningName: string
defaultsMode: DefaultsMode | Provider<DefaultsMode>

The @aws-sdk/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix: boolean

Disable dyanamically changing the endpoint of the client based on the hostPrefix trait of an operation.

disableMultiregionAccessPoints: boolean | false & Provider<boolean> | true & Provider<boolean>
endpoint?: Object

Custom endpoint provided by the user. This is normalized to a single interface from the various acceptable types. This field will be undefined if a custom endpoint is not provided.

endpointProvider: ((params: EndpointParameters, context?: {
    logger?: Logger;
}) => EndpointV2)

Type declaration

    • (params: EndpointParameters, context?: {
          logger?: Logger;
      }): EndpointV2
    • Parameters

      • params: EndpointParameters
      • Optional context: {
            logger?: Logger;
        }
        • Optional logger?: Logger

      Returns EndpointV2

eventStreamMarshaller: EventStreamMarshaller<any>
eventStreamSerdeProvider: EventStreamSerdeProvider

The function that provides necessary utilities for generating and parsing event stream

forcePathStyle: boolean | false & Provider<boolean> | true & Provider<boolean>
logger: Logger

Optional logger for logging debug/info/warn/error.

maxAttempts: Object

Value for how many times a request will be made at most in case of retry.

region: Object

The AWS region to which this client will send requests

requestHandler: RequestHandler<any, any, HttpHandlerOptions> & HttpHandler & RequestHandler<any, any, {}>

The HTTP handler to use. Fetch in browser and Https in Nodejs.

retryMode: string | Provider<string>

Specifies which retry algorithm to use.

retryStrategy: Provider<RetryStrategy | RetryStrategyV2>

Resolved value for input config RetryInputConfig.retryStrategy

signer: ((authScheme?: AuthScheme) => Promise<RequestSigner>)

Type declaration

    • (authScheme?: AuthScheme): Promise<RequestSigner>
    • Resolved value for input config AwsAuthInputConfig.signer

      Parameters

      • Optional authScheme: AuthScheme

      Returns Promise<RequestSigner>

signingEscapePath: boolean

Whether to escape request path when signing the request.

systemClockOffset: number

Resolved value for input config AwsAuthInputConfig.systemClockOffset

tls: boolean

Whether TLS is enabled for requests.

Deprecated

useAccelerateEndpoint: boolean | false & Provider<boolean> | true & Provider<boolean>
useArnRegion: Object

Whether to override the request region with the region inferred from requested resource's ARN. Defaults to false.

useDualstackEndpoint: Object

Enables IPv6/IPv4 dualstack endpoint.

useFipsEndpoint: Object

Enables FIPS compatible endpoints.

useGlobalEndpoint?: boolean | Provider<boolean>