Skip to main content

Amazon S3: List Versions Of Objects

Description

Amazon S3: List Versions Of Objects plugin step lists the versions of objects from a versioning enabled bucket.

Note:

To get the list of objects and version IDs from a bucket a user must have Read permission on the bucket.

Reference

SDK: Versioning Enabled Bucket

Configurations

Field NameDescription
Step NameSpecify a unique name for the step.
CONNECTION tab:Connection fields
RegionSpecify a valid AWS region or click the Get button to choose a region from the Region Explorer window.
The field type is String. This field is mandatory.
Button: GetClick Get button to open the Region Explorer window populated with the list of Regions available on the Amazon S3 instance. Choose a Region.
Access Key:Access key to authenticate an Amazon S3 cloud instance.
Accept Values from fieldsLeave checkbox unchecked to accept Access Key value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Access Key field to appear as Text box.
Access KeySpecify the Access Key to authenticate Amazon S3 cloud instance. If checkbox above is enabled Access Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Access Key field appears as a drop down to select fields from previous steps.
The field type is String. This field is mandatory.
Secret Key:Secret key to authenticate Amazon AWS cloud.
Accept Values from fieldsLeave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Secret Key field to appear as Text box.
Secret KeySpecify the Secret Key to authenticate Amazon S3 cloud instance. If checkbox above is enabled Secret Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Secret Key field appears as a drop down to select fields from previous steps.
The field type is String. This field is mandatory.
Button: Test ConnectionClick Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon S3 cloud instance.
For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.
INPUT tab:Input fields
Bucket NameSpecify the name of the bucket from which the objects are to be got.
The data type is String. This field is mandatory.
GetClick the button to populate the list of available Buckets.
PrefixSpecify the prefix parameter restricts the response to keys that begin with the specified prefix.
Note:
If the object resides in the folder, give prefix as foldername/<prefix>.
For example, testFolder/abc.
OUTPUT tab:Output fields
Object NameSpecify the output variable name in the field. The default output variable name: ObjectName.
The name of the Object (Key) in the bucket, returns the names of files and folders.
VersionSpecify the output variable name in the field. The default output variable name: Version.
Specifies the version ID of the Object.
Is LatestSpecify the output variable name in the field. The default output variable name: IsLatest.
Returns whether or not this version is the latest version for the associated object.
Is Delete MarkerSpecify the output variable name in the field. The default output variable name: IsDeleteMarker.
Returns whether or not this version represents a delete marker.