ListObjects

Lists objects from specified AWS S3 Bucket.

Task version: 3.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Source code: https://github.com/FrendsPlatform/Frends.AmazonS3

Task Parameters

Input

Name	Description
BucketName : String	The name of the S3 bucket to list objects from. Default: - Example: my-s3-bucket

Connection

Name	Description
🗝AwsAccessKeyId : String	AWS Access Key ID used for authentication with AWS services. Default: - Example: AKIAQWERTY7NJ5Q7NZ6Q
🗝AwsSecretAccessKey : String	AWS Secret Access Key used for authentication with AWS services. Default: - Example: TVh5hgd3uGY/2CqH+Kkrrg3dadbXLsYe0jC3h+WD
Region : Region	AWS Region where the S3 bucket is located. Possible values: AfSouth1: AWS Region where the S3 bucket is located. ApEast1: AWS Region where the S3 bucket is located. ApNortheast1: AWS Region where the S3 bucket is located. ApNortheast2: AWS Region where the S3 bucket is located. ApNortheast3: AWS Region where the S3 bucket is located. ApSouth1: AWS Region where the S3 bucket is located. ApSoutheast1: AWS Region where the S3 bucket is located. ApSoutheast2: AWS Region where the S3 bucket is located. CaCentral1: AWS Region where the S3 bucket is located. CnNorth1: AWS Region where the S3 bucket is located. CnNorthWest1: AWS Region where the S3 bucket is located. EuCentral1: AWS Region where the S3 bucket is located. EuNorth1: AWS Region where the S3 bucket is located. EuSouth1: AWS Region where the S3 bucket is located. EuWest1: AWS Region where the S3 bucket is located. EuWest2: AWS Region where the S3 bucket is located. EuWest3: AWS Region where the S3 bucket is located. MeSouth1: AWS Region where the S3 bucket is located. SaEast1: AWS Region where the S3 bucket is located. UsEast1: AWS Region where the S3 bucket is located. UsEast2: AWS Region where the S3 bucket is located. UsWest1: AWS Region where the S3 bucket is located. UsWest2: AWS Region where the S3 bucket is located. Default: - Example: EuCentral1

Options

Name	Description
Prefix : String	Limits the response to keys that begin with the specified prefix. Default: - Example: bucket/object1/object2
Delimiter : String	A delimiter character used to group keys hierarchically. See: http://docs.aws.amazon.com/AmazonS3/latest/dev/ListingKeysHierarchy.html Default: - Example: /
MaxKeys : Int32	Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more than this value. Default: 1000 Example: 1000
StartAfter : String	StartAfter specifies the key to start listing from (exclusive). For example, in a bucket with objects { 20220401, 20220402, 20220403 }, StartAfter=20220401 returns objects 20220402 and 20220403. Default: - Example: 20220401
ThrowErrorOnFailure : Boolean	Determines whether to throw an exception on failure. If set to false, returns a Result object with error information instead. Default: True Example: true
ErrorMessageOnFailure : String	Custom error message to return when ThrowErrorOnFailure is false. If not specified, the original error message will be used. Default: - Example: Failed to create object list

Task Result

Name	Description
Objects : List<BucketObject>	List of objects retrieved from the S3 bucket. Empty list if operation failed. Example: [ { BucketName: "my-bucket", Key: "folder/file.txt", ... } ]
Success : Boolean	Indicates whether the operation was successful. Example: true
Error : Error	Error information if the operation failed. Example: object { Error Message, dynamic AdditionalInfo }
Error.Message : String	The primary error message describing what went wrong. Example: Unable to list objects.
Error.AdditionalInfo : Object	Additional error information such as stack traces, error codes, or other diagnostic data. Example: object { Exception AdditionalInfo }
ErrorMessage : String	Error message if the operation failed. Returns empty string if operation succeeded. Provided for backward compatibility - use Error property for detailed error information. Example: Unable to list objects.

Task Changelog

Changelog for Task Frends.AmazonS3.ListObjects.

[3.0.0] - 2026-07-18

Changed

• [Breaking] The parameter order of the ListObjects task has been updated to follow the standard Frends parameter order: Input, Connection, Options. This may require reconfiguring the task in existing processes.
• Added missing documentation examples for result and error output properties.

[2.2.0] - 2026-06-16

Changed

• Updated AWSSDK.Core nuget package from 4.0.3.5 to 4.0.8
• Updated AWSSDK.S3 nuget package from 4.0.14.2 to 4.0.24.1
• Introduce more null checks to avoid unexpected exceptions

[2.1.0] - 2025-12-29

Changed

• Updated AWS SDK version.

[2.0.0] - 2025-07-17

[Breaking] Major refactoring with new class structure and error handling

Added

• Connection class: New dedicated class for AWS connection parameters

  • AwsAccessKeyId - AWS access key ID for authentication
  • AwsSecretAccessKey - AWS secret access key for authentication
  • Region - AWS region for the S3 service
• Options class: New class for task configuration options

  • ThrowErrorOnFailure - Boolean flag to control error throwing behavior (default: false)
  • ErrorMessageOnFailure - Custom error message for failures (default: empty string)
• Error class: New structured error handling

  • Message - Error message string
  • AdditionalInfo - Dynamic property for additional error context
• ErrorHandler class: New static utility class for centralized error handling

  • Handle method for consistent error processing across the task
• Result.Success: New boolean property indicating task execution success
• Result.Error: New error property for structured error information

Changed

• [Breaking] Renamed Source class to Input class
• [Breaking] Moved AWS credentials from Input to Connection class:

  • Input.AwsAccessKeyId → Connection.AwsAccessKeyId
  • Input.AwsSecretAccessKey → Connection.AwsSecretAccessKey
  • Input.Region → Connection.Region
• [Breaking] Renamed Result.ObjectList to Result.Objects
• [Breaking] Task method signature now includes Connection and Options parameters
• Improved error handling with consistent error structure and configurable error behavior

[1.0.0] - 2022-04-25

Added

• Initial implementation