on_prefix_list Event

Fires once for each common prefix returned when listing objects.

Syntax

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

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

Remarks

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

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

Prefix is the common prefix.