Optional Readonly InternalapiThe API version set internally by the SDK, and is not planned to be used by customer code.
OptionalauthA 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.
Optional Internalbase64The function that will be used to convert a base64-encoded string to a byte array.
Optional Internalbase64The function that will be used to convert binary data to a base64-encoded string.
Optional InternalbodyA function that can calculate the length of a request body.
OptionalbucketWhether to use the bucket name as the endpoint for this client.
OptionalcacheDefault false.
When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be recognized.
Calling client.destroy() also clears this cache.
Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests.
Optional InternalcredentialDefault credentials provider; Not available in browser runtime.
OptionalcredentialsThe credentials used to sign requests.
OptionalcustomThe custom user agent header that would be appended to default one
OptionaldefaultsThe @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
Optional InternaldefaultThe provider populating default tracking information to be sent with user-agent, x-amz-user-agent header
OptionaldisableDisable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
OptionaldisableWhether multi-region access points (MRAP) should be disabled.
OptionaldisableOptionalendpointThe fully qualified endpoint of the webservice. This is only for using a custom endpoint (for example, when using a local version of S3).
Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint.
OptionalendpointProviding a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider.
OptionaleventThe function that provides necessary utilities for generating and parsing event stream
OptionalextensionsOptional extensions
OptionalfollowThis 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.
OptionalforceWhether to force path style URLs for S3 objects
(e.g., https://s3.amazonaws.com/
Optional InternalgetA function that returns Readable Stream which follows aws-chunked encoding stream.
Optional InternalhttpConfiguration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
Optional InternalhttpConfiguration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
OptionalloggerOptional logger for logging debug/info/warn/error.
OptionalmaxValue for how many times a request will be made at most in case of retry.
Optional Internalmd5A constructor for a class implementing the __Checksum interface that computes MD5 hashes.
OptionalprofileSetting 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.
OptionalregionThe AWS region to which this client will send requests
OptionalrequestDetermines when a checksum will be calculated for request payloads.
OptionalrequestThe HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
OptionalrequestDefault 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.
OptionalresponseDetermines when checksum validation will be performed on response payloads.
OptionalretrySpecifies which retry algorithm to use.
OptionalretryThe strategy to retry the request. Using built-in exponential backoff strategy by default.
Optional InternalruntimeThe runtime environment.
Optionals3Identity provider for an S3 feature.
Optional InternalsdkThe internal function that inject utilities to runtime-specific stream to help users consume the data
Optional InternalserviceThis field is used internally so you should not fill any value to this field.
Optional InternalserviceUnique service identifier.
Optional Internalsha1A constructor for a class implementing the __Checksum interface that computes SHA1 hashes.
Optional Internalsha256A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.
OptionalsignerThe signer to use when signing requests.
Optional InternalsignerThe injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.
OptionalsigningWhether to escape request path when signing the request.
OptionalsigningThe region where you want to sign your request against. This can be different to the region in the endpoint.
Optionalsigv4aThis option will override the AWS sigv4a signing regionSet from any other source.
The lookup order is:
Optional InternalstreamA function that converts a stream into an array of bytes.
Optional InternalstreamA function that, given a hash constructor and a stream, calculates the hash of the streamed value.
OptionalsystemAn offset value in milliseconds to apply to all signing times.
OptionaltlsWhether TLS is enabled for requests.
Optional InternalurlThe function that will be used to convert strings into HTTP endpoints.
OptionaluseWhether to use the S3 Transfer Acceleration endpoint by default
OptionaluseWhether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.
OptionaluseEnables IPv6/IPv4 dualstack endpoint.
OptionaluseEnables FIPS compatible endpoints.
OptionaluseOptionaluserThe application ID used to identify the application.
Optional Internalutf8The function that will be used to convert a UTF8-encoded string to a byte array.
Optional Internalutf8The function that will be used to convert binary data to a UTF-8 encoded string.
The configuration interface of S3Client class constructor that set the region, credentials and other options.