AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DeleteBucket operation. Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Permissions
  • General purpose bucket permissions - You must have the s3:DeleteBucket permission on the specified bucket in a policy.

  • Directory bucket permissions - You must have the s3express:DeleteBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucket:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.S3.Model.DeleteBucketRequest

Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C#
public class DeleteBucketRequest : AmazonWebServiceRequest
         IAmazonWebServiceRequest

The DeleteBucketRequest type exposes the following members

Constructors

NameDescription
Public Method DeleteBucketRequest()

Properties

NameTypeDescription
Public Property BucketName System.String

Gets and sets the property BucketName.

Specifies the bucket being deleted.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

Public Property BucketRegion Amazon.S3.S3Region

The region locality for the bucket.

Public Property ExpectedBucketOwner System.String

Gets and sets the property ExpectedBucketOwner.

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Public Property UseClientRegion System.Boolean

If set to true the bucket will be deleted in the same region as the configuration of the AmazonS3 client. DeleteBucketRequest.BucketRegion takes precedence over this property if both are set. Default: true.

Examples

This example shows how to delete an bucket.

DeleteBucket sample


// Create a client
AmazonS3Client client = new AmazonS3Client();

// Construct request
DeleteBucketRequest request = new DeleteBucketRequest
{
    BucketName = "SampleBucket"
};

// Issue call
DeleteBucketResponse response = client.DeleteBucket(request);

                

This example shows how to delete all items in a bucket, and then delete the actual bucket.

DeleteBucket sample


// Create a client
AmazonS3Client client = new AmazonS3Client();

// List and delete all objects
ListObjectsRequest listRequest = new ListObjectsRequest
{
    BucketName = "SampleBucket"
};

ListObjectsResponse listResponse;
do
{
    // Get a list of objects
    listResponse = client.ListObjects(listRequest);
    foreach (S3Object obj in listResponse.S3Objects)
    {
        // Delete each object
        client.DeleteObject(new DeleteObjectRequest
        {
            BucketName = "SampleBucket",
            Key = obj.Key
        });
    }

    // Set the marker property
    listRequest.Marker = listResponse.NextMarker;
} while (listResponse.IsTruncated);

// Construct DeleteBucket request
DeleteBucketRequest request = new DeleteBucketRequest
{
    BucketName = "SampleBucket"
};

// Issue call
DeleteBucketResponse response = client.DeleteBucket(request);

                

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5