Interface S3ClientConfig

The credentials used to sign requests.

The signer to use when signing requests.

An offset value in milliseconds to apply to all signing times.

The region where you want to sign your request against. This can be different to the region in the endpoint.

The injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.

Determines when a checksum will be calculated for request payloads.

Determines when checksum validation will be performed on response payloads.

Default 0 (off).

When set to a value greater than or equal to 8192, sets the minimum number of bytes to buffer into a chunk when processing input streams with chunked encoding (that is, when request checksums are enabled). A minimum of 8kb = 8 * 1024 is required, and 64kb or higher is recommended.

See https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html.

This has a slight performance penalty because it must wrap and buffer your input stream. You do not need to set this value if your stream already flows chunks of 8kb or greater.

Whether to force path style URLs for S3 objects (e.g., https://s3.amazonaws.com// instead of https://.s3.amazonaws.com/

Whether to use the S3 Transfer Acceleration endpoint by default

Whether multi-region access points (MRAP) should be disabled.

This feature was previously called the S3 Global Client. This can result in additional latency as failed requests are retried with a corrected region when receiving a permanent redirect error with status 301. This feature should only be used as a last resort if you do not know the region of your bucket(s) ahead of time.

Identity provider for an S3 feature.

Whether to use the bucket name as the endpoint for this client.

This field configures the SDK's behavior around setting the expect: 100-continue header.

Default: 2_097_152 (2 MB)

When given as a boolean - always send or omit the header. When given as a number - minimum byte threshold of the payload before setting the header. Unmeasurable payload sizes (streams) will set the header too.

The expect: 100-continue header is used to allow the server a chance to validate the PUT request headers before the client begins to send the object payload. This avoids wasteful data transmission for a request that is rejected.

However, there is a trade-off where the request will take longer to complete.

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

The application ID used to identify the application.

A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.

The function that will be used to convert strings into HTTP endpoints.

A function that can calculate the length of a request body.

A function that converts a stream into an array of bytes.

The function that will be used to convert a base64-encoded string to a byte array.

The function that will be used to convert binary data to a base64-encoded string.

The function that will be used to convert a UTF8-encoded string to a byte array.

The function that will be used to convert binary data to a UTF-8 encoded string.

The runtime environment.

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

Unique service identifier.

Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.

When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.

For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

A function that, given a hash constructor and a stream, calculates the hash of the streamed value.

A constructor for a class implementing the __Checksum interface that computes MD5 hashes.

A constructor for a class implementing the __Checksum interface that computes SHA1 hashes.

A function that returns Readable Stream which follows aws-chunked encoding stream.

Default credentials provider; Not available in browser runtime.

Specifies which retry algorithm to use.

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

Optional extensions

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

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

Whether to escape request path when signing the request.

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

The internal function that inject utilities to runtime-specific stream to help users consume the data

A comma-separated list of case-sensitive auth scheme names. An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed. For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.

Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.