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

null

Properties

Name	Label	Type	Control Type	Required
accessKeyId	Access Key ID	STRING	TEXT	true
secretAccessKey	Secret Access Key	STRING	TEXT	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	SELECT	true
bucketName	Bucket	STRING	TEXT	true

Actions

Get Object

Name: getObject

Get the AWS S3 object.

Properties

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

Output

Type: FILE_ENTRY

Properties

Name	Type	Control Type
extension	STRING	TEXT
mimeType	STRING	TEXT
name	STRING	TEXT
url	STRING	TEXT

JSON Example

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

Get URL

Name: getUrl

Get the url of an AWS S3 object.

Properties

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

Output

Sample Output:

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

Type: STRING

JSON Example

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

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	Control Type	Description	Required
prefix	Prefix	STRING	TEXT	The prefix of an AWS S3 objects.	true

Output

Type: ARRAY

Properties

Name	Type	Control Type
	OBJECT Properties {STRING(key), STRING(suffix), STRING(uri)}	OBJECT_BUILDER

JSON Example

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

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	Control Type	Description	Required
key	Key	STRING	TEXT	Key is most likely the name of the file.	true
signatureDuration	Signature Duration	STRING	TEXT	Time interval until the pre-signed URL expires	true

Output

Type: STRING

JSON Example

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

Put Object

Name: putObject

Store an object to AWS S3.

Properties

Name	Label	Type	Control Type	Description	Required
fileEntry	File	FILE_ENTRY	FILE_ENTRY	The object property which contains a reference to the file that needs to be written to AWS S3.	true
key	Key	STRING	TEXT	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	SELECT	The canned ACL to apply to the object.	null

Output

Type: STRING

JSON Example

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