Skip to content

Commit cc0b3c6

Browse files
jnunn-awsjnunn-aws
authored
Changed example S3 bucket names to use approved value. (#3851)
1 parent 5fd03bf commit cc0b3c6

14 files changed

+65
-54
lines changed

‎docgenerator/AWSSDKDocSamples/S3/BaseS3Samples.cs

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ public void BucketSamples()
4646
""Effect"":""Allow"",
4747
""Principal"": ""*"",
4848
""Action"":[""s3:PutObject"",""s3:GetObject""],
49-
""Resource"":[""arn:aws:s3:::samplebucketname/*""]
49+
""Resource"":[""arn:aws:s3:::amzn-s3-demo-bucketname/*""]
5050
}]}";
5151
PutBucketPolicyRequest putRequest = new PutBucketPolicyRequest
5252
{
53-
BucketName = "SampleBucket",
53+
BucketName = "amzn-s3-demo-bucket",
5454
Policy = newPolicy
5555
};
5656
client.PutBucketPolicy(putRequest);
@@ -59,7 +59,7 @@ public void BucketSamples()
5959
// Retrieve current policy
6060
GetBucketPolicyRequest getRequest = new GetBucketPolicyRequest
6161
{
62-
BucketName = "SampleBucket"
62+
BucketName = "amzn-s3-demo-bucket"
6363
};
6464
string policy = client.GetBucketPolicy(getRequest).Policy;
6565

@@ -70,7 +70,7 @@ public void BucketSamples()
7070
// Delete current policy
7171
DeleteBucketPolicyRequest deleteRequest = new DeleteBucketPolicyRequest
7272
{
73-
BucketName = "SampleBucket"
73+
BucketName = "amzn-s3-demo-bucket"
7474
};
7575
client.DeleteBucketPolicy(deleteRequest);
7676

@@ -91,7 +91,7 @@ public void BucketSamples()
9191
// Construct request
9292
GetBucketLocationRequest request = new GetBucketLocationRequest
9393
{
94-
BucketName = "SampleBucket"
94+
BucketName = "amzn-s3-demo-bucket"
9595
};
9696

9797
// Issue call
@@ -112,7 +112,7 @@ public void BucketSamples()
112112
// Construct request
113113
PutBucketRequest request = new PutBucketRequest
114114
{
115-
BucketName = "SampleBucket",
115+
BucketName = "amzn-s3-demo-bucket",
116116
BucketRegion = S3Region.EU, // set region to EU
117117
CannedACL = S3CannedACL.PublicRead // make bucket publicly readable
118118
};
@@ -132,7 +132,7 @@ public void BucketSamples()
132132
// Construct request
133133
DeleteBucketRequest request = new DeleteBucketRequest
134134
{
135-
BucketName = "SampleBucket"
135+
BucketName = "amzn-s3-demo-bucket"
136136
};
137137

138138
// Issue call
@@ -150,7 +150,7 @@ public void BucketSamples()
150150
// List and delete all objects
151151
ListObjectsRequest listRequest = new ListObjectsRequest
152152
{
153-
BucketName = "SampleBucket"
153+
BucketName = "amzn-s3-demo-bucket"
154154
};
155155

156156
ListObjectsResponse listResponse;
@@ -163,7 +163,7 @@ public void BucketSamples()
163163
// Delete each object
164164
client.DeleteObject(new DeleteObjectRequest
165165
{
166-
BucketName = "SampleBucket",
166+
BucketName = "amzn-s3-demo-bucket",
167167
Key = obj.Key
168168
});
169169
}
@@ -175,7 +175,7 @@ public void BucketSamples()
175175
// Construct DeleteBucket request
176176
DeleteBucketRequest request = new DeleteBucketRequest
177177
{
178-
BucketName = "SampleBucket"
178+
BucketName = "amzn-s3-demo-bucket"
179179
};
180180

181181
// Issue call
@@ -213,7 +213,7 @@ public void BucketSamples()
213213
};
214214
PutLifecycleConfigurationRequest putRequest = new PutLifecycleConfigurationRequest
215215
{
216-
BucketName = "SampleBucket",
216+
BucketName = "amzn-s3-demo-bucket",
217217
Configuration = newConfiguration
218218
};
219219
client.PutLifecycleConfiguration(putRequest);
@@ -222,7 +222,7 @@ public void BucketSamples()
222222
// Retrieve current configuration
223223
GetLifecycleConfigurationRequest getRequest = new GetLifecycleConfigurationRequest
224224
{
225-
BucketName = "SampleBucket"
225+
BucketName = "amzn-s3-demo-bucket"
226226
};
227227
LifecycleConfiguration configuration = client.GetLifecycleConfiguration(getRequest).Configuration;
228228

@@ -244,7 +244,7 @@ public void BucketSamples()
244244
// Delete current configuration
245245
DeleteLifecycleConfigurationRequest deleteRequest = new DeleteLifecycleConfigurationRequest
246246
{
247-
BucketName = "SampleBucket"
247+
BucketName = "amzn-s3-demo-bucket"
248248
};
249249
client.DeleteLifecycleConfiguration(deleteRequest);
250250

@@ -268,7 +268,7 @@ public void ObjectSamples()
268268
// List all objects
269269
ListObjectsRequest listRequest = new ListObjectsRequest
270270
{
271-
BucketName = "SampleBucket",
271+
BucketName = "amzn-s3-demo-bucket",
272272
};
273273

274274
ListObjectsResponse listResponse;
@@ -300,7 +300,7 @@ public void ObjectSamples()
300300
// Create a GetObject request
301301
GetObjectRequest request = new GetObjectRequest
302302
{
303-
BucketName = "SampleBucket",
303+
BucketName = "amzn-s3-demo-bucket",
304304
Key = "Item1"
305305
};
306306

@@ -328,7 +328,7 @@ public void ObjectSamples()
328328
// Create a GetObject request
329329
GetObjectRequest request = new GetObjectRequest
330330
{
331-
BucketName = "SampleBucket",
331+
BucketName = "amzn-s3-demo-bucket",
332332
Key = "Item1"
333333
};
334334

@@ -352,7 +352,7 @@ public void ObjectSamples()
352352
// Create a GetObjectMetadata request
353353
GetObjectMetadataRequest request = new GetObjectMetadataRequest
354354
{
355-
BucketName = "SampleBucket",
355+
BucketName = "amzn-s3-demo-bucket",
356356
Key = "Item1"
357357
};
358358

@@ -378,7 +378,7 @@ public void ObjectSamples()
378378
// Create a PutObject request
379379
PutObjectRequest request = new PutObjectRequest
380380
{
381-
BucketName = "SampleBucket",
381+
BucketName = "amzn-s3-demo-bucket",
382382
Key = "Item1",
383383
ContentBody = "This is sample content..."
384384
};
@@ -398,7 +398,7 @@ public void ObjectSamples()
398398
// Create a PutObject request
399399
PutObjectRequest request = new PutObjectRequest
400400
{
401-
BucketName = "SampleBucket",
401+
BucketName = "amzn-s3-demo-bucket",
402402
Key = "Item1",
403403
FilePath = "contents.txt"
404404
};
@@ -418,7 +418,7 @@ public void ObjectSamples()
418418
// Create a PutObject request
419419
PutObjectRequest request = new PutObjectRequest
420420
{
421-
BucketName = "SampleBucket",
421+
BucketName = "amzn-s3-demo-bucket",
422422
Key = "Item1",
423423
};
424424
using (FileStream stream = new FileStream("contents.txt", FileMode.Open))
@@ -441,7 +441,7 @@ public void ObjectSamples()
441441
// Create a DeleteObject request
442442
DeleteObjectRequest request = new DeleteObjectRequest
443443
{
444-
BucketName = "SampleBucket",
444+
BucketName = "amzn-s3-demo-bucket",
445445
Key = "Item1"
446446
};
447447

@@ -460,7 +460,7 @@ public void ObjectSamples()
460460
// Create a DeleteObject request
461461
DeleteObjectsRequest request = new DeleteObjectsRequest
462462
{
463-
BucketName = "SampleBucket",
463+
BucketName = "amzn-s3-demo-bucket",
464464
Objects = new List<KeyVersion>
465465
{
466466
new KeyVersion() {Key = "Item1"},
@@ -505,7 +505,7 @@ public void ObjectSamples()
505505
// Create a CopyObject request
506506
CopyObjectRequest request = new CopyObjectRequest
507507
{
508-
SourceBucket = "SampleBucket",
508+
SourceBucket = "amzn-s3-demo-bucket",
509509
SourceKey = "Item1",
510510
DestinationBucket = "AnotherBucket",
511511
DestinationKey = "Copy1",
@@ -527,7 +527,7 @@ public void ObjectSamples()
527527
// Create a CopyObject request
528528
CopyObjectRequest request = new CopyObjectRequest
529529
{
530-
SourceBucket = "SampleBucket",
530+
SourceBucket = "amzn-s3-demo-bucket",
531531
SourceKey = "Item1",
532532
DestinationBucket = "AnotherBucket",
533533
DestinationKey = "Copy1",
@@ -549,17 +549,17 @@ public void ObjectSamples()
549549
// Turn versioning on for a bucket
550550
client.PutBucketVersioning(new PutBucketVersioningRequest
551551
{
552-
BucketName = "SampleBucket",
552+
BucketName = "amzn-s3-demo-bucket",
553553
VersioningConfig = new S3BucketVersioningConfig { Status = "Enable" }
554554
});
555555

556556
// Populate bucket with multiple items, each with multiple versions
557-
PopulateBucket(client, "SampleBucket");
557+
PopulateBucket(client, "amzn-s3-demo-bucket");
558558

559559
// Get versions
560560
ListVersionsRequest request = new ListVersionsRequest
561561
{
562-
BucketName = "SampleBucket"
562+
BucketName = "amzn-s3-demo-bucket"
563563
};
564564

565565
// Make paged ListVersions calls
@@ -599,15 +599,15 @@ public void ObjectSamples()
599599
// Initiate multipart upload
600600
InitiateMultipartUploadRequest initRequest = new InitiateMultipartUploadRequest
601601
{
602-
BucketName = "SampleBucket",
602+
BucketName = "amzn-s3-demo-bucket",
603603
Key = "Item1"
604604
};
605605
InitiateMultipartUploadResponse initResponse = client.InitiateMultipartUpload(initRequest);
606606

607607
// Upload part 1
608608
UploadPartRequest uploadRequest = new UploadPartRequest
609609
{
610-
BucketName = "SampleBucket",
610+
BucketName = "amzn-s3-demo-bucket",
611611
Key = "Item1",
612612
UploadId = initResponse.UploadId,
613613
PartNumber = 1,
@@ -619,7 +619,7 @@ public void ObjectSamples()
619619
// Upload part 2
620620
uploadRequest = new UploadPartRequest
621621
{
622-
BucketName = "SampleBucket",
622+
BucketName = "amzn-s3-demo-bucket",
623623
Key = "Item1",
624624
UploadId = initResponse.UploadId,
625625
PartNumber = 2,
@@ -631,7 +631,7 @@ public void ObjectSamples()
631631
// Upload part 3
632632
uploadRequest = new UploadPartRequest
633633
{
634-
BucketName = "SampleBucket",
634+
BucketName = "amzn-s3-demo-bucket",
635635
Key = "Item1",
636636
UploadId = initResponse.UploadId,
637637
PartNumber = 3,
@@ -642,7 +642,7 @@ public void ObjectSamples()
642642
// List parts for current upload
643643
ListPartsRequest listPartRequest = new ListPartsRequest
644644
{
645-
BucketName = "SampleBucket",
645+
BucketName = "amzn-s3-demo-bucket",
646646
Key = "Item1",
647647
UploadId = initResponse.UploadId
648648
};
@@ -652,7 +652,7 @@ public void ObjectSamples()
652652
// Complete the multipart upload
653653
CompleteMultipartUploadRequest compRequest = new CompleteMultipartUploadRequest
654654
{
655-
BucketName = "SampleBucket",
655+
BucketName = "amzn-s3-demo-bucket",
656656
Key = "Item1",
657657
UploadId = initResponse.UploadId,
658658
PartETags = new List<PartETag>
@@ -704,7 +704,7 @@ public void PresignedURLSamples()
704704
// Create a CopyObject request
705705
GetPreSignedUrlRequest request = new GetPreSignedUrlRequest
706706
{
707-
BucketName = "SampleBucket",
707+
BucketName = "amzn-s3-demo-bucket",
708708
Key = "Item1",
709709
Expires = DateTime.UtcNow.AddMinutes(5)
710710
};
@@ -727,7 +727,7 @@ public void PresignedURLSamples()
727727
// Create a CopyObject request
728728
GetPreSignedUrlRequest request = new GetPreSignedUrlRequest
729729
{
730-
BucketName = "SampleBucket",
730+
BucketName = "amzn-s3-demo-bucket",
731731
Key = "Item1",
732732
Expires = DateTime.UtcNow.AddMinutes(5)
733733
};
@@ -756,7 +756,7 @@ public void PresignedURLSamples()
756756
// Create a CopyObject request
757757
GetPreSignedUrlRequest request = new GetPreSignedUrlRequest
758758
{
759-
BucketName = "SampleBucket",
759+
BucketName = "amzn-s3-demo-bucket",
760760
Expires = DateTime.UtcNow.AddMinutes(5)
761761
};
762762

@@ -799,7 +799,7 @@ public void PresignedURLSamples()
799799
// Create a CopyObject request
800800
GetPreSignedUrlRequest request = new GetPreSignedUrlRequest
801801
{
802-
BucketName = "SampleBucket",
802+
BucketName = "amzn-s3-demo-bucket",
803803
Key = "Item1",
804804
Verb = HttpVerb.PUT,
805805
Expires = DateTime.UtcNow.AddDays(10)
@@ -839,7 +839,7 @@ public void AclSamples()
839839
// Set Canned ACL (PublicRead) for an existing item
840840
client.PutACL(new PutACLRequest
841841
{
842-
BucketName = "SampleBucket",
842+
BucketName = "amzn-s3-demo-bucket",
843843
Key = "Item1",
844844
CannedACL = S3CannedACL.PublicRead
845845
});
@@ -848,7 +848,7 @@ public void AclSamples()
848848
// (This reverts ACL back to default for object)
849849
client.PutACL(new PutACLRequest
850850
{
851-
BucketName = "SampleBucket",
851+
BucketName = "amzn-s3-demo-bucket",
852852
Key = "Item1",
853853
CannedACL = S3CannedACL.Private
854854
});
@@ -865,7 +865,7 @@ public void AclSamples()
865865
// Retrieve ACL for object
866866
S3AccessControlList acl = client.GetACL(new GetACLRequest
867867
{
868-
BucketName = "SampleBucket",
868+
BucketName = "amzn-s3-demo-bucket",
869869
Key = "Item1",
870870
}).AccessControlList;
871871

@@ -890,7 +890,7 @@ public void AclSamples()
890890
// Set new ACL
891891
PutACLResponse response = client.PutACL(new PutACLRequest
892892
{
893-
BucketName = "SampleBucket",
893+
BucketName = "amzn-s3-demo-bucket",
894894
Key = "Item1",
895895
AccessControlList = acl
896896
});

‎generator/.DevConfigs/02307d99-dc6c-4ae1-8529-d7394f1493cb.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"services": [
3+
{
4+
"serviceName": "S3",
5+
"type": "patch",
6+
"changeLogMessages": [
7+
"Changing S3 bucket names to preferred values in example documentation."
8+
]
9+
}
10+
]
11+
}

‎sdk/src/Services/S3/Custom/Model/DeleteBucketEncryptionRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public class DeleteBucketEncryptionRequest : AmazonWebServiceRequest
4444
///
4545
/// Virtual-hosted-style requests aren't supported.
4646
/// Directory bucket names must be unique in the chosen Availability Zone.
47-
/// Bucket names must also follow the format <c><i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c><i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>).
47+
/// Bucket names must also follow the format <c><i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c><i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</c>).
4848
///
4949
/// For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a>
5050
/// in the <i>Amazon S3 User Guide</i>.

‎sdk/src/Services/S3/Custom/Model/DeleteBucketPolicyRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ public partial class DeleteBucketPolicyRequest : AmazonWebServiceRequest
113113
/// you must use path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
114114
/// </c>. Virtual-hosted-style requests aren't supported. Directory bucket names must
115115
/// be unique in the chosen Availability Zone. Bucket names must also follow the format
116-
/// <c> <i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>).
116+
/// <c> <i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</c>).
117117
/// For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory
118118
/// bucket naming rules</a> in the <i>Amazon S3 User Guide</i>
119119
/// </para>

‎sdk/src/Services/S3/Custom/Model/DeleteBucketRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public partial class DeleteBucketRequest : AmazonWebServiceRequest
9696
/// you must use path-style requests in the format <c>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
9797
/// </c>. Virtual-hosted-style requests aren't supported. Directory bucket names must
9898
/// be unique in the chosen Availability Zone. Bucket names must also follow the format
99-
/// <c> <i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</c>).
99+
/// <c> <i>bucket_base_name</i>--<i>az_id</i>--x-s3</c> (for example, <c> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</c>).
100100
/// For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory
101101
/// bucket naming rules</a> in the <i>Amazon S3 User Guide</i>
102102
/// </para>

0 commit comments

Comments
 (0)