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:
Input
The input of the activity varies depending on the Service Name, Put Type, and Input Type specified on the General tab.
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.
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 | Enables SSE-S3 when set to true. |
serversideEncryptAdvanced | String | Specifies advanced Server-side encrypt configuration for enabling SSE-KMS or SSE-C. |
useServersideEncryptKMS | Boolean | Set to true to enable SSE-KMS. |
ServersideEncryptKMSKeyID | String | Specifies the server-side encryption with AWS Key Management Service (AWS KMS) and customer master keys (CMKs) to encrypt your data when uploading or copying an object. For more information about the request headers, see AWS online documentation. |
useServersideEncryptCustomerProvided | Boolean | Set to true to enable SSE-C. |
customerEncryptionAlgorithm | String | Specifies the algorithm to use to when encrypting the object. For example, AES256 |
customerEncryptionKey | String |
Specifies the customer-provided base64-encoded encryption key to use to decrypt the requested object. For more information about the x-amz-server-sideencryption-customer-key metadata key, see AWS online documentation. |
customerKeyMD5 | String | Specifies the base64-encoded 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321.
For more information about the x-amz-server-sideencryption-customer-key-MD5 metadata key, see AWS online documentation. |
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 on 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 on 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 |
meatadataAttributes | 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.
For more information about metadata attributes refer to the AWS documentation. |
transferManagerConfig | Complex | An option to upload or copy the file in multiple small parts. Set the useTransferManager to true() to use this option. |
minUploadPartSize? | Long | Size of each part of the file. |
multipartUploadThreshold? | Long | Size and the number of the part of the file to be uploaded. |
alwaysCalculateMultipartMd5? | Boolean | Calculates Multipart MD5 when set to true. |
uploadThreadCount | Integer | Number of threads to upload the file. |
minCopyPartSize? | Long | Size of each part of the file to copy. |
multipartCopyThreshold? | Long | Size and the number of part of the file to be copied. |
copyThreadCount | Integer | Number of threads to copy the file. |
timeout | Long |
An activity timeout value, if not specified, the activity uses default timeout. The unit is in seconds. |
contentMD5 | String | contentMD5 is a hash value of the input data. |
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 |