Amazon S3: Get Objects From Bucket
Description
Amazon S3: Get Objects From Bucket plugin step Gets the list of objects from a bucket on Amazon S3. The call returns some or all (up to 1000) objects in a bucket.
Notes:
- To get the list of objects from a bucket a user must have Read permission on the bucket.
- Provide access (whitelist) to the following URLs through your firewall and network, https://amazonaws.com/.
Reference
REST API: Get Objects From Bucket
Configurations
| Field Name | Description |
|---|---|
| Step Name | Specify a unique name for the step. |
| CONNECTION tab: | Connection fields |
| Region | Specify 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: Get | Click 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 fields | Leave 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 Key | Specify 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 fields | Leave 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 Key | Specify 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 Connection | Click 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 Name | Specify the name of the S3 bucket to get objects. The data type is String. This field is mandatory. |
| Get | Click the button to populate the list of available Buckets. |
| OUTPUT tab: | Output fields |
| Object Name | Specify 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. |
| ETag | Specify the output variable name in the field. The default output variable name: ETag The ETag (entity tag) is the hash of an object. |
| Object Size | Specify the output variable name in the field. The default output variable name: ObjectSize. The object size returns the size of each object in the bucket. |
| Last Modified | Specify the output variable name in the field. The default output variable name: LastModified. The last modified is the date of the modification of the objects. |
| Storage Class | Specify the output variable name in the field. The default output variable name: StorageClass. It returns the Storage class of the object in which that object is stored in. Storage classes offer higher durability. |