You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the
bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the
bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a
GetBucketVersioning request does not return a versioning state value.
In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner
and want to enable MFA Delete in the bucket versioning configuration, you must
include the x-amz-mfa request header and the
Status and the MfaDelete request elements in a request to set
the versioning state of the bucket.
If you have an object expiration lifecycle policy in your non-versioned bucket and
you want to maintain the same permanent delete behavior when you enable versioning, you
must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will
manage the deletes of the noncurrent object versions in the version-enabled bucket. (A
version-enabled bucket maintains one current and zero or more noncurrent object
versions.) For more information, see Lifecycle and Versioning.
Sets the versioning state of an existing bucket.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the
x-amz-mfa request
header and theStatus
and theMfaDelete
request elements in a request to set the versioning state of the bucket.If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
Related Resources
CreateBucket
DeleteBucket
GetBucketVersioning
Use a bare-bones client and the command you need to make an API call.
import { S3Client, PutBucketVersioningCommand } from "@aws-sdk/client-s3"; // ES Modules import // const { S3Client, PutBucketVersioningCommand } = require("@aws-sdk/client-s3"); // CommonJS import const client = new S3Client(config); const command = new PutBucketVersioningCommand(input); const response = await client.send(command);
PutBucketVersioningCommandInput for command's
input
shape.PutBucketVersioningCommandOutput for command's
response
shape.config for S3Client's
config
shape.