Skip to main content

AWS S3

Type ID: s3  ·  Kind: Action  ·  Ports: 1 in, 1 out

Interact with AWS S3 to upload and retrieve objects.

Credentials​

aws

Resources & operations​

  • Object (object)
    • Upload (upload) - Upload an object to S3
    • Get (get) - Get an object from S3

Properties​

Common​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
ResourceresourceoptionsYesobjectObject (object)-
OperationoperationoptionsYesuploadUpload (upload), Get (get)resource = object

Object → Upload​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Bucket NamebucketNamestringYes''S3 bucket nameresource = object, operation = upload
Object KeyobjectKeystringYes''S3 object keyresource = object, operation = upload
Binary Property NamebinaryPropertyNamestringYesdataName of the binary property containing the file data to uploadresource = object, operation = upload
Skip If No Binary DataskipIfNoBinaryDatabooleanNofalseSkip the upload and return a skipped result when the configured binary property is not presentresource = object, operation = upload

Object → Get​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Bucket NamebucketNamestringYes''S3 bucket nameresource = object, operation = get
Object KeyobjectKeystringYes''S3 object keyresource = object, operation = get
Binary Property NamebinaryPropertyNamestringYesdataName of the binary property to write the downloaded file data toresource = object, operation = get
Return Binary DatareturnBinaryDatabooleanNotruetrue / false (include downloaded file as binary data in output)resource = object, operation = get
Generate Download URLgenerateDownloadUrlbooleanNofalsetrue / false (generate a temporary presigned download URL)resource = object, operation = get
Download URL Expiration SecondsdownloadUrlExpiresInnumberNo3600How long the generated download URL stays valid (1–604800 seconds)resource = object, operation = get, generateDownloadUrl = true

Notes​

  • Bucket Name, Object Key, and Binary Property Name are required for both Upload and Get. Upload also requires an input item with binary data on the named property, unless Skip If No Binary Data is enabled.
  • Download URL Expiration Seconds must be between 1 and 604800 (7 days) when Generate Download URL is enabled.
  • Get objects over 10 MB will error when Return Binary Data is enabled.
  • Output: { success, bucket, key, url, [downloadUrl, downloadUrlExpiresIn] }. On Get with Return Binary Data enabled, the file is also attached under binary[binaryPropertyName].