l.s.d.s.S3StorageDriver(StorageDriver) : class documentation

Return a generator of containers for the given account

@return: A generator of Container instances.
@rtype: C{generator} of L{Container}

Return a generator of objects for the given container.

@param container: Container instance
@type container: L{Container}

@return: A generator of Object instances.
@rtype: C{generator} of L{Object}

Return a container instance.

@param container_name: Container name.
@type container_name: C{str}

@return: L{Container} instance.
@rtype: L{Container}

Return an object instance.

@param container_name: Container name.
@type  container_name: C{str}

@param object_name: Object name.
@type  object_name: C{str}

@return: L{Object} instance.
@rtype: L{Object}

Return a container path

@param container: Container instance
@type  container: L{Container}

@return: A path for this container.
@rtype: C{str}

Return an object's CDN path.

@param container: Container instance
@type  container: L{Container}

@param object_name: Object name
@type  object_name: L{str}

@return: A  path for this object.
@rtype: C{str}

Create a new container.

@type container_name: C{str}
@param container_name: Container name.

@return: C{Container} instance on success.
@rtype: L{Container}

Delete a container.

@type container: L{Container}
@param container: Container instance

@return: True on success, False otherwise.
@rtype: C{bool}

Download an object to the specified destination path.

@param obj: Object instance.
@type obj: L{Object}

@param destination_path: Full path to a file or a directory where the
                        incoming file will be saved.
@type destination_path: C{str}

@param overwrite_existing: True to overwrite an existing file,
    defaults to False.
@type overwrite_existing: C{bool}

@param delete_on_failure: True to delete a partially downloaded file if
the download was not successful (hash mismatch / file size).
@type delete_on_failure: C{bool}

@return: True if an object has been successfully downloaded, False
otherwise.
@rtype: C{bool}

Return a generator which yields object data.

@param obj: Object instance
@type obj: L{Object}

@param chunk_size: Optional chunk size (in bytes).
@type chunk_size: C{int}

@rtype: C{object}

@inherits: L{StorageDriver.upload_object}

@param ex_storage_class: Storage class
@type ex_storage_class: C{str}

Callback invoked for uploading data to S3 using Amazon's
multipart upload mechanism

@param response: Response object from the initial POST request
@type response: L{S3RawResponse}

@param data: Any data from the initial POST request
@type data: C{str}

@param iterator: The generator for fetching the upload data
@type iterator: C{generator}

@param container: The container owning the object to which data is
    being uploaded
@type container: L{Container}

@param object_name: The name of the object to which we are uploading
@type object_name: C{str}

@keyword calculate_hash: Indicates if we must calculate the data hash
@type calculate_hash: C{bool}

@return: A tuple of (status, checksum, bytes transferred)
@rtype: C{tuple}

Uploads data from an interator in fixed sized chunks to S3

@param iterator: The generator for fetching the upload data
@type iterator: C{generator}

@param object_path: The path of the object to which we are uploading
@type object_name: C{str}

@param upload_id: The upload id allocated for this multipart upload
@type upload_id: C{str}

@keyword calculate_hash: Indicates if we must calculate the data hash
@type calculate_hash: C{bool}

@return: A tuple of (chunk info, checksum, bytes transferred)
@rtype: C{tuple}

Makes a final commit of the data.

@param object_path: Server side object path.
@type object_path: C{str}

@param upload_id: ID of the multipart upload.
@type upload_id: C{str}

@param upload_id: A list of (chunk_number, chunk_hash) tuples.
@type upload_id: C{list}

Aborts an already initiated multipart upload

@param object_path: Server side object path.
@type object_path: C{str}

@param upload_id: ID of the multipart upload.
@type upload_id: C{str}

@inherits: L{StorageDriver.upload_object_via_stream}

@param ex_storage_class: Storage class
@type ex_storage_class: C{str}

Delete an object.

@type obj: L{Object}
@param obj: Object instance.

@return: C{bool} True on success.
@rtype: C{bool}

Extension method for listing all in-progress S3 multipart uploads.

Each multipart upload which has not been committed or aborted is
considered in-progress.

@param container: The container holding the uploads
@type container: L{Container}

@keyword prefix: Print only uploads of objects with this prefix
@type prefix: C{str}

@keyword delimiter: The object/key names are grouped based on
    being split by this delimiter
@type delimiter: C{str}

@return: A generator of S3MultipartUpload instances.
@rtype: C{generator} of L{S3MultipartUpload}

Extension method for removing all partially completed S3 multipart
uploads.

@param container: The container holding the uploads
@type container: L{Container}

@keyword prefix: Delete only uploads of objects with this prefix
@type prefix: C{str}