IPWorks Cloud 2020 Python Edition

Questions / Feedback?

Wasabi Class

Properties   Methods   Events   Configuration Settings   Errors  

The Wasabi class provides an easy way to interface with the Wasabi service.

Syntax

class ipworkscloud.Wasabi

Remarks

Wasabi has an API that is fully compatible with that of Amazon S3, allowing you to store arbitrary data using the same bucket-and-object paradigm that S3 uses. Wasabi adds additional functionality on top of the S3 API. Whether you're doing simple bucket-and-object data manipulation, or leveraging Wasabi-exclusive API features, the Wasabi class makes it easy to access the Wasabi service quickly and securely.

Wasabi's API additions range in scale; the simplest example is the ability to rename buckets, objects, and folders. The most notable API additions, however, are two full-blown headline features: Composition and Compliance. Composition allows you to concatenate (or, "compose") together objects which are already on the server; it's a simpler, cheaper, and more flexible alternative to S3's multipart uploads. The Compliance system gives you the ability to define policies that dictate how long objects must be retained before they can be modified or deleted. We recommend referring to Wasabi's website for more details about these features.

To use the Wasabi class, you will first need to sign up for the Wasabi service and obtain an access_key and a secret_key. Then you can start creating buckets in your account using create_bucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using create_object.

The compose_objects and update_compliance methods' documentation provide extensive usage details and examples for composition and compliance; the rename_bucket, rename_object, and rename_folder methods speak for themselves; and the standard bucket-and-object manipulation features are available through methods such as list_buckets, list_objects, get_object, delete_object, get_link, 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.

access_keyThe access key to use for authentication.
access_policyThe canned access policy to apply to a bucket or object.
bucketSelects a bucket.
bucket_compliance_conditional_holdSignifies whether new objects created in a bucket will be placed under conditional hold.
bucket_compliance_delete_after_retentionWhether or not objects should be deleted immediately once their retention period expires.
bucket_compliance_is_lockedSignifies whether the current bucket's compliance settings are locked or not.
bucket_compliance_lock_timeSpecifies when a bucket's compliance settings are locked.
bucket_compliance_retention_daysSpecifies the minimum number of days objects must be retained before they can be deleted.
bucket_compliance_statusWhether or not the a bucket has compliance settings enabled.
buckets_countThe number of records in the Buckets arrays.
buckets_creation_dateThe creation date of the bucket.
buckets_nameThe name of the bucket.
buckets_owner_display_nameThe display name of the bucket's owner.
buckets_owner_idThe Id of the bucket's owner.
content_dispositionContent disposition to send for an object.
content_typeContent type to send for an object.
encryption_algorithmThe encryption algorithm.
encryption_passwordThe encryption password.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the TCP port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
follow_redirectsDetermines what happens when the server issues a redirect.
idleThe current status of the class.
local_fileThe location of the local file.
local_hostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
metadata_countThe number of records in the Metadata arrays.
metadata_nameThe name of the metadata item.
metadata_valueThe value of the metadata item.
object_compliance_conditional_holdSpecifies whether an object is under conditional hold.
object_compliance_hashThe SHA-256 hash of an object, intended to be used to verify that it hasn't changed.
object_compliance_legal_holdSpecifies whether or not an object is under legal hold.
object_compliance_retention_timeThe retention time for a specific object.
object_dataThe data that was downloaded, or that should be uploaded.
object_delimiterThe delimiter string to use when listing objects.
object_markerA marker indicating what page of objects to return next.
object_prefixA prefix used to restrict the results returned when listing objects.
objects_countThe number of records in the Objects arrays.
objects_deletedWhether this object version is a delete marker.
objects_e_tagThe ETag of the object.
objects_last_modifiedThe last modified time of the object.
objects_latest_versionWhether this is the latest object version.
objects_nameThe name (key) of the object.
objects_owner_display_nameThe display name of the object's owner.
objects_owner_idThe Id of the object's owner.
objects_sizeThe size of the object.
objects_storage_classThe storage class of the object.
objects_upload_idThe upload Id of the multipart upload.
objects_version_idThe Id of the object version.
other_headersOther headers as determined by the user (optional).
overwriteDetermines if local files are overwritten.
parsed_header_countThe number of records in the ParsedHeader arrays.
parsed_header_fieldThis property contains the name of the HTTP header (same case as it is delivered).
parsed_header_valueThis property contains the header contents.
part_markerA marker indicating what page of parts to return next.
parts_countThe number of records in the Parts arrays.
parts_e_tagThe ETag of the part.
parts_last_modifiedThe last modified time of the part.
parts_object_nameThe name (key) of the object the part was uploaded for.
parts_owner_display_nameThe display name of the part's owner.
parts_owner_idThe Id of the part's owner.
parts_numberThe number of the part.
parts_sizeThe size of the part.
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the TCP port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use SSL for the connection to the proxy.
proxy_userThis property contains a user name, if authentication is to be used for the proxy.
query_param_countThe number of records in the QueryParam arrays.
query_param_nameThe name of the query parameter.
query_param_valueThe value of the query parameter.
rangeThe range of bytes to request.
regionThe region the class will make requests against.
secret_keyThe secret key to use for authentication.
ssl_accept_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_storeThe name of the certificate store for the client certificate.
ssl_cert_store_passwordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_typeThe type of certificate store for this certificate.
ssl_cert_subjectThe subject of the certificate used for client authentication.
ssl_server_cert_encodedThe certificate (PEM/base64 encoded).
start_byteThe byte offset from which to resume the upload or download.
timeoutA timeout for the class.
use_sslWhether to use SSL/TLS when connecting.
use_virtual_hostingDetermines which style request to use.
version_idThe object version to make requests against.
versioning_enabledControls whether versioning is enabled for the currently selected bucket.
version_markerA 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.

abort_multipart_uploadAborts a multipart upload.
add_metadataAdds a metadata item to the Metadata properties.
add_query_paramAdds a query parameter to the QueryParams properties.
append_objectAppends data onto an object on the server.
bucket_existsChecks whether the bucket exists.
complete_multipart_uploadCompletes a multipart upload by assembling previously uploaded parts.
compose_objectsCreates a composed object using multiple objects already on the server.
configSets or retrieves a configuration setting.
copy_objectCopies an object.
copy_partCopies the specified object as a part of a multipart upload.
create_bucketCreates a new bucket.
create_objectCreates a new object in the currently selected bucket.
delete_bucketDeletes a bucket.
delete_objectDeletes an object.
do_eventsProcesses events from the internal message queue.
get_bucket_locationGets a bucket's location.
get_complianceGets the compliance settings for the current bucket or an object in it.
get_linkCreates a link that provides access to an object for a specified amount of time.
get_objectDownloads an object.
get_object_infoGets an object's information and metadata.
interruptInterrupt the current method.
list_bucketsLists all buckets in the account.
list_multipart_uploadsLists the current multipart uploads.
list_objectsLists the objects in a bucket.
list_partsLists the parts in a multipart upload.
list_versionsLists the object versions in a bucket.
rename_bucketRenames a bucket.
rename_folderRenames a folder.
rename_objectRenames an object.
resetResets the class to its initial state.
reset_headersResets all HTTP headers, cookies, and LocalFile.
send_custom_requestSends a custom request to the server.
start_multipart_uploadStarts a new manual multipart upload.
update_bucket_aclUpdates a bucket's canned access policy.
update_complianceUpdates the compliance settings for the current bucket or an object in it.
update_object_aclUpdates an object's canned access policy.
upload_partUploads 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.

on_bucket_listFires once for each bucket returned when listing buckets.
on_end_transferFired when a document finishes transferring.
on_errorInformation about errors during data delivery.
on_fragment_completeFires after each part in an automatic multipart upload is complete.
on_headerFired every time a header line comes in.
on_logFires once for each log message.
on_metadata_listFires once for each metadata item returned when object information and metadata is retrieved.
on_object_listFires once for each object, object version, or multipart upload returned when listing such items.
on_part_listFires once for every part returned when listing a multipart upload's parts.
on_prefix_listFires once for each common prefix returned when listing objects.
on_progressFires during an upload or download to indicate transfer progress.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_start_transferFired when a document starts transferring (after the headers).
on_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.
AssumeRoleARNAmazon Resource Name used when assuming a role for authentication.
AssumeRoleDurationThe durration for role session in seconds.
AssumeRoleSessionNameUnique name for current role session.
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.
IfMatchCheck to make sure the object has not been modified since the last request.
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.
OverwriteOnRenameOverwrites objects on the server when renaming, if necessary.
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.
SessionTokenThe session token to send in the request when using temporary credentials.
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.
StoreObjectDataWhether class stores object data or not.
StorePrefixListWhether to store the common prefixes returned when listing objects.
TempPathThe path to the directory where temporary files are created.
URLIf set, the default URL will be overridden by this value.
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.
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.
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.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
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).
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.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
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.
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.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
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.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
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 Cloud 2020 Python Edition - Version 20.0 [Build 8265]