List Module¶

List S3 bucket objects.

s3_tools.list.list_objects(bucket: str, prefix: str = '', search_str: Optional[str] = None, max_keys: int = 1000) → list[source]¶

Retrieve the list of objects from AWS S3 bucket under a given prefix and search string.

Parameters

bucket (str) – AWS S3 bucket where the objects are stored.
prefix (str) – Prefix where the objects are under.
search_str (str) – Basic search string to filter out keys on result (uses Unix shell-style wildcards), by default is None. For more about the search check “fnmatch” package.
max_keys (int) – Max number of keys to have pagination.

Returns

List of keys inside the bucket, under the path, and filtered.

Return type

list

Examples

>>> list_objects(bucket="myBucket", prefix="myData")
[
    "myData/myFile.data",
    "myData/myMusic/awesome.mp3",
    "myData/myDocs/paper.doc"
]

>>> list_objects(bucket="myBucket", prefix="myData", search_str="*paper*")
[
    "myData/myDocs/paper.doc"
]