GetObject

The GetObject activity is used to get an Amazon S3 object.

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
Operation Type No You can choose from the following options provided:
  • All: Get details of all objects in the selected bucket
  • Single: Retrieve an object from the selected bucket
  • List Buckets: Provide a list of all the buckets available to the user based on the client credentials in the client connection used by this activity.

    The input tab provides a prefix which can be used to trim the list.

Bucket No Select the required bucket
Output Type No Output type of the get single object operation
You can use this operation only to get a single object operation. The default value is File.
  • File: Get the object and store it on the specified file path
  • Text: Get the object and show the object content as text
  • Binary: Get the object and show the object content as binary

Description

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

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

Input

The input of the activity varies depending on the Operation Type and Output Type specified on the General tab.

Input for All operation Get Objects
Input Item Data Type Description
bucketName String Name of the Amazon S3 bucket to be listed
prefix String Optional parameter

It restricts the response to keys beginning with the specified prefix. Use prefixes to separate a bucket into different sets of keys.

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 Single operation Get Objects
Input Item Data Type Description
bucketName String Name of the bucket containing the desired object
key String Key under which the desired object is stored
versionId String Amazon S3 version ID specifying the version of the object to be downloaded
destinationFilePath String Local path with the file name when the value specified in the Output Type field in the General tab is File. The object is downloaded in the specified location.
range Complex Optional inclusive byte range within the desired object that is downloaded. The range consists of the following information:
  • start: Start of the inclusive byte range to download
  • end: End of the inclusive byte range to download
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.
customerEncryptionAlgorithm String Specifies the algorithm to use to when decrypting the requested object.

For more information about the x-amz-server-side​-encryption​-customer-algorithm metadata key, refer to the AWS online documentation.

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-side​-encryption​-customer-key metadata key, refer to the AWS online documentation.

customerEncryptionMD5 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-side​-encryption​-customer-key-MD5 metadata key, refer to the AWS online documentation.

Input for List Buckets operation
Input Item Data Type Description
prefix String Prefix to be matched against the buckets list to filter the list provided on output
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

The output of the activity varies depending on the Operation Type and Output Type specified in the General tab.

Output for All operation Get Objects
Output Item Data Type Description
bucketName String Name of the bucket containing the desired object
prefix String Prefix

Use prefixes to separate a bucket into different sets of keys

objectList Complex List of objects in the bucket
objectSummary Complex Information about the object

The following information is provided in the objectSummary:

Output Item Data Type Description
bucketName String Name of the bucket specified as input to this activity
eTag String Hex-encoded 128 bit MD5 digest of this object according to RFC 1864
key String Key that identifies this object
lastModified Date Value of the Last Modified header indicating the date and time at which Amazon S3 last recorded a modification of this object
owner String ID and display name of the object's owner in separate fields labeled id and displayName
storageClass String Amazon S3 storage class for this object
size Integer Size of the object in bytes
Output for Single operation Get Objects
Output Item Data Type Description
bucketName String Name of the bucket containing the desired object
key String Key under which the desired object is stored
destinationFilePath String Local path with file name when the value specified in the Output Type field in the General tab is File.
textContent String The text content of the file when the value specified in the Output Type field in the General tab is Text.
binaryContent base64Binary The binary content of the file when the value specified in the Output Type field in the General tab is Binary.
metadata Complex Information about the object
The following information is provided in the metadata:
Output Item Data Type Description
versionid String Version ID of the object
cacheControl String Optional cache control HTTP header

You can specify caching behavior along the HTTP request/reply chain.

contentDisposition String Optional content disposition HTTP header

It specifies the presentation information for the object such as the recommended file name when saving the object.

contentEncoding String Optional content encoding HTTP header

It specifies the content encoding which has been applied to the object. It also specifies the decoding mechanisms that must be applied in order to obtain the media-type referenced by the contentType field.

contentLength String Content length HTTP header indicating the size of the object in bytes
contentMD5 String Base64 encoded 128 bit MD5 digest of the associated object (excluding the headers) according to RFC 1864
contentType String Content type HTTP header

It indicates the type of content stored in the associated object.

eTag String Hex-encoded 128 bit MD5 digest of the associated object according to RFC 1864
expirationTime Date Time this object expires and is completely removed from Amazon S3
expirationTimeRuleId String BucketLifeCycleConfiguration rule ID for this object's expiration; null if it does not expire.
httpExpiresDate Date Date when the object can no longer be cached
instanceLength Integer Physical length of the object stored in Amazon S3
lastModified Date Value of the Last Modified header indicating the date and time at which Amazon S3 last recorded a modification to the associated object
ongoingRestore String Value which indicates whether there is ongoing restore request
restoreExpirationTime Date Time at which an object that is temporarily restored from Amazon Glacier, expires, and needs to be restored in order to be accessed again
serverSideEncryption String True if server side encryption has been enabled for this object
seeAlgorithm String Server side encryption algorithm when encrypting the object by using keys managed by Amazon Web Services
seeAwskmsKeyId String Amazon Web Services Key Management System key ID used for server side encryption of the Amazon S3 object
seeCustomerKeyMd5 String Base64 encoded MD5 digest of the encryption key for server side encryption, if the object is encrypted by using keys provided by a customer
storageClass String Amazon Web Service S3 storage class for this object
userMetadata String Metadata key and metadata value are enumerated here if user metadata has been established for this object
Output for List Buckets operation
Input Item Data Type Description
bucketName String This repeating element describes all the buckets that satisfy the prefix filter (if the filter is provided)

Fault

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