ToolJet/docs/versioned_docs/version-2.33.0/data-sources/s3.md

id	title
s3	Amazon S3

Amazon S3

ToolJet can connect to Amazon S3 buckets and perform various operation on them.

Connection

To establish a connection with the Amazon S3 data source, you can either click on the +Add new Data source button located on the query panel or navigate to the Data Sources page from the ToolJet dashboard.

ToolJet supports connecting to AWS S3 using IAM credentials, AWS Instance Profile or AWS ARN Role.

If you are using IAM credentials, you will need to provide the following details:

• Region
• Access key
• Secret key

It is recommended to create a new IAM user for the database so that you can control the access levels of ToolJet.

To connect to AWS S3 using AWS Instance Profile, select the Use AWS Instance Profile. This will use the IAM role attached to the EC2 instance where ToolJet is running. To access the metadata service of an ECS container and the EC2 instance, we use the WebIdentityToken parameter which is obtained from a successful login with an identity provider.

If you are using AWS ARN Role, you will need to provide the following details:

• Region
• Role ARN

Click on Test connection button to verify if the credentials are correct and that the database is accessible to ToolJet server. Click on Save button to save the data source.

:::tip You can now connect to different S3 Hosts using custom endpoints. :::

Querying AWS S3

Click on +Add button of the query manager and select the data source added in the previous step as the data source. Select the operation that you want to perform, fill in the required parameters and click on Run button to run the query.

:::info Query results can be transformed using transformations. Read our transformations documentation. :::

Query operations

You can create query for AWS S3 data source to perform several actions such as:

1. Create a new bucket
2. Read object
3. Upload object
4. Remove object
5. List buckets
6. List objects in a bucket
7. Signed url for download
8. Signed url for upload

Create a new bucket

You can create a new bucket in your S3 by using this operation. It requires one parameter - Bucket name.

Read object

You can read an object in a bucket by using this operation. It requires two parameters - Bucket name and Key.

Upload object

You can use this operation to upload objects(files) to your S3 bucket. It requires four parameters:

1. Bucket: Specify the bucket name
2. Key: Key of the object/file
3. Content type: Specify file type such as text, image etc.
4. Upload data: File/object that is to be uploaded.

Remove object

You can use this operation to remove an object from your S3 bucket. It requires two parameters:

1. Bucket: Specify the bucket name
2. Key: Key of the object/file

List buckets

This operation will list all the buckets in your S3. This does not require any parameter.

List objects in a bucket

This operation will fetch the list of all the files in your bucket. It requires two parameters:

1. Bucket: Bucket name (mandatory)
2. Prefix: To limit the response to keys that begin with the specified prefix (optional)
3. Max keys: The maximum number of keys returned in the response body (optional). Default value is 1000.
4. Offset: The key to start with when listing objects in a bucket (optional).
5. "Next Continuation Token": Next Continuation Token indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key (optional).

:::info Next Continuation Token For listing a bucket for objects that begin with a specific character or a prefix, then use the Offset parameter. For example, if you want to list all the objects that begin with a, then set the Offset parameter to a. Similarly, if you want to list all the objects that begin with ab, then set the Offset parameter to ab.

The Next Continuation Token is used to list the next set of objects in a bucket. It is returned by the API when the response is truncated. The results will contain Next Continuation Token if there are more keys in the bucket that satisfy the list query. To get the next set of objects, set the Next Continuation Token parameter and run the query again. The results will continue from where the last listing finished. :::

Signed url for download

The object owner can optionally share objects with others by creating a presigned URL, using their own security credentials, to grant time-limited permission to download the objects. For creating a presigned URL, the required parameters are:

1. Bucket: name of the bucket for uploading the file
2. Key: an object key
3. Expires in: an expiration time of URL

Signed url for upload

The presigned URLs are useful if you want your user/customer to be able to upload a specific object to your bucket, but you don't require them to have AWS security credentials or permissions. For creating a presigned URL, the required parameters are:

1. Bucket: name of the bucket for uploading the file
2. Key: an object key
3. Expires in: an expiration time of URL
4. Content type: the content type such as text, image etc.

:::info We built an app to view and upload files to AWS S3 buckets. Check out the complete tutorial here. :::