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 ClientDefaults

Hierarchy

  • Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>>
    • ClientDefaults

Properties

defaultsMode? disableHostPrefix? logger? maxAttempts? region? requestHandler? retryMode? useDualstackEndpoint? useFipsEndpoint?

Properties

Optional defaultsMode

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.

Optional disableHostPrefix

disableHostPrefix?: boolean

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

Optional logger

logger?: Logger

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

Optional maxAttempts

maxAttempts?: number | Provider<number>

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

Optional region

region?: string | Provider<string>

The AWS region to which this client will send requests

Optional requestHandler

requestHandler?: HttpHandler

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

Optional retryMode

retryMode?: string | Provider<string>

Specifies which retry algorithm to use.

Optional useDualstackEndpoint

useDualstackEndpoint?: boolean | Provider<boolean>

Enables IPv6/IPv4 dualstack endpoint.

Optional useFipsEndpoint

useFipsEndpoint?: boolean | Provider<boolean>

Enables FIPS compatible endpoints.

Settings

Member Visibility

Theme