IPWorks S3 2020 Python Edition

Questions / Feedback?

on_object_list Event

Fires once for each object, object version, or multipart upload returned when listing such items.

Syntax

class S3ClientObjectListEventParams(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 S3Client:
@property
def on_object_list() -> Callable[[S3ClientObjectListEventParams], None]: ...
@on_object_list.setter
def on_object_list(event_hook: Callable[[S3ClientObjectListEventParams], 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. Not applicable when list_multipart_uploads is called.

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

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

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

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

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

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

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

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