@aws-sdk/client-s3 3.697.0 → 3.698.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/dist-cjs/index.js +152 -5
  2. package/dist-es/models/models_1.js +48 -0
  3. package/dist-es/protocols/Aws_restXml.js +75 -4
  4. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +16 -13
  5. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +47 -42
  6. package/dist-types/commands/CopyObjectCommand.d.ts +77 -57
  7. package/dist-types/commands/CreateBucketCommand.d.ts +60 -45
  8. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +92 -66
  9. package/dist-types/commands/CreateSessionCommand.d.ts +30 -16
  10. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +1 -1
  11. package/dist-types/commands/DeleteBucketCommand.d.ts +10 -3
  12. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +1 -1
  13. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +18 -10
  14. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  15. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +1 -1
  16. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +52 -9
  17. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +1 -1
  18. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +1 -1
  19. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +25 -21
  20. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +1 -1
  21. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +1 -1
  22. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +1 -1
  23. package/dist-types/commands/DeleteObjectCommand.d.ts +3 -0
  24. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +1 -1
  25. package/dist-types/commands/DeleteObjectsCommand.d.ts +41 -27
  26. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +1 -1
  27. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +1 -1
  28. package/dist-types/commands/GetBucketAclCommand.d.ts +1 -1
  29. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +1 -1
  30. package/dist-types/commands/GetBucketCorsCommand.d.ts +1 -1
  31. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +18 -10
  32. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  33. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +1 -1
  34. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +61 -17
  35. package/dist-types/commands/GetBucketLocationCommand.d.ts +1 -1
  36. package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
  37. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +1 -1
  38. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +1 -1
  39. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +1 -1
  40. package/dist-types/commands/GetBucketPolicyCommand.d.ts +30 -21
  41. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
  42. package/dist-types/commands/GetBucketReplicationCommand.d.ts +1 -1
  43. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +1 -1
  44. package/dist-types/commands/GetBucketTaggingCommand.d.ts +1 -1
  45. package/dist-types/commands/GetBucketVersioningCommand.d.ts +1 -1
  46. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +1 -1
  47. package/dist-types/commands/GetObjectAclCommand.d.ts +1 -1
  48. package/dist-types/commands/GetObjectAttributesCommand.d.ts +62 -44
  49. package/dist-types/commands/GetObjectCommand.d.ts +79 -60
  50. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -1
  51. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -1
  52. package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -1
  53. package/dist-types/commands/GetObjectTaggingCommand.d.ts +1 -1
  54. package/dist-types/commands/GetObjectTorrentCommand.d.ts +1 -1
  55. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -1
  56. package/dist-types/commands/HeadBucketCommand.d.ts +32 -16
  57. package/dist-types/commands/HeadObjectCommand.d.ts +60 -38
  58. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +1 -1
  59. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -1
  60. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +1 -1
  61. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +1 -1
  62. package/dist-types/commands/ListBucketsCommand.d.ts +6 -6
  63. package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +10 -4
  64. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +50 -33
  65. package/dist-types/commands/ListObjectVersionsCommand.d.ts +1 -1
  66. package/dist-types/commands/ListObjectsCommand.d.ts +1 -1
  67. package/dist-types/commands/ListObjectsV2Command.d.ts +23 -14
  68. package/dist-types/commands/ListPartsCommand.d.ts +22 -17
  69. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
  70. package/dist-types/commands/PutBucketAclCommand.d.ts +1 -1
  71. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
  72. package/dist-types/commands/PutBucketCorsCommand.d.ts +1 -1
  73. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +47 -32
  74. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  75. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
  76. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +84 -45
  77. package/dist-types/commands/PutBucketLoggingCommand.d.ts +1 -1
  78. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
  79. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +1 -1
  80. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +1 -1
  81. package/dist-types/commands/PutBucketPolicyCommand.d.ts +30 -21
  82. package/dist-types/commands/PutBucketReplicationCommand.d.ts +3 -4
  83. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
  84. package/dist-types/commands/PutBucketTaggingCommand.d.ts +1 -1
  85. package/dist-types/commands/PutBucketVersioningCommand.d.ts +3 -6
  86. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +1 -1
  87. package/dist-types/commands/PutObjectAclCommand.d.ts +1 -1
  88. package/dist-types/commands/PutObjectCommand.d.ts +83 -35
  89. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -1
  90. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +3 -3
  91. package/dist-types/commands/PutObjectRetentionCommand.d.ts +2 -2
  92. package/dist-types/commands/PutObjectTaggingCommand.d.ts +1 -1
  93. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
  94. package/dist-types/commands/RestoreObjectCommand.d.ts +1 -1
  95. package/dist-types/commands/SelectObjectContentCommand.d.ts +1 -1
  96. package/dist-types/commands/UploadPartCommand.d.ts +52 -41
  97. package/dist-types/commands/UploadPartCopyCommand.d.ts +53 -39
  98. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +1 -1
  99. package/dist-types/models/models_0.d.ts +938 -632
  100. package/dist-types/models/models_1.d.ts +230 -135
  101. package/dist-types/ts3.4/models/models_0.d.ts +7 -0
  102. package/dist-types/ts3.4/models/models_1.d.ts +24 -0
  103. package/package.json +1 -1
@@ -30,28 +30,31 @@ declare const CreateMultipartUploadCommand_base: {
30
30
  * <p>This action initiates a multipart upload and returns an upload ID. This upload ID is
31
31
  * used to associate all of the parts in the specific multipart upload. You specify this
32
32
  * upload ID in each of your subsequent upload part requests (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>). You also include this
33
- * upload ID in the final request to either complete or abort the multipart upload
34
- * request. For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide</i>.</p>
33
+ * upload ID in the final request to either complete or abort the multipart upload request.
34
+ * For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the
35
+ * <i>Amazon S3 User Guide</i>.</p>
35
36
  * <note>
36
37
  * <p>After you initiate a multipart upload and upload one or more parts, to stop being
37
38
  * charged for storing the uploaded parts, you must either complete or abort the multipart
38
39
  * upload. Amazon S3 frees up the space used to store the parts and stops charging you for
39
40
  * storing them only after you either complete or abort a multipart upload. </p>
40
41
  * </note>
41
- * <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart
42
- * upload must be completed within the number of days specified in the bucket lifecycle
43
- * configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort
44
- * action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
45
- * Configuration</a>.</p>
42
+ * <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the
43
+ * created multipart upload must be completed within the number of days specified in the
44
+ * bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible
45
+ * for an abort action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
46
+ * Configuration</a>.</p>
46
47
  * <note>
47
48
  * <ul>
48
49
  * <li>
49
50
  * <p>
50
- * <b>Directory buckets </b> - S3 Lifecycle is not supported by directory buckets.</p>
51
+ * <b>Directory buckets </b> -
52
+ * S3 Lifecycle is not supported by directory buckets.</p>
51
53
  * </li>
52
54
  * <li>
53
55
  * <p>
54
- * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
56
+ * <b>Directory buckets </b> -
57
+ * For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
55
58
  * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
56
59
  * <i>Amazon S3 User Guide</i>.</p>
57
60
  * </li>
@@ -60,10 +63,13 @@ declare const CreateMultipartUploadCommand_base: {
60
63
  * <dl>
61
64
  * <dt>Request signing</dt>
62
65
  * <dd>
63
- * <p>For request signing, multipart upload is just a series of regular requests. You initiate
64
- * a multipart upload, send one or more requests to upload parts, and then complete the
65
- * multipart upload process. You sign each request individually. There is nothing special
66
- * about signing multipart upload requests. For more information about signing, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon S3 User Guide</i>.</p>
66
+ * <p>For request signing, multipart upload is just a series of regular requests. You
67
+ * initiate a multipart upload, send one or more requests to upload parts, and then
68
+ * complete the multipart upload process. You sign each request individually. There
69
+ * is nothing special about signing multipart upload requests. For more information
70
+ * about signing, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating
71
+ * Requests (Amazon Web Services Signature Version 4)</a> in the
72
+ * <i>Amazon S3 User Guide</i>.</p>
67
73
  * </dd>
68
74
  * <dt>Permissions</dt>
69
75
  * <dd>
@@ -101,29 +107,36 @@ declare const CreateMultipartUploadCommand_base: {
101
107
  * <ul>
102
108
  * <li>
103
109
  * <p>
104
- * <b>General purpose buckets</b> - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it
105
- * writes it to disks in its data centers and decrypts it when you access it. Amazon S3
106
- * automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a
107
- * multipart upload, if you don't specify encryption information in your request, the
108
- * encryption setting of the uploaded parts is set to the default encryption configuration of
109
- * the destination bucket. By default, all buckets have a base level of encryption
110
- * configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
111
- * destination bucket has a default encryption configuration that uses server-side encryption
112
- * with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),
113
- * Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded
114
- * parts. When you perform a CreateMultipartUpload operation, if you want to use a different
115
- * type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the
116
- * object with a different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the encryption
117
- * setting in your request is different from the default encryption configuration of the
118
- * destination bucket, the encryption setting in your request takes precedence. If you choose
119
- * to provide your own encryption key, the request headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
120
- * and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> requests must match the headers you used in the <code>CreateMultipartUpload</code> request.</p>
110
+ * <b>General purpose buckets</b> - Server-side
111
+ * encryption is for data encryption at rest. Amazon S3 encrypts your data as it
112
+ * writes it to disks in its data centers and decrypts it when you access it.
113
+ * Amazon S3 automatically encrypts all new objects that are uploaded to an S3
114
+ * bucket. When doing a multipart upload, if you don't specify encryption
115
+ * information in your request, the encryption setting of the uploaded parts is
116
+ * set to the default encryption configuration of the destination bucket. By
117
+ * default, all buckets have a base level of encryption configuration that uses
118
+ * server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination
119
+ * bucket has a default encryption configuration that uses server-side
120
+ * encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided
121
+ * encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a
122
+ * customer-provided key to encrypt the uploaded parts. When you perform a
123
+ * CreateMultipartUpload operation, if you want to use a different type of
124
+ * encryption setting for the uploaded parts, you can request that Amazon S3
125
+ * encrypts the object with a different encryption key (such as an Amazon S3 managed
126
+ * key, a KMS key, or a customer-provided key). When the encryption setting
127
+ * in your request is different from the default encryption configuration of
128
+ * the destination bucket, the encryption setting in your request takes
129
+ * precedence. If you choose to provide your own encryption key, the request
130
+ * headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> and
131
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>
132
+ * requests must match the headers you used in the
133
+ * <code>CreateMultipartUpload</code> request.</p>
121
134
  * <ul>
122
135
  * <li>
123
136
  * <p>Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key
124
- * (<code>aws/s3</code>) and KMS customer managed keys stored in Key Management Service (KMS) –
125
- * If you want Amazon Web Services to manage the keys used to encrypt data, specify the
126
- * following headers in the request.</p>
137
+ * (<code>aws/s3</code>) and KMS customer managed keys stored in Key Management Service
138
+ * (KMS) – If you want Amazon Web Services to manage the keys used to encrypt data,
139
+ * specify the following headers in the request.</p>
127
140
  * <ul>
128
141
  * <li>
129
142
  * <p>
@@ -144,44 +157,53 @@ declare const CreateMultipartUploadCommand_base: {
144
157
  * <note>
145
158
  * <ul>
146
159
  * <li>
147
- * <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but
148
- * don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>,
149
- * Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code> key) in KMS to
150
- * protect the data.</p>
160
+ * <p>If you specify
161
+ * <code>x-amz-server-side-encryption:aws:kms</code>, but
162
+ * don't provide
163
+ * <code>x-amz-server-side-encryption-aws-kms-key-id</code>,
164
+ * Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code> key) in
165
+ * KMS to protect the data.</p>
151
166
  * </li>
152
167
  * <li>
153
- * <p>To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester
154
- * must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code>
155
- * actions on the key. These permissions are required because Amazon S3 must decrypt and read data
156
- * from the encrypted file parts before it completes the multipart upload. For more
157
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart upload API
158
- * and permissions</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting data using
159
- * server-side encryption with Amazon Web Services KMS</a> in the
160
- * <i>Amazon S3 User Guide</i>.</p>
168
+ * <p>To perform a multipart upload with encryption by using an
169
+ * Amazon Web Services KMS key, the requester must have permission to the
170
+ * <code>kms:Decrypt</code> and
171
+ * <code>kms:GenerateDataKey*</code> actions on the key.
172
+ * These permissions are required because Amazon S3 must decrypt and
173
+ * read data from the encrypted file parts before it completes
174
+ * the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart upload API and permissions</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting data using server-side encryption with Amazon Web Services
175
+ * KMS</a> in the
176
+ * <i>Amazon S3 User Guide</i>.</p>
161
177
  * </li>
162
178
  * <li>
163
- * <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key,
164
- * then you must have these permissions on the key policy. If your IAM user or role is in a different account from the key, then you must have the permissions on both the key
165
- * policy and your IAM user or role.</p>
179
+ * <p>If your Identity and Access Management (IAM) user or role is in the same
180
+ * Amazon Web Services account as the KMS key, then you must have these
181
+ * permissions on the key policy. If your IAM user or role is
182
+ * in a different account from the key, then you must have the
183
+ * permissions on both the key policy and your IAM user or
184
+ * role.</p>
166
185
  * </li>
167
186
  * <li>
168
- * <p>All <code>GET</code> and <code>PUT</code> requests for an object
169
- * protected by KMS fail if you don't make them by using Secure Sockets
170
- * Layer (SSL), Transport Layer Security (TLS), or Signature Version
171
- * 4. For information about configuring any of the officially supported Amazon Web Services
172
- * SDKs and Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in Request Authentication</a>
173
- * in the <i>Amazon S3 User Guide</i>.</p>
187
+ * <p>All <code>GET</code> and <code>PUT</code> requests for an
188
+ * object protected by KMS fail if you don't make them by
189
+ * using Secure Sockets Layer (SSL), Transport Layer Security
190
+ * (TLS), or Signature Version 4. For information about
191
+ * configuring any of the officially supported Amazon Web Services SDKs and
192
+ * Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in
193
+ * Request Authentication</a> in the
194
+ * <i>Amazon S3 User Guide</i>.</p>
174
195
  * </li>
175
196
  * </ul>
176
197
  * </note>
177
198
  * <p>For more information about server-side encryption with KMS keys
178
- * (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting Data
179
- * Using Server-Side Encryption with KMS keys</a> in the <i>Amazon S3 User Guide</i>.</p>
199
+ * (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting
200
+ * Data Using Server-Side Encryption with KMS keys</a> in the
201
+ * <i>Amazon S3 User Guide</i>.</p>
180
202
  * </li>
181
203
  * <li>
182
- * <p>Use customer-provided encryption keys (SSE-C) – If you want to manage
183
- * your own encryption keys, provide all the following headers in the
184
- * request.</p>
204
+ * <p>Use customer-provided encryption keys (SSE-C) – If you want to
205
+ * manage your own encryption keys, provide all the following headers in
206
+ * the request.</p>
185
207
  * <ul>
186
208
  * <li>
187
209
  * <p>
@@ -199,16 +221,17 @@ declare const CreateMultipartUploadCommand_base: {
199
221
  * </p>
200
222
  * </li>
201
223
  * </ul>
202
- * <p>For more information about server-side encryption with customer-provided
203
- * encryption keys (SSE-C), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html">
204
- * Protecting data using server-side encryption with customer-provided
205
- * encryption keys (SSE-C)</a> in the <i>Amazon S3 User Guide</i>.</p>
224
+ * <p>For more information about server-side encryption with
225
+ * customer-provided encryption keys (SSE-C), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html"> Protecting data using server-side encryption with
226
+ * customer-provided encryption keys (SSE-C)</a> in the
227
+ * <i>Amazon S3 User Guide</i>.</p>
206
228
  * </li>
207
229
  * </ul>
208
230
  * </li>
209
231
  * <li>
210
232
  * <p>
211
- * <b>Directory buckets</b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
233
+ * <b>Directory buckets</b> -
234
+ * For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
212
235
  * <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
213
236
  * are automatically encrypted with the desired encryption settings. For more
214
237
  * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.</p>
@@ -226,8 +249,11 @@ declare const CreateMultipartUploadCommand_base: {
226
249
  * </p>
227
250
  * </note>
228
251
  * <note>
229
- * <p>For directory buckets, when you perform a <code>CreateMultipartUpload</code> operation and an <code>UploadPartCopy</code> operation,
230
- * the request headers you provide in the <code>CreateMultipartUpload</code> request must match the default encryption configuration of the destination bucket. </p>
252
+ * <p>For directory buckets, when you perform a
253
+ * <code>CreateMultipartUpload</code> operation and an
254
+ * <code>UploadPartCopy</code> operation, the request headers you provide
255
+ * in the <code>CreateMultipartUpload</code> request must match the default
256
+ * encryption configuration of the destination bucket. </p>
231
257
  * </note>
232
258
  * </li>
233
259
  * </ul>
@@ -27,10 +27,10 @@ declare const CreateSessionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets.
31
- * For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see
32
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html">S3 Express One Zone APIs</a> in the <i>Amazon S3 User Guide</i>.
33
- * </p>
30
+ * <p>Creates a session that establishes temporary security credentials to support fast
31
+ * authentication and authorization for the Zonal endpoint API operations on directory buckets. For more
32
+ * information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html">S3 Express One Zone
33
+ * APIs</a> in the <i>Amazon S3 User Guide</i>. </p>
34
34
  * <p>To make Zonal endpoint API requests on a directory bucket, use the <code>CreateSession</code>
35
35
  * API operation. Specifically, you grant <code>s3express:CreateSession</code> permission to a
36
36
  * bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the
@@ -60,30 +60,44 @@ declare const CreateSessionCommand_base: {
60
60
  * <li>
61
61
  * <p>
62
62
  * <b>
63
- * <code>CopyObject</code> API operation</b> - Unlike other Zonal endpoint API operations, the <code>CopyObject</code> API operation doesn't use the temporary security credentials returned from the <code>CreateSession</code> API operation for authentication and authorization. For information about authentication and authorization of the <code>CopyObject</code> API operation on directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>.</p>
63
+ * <code>CopyObject</code> API operation</b> -
64
+ * Unlike other Zonal endpoint API operations, the <code>CopyObject</code> API operation doesn't use
65
+ * the temporary security credentials returned from the <code>CreateSession</code>
66
+ * API operation for authentication and authorization. For information about
67
+ * authentication and authorization of the <code>CopyObject</code> API operation on
68
+ * directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>.</p>
64
69
  * </li>
65
70
  * <li>
66
71
  * <p>
67
72
  * <b>
68
- * <code>HeadBucket</code> API operation</b> - Unlike other Zonal endpoint API operations, the <code>HeadBucket</code> API operation doesn't use the temporary security credentials returned from the <code>CreateSession</code> API operation for authentication and authorization. For information about authentication and authorization of the <code>HeadBucket</code> API operation on directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a>.</p>
73
+ * <code>HeadBucket</code> API operation</b> -
74
+ * Unlike other Zonal endpoint API operations, the <code>HeadBucket</code> API operation doesn't use
75
+ * the temporary security credentials returned from the <code>CreateSession</code>
76
+ * API operation for authentication and authorization. For information about
77
+ * authentication and authorization of the <code>HeadBucket</code> API operation on
78
+ * directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a>.</p>
69
79
  * </li>
70
80
  * </ul>
71
81
  * </note>
72
82
  * <dl>
73
83
  * <dt>Permissions</dt>
74
84
  * <dd>
75
- * <p>To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that
76
- * grants <code>s3express:CreateSession</code> permission to the bucket. In a
77
- * policy, you can have the <code>s3express:SessionMode</code> condition key to
78
- * control who can create a <code>ReadWrite</code> or <code>ReadOnly</code> session.
79
- * For more information about <code>ReadWrite</code> or <code>ReadOnly</code>
80
- * sessions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters">
85
+ * <p>To obtain temporary security credentials, you must create
86
+ * a bucket policy or an IAM identity-based policy that grants <code>s3express:CreateSession</code>
87
+ * permission to the bucket. In a policy, you can have the
88
+ * <code>s3express:SessionMode</code> condition key to control who can create a
89
+ * <code>ReadWrite</code> or <code>ReadOnly</code> session. For more information
90
+ * about <code>ReadWrite</code> or <code>ReadOnly</code> sessions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters">
81
91
  * <code>x-amz-create-session-mode</code>
82
92
  * </a>. For example policies, see
83
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone</a> in the
84
- * <i>Amazon S3 User Guide</i>. </p>
85
- * <p>To grant cross-account access to Zonal endpoint API operations, the bucket policy should also grant both accounts the <code>s3express:CreateSession</code> permission.</p>
86
- * <p>If you want to encrypt objects with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and the <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the target KMS key.</p>
93
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services Identity and Access Management (IAM) identity-based policies for
94
+ * S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>. </p>
95
+ * <p>To grant cross-account access to Zonal endpoint API operations, the bucket policy should also
96
+ * grant both accounts the <code>s3express:CreateSession</code> permission.</p>
97
+ * <p>If you want to encrypt objects with SSE-KMS, you must also have the
98
+ * <code>kms:GenerateDataKey</code> and the <code>kms:Decrypt</code> permissions
99
+ * in IAM identity-based policies and KMS key policies for the target KMS
100
+ * key.</p>
87
101
  * </dd>
88
102
  * <dt>Encryption</dt>
89
103
  * <dd>
@@ -28,7 +28,7 @@ declare const DeleteBucketAnalyticsConfigurationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <note>
31
- * <p>This operation is not supported by directory buckets.</p>
31
+ * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
33
  * <p>Deletes an analytics configuration for the bucket (specified by the analytics
34
34
  * configuration ID).</p>
@@ -33,7 +33,9 @@ declare const DeleteBucketCommand_base: {
33
33
  * <ul>
34
34
  * <li>
35
35
  * <p>
36
- * <b>Directory buckets</b> - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.</p>
36
+ * <b>Directory buckets</b> - If multipart
37
+ * uploads in a directory bucket are in progress, you can't delete the bucket until
38
+ * all the in-progress multipart uploads are aborted or completed.</p>
37
39
  * </li>
38
40
  * <li>
39
41
  * <p>
@@ -50,11 +52,16 @@ declare const DeleteBucketCommand_base: {
50
52
  * <ul>
51
53
  * <li>
52
54
  * <p>
53
- * <b>General purpose bucket permissions</b> - You must have the <code>s3:DeleteBucket</code> permission on the specified bucket in a policy.</p>
55
+ * <b>General purpose bucket permissions</b> - You
56
+ * must have the <code>s3:DeleteBucket</code> permission on the specified
57
+ * bucket in a policy.</p>
54
58
  * </li>
55
59
  * <li>
56
60
  * <p>
57
- * <b>Directory bucket permissions</b> - You must have the <code>s3express:DeleteBucket</code> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
61
+ * <b>Directory bucket permissions</b> -
62
+ * You must have the <code>s3express:DeleteBucket</code> permission in
63
+ * an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
64
+ * For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
58
65
  * </li>
59
66
  * </ul>
60
67
  * </dd>
@@ -28,7 +28,7 @@ declare const DeleteBucketCorsCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <note>
31
- * <p>This operation is not supported by directory buckets.</p>
31
+ * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
33
  * <p>Deletes the <code>cors</code> configuration information set for the bucket.</p>
34
34
  * <p>To use this operation, you must have permission to perform the
@@ -33,13 +33,16 @@ declare const DeleteBucketEncryptionCommand_base: {
33
33
  * <ul>
34
34
  * <li>
35
35
  * <p>
36
- * <b>General purpose buckets</b> - For information about the bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket
37
- * Default Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
36
+ * <b>General purpose buckets</b> - For information
37
+ * about the bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default
38
+ * Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
38
39
  * </li>
39
40
  * <li>
40
41
  * <p>
41
- * <b>Directory buckets</b> - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption configuration in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html">Setting default server-side encryption behavior
42
- * for directory buckets</a>.</p>
42
+ * <b>Directory buckets</b> -
43
+ * For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption
44
+ * configuration in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html">Setting
45
+ * default server-side encryption behavior for directory buckets</a>.</p>
43
46
  * </li>
44
47
  * </ul>
45
48
  * </note>
@@ -49,15 +52,20 @@ declare const DeleteBucketEncryptionCommand_base: {
49
52
  * <ul>
50
53
  * <li>
51
54
  * <p>
52
- * <b>General purpose bucket permissions</b> - The <code>s3:PutEncryptionConfiguration</code> permission is required in a policy.
53
- * The bucket owner has this permission
54
- * by default. The bucket owner can grant this permission to others. For more information
55
- * about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
56
- * Access Permissions to Your Amazon S3 Resources</a>.</p>
55
+ * <b>General purpose bucket permissions</b> - The
56
+ * <code>s3:PutEncryptionConfiguration</code> permission is required in a
57
+ * policy. The bucket owner has this permission by default. The bucket owner
58
+ * can grant this permission to others. For more information about permissions,
59
+ * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
60
+ * Permissions to Your Amazon S3 Resources</a>.</p>
57
61
  * </li>
58
62
  * <li>
59
63
  * <p>
60
- * <b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <code>s3express:PutEncryptionConfiguration</code> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
64
+ * <b>Directory bucket permissions</b> -
65
+ * To grant access to this API operation, you must have the
66
+ * <code>s3express:PutEncryptionConfiguration</code> permission in
67
+ * an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
68
+ * For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
61
69
  * </li>
62
70
  * </ul>
63
71
  * </dd>
@@ -28,7 +28,7 @@ declare const DeleteBucketIntelligentTieringConfigurationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <note>
31
- * <p>This operation is not supported by directory buckets.</p>
31
+ * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
33
  * <p>Deletes the S3 Intelligent-Tiering configuration from the specified bucket.</p>
34
34
  * <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
@@ -28,7 +28,7 @@ declare const DeleteBucketInventoryConfigurationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <note>
31
- * <p>This operation is not supported by directory buckets.</p>
31
+ * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
33
  * <p>Deletes an inventory configuration (identified by the inventory ID) from the
34
34
  * bucket.</p>
@@ -27,18 +27,61 @@ declare const DeleteBucketLifecycleCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <note>
31
- * <p>This operation is not supported by directory buckets.</p>
32
- * </note>
33
- * <p>Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the
30
+ * <p>Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the
34
31
  * lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your
35
32
  * objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of
36
33
  * rules contained in the deleted lifecycle configuration.</p>
37
- * <p>To use this operation, you must have permission to perform the
38
- * <code>s3:PutLifecycleConfiguration</code> action. By default, the bucket owner has this
39
- * permission and the bucket owner can grant this permission to others.</p>
40
- * <p>There is usually some time lag before lifecycle configuration deletion is fully
41
- * propagated to all the Amazon S3 systems.</p>
34
+ * <dl>
35
+ * <dt>Permissions</dt>
36
+ * <dd>
37
+ * <ul>
38
+ * <li>
39
+ * <p>
40
+ * <b>General purpose bucket permissions</b> - By
41
+ * default, all Amazon S3 resources are private, including buckets, objects, and
42
+ * related subresources (for example, lifecycle configuration and website
43
+ * configuration). Only the resource owner (that is, the Amazon Web Services account that
44
+ * created it) can access the resource. The resource owner can optionally grant
45
+ * access permissions to others by writing an access policy. For this
46
+ * operation, a user must have the <code>s3:PutLifecycleConfiguration</code>
47
+ * permission.</p>
48
+ * <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
49
+ * Permissions to Your Amazon S3 Resources</a>.</p>
50
+ * </li>
51
+ * </ul>
52
+ * <ul>
53
+ * <li>
54
+ * <p>
55
+ * <b>Directory bucket permissions</b> -
56
+ * You must have the <code>s3express:PutLifecycleConfiguration</code>
57
+ * permission in an IAM identity-based policy to use this operation.
58
+ * Cross-account access to this API operation isn't supported. The resource
59
+ * owner can optionally grant access permissions to others by creating a role
60
+ * or user for them as long as they are within the same account as the owner
61
+ * and resource.</p>
62
+ * <p>For more information about directory bucket policies and permissions, see
63
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Authorizing Regional endpoint APIs with IAM</a> in the
64
+ * <i>Amazon S3 User Guide</i>.</p>
65
+ * <note>
66
+ * <p>
67
+ * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
68
+ * </code>. Virtual-hosted-style requests aren't supported.
69
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
70
+ * <i>Amazon S3 User Guide</i>.</p>
71
+ * </note>
72
+ * </li>
73
+ * </ul>
74
+ * </dd>
75
+ * </dl>
76
+ * <dl>
77
+ * <dt>HTTP Host header syntax</dt>
78
+ * <dd>
79
+ * <p>
80
+ * <b>Directory buckets </b> - The HTTP Host
81
+ * header syntax is
82
+ * <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
83
+ * </dd>
84
+ * </dl>
42
85
  * <p>For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>.</p>
43
86
  * <p>Related actions include:</p>
44
87
  * <ul>
@@ -28,7 +28,7 @@ declare const DeleteBucketMetricsConfigurationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <note>
31
- * <p>This operation is not supported by directory buckets.</p>
31
+ * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
33
  * <p>Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the
34
34
  * metrics configuration ID) from the bucket. Note that this doesn't include the daily storage
@@ -28,7 +28,7 @@ declare const DeleteBucketOwnershipControlsCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <note>
31
- * <p>This operation is not supported by directory buckets.</p>
31
+ * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
33
  * <p>Removes <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
34
34
  * must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information