S3Client Class

Properties   Methods   Events   Configuration Settings   Errors  

The S3Client class provides an easy-to-use interface for Amazon S3 and other S3-compatible services.




The S3Client class allows you to access Amazon's Simple Storage Service (S3), as well as other S3-compatible services, in a secure manner using TLS/SSL. S3-like services allow you to store arbitrary data objects in various buckets, and access them from anywhere with an internet connection.

A brief synopsis follows, but please refer to Amazon's S3 documentation for more information about the general capabilities of S3.

S3Client supports the following providers:

  • Amazon S3
  • Backblaze B2
  • Digital Ocean Spaces
  • Google Cloud Storage
  • IBM Cloud Object Storage
  • Linode Object Storage
  • Oracle Cloud Object Storage
  • Wasabi

There is also a "custom provider" option, which allows you to interact with any S3-compatible API by specifying its base URL.

Getting Started

To begin, use the ServiceProvider property to select the S3 service provider to use. Then, use the AccessKey and SecretKey properties to specify the access key and secret key that the class should use to sign requests. These keys can be obtained after signing up for an account with the selected service provider.

Working with Buckets

S3 services store objects in various buckets. The following methods can be used to interact with the buckets in an S3 account:

Working with Objects

Once the desired buckets are ready, the following methods can be used to interact with objects:

Working with Multipart Uploads

For S3 providers which support them, multipart uploads make it possible to upload very large objects in multiple parts.

Other Features

The S3Client class also supports a variety of other features:

  • Versioning support
  • Object metadata manipulation
  • Pre-signed link generation
  • And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AccessKeyThe access key to use for authentication.
AccessPolicyThe canned access policy to apply to a bucket or object.
BucketSelects a bucket.
BucketsA collection of buckets.
ContentDispositionContent disposition to send for an object.
ContentTypeContent type to send for an object.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdleThe current status of the class.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MetadataA collection of metadata items.
ObjectDataThe data that was downloaded, or that should be uploaded.
ObjectDelimiterThe delimiter string to use when listing objects.
ObjectMarkerA marker indicating what page of objects to return next.
ObjectPrefixA prefix used to restrict the results returned when listing objects.
ObjectsA collection of objects.
OtherHeadersOther headers as determined by the user (optional).
OverwriteDetermines if local files are overwritten.
ParsedHeadersCollection of headers returned from the last request.
PartMarkerA marker indicating what page of parts to return next.
PartsA collection of multipart upload parts.
ProxyA set of properties related to proxy access.
QueryParamsAdditional query parameters to be included in the request.
RangeThe range of bytes to request.
RegionThe region the class will make requests against.
SecretKeyThe secret key to use for authentication.
ServiceProviderThe S3 service provider to use.
SSLAcceptServerCertInstructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
StartByteThe byte offset from which to resume the upload or download.
TimeoutA timeout for the class.
UseSSLWhether to use SSL/TLS when connecting.
UseVirtualHostingDetermines which URL style to use when making requests.
VersionIdThe object version to make requests against.
VersioningEnabledControls whether versioning is enabled for the currently selected bucket.
VersionMarkerA marker indicating what page of object versions to return next.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AbortMultipartUploadAborts a multipart upload.
AddMetadataAdds a metadata item to the Metadata properties.
AddQueryParamAdds a query parameter to the QueryParams properties.
BucketExistsChecks whether the bucket exists.
CompleteMultipartUploadCompletes a multipart upload by assembling previously uploaded parts.
ConfigSets or retrieves a configuration setting.
CopyObjectCopies an object.
CopyPartCopies the specified object as a part of a multipart upload.
CreateBucketCreates a new bucket.
CreateObjectCreates a new object in the currently selected bucket.
DeleteBucketDeletes a bucket.
DeleteObjectDeletes an object.
DoEventsProcesses events from the internal message queue.
GetBucketLocationGets a bucket's location.
GetLinkCreates a link that provides access to an object for a specified amount of time.
GetObjectDownloads an object.
GetObjectInfoGets an object's information and metadata.
InterruptInterrupt the current method.
ListBucketsLists all buckets in the account.
ListMultipartUploadsLists the current multipart uploads.
ListObjectsLists the objects in a bucket.
ListPartsLists the parts in a multipart upload.
ListVersionsLists the object versions in a bucket.
ResetResets the class to its initial state.
ResetHeadersResets all HTTP headers, cookies, and LocalFile.
SendCustomRequestSends a custom request to the server.
SetDownloadStreamSets the stream to which downloaded data will be written.
SetUploadStreamSets the stream from which data is read when uploading.
StartMultipartUploadStarts a new multipart upload.
UpdateBucketACLUpdates a bucket's canned access policy.
UpdateObjectACLUpdates an object's canned access policy.
UploadPartUploads a multipart upload part.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

BucketListFires once for each bucket returned when listing buckets.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
FragmentCompleteFires after each part in an automatic multipart upload is complete.
HeaderFired every time a header line comes in.
LogFires once for each log message.
MetadataListFires once for each metadata item returned when object information and metadata is retrieved.
ObjectListFires once for each object, object version, or multipart upload returned when listing such items.
PartListFires once for every part returned when listing a multipart upload's parts.
PrefixListFires once for each common prefix returned when listing objects.
ProgressFires during an upload or download to indicate transfer progress.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

AccumulatePagesWhether the class should accumulate subsequent pages of results when listing them.
AutoDetectSigningRegionWhether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process.
AWSProfileThe name of the AWS CLI profile that the class should use to obtain authentication and region information.
AWSProfileDirThe location of the AWS CLI credentials and config files.
ContentRangeThis contains the range of bytes of the current object that are being returned.
CopyPartRangeSpecifies the range of bytes to copy when calling CopyPart.
DownloadTempFileThe temporary file used when downloading encrypted data.
EncodeSlashInObjectNameWhether or not to encode slashes in an object name.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
EnforceBucketNameRestrictionsWhether or not to enforce bucket naming conventions.
ETagThe ETag for the object returned by the server.
ForceDeleteNonEmptyBucketsForces buckets to be deleted even if they aren't empty.
FragmentSizeThe part size to use when uploading a new object.
GoogleProjectIdThe Google project Id to send when using OAuth 2.0 to authenticate to Google Storage.
IfMatchCheck to make sure the object has not been modified since the last request.
IMDSv2SessionTokenDurationThe maximum duration of the session token.
IMDSVersionThe version of Instance Metadata Service to use when accessing role credentials.
IncludeContentMD5Whether an MD5 digest of a custom request's data should be included.
IncludeObjectMD5Whether an MD5 digest of a object's data should be included.
IncludePartMD5Whether an MD5 digest of a part's data should be included.
MaskSensitiveWhether sensitive data is masked in the Log event.
MaxObjectsThe maximum number of results to return when listing objects.
MaxPartsThe maximum number of results to return when listing parts.
OAuthAuthorizationThe OAuth 2.0 authorization token to use to authenticate to Google Storage.
OracleNamespaceThe Oracle Cloud Object Storage namespace to use.
Prefix[i]The i'th common prefix returned.
PrefixCountThe number of common prefixed returned.
ProgressAbsoluteWhether the class should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RawRequestReturns the data that was sent to the server.
RawResponseReturns the data that was received from the server.
ResponseCacheControlSets the Cache-Control header of the response.
ResponseContentDispositionSets the Content-Disposition header of the response.
ResponseContentEncodingSets the Content-Encoding header of the response.
ResponseContentLanguageSets the Content-Language header of the response.
ResponseContentTypeSets the Content-Type header of the response.
ResponseExpiresSets the Expires header of the response.
ResumableUploadStateTracks upload state information during an automatic multipart upload.
SendObjectACLsWhether to include object-level ACL headers when making requests.
SessionTokenThe session token to send in the request when using temporary credentials.
SignatureVersionThe signature version standard to use in all API requests.
SignCustomRequestTells the class to sign the outgoing request.
SigningTimeA custom date to send to the class to use while signing all requests.
SimpleUploadLimitThe maximum data size the class should attempt to upload directly when creating an object.
StorageClassSpecifies the storage class to be used for the uploaded object.
StorePrefixListWhether to store the common prefixes returned when listing objects.
TempPathThe path to the directory where temporary files are created.
URLThe base URL to use when communicating with a service provider.
UseEC2RoleCredentialsWhether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.
XChildCountThe number of child elements of the current element.
XChildName[i]The name of the child element.
XChildXText[i]The inner text of the child element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the class will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the class binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLContextProtocolThe protocol used when getting an SSLContext instance.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithmThe algorithm to be used to create a TrustManager through TrustManagerFactory.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the class whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the class are daemon threads.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S3 2020 Java Edition - Version 20.0 [Build 8164]