ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

AWS S3 modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

The ÃÛ¶¹ÊÓƵ Workfront Fusion AWS S3 modules let you perform operations on your S3 buckets.

Access requirements

You must have the following access to use the functionality in this article:

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime ÃÛ¶¹ÊÓƵ Workfront plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

Prerequisites

To use AWS S3 modules, you must have an Amazon Web Service account.

AWS S3 API information

The AWS S3 connector uses the following:

Base URL
https://s3.{{parameters.region}}.amazonaws.com
API tag
v1.5.21

Connect AWS to Workfront Fusion connect-aws-to-workfront-fusion

To connect AWS S3 to Workfront Fusion you must connect your AWS account to Workfront Fusion. To do so, you’ll first need to create an API user in AWS IAM.

  1. Sign in to your AWS IAM account.

  2. Navigate to Identity and Access Management > Access Management > Users.

  3. Click Add User.

  4. Enter the name of the new user and select the Programmatic access option in the Access type section.

  5. Click Attach existing policies directly, then search for AmazonS3FullAccess in the search bar. Click it when it appears, then click Next.

  6. Proceed through the other dialog screens, then click Create User.

  7. Copy the provided Access key ID and Secret access key.

  8. Go to Workfront Fusion and open the AWS S3 module’s Create a connection dialog.

  9. Enter the Access key ID and Secret access key from step 7 to the respective fields and click Continue to establish the connection.

The connection has been established. You can proceed with setting up the module.

AWS S3 modules and their fields

When you configure AWS S3 modules, Workfront Fusion displays the fields listed below. Along with these, additional AWS S3 fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Actions

Create Bucket

Connection
For instructions about connecting your AWS account to Workfront Fusion, see Connect AWS to Workfront Fusion in this article.
Name
Enter the name of the new bucket.
Region
Select your regional endpoint. For more information, see the discussion of in the AWS documentation.

Get File

Downloads a file from a bucket.

Connection
For instructions about connecting your AWS account to Workfront Fusion, see Connect AWS to Workfront Fusion in this article.
Region
Select your regional endpoint. For more information, see the discussion of in the AWS documentation.
Bucket
Select the bucket you want to download the file from.
Path
Enter the path to the file. Example: /photos/2019/February/image023.jpg.

Upload File

Connection
For instructions about connecting your AWS account to Workfront Fusion, see Connect AWS to Workfront Fusion in this article.
Region
Select your regional endpoint. For more information, see the discussion of in the AWS documentation.
Folder (optional)
Specify the target folder that you want to upload a file to.
Source file
Select a source file from a previous module, or map the source file's name and data.
Headers (optional)
Insert request headers. Available headers can be found in the .

Make an API Call

For a detailed discussion of the Amazon S3 API, see .

Connection
For instructions about connecting your AWS account to Workfront Fusion, see Connect AWS to Workfront Fusion in this article.
Region
Select your regional endpoint. For more information, see the discussion of in the AWS documentation.
URL
URL Enter a host URL. The path must be relative to https://s3.<selected-region>.amazonaws.com/.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in ÃÛ¶¹ÊÓƵ Workfront Fusion.
Headers

Add a request header. You can use the following common request headers. For more request headers refer to .

Workfront Fusion adds authorization headers automatically.

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 layout-auto
Header Name Description
Content-Length Length of the message (without the headers) according to RFC 2616. This header is required for PUTs and operations that load XML, such as logging and ACLs.
Content-Type The content type of the resource, in case the request content is in the body. Example: text/plain.
Content-MD5 The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, go to in the Amazon Simple Storage Service Developer Guide.
Date The current date and time according to the requester. Example: Wed, 01 Mar 2006 12:00:00 GMT. When you specify the Authorization header, you must specify either the x-amz-date or the Date header.
Expect

When your application uses 100-continue, it does not send the request body until it receives an acknowledgment. If the message is rejected based on the headers, the body of the message is not sent. This header can be used only if you are sending a body.

Valid Values: 100-continue
Host

For path-style requests, the value is s3.amazonaws.com. For virtual-style requests, the value is BucketName.s3.amazonaws.com. For more information, see in the Amazon Simple Storage Service Developer Guide.

This header is required for HTTP 1.1 (most toolkits add this header automatically); optional for HTTP/1.0 requests.
x-amz-content-sha256 When using signature version 4 to authenticate the request, this header provides a hash of the request payload. When uploading an object in chunks, set the value to STREAMING-AWS4-HMAC-SHA256-PAYLOAD to indicate that the signature covers only headers and that there is no payload. For more information, see .
x-amz-date The current date and time according to the requester. Example: Wed, 01 Mar 2006 12:00:00 GMT. When you specify the Authorization header, you must specify either the x-amz-date or the Date header. If you specify both, the value specified for the x-amz-date header takes precedence.
x-amz-security-token

This header can be used in the following scenarios:

  • Provide security tokens for Amazon DevPay operations. Each request that uses Amazon DevPay requires two x-amz-security-token headers: one for the product token and one for the user token. When Amazon S3 receives an authenticated request, it compares the computed signature with the provided signature. Improperly formatted multi-value headers used to calculate a signature can cause authentication issues.
  • Provide a security token when using temporary security credentials. When making requests using temporary security credentials you obtained from IAM, you must provide a security token using this header. To learn more about temporary security credentials, go to Making Requests.

This header is required for requests that use Amazon DevPay and requests that are signed using temporary security credentials.
Query String
Add the desired query strings such as parameters or form fields.
Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Searches

List Files

Returns a list of files from a specified location.

Connection
For instructions about connecting your AWS account to Workfront Fusion, see Connect AWS to Workfront Fusion in this article.
Region
Select your regional endpoint. For more information, see the discussion of in the AWS documentation.
Bucket
Select the Amazon S3 bucket you want to search for files.
Prefix (optional)
Path to a folder to look up files in, e.g. workfrontfusion/work.

List Folders

Returns a list of folders from a specified location.

Connection
For instructions about connecting your AWS account to Workfront Fusion, see Connect AWS to Workfront Fusion in this article.
Region
Select your regional endpoint. For more information, see the discussion of in the AWS documentation.
Bucket
Select the Amazon S3 bucket you want to search for folders.
Prefix (optional)
Path to a folder to look up folders in, e.g. workfrontfusion/work.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43