Update

The Update activity is used to update properties of Amazon S3 objects and buckets. If you update the Access Control List of objects and buckets, a new access control rule is added to the original Access Control List. If you update any other properties, the properties are reset.

General

The General tab contains the following fields:

Field Module Property? Description
Name No Name to be displayed as a label for the activity in the process
Amazon Connection Yes Provides connection details to communicate with an Amazon S3 instance
Service Name No You can choose from the two options provided:
  • Object: Update properties of an object
  • Bucket: Update properties of a bucket
Operation Type No
You can choose one of the following options when service is Bucket:
  • Versioning: Set versioning status for a bucket
  • ACL: Add Access Control List rule for a bucket
  • Policy: Set policy for a bucket
  • Website: Set website configuration for a bucket
  • CORS: Set CORS for a bucket
You can choose the following option when service is Object:
  • ACL: Add an Access Control List rule for an object
Bucket No Select a bucket

Description

On the Description tab, you can provide a short description of the Update activity.

Field Module Property? Description
Description No Description of the Update activity

Input

The input of the activity varies depending on the Service Name and Operation Type specified in the General tab.

Input for Update Bucket Versioning
Input Item Data Type Description
bucketName String Name of the bucket
status String Status of the Amazon S3 bucket versioning

Valid values are Enabled, Suspended.

amazonS3Connection String AmazonS3Client object
Note: You can generate the AmazonS3Client object using the GetConnection activity of TIBCO ActiveMatrix BusinessWorks™ Plug-in Component for AWS Common Services.
Input for Update Bucket Access Control List
Input Item Data Type Description
bucketName String Name of the bucket
acl Complex Access Control List

You can set permissions to the bucket by Canonical type, Email Address type, and Group type.

amazonS3Connection String AmazonS3Client object
Note: You can generate the AmazonS3Client object using the GetConnection activity of TIBCO ActiveMatrix BusinessWorks™ Plug-in Component for AWS Common Services.
Input for Update Bucket Policy
Input Item Data Type Description
bucketName String Name of the bucket
policy String Policy of the bucket

You can input the JSON text of the policy. It is a good practice not to use any white space in the JSON text.

amazonS3Connection String AmazonS3Client object
Note: You can generate the AmazonS3Client object using the GetConnection activity of TIBCO ActiveMatrix BusinessWorks™ Plug-in Component for AWS Common Services.
Input for Update Bucket Website
Input Item Data Type Description
bucketName String Name of the bucket
Configuration Complex Configuration of the website
It has the following parameters:
  • indexDocumentSuffix: Document to serve when a directory is specified. For example, index.html.
  • errorDocument: Complete path to the document to serve for 4xx errors
amazonS3Connection String AmazonS3Client object
Note: You can generate the AmazonS3Client object using the GetConnection activity of TIBCO ActiveMatrix BusinessWorks™ Plug-in Component for AWS Common Services.
Input for Update Bucket Cross-Origin Resource Sharing (CORS)
Input Item Data Type Description
bucketName String Name of the bucket
corsRule Complex Rule for Cross-Origin Resource Sharing
amazonS3Connection String AmazonS3Client object
Note: You can generate the AmazonS3Client object using the GetConnection activity of TIBCO ActiveMatrix BusinessWorks™ Plug-in Component for AWS Common Services.
You can set the following information in corsRule
Input Item Data Type Description
id String Arbitrary ID of this rule
allowedHeader String List of allowed headers

Duplicate this node for each specified header.

allowedOrigin String Set the allowed origins of this rule

Duplicate this node for each specified origin.

allowedMethod String HTTP methods GET, PUT, HEAD, POST, and DELETE
maxAgeSeconds Integer Set the maximum age of this rule in seconds
Input for Update Object Access Control List
Input Item Data Type Description
bucketName String Name of the object
key String Key of the object
acl Complex Access Control List

You can set permissions to the bucket by ID, email address, or group.

In each case, the permission is Read, Write, ReadAcp, or WriteAcp.

amazonS3Connection String AmazonS3Client object
Note: You can generate the AmazonS3Client object using the GetConnection activity of TIBCO ActiveMatrix BusinessWorks™ Plug-in Component for AWS Common Services.

Output

Output for Update
Output Item Data Type Description
result String Execution result of the update operation

Fault

The Fault tab lists exceptions that are thrown by the Update activity. It has the following fields:

Error Schema Element Data Type Description
Amazon S3 Plugin Exception Complex Any exception created by TIBCO BusinessWorks Plug-in for Amazon S3

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in

Amazon S3 Client Exception Complex Any exception or error reported by Amazon S3 Client

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in

Amazon S3 Service Exception Complex Any exception or error reported by Amazon S3 instance

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in