DeleteBucket
Delete AWS S3 Bucket.
Task version: 2.1.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.AmazonS3
Task Parameters
BucketName : String
AWS S3 bucket's name to be deleted.
Must follow AWS S3 bucket naming requirements.
See https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
Default: -
Example: my-example-bucket
🗝AwsAccessKeyId : String
AWS Access Key ID for authentication.
This is the public part of your AWS credentials.
Default: -
Example: AKIAQWERTY7NJ5Q7NZ6Q
🗝AwsSecretAccessKey : String
AWS Secret Access Key for authentication.
This is the private part of your AWS credentials and should be kept secure.
Default: -
Example: TVh5hgd3uGY/2CqH+Kkrrg3dadbXLsYe0jC3h+WD
Region : Region
AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
Possible values:
AfSouth1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
ApEast1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
ApNortheast1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
ApNortheast2: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
ApNortheast3: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
ApSouth1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
ApSoutheast1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
ApSoutheast2: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
CaCentral1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
CnNorth1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
CnNorthWest1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
EuCentral1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
EuNorth1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
EuSouth1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
EuWest1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
EuWest2: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
EuWest3: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
MeSouth1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
SaEast1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
UsEast1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
UsEast2: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
UsWest1: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
UsWest2: AWS region where the S3 bucket is located.
Must match the region where the bucket was created.
Default: -
Example: EuCentral1
ThrowErrorOnFailure : Boolean
Determines whether to throw an exception when the operation fails.
If false, errors will be returned in the Result object instead of throwing exceptions.
Default: True
Example: false
ErrorMessageOnFailure : String
Custom error message to use when an error occurs.
If empty, a default error message will be used.
This message will be included in both thrown exceptions and Error objects.
Default: -
Example: Failed to delete the specified S3 bucket
Task Result
Success : Boolean
Indicates whether the delete bucket operation completed successfully. Returns true if the bucket was deleted or if the bucket did not exist. Returns false only when an error occurred and ThrowErrorOnFailure is false.
Example: true
Error : Error
Contains error information when the operation fails. This property is null when Success is true. Only populated when ThrowErrorOnFailure is false and an error occurs.
Example: null
Task Changelog
Changelog for Task Frends.AmazonS3.DeleteBucket.
[2.1.0] - 2025-12-29
Changed
Updated AWS SDK version.
[2.0.0] - 2025-07-16
[Breaking] Moved
Connection.BucketNametoInput.BucketName- update your processes to use the Input tab for bucket name configuration[Breaking] Added new
Optionsparameter class with error handling configuration[Breaking] Updated Result class structure - removed
Dataproperty and addedErrorproperty for consistent error reportingAdded
ThrowErrorOnFailureoption (default: false) to control exception throwing behaviorAdded
ErrorMessageOnFailureoption for custom error messagesUpdated project to target .NET 8.0 for improved performance and compatibility
Enhanced XML documentation with better examples and descriptions
[1.0.0] - 2023-07-31
Added
Initial implementation
Last updated
Was this helpful?