Put

The Put activity is used to upload Amazon S3 objects, copy objects between buckets, and create new buckets.

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: Upload objects and copy objects between buckets
  • Bucket: Create a new bucket
Region

(Deprecated)

No Select a region to create a bucket.

This field is available only if the value specified in the Service Name field is Bucket.

This field is deprecated and will be removed in a later release.

Bucket No Select a bucket

This field is available only if the value specified in the Service Name field is Object.

Put Type No Select a Put type of Upload or Copy.

In Upload mode, the activity uploads the content provided on the input schema to the bucket using the specified key.

In Copy mode, the contents of the source bucket and key are copied to the destination bucket and key. The copy operation takes place entirely in AWS.

This field is available only if the value specified in the Service Name field is Object.

Input Type No Content of the type of object that must be uploaded
This field is available only if the value specified in the Service Name field is Object and the value specified in the Put Type field is Upload. The default value is File.
  • File: Upload file from the specified file path
  • Text: Upload text content as the object content
  • Binary: Upload binary content as the object content
Target Bucket No Select the destination bucket

This field is available only if the value specified in the Service Name field is Object and the value specified in the Put Type field is Copy.

Description

In the Description tab, you can provide a short description of the Put activity.

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

Input

The input of the activity varies depending on the Service Name, Put Type, and Input Type specified on the General tab.

Input for Put Bucket
Input Item Data Type Description
bucketName String Name of the bucket to be created
region

(Deprecated)

String Amazon S3 region in which to create a new bucket
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 Put Object
Input Item Data Type Description
bucketName String Name of an existing bucket, to which the user has Write permission
key String Key under which the desired object is stored
encoding String Metadata that is carried with the object in and out of Amazon Web Services S3.
This item is available to the application retrieving the object so that the application performs appropriate decoding operation if required. For example, gzip.
Note: Using this parameter does not modify the data.

This item is available only when the value specified in the Put Type field in the General tab is Upload.

storageClass String Storage class to be used for the Put operation

The class must be either Standard or StandardInfrequentAccess. See the AWS documentation for description of these storage classes.

serversideEncrypt Boolean Indicates that AWS should encrypt data when it is at rest (that is, on disk) if the value is true. In this mode, the keys are handled by AWS.
destinationBucketName String Destination bucket name for the object to be copied

This item is available only when the value specified in the Put Type field in the General tab is Copy.

destinationKey String Destination object name for the object to be copied

This item is available only when the value specified in the Put Type field in the General tab is Copy.

file String File containing the data to be uploaded to Amazon S3

This item is available only when the value specified in the Put Type field in the General tab is Upload and the value specified in the Input Type field is File.

textContent String Text content of the data to be uploaded to Amazon S3

This item is available only when the value specified in the Put Type field in the General tab is Upload and the value specified in the Input Type field is Text.

binaryContent base64Binary Binary content of the data to be uploaded to Amazon S3

This item is available only when the value specified in the Put Type field in the General tab is Upload and the value specified in the Input Type field is Binary.

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.
metadataAttributes Complex Optional metadata attributes that enable you to add Key/Value pairs.
These attributes are available only when the value specified in the Put Type field in the General tab is Upload.
  • Key: Key / name of system defined or user-defined metadata.
  • Value: Value for metadata.

For more information about metadata attributes refer to the AWS documentation.

Output

Output for Put Bucket
Output Item Data Type Description
bucketName String Name of the bucket
creationDate Date Date when the bucket is created
owner Complex Owner details of the bucket:
  • Id: User ID of the owner
  • displayName: Display name of the owner

Output for Put Object-upload

Output contains the information returned by Amazon S3 for the newly created object.

Output for Put Object-copy

Output contains the information returned by Amazon S3 for the copied object.

Fault

The Fault tab lists exceptions that are thrown by the Put 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