Amazon S3: List objects in a bucket

🕙  2 minute read

Use this action to create a list of all objects in a bucket and output to a data table. No files are downloaded by this action. To download files, use the Amazon S3: Download an object action.

Your Amazon S3 integration must have authorization to access the bucket or objects you are trying to retrieve with this action. For example, this action requires s3:ListBucket permissions to access buckets.

Use case

How to configure this action

This action requires a preconfigured Amazon S3 integration. For more information on integrating Catalytic with other systems, please refer to the Integrations section of our help center, or the Amazon S3 Integration Setup Guide directly.

Fields for this action

  • Integration

    • Select your Amazon S3 integration from the options. You may have multiple integrations configured.
  • Bucket

    • Identify the name of the Amazon S3 bucket. You can find the bucket name in the Amazon S3 console.
  • Key prefix

    • Enter just the key prefix of the directory to list. Amazon S3 uses an implied folder structure.
    • For example: a “whitepaper.pdf” object within the “Catalytic” folder would be Catalytic/whitepaper.pdf. To list all objects with this action, the key prefix is Catalytic/
  • Region

    • The AWS region to send the service request. Leave blank to use the default of us-east-1.
    • Refer to Amazon’s Regions and Availability Zones if necessary.
  • Signature Version

    • The signature version to sign requests with, such as v3 or v4. Leave blank to default to v4. v4 is the latest and recommended signature version.
  • Output Field Prefix

    • To help keep output fields organized, choose an output field prefix to add to the beginning of each output field name as this action may output more than one field.
    • The step’s name is used as the prefix by default.

What will this output?

This action may generate multiple fields. To help keep output fields organized, the prefix above will be added to the beginning of each of the output field names, separated by two dashes. Each field will result as:{{output-field-prefix--output-field}}. Learn more

Output fields for this action

  • Output field prefix

    • A data table field that stores the list of files. The table will have 6 columns:
      • Bucket: Identify the name of the Amazon S3 bucket.
      • Key: The full object key, such as Catalytic/whitepaper.pdf
      • LastModified: Last modified date in a date and time field.
      • Size: The file’s size in bytes. This will be an integer.
      • StorageClass: The storage class, such as STANDARD, GLACIER, DEEP_ARCHIVE, or others.
      • Etag: The entity tag of the object, used for object comparison. Every Amazon S3 object has an entity tag.
  • Status

    • This action returns up to 1000 objects. Any objects over 1000 are not returned by this action.
      • The status is Partial results if the object count exceeds the limit.
      • The status is Success if the object count does not exceed the limit.
    • Each row of the table is another file in the folder.

Sorry about that. What was the most unhelpful part?

Thanks for your feedback

We update the Help Center daily, so expect changes soon.

Link Copied

Paste this URL anywhere to link straight to the section.

Need more help?

If you're signed in to Catalytic Community, you can ask other users a question. You'll be redirected to Community where you can add more info.