@@ -170,7 +170,7 @@ when creating the bucket.
170170Example using the Go SDK ` github.com/aws/aws-sdk-go-v2/service/s3 ` :
171171
172172``` go
173- func createBucketWithSnapshottingEnabled (ctx context .Context , client *s3 .Client , bucketName string ) error {
173+ func createBucketWithSnapshotEnabled (ctx context .Context , client *s3 .Client , bucketName string ) error {
174174 _ , err := client.CreateBucket (ctx, &s3.CreateBucketInput {Bucket: aws.String (bucketName)}, func (options *s3.Options ) {
175175 options.APIOptions = append (options.APIOptions , http.AddHeaderValue (" X-Tigris-Enable-Snapshot" , " true" ))
176176 })
@@ -201,7 +201,7 @@ if (result.error) {
201201Example using the Python SDK boto3:
202202
203203``` python
204- def create_bucket_with_snapshotting_enabled (tigris , bucket_name ):
204+ def create_bucket_with_snapshot_enabled (tigris , bucket_name ):
205205 def add_header (request , ** kwargs ):
206206 request.headers[" X-Tigris-Enable-Snapshot" ] = " true"
207207 tigris.meta.events.register(" before-sign.s3.CreateBucket" , add_header)
@@ -429,14 +429,14 @@ def create_bucket_fork(tigris, bucket_name):
429429</TabItem >
430430</Tabs >
431431
432- ### Retrieving Snapshotting and Forking Info for a Bucket
432+ ### Retrieving Snapshot and Fork Info for a Bucket
433433
434- Snapshotting and forking related information for an existing bucket can be
434+ Information related to snapshots and forks for an existing bucket can be
435435retrieved by making a HeadBucket request. The response of the request will
436436include custom Tigris headers with the details:
437437
438438- The ` X-Tigris-Enable-Snapshot ` header will always be present and will be set
439- to "true" for snapshotting -enabled buckets.
439+ to "true" for snapshot -enabled buckets.
440440- ` X-Tigris-Fork-Source-Bucket ` and ` X-Tigris-Fork-Source-Bucket-Snapshot ` will
441441 only be set for fork buckets and will contain the fork parent bucket name and
442442 snapshot versions respectively.
@@ -445,14 +445,14 @@ include custom Tigris headers with the details:
445445
446446Note: These are not standard AWS S3 headers, and in order to retrieve them, the
447447raw HTTP response will need to be used. Here is an example for checking whether
448- snapshotting is enabled for a bucket:
448+ snapshot is enabled for a bucket:
449449
450450<Tabs groupId = " languages" >
451451<TabItem value = " go" label = " Go" >
452452Example using the Go SDK ` github.com/aws/aws-sdk-go-v2/service/s3 ` :
453453
454454``` go
455- func hasSnapshottingEnabled (ctx context .Context , client *s3 .Client , bucketName string ) (bool , error ) {
455+ func hasSnapshotEnabled (ctx context .Context , client *s3 .Client , bucketName string ) (bool , error ) {
456456 resp , err := client.HeadBucket (ctx, &s3.HeadBucketInput {Bucket: aws.String (bucketName)})
457457 if err != nil {
458458 return false , err
@@ -470,7 +470,7 @@ Example using the AWS SDK for JavaScript v3:
470470``` js
471471import { S3Client , HeadBucketCommand } from " @aws-sdk/client-s3" ;
472472
473- async function hasSnapshottingEnabled (s3Client , bucketName ) {
473+ async function hasSnapshotEnabled (s3Client , bucketName ) {
474474 const response = await s3Client .send (
475475 new HeadBucketCommand ({ Bucket: bucketName }),
476476 );
@@ -484,7 +484,7 @@ async function hasSnapshottingEnabled(s3Client, bucketName) {
484484Example using the Python SDK boto3:
485485
486486` ` ` python
487- def has_snapshotting_enabled (tigris, bucket_name):
487+ def has_snapshot_enabled (tigris, bucket_name):
488488 response = tigris .head_bucket (Bucket= bucket_name)
489489 headers = response .get (" ResponseMetadata" , {}).get (" HTTPHeaders" , {})
490490 return headers .get (" x-tigris-enable-snapshot" , " " ) == " true"
@@ -565,27 +565,25 @@ buckets depend on it.
565565
566566### Authorization
567567
568- Snapshotting and forking operations on existing buckets are limited to users who
569- are bucket owners, organization admins, or have ` ReadOnly` (or ` Editor` ) access
570- to the buckets. This includes all operations mentioned above, such as creating a
568+ Snapshot and fork operations on existing buckets are limited to users who are
569+ bucket owners, organization admins, or have ` ReadOnly` (or ` Editor` ) access to
570+ the buckets. This includes all operations mentioned above, such as creating a
571571snapshot, creating a fork from a specific parent bucket, or listing objects in a
572572snapshot.
573573
574574## Limitations and Upcoming Functionality
575575
576576### Current Limitations
577577
578- Currently, bucket snapshotting and forking functionality have the following
578+ Currently, bucket snapshot and fork functionality have the following
579579limitations:
580580
581- - Once snapshotting support is enabled for a bucket, it cannot be disabled.
582- - Object expiration (TTL) cannot be enabled for buckets with snapshotting or
583- forking enabled.
581+ - Once snapshot support is enabled for a bucket, it cannot be disabled.
582+ - Object expiration (TTL) cannot be enabled for buckets with snapshot support.
584583- Transitioning objects to different storage tiers cannot be configured for
585- buckets with snapshotting or forking enabled.
586- - Only the standard storage tier is allowed for buckets with snapshotting or
587- forking enabled.
588- - Snapshotting and forking cannot be enabled for existing buckets.
584+ snapshot-enabled buckets.
585+ - Only the Standard storage tier is supported for snapshot-enabled buckets.
586+ - Snapshot support cannot be enabled for existing buckets.
589587
590588### Upcoming Features
591589
0 commit comments