Amazon S3: Download an object

🕙  3 minute read

Use this action to download a file from an AWS S3 bucket using its object key name.

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:GetObject permissions to access objects.

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.

The file size must be within Catalytic’s file size limit.

Fields for this action

  • Integration

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

    • Enter the full name of the object, including a file extension of object path.
      • For example a “whitepaper.pdf” object within the “Catalytic” folder would be Catalytic/whitepaper.pdf. An object at the root level of the bucket would be whitepaper.pdf. The extension is required.
      • Refer to Amazon’s Object Keys if necessary.
  • Bucket

    • Identify the name of the Amazon S3 bucket. You can find the bucket name in the Amazon S3 console.
  • 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.
  • Server Side Encryption fields

    • If the object is encrypted with a customer-managed server-side encryption key, fill out the following fields.
  • SSE Customer Algorithm

    • Specify the algorithm to use to when decrypting the object, otherwise leave blank.
    • For example: AES256
  • SSE Customer Key

    • Specify the key to use to when decrypting the object, otherwise leave blank.
  • SSE Customer Key MD5

    • Specify the 128-bit MD5 digest of the encryption key according to RFC 1321 to use when decrypting the object, otherwise leave blank. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

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

    • The file field where the object is stored.
  • Key

    • The object key for the object. This is specified during configuration.
  • File name

    • The file name, including the extension.
  • File size in bytes

    • The file’s size in bytes. This will be an integer.
  • File extension

    • The file extension of the file, such as png or jpg.
  • File media type

    • The type of the file in IANA type/subtype format, for example, text/csv or image/png.
  • ETag

    • The entity tag of the object, used for object comparison. Every Amazon S3 object has an entity tag.

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.