Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 62 additions & 26 deletions .doc_gen/metadata/s3_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ s3_Hello:
synopsis: get started using &S3;.
category: Hello
languages:
.NET:
versions:
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
snippet_tags:
- S3.dotnetv4.S3_Hello
Java:
versions:
- sdk_version: 2
Expand Down Expand Up @@ -83,13 +92,17 @@ s3_CreateBucket:
languages:
.NET:
versions:
- sdk_version: 3
github: dotnetv3/S3
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
snippet_tags:
- S3.dotnetv3.S3_Basics-CreateBucket
- S3.dotnetv4.S3_Basics-CreateBucket
- sdk_version: 3
github: dotnetv3/S3
sdkguide:
excerpts:
- description: Create a bucket with object lock enabled.
snippet_tags:
- S3LockWorkflow.dotnetv3.CreateBucketWithObjectLock
Expand Down Expand Up @@ -230,12 +243,16 @@ s3_CopyObject:
languages:
.NET:
versions:
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
snippet_tags:
- S3.dotnetv4.S3_Basics-CopyObject
- sdk_version: 3
github: dotnetv3/S3
excerpts:
- description:
snippet_tags:
- S3.dotnet35.CopyObject
- description: Copy an object using a conditional request.
genai: some
snippet_tags:
Expand Down Expand Up @@ -610,13 +627,17 @@ s3_DeleteObjects:
languages:
.NET:
versions:
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
snippet_tags:
- S3.dotnetv4.S3_Basics-DeleteBucketContents
- sdk_version: 3
github: dotnetv3/S3
sdkguide:
excerpts:
- description: Delete all objects in an S3 bucket.
snippet_tags:
- S3.dotnetv3.S3_Basics-DeleteBucketContents
- description: Delete multiple objects in a non-versioned S3 bucket.
snippet_tags:
- S3.dotnetv3.DeleteMultipleObjectsExample
Expand Down Expand Up @@ -903,13 +924,17 @@ s3_GetObject:
languages:
.NET:
versions:
- sdk_version: 3
github: dotnetv3/S3
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
snippet_tags:
- S3.dotnetv3.S3_Basics-DownloadObject
- S3.dotnetv4.S3_Basics-DownloadObject
- sdk_version: 3
github: dotnetv3/S3
sdkguide:
excerpts:
- description: Get an object using a conditional request.
genai: some
snippet_tags:
Expand Down Expand Up @@ -1437,13 +1462,17 @@ s3_ListObjectsV2:
languages:
.NET:
versions:
- sdk_version: 3
github: dotnetv3/S3
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
snippet_tags:
- S3.dotnetv3.S3_Basics-ListBucketContents
- S3.dotnetv4.S3_Basics-ListBucketContents
- sdk_version: 3
github: dotnetv3/S3
sdkguide:
excerpts:
- description: List objects with a paginator.
snippet_tags:
- S3.dotnetv3.ListObjectsPaginatorExample
Expand Down Expand Up @@ -1601,13 +1630,17 @@ s3_PutObject:
languages:
.NET:
versions:
- sdk_version: 3
github: dotnetv3/S3
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
snippet_tags:
- S3.dotnetv3.S3_Basics-UploadFile
- S3.dotnetv4.S3_Basics-UploadFile
- sdk_version: 3
github: dotnetv3/S3
sdkguide:
excerpts:
- description: Upload an object with server-side encryption.
snippet_tags:
- S3.dotnetv3.ServerSideEncryptionExample
Expand Down Expand Up @@ -1790,13 +1823,13 @@ s3_DeleteBucket:
languages:
.NET:
versions:
- sdk_version: 3
github: dotnetv3/S3
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
snippet_tags:
- S3.dotnetv3.S3_Basics-DeleteBucket
- S3.dotnetv4.S3_Basics-DeleteBucket
C++:
versions:
- sdk_version: 1
Expand Down Expand Up @@ -3189,13 +3222,16 @@ s3_Scenario_GettingStarted:
languages:
.NET:
versions:
- sdk_version: 3
github: dotnetv3/S3/S3_Basics
- sdk_version: 4
github: dotnetv4/S3
sdkguide:
excerpts:
- description:
- description: Run an interactive scenario demonstrating &S3; features.
snippet_tags:
- S3.dotnetv4.S3_BasicsScenario
- description: A wrapper class for &S3; SDK methods.
snippet_tags:
- S3.dotnetv3.S3_BasicsScenario
- S3.dotnetv4.S3_BasicsBucket
Java:
versions:
- sdk_version: 2
Expand Down Expand Up @@ -3224,7 +3260,7 @@ s3_Scenario_GettingStarted:
- javascript.v3.utils.dirnameFromMetaUrl
- javascript.v3.utils.prompter
- javascript.v3.utils.wrapText
- description: Objects in S3 are stored in 'buckets'. Let's define a function for creating a new bucket.
- description: Objects are stored in 'buckets'. Let's define a function for creating a new bucket.
snippet_tags:
- javascript.v3.s3.scenarios.basic.CreateBucket
- description: Buckets contain 'objects'. This function uploads the contents of a directory to your bucket as
Expand Down
37 changes: 6 additions & 31 deletions dotnetv3/S3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,36 +29,28 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Basics

Code examples that show you how to perform the essential operations within a service.

- [Learn the basics](S3_Basics/S3_Basics.cs)


### Single actions

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

- [CopyObject](CopyObjectExample/CopyObject.cs#L11)
- [CreateBucket](S3_Basics/S3Bucket.cs#L12)
- [DeleteBucket](S3_Basics/S3Bucket.cs#L266)
- [CopyObject](scenarios/S3ConditionalRequestsScenario/S3ConditionalRequests/S3ActionsWrapper.cs#L137)
- [CreateBucket](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L29)
- [DeleteBucketCors](s3CORSExample/S3CORS.cs#L147)
- [DeleteBucketLifecycle](LifecycleExample/Lifecycle.cs#L192)
- [DeleteObject](non-versioned-examples/DeleteObjectExample/DeleteObject.cs#L6)
- [DeleteObjects](S3_Basics/S3Bucket.cs#L221)
- [DeleteObjects](non-versioned-examples/DeleteMultipleObjectsExample/DeleteMultipleObjects.cs#L6)
- [GetBucketAcl](BucketACLExample/BucketACL.cs#L75)
- [GetBucketCors](s3CORSExample/S3CORS.cs#L125)
- [GetBucketEncryption](PutBucketEncryption/ServerSideEncryption/ServerSideEncryption.cs#L107)
- [GetBucketLifecycleConfiguration](LifecycleExample/Lifecycle.cs#L169)
- [GetBucketWebsite](WebsiteConfigExample/WebsiteConfig.cs#L72)
- [GetObject](S3_Basics/S3Bucket.cs#L85)
- [GetObject](scenarios/S3ConditionalRequestsScenario/S3ConditionalRequests/S3ActionsWrapper.cs#L32)
- [GetObjectLegalHold](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L259)
- [GetObjectLockConfiguration](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L290)
- [GetObjectRetention](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L193)
- [ListBuckets](ListBucketsExample/ListBuckets.cs#L4)
- [ListObjectVersions](versioned-examples/ListObjectVersionsExample/ListObjectVersions.cs#L6)
- [ListObjectsV2](S3_Basics/S3Bucket.cs#L171)
- [ListObjectsV2](ListObjectsPaginatorExample/ListObjectsPaginator.cs#L6)
- [PutBucketAccelerateConfiguration](TransferAccelerationExample/TransferAcceleration.cs#L6)
- [PutBucketAcl](BucketACLExample/BucketACL.cs#L37)
- [PutBucketCors](s3CORSExample/S3CORS.cs#L104)
Expand All @@ -67,7 +59,7 @@ Code excerpts that show you how to call individual service functions.
- [PutBucketLogging](ServerAccessLoggingExample/ServerAccessLogging.cs#L6)
- [PutBucketNotificationConfiguration](EnableNotificationsExample/EnableNotifications.cs#L6)
- [PutBucketWebsite](WebsiteConfigExample/WebsiteConfig.cs#L57)
- [PutObject](S3_Basics/S3Bucket.cs#L43)
- [PutObject](ServerSideEncryptionExample/ServerSideEncryption.cs#L6)
- [PutObjectLegalHold](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L224)
- [PutObjectLockConfiguration](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L60)
- [PutObjectRetention](scenarios/S3ObjectLockScenario/S3ObjectLockWorkflow/S3ActionsWrapper.cs#L102)
Expand Down Expand Up @@ -120,23 +112,6 @@ Alternatively, you can run the example from within your IDE.
<!--custom.instructions.end-->


#### Learn the basics

This example shows you how to do the following:

- Create a bucket and upload a file to it.
- Download an object from a bucket.
- Copy an object to a subfolder in a bucket.
- List the objects in a bucket.
- Delete the bucket objects and the bucket.

<!--custom.basic_prereqs.s3_Scenario_GettingStarted.start-->
<!--custom.basic_prereqs.s3_Scenario_GettingStarted.end-->


<!--custom.basics.s3_Scenario_GettingStarted.start-->
<!--custom.basics.s3_Scenario_GettingStarted.end-->


#### Create a presigned URL

Expand Down
2 changes: 2 additions & 0 deletions dotnetv4/.editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -167,3 +167,5 @@ dotnet_diagnostic.S1104.severity = none
dotnet_diagnostic.S1854.severity = none
# SA1401: Disable encapsulation warnings.
dotnet_diagnostic.SA1401.severity = none
# CS8632: Disable nullable warnings.
dotnet_diagnostic.CS8632.severity = none
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.*" />
<PackageReference Include="Moq" Version="4.*" />
<PackageReference Include="xunit" Version="2.*" />
<PackageReference Include="Xunit.Extensions.Ordering" Version="1.*" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.*">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
Expand Down
Loading
Loading