S3 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class cloudstorage.S3

Remarks

The S3 class allows you to access Amazon's Simple Storage Service (S3), as well as other S3-compatible services, in a secure manner using Secure Sockets Layer/Transport Layer Security (TLS/SSL). S3-like services allow you to store arbitrary data objects in various buckets and to 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.

S3 supports the following providers:

• Amazon S3
• Backblaze B2
• Cloudflare R2
• Digital Ocean Spaces
• Google Cloud Storage
• IBM Cloud Object Storage
• Linode Object Storage
• Oort DSS
• Oracle Cloud Object Storage
• Seagate Lyve Cloud
• Wasabi
• And more!

A "custom provider" option also allows you to interact with any S3-compatible API by specifying its base URL.

Getting Started

To begin, use the service_provider property to select the S3 service provider to use. Then, use the access_key and secret_key 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:

• Creating and deleting buckets: create_bucket and delete_bucket
• Checking whether a bucket exists, and its location: bucket_exists and get_bucket_location
• Listing buckets: list_buckets
• Updating a bucket's canned ACL: update_bucket_acl

Working with Objects

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

• Creating, downloading, and deleting objects: create_object, get_object, delete_object
• Copying objects: copy_object
• Listing objects, or getting information about a single object: list_objects, get_object_info
• Updating an object's canned ACL: update_object_acl

Working with Multipart Uploads

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

• Starting, completing, and aborting multipart uploads: start_multipart_upload, complete_multipart_upload, abort_multipart_upload
• Listing multipart uploads: list_multipart_uploads
• Uploading and copying parts: upload_part, copy_part
• Listing parts: list_parts

Cloudflare R2 Notes

The Cloudflare R2 service provider possesses the following unique requirements and characteristics:

• In addition to needing an access_key and secret_key, a CloudflareAccountID is also required to work with this provider.
• The region property is automatically set to "auto" when this service provider is selected, which is the only valid value.
• list_parts is not supported natively by Cloudflare R2, which means that the behavior of complete_multipart_upload changes when using this provider. Instead, calling upload_part or copy_part populates the LastPartInfo and PartInfo[i] configuration settings. complete_multipart_upload will then use the values in PartInfo[i] to complete the multipart upload.

Other Features

The S3 class also supports a variety of other features, including the following:

• Versioning support
• Object metadata manipulation
• Presigned link generation

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

access_key Property

This property includes the access key to use for authentication.

Syntax

def get_access_key() -> str: ...
def set_access_key(value: str) -> None: ...

access_key = property(get_access_key, set_access_key)

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and secret_key must be set before attempting any operations that connect to the server.

access_policy Property

This property includes the canned access policy to apply to a bucket or object.

Syntax

def get_access_policy() -> int: ...
def set_access_policy(value: int) -> None: ...

access_policy = property(get_access_policy, set_access_policy)

Default Value

0

Remarks

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

• copy_object (for the destination object)
• create_bucket
• create_object
• start_multipart_upload
• update_bucket_acl
• update_object_acl

The valid values are as follows:

Note: Most S3-compatible service providers support all of the canned access policies listed above, but some do not, or they have additional restrictions. Refer to the provider's documentation for more information.

bucket Property

This property selects a bucket.

Syntax

def get_bucket() -> str: ...
def set_bucket(value: str) -> None: ...

bucket = property(get_bucket, set_bucket)

Default Value

""

Remarks

This property selects a bucket, by name, for the class to operate against. It must be set before attempting most operations.

buckets_count Property

The number of records in the Buckets arrays.

Syntax

def get_buckets_count() -> int: ...

buckets_count = property(get_buckets_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• buckets_creation_date
• buckets_name
• buckets_owner_display_name
• buckets_owner_id

The array indices start at 0 and end at buckets_count - 1.

This property is read-only.

buckets_creation_date Property

The property includes the creation date of the bucket.

Syntax

def get_buckets_creation_date(buckets_index: int) -> str: ...

Default Value

""

Remarks

The property includes the creation date of the bucket.

This property reflects the creation date of the bucket.

The buckets_index parameter specifies the index of the item in the array. The size of the array is controlled by the buckets_count property.

This property is read-only.

buckets_name Property

The property contains the name of the bucket.

Syntax

def get_buckets_name(buckets_index: int) -> str: ...

Default Value

""

Remarks

The property contains the name of the bucket.

This property reflects the name of the bucket.

The buckets_index parameter specifies the index of the item in the array. The size of the array is controlled by the buckets_count property.

This property is read-only.

buckets_owner_display_name Property

The property contains the display name of the bucket's owner.

Syntax

def get_buckets_owner_display_name(buckets_index: int) -> str: ...

Default Value

""

Remarks

The property contains the display name of the bucket's owner.

This property reflects the display name of the bucket's owner.

The buckets_index parameter specifies the index of the item in the array. The size of the array is controlled by the buckets_count property.

This property is read-only.

buckets_owner_id Property

The property contains the Id of the bucket's owner.

Syntax

def get_buckets_owner_id(buckets_index: int) -> str: ...

Default Value

""

Remarks

The property contains the Id of the bucket's owner.

This property reflects the Id of the bucket's owner.

The buckets_index parameter specifies the index of the item in the array. The size of the array is controlled by the buckets_count property.

This property is read-only.

compression_method Property

Specifies an optional compression method.

Syntax

def get_compression_method() -> int: ...
def set_compression_method(value: int) -> None: ...

compression_method = property(get_compression_method, set_compression_method)

Default Value

0

Remarks

This property specifies an optional compression method to use when calling create_object or get_object. When set, the object data will be compressed or decompressed using the specified method. Possible values are:

• 0 (cmNone - default)
• 1 (cmDeflate)
• 2 (cmZlib)
• 3 (cmGzip)

content_disposition Property

This property includes content disposition to send for an object.

Syntax

def get_content_disposition() -> str: ...
def set_content_disposition(value: str) -> None: ...

content_disposition = property(get_content_disposition, set_content_disposition)

Default Value

""

Remarks

This property can be set before calling create_object to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server any time the object is downloaded.

content_type Property

This property includes the content type to send for an object.

Syntax

def get_content_type() -> str: ...
def set_content_type(value: str) -> None: ...

content_type = property(get_content_type, set_content_type)

Default Value

""

Remarks

This property can be set before calling create_object to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server any time the object is downloaded.

encryption_algorithm Property

This property includes the encryption algorithm.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are as follows:

encryption_password Property

This property includes the encryption password.

Syntax

def get_encryption_password() -> str: ...
def set_encryption_password(value: str) -> None: ...

encryption_password = property(get_encryption_password, set_encryption_password)

Default Value

""

Remarks

If this property is populated when create_object or get_object is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the specified value to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

It is also possible, however, to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, for example, the data need to be encrypted or decrypted by another utility that generates Key and IV values differently.

firewall_auto_detect Property

Whether to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

A password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

A username if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

follow_redirects Property

This property determines what happens when the server issues a redirect.

Syntax

def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...

follow_redirects = property(get_follow_redirects, set_follow_redirects)

Default Value

0

Remarks

This property specifies how the class should behave when the server returns a redirect response (e.g., "Object Moved"). Valid values are as follows:

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

local_file Property

This property includes the location of the local file.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property specifies the location of a file on a disk. This is used as the source file when calling create_object or upload_part; and as the destination file when calling get_object.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

metadata_count Property

The number of records in the Metadata arrays.

Syntax

def get_metadata_count() -> int: ...
def set_metadata_count(value: int) -> None: ...

metadata_count = property(get_metadata_count, set_metadata_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• metadata_name
• metadata_value

The array indices start at 0 and end at metadata_count - 1.

metadata_name Property

The property contains the name of the metadata item.

Syntax

def get_metadata_name(metadata_index: int) -> str: ...
def set_metadata_name(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The property contains the name of the metadata item.

This property specifies the name of the metadata item. The server stores metadata names in lowercase.

Note: The class will automatically prepend the service-appropriate prefix (e.g., x-amz-meta-, x-goog-meta-) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this property is populated.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_value Property

This property contains the value of the metadata item.

Syntax

def get_metadata_value(metadata_index: int) -> str: ...
def set_metadata_value(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the metadata item.

This property specifies the value of the metadata item.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

object_data Property

This property includes the data that were downloaded or that should be uploaded.

Syntax

def get_object_data() -> bytes: ...
def set_object_data(value: bytes) -> None: ...

object_data = property(get_object_data, set_object_data)

Default Value

""

Remarks

This property is populated with object data after calling get_object if local_file is not set.

This property also can be set before calling create_object or upload_part; its data will be uploaded if local_file is not set.

object_delimiter Property

This property includes the delimiter string to use when listing objects.

Syntax

def get_object_delimiter() -> str: ...
def set_object_delimiter(value: str) -> None: ...

object_delimiter = property(get_object_delimiter, set_object_delimiter)

Default Value

""

Remarks

If this property is nonempty when list_objects or list_versions is called, any objects (or object versions) whose names contain the same string between the specified object_prefix and the first occurrence of the specified delimiter that follow will be rolled up into a common prefix element, which is returned in place of the individual objects.

The on_prefix_list event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class also will populate the PrefixCount and Prefix[i] configuration settings.

Object Hierarchy Traversal

By using the object_delimiter and object_prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With object_delimiter set to /, we can set object_prefix to successively "deeper" values before calling list_objects or list_versions for the following effect:

object_marker Property

This property includes a marker indicating what page of objects to return next.

Syntax

def get_object_marker() -> str: ...
def set_object_marker(value: str) -> None: ...

object_marker = property(get_object_marker, set_object_marker)

Default Value

""

Remarks

This property will be populated when list_objects is called if the results are paged and there are more pages. To list all objects, continue to call list_objects until this property returns an empty string.

Refer to list_objects for more information.

Note: This property is cleared any time service_provider changes; marker values are valid only when used with the provider that generated them.

object_prefix Property

This property includes a prefix used to restrict the results returned when listing objects.

Syntax

def get_object_prefix() -> str: ...
def set_object_prefix(value: str) -> None: ...

object_prefix = property(get_object_prefix, set_object_prefix)

Default Value

""

Remarks

This property, if nonempty, is used to restrict the results returned by list_objects (or list_versions) to only those objects (or object versions) whose names begin with the given value.

Object Hierarchy Traversal

By using the object_delimiter and object_prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With object_delimiter set to /, we can set object_prefix to successively "deeper" values before calling list_objects or list_versions for the following effect:

objects_count Property

The number of records in the Objects arrays.

Syntax

def get_objects_count() -> int: ...

objects_count = property(get_objects_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• objects_deleted
• objects_e_tag
• objects_last_modified
• objects_latest_version
• objects_name
• objects_owner_display_name
• objects_owner_id
• objects_size
• objects_storage_class
• objects_upload_id
• objects_version_id

The array indices start at 0 and end at objects_count - 1.

This property is read-only.

objects_deleted Property

This property specifies whether this object version is a delete marker.

Syntax

def get_objects_deleted(objects_index: int) -> bool: ...

Default Value

FALSE

Remarks

This property specifies whether this object version is a delete marker.

This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to delete_object for more information.

This is applicable only when list_versions is called, or when get_object_info is called while version_id is nonempty.; False in all other cases.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_e_tag Property

This property contains the ETag of the object.

Syntax

def get_objects_e_tag(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the ETag of the object.

This property reflects the ETag of the object.

An object's ETag is an MD5 hash of its contents, and as such, it can be used to determine whether its contents have been modified.

This is not applicable when list_multipart_uploads is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_last_modified Property

This property contains the last modified time of the object.

Syntax

def get_objects_last_modified(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the last modified time of the object.

This property reflects the last modified time of the object.

This is not applicable when list_multipart_uploads is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_latest_version Property

This property specifies whether this is the latest object version.

Syntax

def get_objects_latest_version(objects_index: int) -> bool: ...

Default Value

TRUE

Remarks

This property specifies whether this is the latest object version.

This property indicates whether this object version is the latest version available.

This is applicable only when list_versions is called.; True in all other cases.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_name Property

This property contains the name (key) of the object.

Syntax

def get_objects_name(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name (key) of the object.

This property reflects the name (key) of the object.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_owner_display_name Property

This property contains the display name of the object's owner.

Syntax

def get_objects_owner_display_name(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the display name of the object's owner.

This property reflects the display name of the object's owner.

This is not applicable when get_object_info is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_owner_id Property

This property contains the Id of the object's owner.

Syntax

def get_objects_owner_id(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Id of the object's owner.

This property reflects the Id of the object's owner.

This is not applicable when get_object_info is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_size Property

This property contains the size of the object.

Syntax

def get_objects_size(objects_index: int) -> int: ...

Default Value

0

Remarks

This property contains the size of the object.

This property reflects the size of the object in bytes.

This is not applicable when list_multipart_uploads is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_storage_class Property

This property contains the storage class of the object.

Syntax

def get_objects_storage_class(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the storage class of the object.

This property reflects the storage class of the object.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_upload_id Property

This property contains the upload Id of the multipart upload.

Syntax

def get_objects_upload_id(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the upload Id of the multipart upload.

This property reflects the upload Id of the multipart upload.

It is applicable only when list_multipart_uploads is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_version_id Property

This property contains the Id of the object version.

Syntax

def get_objects_version_id(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Id of the object version.

This property reflects the Id of the object version.

Note: The string null is a valid version Id.

This is applicable only when list_versions is called, or when get_object_info is called while version_id is nonempty.; empty in all other cases.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

other_headers Property

Other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

overwrite Property

This property determines if local files are overwritten.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property controls whether local files are overwritten when calling get_object. It is applicable only to local files. The default value is False.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

part_marker Property

This property includes a marker indicating what page of parts to return next.

Syntax

def get_part_marker() -> str: ...
def set_part_marker(value: str) -> None: ...

part_marker = property(get_part_marker, set_part_marker)

Default Value

""

Remarks

This property will be populated when list_parts is called if the results are paged and there are more pages. To list all parts, continue to call list_parts until this property returns empty string.

Refer to list_parts for more information.

Note: This property is cleared any time service_provider changes; marker values are valid only when used with the provider that generated them.

parts_count Property

The number of records in the Parts arrays.

Syntax

def get_parts_count() -> int: ...

parts_count = property(get_parts_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parts_e_tag
• parts_last_modified
• parts_number
• parts_object_name
• parts_owner_display_name
• parts_owner_id
• parts_size

The array indices start at 0 and end at parts_count - 1.

This property is read-only.

parts_e_tag Property

This property contains the ETag of the part.

Syntax

def get_parts_e_tag(parts_index: int) -> str: ...

Default Value

""

Remarks

This property contains the ETag of the part.

This property reflects the ETag of the part.

The parts_index parameter specifies the index of the item in the array. The size of the array is controlled by the parts_count property.

This property is read-only.

parts_last_modified Property

This property contains the last modified time of the part.

Syntax

def get_parts_last_modified(parts_index: int) -> str: ...

Default Value

""

Remarks

This property contains the last modified time of the part.

This property reflects the last modified time of the part.

The parts_index parameter specifies the index of the item in the array. The size of the array is controlled by the parts_count property.

This property is read-only.

parts_object_name Property

This property contains the name (key) of the object that the part was uploaded for.

Syntax

def get_parts_object_name(parts_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name (key) of the object that the part was uploaded for.

This property reflects the name (key) of the object that the part was uploaded for.

The parts_index parameter specifies the index of the item in the array. The size of the array is controlled by the parts_count property.

This property is read-only.

parts_owner_display_name Property

This property contains the display name of the part's owner.

Syntax

def get_parts_owner_display_name(parts_index: int) -> str: ...

Default Value

""

Remarks

This property contains the display name of the part's owner.

This property reflects the display name of the part's owner.

The parts_index parameter specifies the index of the item in the array. The size of the array is controlled by the parts_count property.

This property is read-only.

parts_owner_id Property

This property contains the Id of the part's owner.

Syntax

def get_parts_owner_id(parts_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Id of the part's owner.

This property reflects the Id of the part's owner.

The parts_index parameter specifies the index of the item in the array. The size of the array is controlled by the parts_count property.

This property is read-only.

parts_number Property

This property contains the number of the part.

Syntax

def get_parts_number(parts_index: int) -> int: ...

Default Value

0

Remarks

This property contains the number of the part.

This property reflects the number of the part.

The parts_index parameter specifies the index of the item in the array. The size of the array is controlled by the parts_count property.

This property is read-only.

parts_size Property

This property contains the size of the part.

Syntax

def get_parts_size(parts_index: int) -> int: ...

Default Value

0

Remarks

This property contains the size of the part.

This property reflects the size of the part in bytes.

The parts_index parameter specifies the index of the item in the array. The size of the array is controlled by the parts_count property.

This property is read-only.

proxy_auth_scheme Property

The type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

Whether to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

A password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

A username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

query_param_count Property

The number of records in the QueryParam arrays.

Syntax

def get_query_param_count() -> int: ...
def set_query_param_count(value: int) -> None: ...

query_param_count = property(get_query_param_count, set_query_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

The array indices start at 0 and end at query_param_count - 1.

query_param_name Property

This property specifies the name of the query parameter.

Syntax

def get_query_param_name(query_param_index: int) -> str: ...
def set_query_param_name(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property specifies the name of the query parameter.

This property specifies the name of the query parameter.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

query_param_value Property

This property contains the value of the query parameter.

Syntax

def get_query_param_value(query_param_index: int) -> str: ...
def set_query_param_value(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL encode this value when sending the request.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

range Property

This property includes the range of bytes to request.

Syntax

def get_range() -> str: ...
def set_range(value: str) -> None: ...

range = property(get_range, set_range)

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is nonempty when a get_object request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

Following are the two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the start_byte property is greater than zero when get_object is called (i.e., when a download is being resumed), and this property is nonempty, the class will automatically advance the StartByte value in the specified range by start_byte bytes when sending the Range header to the server. This ensures that the previously downloaded data at the start of the specified range are not downloaded again when the download is resumed.

region Property

This property includes the region the class will make requests against.

Syntax

def get_region() -> str: ...
def set_region(value: str) -> None: ...

region = property(get_region, set_region)

Default Value

"us-east-1"

Remarks

This property controls which region the class will make requests against; it should be changed to create or access resources in other regions.

Each service provider has a different default region, and the class will automatically set this property to the selected service provider's default region anytime service_provider changes. The custom service provider's "default region" is an empty string (i.e., setting service_provider to spCustom (255) will clear this property).

Note: When the custom service provider is selected, the class uses the base URL specified by the ServiceProviderURL configuration setting to generate request URLs. If the base URL contains a %region% token, the class will replace it with this property's value any time it generates a request URL. Refer to the ServiceProviderURL setting's documentation for more information.

Amazon S3 Regions

Alibaba Cloud Object Storage Regions

Backblaze B2 Regions

All Backblaze B2 region strings take the form us-west-###, where ### is a three-digit number. By default, the class uses us-west-000.

To determine the exact region string, log into the Backblaze B2 web console and refer to the "S3 Endpoint" value, which corresponds to the application keypair that will be used for authentication; this endpoint value will include the region string.

Note: The master application key for a Backblaze B2 account cannot be used with Backblaze's S3-compatible API; create a nonmaster application key if necessary.

Cloudflare R2 Regions

By default, the class uses auto. This is the only valid value for this service provider.

Digital Ocean Spaces Regions

Google Cloud Storage Regions

An asterisk (*) denotes a multiregional location.

Huawei Cloud Object Storage Regions

IBM Cloud Object Storage Regions

Note: Optionally, private. or direct. may be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.

Linode Object Storage Regions

Important: Each "region" supported by Linode's Object Storage service is actually a completely standalone storage cluster. These clusters do not interact with each other in any way, which causes the following nonstandard behaviors:

• Bucket names may be reused in each region (however, they must still be "globally" unique within each region).
• The list_buckets method will return only those buckets located in the currently selected region; there is no way to retrieve a list of all regions' buckets.
• Similarly, the bucket_exists and get_bucket_location methods consider only those buckets located in the currently selected region.
• The copy_object method cannot be used to copy objects to a bucket in another region.

Oracle Cloud Object Storage Regions

Wasabi Regions

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value for the currently selected service_provider.

secret_key Property

This property includes the secret key to use for authentication.

Syntax

def get_secret_key() -> str: ...
def set_secret_key(value: str) -> None: ...

secret_key = property(get_secret_key, set_secret_key)

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and access_key must be set before attempting any operations that connect to the server.

service_provider Property

This property includes the S3 service provider to use.

Syntax

def get_service_provider() -> int: ...
def set_service_provider(value: int) -> None: ...

service_provider = property(get_service_provider, set_service_provider)

Default Value

0

Remarks

This property specifies the S3 service provider that the class should use. Possible values are as follows:

Note: The following providers require additional configuration before requests can be made:

• spOracle (8): An Object Storage Namespace must be specified using the OracleNamespace configuration setting.
• spCloudflareR2 (10): An Account ID must be specified using the CloudflareAccountID configuration setting.
• spCustom (255): A base URL must be specified using the ServiceProviderURL configuration setting.

Changing this property will automatically result in the following actions:

• Set the region property to the default region for the provider (empty string for spCustom (255)).
• Reset the use_ssl property to True.
• Reset the start_byte property to 0.
• Clear the object_marker, part_marker, and version_marker properties, as well as the StorageClass and ResumableUploadState configuration settings.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_provider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

start_byte Property

This property includes the byte offset from which to resume the upload or download.

Syntax

def get_start_byte() -> int: ...
def set_start_byte(value: int) -> None: ...

start_byte = property(get_start_byte, set_start_byte)

Default Value

0

Remarks

This property specifies the byte offset from which to resume an automatic multipart upload initiated by create_object, or a download initiated by get_object. Refer to those methods' documentation for more information about resuming uploads and downloads.

Note: This property is automatically reset to 0 anytime service_provider changes.

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

use_ssl Property

This method includes whether to use SSL/TLS when connecting.

Syntax

def get_use_ssl() -> bool: ...
def set_use_ssl(value: bool) -> None: ...

use_ssl = property(get_use_ssl, set_use_ssl)

Default Value

TRUE

Remarks

This property specifies whether the class should use Secure Sockets Layer/Transport Layer Security (SSL/TLS) when connecting.

Note: This property is automatically reset to True any time service_provider changes. The class will ignore any attempts to change this property if one of the following providers is selected, because they require SSL/TLS to be used:

• spDigitalOcean (1)
• spBackblazeB2 (4)
• spOracle (8)
• spSeagateLyveCloud (11)

use_virtual_hosting Property

This property determines which URL style to use when making requests.

Syntax

def get_use_virtual_hosting() -> bool: ...
def set_use_virtual_hosting(value: bool) -> None: ...

use_virtual_hosting = property(get_use_virtual_hosting, set_use_virtual_hosting)

Default Value

TRUE

Remarks

If True (default), virtual-hosted-style URLs will be used to make requests: http://yourbucket.s3.amazonaws.com/yourobject.

Note: Hosted-style URLs impose more bucket name restrictions because of DNS server naming restrictions. Refer to Amazon's documentation for more information.

If False, path-style URLs will be used to make requests: http://s3.amazonaws.com/yourbucket/yourobject.

Note: When using the spAmazonS3 (0) service provider, keep in mind that Amazon has publicly announced that buckets created after September 30, 2020, will only support virtual-hosted-style URLs. Buckets created on or before September 30, 2020, will continue to support both URL styles.

Note: This property is ignored when service_provider is set to one of the following:

• spAlibaba (6) Alibaba does not support path-style URLs, only virtual-hosted-style URLs.
• spOracle (8) Oracle Cloud Object Storage does not support virtual-hosted-style URLs, only path-style URLs.
• spOortDSS (12) Oort DSS does not support virtual-hosted-style URLs, only path-style URLs.

version_id Property

This property includes the object version to make requests against.

Syntax

def get_version_id() -> str: ...
def set_version_id(value: str) -> None: ...

version_id = property(get_version_id, set_version_id)

Default Value

""

Remarks

This property can be set to the Id of a specific object version before calling the following methods to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:

• copy_object (to copy from a specific object version)
• delete_object
• get_link (to build a link for a specific object version)
• get_object
• get_object_info
• send_custom_request
• update_object_acl

Refer to Amazon's Versioning documentation for more information about versioning.

version_marker Property

This property includes a marker indicating what page of object versions to return next.

Syntax

def get_version_marker() -> str: ...
def set_version_marker(value: str) -> None: ...

version_marker = property(get_version_marker, set_version_marker)

Default Value

""

Remarks

This property will be populated when list_versions is called if the results are paged and there are more pages. To list all object versions, continue to call list_versions until this property returns empty string.

Refer to list_versions for more information.

Note: This property is cleared any time service_provider changes; marker values are valid only when used with the provider that generated them.

abort_multipart_upload Method

This method aborts a multipart upload.

Syntax

def abort_multipart_upload(object_name: str, upload_id: str) -> None: ...

Remarks

This method aborts the multipart upload of the object named ObjectName specified by UploadId.

When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server.

Note: If any part of the upload is currently in progress, it may be necessary to call this method again after the upload is complete.

If this method is called successfully, the specified UploadId will no longer be valid.

add_metadata Method

Adds a metadata item to the Metadata properties.

Syntax

def add_metadata(name: str, value: str) -> None: ...

Remarks

This method adds a metadata item to the metadata properties. Name specifies the name of the item, and Value specifies the value of the item. The server stores metadata names in lowercase.

If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-), it will be stripped off. The class will take care of prepending it when sending metadata to the server.

add_query_param Method

This method adds a query parameter to the QueryParams properties.

Syntax

def add_query_param(name: str, value: str) -> None: ...

Remarks

This method is used to add a query parameter to the query_params properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

append_object Method

This method appends data to the end of the existing object specified by ObjectName .

Syntax

def append_object(object_name: str) -> None: ...

Remarks

The data to upload are taken from either or object_data (whichever data are found first, when checked in that order).

bucket_exists Method

This method checks whether the bucket exists.

Syntax

def bucket_exists() -> bool: ...

Remarks

This method checks whether the bucket specified by bucket exists, returning True if so or False if not.

Note: When service_provider is spLinode (9), this method considers only buckets located in the currently selected region. Refer to the Linode section of the region property's documentation for more information.

check_versioning_enabled Method

This method checks whether versioning is enabled for the currently selected bucket.

Syntax

def check_versioning_enabled() -> bool: ...

Remarks

This method can be used to check whether the bucket currently selected by bucket has versioning enabled.

Note: If bucket is empty, or refers to a bucket that does not exist, this property will always return False when queried, and any attempts to set it will fail. This behavior also occurs if the currently selected service provider does not support versioning at all.

Refer to Amazon's Versioning documentation for more information about versioning.

Note: When service_provider is spBackblazeB2 (4), this property will always return True (assuming bucket is nonempty), and any attempt to change it will fail; Backblaze B2 buckets are always versioned.

complete_multipart_upload Method

This method completes a multipart upload by assembling previously uploaded parts.

Syntax

def complete_multipart_upload(object_name: str, upload_id: str) -> None: ...

Remarks

This method completes the multipart upload specified by UploadId. The server will assemble all of the parts that have been uploaded into an object named ObjectName.

Note: This method automatically calls list_parts internally to obtain the information needed to complete the multipart upload. This process does not alter the parts properties, nor does it cause the on_part_list event to fire. The spCloudflareR2 (10) service_provider does not support the ListParts S3 operation; thus, when that provider is selected, this method instead relies on the part information contained in the PartInfo[i] configuration setting.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

copy_object Method

This method copies an object.

Syntax

def copy_object(src_object_name: str, dest_bucket: str, dest_object_name: str) -> None: ...

Remarks

This method copies the object specified by SrcObjectName (in the bucket currently selected by bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by bucket is used as the destination bucket.

If the version_id property is nonempty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.

If any metadata items are present in the metadata properties, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.

Notes:

• Objects may be copied only to buckets that exist within the same region.
• Objects larger than 5 GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using start_multipart_upload. Then use the copy_part method to create parts for that multipart upload using the source object's data.

copy_part Method

This method copies the specified object as a part of a multipart upload.

Syntax

def copy_part(src_object_name: str, dest_bucket: str, dest_object_name: str, dest_part_number: int, dest_upload_id: str) -> None: ...

Remarks

This method copies data from the object specified by SrcObjectName (in the bucket currently selected by bucket) to a new multipart upload part for DestObjectName in DestBucket.

The DestPartNumber and DestUploadId parameters should be used in the same manner as the upload_part method's PartNumber and UploadId parameters.

To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.

Note: This method is not supported when service_provider is spGoogleStorage (2).

create_bucket Method

This method creates a new bucket.

Syntax

def create_bucket() -> None: ...

Remarks

This method creates a new bucket using the name specified by the bucket property. The bucket is created in the region specified by the region property.

create_object Method

This method creates a new object in the currently selected bucket.

Syntax

def create_object(object_name: str) -> None: ...

Remarks

This method creates a new object named Object in the bucket currently selected by bucket. If any metadata items are present in the metadata properties, they will be included in the creation request.

If local_file is set, the file will be uploaded from the specified path. If local_file is not set, the data in object_data will be used.

To encrypt the file before uploading it, set encryption_algorithm and encryption_password.

This method can automatically handle the multipart upload of objects (see below). If it is desired to manually take control of the multipart upload process, see start_multipart_upload.

Automatic Multipart Uploads

If more than SimpleUploadLimit bytes of data are provided, the class will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the class automatically makes calls to start_multipart_upload, upload_part, and complete_multipart_upload internally; tracks the upload state information using the ResumableUploadState configuration setting; and tracks how much data have been uploaded using the start_byte property. The on_fragment_complete event will fire after each part is uploaded.

If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and start_byte contain the same values as they did when the upload was interrupted.

When an automatic multipart upload completes successfully, ResumableUploadState is cleared and start_byte is reset to 0.

delete_bucket Method

This method deletes a bucket.

Syntax

def delete_bucket() -> None: ...

Remarks

This method deletes the bucket currently selected by bucket.

Note: For some service providers, bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime. Refer to the provider's documentation for more information.

delete_object Method

This method deletes an object.

Syntax

def delete_object(object_name: str) -> None: ...

Remarks

This method deletes the object specified by ObjectName in the bucket currently selected by bucket.

If the version_id property is nonempty, this method deletes the specified version of the object instead.

Deleting Versioned Objects

If a bucket has versioning enabled (i.e., check_versioning_enabled returns True when queried), and this method is called on an object rather than a specific object version, then instead of actually deleting any data, the server will simply create a special object version called a delete marker.

If an object's latest version is a delete marker, then the server treats the object as if it did not exist (i.e., it does not appear when listing objects or it cannot be downloaded). If, however, all of the previous versions of the object (including the one that existed just before the delete marker was created) still exist, then they can be listed using list_versions and explicitly can be interacted with by setting version_id and calling an appropriate method.

To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting version_id before calling this method. This includes any delete marker versions, which can be deleted like any other version.

Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.

disable_versioning Method

This method disables versioning for the currently selected bucket.

Syntax

def disable_versioning() -> None: ...

Remarks

This method can be used to disable versioning for the bucket currently selected by bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

enable_versioning Method

This method enables versioning for the currently selected bucket.

Syntax

def enable_versioning() -> None: ...

Remarks

This method can be used to enable versioning for the bucket currently selected by bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

get_bucket_location Method

This method gets a bucket's location.

Syntax

def get_bucket_location() -> str: ...

Remarks

This method retrieves and returns the location (i.e., region) of the bucket currently selected by bucket.

Note: When service_provider is spLinode (9), this method considers only buckets located in the currently selected region. Refer to the Linode section of the region property's documentation for more information.

get_link Method

This method creates a link that provides access to an object for a specified amount of time.

Syntax

def get_link(object_name: str, expires: int) -> str: ...

Remarks

This method creates and returns a preauthenticated link that provides access to the object specified by ObjectName in the bucket currently selected by bucket. If the version_id property is nonempty, a link is created for the specified version of the object.

The Expires parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days.

Note: This method is an offline method that simply generates a presigned URL; no communication with the server takes place.

Note: This method is not supported when service_provider is set to one of the following:

• spGoogleStorage (2)
• spOracle (8)

get_object Method

This method downloads an object.

Syntax

def get_object(object_name: str) -> None: ...

Remarks

This methods downloads the object specified by ObjectName in the bucket currently selected by bucket. If the version_id property is nonempty, the specified version of the object is downloaded instead. The range property can be used to download a specific range of bytes from the object.

If local_file is set, the object data will be saved to the specified location; otherwise, the object data will be held by object_data.

To download and decrypt an encrypted object, set encryption_algorithm and encryption_password before calling this method.

Download Notes

In the simplest use-case, downloading an object looks like this: s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name);

Example 1. Resuming Downloads:

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; s3.LocalFile = downloadFile; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded file s3.StartByte = new FileInfo(downloadFile).Length; s3.GetObject(s3.Objects[0].Name);

Example 2. Resuming Encrypted File Downloads:

Resuming encrypted file downloads is supported only when local_file has been set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data are downloaded, it will be decrypted and written to local_file. s3.LocalFile = "../MyData.zip"; s3.EncryptionPassword = "password"; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded temp file s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length; s3.GetObject(s3.Objects[0].Name);

get_object_info Method

This method gets an object's information and metadata.

Syntax

def get_object_info(object_name: str) -> None: ...

Remarks

This method gets information and metadata for the object specified by Object in the bucket currently selected by bucket. If the version_id property is nonempty, information and metadata for the specified version of the object is retrieved instead.

Calling this method will fire the on_object_list and on_metadata_list events and also will repopulate the objects and metadata collection properties.

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_buckets Method

This method lists all buckets in the account.

Syntax

def list_buckets() -> None: ...

Remarks

This method lists all buckets in the account.

Calling this method will fire the on_bucket_list event once for each bucket and also will populate the buckets properties.

Note: When service_provider is spLinode (9), this method returns only buckets located in the currently selected region, and it is not possible to retrieve a list of all regions' buckets. Refer to the Linode section of the region property's documentation for more information.

list_multipart_uploads Method

This method lists the current multipart uploads.

Syntax

def list_multipart_uploads() -> None: ...

Remarks

This method lists the current multipart uploads in the bucket currently selected by bucket.

Before calling this method, the object_prefix property may be set to restrict the results to only the multipart uploads whose names begin with a given string. The object_delimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the on_object_list event once for each multipart upload and also will populate the objects properties.

If more multipart uploads are still available to list when this method returns, the object_marker property will be populated. Continue to call this method until object_marker is empty to accumulate all of the pages of results in the objects properties.

Note: This method is not supported when service_provider is spOortDSS (12).

Note: When the service_provider is spSeagateLyveCloud (11) the object_prefix property must be specified.

list_objects Method

This method lists the objects in a bucket.

Syntax

def list_objects() -> None: ...

Remarks

This method lists the objects in the bucket currently selected by bucket.

Before calling this method, the object_prefix property may be set to restrict the results to only those objects whose names begin with a given string. The object_delimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the on_object_list event once for each object and also will populate the objects properties. It also may fire the on_prefix_list event and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If more objects are still available to list when this method returns, the object_marker property will be populated. Continue to call this method until object_marker is empty to accumulate all of the pages of results in the objects properties.

Object Hierarchy Traversal

By using the object_delimiter and object_prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With object_delimiter set to /, we can set object_prefix to successively "deeper" values before calling list_objects or list_versions for the following effect:

list_parts Method

This method lists the parts in a multipart upload.

Syntax

def list_parts(object_name: str, upload_id: str) -> None: ...

Remarks

This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.

Calling this method will fire the on_part_list event once for each part and also will populate the parts properties.

If more parts are still available to list when this method returns, the part_marker property will be populated. Continue to call this method until part_marker is empty to accumulate all of the pages of results in the parts properties.

This method does not need to be called before attempting to complete a multipart upload with complete_multipart_upload; the class will automatically collect the necessary information internally. Refer to complete_multipart_upload for more information.

Note: spCloudflareR2 (10) does not support the ListParts S3 operation.

list_versions Method

This method lists the object versions in a bucket.

Syntax

def list_versions() -> None: ...

Remarks

This method lists the object versions in the bucket currently selected by bucket.

Before calling this method, the object_prefix property may be set to restrict the results to only the object versions whose names begin with a given string. The object_delimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the on_object_list event once for each object version and also will populate the objects properties. It also may fire the on_prefix_list event and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If more object versions are still available to list when this method returns, the version_marker property will be populated. Continue to call this method until version_marker is empty to accumulate all pages of results in the objects properties.

Object Hierarchy Traversal

By using the object_delimiter and object_prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With object_delimiter set to /, we can set object_prefix to successively "deeper" values before calling list_objects or list_versions for the following effect:

reset Method

This method resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

reset_headers Method

This method resets all HTTP headers, cookies, and LocalFile.

Syntax

def reset_headers() -> None: ...

Remarks

This method resets all HTTP headers as well as local_file to "" (empty string), and clears the metadata and query_params collection properties.

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next request.

send_custom_request Method

This method sends a custom request to the server.

Syntax

def send_custom_request(http_method: str, object_name: str, request_body: str) -> None: ...

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are as follows:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The ObjectName and RequestBody parameters may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, based on the following:
   • use_ssl, region, and use_virtual_hosting for the base URL.
     • Alternatively, if service_provider is spCustom (255), the custom URL specified using the ServiceProviderURL configuration setting is used directly, and these properties are ignored.
   • bucket (if nonempty)
   • ObjectName (if nonempty)
   • version_id (if both it and ObjectName are nonempty)
   • query_params
2. Adds request headers from the following:
   • content_disposition
   • content_type
   • other_headers
   • SessionToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if nonempty.
5. Stores the response headers in the parsed_headers properties; and the response body in the specified local_file, or object_data (using the same logic as get_object).

If the response body is XML data, then the XPath, XText, and other X* configuration settings can be used to navigate and extract information from it.

start_multipart_upload Method

This method starts a new manual multipart upload.

Syntax

def start_multipart_upload(object_name: str) -> str: ...

Remarks

This method starts a new manual multipart upload for an object named ObjectName, in the bucket currently selected by bucket, and returns the upload Id that the server associates with it. For an automatic multipart upload, see the create_object method. This upload Id can then be used to call the following methods:

• upload_part
• copy_part
• list_parts
• complete_multipart_upload
• abort_multipart_upload

If any metadata items are present in the metadata properties, they will be included in the creation request and will be applied to the final object after the multipart upload is completed with complete_multipart_upload.

Multipart uploads never expire, they must be explicitly completed or aborted using complete_multipart_upload or abort_multipart_upload. The list_multipart_uploads method can be used to retrieve a list of current multipart uploads.

update_bucket_acl Method

This method updates a bucket's canned access policy.

Syntax

def update_bucket_acl() -> None: ...

Remarks

This method updates the canned access policy of the bucket selected by bucket to the value specified by access_policy

update_object_acl Method

This method updates an object's canned access policy.

Syntax

def update_object_acl(object_name: str) -> None: ...

Remarks

This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by bucket, to the value specified by access_policy.

If the version_id property is nonempty, the canned access policy of the specified version of the object is updated instead.

upload_part Method

This method uploads a multipart upload part.

Syntax

def upload_part(object_name: str, part_number: int, upload_id: str) -> None: ...

Remarks

This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.

PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly uploaded part.

The data to upload are taken from either local_file or object_data (whichever data are found first, when checked in that order). Each part must be at least 5 MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.

If the IncludePartMD5 configuration setting is True, the class will include an MD5 digest of its data when sending it to the server. The server then will verify that the data were received without corruption.

on_bucket_list Event

This event fires once for each bucket returned when listing buckets.

Syntax

class S3BucketListEventParams(object):
  @property
  def bucket_name() -> str: ...

  @property
  def creation_date() -> str: ...

  @property
  def owner_id() -> str: ...

  @property
  def owner_name() -> str: ...

# In class S3:
@property
def on_bucket_list() -> Callable[[S3BucketListEventParams], None]: ...
@on_bucket_list.setter
def on_bucket_list(event_hook: Callable[[S3BucketListEventParams], None]) -> None: ...

Remarks

This event fires once for each bucket returned when list_buckets is called.

BucketName reflects the name of the bucket.

CreationDate reflects the bucket's creation date.

OwnerId and OwnerName reflect the Id and display the name of the bucket's owner, respectively.

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class S3EndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class S3:
@property
def on_end_transfer() -> Callable[[S3EndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[S3EndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class S3ErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class S3:
@property
def on_error() -> Callable[[S3ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[S3ErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_fragment_complete Event

This event fires after each part in an automatic multipart upload is complete.

Syntax

class S3FragmentCompleteEventParams(object):
  @property
  def fragment_number() -> int: ...

  @property
  def fragment_count() -> int: ...

  @property
  def interrupt() -> bool: ...
  @interrupt.setter
  def interrupt(value) -> None: ...

# In class S3:
@property
def on_fragment_complete() -> Callable[[S3FragmentCompleteEventParams], None]: ...
@on_fragment_complete.setter
def on_fragment_complete(event_hook: Callable[[S3FragmentCompleteEventParams], None]) -> None: ...

Remarks

If, when create_object is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically divide the upload data into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current part of the upload that has been completed. This value starts at 1.

FragmentCount is the total number of parts that will be uploaded.

Interrupt can be set to True to interrupt the upload. The upload may be resumed later.

Refer to create_object for more information.

on_header Event

Fired every time a header line comes in.

Syntax

class S3HeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class S3:
@property
def on_header() -> Callable[[S3HeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[S3HeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

Fired once for each log message.

Syntax

class S3LogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class S3:
@property
def on_log() -> Callable[[S3LogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[S3LogEventParams], None]) -> None: ...

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_metadata_list Event

This event fires once for each metadata item returned when object information and metadata are retrieved.

Syntax

class S3MetadataListEventParams(object):
  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

# In class S3:
@property
def on_metadata_list() -> Callable[[S3MetadataListEventParams], None]: ...
@on_metadata_list.setter
def on_metadata_list(event_hook: Callable[[S3MetadataListEventParams], None]) -> None: ...

Remarks

This event fires once for each metadata item returned when get_object_info is called.

Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-).

Note: The server stores metadata names in lowercase.

Value is the metadata item's value.

on_object_list Event

This event fires once for each object, object version, or multipart upload returned when listing such items.

Syntax

class S3ObjectListEventParams(object):
  @property
  def bucket_name() -> str: ...

  @property
  def object_name() -> str: ...

  @property
  def last_modified() -> str: ...

  @property
  def size() -> int: ...

  @property
  def e_tag() -> str: ...

  @property
  def owner_id() -> str: ...

  @property
  def owner_name() -> str: ...

  @property
  def upload_id() -> str: ...

  @property
  def version_id() -> str: ...

  @property
  def latest_version() -> bool: ...

  @property
  def deleted() -> bool: ...

# In class S3:
@property
def on_object_list() -> Callable[[S3ObjectListEventParams], None]: ...
@on_object_list.setter
def on_object_list(event_hook: Callable[[S3ObjectListEventParams], None]) -> None: ...

Remarks

This event fires once for each object, object version, or multipart upload returned when get_object_info, list_objects, list_versions, or list_multipart_uploads is called.

BucketName reflects the name of the bucket that the object is in.

ObjectName reflects the name of the object.

LastModified reflects the last modified time of the object. This is not applicable when list_multipart_uploads is called.

Size reflects the size, in bytes, of the object. This is not applicable when list_multipart_uploads is called.

ETag reflects the object's ETag. This is not applicable when list_multipart_uploads is called.

OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. This is not applicable when get_object_info is called.

UploadId reflects the Id of the multipart upload. This is applicable only when list_multipart_uploads is called.

VersionId reflects the Id of the object version (note that the string null is a valid version Id). This is applicable only when list_versions is called, or when get_object_info is called while version_id is nonempty.; is empty in all other cases.

LatestVersion indicates whether this is the latest object version. This is applicable only when list_versions is called.; is True in all other cases.

Deleted indicates whether this object version is a delete marker (refer to delete_object for more information). This is applicable only when list_versions is called, or when get_object_info is called while version_id is nonempty.; is False in all other cases.

on_part_list Event

This event fires once for every part returned when listing a multipart upload's parts.

Syntax

class S3PartListEventParams(object):
  @property
  def part_number() -> int: ...

  @property
  def object_name() -> str: ...

  @property
  def last_modified() -> str: ...

  @property
  def size() -> int: ...

  @property
  def e_tag() -> str: ...

  @property
  def owner_id() -> str: ...

  @property
  def owner_name() -> str: ...

# In class S3:
@property
def on_part_list() -> Callable[[S3PartListEventParams], None]: ...
@on_part_list.setter
def on_part_list(event_hook: Callable[[S3PartListEventParams], None]) -> None: ...

Remarks

This event fires once for each part of a multipart upload that is returned when list_parts is called.

PartNumber reflects the part's number.

ObjectName reflects the name of the object the multipart upload is for.

LastModified reflects the last modified time of the part.

Size reflects the size, in bytes, of the part.

ETag reflects the part's ETag of the part.

OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.

on_prefix_list Event

This event fires once for each common prefix returned when listing objects.

Syntax

class S3PrefixListEventParams(object):
  @property
  def bucket_name() -> str: ...

  @property
  def prefix() -> str: ...

# In class S3:
@property
def on_prefix_list() -> Callable[[S3PrefixListEventParams], None]: ...
@on_prefix_list.setter
def on_prefix_list(event_hook: Callable[[S3PrefixListEventParams], None]) -> None: ...

Remarks

This event fires once for each common prefix returned when list_objects or list_versions is called when object_delimiter is nonempty. Refer to object_delimiter for more information.

BucketName reflects the name of the bucket that the prefix is in.

Prefix is the common prefix.

on_progress Event

This event fires during an upload or download to indicate transfer progress.

Syntax

class S3ProgressEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def total_bytes() -> int: ...

  @property
  def percent_done() -> int: ...

# In class S3:
@property
def on_progress() -> Callable[[S3ProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[S3ProgressEventParams], None]) -> None: ...

Remarks

This event fires during an upload or download to indicate the progress of the transfer. By default, this event will fire each time PercentDone increases by 1 percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see the note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that were transferred before the interruption.

For example, if 10 MB of data were successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10 MB) when the transfer is first resumed, and then will continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class S3SSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class S3:
@property
def on_ssl_server_authentication() -> Callable[[S3SSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[S3SSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class S3SSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class S3:
@property
def on_ssl_status() -> Callable[[S3SSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[S3SSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer Event

This event fires when a document starts transferring (after the headers).

Syntax

class S3StartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class S3:
@property
def on_start_transfer() -> Callable[[S3StartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[S3StartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

class S3TransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class S3:
@property
def on_transfer() -> Callable[[S3TransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[S3TransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

S3 Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

S3 Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

S3 Errors

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors