@aws-sdk/client-s3 3.933.0 → 3.935.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 (91) hide show
  1. package/dist-cjs/index.js +525 -491
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +392 -0
  4. package/dist-es/models/errors.js +173 -0
  5. package/dist-es/models/models_0.js +1 -436
  6. package/dist-es/models/models_1.js +1 -126
  7. package/dist-es/schemas/schemas_0.js +62 -33
  8. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +1 -1
  9. package/dist-types/commands/DeleteObjectCommand.d.ts +8 -3
  10. package/dist-types/commands/DeleteObjectsCommand.d.ts +5 -0
  11. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +7 -2
  12. package/dist-types/commands/GetBucketPolicyCommand.d.ts +1 -1
  13. package/dist-types/commands/GetBucketTaggingCommand.d.ts +1 -1
  14. package/dist-types/commands/ListObjectVersionsCommand.d.ts +1 -1
  15. package/dist-types/commands/ListObjectsCommand.d.ts +1 -1
  16. package/dist-types/commands/ListObjectsV2Command.d.ts +1 -1
  17. package/dist-types/commands/ListPartsCommand.d.ts +1 -1
  18. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
  19. package/dist-types/commands/PutBucketAclCommand.d.ts +1 -1
  20. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
  21. package/dist-types/commands/PutBucketCorsCommand.d.ts +1 -1
  22. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +7 -2
  23. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  24. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
  25. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
  26. package/dist-types/commands/PutBucketLoggingCommand.d.ts +1 -1
  27. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
  28. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +1 -1
  29. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +1 -1
  30. package/dist-types/commands/PutBucketPolicyCommand.d.ts +1 -1
  31. package/dist-types/commands/PutBucketReplicationCommand.d.ts +1 -1
  32. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
  33. package/dist-types/commands/PutBucketTaggingCommand.d.ts +2 -2
  34. package/dist-types/commands/PutBucketVersioningCommand.d.ts +1 -1
  35. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +1 -1
  36. package/dist-types/commands/PutObjectAclCommand.d.ts +1 -1
  37. package/dist-types/commands/PutObjectCommand.d.ts +1 -1
  38. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -1
  39. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +1 -1
  40. package/dist-types/commands/PutObjectRetentionCommand.d.ts +1 -1
  41. package/dist-types/commands/PutObjectTaggingCommand.d.ts +1 -1
  42. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
  43. package/dist-types/commands/RenameObjectCommand.d.ts +1 -1
  44. package/dist-types/commands/RestoreObjectCommand.d.ts +2 -1
  45. package/dist-types/index.d.ts +4 -1
  46. package/dist-types/models/enums.d.ts +960 -0
  47. package/dist-types/models/errors.d.ts +207 -0
  48. package/dist-types/models/models_0.d.ts +3701 -929
  49. package/dist-types/models/models_1.d.ts +3 -3889
  50. package/dist-types/schemas/schemas_0.d.ts +2 -0
  51. package/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/ListObjectsCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/ListPartsCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/PutBucketAclCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/PutBucketCorsCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/PutBucketEncryptionCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/PutBucketLoggingCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/PutBucketNotificationConfigurationCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/PutBucketOwnershipControlsCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/PutBucketPolicyCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/PutBucketReplicationCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/PutBucketTaggingCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/PutBucketVersioningCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/PutBucketWebsiteCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/PutObjectAclCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/PutObjectCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/PutObjectLegalHoldCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/PutObjectLockConfigurationCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/PutObjectRetentionCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/PutObjectTaggingCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/PutPublicAccessBlockCommand.d.ts +1 -1
  80. package/dist-types/ts3.4/commands/RenameObjectCommand.d.ts +1 -1
  81. package/dist-types/ts3.4/commands/RestoreObjectCommand.d.ts +2 -1
  82. package/dist-types/ts3.4/index.d.ts +4 -1
  83. package/dist-types/ts3.4/models/enums.d.ts +514 -0
  84. package/dist-types/ts3.4/models/errors.d.ts +87 -0
  85. package/dist-types/ts3.4/models/models_0.d.ts +607 -487
  86. package/dist-types/ts3.4/models/models_1.d.ts +11 -677
  87. package/dist-types/ts3.4/schemas/schemas_0.d.ts +2 -0
  88. package/package.json +16 -16
  89. package/dist-es/models/index.js +0 -2
  90. package/dist-types/models/index.d.ts +0 -2
  91. package/dist-types/ts3.4/models/index.d.ts +0 -2
@@ -1,3881 +1,6 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
1
  import { StreamingBlobTypes } from "@smithy/types";
3
- import { AccelerateConfiguration, AccessControlPolicy, AnalyticsConfiguration, BucketCannedACL, BucketVersioningStatus, ChecksumAlgorithm, ChecksumType, CommonPrefix, CORSRule, EncodingType, ErrorDocument, Grant, IndexDocument, Initiator, IntelligentTieringConfiguration, InventoryConfiguration, InventoryConfigurationState, LifecycleRule, LoggingEnabled, MetadataTableEncryptionConfiguration, MetricsConfiguration, NotificationConfiguration, ObjectCannedACL, ObjectLockConfiguration, ObjectLockLegalHold, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetention, Owner, OwnershipControls, Payer, PublicAccessBlockConfiguration, RecordExpiration, RedirectAllRequestsTo, ReplicationConfiguration, ReplicationStatus, RequestCharged, RequestPayer, RestoreStatus, RoutingRule, ServerSideEncryption, ServerSideEncryptionConfiguration, StorageClass, Tag, TransitionDefaultMinimumObjectSize } from "./models_0";
4
- import { S3ServiceException as __BaseException } from "./S3ServiceException";
5
- /**
6
- * @public
7
- * @enum
8
- */
9
- export declare const ObjectStorageClass: {
10
- readonly DEEP_ARCHIVE: "DEEP_ARCHIVE";
11
- readonly EXPRESS_ONEZONE: "EXPRESS_ONEZONE";
12
- readonly FSX_OPENZFS: "FSX_OPENZFS";
13
- readonly GLACIER: "GLACIER";
14
- readonly GLACIER_IR: "GLACIER_IR";
15
- readonly INTELLIGENT_TIERING: "INTELLIGENT_TIERING";
16
- readonly ONEZONE_IA: "ONEZONE_IA";
17
- readonly OUTPOSTS: "OUTPOSTS";
18
- readonly REDUCED_REDUNDANCY: "REDUCED_REDUNDANCY";
19
- readonly SNOW: "SNOW";
20
- readonly STANDARD: "STANDARD";
21
- readonly STANDARD_IA: "STANDARD_IA";
22
- };
23
- /**
24
- * @public
25
- */
26
- export type ObjectStorageClass = (typeof ObjectStorageClass)[keyof typeof ObjectStorageClass];
27
- /**
28
- * <p>An object consists of data and its descriptive metadata.</p>
29
- * @public
30
- */
31
- export interface _Object {
32
- /**
33
- * <p>The name that you assign to an object. You use the object key to retrieve the object.</p>
34
- * @public
35
- */
36
- Key?: string | undefined;
37
- /**
38
- * <p>Creation date of the object.</p>
39
- * @public
40
- */
41
- LastModified?: Date | undefined;
42
- /**
43
- * <p>The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object,
44
- * not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is
45
- * depends on how the object was created and how it is encrypted as described below:</p>
46
- * <ul>
47
- * <li>
48
- * <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services
49
- * Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of
50
- * their object data.</p>
51
- * </li>
52
- * <li>
53
- * <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services
54
- * Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of
55
- * their object data.</p>
56
- * </li>
57
- * <li>
58
- * <p>If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not
59
- * an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services
60
- * Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag
61
- * will not be an MD5 digest.</p>
62
- * </li>
63
- * </ul>
64
- * <note>
65
- * <p>
66
- * <b>Directory buckets</b> - MD5 is not supported by directory buckets.</p>
67
- * </note>
68
- * @public
69
- */
70
- ETag?: string | undefined;
71
- /**
72
- * <p>The algorithm that was used to create a checksum of the object.</p>
73
- * @public
74
- */
75
- ChecksumAlgorithm?: ChecksumAlgorithm[] | undefined;
76
- /**
77
- * <p>The checksum type that is used to calculate the object’s checksum value. For more information, see
78
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking
79
- * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
80
- * @public
81
- */
82
- ChecksumType?: ChecksumType | undefined;
83
- /**
84
- * <p>Size in bytes of the object</p>
85
- * @public
86
- */
87
- Size?: number | undefined;
88
- /**
89
- * <p>The class of storage used to store the object.</p>
90
- * <note>
91
- * <p>
92
- * <b>Directory buckets</b> -
93
- * Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
94
- * </note>
95
- * @public
96
- */
97
- StorageClass?: ObjectStorageClass | undefined;
98
- /**
99
- * <p>The owner of the object</p>
100
- * <note>
101
- * <p>
102
- * <b>Directory buckets</b> - The bucket owner is returned as the
103
- * object owner.</p>
104
- * </note>
105
- * @public
106
- */
107
- Owner?: Owner | undefined;
108
- /**
109
- * <p>Specifies the restoration status of an object. Objects in certain storage classes must be restored
110
- * before they can be retrieved. For more information about these storage classes and how to work with
111
- * archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html">
112
- * Working with archived objects</a> in the <i>Amazon S3 User Guide</i>.</p>
113
- * <note>
114
- * <p>This functionality is not supported for directory buckets. Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
115
- * </note>
116
- * @public
117
- */
118
- RestoreStatus?: RestoreStatus | undefined;
119
- }
120
- /**
121
- * @public
122
- */
123
- export interface ListObjectsOutput {
124
- /**
125
- * <p>A flag that indicates whether Amazon S3 returned all of the results that satisfied the search
126
- * criteria.</p>
127
- * @public
128
- */
129
- IsTruncated?: boolean | undefined;
130
- /**
131
- * <p>Indicates where in the bucket listing begins. Marker is included in the response if it was sent with
132
- * the request.</p>
133
- * @public
134
- */
135
- Marker?: string | undefined;
136
- /**
137
- * <p>When the response is truncated (the <code>IsTruncated</code> element value in the response is
138
- * <code>true</code>), you can use the key name in this field as the <code>marker</code> parameter in the
139
- * subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order. </p>
140
- * <note>
141
- * <p>This element is returned only if you have the <code>delimiter</code> request parameter specified.
142
- * If the response does not include the <code>NextMarker</code> element and it is truncated, you can use
143
- * the value of the last <code>Key</code> element in the response as the <code>marker</code> parameter in
144
- * the subsequent request to get the next set of object keys.</p>
145
- * </note>
146
- * @public
147
- */
148
- NextMarker?: string | undefined;
149
- /**
150
- * <p>Metadata about each object returned.</p>
151
- * @public
152
- */
153
- Contents?: _Object[] | undefined;
154
- /**
155
- * <p>The bucket name.</p>
156
- * @public
157
- */
158
- Name?: string | undefined;
159
- /**
160
- * <p>Keys that begin with the indicated prefix.</p>
161
- * @public
162
- */
163
- Prefix?: string | undefined;
164
- /**
165
- * <p>Causes keys that contain the same string between the prefix and the first occurrence of the
166
- * delimiter to be rolled up into a single result element in the <code>CommonPrefixes</code> collection.
167
- * These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only
168
- * one return against the <code>MaxKeys</code> value.</p>
169
- * @public
170
- */
171
- Delimiter?: string | undefined;
172
- /**
173
- * <p>The maximum number of keys returned in the response body.</p>
174
- * @public
175
- */
176
- MaxKeys?: number | undefined;
177
- /**
178
- * <p>All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating
179
- * the number of returns. </p>
180
- * <p>A response can contain <code>CommonPrefixes</code> only if you specify a delimiter.</p>
181
- * <p>
182
- * <code>CommonPrefixes</code> contains all (if there are any) keys between <code>Prefix</code> and the
183
- * next occurrence of the string specified by the delimiter.</p>
184
- * <p>
185
- * <code>CommonPrefixes</code> lists keys that act like subdirectories in the directory specified by
186
- * <code>Prefix</code>.</p>
187
- * <p>For example, if the prefix is <code>notes/</code> and the delimiter is a slash (<code>/</code>), as
188
- * in <code>notes/summer/july</code>, the common prefix is <code>notes/summer/</code>. All of the keys that
189
- * roll up into a common prefix count as a single return when calculating the number of returns.</p>
190
- * @public
191
- */
192
- CommonPrefixes?: CommonPrefix[] | undefined;
193
- /**
194
- * <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are
195
- * encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser
196
- * can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that
197
- * aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the
198
- * response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key
199
- * naming guidelines</a>.</p>
200
- * <note>
201
- * <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will
202
- * be percent-encoded according to UTF-8 code values. For example, the object
203
- * <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
204
- * </note>
205
- * @public
206
- */
207
- EncodingType?: EncodingType | undefined;
208
- /**
209
- * <p>If present, indicates that the requester was successfully charged for the request. For more
210
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
211
- * Storage Service user guide</i>.</p>
212
- * <note>
213
- * <p>This functionality is not supported for directory buckets.</p>
214
- * </note>
215
- * @public
216
- */
217
- RequestCharged?: RequestCharged | undefined;
218
- }
219
- /**
220
- * @public
221
- * @enum
222
- */
223
- export declare const OptionalObjectAttributes: {
224
- readonly RESTORE_STATUS: "RestoreStatus";
225
- };
226
- /**
227
- * @public
228
- */
229
- export type OptionalObjectAttributes = (typeof OptionalObjectAttributes)[keyof typeof OptionalObjectAttributes];
230
- /**
231
- * @public
232
- */
233
- export interface ListObjectsRequest {
234
- /**
235
- * <p>The name of the bucket containing the objects.</p>
236
- * <p>
237
- * <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
238
- * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code>
239
- * <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
240
- * <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
241
- * restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
242
- * rules</a> in the <i>Amazon S3 User Guide</i>.</p>
243
- * <p>
244
- * <b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
245
- * <note>
246
- * <p>Object Lambda access points are not supported by directory buckets.</p>
247
- * </note>
248
- * <p>
249
- * <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the
250
- * form <code>
251
- * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
252
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
253
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
254
- * @public
255
- */
256
- Bucket: string | undefined;
257
- /**
258
- * <p>A delimiter is a character that you use to group keys.</p>
259
- * <p>
260
- * <code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than
261
- * the key-marker.</p>
262
- * @public
263
- */
264
- Delimiter?: string | undefined;
265
- /**
266
- * <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are
267
- * encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser
268
- * can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that
269
- * aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the
270
- * response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key
271
- * naming guidelines</a>.</p>
272
- * <note>
273
- * <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will
274
- * be percent-encoded according to UTF-8 code values. For example, the object
275
- * <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
276
- * </note>
277
- * @public
278
- */
279
- EncodingType?: EncodingType | undefined;
280
- /**
281
- * <p>Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified
282
- * key. Marker can be any key in the bucket.</p>
283
- * @public
284
- */
285
- Marker?: string | undefined;
286
- /**
287
- * <p>Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000
288
- * key names. The response might contain fewer keys but will never contain more. </p>
289
- * @public
290
- */
291
- MaxKeys?: number | undefined;
292
- /**
293
- * <p>Limits the response to keys that begin with the specified prefix.</p>
294
- * @public
295
- */
296
- Prefix?: string | undefined;
297
- /**
298
- * <p>Confirms that the requester knows that she or he will be charged for the list objects request.
299
- * Bucket owners need not specify this parameter in their requests.</p>
300
- * @public
301
- */
302
- RequestPayer?: RequestPayer | undefined;
303
- /**
304
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
305
- * @public
306
- */
307
- ExpectedBucketOwner?: string | undefined;
308
- /**
309
- * <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify
310
- * are not returned.</p>
311
- * @public
312
- */
313
- OptionalObjectAttributes?: OptionalObjectAttributes[] | undefined;
314
- }
315
- /**
316
- * @public
317
- */
318
- export interface ListObjectsV2Output {
319
- /**
320
- * <p>Set to <code>false</code> if all of the results were returned. Set to <code>true</code> if more keys
321
- * are available to return. If the number of results exceeds that specified by <code>MaxKeys</code>, all of
322
- * the results might not be returned.</p>
323
- * @public
324
- */
325
- IsTruncated?: boolean | undefined;
326
- /**
327
- * <p>Metadata about each object returned.</p>
328
- * @public
329
- */
330
- Contents?: _Object[] | undefined;
331
- /**
332
- * <p>The bucket name.</p>
333
- * @public
334
- */
335
- Name?: string | undefined;
336
- /**
337
- * <p>Keys that begin with the indicated prefix.</p>
338
- * <note>
339
- * <p>
340
- * <b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
341
- * </note>
342
- * @public
343
- */
344
- Prefix?: string | undefined;
345
- /**
346
- * <p>Causes keys that contain the same string between the <code>prefix</code> and the first occurrence of
347
- * the delimiter to be rolled up into a single result element in the <code>CommonPrefixes</code>
348
- * collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result
349
- * counts as only one return against the <code>MaxKeys</code> value.</p>
350
- * <note>
351
- * <p>
352
- * <b>Directory buckets</b> - For directory buckets, <code>/</code> is the only supported delimiter.</p>
353
- * </note>
354
- * @public
355
- */
356
- Delimiter?: string | undefined;
357
- /**
358
- * <p>Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000
359
- * key names. The response might contain fewer keys but will never contain more.</p>
360
- * @public
361
- */
362
- MaxKeys?: number | undefined;
363
- /**
364
- * <p>All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the
365
- * total numbers of returns by this API operation, this group of keys is considered as one item.</p>
366
- * <p>A response can contain <code>CommonPrefixes</code> only if you specify a delimiter.</p>
367
- * <p>
368
- * <code>CommonPrefixes</code> contains all (if there are any) keys between <code>Prefix</code> and the
369
- * next occurrence of the string specified by a delimiter.</p>
370
- * <p>
371
- * <code>CommonPrefixes</code> lists keys that act like subdirectories in the directory specified by
372
- * <code>Prefix</code>.</p>
373
- * <p>For example, if the prefix is <code>notes/</code> and the delimiter is a slash (<code>/</code>) as
374
- * in <code>notes/summer/july</code>, the common prefix is <code>notes/summer/</code>. All of the keys that
375
- * roll up into a common prefix count as a single return when calculating the number of returns. </p>
376
- * <note>
377
- * <ul>
378
- * <li>
379
- * <p>
380
- * <b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
381
- * </li>
382
- * <li>
383
- * <p>
384
- * <b>Directory buckets </b> - When you query
385
- * <code>ListObjectsV2</code> with a delimiter during in-progress multipart uploads, the
386
- * <code>CommonPrefixes</code> response parameter contains the prefixes that are associated with
387
- * the in-progress multipart uploads. For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload
388
- * Overview</a> in the <i>Amazon S3 User Guide</i>.</p>
389
- * </li>
390
- * </ul>
391
- * </note>
392
- * @public
393
- */
394
- CommonPrefixes?: CommonPrefix[] | undefined;
395
- /**
396
- * <p>Encoding type used by Amazon S3 to encode object key names in the XML response.</p>
397
- * <p>If you specify the <code>encoding-type</code> request parameter, Amazon S3 includes this element in the
398
- * response, and returns encoded key name values in the following response elements:</p>
399
- * <p>
400
- * <code>Delimiter, Prefix, Key,</code> and <code>StartAfter</code>.</p>
401
- * @public
402
- */
403
- EncodingType?: EncodingType | undefined;
404
- /**
405
- * <p>
406
- * <code>KeyCount</code> is the number of keys returned with this request. <code>KeyCount</code> will
407
- * always be less than or equal to the <code>MaxKeys</code> field. For example, if you ask for 50 keys,
408
- * your result will include 50 keys or fewer.</p>
409
- * @public
410
- */
411
- KeyCount?: number | undefined;
412
- /**
413
- * <p> If <code>ContinuationToken</code> was sent with the request, it is included in the response. You
414
- * can use the returned <code>ContinuationToken</code> for pagination of the list response.</p>
415
- * @public
416
- */
417
- ContinuationToken?: string | undefined;
418
- /**
419
- * <p>
420
- * <code>NextContinuationToken</code> is sent when <code>isTruncated</code> is true, which means there
421
- * are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with
422
- * this <code>NextContinuationToken</code>. <code>NextContinuationToken</code> is obfuscated and is not a
423
- * real key</p>
424
- * @public
425
- */
426
- NextContinuationToken?: string | undefined;
427
- /**
428
- * <p>If StartAfter was sent with the request, it is included in the response.</p>
429
- * <note>
430
- * <p>This functionality is not supported for directory buckets.</p>
431
- * </note>
432
- * @public
433
- */
434
- StartAfter?: string | undefined;
435
- /**
436
- * <p>If present, indicates that the requester was successfully charged for the request. For more
437
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
438
- * Storage Service user guide</i>.</p>
439
- * <note>
440
- * <p>This functionality is not supported for directory buckets.</p>
441
- * </note>
442
- * @public
443
- */
444
- RequestCharged?: RequestCharged | undefined;
445
- }
446
- /**
447
- * @public
448
- */
449
- export interface ListObjectsV2Request {
450
- /**
451
- * <p>
452
- * <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
453
- * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code>
454
- * <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
455
- * <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
456
- * restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
457
- * rules</a> in the <i>Amazon S3 User Guide</i>.</p>
458
- * <p>
459
- * <b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
460
- * <note>
461
- * <p>Object Lambda access points are not supported by directory buckets.</p>
462
- * </note>
463
- * <p>
464
- * <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the
465
- * form <code>
466
- * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
467
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
468
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
469
- * @public
470
- */
471
- Bucket: string | undefined;
472
- /**
473
- * <p>A delimiter is a character that you use to group keys.</p>
474
- * <p>
475
- * <code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than
476
- * the <code>StartAfter</code> value.</p>
477
- * <note>
478
- * <ul>
479
- * <li>
480
- * <p>
481
- * <b>Directory buckets</b> - For directory buckets, <code>/</code> is the only supported delimiter.</p>
482
- * </li>
483
- * <li>
484
- * <p>
485
- * <b>Directory buckets </b> - When you query
486
- * <code>ListObjectsV2</code> with a delimiter during in-progress multipart uploads, the
487
- * <code>CommonPrefixes</code> response parameter contains the prefixes that are associated with
488
- * the in-progress multipart uploads. For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload
489
- * Overview</a> in the <i>Amazon S3 User Guide</i>.</p>
490
- * </li>
491
- * </ul>
492
- * </note>
493
- * @public
494
- */
495
- Delimiter?: string | undefined;
496
- /**
497
- * <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are
498
- * encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser
499
- * can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that
500
- * aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the
501
- * response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key
502
- * naming guidelines</a>.</p>
503
- * <note>
504
- * <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will
505
- * be percent-encoded according to UTF-8 code values. For example, the object
506
- * <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
507
- * </note>
508
- * @public
509
- */
510
- EncodingType?: EncodingType | undefined;
511
- /**
512
- * <p>Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000
513
- * key names. The response might contain fewer keys but will never contain more.</p>
514
- * @public
515
- */
516
- MaxKeys?: number | undefined;
517
- /**
518
- * <p>Limits the response to keys that begin with the specified prefix.</p>
519
- * <note>
520
- * <p>
521
- * <b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
522
- * </note>
523
- * @public
524
- */
525
- Prefix?: string | undefined;
526
- /**
527
- * <p>
528
- * <code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on this bucket
529
- * with a token. <code>ContinuationToken</code> is obfuscated and is not a real key. You can use this
530
- * <code>ContinuationToken</code> for pagination of the list results. </p>
531
- * @public
532
- */
533
- ContinuationToken?: string | undefined;
534
- /**
535
- * <p>The owner field is not present in <code>ListObjectsV2</code> by default. If you want to return the
536
- * owner field with each key in the result, then set the <code>FetchOwner</code> field to
537
- * <code>true</code>.</p>
538
- * <note>
539
- * <p>
540
- * <b>Directory buckets</b> - For directory buckets, the bucket
541
- * owner is returned as the object owner for all objects.</p>
542
- * </note>
543
- * @public
544
- */
545
- FetchOwner?: boolean | undefined;
546
- /**
547
- * <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified
548
- * key. StartAfter can be any key in the bucket.</p>
549
- * <note>
550
- * <p>This functionality is not supported for directory buckets.</p>
551
- * </note>
552
- * @public
553
- */
554
- StartAfter?: string | undefined;
555
- /**
556
- * <p>Confirms that the requester knows that she or he will be charged for the list objects request in V2
557
- * style. Bucket owners need not specify this parameter in their requests.</p>
558
- * <note>
559
- * <p>This functionality is not supported for directory buckets.</p>
560
- * </note>
561
- * @public
562
- */
563
- RequestPayer?: RequestPayer | undefined;
564
- /**
565
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
566
- * @public
567
- */
568
- ExpectedBucketOwner?: string | undefined;
569
- /**
570
- * <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify
571
- * are not returned.</p>
572
- * <note>
573
- * <p>This functionality is not supported for directory buckets.</p>
574
- * </note>
575
- * @public
576
- */
577
- OptionalObjectAttributes?: OptionalObjectAttributes[] | undefined;
578
- }
579
- /**
580
- * <p>Information about the delete marker.</p>
581
- * @public
582
- */
583
- export interface DeleteMarkerEntry {
584
- /**
585
- * <p>The account that created the delete marker. </p>
586
- * @public
587
- */
588
- Owner?: Owner | undefined;
589
- /**
590
- * <p>The object key.</p>
591
- * @public
592
- */
593
- Key?: string | undefined;
594
- /**
595
- * <p>Version ID of an object.</p>
596
- * @public
597
- */
598
- VersionId?: string | undefined;
599
- /**
600
- * <p>Specifies whether the object is (true) or is not (false) the latest version of an object. </p>
601
- * @public
602
- */
603
- IsLatest?: boolean | undefined;
604
- /**
605
- * <p>Date and time when the object was last modified.</p>
606
- * @public
607
- */
608
- LastModified?: Date | undefined;
609
- }
610
- /**
611
- * @public
612
- * @enum
613
- */
614
- export declare const ObjectVersionStorageClass: {
615
- readonly STANDARD: "STANDARD";
616
- };
617
- /**
618
- * @public
619
- */
620
- export type ObjectVersionStorageClass = (typeof ObjectVersionStorageClass)[keyof typeof ObjectVersionStorageClass];
621
- /**
622
- * <p>The version of an object.</p>
623
- * @public
624
- */
625
- export interface ObjectVersion {
626
- /**
627
- * <p>The entity tag is an MD5 hash of that version of the object.</p>
628
- * @public
629
- */
630
- ETag?: string | undefined;
631
- /**
632
- * <p>The algorithm that was used to create a checksum of the object.</p>
633
- * @public
634
- */
635
- ChecksumAlgorithm?: ChecksumAlgorithm[] | undefined;
636
- /**
637
- * <p>The checksum type that is used to calculate the object’s checksum value. For more information, see
638
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking
639
- * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
640
- * @public
641
- */
642
- ChecksumType?: ChecksumType | undefined;
643
- /**
644
- * <p>Size in bytes of the object.</p>
645
- * @public
646
- */
647
- Size?: number | undefined;
648
- /**
649
- * <p>The class of storage used to store the object.</p>
650
- * @public
651
- */
652
- StorageClass?: ObjectVersionStorageClass | undefined;
653
- /**
654
- * <p>The object key.</p>
655
- * @public
656
- */
657
- Key?: string | undefined;
658
- /**
659
- * <p>Version ID of an object.</p>
660
- * @public
661
- */
662
- VersionId?: string | undefined;
663
- /**
664
- * <p>Specifies whether the object is (true) or is not (false) the latest version of an object.</p>
665
- * @public
666
- */
667
- IsLatest?: boolean | undefined;
668
- /**
669
- * <p>Date and time when the object was last modified.</p>
670
- * @public
671
- */
672
- LastModified?: Date | undefined;
673
- /**
674
- * <p>Specifies the owner of the object.</p>
675
- * @public
676
- */
677
- Owner?: Owner | undefined;
678
- /**
679
- * <p>Specifies the restoration status of an object. Objects in certain storage classes must be restored
680
- * before they can be retrieved. For more information about these storage classes and how to work with
681
- * archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html">
682
- * Working with archived objects</a> in the <i>Amazon S3 User Guide</i>.</p>
683
- * @public
684
- */
685
- RestoreStatus?: RestoreStatus | undefined;
686
- }
687
- /**
688
- * @public
689
- */
690
- export interface ListObjectVersionsOutput {
691
- /**
692
- * <p>A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
693
- * If your results were truncated, you can make a follow-up paginated request by using the
694
- * <code>NextKeyMarker</code> and <code>NextVersionIdMarker</code> response parameters as a starting
695
- * place in another request to return the rest of the results.</p>
696
- * @public
697
- */
698
- IsTruncated?: boolean | undefined;
699
- /**
700
- * <p>Marks the last key returned in a truncated response.</p>
701
- * @public
702
- */
703
- KeyMarker?: string | undefined;
704
- /**
705
- * <p>Marks the last version of the key returned in a truncated response.</p>
706
- * @public
707
- */
708
- VersionIdMarker?: string | undefined;
709
- /**
710
- * <p>When the number of responses exceeds the value of <code>MaxKeys</code>, <code>NextKeyMarker</code>
711
- * specifies the first key not returned that satisfies the search criteria. Use this value for the
712
- * key-marker request parameter in a subsequent request.</p>
713
- * @public
714
- */
715
- NextKeyMarker?: string | undefined;
716
- /**
717
- * <p>When the number of responses exceeds the value of <code>MaxKeys</code>,
718
- * <code>NextVersionIdMarker</code> specifies the first object version not returned that satisfies the
719
- * search criteria. Use this value for the <code>version-id-marker</code> request parameter in a subsequent
720
- * request.</p>
721
- * @public
722
- */
723
- NextVersionIdMarker?: string | undefined;
724
- /**
725
- * <p>Container for version information.</p>
726
- * @public
727
- */
728
- Versions?: ObjectVersion[] | undefined;
729
- /**
730
- * <p>Container for an object that is a delete marker. To learn more about delete markers, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html">Working with delete
731
- * markers</a>.</p>
732
- * @public
733
- */
734
- DeleteMarkers?: DeleteMarkerEntry[] | undefined;
735
- /**
736
- * <p>The bucket name.</p>
737
- * @public
738
- */
739
- Name?: string | undefined;
740
- /**
741
- * <p>Selects objects that start with the value supplied by this parameter.</p>
742
- * @public
743
- */
744
- Prefix?: string | undefined;
745
- /**
746
- * <p>The delimiter grouping the included keys. A delimiter is a character that you specify to group keys.
747
- * All keys that contain the same string between the prefix and the first occurrence of the delimiter are
748
- * grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one
749
- * result against the <code>max-keys</code> limitation. These keys are not returned elsewhere in the
750
- * response.</p>
751
- * @public
752
- */
753
- Delimiter?: string | undefined;
754
- /**
755
- * <p>Specifies the maximum number of objects to return.</p>
756
- * @public
757
- */
758
- MaxKeys?: number | undefined;
759
- /**
760
- * <p>All of the keys rolled up into a common prefix count as a single return when calculating the number
761
- * of returns.</p>
762
- * @public
763
- */
764
- CommonPrefixes?: CommonPrefix[] | undefined;
765
- /**
766
- * <p> Encoding type used by Amazon S3 to encode object key names in the XML response.</p>
767
- * <p>If you specify the <code>encoding-type</code> request parameter, Amazon S3 includes this element in the
768
- * response, and returns encoded key name values in the following response elements:</p>
769
- * <p>
770
- * <code>KeyMarker, NextKeyMarker, Prefix, Key</code>, and <code>Delimiter</code>.</p>
771
- * @public
772
- */
773
- EncodingType?: EncodingType | undefined;
774
- /**
775
- * <p>If present, indicates that the requester was successfully charged for the request. For more
776
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
777
- * Storage Service user guide</i>.</p>
778
- * <note>
779
- * <p>This functionality is not supported for directory buckets.</p>
780
- * </note>
781
- * @public
782
- */
783
- RequestCharged?: RequestCharged | undefined;
784
- }
785
- /**
786
- * @public
787
- */
788
- export interface ListObjectVersionsRequest {
789
- /**
790
- * <p>The bucket name that contains the objects. </p>
791
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
792
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
793
- * @public
794
- */
795
- Bucket: string | undefined;
796
- /**
797
- * <p>A delimiter is a character that you specify to group keys. All keys that contain the same string
798
- * between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single
799
- * result element in <code>CommonPrefixes</code>. These groups are counted as one result against the
800
- * <code>max-keys</code> limitation. These keys are not returned elsewhere in the response.</p>
801
- * <p>
802
- * <code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than
803
- * the key-marker.</p>
804
- * @public
805
- */
806
- Delimiter?: string | undefined;
807
- /**
808
- * <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are
809
- * encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser
810
- * can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that
811
- * aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the
812
- * response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key
813
- * naming guidelines</a>.</p>
814
- * <note>
815
- * <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will
816
- * be percent-encoded according to UTF-8 code values. For example, the object
817
- * <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
818
- * </note>
819
- * @public
820
- */
821
- EncodingType?: EncodingType | undefined;
822
- /**
823
- * <p>Specifies the key to start with when listing objects in a bucket.</p>
824
- * @public
825
- */
826
- KeyMarker?: string | undefined;
827
- /**
828
- * <p>Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000
829
- * key names. The response might contain fewer keys but will never contain more. If additional keys satisfy
830
- * the search criteria, but were not returned because <code>max-keys</code> was exceeded, the response
831
- * contains <code><isTruncated>true</isTruncated></code>. To return the additional keys, see
832
- * <code>key-marker</code> and <code>version-id-marker</code>.</p>
833
- * @public
834
- */
835
- MaxKeys?: number | undefined;
836
- /**
837
- * <p>Use this parameter to select only those keys that begin with the specified prefix. You can use
838
- * prefixes to separate a bucket into different groupings of keys. (You can think of using
839
- * <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can
840
- * use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result
841
- * under <code>CommonPrefixes</code>. </p>
842
- * @public
843
- */
844
- Prefix?: string | undefined;
845
- /**
846
- * <p>Specifies the object version you want to start listing from.</p>
847
- * @public
848
- */
849
- VersionIdMarker?: string | undefined;
850
- /**
851
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
852
- * @public
853
- */
854
- ExpectedBucketOwner?: string | undefined;
855
- /**
856
- * <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
857
- * specify this parameter in their requests. If either the source or destination S3 bucket has Requester
858
- * Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
859
- * downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
860
- * Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
861
- * <note>
862
- * <p>This functionality is not supported for directory buckets.</p>
863
- * </note>
864
- * @public
865
- */
866
- RequestPayer?: RequestPayer | undefined;
867
- /**
868
- * <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify
869
- * are not returned.</p>
870
- * @public
871
- */
872
- OptionalObjectAttributes?: OptionalObjectAttributes[] | undefined;
873
- }
874
- /**
875
- * <p>Container for elements related to a part.</p>
876
- * @public
877
- */
878
- export interface Part {
879
- /**
880
- * <p>Part number identifying the part. This is a positive integer between 1 and 10,000.</p>
881
- * @public
882
- */
883
- PartNumber?: number | undefined;
884
- /**
885
- * <p>Date and time at which the part was uploaded.</p>
886
- * @public
887
- */
888
- LastModified?: Date | undefined;
889
- /**
890
- * <p>Entity tag returned when the part was uploaded.</p>
891
- * @public
892
- */
893
- ETag?: string | undefined;
894
- /**
895
- * <p>Size in bytes of the uploaded part data.</p>
896
- * @public
897
- */
898
- Size?: number | undefined;
899
- /**
900
- * <p>The Base64 encoded, 32-bit <code>CRC32</code> checksum of the part. This checksum is present if the
901
- * object was uploaded with the <code>CRC32</code> checksum algorithm. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
902
- * integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
903
- * @public
904
- */
905
- ChecksumCRC32?: string | undefined;
906
- /**
907
- * <p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the part. This checksum is present if the
908
- * object was uploaded with the <code>CRC32C</code> checksum algorithm. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
909
- * integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
910
- * @public
911
- */
912
- ChecksumCRC32C?: string | undefined;
913
- /**
914
- * <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. This checksum is present if
915
- * the multipart upload request was created with the <code>CRC64NVME</code> checksum algorithm, or if the
916
- * object was uploaded without a checksum (and Amazon S3 added the default checksum, <code>CRC64NVME</code>, to
917
- * the uploaded object). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
918
- * the <i>Amazon S3 User Guide</i>.</p>
919
- * @public
920
- */
921
- ChecksumCRC64NVME?: string | undefined;
922
- /**
923
- * <p>The Base64 encoded, 160-bit <code>SHA1</code> checksum of the part. This checksum is present if the
924
- * object was uploaded with the <code>SHA1</code> checksum algorithm. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
925
- * integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
926
- * @public
927
- */
928
- ChecksumSHA1?: string | undefined;
929
- /**
930
- * <p>The Base64 encoded, 256-bit <code>SHA256</code> checksum of the part. This checksum is present if
931
- * the object was uploaded with the <code>SHA256</code> checksum algorithm. For more information, see
932
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking
933
- * object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
934
- * @public
935
- */
936
- ChecksumSHA256?: string | undefined;
937
- }
938
- /**
939
- * @public
940
- */
941
- export interface ListPartsOutput {
942
- /**
943
- * <p>If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads
944
- * and the prefix in the lifecycle rule matches the object name in the request, then the response includes
945
- * this header indicating when the initiated multipart upload will become eligible for abort operation. For
946
- * more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting
947
- * Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>.</p>
948
- * <p>The response will also include the <code>x-amz-abort-rule-id</code> header that will provide the ID
949
- * of the lifecycle configuration rule that defines this action.</p>
950
- * <note>
951
- * <p>This functionality is not supported for directory buckets.</p>
952
- * </note>
953
- * @public
954
- */
955
- AbortDate?: Date | undefined;
956
- /**
957
- * <p>This header is returned along with the <code>x-amz-abort-date</code> header. It identifies
958
- * applicable lifecycle configuration rule that defines the action to abort incomplete multipart
959
- * uploads.</p>
960
- * <note>
961
- * <p>This functionality is not supported for directory buckets.</p>
962
- * </note>
963
- * @public
964
- */
965
- AbortRuleId?: string | undefined;
966
- /**
967
- * <p>The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or
968
- * access point alias if used.</p>
969
- * @public
970
- */
971
- Bucket?: string | undefined;
972
- /**
973
- * <p>Object key for which the multipart upload was initiated.</p>
974
- * @public
975
- */
976
- Key?: string | undefined;
977
- /**
978
- * <p>Upload ID identifying the multipart upload whose parts are being listed.</p>
979
- * @public
980
- */
981
- UploadId?: string | undefined;
982
- /**
983
- * <p>Specifies the part after which listing should begin. Only parts with higher part numbers will be
984
- * listed.</p>
985
- * @public
986
- */
987
- PartNumberMarker?: string | undefined;
988
- /**
989
- * <p>When a list is truncated, this element specifies the last part in the list, as well as the value to
990
- * use for the <code>part-number-marker</code> request parameter in a subsequent request.</p>
991
- * @public
992
- */
993
- NextPartNumberMarker?: string | undefined;
994
- /**
995
- * <p>Maximum number of parts that were allowed in the response.</p>
996
- * @public
997
- */
998
- MaxParts?: number | undefined;
999
- /**
1000
- * <p> Indicates whether the returned list of parts is truncated. A true value indicates that the list was
1001
- * truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts
1002
- * element.</p>
1003
- * @public
1004
- */
1005
- IsTruncated?: boolean | undefined;
1006
- /**
1007
- * <p>Container for elements related to a particular part. A response can contain zero or more
1008
- * <code>Part</code> elements.</p>
1009
- * @public
1010
- */
1011
- Parts?: Part[] | undefined;
1012
- /**
1013
- * <p>Container element that identifies who initiated the multipart upload. If the initiator is an
1014
- * Amazon Web Services account, this element provides the same information as the <code>Owner</code> element. If the
1015
- * initiator is an IAM User, this element provides the user ARN and display name.</p>
1016
- * @public
1017
- */
1018
- Initiator?: Initiator | undefined;
1019
- /**
1020
- * <p>Container element that identifies the object owner, after the object is created. If multipart upload
1021
- * is initiated by an IAM user, this element provides the parent account ID and display name.</p>
1022
- * <note>
1023
- * <p>
1024
- * <b>Directory buckets</b> - The bucket owner is returned as the
1025
- * object owner for all the parts.</p>
1026
- * </note>
1027
- * @public
1028
- */
1029
- Owner?: Owner | undefined;
1030
- /**
1031
- * <p>The class of storage used to store the uploaded object.</p>
1032
- * <note>
1033
- * <p>
1034
- * <b>Directory buckets</b> -
1035
- * Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
1036
- * </note>
1037
- * @public
1038
- */
1039
- StorageClass?: StorageClass | undefined;
1040
- /**
1041
- * <p>If present, indicates that the requester was successfully charged for the request. For more
1042
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
1043
- * Storage Service user guide</i>.</p>
1044
- * <note>
1045
- * <p>This functionality is not supported for directory buckets.</p>
1046
- * </note>
1047
- * @public
1048
- */
1049
- RequestCharged?: RequestCharged | undefined;
1050
- /**
1051
- * <p>The algorithm that was used to create a checksum of the object.</p>
1052
- * @public
1053
- */
1054
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1055
- /**
1056
- * <p>The checksum type, which determines how part-level checksums are combined to create an object-level
1057
- * checksum for multipart objects. You can use this header response to verify that the checksum type that
1058
- * is received is the same checksum type that was specified in <code>CreateMultipartUpload</code> request.
1059
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3
1060
- * User Guide</a>.</p>
1061
- * @public
1062
- */
1063
- ChecksumType?: ChecksumType | undefined;
1064
- }
1065
- /**
1066
- * @public
1067
- */
1068
- export interface ListPartsRequest {
1069
- /**
1070
- * <p>The name of the bucket to which the parts are being uploaded. </p>
1071
- * <p>
1072
- * <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
1073
- * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code>
1074
- * <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
1075
- * <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
1076
- * restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
1077
- * rules</a> in the <i>Amazon S3 User Guide</i>.</p>
1078
- * <p>
1079
- * <b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
1080
- * <note>
1081
- * <p>Object Lambda access points are not supported by directory buckets.</p>
1082
- * </note>
1083
- * <p>
1084
- * <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the
1085
- * form <code>
1086
- * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
1087
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1088
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1089
- * @public
1090
- */
1091
- Bucket: string | undefined;
1092
- /**
1093
- * <p>Object key for which the multipart upload was initiated.</p>
1094
- * @public
1095
- */
1096
- Key: string | undefined;
1097
- /**
1098
- * <p>Sets the maximum number of parts to return.</p>
1099
- * @public
1100
- */
1101
- MaxParts?: number | undefined;
1102
- /**
1103
- * <p>Specifies the part after which listing should begin. Only parts with higher part numbers will be
1104
- * listed.</p>
1105
- * @public
1106
- */
1107
- PartNumberMarker?: string | undefined;
1108
- /**
1109
- * <p>Upload ID identifying the multipart upload whose parts are being listed.</p>
1110
- * @public
1111
- */
1112
- UploadId: string | undefined;
1113
- /**
1114
- * <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
1115
- * specify this parameter in their requests. If either the source or destination S3 bucket has Requester
1116
- * Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
1117
- * downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
1118
- * Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
1119
- * <note>
1120
- * <p>This functionality is not supported for directory buckets.</p>
1121
- * </note>
1122
- * @public
1123
- */
1124
- RequestPayer?: RequestPayer | undefined;
1125
- /**
1126
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1127
- * @public
1128
- */
1129
- ExpectedBucketOwner?: string | undefined;
1130
- /**
1131
- * <p>The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created
1132
- * using a checksum algorithm. For more information,
1133
- * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
1134
- * <i>Amazon S3 User Guide</i>.</p>
1135
- * <note>
1136
- * <p>This functionality is not supported for directory buckets.</p>
1137
- * </note>
1138
- * @public
1139
- */
1140
- SSECustomerAlgorithm?: string | undefined;
1141
- /**
1142
- * <p>The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm.
1143
- * For more information, see
1144
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
1145
- * <i>Amazon S3 User Guide</i>.</p>
1146
- * <note>
1147
- * <p>This functionality is not supported for directory buckets.</p>
1148
- * </note>
1149
- * @public
1150
- */
1151
- SSECustomerKey?: string | undefined;
1152
- /**
1153
- * <p>The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum
1154
- * algorithm. For more information,
1155
- * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
1156
- * <i>Amazon S3 User Guide</i>.</p>
1157
- * <note>
1158
- * <p>This functionality is not supported for directory buckets.</p>
1159
- * </note>
1160
- * @public
1161
- */
1162
- SSECustomerKeyMD5?: string | undefined;
1163
- }
1164
- /**
1165
- * @public
1166
- */
1167
- export interface PutBucketAccelerateConfigurationRequest {
1168
- /**
1169
- * <p>The name of the bucket for which the accelerate configuration is set.</p>
1170
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1171
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1172
- * @public
1173
- */
1174
- Bucket: string | undefined;
1175
- /**
1176
- * <p>Container for setting the transfer acceleration state.</p>
1177
- * @public
1178
- */
1179
- AccelerateConfiguration: AccelerateConfiguration | undefined;
1180
- /**
1181
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1182
- * @public
1183
- */
1184
- ExpectedBucketOwner?: string | undefined;
1185
- /**
1186
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1187
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1188
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1189
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1190
- * the <i>Amazon S3 User Guide</i>.</p>
1191
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1192
- * parameter.</p>
1193
- * @public
1194
- */
1195
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1196
- }
1197
- /**
1198
- * @public
1199
- */
1200
- export interface PutBucketAclRequest {
1201
- /**
1202
- * <p>The canned ACL to apply to the bucket.</p>
1203
- * @public
1204
- */
1205
- ACL?: BucketCannedACL | undefined;
1206
- /**
1207
- * <p>Contains the elements that set the ACL permissions for an object per grantee.</p>
1208
- * @public
1209
- */
1210
- AccessControlPolicy?: AccessControlPolicy | undefined;
1211
- /**
1212
- * <p>The bucket to which to apply the ACL.</p>
1213
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1214
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1215
- * @public
1216
- */
1217
- Bucket: string | undefined;
1218
- /**
1219
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a
1220
- * message integrity check to verify that the request body was not corrupted in transit. For more
1221
- * information, go to <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.</a>
1222
- * </p>
1223
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1224
- * @public
1225
- */
1226
- ContentMD5?: string | undefined;
1227
- /**
1228
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1229
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1230
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1231
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1232
- * the <i>Amazon S3 User Guide</i>.</p>
1233
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1234
- * parameter.</p>
1235
- * @public
1236
- */
1237
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1238
- /**
1239
- * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>
1240
- * @public
1241
- */
1242
- GrantFullControl?: string | undefined;
1243
- /**
1244
- * <p>Allows grantee to list the objects in the bucket.</p>
1245
- * @public
1246
- */
1247
- GrantRead?: string | undefined;
1248
- /**
1249
- * <p>Allows grantee to read the bucket ACL.</p>
1250
- * @public
1251
- */
1252
- GrantReadACP?: string | undefined;
1253
- /**
1254
- * <p>Allows grantee to create new objects in the bucket.</p>
1255
- * <p>For the bucket and object owners of existing objects, also allows deletions and overwrites of those
1256
- * objects.</p>
1257
- * @public
1258
- */
1259
- GrantWrite?: string | undefined;
1260
- /**
1261
- * <p>Allows grantee to write the ACL for the applicable bucket.</p>
1262
- * @public
1263
- */
1264
- GrantWriteACP?: string | undefined;
1265
- /**
1266
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1267
- * @public
1268
- */
1269
- ExpectedBucketOwner?: string | undefined;
1270
- }
1271
- /**
1272
- * @public
1273
- */
1274
- export interface PutBucketAnalyticsConfigurationRequest {
1275
- /**
1276
- * <p>The name of the bucket to which an analytics configuration is stored.</p>
1277
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1278
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1279
- * @public
1280
- */
1281
- Bucket: string | undefined;
1282
- /**
1283
- * <p>The ID that identifies the analytics configuration.</p>
1284
- * @public
1285
- */
1286
- Id: string | undefined;
1287
- /**
1288
- * <p>The configuration and any analyses for the analytics filter.</p>
1289
- * @public
1290
- */
1291
- AnalyticsConfiguration: AnalyticsConfiguration | undefined;
1292
- /**
1293
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1294
- * @public
1295
- */
1296
- ExpectedBucketOwner?: string | undefined;
1297
- }
1298
- /**
1299
- * <p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information,
1300
- * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource
1301
- * Sharing</a> in the <i>Amazon S3 User Guide</i>.</p>
1302
- * @public
1303
- */
1304
- export interface CORSConfiguration {
1305
- /**
1306
- * <p>A set of origins and methods (cross-origin access that you want to allow). You can add up to 100
1307
- * rules to the configuration.</p>
1308
- * @public
1309
- */
1310
- CORSRules: CORSRule[] | undefined;
1311
- }
1312
- /**
1313
- * @public
1314
- */
1315
- export interface PutBucketCorsRequest {
1316
- /**
1317
- * <p>Specifies the bucket impacted by the <code>cors</code>configuration.</p>
1318
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1319
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1320
- * @public
1321
- */
1322
- Bucket: string | undefined;
1323
- /**
1324
- * <p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information,
1325
- * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource
1326
- * Sharing</a> in the <i>Amazon S3 User Guide</i>.</p>
1327
- * @public
1328
- */
1329
- CORSConfiguration: CORSConfiguration | undefined;
1330
- /**
1331
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a
1332
- * message integrity check to verify that the request body was not corrupted in transit. For more
1333
- * information, go to <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.</a>
1334
- * </p>
1335
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1336
- * @public
1337
- */
1338
- ContentMD5?: string | undefined;
1339
- /**
1340
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1341
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1342
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1343
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1344
- * the <i>Amazon S3 User Guide</i>.</p>
1345
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1346
- * parameter.</p>
1347
- * @public
1348
- */
1349
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1350
- /**
1351
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1352
- * @public
1353
- */
1354
- ExpectedBucketOwner?: string | undefined;
1355
- }
1356
- /**
1357
- * @public
1358
- */
1359
- export interface PutBucketEncryptionRequest {
1360
- /**
1361
- * <p>Specifies default encryption for a bucket using server-side encryption with different key
1362
- * options.</p>
1363
- * <p>
1364
- * <b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
1365
- * </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code>
1366
- * <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
1367
- * <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). 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> in the <i>Amazon S3 User Guide</i>
1368
- * </p>
1369
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1370
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1371
- * @public
1372
- */
1373
- Bucket: string | undefined;
1374
- /**
1375
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the server-side encryption
1376
- * configuration.</p>
1377
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1378
- * <note>
1379
- * <p>This functionality is not supported for directory buckets.</p>
1380
- * </note>
1381
- * @public
1382
- */
1383
- ContentMD5?: string | undefined;
1384
- /**
1385
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1386
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1387
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1388
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1389
- * the <i>Amazon S3 User Guide</i>.</p>
1390
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1391
- * parameter.</p>
1392
- * <note>
1393
- * <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
1394
- * </note>
1395
- * @public
1396
- */
1397
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1398
- /**
1399
- * <p>Specifies the default server-side-encryption configuration.</p>
1400
- * @public
1401
- */
1402
- ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
1403
- /**
1404
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1405
- * <note>
1406
- * <p>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code
1407
- * <code>501 Not Implemented</code>.</p>
1408
- * </note>
1409
- * @public
1410
- */
1411
- ExpectedBucketOwner?: string | undefined;
1412
- }
1413
- /**
1414
- * @public
1415
- */
1416
- export interface PutBucketIntelligentTieringConfigurationRequest {
1417
- /**
1418
- * <p>The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.</p>
1419
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1420
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1421
- * @public
1422
- */
1423
- Bucket: string | undefined;
1424
- /**
1425
- * <p>The ID used to identify the S3 Intelligent-Tiering configuration.</p>
1426
- * @public
1427
- */
1428
- Id: string | undefined;
1429
- /**
1430
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1431
- * @public
1432
- */
1433
- ExpectedBucketOwner?: string | undefined;
1434
- /**
1435
- * <p>Container for S3 Intelligent-Tiering configuration.</p>
1436
- * @public
1437
- */
1438
- IntelligentTieringConfiguration: IntelligentTieringConfiguration | undefined;
1439
- }
1440
- /**
1441
- * @public
1442
- */
1443
- export interface PutBucketInventoryConfigurationRequest {
1444
- /**
1445
- * <p>The name of the bucket where the inventory configuration will be stored.</p>
1446
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1447
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1448
- * @public
1449
- */
1450
- Bucket: string | undefined;
1451
- /**
1452
- * <p>The ID used to identify the inventory configuration.</p>
1453
- * @public
1454
- */
1455
- Id: string | undefined;
1456
- /**
1457
- * <p>Specifies the inventory configuration.</p>
1458
- * @public
1459
- */
1460
- InventoryConfiguration: InventoryConfiguration | undefined;
1461
- /**
1462
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1463
- * @public
1464
- */
1465
- ExpectedBucketOwner?: string | undefined;
1466
- }
1467
- /**
1468
- * @public
1469
- */
1470
- export interface PutBucketLifecycleConfigurationOutput {
1471
- /**
1472
- * <p>Indicates which default minimum object size behavior is applied to the lifecycle
1473
- * configuration.</p>
1474
- * <note>
1475
- * <p>This parameter applies to general purpose buckets only. It is not supported for directory bucket
1476
- * lifecycle configurations.</p>
1477
- * </note>
1478
- * <ul>
1479
- * <li>
1480
- * <p>
1481
- * <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not transition to
1482
- * any storage class by default. </p>
1483
- * </li>
1484
- * <li>
1485
- * <p>
1486
- * <code>varies_by_storage_class</code> - Objects smaller than 128 KB will transition to Glacier
1487
- * Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes
1488
- * will prevent transitions smaller than 128 KB. </p>
1489
- * </li>
1490
- * </ul>
1491
- * <p>To customize the minimum object size for any transition you can add a filter that specifies a custom
1492
- * <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in the body of your transition
1493
- * rule. Custom filters always take precedence over the default transition behavior.</p>
1494
- * @public
1495
- */
1496
- TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
1497
- }
1498
- /**
1499
- * <p>Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see
1500
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle
1501
- * Management</a> in the <i>Amazon S3 User Guide</i>.</p>
1502
- * @public
1503
- */
1504
- export interface BucketLifecycleConfiguration {
1505
- /**
1506
- * <p>A lifecycle rule for individual objects in an Amazon S3 bucket.</p>
1507
- * @public
1508
- */
1509
- Rules: LifecycleRule[] | undefined;
1510
- }
1511
- /**
1512
- * @public
1513
- */
1514
- export interface PutBucketLifecycleConfigurationRequest {
1515
- /**
1516
- * <p>The name of the bucket for which to set the configuration.</p>
1517
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1518
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1519
- * @public
1520
- */
1521
- Bucket: string | undefined;
1522
- /**
1523
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1524
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1525
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1526
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1527
- * the <i>Amazon S3 User Guide</i>.</p>
1528
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1529
- * parameter.</p>
1530
- * @public
1531
- */
1532
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1533
- /**
1534
- * <p>Container for lifecycle rules. You can add as many as 1,000 rules.</p>
1535
- * @public
1536
- */
1537
- LifecycleConfiguration?: BucketLifecycleConfiguration | undefined;
1538
- /**
1539
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1540
- * <note>
1541
- * <p>This parameter applies to general purpose buckets only. It is not supported for directory bucket
1542
- * lifecycle configurations.</p>
1543
- * </note>
1544
- * @public
1545
- */
1546
- ExpectedBucketOwner?: string | undefined;
1547
- /**
1548
- * <p>Indicates which default minimum object size behavior is applied to the lifecycle
1549
- * configuration.</p>
1550
- * <note>
1551
- * <p>This parameter applies to general purpose buckets only. It is not supported for directory bucket
1552
- * lifecycle configurations.</p>
1553
- * </note>
1554
- * <ul>
1555
- * <li>
1556
- * <p>
1557
- * <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not transition to
1558
- * any storage class by default. </p>
1559
- * </li>
1560
- * <li>
1561
- * <p>
1562
- * <code>varies_by_storage_class</code> - Objects smaller than 128 KB will transition to Glacier
1563
- * Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes
1564
- * will prevent transitions smaller than 128 KB. </p>
1565
- * </li>
1566
- * </ul>
1567
- * <p>To customize the minimum object size for any transition you can add a filter that specifies a custom
1568
- * <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in the body of your transition
1569
- * rule. Custom filters always take precedence over the default transition behavior.</p>
1570
- * @public
1571
- */
1572
- TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
1573
- }
1574
- /**
1575
- * <p>Container for logging status information.</p>
1576
- * @public
1577
- */
1578
- export interface BucketLoggingStatus {
1579
- /**
1580
- * <p>Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a
1581
- * bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html">PUT Bucket logging</a> in the
1582
- * <i>Amazon S3 API Reference</i>.</p>
1583
- * @public
1584
- */
1585
- LoggingEnabled?: LoggingEnabled | undefined;
1586
- }
1587
- /**
1588
- * @public
1589
- */
1590
- export interface PutBucketLoggingRequest {
1591
- /**
1592
- * <p>The name of the bucket for which to set the logging parameters.</p>
1593
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1594
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1595
- * @public
1596
- */
1597
- Bucket: string | undefined;
1598
- /**
1599
- * <p>Container for logging status information.</p>
1600
- * @public
1601
- */
1602
- BucketLoggingStatus: BucketLoggingStatus | undefined;
1603
- /**
1604
- * <p>The MD5 hash of the <code>PutBucketLogging</code> request body.</p>
1605
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1606
- * @public
1607
- */
1608
- ContentMD5?: string | undefined;
1609
- /**
1610
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1611
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1612
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1613
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1614
- * the <i>Amazon S3 User Guide</i>.</p>
1615
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1616
- * parameter.</p>
1617
- * @public
1618
- */
1619
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1620
- /**
1621
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1622
- * @public
1623
- */
1624
- ExpectedBucketOwner?: string | undefined;
1625
- }
1626
- /**
1627
- * @public
1628
- */
1629
- export interface PutBucketMetricsConfigurationRequest {
1630
- /**
1631
- * <p>The name of the bucket for which the metrics configuration is set.</p>
1632
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1633
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1634
- * @public
1635
- */
1636
- Bucket: string | undefined;
1637
- /**
1638
- * <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and can only
1639
- * contain letters, numbers, periods, dashes, and underscores.</p>
1640
- * @public
1641
- */
1642
- Id: string | undefined;
1643
- /**
1644
- * <p>Specifies the metrics configuration.</p>
1645
- * @public
1646
- */
1647
- MetricsConfiguration: MetricsConfiguration | undefined;
1648
- /**
1649
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1650
- * @public
1651
- */
1652
- ExpectedBucketOwner?: string | undefined;
1653
- }
1654
- /**
1655
- * @public
1656
- */
1657
- export interface PutBucketNotificationConfigurationRequest {
1658
- /**
1659
- * <p>The name of the bucket.</p>
1660
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1661
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1662
- * @public
1663
- */
1664
- Bucket: string | undefined;
1665
- /**
1666
- * <p>A container for specifying the notification configuration of the bucket. If this element is empty,
1667
- * notifications are turned off for the bucket.</p>
1668
- * @public
1669
- */
1670
- NotificationConfiguration: NotificationConfiguration | undefined;
1671
- /**
1672
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1673
- * @public
1674
- */
1675
- ExpectedBucketOwner?: string | undefined;
1676
- /**
1677
- * <p>Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations.
1678
- * True or false value.</p>
1679
- * @public
1680
- */
1681
- SkipDestinationValidation?: boolean | undefined;
1682
- }
1683
- /**
1684
- * @public
1685
- */
1686
- export interface PutBucketOwnershipControlsRequest {
1687
- /**
1688
- * <p>The name of the Amazon S3 bucket whose <code>OwnershipControls</code> you want to set.</p>
1689
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1690
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1691
- * @public
1692
- */
1693
- Bucket: string | undefined;
1694
- /**
1695
- * <p>The MD5 hash of the <code>OwnershipControls</code> request body. </p>
1696
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1697
- * @public
1698
- */
1699
- ContentMD5?: string | undefined;
1700
- /**
1701
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1702
- * @public
1703
- */
1704
- ExpectedBucketOwner?: string | undefined;
1705
- /**
1706
- * <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that
1707
- * you want to apply to this Amazon S3 bucket.</p>
1708
- * @public
1709
- */
1710
- OwnershipControls: OwnershipControls | undefined;
1711
- /**
1712
- * <p> Indicates the algorithm used to create the checksum for the object when you use the SDK. This
1713
- * header will not provide any additional functionality if you don't use the SDK. When you send this
1714
- * header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i>
1715
- * </code> header
1716
- * sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1717
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1718
- * the <i>Amazon S3 User Guide</i>.</p>
1719
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1720
- * parameter. </p>
1721
- * @public
1722
- */
1723
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1724
- }
1725
- /**
1726
- * @public
1727
- */
1728
- export interface PutBucketPolicyRequest {
1729
- /**
1730
- * <p>The name of the bucket.</p>
1731
- * <p>
1732
- * <b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
1733
- * </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code>
1734
- * <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
1735
- * <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). 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> in the <i>Amazon S3 User Guide</i>
1736
- * </p>
1737
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1738
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1739
- * @public
1740
- */
1741
- Bucket: string | undefined;
1742
- /**
1743
- * <p>The MD5 hash of the request body.</p>
1744
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1745
- * <note>
1746
- * <p>This functionality is not supported for directory buckets.</p>
1747
- * </note>
1748
- * @public
1749
- */
1750
- ContentMD5?: string | undefined;
1751
- /**
1752
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1753
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i>
1754
- * </code> or
1755
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p>
1756
- * <p>For the <code>x-amz-checksum-<i>algorithm</i>
1757
- * </code> header, replace <code>
1758
- * <i>algorithm</i>
1759
- * </code> with the supported algorithm from the following list: </p>
1760
- * <ul>
1761
- * <li>
1762
- * <p>
1763
- * <code>CRC32</code>
1764
- * </p>
1765
- * </li>
1766
- * <li>
1767
- * <p>
1768
- * <code>CRC32C</code>
1769
- * </p>
1770
- * </li>
1771
- * <li>
1772
- * <p>
1773
- * <code>CRC64NVME</code>
1774
- * </p>
1775
- * </li>
1776
- * <li>
1777
- * <p>
1778
- * <code>SHA1</code>
1779
- * </p>
1780
- * </li>
1781
- * <li>
1782
- * <p>
1783
- * <code>SHA256</code>
1784
- * </p>
1785
- * </li>
1786
- * </ul>
1787
- * <p>For more
1788
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1789
- * the <i>Amazon S3 User Guide</i>.</p>
1790
- * <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i>
1791
- * </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error.</p>
1792
- * <note>
1793
- * <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
1794
- * </note>
1795
- * @public
1796
- */
1797
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1798
- /**
1799
- * <p>Set this parameter to true to confirm that you want to remove your permissions to change this bucket
1800
- * policy in the future.</p>
1801
- * <note>
1802
- * <p>This functionality is not supported for directory buckets.</p>
1803
- * </note>
1804
- * @public
1805
- */
1806
- ConfirmRemoveSelfBucketAccess?: boolean | undefined;
1807
- /**
1808
- * <p>The bucket policy as a JSON document.</p>
1809
- * <p>For directory buckets, the only IAM action supported in the bucket policy is
1810
- * <code>s3express:CreateSession</code>.</p>
1811
- * @public
1812
- */
1813
- Policy: string | undefined;
1814
- /**
1815
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1816
- * <note>
1817
- * <p>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code
1818
- * <code>501 Not Implemented</code>.</p>
1819
- * </note>
1820
- * @public
1821
- */
1822
- ExpectedBucketOwner?: string | undefined;
1823
- }
1824
- /**
1825
- * @public
1826
- */
1827
- export interface PutBucketReplicationRequest {
1828
- /**
1829
- * <p>The name of the bucket</p>
1830
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1831
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1832
- * @public
1833
- */
1834
- Bucket: string | undefined;
1835
- /**
1836
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
1837
- * message integrity check to verify that the request body was not corrupted in transit. For more
1838
- * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
1839
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1840
- * @public
1841
- */
1842
- ContentMD5?: string | undefined;
1843
- /**
1844
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1845
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1846
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1847
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1848
- * the <i>Amazon S3 User Guide</i>.</p>
1849
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1850
- * parameter.</p>
1851
- * @public
1852
- */
1853
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1854
- /**
1855
- * <p>A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication
1856
- * configuration is 2 MB.</p>
1857
- * @public
1858
- */
1859
- ReplicationConfiguration: ReplicationConfiguration | undefined;
1860
- /**
1861
- * <p>A token to allow Object Lock to be enabled for an existing bucket.</p>
1862
- * @public
1863
- */
1864
- Token?: string | undefined;
1865
- /**
1866
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1867
- * @public
1868
- */
1869
- ExpectedBucketOwner?: string | undefined;
1870
- }
1871
- /**
1872
- * <p>Container for Payer.</p>
1873
- * @public
1874
- */
1875
- export interface RequestPaymentConfiguration {
1876
- /**
1877
- * <p>Specifies who pays for the download and request fees.</p>
1878
- * @public
1879
- */
1880
- Payer: Payer | undefined;
1881
- }
1882
- /**
1883
- * @public
1884
- */
1885
- export interface PutBucketRequestPaymentRequest {
1886
- /**
1887
- * <p>The bucket name.</p>
1888
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1889
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1890
- * @public
1891
- */
1892
- Bucket: string | undefined;
1893
- /**
1894
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
1895
- * message integrity check to verify that the request body was not corrupted in transit. For more
1896
- * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
1897
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1898
- * @public
1899
- */
1900
- ContentMD5?: string | undefined;
1901
- /**
1902
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1903
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1904
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1905
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1906
- * the <i>Amazon S3 User Guide</i>.</p>
1907
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1908
- * parameter.</p>
1909
- * @public
1910
- */
1911
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1912
- /**
1913
- * <p>Container for Payer.</p>
1914
- * @public
1915
- */
1916
- RequestPaymentConfiguration: RequestPaymentConfiguration | undefined;
1917
- /**
1918
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1919
- * @public
1920
- */
1921
- ExpectedBucketOwner?: string | undefined;
1922
- }
1923
- /**
1924
- * <p>Container for <code>TagSet</code> elements.</p>
1925
- * @public
1926
- */
1927
- export interface Tagging {
1928
- /**
1929
- * <p>A collection for a set of tags</p>
1930
- * @public
1931
- */
1932
- TagSet: Tag[] | undefined;
1933
- }
1934
- /**
1935
- * @public
1936
- */
1937
- export interface PutBucketTaggingRequest {
1938
- /**
1939
- * <p>The bucket name.</p>
1940
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
1941
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
1942
- * @public
1943
- */
1944
- Bucket: string | undefined;
1945
- /**
1946
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
1947
- * message integrity check to verify that the request body was not corrupted in transit. For more
1948
- * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
1949
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
1950
- * @public
1951
- */
1952
- ContentMD5?: string | undefined;
1953
- /**
1954
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
1955
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
1956
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
1957
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
1958
- * the <i>Amazon S3 User Guide</i>.</p>
1959
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
1960
- * parameter.</p>
1961
- * @public
1962
- */
1963
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
1964
- /**
1965
- * <p>Container for the <code>TagSet</code> and <code>Tag</code> elements.</p>
1966
- * @public
1967
- */
1968
- Tagging: Tagging | undefined;
1969
- /**
1970
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
1971
- * @public
1972
- */
1973
- ExpectedBucketOwner?: string | undefined;
1974
- }
1975
- /**
1976
- * @public
1977
- * @enum
1978
- */
1979
- export declare const MFADelete: {
1980
- readonly Disabled: "Disabled";
1981
- readonly Enabled: "Enabled";
1982
- };
1983
- /**
1984
- * @public
1985
- */
1986
- export type MFADelete = (typeof MFADelete)[keyof typeof MFADelete];
1987
- /**
1988
- * <p>Describes the versioning state of an Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html">PUT Bucket
1989
- * versioning</a> in the <i>Amazon S3 API Reference</i>.</p>
1990
- * @public
1991
- */
1992
- export interface VersioningConfiguration {
1993
- /**
1994
- * <p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only
1995
- * returned if the bucket has been configured with MFA delete. If the bucket has never been so configured,
1996
- * this element is not returned.</p>
1997
- * @public
1998
- */
1999
- MFADelete?: MFADelete | undefined;
2000
- /**
2001
- * <p>The versioning state of the bucket.</p>
2002
- * @public
2003
- */
2004
- Status?: BucketVersioningStatus | undefined;
2005
- }
2006
- /**
2007
- * @public
2008
- */
2009
- export interface PutBucketVersioningRequest {
2010
- /**
2011
- * <p>The bucket name.</p>
2012
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
2013
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
2014
- * @public
2015
- */
2016
- Bucket: string | undefined;
2017
- /**
2018
- * <p>>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
2019
- * message integrity check to verify that the request body was not corrupted in transit. For more
2020
- * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
2021
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
2022
- * @public
2023
- */
2024
- ContentMD5?: string | undefined;
2025
- /**
2026
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
2027
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
2028
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
2029
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
2030
- * the <i>Amazon S3 User Guide</i>.</p>
2031
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
2032
- * parameter.</p>
2033
- * @public
2034
- */
2035
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
2036
- /**
2037
- * <p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. The serial number is the number that uniquely identifies the MFA device. For physical MFA devices, this is the unique serial number that's provided with the device. For virtual MFA devices, the serial number is the device ARN. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html">Enabling versioning on buckets</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiFactorAuthenticationDelete.html">Configuring MFA delete</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
2038
- * @public
2039
- */
2040
- MFA?: string | undefined;
2041
- /**
2042
- * <p>Container for setting the versioning state.</p>
2043
- * @public
2044
- */
2045
- VersioningConfiguration: VersioningConfiguration | undefined;
2046
- /**
2047
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
2048
- * @public
2049
- */
2050
- ExpectedBucketOwner?: string | undefined;
2051
- }
2052
- /**
2053
- * <p>Specifies website configuration parameters for an Amazon S3 bucket.</p>
2054
- * @public
2055
- */
2056
- export interface WebsiteConfiguration {
2057
- /**
2058
- * <p>The name of the error document for the website.</p>
2059
- * @public
2060
- */
2061
- ErrorDocument?: ErrorDocument | undefined;
2062
- /**
2063
- * <p>The name of the index document for the website.</p>
2064
- * @public
2065
- */
2066
- IndexDocument?: IndexDocument | undefined;
2067
- /**
2068
- * <p>The redirect behavior for every request to this bucket's website endpoint.</p>
2069
- * <important>
2070
- * <p>If you specify this property, you can't specify any other property.</p>
2071
- * </important>
2072
- * @public
2073
- */
2074
- RedirectAllRequestsTo?: RedirectAllRequestsTo | undefined;
2075
- /**
2076
- * <p>Rules that define when a redirect is applied and the redirect behavior.</p>
2077
- * @public
2078
- */
2079
- RoutingRules?: RoutingRule[] | undefined;
2080
- }
2081
- /**
2082
- * @public
2083
- */
2084
- export interface PutBucketWebsiteRequest {
2085
- /**
2086
- * <p>The bucket name.</p>
2087
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
2088
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
2089
- * @public
2090
- */
2091
- Bucket: string | undefined;
2092
- /**
2093
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
2094
- * message integrity check to verify that the request body was not corrupted in transit. For more
2095
- * information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
2096
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
2097
- * @public
2098
- */
2099
- ContentMD5?: string | undefined;
2100
- /**
2101
- * <p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any
2102
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
2103
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
2104
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
2105
- * the <i>Amazon S3 User Guide</i>.</p>
2106
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
2107
- * parameter.</p>
2108
- * @public
2109
- */
2110
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
2111
- /**
2112
- * <p>Container for the request.</p>
2113
- * @public
2114
- */
2115
- WebsiteConfiguration: WebsiteConfiguration | undefined;
2116
- /**
2117
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
2118
- * @public
2119
- */
2120
- ExpectedBucketOwner?: string | undefined;
2121
- }
2122
- /**
2123
- * <p> The existing object was created with a different encryption type. Subsequent write requests must
2124
- * include the appropriate encryption parameters in the request or while creating the session. </p>
2125
- * @public
2126
- */
2127
- export declare class EncryptionTypeMismatch extends __BaseException {
2128
- readonly name: "EncryptionTypeMismatch";
2129
- readonly $fault: "client";
2130
- /**
2131
- * @internal
2132
- */
2133
- constructor(opts: __ExceptionOptionType<EncryptionTypeMismatch, __BaseException>);
2134
- }
2135
- /**
2136
- * <p>You may receive this error in multiple cases. Depending on the reason for the error, you may receive
2137
- * one of the messages below:</p>
2138
- * <ul>
2139
- * <li>
2140
- * <p>Cannot specify both a write offset value and user-defined object metadata for existing
2141
- * objects.</p>
2142
- * </li>
2143
- * <li>
2144
- * <p>Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type:
2145
- * crc32c.</p>
2146
- * </li>
2147
- * <li>
2148
- * <p>Request body cannot be empty when 'write offset' is specified.</p>
2149
- * </li>
2150
- * </ul>
2151
- * @public
2152
- */
2153
- export declare class InvalidRequest extends __BaseException {
2154
- readonly name: "InvalidRequest";
2155
- readonly $fault: "client";
2156
- /**
2157
- * @internal
2158
- */
2159
- constructor(opts: __ExceptionOptionType<InvalidRequest, __BaseException>);
2160
- }
2161
- /**
2162
- * <p> The write offset value that you specified does not match the current object size. </p>
2163
- * @public
2164
- */
2165
- export declare class InvalidWriteOffset extends __BaseException {
2166
- readonly name: "InvalidWriteOffset";
2167
- readonly $fault: "client";
2168
- /**
2169
- * @internal
2170
- */
2171
- constructor(opts: __ExceptionOptionType<InvalidWriteOffset, __BaseException>);
2172
- }
2173
- /**
2174
- * @public
2175
- */
2176
- export interface PutObjectOutput {
2177
- /**
2178
- * <p>If the expiration is configured for the object (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>) in the <i>Amazon S3 User Guide</i>, the response
2179
- * includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs
2180
- * that provide information about object expiration. The value of the <code>rule-id</code> is
2181
- * URL-encoded.</p>
2182
- * <note>
2183
- * <p>Object expiration information is not returned in directory buckets and this header returns the
2184
- * value "<code>NotImplemented</code>" in all responses for directory buckets.</p>
2185
- * </note>
2186
- * @public
2187
- */
2188
- Expiration?: string | undefined;
2189
- /**
2190
- * <p>Entity tag for the uploaded object.</p>
2191
- * <p>
2192
- * <b>General purpose buckets </b> - To ensure that data is not corrupted
2193
- * traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate
2194
- * the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5
2195
- * value.</p>
2196
- * <p>
2197
- * <b>Directory buckets </b> - The ETag for the object in a
2198
- * directory bucket isn't the MD5 digest of the object.</p>
2199
- * @public
2200
- */
2201
- ETag?: string | undefined;
2202
- /**
2203
- * <p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only present if the checksum was uploaded
2204
- * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
2205
- * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
2206
- * Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
2207
- * @public
2208
- */
2209
- ChecksumCRC32?: string | undefined;
2210
- /**
2211
- * <p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded
2212
- * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
2213
- * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
2214
- * Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
2215
- * @public
2216
- */
2217
- ChecksumCRC32C?: string | undefined;
2218
- /**
2219
- * <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. This header is present if
2220
- * the object was uploaded with the <code>CRC64NVME</code> checksum algorithm, or if it was uploaded
2221
- * without a checksum (and Amazon S3 added the default checksum, <code>CRC64NVME</code>, to the uploaded
2222
- * object). For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
2223
- * integrity in the Amazon S3 User Guide</a>.</p>
2224
- * @public
2225
- */
2226
- ChecksumCRC64NVME?: string | undefined;
2227
- /**
2228
- * <p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This checksum is only present if the checksum was uploaded
2229
- * with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
2230
- * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
2231
- * Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
2232
- * @public
2233
- */
2234
- ChecksumSHA1?: string | undefined;
2235
- /**
2236
- * <p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This checksum is only present if the checksum was uploaded
2237
- * with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
2238
- * with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
2239
- * Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
2240
- * @public
2241
- */
2242
- ChecksumSHA256?: string | undefined;
2243
- /**
2244
- * <p>This header specifies the checksum type of the object, which determines how part-level checksums are
2245
- * combined to create an object-level checksum for multipart objects. For <code>PutObject</code> uploads,
2246
- * the checksum type is always <code>FULL_OBJECT</code>. You can use this header as a data integrity check
2247
- * to verify that the checksum type that is received is the same checksum that was specified. For more
2248
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
2249
- * the <i>Amazon S3 User Guide</i>.</p>
2250
- * @public
2251
- */
2252
- ChecksumType?: ChecksumType | undefined;
2253
- /**
2254
- * <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p>
2255
- * <note>
2256
- * <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
2257
- * encryption option is <code>aws:fsx</code>.</p>
2258
- * </note>
2259
- * @public
2260
- */
2261
- ServerSideEncryption?: ServerSideEncryption | undefined;
2262
- /**
2263
- * <p>Version ID of the object.</p>
2264
- * <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the
2265
- * object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if
2266
- * Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
2267
- * For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to
2268
- * Versioning-Enabled Buckets</a> in the <i>Amazon S3 User Guide</i>. For information about
2269
- * returning the versioning state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
2270
- * <note>
2271
- * <p>This functionality is not supported for directory buckets.</p>
2272
- * </note>
2273
- * @public
2274
- */
2275
- VersionId?: string | undefined;
2276
- /**
2277
- * <p>If server-side encryption with a customer-provided encryption key was requested, the response will
2278
- * include this header to confirm the encryption algorithm that's used.</p>
2279
- * <note>
2280
- * <p>This functionality is not supported for directory buckets.</p>
2281
- * </note>
2282
- * @public
2283
- */
2284
- SSECustomerAlgorithm?: string | undefined;
2285
- /**
2286
- * <p>If server-side encryption with a customer-provided encryption key was requested, the response will
2287
- * include this header to provide the round-trip message integrity verification of the customer-provided
2288
- * encryption key.</p>
2289
- * <note>
2290
- * <p>This functionality is not supported for directory buckets.</p>
2291
- * </note>
2292
- * @public
2293
- */
2294
- SSECustomerKeyMD5?: string | undefined;
2295
- /**
2296
- * <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
2297
- * @public
2298
- */
2299
- SSEKMSKeyId?: string | undefined;
2300
- /**
2301
- * <p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
2302
- * this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.
2303
- * This value is stored as object metadata and automatically gets
2304
- * passed on to Amazon Web Services KMS for future <code>GetObject</code>
2305
- * operations on this object.</p>
2306
- * @public
2307
- */
2308
- SSEKMSEncryptionContext?: string | undefined;
2309
- /**
2310
- * <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with
2311
- * Key Management Service (KMS) keys (SSE-KMS).</p>
2312
- * @public
2313
- */
2314
- BucketKeyEnabled?: boolean | undefined;
2315
- /**
2316
- * <p> The size of the object in bytes. This value is only be present if you append to an object. </p>
2317
- * <note>
2318
- * <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in
2319
- * directory buckets.</p>
2320
- * </note>
2321
- * @public
2322
- */
2323
- Size?: number | undefined;
2324
- /**
2325
- * <p>If present, indicates that the requester was successfully charged for the request. For more
2326
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
2327
- * Storage Service user guide</i>.</p>
2328
- * <note>
2329
- * <p>This functionality is not supported for directory buckets.</p>
2330
- * </note>
2331
- * @public
2332
- */
2333
- RequestCharged?: RequestCharged | undefined;
2334
- }
2335
- /**
2336
- * @public
2337
- */
2338
- export interface PutObjectRequest {
2339
- /**
2340
- * <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a> in the
2341
- * <i>Amazon S3 User Guide</i>.</p>
2342
- * <p>When adding a new object, you can use headers to grant ACL-based permissions to individual
2343
- * Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on
2344
- * the object. By default, all objects are private. Only the owner has full access control. For more
2345
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
2346
- * List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST API</a> in the
2347
- * <i>Amazon S3 User Guide</i>.</p>
2348
- * <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object
2349
- * Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept
2350
- * PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such
2351
- * as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in
2352
- * the XML format. PUT requests that contain other ACLs (for example, custom grants to certain
2353
- * Amazon Web Services accounts) fail and return a <code>400</code> error with the error code
2354
- * <code>AccessControlListNotSupported</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of objects and
2355
- * disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
2356
- * <note>
2357
- * <ul>
2358
- * <li>
2359
- * <p>This functionality is not supported for directory buckets.</p>
2360
- * </li>
2361
- * <li>
2362
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2363
- * </li>
2364
- * </ul>
2365
- * </note>
2366
- * @public
2367
- */
2368
- ACL?: ObjectCannedACL | undefined;
2369
- /**
2370
- * <p>Object data.</p>
2371
- * @public
2372
- */
2373
- Body?: StreamingBlobTypes | undefined;
2374
- /**
2375
- * <p>The bucket name to which the PUT action was initiated. </p>
2376
- * <p>
2377
- * <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
2378
- * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code>
2379
- * <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
2380
- * <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
2381
- * restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
2382
- * rules</a> in the <i>Amazon S3 User Guide</i>.</p>
2383
- * <p>
2384
- * <b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
2385
- * <note>
2386
- * <p>Object Lambda access points are not supported by directory buckets.</p>
2387
- * </note>
2388
- * <p>
2389
- * <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the
2390
- * form <code>
2391
- * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
2392
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
2393
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
2394
- * @public
2395
- */
2396
- Bucket: string | undefined;
2397
- /**
2398
- * <p>Can be used to specify caching behavior along the request/reply chain. For more information, see
2399
- * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9</a>.</p>
2400
- * @public
2401
- */
2402
- CacheControl?: string | undefined;
2403
- /**
2404
- * <p>Specifies presentational information for the object. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc6266#section-4">https://www.rfc-editor.org/rfc/rfc6266#section-4</a>.</p>
2405
- * @public
2406
- */
2407
- ContentDisposition?: string | undefined;
2408
- /**
2409
- * <p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms
2410
- * must be applied to obtain the media-type referenced by the Content-Type header field. For more
2411
- * information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding">https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding</a>.</p>
2412
- * @public
2413
- */
2414
- ContentEncoding?: string | undefined;
2415
- /**
2416
- * <p>The language the content is in.</p>
2417
- * @public
2418
- */
2419
- ContentLanguage?: string | undefined;
2420
- /**
2421
- * <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
2422
- * automatically. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length</a>.</p>
2423
- * @public
2424
- */
2425
- ContentLength?: number | undefined;
2426
- /**
2427
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the message (without the headers) according to
2428
- * RFC 1864. This header can be used as a message integrity check to verify that the data is the same data
2429
- * that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an
2430
- * end-to-end integrity check. For more information about REST request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST
2431
- * Authentication</a>.</p>
2432
- * <note>
2433
- * <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for
2434
- * any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
2435
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects
2436
- * to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
2437
- * </note>
2438
- * <note>
2439
- * <p>This functionality is not supported for directory buckets.</p>
2440
- * </note>
2441
- * @public
2442
- */
2443
- ContentMD5?: string | undefined;
2444
- /**
2445
- * <p>A standard MIME type describing the format of the contents. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type</a>.</p>
2446
- * @public
2447
- */
2448
- ContentType?: string | undefined;
2449
- /**
2450
- * <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
2451
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i>
2452
- * </code> or
2453
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p>
2454
- * <p>For the <code>x-amz-checksum-<i>algorithm</i>
2455
- * </code> header, replace <code>
2456
- * <i>algorithm</i>
2457
- * </code> with the supported algorithm from the following list: </p>
2458
- * <ul>
2459
- * <li>
2460
- * <p>
2461
- * <code>CRC32</code>
2462
- * </p>
2463
- * </li>
2464
- * <li>
2465
- * <p>
2466
- * <code>CRC32C</code>
2467
- * </p>
2468
- * </li>
2469
- * <li>
2470
- * <p>
2471
- * <code>CRC64NVME</code>
2472
- * </p>
2473
- * </li>
2474
- * <li>
2475
- * <p>
2476
- * <code>SHA1</code>
2477
- * </p>
2478
- * </li>
2479
- * <li>
2480
- * <p>
2481
- * <code>SHA256</code>
2482
- * </p>
2483
- * </li>
2484
- * </ul>
2485
- * <p>For more
2486
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
2487
- * the <i>Amazon S3 User Guide</i>.</p>
2488
- * <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i>
2489
- * </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error.</p>
2490
- * <note>
2491
- * <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for
2492
- * any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
2493
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects
2494
- * to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
2495
- * </note>
2496
- * <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
2497
- * @public
2498
- */
2499
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
2500
- /**
2501
- * <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
2502
- * This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. For more information, see
2503
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
2504
- * <i>Amazon S3 User Guide</i>.</p>
2505
- * @public
2506
- */
2507
- ChecksumCRC32?: string | undefined;
2508
- /**
2509
- * <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
2510
- * This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. For more information, see
2511
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
2512
- * <i>Amazon S3 User Guide</i>.</p>
2513
- * @public
2514
- */
2515
- ChecksumCRC32C?: string | undefined;
2516
- /**
2517
- * <p>This header can be used as a data integrity check to verify that the data received is the same data
2518
- * that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code>
2519
- * checksum of the object. The <code>CRC64NVME</code> checksum is always a full object checksum. For more
2520
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3
2521
- * User Guide</a>.</p>
2522
- * @public
2523
- */
2524
- ChecksumCRC64NVME?: string | undefined;
2525
- /**
2526
- * <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
2527
- * This header specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the object. For more information, see
2528
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
2529
- * <i>Amazon S3 User Guide</i>.</p>
2530
- * @public
2531
- */
2532
- ChecksumSHA1?: string | undefined;
2533
- /**
2534
- * <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
2535
- * This header specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the object. For more information, see
2536
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
2537
- * <i>Amazon S3 User Guide</i>.</p>
2538
- * @public
2539
- */
2540
- ChecksumSHA256?: string | undefined;
2541
- /**
2542
- * <p>The date and time at which the object is no longer cacheable. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc7234#section-5.3">https://www.rfc-editor.org/rfc/rfc7234#section-5.3</a>.</p>
2543
- * @public
2544
- */
2545
- Expires?: Date | undefined;
2546
- /**
2547
- * <p>Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches
2548
- * the ETag of the object in S3. If the ETag values do not match, the operation returns a <code>412
2549
- * Precondition Failed</code> error.</p>
2550
- * <p>If a conflicting operation occurs during the upload S3 returns a <code>409
2551
- * ConditionalRequestConflict</code> response. On a 409 failure you should fetch the object's ETag and
2552
- * retry the upload.</p>
2553
- * <p>Expects the ETag value as a string.</p>
2554
- * <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the
2555
- * <i>Amazon S3 User Guide</i>.</p>
2556
- * @public
2557
- */
2558
- IfMatch?: string | undefined;
2559
- /**
2560
- * <p>Uploads the object only if the object key name does not already exist in the bucket specified.
2561
- * Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error.</p>
2562
- * <p>If a conflicting operation occurs during the upload S3 returns a <code>409
2563
- * ConditionalRequestConflict</code> response. On a 409 failure you should retry the upload.</p>
2564
- * <p>Expects the '*' (asterisk) character.</p>
2565
- * <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the
2566
- * <i>Amazon S3 User Guide</i>.</p>
2567
- * @public
2568
- */
2569
- IfNoneMatch?: string | undefined;
2570
- /**
2571
- * <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>
2572
- * <note>
2573
- * <ul>
2574
- * <li>
2575
- * <p>This functionality is not supported for directory buckets.</p>
2576
- * </li>
2577
- * <li>
2578
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2579
- * </li>
2580
- * </ul>
2581
- * </note>
2582
- * @public
2583
- */
2584
- GrantFullControl?: string | undefined;
2585
- /**
2586
- * <p>Allows grantee to read the object data and its metadata.</p>
2587
- * <note>
2588
- * <ul>
2589
- * <li>
2590
- * <p>This functionality is not supported for directory buckets.</p>
2591
- * </li>
2592
- * <li>
2593
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2594
- * </li>
2595
- * </ul>
2596
- * </note>
2597
- * @public
2598
- */
2599
- GrantRead?: string | undefined;
2600
- /**
2601
- * <p>Allows grantee to read the object ACL.</p>
2602
- * <note>
2603
- * <ul>
2604
- * <li>
2605
- * <p>This functionality is not supported for directory buckets.</p>
2606
- * </li>
2607
- * <li>
2608
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2609
- * </li>
2610
- * </ul>
2611
- * </note>
2612
- * @public
2613
- */
2614
- GrantReadACP?: string | undefined;
2615
- /**
2616
- * <p>Allows grantee to write the ACL for the applicable object.</p>
2617
- * <note>
2618
- * <ul>
2619
- * <li>
2620
- * <p>This functionality is not supported for directory buckets.</p>
2621
- * </li>
2622
- * <li>
2623
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2624
- * </li>
2625
- * </ul>
2626
- * </note>
2627
- * @public
2628
- */
2629
- GrantWriteACP?: string | undefined;
2630
- /**
2631
- * <p>Object key for which the PUT action was initiated.</p>
2632
- * @public
2633
- */
2634
- Key: string | undefined;
2635
- /**
2636
- * <p> Specifies the offset for appending data to existing objects in bytes. The offset must be equal to
2637
- * the size of the existing object being appended to. If no object exists, setting this header to 0 will
2638
- * create a new object. </p>
2639
- * <note>
2640
- * <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in
2641
- * directory buckets.</p>
2642
- * </note>
2643
- * @public
2644
- */
2645
- WriteOffsetBytes?: number | undefined;
2646
- /**
2647
- * <p>A map of metadata to store with the object in S3.</p>
2648
- * @public
2649
- */
2650
- Metadata?: Record<string, string> | undefined;
2651
- /**
2652
- * <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 or
2653
- * Amazon FSx.</p>
2654
- * <ul>
2655
- * <li>
2656
- * <p>
2657
- * <b>General purpose buckets </b> - You have four mutually exclusive
2658
- * options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage
2659
- * the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3),
2660
- * Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with
2661
- * server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3
2662
- * to encrypt data at rest by using server-side encryption with other key options. For more
2663
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a> in
2664
- * the <i>Amazon S3 User Guide</i>.</p>
2665
- * </li>
2666
- * <li>
2667
- * <p>
2668
- * <b>Directory buckets </b> -
2669
- * 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
2670
- * <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
2671
- * are automatically encrypted with the desired encryption settings. For more
2672
- * 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>
2673
- * <p>In the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>) using the REST API, the encryption request headers must match the encryption settings that are specified in the <code>CreateSession</code> request.
2674
- * You can't override the values of the encryption settings (<code>x-amz-server-side-encryption</code>, <code>x-amz-server-side-encryption-aws-kms-key-id</code>, <code>x-amz-server-side-encryption-context</code>, and <code>x-amz-server-side-encryption-bucket-key-enabled</code>) that are specified in the <code>CreateSession</code> request.
2675
- * You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and
2676
- * Amazon S3 will use the encryption settings values from the <code>CreateSession</code> request to protect new objects in the directory bucket.
2677
- * </p>
2678
- * <note>
2679
- * <p>When you use the CLI or the Amazon Web Services SDKs, for <code>CreateSession</code>, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the
2680
- * <code>CreateSession</code> request. It's not supported to override the encryption settings values in the <code>CreateSession</code> request.
2681
- * So in the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>),
2682
- * the encryption request headers must match the default encryption configuration of the directory bucket.
2683
- *
2684
- * </p>
2685
- * </note>
2686
- * </li>
2687
- * <li>
2688
- * <p>
2689
- * <b>S3 access points for Amazon FSx </b> - When accessing data stored in
2690
- * Amazon FSx file systems using S3 access points, the only valid server side encryption option is
2691
- * <code>aws:fsx</code>. All Amazon FSx file systems have encryption configured by default and are
2692
- * encrypted at rest. Data is automatically encrypted before being written to the file system, and
2693
- * automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.</p>
2694
- * </li>
2695
- * </ul>
2696
- * @public
2697
- */
2698
- ServerSideEncryption?: ServerSideEncryption | undefined;
2699
- /**
2700
- * <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD
2701
- * storage class provides high durability and high availability. Depending on performance needs, you can
2702
- * specify a different Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the
2703
- * <i>Amazon S3 User Guide</i>.</p>
2704
- * <note>
2705
- * <ul>
2706
- * <li>
2707
- * <p>Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in
2708
- * Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in
2709
- * Dedicated Local Zones.</p>
2710
- * </li>
2711
- * <li>
2712
- * <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p>
2713
- * </li>
2714
- * </ul>
2715
- * </note>
2716
- * @public
2717
- */
2718
- StorageClass?: StorageClass | undefined;
2719
- /**
2720
- * <p>If the bucket is configured as a website, redirects requests for this object to another object in
2721
- * the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For
2722
- * information about object metadata, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the <i>Amazon S3
2723
- * User Guide</i>.</p>
2724
- * <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in
2725
- * the same bucket:</p>
2726
- * <p>
2727
- * <code>x-amz-website-redirect-location: /anotherPage.html</code>
2728
- * </p>
2729
- * <p>In the following example, the request header sets the object redirect to another website:</p>
2730
- * <p>
2731
- * <code>x-amz-website-redirect-location: http://www.example.com/</code>
2732
- * </p>
2733
- * <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to Configure Website Page
2734
- * Redirects</a> in the <i>Amazon S3 User Guide</i>. </p>
2735
- * <note>
2736
- * <p>This functionality is not supported for directory buckets.</p>
2737
- * </note>
2738
- * @public
2739
- */
2740
- WebsiteRedirectLocation?: string | undefined;
2741
- /**
2742
- * <p>Specifies the algorithm to use when encrypting the object (for example, <code>AES256</code>).</p>
2743
- * <note>
2744
- * <p>This functionality is not supported for directory buckets.</p>
2745
- * </note>
2746
- * @public
2747
- */
2748
- SSECustomerAlgorithm?: string | undefined;
2749
- /**
2750
- * <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is
2751
- * used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must
2752
- * be appropriate for use with the algorithm specified in the
2753
- * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>
2754
- * <note>
2755
- * <p>This functionality is not supported for directory buckets.</p>
2756
- * </note>
2757
- * @public
2758
- */
2759
- SSECustomerKey?: string | undefined;
2760
- /**
2761
- * <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header
2762
- * for a message integrity check to ensure that the encryption key was transmitted without error.</p>
2763
- * <note>
2764
- * <p>This functionality is not supported for directory buckets.</p>
2765
- * </note>
2766
- * @public
2767
- */
2768
- SSECustomerKeyMD5?: string | undefined;
2769
- /**
2770
- * <p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same
2771
- * account that's issuing the command, you must use the full Key ARN not the Key ID.</p>
2772
- * <p>
2773
- * <b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS
2774
- * key to use. If you specify
2775
- * <code>x-amz-server-side-encryption:aws:kms</code> or
2776
- * <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key
2777
- * (<code>aws/s3</code>) to protect the data.</p>
2778
- * <p>
2779
- * <b>Directory buckets</b> - To encrypt data using SSE-KMS, it's recommended to specify the
2780
- * <code>x-amz-server-side-encryption</code> header to <code>aws:kms</code>. Then, the <code>x-amz-server-side-encryption-aws-kms-key-id</code> header implicitly uses
2781
- * the bucket's default KMS customer managed key ID. If you want to explicitly set the <code>
2782
- * x-amz-server-side-encryption-aws-kms-key-id</code> header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> per directory bucket's lifetime.
2783
- * The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported.
2784
- *
2785
- * Incorrect key specification results in an HTTP <code>400 Bad Request</code> error. </p>
2786
- * @public
2787
- */
2788
- SSEKMSKeyId?: string | undefined;
2789
- /**
2790
- * <p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of
2791
- * this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.
2792
- * This value is stored as object metadata and automatically gets passed on
2793
- * to Amazon Web Services KMS for future <code>GetObject</code> operations on
2794
- * this object.</p>
2795
- * <p>
2796
- * <b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p>
2797
- * <p>
2798
- * <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>
2799
- * @public
2800
- */
2801
- SSEKMSEncryptionContext?: string | undefined;
2802
- /**
2803
- * <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
2804
- * server-side encryption using Key Management Service (KMS) keys (SSE-KMS).</p>
2805
- * <p>
2806
- * <b>General purpose buckets</b> - Setting this header to
2807
- * <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with
2808
- * SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3
2809
- * Bucket Key.</p>
2810
- * <p>
2811
- * <b>Directory buckets</b> - S3 Bucket Keys are always enabled for <code>GET</code> and <code>PUT</code> operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets
2812
- * to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops">the Copy operation in Batch Operations</a>, or
2813
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job">the import jobs</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p>
2814
- * @public
2815
- */
2816
- BucketKeyEnabled?: boolean | undefined;
2817
- /**
2818
- * <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
2819
- * specify this parameter in their requests. If either the source or destination S3 bucket has Requester
2820
- * Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
2821
- * downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
2822
- * Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
2823
- * <note>
2824
- * <p>This functionality is not supported for directory buckets.</p>
2825
- * </note>
2826
- * @public
2827
- */
2828
- RequestPayer?: RequestPayer | undefined;
2829
- /**
2830
- * <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example,
2831
- * "Key1=Value1")</p>
2832
- * <note>
2833
- * <p>This functionality is not supported for directory buckets.</p>
2834
- * </note>
2835
- * @public
2836
- */
2837
- Tagging?: string | undefined;
2838
- /**
2839
- * <p>The Object Lock mode that you want to apply to this object.</p>
2840
- * <note>
2841
- * <p>This functionality is not supported for directory buckets.</p>
2842
- * </note>
2843
- * @public
2844
- */
2845
- ObjectLockMode?: ObjectLockMode | undefined;
2846
- /**
2847
- * <p>The date and time when you want this object's Object Lock to expire. Must be formatted as a
2848
- * timestamp parameter.</p>
2849
- * <note>
2850
- * <p>This functionality is not supported for directory buckets.</p>
2851
- * </note>
2852
- * @public
2853
- */
2854
- ObjectLockRetainUntilDate?: Date | undefined;
2855
- /**
2856
- * <p>Specifies whether a legal hold will be applied to this object. For more information about S3 Object
2857
- * Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in
2858
- * the <i>Amazon S3 User Guide</i>.</p>
2859
- * <note>
2860
- * <p>This functionality is not supported for directory buckets.</p>
2861
- * </note>
2862
- * @public
2863
- */
2864
- ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | undefined;
2865
- /**
2866
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
2867
- * @public
2868
- */
2869
- ExpectedBucketOwner?: string | undefined;
2870
- }
2871
- /**
2872
- * <p> You have attempted to add more parts than the maximum of 10000 that are allowed for this object.
2873
- * You can use the CopyObject operation to copy this object to another and then add more data to the newly
2874
- * copied object. </p>
2875
- * @public
2876
- */
2877
- export declare class TooManyParts extends __BaseException {
2878
- readonly name: "TooManyParts";
2879
- readonly $fault: "client";
2880
- /**
2881
- * @internal
2882
- */
2883
- constructor(opts: __ExceptionOptionType<TooManyParts, __BaseException>);
2884
- }
2885
- /**
2886
- * @public
2887
- */
2888
- export interface PutObjectAclOutput {
2889
- /**
2890
- * <p>If present, indicates that the requester was successfully charged for the request. For more
2891
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
2892
- * Storage Service user guide</i>.</p>
2893
- * <note>
2894
- * <p>This functionality is not supported for directory buckets.</p>
2895
- * </note>
2896
- * @public
2897
- */
2898
- RequestCharged?: RequestCharged | undefined;
2899
- }
2900
- /**
2901
- * @public
2902
- */
2903
- export interface PutObjectAclRequest {
2904
- /**
2905
- * <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p>
2906
- * @public
2907
- */
2908
- ACL?: ObjectCannedACL | undefined;
2909
- /**
2910
- * <p>Contains the elements that set the ACL permissions for an object per grantee.</p>
2911
- * @public
2912
- */
2913
- AccessControlPolicy?: AccessControlPolicy | undefined;
2914
- /**
2915
- * <p>The bucket name that contains the object to which you want to attach the ACL. </p>
2916
- * <p>
2917
- * <b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
2918
- * <p>
2919
- * <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the
2920
- * form <code>
2921
- * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
2922
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
2923
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
2924
- * @public
2925
- */
2926
- Bucket: string | undefined;
2927
- /**
2928
- * <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a
2929
- * message integrity check to verify that the request body was not corrupted in transit. For more
2930
- * information, go to <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a>
2931
- * </p>
2932
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
2933
- * @public
2934
- */
2935
- ContentMD5?: string | undefined;
2936
- /**
2937
- * <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
2938
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
2939
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
2940
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
2941
- * the <i>Amazon S3 User Guide</i>.</p>
2942
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
2943
- * parameter.</p>
2944
- * @public
2945
- */
2946
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
2947
- /**
2948
- * <p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>
2949
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2950
- * @public
2951
- */
2952
- GrantFullControl?: string | undefined;
2953
- /**
2954
- * <p>Allows grantee to list the objects in the bucket.</p>
2955
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2956
- * @public
2957
- */
2958
- GrantRead?: string | undefined;
2959
- /**
2960
- * <p>Allows grantee to read the bucket ACL.</p>
2961
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2962
- * @public
2963
- */
2964
- GrantReadACP?: string | undefined;
2965
- /**
2966
- * <p>Allows grantee to create new objects in the bucket.</p>
2967
- * <p>For the bucket and object owners of existing objects, also allows deletions and overwrites of those
2968
- * objects.</p>
2969
- * @public
2970
- */
2971
- GrantWrite?: string | undefined;
2972
- /**
2973
- * <p>Allows grantee to write the ACL for the applicable bucket.</p>
2974
- * <p>This functionality is not supported for Amazon S3 on Outposts.</p>
2975
- * @public
2976
- */
2977
- GrantWriteACP?: string | undefined;
2978
- /**
2979
- * <p>Key for which the PUT action was initiated.</p>
2980
- * @public
2981
- */
2982
- Key: string | undefined;
2983
- /**
2984
- * <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
2985
- * specify this parameter in their requests. If either the source or destination S3 bucket has Requester
2986
- * Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
2987
- * downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
2988
- * Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
2989
- * <note>
2990
- * <p>This functionality is not supported for directory buckets.</p>
2991
- * </note>
2992
- * @public
2993
- */
2994
- RequestPayer?: RequestPayer | undefined;
2995
- /**
2996
- * <p>Version ID used to reference a specific version of the object.</p>
2997
- * <note>
2998
- * <p>This functionality is not supported for directory buckets.</p>
2999
- * </note>
3000
- * @public
3001
- */
3002
- VersionId?: string | undefined;
3003
- /**
3004
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
3005
- * @public
3006
- */
3007
- ExpectedBucketOwner?: string | undefined;
3008
- }
3009
- /**
3010
- * @public
3011
- */
3012
- export interface PutObjectLegalHoldOutput {
3013
- /**
3014
- * <p>If present, indicates that the requester was successfully charged for the request. For more
3015
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
3016
- * Storage Service user guide</i>.</p>
3017
- * <note>
3018
- * <p>This functionality is not supported for directory buckets.</p>
3019
- * </note>
3020
- * @public
3021
- */
3022
- RequestCharged?: RequestCharged | undefined;
3023
- }
3024
- /**
3025
- * @public
3026
- */
3027
- export interface PutObjectLegalHoldRequest {
3028
- /**
3029
- * <p>The bucket name containing the object that you want to place a legal hold on. </p>
3030
- * <p>
3031
- * <b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
3032
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
3033
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
3034
- * @public
3035
- */
3036
- Bucket: string | undefined;
3037
- /**
3038
- * <p>The key name for the object that you want to place a legal hold on.</p>
3039
- * @public
3040
- */
3041
- Key: string | undefined;
3042
- /**
3043
- * <p>Container element for the legal hold configuration you want to apply to the specified object.</p>
3044
- * @public
3045
- */
3046
- LegalHold?: ObjectLockLegalHold | undefined;
3047
- /**
3048
- * <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
3049
- * specify this parameter in their requests. If either the source or destination S3 bucket has Requester
3050
- * Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
3051
- * downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
3052
- * Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
3053
- * <note>
3054
- * <p>This functionality is not supported for directory buckets.</p>
3055
- * </note>
3056
- * @public
3057
- */
3058
- RequestPayer?: RequestPayer | undefined;
3059
- /**
3060
- * <p>The version ID of the object that you want to place a legal hold on.</p>
3061
- * @public
3062
- */
3063
- VersionId?: string | undefined;
3064
- /**
3065
- * <p>The MD5 hash for the request body.</p>
3066
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
3067
- * @public
3068
- */
3069
- ContentMD5?: string | undefined;
3070
- /**
3071
- * <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
3072
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
3073
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
3074
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
3075
- * the <i>Amazon S3 User Guide</i>.</p>
3076
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
3077
- * parameter.</p>
3078
- * @public
3079
- */
3080
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
3081
- /**
3082
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
3083
- * @public
3084
- */
3085
- ExpectedBucketOwner?: string | undefined;
3086
- }
3087
- /**
3088
- * @public
3089
- */
3090
- export interface PutObjectLockConfigurationOutput {
3091
- /**
3092
- * <p>If present, indicates that the requester was successfully charged for the request. For more
3093
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
3094
- * Storage Service user guide</i>.</p>
3095
- * <note>
3096
- * <p>This functionality is not supported for directory buckets.</p>
3097
- * </note>
3098
- * @public
3099
- */
3100
- RequestCharged?: RequestCharged | undefined;
3101
- }
3102
- /**
3103
- * @public
3104
- */
3105
- export interface PutObjectLockConfigurationRequest {
3106
- /**
3107
- * <p>The bucket whose Object Lock configuration you want to create or replace.</p>
3108
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
3109
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
3110
- * @public
3111
- */
3112
- Bucket: string | undefined;
3113
- /**
3114
- * <p>The Object Lock configuration that you want to apply to the specified bucket.</p>
3115
- * @public
3116
- */
3117
- ObjectLockConfiguration?: ObjectLockConfiguration | undefined;
3118
- /**
3119
- * <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
3120
- * specify this parameter in their requests. If either the source or destination S3 bucket has Requester
3121
- * Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
3122
- * downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
3123
- * Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
3124
- * <note>
3125
- * <p>This functionality is not supported for directory buckets.</p>
3126
- * </note>
3127
- * @public
3128
- */
3129
- RequestPayer?: RequestPayer | undefined;
3130
- /**
3131
- * <p>A token to allow Object Lock to be enabled for an existing bucket.</p>
3132
- * @public
3133
- */
3134
- Token?: string | undefined;
3135
- /**
3136
- * <p>The MD5 hash for the request body.</p>
3137
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
3138
- * @public
3139
- */
3140
- ContentMD5?: string | undefined;
3141
- /**
3142
- * <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
3143
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
3144
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
3145
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
3146
- * the <i>Amazon S3 User Guide</i>.</p>
3147
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
3148
- * parameter.</p>
3149
- * @public
3150
- */
3151
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
3152
- /**
3153
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
3154
- * @public
3155
- */
3156
- ExpectedBucketOwner?: string | undefined;
3157
- }
3158
- /**
3159
- * @public
3160
- */
3161
- export interface PutObjectRetentionOutput {
3162
- /**
3163
- * <p>If present, indicates that the requester was successfully charged for the request. For more
3164
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
3165
- * Storage Service user guide</i>.</p>
3166
- * <note>
3167
- * <p>This functionality is not supported for directory buckets.</p>
3168
- * </note>
3169
- * @public
3170
- */
3171
- RequestCharged?: RequestCharged | undefined;
3172
- }
3173
- /**
3174
- * @public
3175
- */
3176
- export interface PutObjectRetentionRequest {
3177
- /**
3178
- * <p>The bucket name that contains the object you want to apply this Object Retention configuration to. </p>
3179
- * <p>
3180
- * <b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
3181
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
3182
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
3183
- * @public
3184
- */
3185
- Bucket: string | undefined;
3186
- /**
3187
- * <p>The key name for the object that you want to apply this Object Retention configuration to.</p>
3188
- * @public
3189
- */
3190
- Key: string | undefined;
3191
- /**
3192
- * <p>The container element for the Object Retention configuration.</p>
3193
- * @public
3194
- */
3195
- Retention?: ObjectLockRetention | undefined;
3196
- /**
3197
- * <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
3198
- * specify this parameter in their requests. If either the source or destination S3 bucket has Requester
3199
- * Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
3200
- * downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
3201
- * Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
3202
- * <note>
3203
- * <p>This functionality is not supported for directory buckets.</p>
3204
- * </note>
3205
- * @public
3206
- */
3207
- RequestPayer?: RequestPayer | undefined;
3208
- /**
3209
- * <p>The version ID for the object that you want to apply this Object Retention configuration to.</p>
3210
- * @public
3211
- */
3212
- VersionId?: string | undefined;
3213
- /**
3214
- * <p>Indicates whether this action should bypass Governance-mode restrictions.</p>
3215
- * @public
3216
- */
3217
- BypassGovernanceRetention?: boolean | undefined;
3218
- /**
3219
- * <p>The MD5 hash for the request body.</p>
3220
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
3221
- * @public
3222
- */
3223
- ContentMD5?: string | undefined;
3224
- /**
3225
- * <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
3226
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
3227
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
3228
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
3229
- * the <i>Amazon S3 User Guide</i>.</p>
3230
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
3231
- * parameter.</p>
3232
- * @public
3233
- */
3234
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
3235
- /**
3236
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
3237
- * @public
3238
- */
3239
- ExpectedBucketOwner?: string | undefined;
3240
- }
3241
- /**
3242
- * @public
3243
- */
3244
- export interface PutObjectTaggingOutput {
3245
- /**
3246
- * <p>The versionId of the object the tag-set was added to.</p>
3247
- * @public
3248
- */
3249
- VersionId?: string | undefined;
3250
- }
3251
- /**
3252
- * @public
3253
- */
3254
- export interface PutObjectTaggingRequest {
3255
- /**
3256
- * <p>The bucket name containing the object. </p>
3257
- * <p>
3258
- * <b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
3259
- * <p>
3260
- * <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the
3261
- * form <code>
3262
- * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
3263
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
3264
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
3265
- * @public
3266
- */
3267
- Bucket: string | undefined;
3268
- /**
3269
- * <p>Name of the object key.</p>
3270
- * @public
3271
- */
3272
- Key: string | undefined;
3273
- /**
3274
- * <p>The versionId of the object that the tag-set will be added to.</p>
3275
- * @public
3276
- */
3277
- VersionId?: string | undefined;
3278
- /**
3279
- * <p>The MD5 hash for the request body.</p>
3280
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
3281
- * @public
3282
- */
3283
- ContentMD5?: string | undefined;
3284
- /**
3285
- * <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
3286
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
3287
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
3288
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
3289
- * the <i>Amazon S3 User Guide</i>.</p>
3290
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
3291
- * parameter.</p>
3292
- * @public
3293
- */
3294
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
3295
- /**
3296
- * <p>Container for the <code>TagSet</code> and <code>Tag</code> elements</p>
3297
- * @public
3298
- */
3299
- Tagging: Tagging | undefined;
3300
- /**
3301
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
3302
- * @public
3303
- */
3304
- ExpectedBucketOwner?: string | undefined;
3305
- /**
3306
- * <p>Confirms that the requester knows that she or he will be charged for the tagging object
3307
- * request. Bucket owners need not specify this parameter in their requests.</p>
3308
- * @public
3309
- */
3310
- RequestPayer?: RequestPayer | undefined;
3311
- }
3312
- /**
3313
- * @public
3314
- */
3315
- export interface PutPublicAccessBlockRequest {
3316
- /**
3317
- * <p>The name of the Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration you want to
3318
- * set.</p>
3319
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
3320
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
3321
- * @public
3322
- */
3323
- Bucket: string | undefined;
3324
- /**
3325
- * <p>The MD5 hash of the <code>PutPublicAccessBlock</code> request body. </p>
3326
- * <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
3327
- * @public
3328
- */
3329
- ContentMD5?: string | undefined;
3330
- /**
3331
- * <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
3332
- * additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
3333
- * <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
3334
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
3335
- * the <i>Amazon S3 User Guide</i>.</p>
3336
- * <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
3337
- * parameter.</p>
3338
- * @public
3339
- */
3340
- ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
3341
- /**
3342
- * <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3 bucket. You can
3343
- * enable the configuration options in any combination. For more information about when Amazon S3 considers a
3344
- * bucket or object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>.</p>
3345
- * @public
3346
- */
3347
- PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined;
3348
- /**
3349
- * <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
3350
- * @public
3351
- */
3352
- ExpectedBucketOwner?: string | undefined;
3353
- }
3354
- /**
3355
- * <p>Parameters on this idempotent request are inconsistent with parameters used in previous request(s). </p>
3356
- * <p>For a list of error codes and more information on Amazon S3 errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">Error codes</a>.</p>
3357
- * <note>
3358
- * <p>Idempotency ensures that an API request completes no more than one time. With an idempotent
3359
- * request, if the original request completes successfully, any subsequent retries complete successfully
3360
- * without performing any further actions.</p>
3361
- * </note>
3362
- * @public
3363
- */
3364
- export declare class IdempotencyParameterMismatch extends __BaseException {
3365
- readonly name: "IdempotencyParameterMismatch";
3366
- readonly $fault: "client";
3367
- /**
3368
- * @internal
3369
- */
3370
- constructor(opts: __ExceptionOptionType<IdempotencyParameterMismatch, __BaseException>);
3371
- }
3372
- /**
3373
- * @public
3374
- */
3375
- export interface RenameObjectOutput {
3376
- }
3377
- /**
3378
- * @public
3379
- */
3380
- export interface RenameObjectRequest {
3381
- /**
3382
- * <p>The bucket name of the directory bucket containing the object.</p>
3383
- * <p> You must use virtual-hosted-style requests in the format
3384
- * <code>Bucket-name.s3express-zone-id.region-code.amazonaws.com</code>. Path-style requests are not
3385
- * supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
3386
- * follow the format <code>bucket-base-name--zone-id--x-s3 </code> (for example,
3387
- * <code>amzn-s3-demo-bucket--usw2-az1--x-s3</code>). For information about bucket naming restrictions, see
3388
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p>
3389
- * <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
3390
- * For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
3391
- * @public
3392
- */
3393
- Bucket: string | undefined;
3394
- /**
3395
- * <p>Key name of the object to rename.</p>
3396
- * @public
3397
- */
3398
- Key: string | undefined;
3399
- /**
3400
- * <p>Specifies the source for the rename operation. The value must be URL encoded.</p>
3401
- * @public
3402
- */
3403
- RenameSource: string | undefined;
3404
- /**
3405
- * <p>Renames the object only if the ETag (entity tag) value provided during the operation matches the
3406
- * ETag of the object in S3. The <code>If-Match</code> header field makes the request method conditional on
3407
- * ETags. If the ETag values do not match, the operation returns a <code>412 Precondition Failed</code>
3408
- * error.</p>
3409
- * <p>Expects the ETag value as a string.</p>
3410
- * @public
3411
- */
3412
- DestinationIfMatch?: string | undefined;
3413
- /**
3414
- * <p> Renames the object only if the destination does not already exist in the specified directory
3415
- * bucket. If the object does exist when you send a request with <code>If-None-Match:*</code>, the S3 API
3416
- * will return a <code>412 Precondition Failed</code> error, preventing an overwrite. The
3417
- * <code>If-None-Match</code> header prevents overwrites of existing data by validating that there's not
3418
- * an object with the same key name already in your directory bucket.</p>
3419
- * <p> Expects the <code>*</code> character (asterisk).</p>
3420
- * @public
3421
- */
3422
- DestinationIfNoneMatch?: string | undefined;
3423
- /**
3424
- * <p>Renames the object if the destination exists and if it has been modified since the specified
3425
- * time.</p>
3426
- * @public
3427
- */
3428
- DestinationIfModifiedSince?: Date | undefined;
3429
- /**
3430
- * <p>Renames the object if it hasn't been modified since the specified time.</p>
3431
- * @public
3432
- */
3433
- DestinationIfUnmodifiedSince?: Date | undefined;
3434
- /**
3435
- * <p>Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
3436
- * </p>
3437
- * @public
3438
- */
3439
- SourceIfMatch?: string | undefined;
3440
- /**
3441
- * <p>Renames the object if the source exists and if its entity tag (ETag) is different than the specified
3442
- * ETag. If an asterisk (<code>*</code>) character is provided, the operation will fail and return a
3443
- * <code>412 Precondition Failed</code> error. </p>
3444
- * @public
3445
- */
3446
- SourceIfNoneMatch?: string | undefined;
3447
- /**
3448
- * <p>Renames the object if the source exists and if it has been modified since the specified time.</p>
3449
- * @public
3450
- */
3451
- SourceIfModifiedSince?: Date | undefined;
3452
- /**
3453
- * <p>Renames the object if the source exists and hasn't been modified since the specified time.</p>
3454
- * @public
3455
- */
3456
- SourceIfUnmodifiedSince?: Date | undefined;
3457
- /**
3458
- * <p> A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.</p>
3459
- * <note>
3460
- * <p>
3461
- * <code>RenameObject</code> supports idempotency using a client token. To make an idempotent API request
3462
- * using <code>RenameObject</code>, specify a client token in the request. You should not reuse the same
3463
- * client token for other API requests. If you retry a request that completed successfully using the same
3464
- * client token and the same parameters, the retry succeeds without performing any further actions. If
3465
- * you retry a successful request using the same client token, but one or more of the parameters are
3466
- * different, the retry fails and an <code>IdempotentParameterMismatch</code> error is returned. </p>
3467
- * </note>
3468
- * @public
3469
- */
3470
- ClientToken?: string | undefined;
3471
- }
3472
- /**
3473
- * <p>This action is not allowed against this storage tier.</p>
3474
- * @public
3475
- */
3476
- export declare class ObjectAlreadyInActiveTierError extends __BaseException {
3477
- readonly name: "ObjectAlreadyInActiveTierError";
3478
- readonly $fault: "client";
3479
- /**
3480
- * @internal
3481
- */
3482
- constructor(opts: __ExceptionOptionType<ObjectAlreadyInActiveTierError, __BaseException>);
3483
- }
3484
- /**
3485
- * @public
3486
- */
3487
- export interface RestoreObjectOutput {
3488
- /**
3489
- * <p>If present, indicates that the requester was successfully charged for the request. For more
3490
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple
3491
- * Storage Service user guide</i>.</p>
3492
- * <note>
3493
- * <p>This functionality is not supported for directory buckets.</p>
3494
- * </note>
3495
- * @public
3496
- */
3497
- RequestCharged?: RequestCharged | undefined;
3498
- /**
3499
- * <p>Indicates the path in the provided S3 output location where Select results will be restored
3500
- * to.</p>
3501
- * @public
3502
- */
3503
- RestoreOutputPath?: string | undefined;
3504
- }
3505
- /**
3506
- * @public
3507
- * @enum
3508
- */
3509
- export declare const Tier: {
3510
- readonly Bulk: "Bulk";
3511
- readonly Expedited: "Expedited";
3512
- readonly Standard: "Standard";
3513
- };
3514
- /**
3515
- * @public
3516
- */
3517
- export type Tier = (typeof Tier)[keyof typeof Tier];
3518
- /**
3519
- * <p>Container for S3 Glacier job parameters.</p>
3520
- * @public
3521
- */
3522
- export interface GlacierJobParameters {
3523
- /**
3524
- * <p>Retrieval tier at which the restore will be processed.</p>
3525
- * @public
3526
- */
3527
- Tier: Tier | undefined;
3528
- }
3529
- /**
3530
- * <p>Contains the type of server-side encryption used.</p>
3531
- * @public
3532
- */
3533
- export interface Encryption {
3534
- /**
3535
- * <p>The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256,
3536
- * <code>aws:kms</code>).</p>
3537
- * @public
3538
- */
3539
- EncryptionType: ServerSideEncryption | undefined;
3540
- /**
3541
- * <p>If the encryption type is <code>aws:kms</code>, this optional value specifies the ID of the
3542
- * symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric
3543
- * encryption KMS keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric keys in KMS</a> in the
3544
- * <i>Amazon Web Services Key Management Service Developer Guide</i>.</p>
3545
- * @public
3546
- */
3547
- KMSKeyId?: string | undefined;
3548
- /**
3549
- * <p>If the encryption type is <code>aws:kms</code>, this optional value can be used to specify the
3550
- * encryption context for the restore results.</p>
3551
- * @public
3552
- */
3553
- KMSContext?: string | undefined;
3554
- }
3555
- /**
3556
- * <p>A metadata key-value pair to store with an object.</p>
3557
- * @public
3558
- */
3559
- export interface MetadataEntry {
3560
- /**
3561
- * <p>Name of the object.</p>
3562
- * @public
3563
- */
3564
- Name?: string | undefined;
3565
- /**
3566
- * <p>Value of the object.</p>
3567
- * @public
3568
- */
3569
- Value?: string | undefined;
3570
- }
3571
- /**
3572
- * <p>Describes an Amazon S3 location that will receive the results of the restore request.</p>
3573
- * @public
3574
- */
3575
- export interface S3Location {
3576
- /**
3577
- * <p>The name of the bucket where the restore results will be placed.</p>
3578
- * @public
3579
- */
3580
- BucketName: string | undefined;
3581
- /**
3582
- * <p>The prefix that is prepended to the restore results for this request.</p>
3583
- * @public
3584
- */
3585
- Prefix: string | undefined;
3586
- /**
3587
- * <p>Contains the type of server-side encryption used.</p>
3588
- * @public
3589
- */
3590
- Encryption?: Encryption | undefined;
3591
- /**
3592
- * <p>The canned ACL to apply to the restore results.</p>
3593
- * @public
3594
- */
3595
- CannedACL?: ObjectCannedACL | undefined;
3596
- /**
3597
- * <p>A list of grants that control access to the staged results.</p>
3598
- * @public
3599
- */
3600
- AccessControlList?: Grant[] | undefined;
3601
- /**
3602
- * <p>The tag-set that is applied to the restore results.</p>
3603
- * @public
3604
- */
3605
- Tagging?: Tagging | undefined;
3606
- /**
3607
- * <p>A list of metadata to store with the restore results in S3.</p>
3608
- * @public
3609
- */
3610
- UserMetadata?: MetadataEntry[] | undefined;
3611
- /**
3612
- * <p>The class of storage used to store the restore results.</p>
3613
- * @public
3614
- */
3615
- StorageClass?: StorageClass | undefined;
3616
- }
3617
- /**
3618
- * <p>Describes the location where the restore job's output is stored.</p>
3619
- * @public
3620
- */
3621
- export interface OutputLocation {
3622
- /**
3623
- * <p>Describes an S3 location that will receive the results of the restore request.</p>
3624
- * @public
3625
- */
3626
- S3?: S3Location | undefined;
3627
- }
3628
- /**
3629
- * @public
3630
- * @enum
3631
- */
3632
- export declare const ExpressionType: {
3633
- readonly SQL: "SQL";
3634
- };
3635
- /**
3636
- * @public
3637
- */
3638
- export type ExpressionType = (typeof ExpressionType)[keyof typeof ExpressionType];
3639
- /**
3640
- * @public
3641
- * @enum
3642
- */
3643
- export declare const CompressionType: {
3644
- readonly BZIP2: "BZIP2";
3645
- readonly GZIP: "GZIP";
3646
- readonly NONE: "NONE";
3647
- };
3648
- /**
3649
- * @public
3650
- */
3651
- export type CompressionType = (typeof CompressionType)[keyof typeof CompressionType];
3652
- /**
3653
- * @public
3654
- * @enum
3655
- */
3656
- export declare const FileHeaderInfo: {
3657
- readonly IGNORE: "IGNORE";
3658
- readonly NONE: "NONE";
3659
- readonly USE: "USE";
3660
- };
3661
- /**
3662
- * @public
3663
- */
3664
- export type FileHeaderInfo = (typeof FileHeaderInfo)[keyof typeof FileHeaderInfo];
3665
- /**
3666
- * <p>Describes how an uncompressed comma-separated values (CSV)-formatted input object is
3667
- * formatted.</p>
3668
- * @public
3669
- */
3670
- export interface CSVInput {
3671
- /**
3672
- * <p>Describes the first line of input. Valid values are:</p>
3673
- * <ul>
3674
- * <li>
3675
- * <p>
3676
- * <code>NONE</code>: First line is not a header.</p>
3677
- * </li>
3678
- * <li>
3679
- * <p>
3680
- * <code>IGNORE</code>: First line is a header, but you can't use the header values to indicate the
3681
- * column in an expression. You can use column position (such as _1, _2, …) to indicate the column
3682
- * (<code>SELECT s._1 FROM OBJECT s</code>).</p>
3683
- * </li>
3684
- * <li>
3685
- * <p>
3686
- * <code>Use</code>: First line is a header, and you can use the header value to identify a column
3687
- * in an expression (<code>SELECT "name" FROM OBJECT</code>). </p>
3688
- * </li>
3689
- * </ul>
3690
- * @public
3691
- */
3692
- FileHeaderInfo?: FileHeaderInfo | undefined;
3693
- /**
3694
- * <p>A single character used to indicate that a row should be ignored when the character is present at
3695
- * the start of that row. You can specify any character to indicate a comment line. The default character
3696
- * is <code>#</code>.</p>
3697
- * <p>Default: <code>#</code>
3698
- * </p>
3699
- * @public
3700
- */
3701
- Comments?: string | undefined;
3702
- /**
3703
- * <p>A single character used for escaping the quotation mark character inside an already escaped value.
3704
- * For example, the value <code>""" a , b """</code> is parsed as <code>" a , b "</code>.</p>
3705
- * @public
3706
- */
3707
- QuoteEscapeCharacter?: string | undefined;
3708
- /**
3709
- * <p>A single character used to separate individual records in the input. Instead of the default value,
3710
- * you can specify an arbitrary delimiter.</p>
3711
- * @public
3712
- */
3713
- RecordDelimiter?: string | undefined;
3714
- /**
3715
- * <p>A single character used to separate individual fields in a record. You can specify an arbitrary
3716
- * delimiter.</p>
3717
- * @public
3718
- */
3719
- FieldDelimiter?: string | undefined;
3720
- /**
3721
- * <p>A single character used for escaping when the field delimiter is part of the value. For example, if
3722
- * the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, as follows: <code>" a ,
3723
- * b "</code>.</p>
3724
- * <p>Type: String</p>
3725
- * <p>Default: <code>"</code>
3726
- * </p>
3727
- * <p>Ancestors: <code>CSV</code>
3728
- * </p>
3729
- * @public
3730
- */
3731
- QuoteCharacter?: string | undefined;
3732
- /**
3733
- * <p>Specifies that CSV field values may contain quoted record delimiters and such records should be
3734
- * allowed. Default value is FALSE. Setting this value to TRUE may lower performance.</p>
3735
- * @public
3736
- */
3737
- AllowQuotedRecordDelimiter?: boolean | undefined;
3738
- }
3739
- /**
3740
- * @public
3741
- * @enum
3742
- */
3743
- export declare const JSONType: {
3744
- readonly DOCUMENT: "DOCUMENT";
3745
- readonly LINES: "LINES";
3746
- };
3747
- /**
3748
- * @public
3749
- */
3750
- export type JSONType = (typeof JSONType)[keyof typeof JSONType];
3751
- /**
3752
- * <p>Specifies JSON as object's input serialization format.</p>
3753
- * @public
3754
- */
3755
- export interface JSONInput {
3756
- /**
3757
- * <p>The type of JSON. Valid values: Document, Lines.</p>
3758
- * @public
3759
- */
3760
- Type?: JSONType | undefined;
3761
- }
3762
- /**
3763
- * <p>Container for Parquet.</p>
3764
- * @public
3765
- */
3766
- export interface ParquetInput {
3767
- }
3768
- /**
3769
- * <p>Describes the serialization format of the object.</p>
3770
- * @public
3771
- */
3772
- export interface InputSerialization {
3773
- /**
3774
- * <p>Describes the serialization of a CSV-encoded object.</p>
3775
- * @public
3776
- */
3777
- CSV?: CSVInput | undefined;
3778
- /**
3779
- * <p>Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.</p>
3780
- * @public
3781
- */
3782
- CompressionType?: CompressionType | undefined;
3783
- /**
3784
- * <p>Specifies JSON as object's input serialization format.</p>
3785
- * @public
3786
- */
3787
- JSON?: JSONInput | undefined;
3788
- /**
3789
- * <p>Specifies Parquet as object's input serialization format.</p>
3790
- * @public
3791
- */
3792
- Parquet?: ParquetInput | undefined;
3793
- }
3794
- /**
3795
- * @public
3796
- * @enum
3797
- */
3798
- export declare const QuoteFields: {
3799
- readonly ALWAYS: "ALWAYS";
3800
- readonly ASNEEDED: "ASNEEDED";
3801
- };
3802
- /**
3803
- * @public
3804
- */
3805
- export type QuoteFields = (typeof QuoteFields)[keyof typeof QuoteFields];
3806
- /**
3807
- * <p>Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.</p>
3808
- * @public
3809
- */
3810
- export interface CSVOutput {
3811
- /**
3812
- * <p>Indicates whether to use quotation marks around output fields. </p>
3813
- * <ul>
3814
- * <li>
3815
- * <p>
3816
- * <code>ALWAYS</code>: Always use quotation marks for output fields.</p>
3817
- * </li>
3818
- * <li>
3819
- * <p>
3820
- * <code>ASNEEDED</code>: Use quotation marks for output fields when needed.</p>
3821
- * </li>
3822
- * </ul>
3823
- * @public
3824
- */
3825
- QuoteFields?: QuoteFields | undefined;
3826
- /**
3827
- * <p>The single character used for escaping the quote character inside an already escaped value.</p>
3828
- * @public
3829
- */
3830
- QuoteEscapeCharacter?: string | undefined;
3831
- /**
3832
- * <p>A single character used to separate individual records in the output. Instead of the default value,
3833
- * you can specify an arbitrary delimiter.</p>
3834
- * @public
3835
- */
3836
- RecordDelimiter?: string | undefined;
3837
- /**
3838
- * <p>The value used to separate individual fields in a record. You can specify an arbitrary
3839
- * delimiter.</p>
3840
- * @public
3841
- */
3842
- FieldDelimiter?: string | undefined;
3843
- /**
3844
- * <p>A single character used for escaping when the field delimiter is part of the value. For example, if
3845
- * the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, as follows: <code>" a ,
3846
- * b "</code>.</p>
3847
- * @public
3848
- */
3849
- QuoteCharacter?: string | undefined;
3850
- }
3851
- /**
3852
- * <p>Specifies JSON as request's output serialization format.</p>
3853
- * @public
3854
- */
3855
- export interface JSONOutput {
3856
- /**
3857
- * <p>The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a
3858
- * newline character ('\n').</p>
3859
- * @public
3860
- */
3861
- RecordDelimiter?: string | undefined;
3862
- }
3863
- /**
3864
- * <p>Describes how results of the Select job are serialized.</p>
3865
- * @public
3866
- */
3867
- export interface OutputSerialization {
3868
- /**
3869
- * <p>Describes the serialization of CSV-encoded Select results.</p>
3870
- * @public
3871
- */
3872
- CSV?: CSVOutput | undefined;
3873
- /**
3874
- * <p>Specifies JSON as request's output serialization format.</p>
3875
- * @public
3876
- */
3877
- JSON?: JSONOutput | undefined;
3878
- }
2
+ import { ChecksumAlgorithm, ExpressionType, InventoryConfigurationState, ObjectLockLegalHoldStatus, ObjectLockMode, ReplicationStatus, RequestCharged, RequestPayer, RestoreRequestType, ServerSideEncryption, StorageClass, Tier } from "./enums";
3
+ import { GlacierJobParameters, InputSerialization, MetadataTableEncryptionConfiguration, OutputLocation, OutputSerialization, RecordExpiration } from "./models_0";
3879
4
  /**
3880
5
  * <important>
3881
6
  * <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
@@ -3915,17 +40,6 @@ export interface SelectParameters {
3915
40
  */
3916
41
  OutputSerialization: OutputSerialization | undefined;
3917
42
  }
3918
- /**
3919
- * @public
3920
- * @enum
3921
- */
3922
- export declare const RestoreRequestType: {
3923
- readonly SELECT: "SELECT";
3924
- };
3925
- /**
3926
- * @public
3927
- */
3928
- export type RestoreRequestType = (typeof RestoreRequestType)[keyof typeof RestoreRequestType];
3929
43
  /**
3930
44
  * <p>Container for restore job parameters.</p>
3931
45
  * @public
@@ -4096,7 +210,7 @@ export interface RecordsEvent {
4096
210
  * <p>The byte array of partial, one or more result records. S3 Select doesn't guarantee that a record
4097
211
  * will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might
4098
212
  * split the same record across multiple record frames instead of aggregating the results in memory. Some
4099
- * S3 clients (for example, the SDKforJava) handle this behavior by creating a
213
+ * S3 clients (for example, the SDK for Java) handle this behavior by creating a
4100
214
  * <code>ByteStream</code> out of the response by default. Other clients might not handle this behavior
4101
215
  * by default. In those cases, you must aggregate the results on the client side and parse the
4102
216
  * response.</p>