AWS S3

AWS S3 is a simple object storage service provided by Amazon Web Services.

Categories: developer-tools, file-storage

Type: awsS3/v1

Connections

Version: 1

custom

Properties

Name	Label	Type	Required
accessKeyId	Access Key ID	STRING	true
secretAccessKey	Secret Access Key	STRING	true
region		STRING Options us-east-1, us-east-2, us-west-1, us-west-2, ca-central-1, ap-east-1, ap-south-1, ap-south-2, ap-northeast-3, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ap-northeast-1, me-south-1, me-central-1, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-south-1, eu-south-2, eu-west-3, eu-north-1, af-south-1, sa-east-1, cn-north-1, cn-northwest-1	true
bucketName	Bucket	STRING	true

Actions

Get Object

Name: getObject

Get the AWS S3 object.

Properties

Name	Label	Type	Description	Required
filename	Filename	STRING	Filename to set for binary data.	true
key	Key	STRING	Key is most likely the name of the file.	true

Example JSON Structure

{
  "label" : "Get Object",
  "name" : "getObject",
  "parameters" : {
    "filename" : "",
    "key" : ""
  },
  "type" : "awsS3/v1/getObject"
}

Output

Type: FILE_ENTRY

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}

Get URL

Name: getUrl

Get the url of an AWS S3 object.

Properties

Name	Label	Type	Description	Required
key	Key or Entity Tag (Etag)	STRING	Key is most likely the name of the file.	true

Example JSON Structure

{
  "label" : "Get URL",
  "name" : "getUrl",
  "parameters" : {
    "key" : ""
  },
  "type" : "awsS3/v1/getUrl"
}

Output

Sample Output:

https://s3.amazonaws.com/bucket-name/key

Type: STRING

List Objects

Name: listObjects

Get the list AWS S3 objects. Every object needs to have read permission in order to be seen.

Properties

Name	Label	Type	Description	Required
prefix	Prefix	STRING	The prefix of an AWS S3 objects.	true

Example JSON Structure

{
  "label" : "List Objects",
  "name" : "listObjects",
  "parameters" : {
    "prefix" : ""
  },
  "type" : "awsS3/v1/listObjects"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

Name	Type	Description
key	STRING
suffix	STRING
uri	STRING

Output Example

[ {
  "key" : "",
  "suffix" : "",
  "uri" : ""
} ]

Get Pre-signed Object

Name: presignGetObject

You can share an object with a pre-signed URL for up to 12 hours or until your session expires.

Properties

Name	Label	Type	Description	Required
key	Key	STRING	Key is most likely the name of the file.	true
signatureDuration	Signature Duration	STRING	Time interval until the pre-signed URL expires	true

Example JSON Structure

{
  "label" : "Get Pre-signed Object",
  "name" : "presignGetObject",
  "parameters" : {
    "key" : "",
    "signatureDuration" : ""
  },
  "type" : "awsS3/v1/presignGetObject"
}

Output

Type: STRING

Put Object

Name: putObject

Store an object to AWS S3.

Properties

Name	Label	Type	Description	Required
fileEntry	File	FILE_ENTRY	The object property which contains a reference to the file that needs to be written to AWS S3.	true
key	Key	STRING	Key is most likely the name of the file.	true
acl	ACL	STRING Options authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control, private, public-read, public-read-write	The canned ACL to apply to the object.	null

Example JSON Structure

{
  "label" : "Put Object",
  "name" : "putObject",
  "parameters" : {
    "fileEntry" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "key" : "",
    "acl" : ""
  },
  "type" : "awsS3/v1/putObject"
}

Output

This action does not produce any output.