# ListObjectVersions

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

Source code: <https://github.com/FrendsPlatform/Frends.AmazonS3/tree/main/Frends.AmazonS3.ListObjectVersions>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name                  | Description                                                                                                                            |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| BucketName : `String` | <p>The name of the S3 bucket to list object versions from.</p><p><br>Default: <code>-</code><br>Example: <code>my-s3-bucket</code></p> |
| {% endtab %}          |                                                                                                                                        |

{% tab title="Parameter: Connection" %}

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

{% tab title="Parameter: Options" %}

| Name                             | Description                                                                                                                                                                                                                                                                           |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Prefix : `String`                | <p>Limits the response to keys that begin with the specified prefix.</p><p><br>Default: <code>-</code><br>Example: <code>bucket/object1/object2</code></p>                                                                                                                            |
| MaxKeys : `Int32`                | <p>Sets the maximum number of keys returned in one response.</p><p>The response might contain fewer keys but will never contain more than this value.</p><p>Multiple responses will be merged into one result.</p><p><br>Default: <code>1000</code><br>Example: <code>1000</code></p> |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an error on failure.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                                                                                                                                                                       |
| ErrorMessageOnFailure : `String` | <p>Overrides the error message on failure.</p><p><br>Default: <code>-</code><br>Example: <code>Custom error message</code></p>                                                                                                                                                        |
| {% endtab %}                     |                                                                                                                                                                                                                                                                                       |

{% tab title="Result: Result" %}

| Name                                   | Description                                                                                                                    |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Success : `Boolean`                    | <p>Indicates if the task completed successfully.<br>Example: <code>true</code></p>                                             |
| Objects : `List<BucketObjectVersions>` | <p>List of objects retrieved from the S3 bucket. Empty list if operation failed.<br>Example: <code>\[{}, {}]</code></p>        |
| Error : `Error`                        | <p>Error that occurred during task execution.<br>Example: <code>object { string Message, Exception AdditionalInfo }</code></p> |
| {% endtab %}                           |                                                                                                                                |

{% tab title="Changelog" %}

## Changelog

### \[1.1.0] - 2026-02-23

#### Fixed

* Ensure FrendsTaskMetadata.json is included in NuGet package

### \[1.0.0] - 2026-02-04

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}