Skip to content

Commit fe33ce0

Browse files
committed
Updates for s3 v4 READMEs
1 parent 0fcb552 commit fe33ce0

4 files changed

Lines changed: 84 additions & 53 deletions

File tree

.doc_gen/metadata/s3_metadata.yaml

Lines changed: 46 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,17 @@ s3_CreateBucket:
8383
languages:
8484
.NET:
8585
versions:
86-
- sdk_version: 3
87-
github: dotnetv3/S3
86+
- sdk_version: 4
87+
github: dotnetv4/S3
8888
sdkguide:
8989
excerpts:
9090
- description:
9191
snippet_tags:
92-
- S3.dotnetv3.S3_Basics-CreateBucket
92+
- S3.dotnetv4.S3_Basics-CreateBucket
93+
- sdk_version: 3
94+
github: dotnetv3/S3
95+
sdkguide:
96+
excerpts:
9397
- description: Create a bucket with object lock enabled.
9498
snippet_tags:
9599
- S3LockWorkflow.dotnetv3.CreateBucketWithObjectLock
@@ -610,13 +614,17 @@ s3_DeleteObjects:
610614
languages:
611615
.NET:
612616
versions:
617+
- sdk_version: 4
618+
github: dotnetv4/S3
619+
sdkguide:
620+
excerpts:
621+
- description:
622+
snippet_tags:
623+
- S3.dotnetv4.S3_Basics-DeleteBucketContents
613624
- sdk_version: 3
614625
github: dotnetv3/S3
615626
sdkguide:
616627
excerpts:
617-
- description: Delete all objects in an S3 bucket.
618-
snippet_tags:
619-
- S3.dotnetv3.S3_Basics-DeleteBucketContents
620628
- description: Delete multiple objects in a non-versioned S3 bucket.
621629
snippet_tags:
622630
- S3.dotnetv3.DeleteMultipleObjectsExample
@@ -903,13 +911,17 @@ s3_GetObject:
903911
languages:
904912
.NET:
905913
versions:
906-
- sdk_version: 3
907-
github: dotnetv3/S3
914+
- sdk_version: 4
915+
github: dotnetv4/S3
908916
sdkguide:
909917
excerpts:
910918
- description:
911919
snippet_tags:
912-
- S3.dotnetv3.S3_Basics-DownloadObject
920+
- S3.dotnetv4.S3_Basics-DownloadObject
921+
- sdk_version: 3
922+
github: dotnetv3/S3
923+
sdkguide:
924+
excerpts:
913925
- description: Get an object using a conditional request.
914926
genai: some
915927
snippet_tags:
@@ -1437,13 +1449,17 @@ s3_ListObjectsV2:
14371449
languages:
14381450
.NET:
14391451
versions:
1440-
- sdk_version: 3
1441-
github: dotnetv3/S3
1452+
- sdk_version: 4
1453+
github: dotnetv4/S3
14421454
sdkguide:
14431455
excerpts:
14441456
- description:
14451457
snippet_tags:
1446-
- S3.dotnetv3.S3_Basics-ListBucketContents
1458+
- S3.dotnetv4.S3_Basics-ListBucketContents
1459+
- sdk_version: 3
1460+
github: dotnetv3/S3
1461+
sdkguide:
1462+
excerpts:
14471463
- description: List objects with a paginator.
14481464
snippet_tags:
14491465
- S3.dotnetv3.ListObjectsPaginatorExample
@@ -1601,13 +1617,17 @@ s3_PutObject:
16011617
languages:
16021618
.NET:
16031619
versions:
1604-
- sdk_version: 3
1605-
github: dotnetv3/S3
1620+
- sdk_version: 4
1621+
github: dotnetv4/S3
16061622
sdkguide:
16071623
excerpts:
16081624
- description:
16091625
snippet_tags:
1610-
- S3.dotnetv3.S3_Basics-UploadFile
1626+
- S3.dotnetv4.S3_Basics-UploadFile
1627+
- sdk_version: 3
1628+
github: dotnetv3/S3
1629+
sdkguide:
1630+
excerpts:
16111631
- description: Upload an object with server-side encryption.
16121632
snippet_tags:
16131633
- S3.dotnetv3.ServerSideEncryptionExample
@@ -1790,13 +1810,13 @@ s3_DeleteBucket:
17901810
languages:
17911811
.NET:
17921812
versions:
1793-
- sdk_version: 3
1794-
github: dotnetv3/S3
1813+
- sdk_version: 4
1814+
github: dotnetv4/S3
17951815
sdkguide:
17961816
excerpts:
17971817
- description:
17981818
snippet_tags:
1799-
- S3.dotnetv3.S3_Basics-DeleteBucket
1819+
- S3.dotnetv4.S3_Basics-DeleteBucket
18001820
C++:
18011821
versions:
18021822
- sdk_version: 1
@@ -3189,13 +3209,16 @@ s3_Scenario_GettingStarted:
31893209
languages:
31903210
.NET:
31913211
versions:
3192-
- sdk_version: 3
3193-
github: dotnetv3/S3/S3_Basics
3212+
- sdk_version: 4
3213+
github: dotnetv4/S3
31943214
sdkguide:
31953215
excerpts:
3196-
- description:
3216+
- description: Run an interactive scenario demonstrating &S3; features.
3217+
snippet_tags:
3218+
- S3.dotnetv4.S3_BasicsScenario
3219+
- description: A wrapper class for &S3; SDK methods.
31973220
snippet_tags:
3198-
- S3.dotnetv3.S3_BasicsScenario
3221+
- S3.dotnetv4.S3_BasicsBucket
31993222
Java:
32003223
versions:
32013224
- sdk_version: 2
@@ -3224,7 +3247,7 @@ s3_Scenario_GettingStarted:
32243247
- javascript.v3.utils.dirnameFromMetaUrl
32253248
- javascript.v3.utils.prompter
32263249
- javascript.v3.utils.wrapText
3227-
- description: Objects in S3 are stored in 'buckets'. Let's define a function for creating a new bucket.
3250+
- description: Objects are stored in 'buckets'. Let's define a function for creating a new bucket.
32283251
snippet_tags:
32293252
- javascript.v3.s3.scenarios.basic.CreateBucket
32303253
- description: Buckets contain 'objects'. This function uploads the contents of a directory to your bucket as

dotnetv3/S3/README.md

Lines changed: 5 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,36 +29,28 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
2929
<!--custom.prerequisites.start-->
3030
<!--custom.prerequisites.end-->
3131

32-
### Basics
33-
34-
Code examples that show you how to perform the essential operations within a service.
35-
36-
- [Learn the basics](S3_Basics/S3_Basics.cs)
37-
38-
3932
### Single actions
4033

4134
Code excerpts that show you how to call individual service functions.
4235

4336
- [CopyObject](CopyObjectExample/CopyObject.cs#L11)
44-
- [CreateBucket](S3_Basics/S3Bucket.cs#L12)
45-
- [DeleteBucket](S3_Basics/S3Bucket.cs#L266)
37+
- [CreateBucket](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L29)
4638
- [DeleteBucketCors](s3CORSExample/S3CORS.cs#L147)
4739
- [DeleteBucketLifecycle](LifecycleExample/Lifecycle.cs#L192)
4840
- [DeleteObject](non-versioned-examples/DeleteObjectExample/DeleteObject.cs#L6)
49-
- [DeleteObjects](S3_Basics/S3Bucket.cs#L221)
41+
- [DeleteObjects](non-versioned-examples/DeleteMultipleObjectsExample/DeleteMultipleObjects.cs#L6)
5042
- [GetBucketAcl](BucketACLExample/BucketACL.cs#L75)
5143
- [GetBucketCors](s3CORSExample/S3CORS.cs#L125)
5244
- [GetBucketEncryption](PutBucketEncryption/ServerSideEncryption/ServerSideEncryption.cs#L107)
5345
- [GetBucketLifecycleConfiguration](LifecycleExample/Lifecycle.cs#L169)
5446
- [GetBucketWebsite](WebsiteConfigExample/WebsiteConfig.cs#L72)
55-
- [GetObject](S3_Basics/S3Bucket.cs#L85)
47+
- [GetObject](scenarios/S3ConditionalRequestsScenario/S3ConditionalRequests/S3ActionsWrapper.cs#L32)
5648
- [GetObjectLegalHold](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L259)
5749
- [GetObjectLockConfiguration](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L290)
5850
- [GetObjectRetention](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L193)
5951
- [ListBuckets](ListBucketsExample/ListBuckets.cs#L4)
6052
- [ListObjectVersions](versioned-examples/ListObjectVersionsExample/ListObjectVersions.cs#L6)
61-
- [ListObjectsV2](S3_Basics/S3Bucket.cs#L171)
53+
- [ListObjectsV2](ListObjectsPaginatorExample/ListObjectsPaginator.cs#L6)
6254
- [PutBucketAccelerateConfiguration](TransferAccelerationExample/TransferAcceleration.cs#L6)
6355
- [PutBucketAcl](BucketACLExample/BucketACL.cs#L37)
6456
- [PutBucketCors](s3CORSExample/S3CORS.cs#L104)
@@ -67,7 +59,7 @@ Code excerpts that show you how to call individual service functions.
6759
- [PutBucketLogging](ServerAccessLoggingExample/ServerAccessLogging.cs#L6)
6860
- [PutBucketNotificationConfiguration](EnableNotificationsExample/EnableNotifications.cs#L6)
6961
- [PutBucketWebsite](WebsiteConfigExample/WebsiteConfig.cs#L57)
70-
- [PutObject](S3_Basics/S3Bucket.cs#L43)
62+
- [PutObject](ServerSideEncryptionExample/ServerSideEncryption.cs#L6)
7163
- [PutObjectLegalHold](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L224)
7264
- [PutObjectLockConfiguration](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L60)
7365
- [PutObjectRetention](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L102)
@@ -120,23 +112,6 @@ Alternatively, you can run the example from within your IDE.
120112
<!--custom.instructions.end-->
121113

122114

123-
#### Learn the basics
124-
125-
This example shows you how to do the following:
126-
127-
- Create a bucket and upload a file to it.
128-
- Download an object from a bucket.
129-
- Copy an object to a subfolder in a bucket.
130-
- List the objects in a bucket.
131-
- Delete the bucket objects and the bucket.
132-
133-
<!--custom.basic_prereqs.s3_Scenario_GettingStarted.start-->
134-
<!--custom.basic_prereqs.s3_Scenario_GettingStarted.end-->
135-
136-
137-
<!--custom.basics.s3_Scenario_GettingStarted.start-->
138-
<!--custom.basics.s3_Scenario_GettingStarted.end-->
139-
140115

141116
#### Create a presigned URL
142117

dotnetv4/S3/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,24 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv4
2929
<!--custom.prerequisites.start-->
3030
<!--custom.prerequisites.end-->
3131

32+
### Basics
33+
34+
Code examples that show you how to perform the essential operations within a service.
35+
36+
- [Learn the basics](Scenarios/S3_Basics/S3_Basics.cs)
37+
38+
3239
### Single actions
3340

3441
Code excerpts that show you how to call individual service functions.
3542

43+
- [CreateBucket](Scenarios/S3_Basics/S3Bucket.cs#L24)
3644
- [CreatePresignedPost](Scenarios/S3_CreatePresignedPost/S3Wrapper.cs#L35)
45+
- [DeleteBucket](Scenarios/S3_Basics/S3Bucket.cs#L261)
46+
- [DeleteObjects](Scenarios/S3_Basics/S3Bucket.cs#L224)
47+
- [GetObject](Scenarios/S3_Basics/S3Bucket.cs#L93)
48+
- [ListObjectsV2](Scenarios/S3_Basics/S3Bucket.cs#L175)
49+
- [PutObject](Scenarios/S3_Basics/S3Bucket.cs#L54)
3750

3851
### Scenarios
3952

@@ -55,6 +68,23 @@ functions within the same service.
5568
<!--custom.instructions.end-->
5669

5770

71+
#### Learn the basics
72+
73+
This example shows you how to do the following:
74+
75+
- Create a bucket and upload a file to it.
76+
- Download an object from a bucket.
77+
- Copy an object to a subfolder in a bucket.
78+
- List the objects in a bucket.
79+
- Delete the bucket objects and the bucket.
80+
81+
<!--custom.basic_prereqs.s3_Scenario_GettingStarted.start-->
82+
<!--custom.basic_prereqs.s3_Scenario_GettingStarted.end-->
83+
84+
85+
<!--custom.basics.s3_Scenario_GettingStarted.start-->
86+
<!--custom.basics.s3_Scenario_GettingStarted.end-->
87+
5888

5989
#### Create a presigned URL
6090

dotnetv4/S3/Scenarios/S3_Basics/S3Bucket.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
namespace S3_BasicsScenario;
5+
// snippet-start:[S3.dotnetv4.S3_BasicsBucket]
56

67
/// <summary>
78
/// This class contains all of the methods for working with Amazon Simple
@@ -283,3 +284,5 @@ public async Task<bool> DeleteBucketAsync(string bucketName)
283284

284285
// snippet-end:[S3.dotnetv4.S3_Basics-DeleteBucket]
285286
}
287+
288+
// snippet-end:[S3.dotnetv4.S3_BasicsBucket]

0 commit comments

Comments
 (0)