AWS-Enabling versioning on buckets

March 1, 2023 . 4 MIN READ

You can use S3 Versioning to keep multiple versions of an object in one bucket. This section provides examples of how to enable versioning on a bucket using the console, REST API, AWS SDKs, and AWS Command Line Interface (AWS CLI).

Note

After enabling versioning on a bucket for the first time, it may take up to 15 minutes for the change to fully propagate across the S3 system. During this time, GET requests for objects created or updated after enabling versioning may result in HTTP 404 NoSuchKey errors. We recommend waiting 15 minutes after enabling versioning before performing any write operations (PUT or DELETE) on objects in the bucket. This waiting period helps avoid potential issues with object visibility and version tracking.

For more information about S3 Versioning, see Retaining multiple versions of objects with S3 Versioning. For information about working with objects that are in versioning-enabled buckets, see Working with objects in a versioning-enabled bucket.

To learn more about how to use S3 Versioning to protect data, see Tutorial: Protecting data on Amazon S3 against accidental deletion or application bugs using S3 Versioning, S3 Object Lock, and S3 Replication.

Each S3 bucket that you create has a versioning subresource associated with it. (For more information, see General purpose buckets configuration options.) By default, your bucket is unversioned, and the versioning subresource stores the empty versioning configuration, as follows.

To enable versioning, you can send a request to Amazon S3 with a versioning configuration that includes a status.

<VersioningConfiguration xmlns=”http://s3.amazonaws.com/doc/2006-03-01/”>
<Status>Enabled</Status>
</VersioningConfiguration>To suspend versioning, you set the status value to Suspended.

The bucket owner and all authorized users can enable versioning. The bucket owner is the AWS account that created the bucket (the root account). For more information about permissions, see Identity and Access Management for Amazon S3.

The following sections provide more detail about enabling S3 Versioning using the console, AWS CLI, and the AWS SDKs.

Using the S3 console

Follow these steps to use the AWS Management Console to enable versioning on an S3 bucket.

To enable or disable versioning on an S3 general purpose bucket

Sign in to the AWS Management Console and open the Amazon S3 console at https://console.aws.amazon.com/s3/.
In the left navigation pane, choose General purpose buckets.
In the buckets list, choose the name of the bucket that you want to enable versioning for.
Choose Properties.
Under Bucket Versioning, choose Edit.
Choose Suspend or Enable, and then choose Save changes.

Note

You can use AWS multi-factor authentication (MFA) with versioning. When you use MFA with versioning, you must provide your AWS account’s access keys and a valid code from the account’s MFA device to permanently delete an object version or suspend or reactivate versioning.

To use MFA with versioning, you enable MFA Delete. However, you can’t enable MFA Delete using the AWS Management Console. You must use the AWS Command Line Interface (AWS CLI) or the API. For more information, see Configuring MFA delete.

Using the AWS CLI

The following example enables versioning on an S3 general purpose bucket.

aws s3api put-bucket-versioning –bucket amzn-s3-demo-bucket1 –versioning-configuration Status=Enabled

The following example enables S3 Versioning and multi-factor authentication (MFA) delete on a bucket for a physical MFA device. For physical MFA devices, in the --mfa parameter, pass a concatenation of the MFA device serial number, a space character, and the value that is displayed on your authentication device.

aws s3api put-bucket-versioning –bucket amzn-s3-demo-bucket1 –versioning-configuration Status=Enabled,MFADelete=Enabled –mfa “SerialNumber 123456”

The following example enables S3 Versioning and multi-factor authentication (MFA) delete on a bucket for a virtual MFA device. For virtual MFA devices, in the --mfa parameter, pass a concatenation of the MFA device ARN, a space character, and the value that is displayed on your authentication device.

aws s3api put-bucket-versioning –bucket amzn-s3-demo-bucket1 –versioning-configuration Status=Enabled,MFADelete=Enabled –mfa “arn:aws:iam::account-id:mfa/root-account-mfa-device 123789”

Note

Using MFA delete requires an approved physical or virtual authentication device. For more information about using MFA delete in Amazon S3, see Configuring MFA delete.

For more information about enabling versioning using the AWS CLI, see put-bucket-versioning in the AWS CLI Command Reference.

Using the AWS SDKs

The following examples enable versioning on a bucket and then retrieve versioning status using the AWS SDK for Java and the AWS SDK for .NET. For information about using other AWS SDKs, see the AWS Developer Center

For information about setting up and running the code examples, see Getting Started with the AWS SDK for .NET in the AWS SDK for .NET Developer Guide.

using System;
using Amazon.S3;
using Amazon.S3.Model;

namespace s3.amazon.com.docsamples
{
class BucketVersioningConfiguration
{
static string bucketName = “*** bucket name ***”;

public static void Main(string[] args)
{
using (var client = new AmazonS3Client(Amazon.RegionEndpoint.USEast1))
{
try
{
EnableVersioningOnBucket(client);
string bucketVersioningStatus = RetrieveBucketVersioningConfiguration(client);
}
catch (AmazonS3Exception amazonS3Exception)
{
if (amazonS3Exception.ErrorCode != null &&
(amazonS3Exception.ErrorCode.Equals(“InvalidAccessKeyId”)
||
amazonS3Exception.ErrorCode.Equals(“InvalidSecurity”)))
{
Console.WriteLine(“Check the provided AWS Credentials.”);
Console.WriteLine(
“To sign up for service, go to http://aws.amazon.com/s3”);
}
else
{
Console.WriteLine(
“Error occurred. Message:'{0}’ when listing objects”,
amazonS3Exception.Message);
}
}
}

Console.WriteLine(“Press any key to continue…”);
Console.ReadKey();
}

static void EnableVersioningOnBucket(IAmazonS3 client)
{

PutBucketVersioningRequest request = new PutBucketVersioningRequest
{
BucketName = bucketName,
VersioningConfig = new S3BucketVersioningConfig
{
Status = VersionStatus.Enabled
}
};

PutBucketVersioningResponse response = client.PutBucketVersioning(request);
}

static string RetrieveBucketVersioningConfiguration(IAmazonS3 client)
{
GetBucketVersioningRequest request = new GetBucketVersioningRequest
{
BucketName = bucketName
};

GetBucketVersioningResponse response = client.GetBucketVersioning(request);
return response.VersioningConfig.Status;
}
}
}

Reference:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html