AWS S3 Element

The AWS S3 element is used to provide an Atmosphere project the ability to access and manipulate AWS S3 buckets.

The AWS S3 element is located in the Element Toolbox within Studio’s Cloud View.

Element Icon
AWS S3 Element

Using AWS elements requires the prerequisite configuration of AWS products and an AWS IAM role. To learn more about integrating AWS products into your Atmosphere projects, visit Amazon Web Services Integration.

Properties

The following properties can be changed for the AWS S3 element:

Name

The name of the element.

Region

The AWS region where the S3 bucket is located.

Role ARN

The designated IAM role used to allow Atmosphere to access the S3 bucket.

External ID

The external identifier within the IAM role used to allow role access.

Bucket Name

The name of the S3 bucket accessed on AWS.

Bucket Key

The key of the S3 object located in the S3 bucket the element interacts with.

ACL

Access control list to access the specified S3 bucket or object.

Triggers

The following triggers are available to execute events from within the AWS S3 element:

Triggered

Execute an event when the source element connected to the AWS S3 triggers.

Object Sent

Execute an event when an object is sent to the S3 bucket.

Object Received

Execute an event when an object is received from the S3 bucket.

Objects Listed

Execute an event when all objects in the S3 bucket are listed in an array.

Object Deleted

Execute an event when an object is deleted from the S3 bucket.

Abilities

The following abilities are available for the AWS S3 element when its source element triggers:

Trigger

Trigger the element(s) that follow the AWS S3 element.

Send Object

Send data as a JavaScript object to the S3 bucket.

Send Object Arguments:
Name Type Description Example
Data JSON Data inserted into an object in the specified S3 bucket. {“a”: 2, “b”: 3, “c”: 4}

The owner of the S3 bucket has full control of what objects are sent to it. If you are not the owner of the S3 bucket, ensure you can have objects sent to it.

Receive Object

Return an object from the S3 bucket. An object returned from the S3 bucket is put into a JavaScript buffer, encoded as a UTF-8 string, and parsed as JSON data.

List Objects

Return all objects in the S3 bucket in an array of JavaScript objects.

List Objects Arguments:
Name Type Description
Prefix String Filter a list of objects when calling listObjects(). Only objects with a matching prefix are returned.
Delimiter String Return objects that are grouped by the delimiter.

Delete Object

Delete an object from the S3 bucket.