Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Table of Contents

...

  • The following file transfer commands are supported:

    • Upload a file(s) to an S3 bucket

    • Download of file(s) from an S3 bucket

    • Transfer files between S3 buckets

    • List objects in an S3 bucket

    • Delete object(s) in an S3 bucket

    • List S3 bucket names

    • Create an S3 bucket

  • Monitor for a key(s) in a bucket.

  • File Transfer can be trigger by a third-party application using the Universal Automation Center RESTfull Webservice API: REST API.

  • Universal Task for AWS S3 can be integrated into any existing scheduling workflow in the same way as any standard Linux or Windows Task type.

  • Security is ensured by using the HTTPS protocol with support for an optional Proxy Server.

  • AWS IAM Role Based Access ( RBCA ) is supported.

  • AWS canned ACLs are supported; for example, to grant full access to the bucket owner.

  • No Universal Agent needs to be installed on the AWS Cloud – the communication goes via HTTPS.

...

NameDescription

Upload a file(s) to a bucket (Copy or Move)

  • A single or multiple files can be uploaded to a bucket.

  • Move or copy are supported for the upload

  • Unix filename pattern matching support e.g. wild card wildcard support “*” to upload multiple files

  • A single or multiple files can be Uploaded to a folder using a prefix

  • It can be decided via an the Upload Write Options:

    • to overwrite an existing object (Replace existing Object)

    • to cancel the operations in case an object with a similar name exists (Do not overwrite existing Object)

    • to add a timestamp to the uploaded Object (Timestamp

Download of file(s) from a bucket (Copy or Move)

  • A single or multiple files should be downloaded from a bucket.

  • Move or copy must be supported for the download

  • Unix filename pattern matching support e.g. wild card wildcard support “*” to download multiple files

  • Download to a specific folder is supported

  • It can be decided via an the Download Write Options:

    • to overwrite an existing file (Replace existing File)

    • to cancel the operations in case a File with a similar name exists (Do not overwrite existing File)

    • to add a timestamp to the uploaded file (Timestamp

    • to perform the default Windows behaviour for copying files (Default Windows behaviour)

      • If a file with a similar name exists, the file names that are similar will be edited so that the files you copied have a number appended at the end of them. For example, if you’re copying a file named image.png to a folder that already has a file named image.png in it, the copied file will be named image (1).png.

Copy object to a bucket

  • An object can be copied from one AWS S3 bucket to another.

  • Folders are support

List objects in a bucket

  • Show all Objects in a bucket

  • Show all Objects in a folder

  • Unix filename pattern matching support e.g. wild card wildcard support “*” to narrow down the objects to display

Delete object(s) in a bucket

  • Delete one or multiple objects in a bucket

  • Delete one or multiple objects in folder in a bucket

  • Unix filename pattern matching support; for example, wild card wildcard support “*” to narrow down the objects to be deleted

List buckets

List all bucket in an AWS S3 account

Create an S3 bucket

Create a new S3 bucket

Delete an S3 bucket

Delete an S3 bucket

Monitor Key

Monitor if a certain key(s) exists in an S3 bucket.

Unix filename pattern matching support; for example, wild card wildcard support “*” to narrow down the keys to be monitored.

Proxy Server Connection

A proxy server connection with or without basic authentication can be configured

Integration into 3rd Party Applications

An AWS S3 file transfer can be triggered via the Universal Automation Center RESTfull Webservice API within an application.

Self-Service through Web-Client

The S3 Task can be fully configured, monitored and updated via the Universal Controller Web-GUI

...

FieldDescription

Action

Upload-file action

AWS_ACCESS_KEY_ID

AWS Account credentials Access Key

AWS_DEFAULT_REGION

AWS Account credentials Region

AWS_SECRET_ACCESS_KEY

AWS Account credentials Secret Access Key

Useproxy ( default is NO )

[NO | YES]

If set to YES, the fields to set-up the proxy server connections are displayed:

  • Proxy Server IP or hostname

  • Proxy Server Port

  • Proxy Server Credentials (optional)

Loglevel ( default is INFO )

Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]

Role Based Access

[NO | YES]

If set to YES, the fields to set-up the IAM Role Based Access Connection are displayed:

  • Role Arn: Amazon Role, which is applied for the connection e.g. rn:aws:iam::111222333444:role/SB-AWSS3

  • Service Name [STS | S3 ] , default is STS

STS: AWS Security Token Service is used to create and provide trusted users with temporary security credentials that can control access to your AWS resources.

ACL

bucket-owner-full-control | private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | log-delivery-write

AWS canned ACLs; for details, refer to:

AWS canned ACL

The default ACL bucket-owner-full-control grant full access to the bucket owner.

Endpoint URL

Only used in case of a MinIO server; connection Endpoint URL for the MinIO storage

Sourcefile

Source file(s) to be uploaded to a bucket or specific folder in a bucket.

Unix filename pattern are supported to upload a selection of files.

Supported wildcards are:

  • ? matches any single character

  • [seq] matches any character in seq

  • [!seq] matches any character not in seq

  • ”*” matches everything

Operation

[copy | move]

In case of a “move” the source file(s) is/are deleted after the upload to the bucket.

Prefix

A folder in a bucket is called prefix in AWS. In the field Prefix only the name of the folder needs to be provided no “/” after the folder name.

Upload Write Options

Upload Write Options

[Replace existing Object | Do not overwrite existing Object | Timestamp]

  • Replace existing Object: Overwrite an existing object

  • Do not overwrite existing Object: Cancel the operations in case an object with a similar name exists

    • Timestamp: Add a timestamp to the uploaded Object

...

FieldDescription

Action

Delete-objects action

AWS_ACCESS_KEY_ID

AWS Account credentials Access Key

AWS_DEFAULT_REGION

AWS Account credentials Region

AWS_SECRET_ACCESS_KEY

AWS Account credentials Secret Access Key

Useproxy ( default is NO )

[NO | YES]

If set to YES, the fields to set-up the proxy server connections are displayed:

  • Proxy Server IP or hostname

  • Proxy Server Port

  • Proxy Server Credentials (optional)

Loglevel ( default is INFO )

Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]

Role Based Access

[NO | YES]

If set to YES, the fields to set-up the IAM Role Based Access Connection are displayed:

  • Role Arn: Amazon Role, which is applied for the connection e.g. rn:aws:iam::111222333444:role/SB-AWSS3

  • Service Name [STS | S3 ] , default is STS

STS: AWS Security Token Service is used to create and provide trusted users with temporary security credentials that can control access to your AWS resources.

Endpoint URL

Only used in case of a MinIO server; connection Endpoint URL for the MinIO storage system

Bucket

AWS bucket name

S3key

Key to be deleted in AWS

Note: Due to security reasons wild card wildcard is only support, if at least one character is provided e.g. t* would delete all files starting with at “t”.

...

FieldDescription

Action

Copy-object-to-bucket action

AWS_ACCESS_KEY_ID

AWS Account credentials Access Key

AWS_DEFAULT_REGION

AWS Account credentials Region

AWS_SECRET_ACCESS_KEY

AWS Account credentials Secret Access Key

Useproxy ( default is NO )

[NO | YES]

If set to YES, the fields to set-up the proxy server connections are displayed:

  • Proxy Server IP or hostname

  • Proxy Server Port

  • Proxy Server Credentials (optional)

Loglevel ( default is INFO )

Universal Task logging settings [DEBUG | INFO| WARNING | ERROR | CRITICAL]

Role Based Access

[NO | YES]

If set to YES, the fields to set-up the IAM Role Based Access Connection are displayed:

  • Role Arn: Amazon Role, which is applied for the connection e.g. rn:aws:iam::111222333444:role/SB-AWSS3

  • Service Name [STS | S3 ] , default is STS

STS: AWS Security Token Service is used to create and provide trusted users with temporary security credentials that can control access to your AWS resources.

ACL

bucket-owner-full-control | private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | log-delivery-write

AWS canned ACLs; for details, refer to:

AWS canned ACL

The default ACL bucket-owner-full-control grant full access to the bucket owner.

Endpoint URL

Only used in case of a MinIO server; connection Endpoint URL for the MinIO storage system

Bucket

AWS bucket name

Target Bucket

target Bucket, where the object(s) will be copied to

S3key

File to be copied from one bucket to another

TargetS3Key

Target file name.

The TargetS3key supports pattern match. For example:

Bucket: stonebranchpm

Target Bucket: stonebranchpm1

S3key: dir1/report* ;

Target s3key: dir2/*

This copies all files from bucket stonebranchpm in the directory dir1 starting with the file name report to the directory dir2/ in the bucket stonebranchpm1.

Note
titleNote

If the field TargetS3key is left blank, the entire source key - including the directory - will be copied to the target bucket. For example:

Bucket: stonebranchpm

Target Bucket: stonebranchpm1

S3key: dir1/report* ;

Target s3key:

This copies dir1/report* from bucket stonebranchpm to the bucket stonebranchpm1


Note
titleATTENTION

Do not use a non-pattern match Target S3key when the S3key uses pattern match.  For example:

Bucket: stonebranchpm

Target Bucket: stonebranchpm1

S3key: dir1/report* ;

Target s3key: dir2/report1.txt

This set-up will copy only one file, even if multiple files will match the S3Key in the source.


Upload Write Options

Upload Write Options

[Replace existing Object | Do not overwrite existing Object | Timestamp]

  • Replace existing Object: Overwrite an existing object

  • Do not overwrite existing Object: Cancel the operations in case an object with a similar name exists

  • Timestamp: Add a timestamp to the uploaded Object

...