Select Object Content

The Select Object Content activity is used to retrieve only a subset of data from an object by using simple SQL expressions. You can configure Input serialization configuration, S3 Select SQL Expression, and returns output based on the configured Output serialization format.

General

The General tab contains the following fields:

Field Module Property? Description
Name No Provides the 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
Bucket No A bucket on which you want to perform this activity operation.
Input Serialization No The data format in which you want to read from the bucket:
  • CSV
  • JSON
  • Parquet
Compression Type No The type of data compression:
  • GZIP
  • BZIP2
  • None
Output Serialization No The data format for output serialization:
  • CSV
  • JSON
Output Type No The output types:
  • File
  • Text

Description

On the Description tab, you can provide a short description of the Amazon S3 Select Object Content activity.

Field Module Property? Description
Description No Description of the Amazon S3 Select Object Content activity

Input

The input of the activity varies depending on the Input Serialization and Output Serialization fields specified on the General tab.

Input for SelectObjectContent
Input Item Data Type Description
bucketName String The name of the bucket.
key String The key under which the desired object is stored.
destinationFilePath

Available only when Output Type is File

String Destination file path of the result
expression String Amazon S3 Select SQL Expression. For more information, refer AWS documentation.
range Complex Optional inclusive byte range within the desired object that is selected. The range consists of the following information:
  • start: Start of the inclusive byte range to be selected
  • end: End of the inclusive byte range to be selected
inputJSONConfig Complex

This field is available only if the value specified in the Input Serialization field is JSON.

jsonType String JSON Type value. For example, Document or Lines.
outputJSONConfig Complex This field is available only if the value specified in the Output Serialization field is JSON.
recordDelimiter String A delimiter used to separate records.
inputCSVConfig Complex

This field is available only if the value specified in the Input Serialization field is CSV.

commentsChar String A character to indicate that a row must be ignored when it is present at the beginning of a row.
fieldDelimiter String A character to separate individual fields in a record.
fileHeaderInfo String Set the first line of input. Select one of the following values:
  • None
  • Ignore
  • Use
quoteChar String Set the value used for escaping where the field delimiter is part of the value.
quoteEscapeChar String Set the character used for escaping the quote character inside an already escaped value.
recordDelimiter String A character used to separate records.
allowQuotedRecordDelimiter Boolean Set the value used to allow quoted record delimiters to occur within the input.
outputCSVConfig Complex This field is available only if the value specified in the Output Serialization field is CSV.
fieldDelimiter String A character to separate individual fields in a record.
fileHeaderInfo String Set the first line of input. Select one of the following values:
  • None
  • Ignore
  • Use
quoteChar String Set the value used for escaping where the field delimiter is part of the value.
quoteEscapeChar String Set the character used for escaping the quote character inside an already escaped value.
recordDelimiter String A character used to separate records.
amazonS3connection String
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-sideencryption-customer-algorithm metadata key, see AWS 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-sideencryption-customer-key metadata key, see AWS 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 documentation.

timeout Long An activity timeout value (seconds), if not specified the activity uses default timeout.
Output for SelectObjectContent
Input Item Data Type Description
result String Depending on the type of Input Serialization that you have selected, result is produced.