Chapter 5. Listing files in your bucket


To list files in a specific bucket, use the list_bucket_v2() method.

Prerequisites

  • You have cloned the odh-doc-examples repository to your workbench.
  • You have opened the s3client_examples.ipynb file in your workbench.
  • You have installed Boto3 and configured an S3 client.

Procedure

  1. In the Jupyter notebook, locate the following code for listing files.

    #List files
    #Replace <bucket_name> with the name of the bucket.
    bucket_name = ‘<bucket_name>’
    s3_client.list_objects_v2(Bucket=bucket_name)
    Copy to Clipboard
  2. Replace <bucket_name> with the name of your own bucket, as shown in the example, and then run the code cell.

    #List files
    #Replace <bucket_name> with the name of the bucket.
    bucket_name = ‘aqs27-registry’
    s3_client.list_objects_v2(Bucket=bucket_name)
    Copy to Clipboard

    The output displays information about the files that are available in the specified bucket.

  3. Locate the code cell that lists only the names of the files.

    #Print only names of files
    bucket_name = ‘<bucket_name>’
    for key in s3_client.list_objects_v2(Bucket=bucket_name)[‘Contents’]:
    	print(key[‘Key’])
    Copy to Clipboard
  4. Replace <bucket_name> with the name of your bucket, as shown in the example, and run the code cell:

    #Print only names of files
    bucket_name = ‘aqs27-registry’
    for key in s3_client.list_objects_v2(Bucket=bucket_name)[‘Contents’]:
    print(key[‘Key’])
    Copy to Clipboard

    The output displays a list of file names that are available in the specified bucket.

  5. Refine the previous query to specify a file path, by locating the following code cell:

    bucket_name = ‘<bucket_name>’
    for key in s3_client.list_objects_v2(Bucket=bucket_name,Prefix=’<start_of_file_path’)[‘Contents’]:
    print(key[‘Key’])
    Copy to Clipboard
  6. Replace <bucket_name> and <start_of_file_path> with your own values and run the code cell.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat