Skip to content

Commit fbac768

Browse files
Documentation updates for Amazon S3
1 parent 9b2048f commit fbac768

File tree

61 files changed

+7359
-5692
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+7359
-5692
lines changed

generator/ServiceModels/s3/s3-2006-03-01.docs.json

Lines changed: 103 additions & 103 deletions
Large diffs are not rendered by default.

generator/ServiceModels/s3/s3-2006-03-01.endpoint-rule-set.json

Lines changed: 283 additions & 283 deletions
Large diffs are not rendered by default.

generator/ServiceModels/s3/s3-2006-03-01.examples.json

Lines changed: 97 additions & 97 deletions
Large diffs are not rendered by default.

generator/ServiceModels/s3/s3-2006-03-01.normal.json

Lines changed: 103 additions & 103 deletions
Large diffs are not rendered by default.

sdk/src/Services/S3/Custom/Model/AbortMultipartUploadRequest.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,12 @@ public partial class AbortMultipartUploadRequest : AmazonWebServiceRequest
9898
/// </para>
9999
///
100100
/// <para>
101-
/// When using this action with Amazon S3 on Outposts, you must direct requests to the
102-
/// S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com.
103-
/// When using this action using S3 on Outposts through the Amazon Web Services SDKs,
104-
/// you provide the Outposts bucket ARN in place of the bucket name. For more information
105-
/// about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
106-
/// S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.
101+
/// When you use this action with Amazon S3 on Outposts, you must direct requests to the
102+
/// S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
103+
/// When you use this action with S3 on Outposts through the Amazon Web Services SDKs,
104+
/// you provide the Outposts access point ARN in place of the bucket name. For more information
105+
/// about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What
106+
/// is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.
107107
/// </para>
108108
/// </summary>
109109
public string BucketName

sdk/src/Services/S3/Custom/Model/CSVInput.cs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,14 @@ internal bool IsSetFileHeaderInfo()
3434
}
3535

3636
/// <summary>
37-
/// Single character used to indicate a row should be ignored when present at the start of a row.
37+
/// <para>
38+
/// A single character used to indicate that a row should be ignored when the character
39+
/// is present at the start of that row. You can specify any character to indicate a comment line.
40+
/// The default character is <code>#</code>.
41+
/// </para>
42+
/// <para>
43+
/// Default: <code>#</code>
44+
/// </para>
3845
/// </summary>
3946
public string Comments { get; set; }
4047

sdk/src/Services/S3/Custom/Model/CompleteMultipartUploadRequest.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,12 +191,12 @@ public partial class CompleteMultipartUploadRequest : AmazonWebServiceRequest
191191
/// </para>
192192
///
193193
/// <para>
194-
/// When using this action with Amazon S3 on Outposts, you must direct requests to the
195-
/// S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com.
196-
/// When using this action using S3 on Outposts through the Amazon Web Services SDKs,
197-
/// you provide the Outposts bucket ARN in place of the bucket name. For more information
198-
/// about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
199-
/// S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.
194+
/// When you use this action with Amazon S3 on Outposts, you must direct requests to the
195+
/// S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
196+
/// When you use this action with S3 on Outposts through the Amazon Web Services SDKs,
197+
/// you provide the Outposts access point ARN in place of the bucket name. For more information
198+
/// about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What
199+
/// is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.
200200
/// </para>
201201
/// </summary>
202202
public string BucketName

sdk/src/Services/S3/Custom/Model/CompleteMultipartUploadResponse.cs

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,12 @@ internal bool IsSetBucketKeyEnabled()
7373
/// </para>
7474
///
7575
/// <para>
76-
/// When using this action with Amazon S3 on Outposts, you must direct requests to the
77-
/// S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com.
78-
/// When using this action using S3 on Outposts through the Amazon Web Services SDKs,
79-
/// you provide the Outposts bucket ARN in place of the bucket name. For more information
80-
/// about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
81-
/// S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.
76+
/// When you use this action with Amazon S3 on Outposts, you must direct requests to the
77+
/// S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
78+
/// When you use this action with S3 on Outposts through the Amazon Web Services SDKs,
79+
/// you provide the Outposts access point ARN in place of the bucket name. For more information
80+
/// about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What
81+
/// is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.
8282
/// </para>
8383
/// </summary>
8484
public string BucketName
@@ -255,15 +255,9 @@ internal bool IsSetRequestCharged()
255255
}
256256

257257
/// <summary>
258-
/// Gets and sets the ServerSideEncryptionMethod property.
259-
/// Specifies the encryption used on the server to
260-
/// store the content.
261-
/// Default is None.
262258
/// <para>
263-
/// If you specified server-side encryption either with an Amazon S3-managed encryption
264-
/// key or an Amazon Web Services KMS key in your initiate multipart upload request,
265-
/// the response includes this header. It confirms the encryption algorithm
266-
/// that Amazon S3 used to encrypt the object.
259+
/// The server-side encryption algorithm used when storing this object in Amazon S3 (for
260+
/// example, AES256, <code>aws:kms</code>).
267261
/// </para>
268262
/// </summary>
269263
public ServerSideEncryptionMethod ServerSideEncryptionMethod
@@ -277,7 +271,8 @@ public ServerSideEncryptionMethod ServerSideEncryptionMethod
277271
/// The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object.
278272
/// <para>
279273
/// If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon
280-
/// Web Services KMS) symmetric customer managed key that was used for the object.
274+
/// Web Services KMS) symmetric encryption customer managed key that was used for the
275+
/// object.
281276
/// </para>
282277
/// </summary>
283278
[AWSProperty(Sensitive=true)]

sdk/src/Services/S3/Custom/Model/CopyObjectRequest.cs

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -541,17 +541,28 @@ internal bool IsSetCopySourceServerSideEncryptionCustomerProvidedKeyMD5()
541541
}
542542

543543
/// <summary>
544-
/// <para>The name of the destination bucket.</para>
545-
/// <para>When using this API with an access point, you must direct requests to the access point hostname.
546-
/// The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
547-
/// When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name.
548-
/// For more information about access point ARNs, see
549-
/// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</para>
550-
/// <para>When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
551-
/// The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com.
552-
/// When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name.
553-
/// For more information about S3 on Outposts ARNs, see
554-
/// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</para>
544+
/// Gets and sets the property DestinationBucket.
545+
/// <para>
546+
/// The name of the destination bucket.
547+
/// </para>
548+
///
549+
/// <para>
550+
/// When using this action with an access point, you must direct requests to the access
551+
/// point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
552+
/// When using this action with an access point through the Amazon Web Services SDKs,
553+
/// you provide the access point ARN in place of the bucket name. For more information
554+
/// about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
555+
/// access points</a> in the <i>Amazon S3 User Guide</i>.
556+
/// </para>
557+
///
558+
/// <para>
559+
/// When you use this action with Amazon S3 on Outposts, you must direct requests to the
560+
/// S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
561+
/// When you use this action with S3 on Outposts through the Amazon Web Services SDKs,
562+
/// you provide the Outposts access point ARN in place of the bucket name. For more information
563+
/// about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What
564+
/// is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.
565+
/// </para>
555566
/// </summary>
556567
public string DestinationBucket
557568
{
@@ -793,8 +804,10 @@ internal bool IsSetSourceVersionId()
793804
}
794805

795806
/// <summary>
796-
/// The Server-side encryption algorithm used when storing this object in S3.
797-
///
807+
/// <para>
808+
/// The server-side encryption algorithm used when storing this object in Amazon S3 (for
809+
/// example, AES256, <code>aws:kms</code>).
810+
/// </para>
798811
/// </summary>
799812
public ServerSideEncryptionMethod ServerSideEncryptionMethod
800813
{
@@ -963,9 +976,13 @@ internal bool IsSetTagSet()
963976
}
964977

965978
/// <summary>
966-
/// If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL.
967-
/// Amazon S3 stores the value of this header in the object metadata.
968-
///
979+
/// <para>
980+
/// If the bucket is configured as a website, redirects requests for this object to another
981+
/// object in the same bucket or to an external URL. Amazon S3 stores the value of this
982+
/// header in the object metadata. This value is unique to each object and is not copied
983+
/// when using the <code>x-amz-metadata-directive</code> header. Instead, you may opt
984+
/// to provide this header in combination with the directive.
985+
/// </para>
969986
/// </summary>
970987
public string WebsiteRedirectLocation
971988
{

sdk/src/Services/S3/Custom/Model/CopyObjectResponse.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,10 @@ internal bool IsSetRequestCharged()
101101
}
102102

103103
/// <summary>
104-
/// The Server-side encryption algorithm used when storing this object in S3.
104+
/// <para>
105+
/// The server-side encryption algorithm used when storing this object in Amazon S3 (for
106+
/// example, AES256, <code>aws:kms</code>).
107+
/// </para>
105108
/// </summary>
106109
public ServerSideEncryptionMethod ServerSideEncryptionMethod
107110
{
@@ -148,7 +151,8 @@ public string ServerSideEncryptionKeyManagementServiceEncryptionContext
148151
/// The id of the AWS Key Management Service key that Amazon S3 uses to encrypt and decrypt the object.
149152
/// <para>
150153
/// If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon
151-
/// Web Services KMS) symmetric customer managed key that was used for the object.
154+
/// Web Services KMS) symmetric encryption customer managed key that was used for the
155+
/// object.
152156
/// </para>
153157
/// </summary>
154158
[AWSProperty(Sensitive=true)]

0 commit comments

Comments
 (0)