@aws-sdk/client-s3 3.844.0 → 3.845.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.
- package/README.md +40 -0
- package/dist-cjs/index.js +594 -121
- package/dist-es/S3.js +10 -0
- package/dist-es/commands/CreateBucketMetadataConfigurationCommand.js +31 -0
- package/dist-es/commands/DeleteBucketMetadataConfigurationCommand.js +26 -0
- package/dist-es/commands/GetBucketMetadataConfigurationCommand.js +28 -0
- package/dist-es/commands/ListPartsCommand.js +1 -1
- package/dist-es/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.js +31 -0
- package/dist-es/commands/UpdateBucketMetadataJournalTableConfigurationCommand.js +31 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +16 -24
- package/dist-es/models/models_1.js +24 -0
- package/dist-es/protocols/Aws_restXml.js +325 -3
- package/dist-types/S3.d.ts +35 -0
- package/dist-types/S3Client.d.ts +7 -2
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +17 -22
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +46 -57
- package/dist-types/commands/CopyObjectCommand.d.ts +95 -106
- package/dist-types/commands/CreateBucketCommand.d.ts +70 -82
- package/dist-types/commands/CreateBucketMetadataConfigurationCommand.d.ts +182 -0
- package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +25 -12
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +88 -113
- package/dist-types/commands/CreateSessionCommand.d.ts +45 -50
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +7 -9
- package/dist-types/commands/DeleteBucketCommand.d.ts +10 -12
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -5
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +16 -18
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -6
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +23 -28
- package/dist-types/commands/DeleteBucketMetadataConfigurationCommand.d.ts +114 -0
- package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +26 -8
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +5 -6
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +20 -23
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +5 -7
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +2 -3
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +9 -10
- package/dist-types/commands/DeleteObjectCommand.d.ts +37 -23
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +7 -7
- package/dist-types/commands/DeleteObjectsCommand.d.ts +37 -44
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -6
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +14 -17
- package/dist-types/commands/GetBucketAclCommand.d.ts +9 -11
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +8 -11
- package/dist-types/commands/GetBucketCorsCommand.d.ts +4 -6
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -19
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +6 -8
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +28 -37
- package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -5
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketMetadataConfigurationCommand.d.ts +146 -0
- package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +25 -8
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +10 -11
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +9 -8
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +24 -29
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +5 -6
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +11 -12
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +3 -3
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +6 -7
- package/dist-types/commands/GetObjectAclCommand.d.ts +9 -11
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +55 -70
- package/dist-types/commands/GetObjectCommand.d.ts +66 -81
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +8 -10
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +4 -5
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +10 -12
- package/dist-types/commands/HeadBucketCommand.d.ts +33 -35
- package/dist-types/commands/HeadObjectCommand.d.ts +50 -62
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +14 -17
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +12 -15
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +15 -18
- package/dist-types/commands/ListBucketsCommand.d.ts +10 -9
- package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +9 -9
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +41 -49
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +7 -9
- package/dist-types/commands/ListObjectsCommand.d.ts +8 -7
- package/dist-types/commands/ListObjectsV2Command.d.ts +28 -31
- package/dist-types/commands/ListPartsCommand.d.ts +21 -24
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +14 -18
- package/dist-types/commands/PutBucketAclCommand.d.ts +51 -62
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +23 -25
- package/dist-types/commands/PutBucketCorsCommand.d.ts +23 -27
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +40 -48
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +11 -12
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +33 -37
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +51 -60
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +26 -33
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +12 -14
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +29 -35
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -6
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +24 -29
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -38
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -5
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +21 -27
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +20 -23
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +19 -18
- package/dist-types/commands/PutObjectAclCommand.d.ts +53 -61
- package/dist-types/commands/PutObjectCommand.d.ts +56 -66
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -3
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +10 -11
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +4 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +18 -24
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +10 -12
- package/dist-types/commands/RenameObjectCommand.d.ts +34 -40
- package/dist-types/commands/RestoreObjectCommand.d.ts +76 -85
- package/dist-types/commands/SelectObjectContentCommand.d.ts +50 -59
- package/dist-types/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +161 -0
- package/dist-types/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +113 -0
- package/dist-types/commands/UploadPartCommand.d.ts +64 -74
- package/dist-types/commands/UploadPartCopyCommand.d.ts +80 -96
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +29 -33
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +2688 -3603
- package/dist-types/models/models_1.d.ts +2120 -743
- package/dist-types/protocols/Aws_restXml.d.ts +45 -0
- package/dist-types/ts3.4/S3.d.ts +109 -0
- package/dist-types/ts3.4/S3Client.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateBucketMetadataConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteBucketMetadataConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetBucketMetadataConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListObjectsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPartsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAclCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +93 -206
- package/dist-types/ts3.4/models/models_1.d.ts +238 -0
- package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +60 -0
- package/package.json +15 -15
|
@@ -1,18 +1,1310 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { StreamingBlobTypes } from "@smithy/types";
|
|
3
|
-
import { AccessControlPolicy, BucketVersioningStatus, ChecksumAlgorithm, ChecksumType, CORSRule, ErrorDocument, Grant, IndexDocument, IntelligentTieringConfiguration, InventoryConfiguration, LifecycleRule, LoggingEnabled, MetricsConfiguration, NotificationConfiguration, ObjectCannedACL, ObjectLockConfiguration, ObjectLockLegalHold, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetention, OwnershipControls, Payer, PublicAccessBlockConfiguration, RedirectAllRequestsTo, ReplicationConfiguration, ReplicationStatus, RequestCharged, RequestPayer, RoutingRule, ServerSideEncryption, ServerSideEncryptionConfiguration, StorageClass, Tag, TransitionDefaultMinimumObjectSize } from "./models_0";
|
|
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
4
|
import { S3ServiceException as __BaseException } from "./S3ServiceException";
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
|
|
9
|
-
|
|
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>
|
|
10
1302
|
* @public
|
|
11
1303
|
*/
|
|
12
1304
|
export interface CORSConfiguration {
|
|
13
1305
|
/**
|
|
14
|
-
* <p>A set of origins and methods (cross-origin access that you want to allow). You can add
|
|
15
|
-
*
|
|
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>
|
|
16
1308
|
* @public
|
|
17
1309
|
*/
|
|
18
1310
|
CORSRules: CORSRule[] | undefined;
|
|
@@ -29,18 +1321,16 @@ export interface PutBucketCorsRequest {
|
|
|
29
1321
|
*/
|
|
30
1322
|
Bucket: string | undefined;
|
|
31
1323
|
/**
|
|
32
|
-
* <p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
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>
|
|
36
1327
|
* @public
|
|
37
1328
|
*/
|
|
38
1329
|
CORSConfiguration: CORSConfiguration | undefined;
|
|
39
1330
|
/**
|
|
40
|
-
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* 1864.</a>
|
|
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>
|
|
44
1334
|
* </p>
|
|
45
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>
|
|
46
1336
|
* @public
|
|
@@ -52,8 +1342,8 @@ export interface PutBucketCorsRequest {
|
|
|
52
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
|
|
53
1343
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
54
1344
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
55
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
56
|
-
*
|
|
1345
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
1346
|
+
* parameter.</p>
|
|
57
1347
|
* @public
|
|
58
1348
|
*/
|
|
59
1349
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -68,8 +1358,8 @@ export interface PutBucketCorsRequest {
|
|
|
68
1358
|
*/
|
|
69
1359
|
export interface PutBucketEncryptionRequest {
|
|
70
1360
|
/**
|
|
71
|
-
* <p>Specifies default encryption for a bucket using server-side encryption with different
|
|
72
|
-
*
|
|
1361
|
+
* <p>Specifies default encryption for a bucket using server-side encryption with different key
|
|
1362
|
+
* options.</p>
|
|
73
1363
|
* <p>
|
|
74
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>
|
|
75
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>
|
|
@@ -83,7 +1373,7 @@ export interface PutBucketEncryptionRequest {
|
|
|
83
1373
|
Bucket: string | undefined;
|
|
84
1374
|
/**
|
|
85
1375
|
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the server-side encryption
|
|
86
|
-
*
|
|
1376
|
+
* configuration.</p>
|
|
87
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>
|
|
88
1378
|
* <note>
|
|
89
1379
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -97,8 +1387,8 @@ export interface PutBucketEncryptionRequest {
|
|
|
97
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
|
|
98
1388
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
99
1389
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
100
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
101
|
-
*
|
|
1390
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
1391
|
+
* parameter.</p>
|
|
102
1392
|
* <note>
|
|
103
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>
|
|
104
1394
|
* </note>
|
|
@@ -180,37 +1470,35 @@ export interface PutBucketInventoryConfigurationRequest {
|
|
|
180
1470
|
export interface PutBucketLifecycleConfigurationOutput {
|
|
181
1471
|
/**
|
|
182
1472
|
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
183
|
-
*
|
|
1473
|
+
* configuration.</p>
|
|
184
1474
|
* <note>
|
|
185
|
-
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
186
|
-
*
|
|
1475
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for directory bucket
|
|
1476
|
+
* lifecycle configurations.</p>
|
|
187
1477
|
* </note>
|
|
188
1478
|
* <ul>
|
|
189
1479
|
* <li>
|
|
190
1480
|
* <p>
|
|
191
|
-
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
192
|
-
*
|
|
1481
|
+
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not transition to
|
|
1482
|
+
* any storage class by default. </p>
|
|
193
1483
|
* </li>
|
|
194
1484
|
* <li>
|
|
195
1485
|
* <p>
|
|
196
|
-
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
* </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>
|
|
200
1489
|
* </li>
|
|
201
1490
|
* </ul>
|
|
202
|
-
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
* transition behavior.</p>
|
|
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>
|
|
206
1494
|
* @public
|
|
207
1495
|
*/
|
|
208
1496
|
TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
|
|
209
1497
|
}
|
|
210
1498
|
/**
|
|
211
|
-
* <p>Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more
|
|
212
|
-
*
|
|
213
|
-
*
|
|
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>
|
|
214
1502
|
* @public
|
|
215
1503
|
*/
|
|
216
1504
|
export interface BucketLifecycleConfiguration {
|
|
@@ -237,8 +1525,8 @@ export interface PutBucketLifecycleConfigurationRequest {
|
|
|
237
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
|
|
238
1526
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
239
1527
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
240
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
241
|
-
*
|
|
1528
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
1529
|
+
* parameter.</p>
|
|
242
1530
|
* @public
|
|
243
1531
|
*/
|
|
244
1532
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -250,37 +1538,35 @@ export interface PutBucketLifecycleConfigurationRequest {
|
|
|
250
1538
|
/**
|
|
251
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>
|
|
252
1540
|
* <note>
|
|
253
|
-
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
254
|
-
*
|
|
1541
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for directory bucket
|
|
1542
|
+
* lifecycle configurations.</p>
|
|
255
1543
|
* </note>
|
|
256
1544
|
* @public
|
|
257
1545
|
*/
|
|
258
1546
|
ExpectedBucketOwner?: string | undefined;
|
|
259
1547
|
/**
|
|
260
1548
|
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
261
|
-
*
|
|
1549
|
+
* configuration.</p>
|
|
262
1550
|
* <note>
|
|
263
|
-
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
264
|
-
*
|
|
1551
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for directory bucket
|
|
1552
|
+
* lifecycle configurations.</p>
|
|
265
1553
|
* </note>
|
|
266
1554
|
* <ul>
|
|
267
1555
|
* <li>
|
|
268
1556
|
* <p>
|
|
269
|
-
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
270
|
-
*
|
|
1557
|
+
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not transition to
|
|
1558
|
+
* any storage class by default. </p>
|
|
271
1559
|
* </li>
|
|
272
1560
|
* <li>
|
|
273
1561
|
* <p>
|
|
274
|
-
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
* </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>
|
|
278
1565
|
* </li>
|
|
279
1566
|
* </ul>
|
|
280
|
-
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
* transition behavior.</p>
|
|
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>
|
|
284
1570
|
* @public
|
|
285
1571
|
*/
|
|
286
1572
|
TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
|
|
@@ -291,9 +1577,9 @@ export interface PutBucketLifecycleConfigurationRequest {
|
|
|
291
1577
|
*/
|
|
292
1578
|
export interface BucketLoggingStatus {
|
|
293
1579
|
/**
|
|
294
|
-
* <p>Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys
|
|
295
|
-
*
|
|
296
|
-
*
|
|
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>
|
|
297
1583
|
* @public
|
|
298
1584
|
*/
|
|
299
1585
|
LoggingEnabled?: LoggingEnabled | undefined;
|
|
@@ -326,8 +1612,8 @@ export interface PutBucketLoggingRequest {
|
|
|
326
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
|
|
327
1613
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
328
1614
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
329
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
330
|
-
*
|
|
1615
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
1616
|
+
* parameter.</p>
|
|
331
1617
|
* @public
|
|
332
1618
|
*/
|
|
333
1619
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -349,8 +1635,8 @@ export interface PutBucketMetricsConfigurationRequest {
|
|
|
349
1635
|
*/
|
|
350
1636
|
Bucket: string | undefined;
|
|
351
1637
|
/**
|
|
352
|
-
* <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and
|
|
353
|
-
*
|
|
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>
|
|
354
1640
|
* @public
|
|
355
1641
|
*/
|
|
356
1642
|
Id: string | undefined;
|
|
@@ -377,8 +1663,8 @@ export interface PutBucketNotificationConfigurationRequest {
|
|
|
377
1663
|
*/
|
|
378
1664
|
Bucket: string | undefined;
|
|
379
1665
|
/**
|
|
380
|
-
* <p>A container for specifying the notification configuration of the bucket. If this element
|
|
381
|
-
*
|
|
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>
|
|
382
1668
|
* @public
|
|
383
1669
|
*/
|
|
384
1670
|
NotificationConfiguration: NotificationConfiguration | undefined;
|
|
@@ -388,8 +1674,8 @@ export interface PutBucketNotificationConfigurationRequest {
|
|
|
388
1674
|
*/
|
|
389
1675
|
ExpectedBucketOwner?: string | undefined;
|
|
390
1676
|
/**
|
|
391
|
-
* <p>Skips validation of Amazon SQS, Amazon SNS, and Lambda
|
|
392
|
-
*
|
|
1677
|
+
* <p>Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations.
|
|
1678
|
+
* True or false value.</p>
|
|
393
1679
|
* @public
|
|
394
1680
|
*/
|
|
395
1681
|
SkipDestinationValidation?: boolean | undefined;
|
|
@@ -417,20 +1703,21 @@ export interface PutBucketOwnershipControlsRequest {
|
|
|
417
1703
|
*/
|
|
418
1704
|
ExpectedBucketOwner?: string | undefined;
|
|
419
1705
|
/**
|
|
420
|
-
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or
|
|
421
|
-
*
|
|
1706
|
+
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that
|
|
1707
|
+
* you want to apply to this Amazon S3 bucket.</p>
|
|
422
1708
|
* @public
|
|
423
1709
|
*/
|
|
424
1710
|
OwnershipControls: OwnershipControls | undefined;
|
|
425
1711
|
/**
|
|
426
|
-
* <p> Indicates the algorithm used to create the checksum for the object when you use the
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
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>
|
|
434
1721
|
* @public
|
|
435
1722
|
*/
|
|
436
1723
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -509,8 +1796,8 @@ export interface PutBucketPolicyRequest {
|
|
|
509
1796
|
*/
|
|
510
1797
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
511
1798
|
/**
|
|
512
|
-
* <p>Set this parameter to true to confirm that you want to remove your permissions to change
|
|
513
|
-
*
|
|
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>
|
|
514
1801
|
* <note>
|
|
515
1802
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
516
1803
|
* </note>
|
|
@@ -520,7 +1807,7 @@ export interface PutBucketPolicyRequest {
|
|
|
520
1807
|
/**
|
|
521
1808
|
* <p>The bucket policy as a JSON document.</p>
|
|
522
1809
|
* <p>For directory buckets, the only IAM action supported in the bucket policy is
|
|
523
|
-
*
|
|
1810
|
+
* <code>s3express:CreateSession</code>.</p>
|
|
524
1811
|
* @public
|
|
525
1812
|
*/
|
|
526
1813
|
Policy: string | undefined;
|
|
@@ -546,9 +1833,9 @@ export interface PutBucketReplicationRequest {
|
|
|
546
1833
|
*/
|
|
547
1834
|
Bucket: string | undefined;
|
|
548
1835
|
/**
|
|
549
|
-
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
|
|
550
|
-
*
|
|
551
|
-
*
|
|
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>
|
|
552
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>
|
|
553
1840
|
* @public
|
|
554
1841
|
*/
|
|
@@ -559,14 +1846,14 @@ export interface PutBucketReplicationRequest {
|
|
|
559
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
|
|
560
1847
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
561
1848
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
562
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
563
|
-
*
|
|
1849
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
1850
|
+
* parameter.</p>
|
|
564
1851
|
* @public
|
|
565
1852
|
*/
|
|
566
1853
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
567
1854
|
/**
|
|
568
|
-
* <p>A container for replication rules. You can add up to 1,000 rules. The maximum size of a
|
|
569
|
-
*
|
|
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>
|
|
570
1857
|
* @public
|
|
571
1858
|
*/
|
|
572
1859
|
ReplicationConfiguration: ReplicationConfiguration | undefined;
|
|
@@ -604,9 +1891,9 @@ export interface PutBucketRequestPaymentRequest {
|
|
|
604
1891
|
*/
|
|
605
1892
|
Bucket: string | undefined;
|
|
606
1893
|
/**
|
|
607
|
-
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
|
|
608
|
-
*
|
|
609
|
-
*
|
|
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>
|
|
610
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>
|
|
611
1898
|
* @public
|
|
612
1899
|
*/
|
|
@@ -617,8 +1904,8 @@ export interface PutBucketRequestPaymentRequest {
|
|
|
617
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
|
|
618
1905
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
619
1906
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
620
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
621
|
-
*
|
|
1907
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
1908
|
+
* parameter.</p>
|
|
622
1909
|
* @public
|
|
623
1910
|
*/
|
|
624
1911
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -656,9 +1943,9 @@ export interface PutBucketTaggingRequest {
|
|
|
656
1943
|
*/
|
|
657
1944
|
Bucket: string | undefined;
|
|
658
1945
|
/**
|
|
659
|
-
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
|
|
660
|
-
*
|
|
661
|
-
*
|
|
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>
|
|
662
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>
|
|
663
1950
|
* @public
|
|
664
1951
|
*/
|
|
@@ -669,8 +1956,8 @@ export interface PutBucketTaggingRequest {
|
|
|
669
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
|
|
670
1957
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
671
1958
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
672
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
673
|
-
*
|
|
1959
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
1960
|
+
* parameter.</p>
|
|
674
1961
|
* @public
|
|
675
1962
|
*/
|
|
676
1963
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -698,15 +1985,15 @@ export declare const MFADelete: {
|
|
|
698
1985
|
*/
|
|
699
1986
|
export type MFADelete = (typeof MFADelete)[keyof typeof MFADelete];
|
|
700
1987
|
/**
|
|
701
|
-
* <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
|
|
702
|
-
*
|
|
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>
|
|
703
1990
|
* @public
|
|
704
1991
|
*/
|
|
705
1992
|
export interface VersioningConfiguration {
|
|
706
1993
|
/**
|
|
707
|
-
* <p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This
|
|
708
|
-
*
|
|
709
|
-
*
|
|
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>
|
|
710
1997
|
* @public
|
|
711
1998
|
*/
|
|
712
1999
|
MFADelete?: MFADelete | undefined;
|
|
@@ -729,9 +2016,8 @@ export interface PutBucketVersioningRequest {
|
|
|
729
2016
|
Bucket: string | undefined;
|
|
730
2017
|
/**
|
|
731
2018
|
* <p>>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
|
|
732
|
-
*
|
|
733
|
-
*
|
|
734
|
-
* 1864</a>.</p>
|
|
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>
|
|
735
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>
|
|
736
2022
|
* @public
|
|
737
2023
|
*/
|
|
@@ -742,14 +2028,14 @@ export interface PutBucketVersioningRequest {
|
|
|
742
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
|
|
743
2029
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
744
2030
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
745
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
746
|
-
*
|
|
2031
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
2032
|
+
* parameter.</p>
|
|
747
2033
|
* @public
|
|
748
2034
|
*/
|
|
749
2035
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
750
2036
|
/**
|
|
751
|
-
* <p>The concatenation of the authentication device's serial number, a space, and the value
|
|
752
|
-
*
|
|
2037
|
+
* <p>The concatenation of the authentication device's serial number, a space, and the value that is
|
|
2038
|
+
* displayed on your authentication device.</p>
|
|
753
2039
|
* @public
|
|
754
2040
|
*/
|
|
755
2041
|
MFA?: string | undefined;
|
|
@@ -805,9 +2091,9 @@ export interface PutBucketWebsiteRequest {
|
|
|
805
2091
|
*/
|
|
806
2092
|
Bucket: string | undefined;
|
|
807
2093
|
/**
|
|
808
|
-
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
|
|
809
|
-
*
|
|
810
|
-
*
|
|
2094
|
+
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a
|
|
2095
|
+
* message integrity check to verify that the request body was not corrupted in transit. For more
|
|
2096
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
811
2097
|
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
812
2098
|
* @public
|
|
813
2099
|
*/
|
|
@@ -818,8 +2104,8 @@ export interface PutBucketWebsiteRequest {
|
|
|
818
2104
|
* <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
|
|
819
2105
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
820
2106
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
821
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
822
|
-
*
|
|
2107
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
2108
|
+
* parameter.</p>
|
|
823
2109
|
* @public
|
|
824
2110
|
*/
|
|
825
2111
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -835,11 +2121,8 @@ export interface PutBucketWebsiteRequest {
|
|
|
835
2121
|
ExpectedBucketOwner?: string | undefined;
|
|
836
2122
|
}
|
|
837
2123
|
/**
|
|
838
|
-
* <p>
|
|
839
|
-
*
|
|
840
|
-
* Subsequent write requests must include the appropriate encryption
|
|
841
|
-
* parameters in the request or while creating the session.
|
|
842
|
-
* </p>
|
|
2124
|
+
* <p> The existing object was created with a different encryption type. Subsequent write requests must
|
|
2125
|
+
* include the appropriate encryption parameters in the request or while creating the session. </p>
|
|
843
2126
|
* @public
|
|
844
2127
|
*/
|
|
845
2128
|
export declare class EncryptionTypeMismatch extends __BaseException {
|
|
@@ -851,13 +2134,16 @@ export declare class EncryptionTypeMismatch extends __BaseException {
|
|
|
851
2134
|
constructor(opts: __ExceptionOptionType<EncryptionTypeMismatch, __BaseException>);
|
|
852
2135
|
}
|
|
853
2136
|
/**
|
|
854
|
-
* <p>You may receive this error in multiple cases. Depending on the reason for the error, you may receive
|
|
2137
|
+
* <p>You may receive this error in multiple cases. Depending on the reason for the error, you may receive
|
|
2138
|
+
* one of the messages below:</p>
|
|
855
2139
|
* <ul>
|
|
856
2140
|
* <li>
|
|
857
|
-
* <p>Cannot specify both a write offset value and user-defined object metadata for existing
|
|
2141
|
+
* <p>Cannot specify both a write offset value and user-defined object metadata for existing
|
|
2142
|
+
* objects.</p>
|
|
858
2143
|
* </li>
|
|
859
2144
|
* <li>
|
|
860
|
-
* <p>Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type:
|
|
2145
|
+
* <p>Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type:
|
|
2146
|
+
* crc32c.</p>
|
|
861
2147
|
* </li>
|
|
862
2148
|
* <li>
|
|
863
2149
|
* <p>Request body cannot be empty when 'write offset' is specified.</p>
|
|
@@ -874,9 +2160,7 @@ export declare class InvalidRequest extends __BaseException {
|
|
|
874
2160
|
constructor(opts: __ExceptionOptionType<InvalidRequest, __BaseException>);
|
|
875
2161
|
}
|
|
876
2162
|
/**
|
|
877
|
-
* <p>
|
|
878
|
-
* The write offset value that you specified does not match the current object size.
|
|
879
|
-
* </p>
|
|
2163
|
+
* <p> The write offset value that you specified does not match the current object size. </p>
|
|
880
2164
|
* @public
|
|
881
2165
|
*/
|
|
882
2166
|
export declare class InvalidWriteOffset extends __BaseException {
|
|
@@ -892,12 +2176,13 @@ export declare class InvalidWriteOffset extends __BaseException {
|
|
|
892
2176
|
*/
|
|
893
2177
|
export interface PutObjectOutput {
|
|
894
2178
|
/**
|
|
895
|
-
* <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>,
|
|
896
|
-
*
|
|
897
|
-
*
|
|
898
|
-
*
|
|
2179
|
+
* <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
|
|
2180
|
+
* includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs
|
|
2181
|
+
* that provide information about object expiration. The value of the <code>rule-id</code> is
|
|
2182
|
+
* URL-encoded.</p>
|
|
899
2183
|
* <note>
|
|
900
|
-
* <p>Object expiration information is not returned in directory buckets and this header returns the
|
|
2184
|
+
* <p>Object expiration information is not returned in directory buckets and this header returns the
|
|
2185
|
+
* value "<code>NotImplemented</code>" in all responses for directory buckets.</p>
|
|
901
2186
|
* </note>
|
|
902
2187
|
* @public
|
|
903
2188
|
*/
|
|
@@ -905,13 +2190,13 @@ export interface PutObjectOutput {
|
|
|
905
2190
|
/**
|
|
906
2191
|
* <p>Entity tag for the uploaded object.</p>
|
|
907
2192
|
* <p>
|
|
908
|
-
* <b>General purpose buckets </b> - To ensure that data is not
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
*
|
|
2193
|
+
* <b>General purpose buckets </b> - To ensure that data is not corrupted
|
|
2194
|
+
* traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate
|
|
2195
|
+
* the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5
|
|
2196
|
+
* value.</p>
|
|
912
2197
|
* <p>
|
|
913
|
-
* <b>Directory buckets </b> - The ETag for the object in
|
|
914
|
-
*
|
|
2198
|
+
* <b>Directory buckets </b> - The ETag for the object in a
|
|
2199
|
+
* directory bucket isn't the MD5 digest of the object.</p>
|
|
915
2200
|
* @public
|
|
916
2201
|
*/
|
|
917
2202
|
ETag?: string | undefined;
|
|
@@ -932,12 +2217,11 @@ export interface PutObjectOutput {
|
|
|
932
2217
|
*/
|
|
933
2218
|
ChecksumCRC32C?: string | undefined;
|
|
934
2219
|
/**
|
|
935
|
-
* <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. This header
|
|
936
|
-
*
|
|
937
|
-
*
|
|
938
|
-
*
|
|
939
|
-
*
|
|
940
|
-
* in the Amazon S3 User Guide</a>.</p>
|
|
2220
|
+
* <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. This header is present if
|
|
2221
|
+
* the object was uploaded with the <code>CRC64NVME</code> checksum algorithm, or if it was uploaded
|
|
2222
|
+
* without a checksum (and Amazon S3 added the default checksum, <code>CRC64NVME</code>, to the uploaded
|
|
2223
|
+
* 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
|
|
2224
|
+
* integrity in the Amazon S3 User Guide</a>.</p>
|
|
941
2225
|
* @public
|
|
942
2226
|
*/
|
|
943
2227
|
ChecksumCRC64NVME?: string | undefined;
|
|
@@ -958,31 +2242,32 @@ export interface PutObjectOutput {
|
|
|
958
2242
|
*/
|
|
959
2243
|
ChecksumSHA256?: string | undefined;
|
|
960
2244
|
/**
|
|
961
|
-
* <p>This header specifies the checksum type of the object, which determines how part-level
|
|
962
|
-
*
|
|
963
|
-
*
|
|
964
|
-
*
|
|
965
|
-
*
|
|
2245
|
+
* <p>This header specifies the checksum type of the object, which determines how part-level checksums are
|
|
2246
|
+
* combined to create an object-level checksum for multipart objects. For <code>PutObject</code> uploads,
|
|
2247
|
+
* the checksum type is always <code>FULL_OBJECT</code>. You can use this header as a data integrity check
|
|
2248
|
+
* to verify that the checksum type that is received is the same checksum that was specified. For more
|
|
2249
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
2250
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
966
2251
|
* @public
|
|
967
2252
|
*/
|
|
968
2253
|
ChecksumType?: ChecksumType | undefined;
|
|
969
2254
|
/**
|
|
970
2255
|
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p>
|
|
971
2256
|
* <note>
|
|
972
|
-
* <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
|
|
2257
|
+
* <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
|
|
2258
|
+
* encryption option is <code>aws:fsx</code>.</p>
|
|
973
2259
|
* </note>
|
|
974
2260
|
* @public
|
|
975
2261
|
*/
|
|
976
2262
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
977
2263
|
/**
|
|
978
2264
|
* <p>Version ID of the object.</p>
|
|
979
|
-
* <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID
|
|
980
|
-
*
|
|
981
|
-
*
|
|
982
|
-
*
|
|
983
|
-
*
|
|
984
|
-
*
|
|
985
|
-
* information about returning the versioning state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
|
|
2265
|
+
* <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the
|
|
2266
|
+
* object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if
|
|
2267
|
+
* Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
|
|
2268
|
+
* For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to
|
|
2269
|
+
* Versioning-Enabled Buckets</a> in the <i>Amazon S3 User Guide</i>. For information about
|
|
2270
|
+
* returning the versioning state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
|
|
986
2271
|
* <note>
|
|
987
2272
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
988
2273
|
* </note>
|
|
@@ -990,8 +2275,8 @@ export interface PutObjectOutput {
|
|
|
990
2275
|
*/
|
|
991
2276
|
VersionId?: string | undefined;
|
|
992
2277
|
/**
|
|
993
|
-
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
994
|
-
*
|
|
2278
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the response will
|
|
2279
|
+
* include this header to confirm the encryption algorithm that's used.</p>
|
|
995
2280
|
* <note>
|
|
996
2281
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
997
2282
|
* </note>
|
|
@@ -999,9 +2284,9 @@ export interface PutObjectOutput {
|
|
|
999
2284
|
*/
|
|
1000
2285
|
SSECustomerAlgorithm?: string | undefined;
|
|
1001
2286
|
/**
|
|
1002
|
-
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
1003
|
-
*
|
|
1004
|
-
*
|
|
2287
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the response will
|
|
2288
|
+
* include this header to provide the round-trip message integrity verification of the customer-provided
|
|
2289
|
+
* encryption key.</p>
|
|
1005
2290
|
* <note>
|
|
1006
2291
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1007
2292
|
* </note>
|
|
@@ -1023,24 +2308,24 @@ export interface PutObjectOutput {
|
|
|
1023
2308
|
*/
|
|
1024
2309
|
SSEKMSEncryptionContext?: string | undefined;
|
|
1025
2310
|
/**
|
|
1026
|
-
* <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption
|
|
1027
|
-
*
|
|
2311
|
+
* <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with
|
|
2312
|
+
* Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
1028
2313
|
* @public
|
|
1029
2314
|
*/
|
|
1030
2315
|
BucketKeyEnabled?: boolean | undefined;
|
|
1031
2316
|
/**
|
|
1032
|
-
* <p>
|
|
1033
|
-
* The size of the object in bytes. This value is only be present if you append to an object.
|
|
1034
|
-
* </p>
|
|
2317
|
+
* <p> The size of the object in bytes. This value is only be present if you append to an object. </p>
|
|
1035
2318
|
* <note>
|
|
1036
|
-
* <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in
|
|
2319
|
+
* <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in
|
|
2320
|
+
* directory buckets.</p>
|
|
1037
2321
|
* </note>
|
|
1038
2322
|
* @public
|
|
1039
2323
|
*/
|
|
1040
2324
|
Size?: number | undefined;
|
|
1041
2325
|
/**
|
|
1042
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
1043
|
-
*
|
|
2326
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
2327
|
+
* 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
|
|
2328
|
+
* Storage Service user guide</i>.</p>
|
|
1044
2329
|
* <note>
|
|
1045
2330
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1046
2331
|
* </note>
|
|
@@ -1053,23 +2338,22 @@ export interface PutObjectOutput {
|
|
|
1053
2338
|
*/
|
|
1054
2339
|
export interface PutObjectRequest {
|
|
1055
2340
|
/**
|
|
1056
|
-
* <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
|
|
1057
|
-
*
|
|
1058
|
-
* <p>When adding a new object, you can use headers to grant ACL-based permissions to
|
|
1059
|
-
*
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
* <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1069
|
-
*
|
|
1070
|
-
*
|
|
1071
|
-
*
|
|
1072
|
-
* objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2341
|
+
* <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
|
|
2342
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2343
|
+
* <p>When adding a new object, you can use headers to grant ACL-based permissions to individual
|
|
2344
|
+
* Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on
|
|
2345
|
+
* the object. By default, all objects are private. Only the owner has full access control. For more
|
|
2346
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
|
|
2347
|
+
* 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
|
|
2348
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2349
|
+
* <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object
|
|
2350
|
+
* Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept
|
|
2351
|
+
* PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such
|
|
2352
|
+
* as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in
|
|
2353
|
+
* the XML format. PUT requests that contain other ACLs (for example, custom grants to certain
|
|
2354
|
+
* Amazon Web Services accounts) fail and return a <code>400</code> error with the error code
|
|
2355
|
+
* <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
|
|
2356
|
+
* disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1073
2357
|
* <note>
|
|
1074
2358
|
* <ul>
|
|
1075
2359
|
* <li>
|
|
@@ -1091,8 +2375,7 @@ export interface PutObjectRequest {
|
|
|
1091
2375
|
/**
|
|
1092
2376
|
* <p>The bucket name to which the PUT action was initiated. </p>
|
|
1093
2377
|
* <p>
|
|
1094
|
-
* <b>Directory buckets</b> -
|
|
1095
|
-
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
2378
|
+
* <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
1096
2379
|
* <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>
|
|
1097
2380
|
* <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
|
|
1098
2381
|
* <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -1113,8 +2396,8 @@ export interface PutObjectRequest {
|
|
|
1113
2396
|
*/
|
|
1114
2397
|
Bucket: string | undefined;
|
|
1115
2398
|
/**
|
|
1116
|
-
* <p>Can be used to specify caching behavior along the request/reply chain. For more
|
|
1117
|
-
*
|
|
2399
|
+
* <p>Can be used to specify caching behavior along the request/reply chain. For more information, see
|
|
2400
|
+
* <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>
|
|
1118
2401
|
* @public
|
|
1119
2402
|
*/
|
|
1120
2403
|
CacheControl?: string | undefined;
|
|
@@ -1124,9 +2407,9 @@ export interface PutObjectRequest {
|
|
|
1124
2407
|
*/
|
|
1125
2408
|
ContentDisposition?: string | undefined;
|
|
1126
2409
|
/**
|
|
1127
|
-
* <p>Specifies what content encodings have been applied to the object and thus what decoding
|
|
1128
|
-
*
|
|
1129
|
-
*
|
|
2410
|
+
* <p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms
|
|
2411
|
+
* must be applied to obtain the media-type referenced by the Content-Type header field. For more
|
|
2412
|
+
* 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>
|
|
1130
2413
|
* @public
|
|
1131
2414
|
*/
|
|
1132
2415
|
ContentEncoding?: string | undefined;
|
|
@@ -1136,22 +2419,22 @@ export interface PutObjectRequest {
|
|
|
1136
2419
|
*/
|
|
1137
2420
|
ContentLanguage?: string | undefined;
|
|
1138
2421
|
/**
|
|
1139
|
-
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be
|
|
1140
|
-
*
|
|
2422
|
+
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
|
|
2423
|
+
* 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>
|
|
1141
2424
|
* @public
|
|
1142
2425
|
*/
|
|
1143
2426
|
ContentLength?: number | undefined;
|
|
1144
2427
|
/**
|
|
1145
2428
|
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the message (without the headers) according to
|
|
1146
|
-
*
|
|
1147
|
-
*
|
|
1148
|
-
*
|
|
1149
|
-
*
|
|
2429
|
+
* RFC 1864. This header can be used as a message integrity check to verify that the data is the same data
|
|
2430
|
+
* that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an
|
|
2431
|
+
* 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
|
|
2432
|
+
* Authentication</a>.</p>
|
|
1150
2433
|
* <note>
|
|
1151
|
-
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is
|
|
1152
|
-
*
|
|
1153
|
-
*
|
|
1154
|
-
*
|
|
2434
|
+
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for
|
|
2435
|
+
* any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
|
|
2436
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects
|
|
2437
|
+
* to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1155
2438
|
* </note>
|
|
1156
2439
|
* <note>
|
|
1157
2440
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -1160,8 +2443,7 @@ export interface PutObjectRequest {
|
|
|
1160
2443
|
*/
|
|
1161
2444
|
ContentMD5?: string | undefined;
|
|
1162
2445
|
/**
|
|
1163
|
-
* <p>A standard MIME type describing the format of the contents. For more information, see
|
|
1164
|
-
* <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
|
+
* <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>
|
|
1165
2447
|
* @public
|
|
1166
2448
|
*/
|
|
1167
2449
|
ContentType?: string | undefined;
|
|
@@ -1207,10 +2489,10 @@ export interface PutObjectRequest {
|
|
|
1207
2489
|
* <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i>
|
|
1208
2490
|
* </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>
|
|
1209
2491
|
* <note>
|
|
1210
|
-
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is
|
|
1211
|
-
*
|
|
1212
|
-
*
|
|
1213
|
-
*
|
|
2492
|
+
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for
|
|
2493
|
+
* any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
|
|
2494
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects
|
|
2495
|
+
* to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1214
2496
|
* </note>
|
|
1215
2497
|
* <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>
|
|
1216
2498
|
* @public
|
|
@@ -1233,11 +2515,11 @@ export interface PutObjectRequest {
|
|
|
1233
2515
|
*/
|
|
1234
2516
|
ChecksumCRC32C?: string | undefined;
|
|
1235
2517
|
/**
|
|
1236
|
-
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
1237
|
-
*
|
|
1238
|
-
*
|
|
1239
|
-
*
|
|
1240
|
-
*
|
|
2518
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
2519
|
+
* that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code>
|
|
2520
|
+
* checksum of the object. The <code>CRC64NVME</code> checksum is always a full object checksum. For more
|
|
2521
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3
|
|
2522
|
+
* User Guide</a>.</p>
|
|
1241
2523
|
* @public
|
|
1242
2524
|
*/
|
|
1243
2525
|
ChecksumCRC64NVME?: string | undefined;
|
|
@@ -1258,29 +2540,31 @@ export interface PutObjectRequest {
|
|
|
1258
2540
|
*/
|
|
1259
2541
|
ChecksumSHA256?: string | undefined;
|
|
1260
2542
|
/**
|
|
1261
|
-
* <p>The date and time at which the object is no longer cacheable. For more information, see
|
|
1262
|
-
* <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
|
+
* <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>
|
|
1263
2544
|
* @public
|
|
1264
2545
|
*/
|
|
1265
2546
|
Expires?: Date | undefined;
|
|
1266
2547
|
/**
|
|
1267
|
-
* <p>Uploads the object only if the ETag (entity tag) value provided during the WRITE
|
|
1268
|
-
*
|
|
1269
|
-
*
|
|
1270
|
-
* <p>If a conflicting operation occurs during the upload S3 returns a <code>409
|
|
2548
|
+
* <p>Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches
|
|
2549
|
+
* the ETag of the object in S3. If the ETag values do not match, the operation returns a <code>412
|
|
2550
|
+
* Precondition Failed</code> error.</p>
|
|
2551
|
+
* <p>If a conflicting operation occurs during the upload S3 returns a <code>409
|
|
2552
|
+
* ConditionalRequestConflict</code> response. On a 409 failure you should fetch the object's ETag and
|
|
2553
|
+
* retry the upload.</p>
|
|
1271
2554
|
* <p>Expects the ETag value as a string.</p>
|
|
1272
|
-
* <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
|
+
* <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
|
|
2556
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1273
2557
|
* @public
|
|
1274
2558
|
*/
|
|
1275
2559
|
IfMatch?: string | undefined;
|
|
1276
2560
|
/**
|
|
1277
|
-
* <p>Uploads the object only if the object key name does not already exist in the bucket
|
|
1278
|
-
*
|
|
2561
|
+
* <p>Uploads the object only if the object key name does not already exist in the bucket specified.
|
|
2562
|
+
* Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error.</p>
|
|
1279
2563
|
* <p>If a conflicting operation occurs during the upload S3 returns a <code>409
|
|
1280
|
-
*
|
|
1281
|
-
* upload.</p>
|
|
2564
|
+
* ConditionalRequestConflict</code> response. On a 409 failure you should retry the upload.</p>
|
|
1282
2565
|
* <p>Expects the '*' (asterisk) character.</p>
|
|
1283
|
-
* <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
|
+
* <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
|
|
2567
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1284
2568
|
* @public
|
|
1285
2569
|
*/
|
|
1286
2570
|
IfNoneMatch?: string | undefined;
|
|
@@ -1350,13 +2634,12 @@ export interface PutObjectRequest {
|
|
|
1350
2634
|
*/
|
|
1351
2635
|
Key: string | undefined;
|
|
1352
2636
|
/**
|
|
1353
|
-
* <p>
|
|
1354
|
-
*
|
|
1355
|
-
*
|
|
1356
|
-
* If no object exists, setting this header to 0 will create a new object.
|
|
1357
|
-
* </p>
|
|
2637
|
+
* <p> Specifies the offset for appending data to existing objects in bytes. The offset must be equal to
|
|
2638
|
+
* the size of the existing object being appended to. If no object exists, setting this header to 0 will
|
|
2639
|
+
* create a new object. </p>
|
|
1358
2640
|
* <note>
|
|
1359
|
-
* <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in
|
|
2641
|
+
* <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in
|
|
2642
|
+
* directory buckets.</p>
|
|
1360
2643
|
* </note>
|
|
1361
2644
|
* @public
|
|
1362
2645
|
*/
|
|
@@ -1367,24 +2650,24 @@ export interface PutObjectRequest {
|
|
|
1367
2650
|
*/
|
|
1368
2651
|
Metadata?: Record<string, string> | undefined;
|
|
1369
2652
|
/**
|
|
1370
|
-
* <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 or
|
|
2653
|
+
* <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 or
|
|
2654
|
+
* Amazon FSx.</p>
|
|
1371
2655
|
* <ul>
|
|
1372
2656
|
* <li>
|
|
1373
2657
|
* <p>
|
|
1374
|
-
* <b>General purpose buckets </b> - You have four mutually
|
|
1375
|
-
*
|
|
1376
|
-
*
|
|
1377
|
-
*
|
|
1378
|
-
*
|
|
1379
|
-
*
|
|
1380
|
-
*
|
|
1381
|
-
*
|
|
1382
|
-
* Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2658
|
+
* <b>General purpose buckets </b> - You have four mutually exclusive
|
|
2659
|
+
* options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage
|
|
2660
|
+
* the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3),
|
|
2661
|
+
* Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with
|
|
2662
|
+
* server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3
|
|
2663
|
+
* to encrypt data at rest by using server-side encryption with other key options. For more
|
|
2664
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a> in
|
|
2665
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1383
2666
|
* </li>
|
|
1384
2667
|
* <li>
|
|
1385
2668
|
* <p>
|
|
1386
2669
|
* <b>Directory buckets </b> -
|
|
1387
|
-
*
|
|
2670
|
+
* 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
|
|
1388
2671
|
* <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
|
|
1389
2672
|
* are automatically encrypted with the desired encryption settings. For more
|
|
1390
2673
|
* 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>
|
|
@@ -1404,22 +2687,27 @@ export interface PutObjectRequest {
|
|
|
1404
2687
|
* </li>
|
|
1405
2688
|
* <li>
|
|
1406
2689
|
* <p>
|
|
1407
|
-
* <b>S3 access points for Amazon FSx </b> - When accessing data stored in
|
|
2690
|
+
* <b>S3 access points for Amazon FSx </b> - When accessing data stored in
|
|
2691
|
+
* Amazon FSx file systems using S3 access points, the only valid server side encryption option is
|
|
2692
|
+
* <code>aws:fsx</code>. All Amazon FSx file systems have encryption configured by default and are
|
|
2693
|
+
* encrypted at rest. Data is automatically encrypted before being written to the file system, and
|
|
2694
|
+
* automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.</p>
|
|
1408
2695
|
* </li>
|
|
1409
2696
|
* </ul>
|
|
1410
2697
|
* @public
|
|
1411
2698
|
*/
|
|
1412
2699
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
1413
2700
|
/**
|
|
1414
|
-
* <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The
|
|
1415
|
-
*
|
|
1416
|
-
*
|
|
1417
|
-
*
|
|
1418
|
-
* Classes</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2701
|
+
* <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD
|
|
2702
|
+
* storage class provides high durability and high availability. Depending on performance needs, you can
|
|
2703
|
+
* 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
|
|
2704
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1419
2705
|
* <note>
|
|
1420
2706
|
* <ul>
|
|
1421
2707
|
* <li>
|
|
1422
|
-
* <p>Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in
|
|
2708
|
+
* <p>Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in
|
|
2709
|
+
* Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in
|
|
2710
|
+
* Dedicated Local Zones.</p>
|
|
1423
2711
|
* </li>
|
|
1424
2712
|
* <li>
|
|
1425
2713
|
* <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p>
|
|
@@ -1430,23 +2718,21 @@ export interface PutObjectRequest {
|
|
|
1430
2718
|
*/
|
|
1431
2719
|
StorageClass?: StorageClass | undefined;
|
|
1432
2720
|
/**
|
|
1433
|
-
* <p>If the bucket is configured as a website, redirects requests for this object to another
|
|
1434
|
-
*
|
|
1435
|
-
*
|
|
1436
|
-
*
|
|
1437
|
-
* <p>In the following example, the request header sets the redirect to an object
|
|
1438
|
-
*
|
|
2721
|
+
* <p>If the bucket is configured as a website, redirects requests for this object to another object in
|
|
2722
|
+
* the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For
|
|
2723
|
+
* 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
|
|
2724
|
+
* User Guide</i>.</p>
|
|
2725
|
+
* <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in
|
|
2726
|
+
* the same bucket:</p>
|
|
1439
2727
|
* <p>
|
|
1440
2728
|
* <code>x-amz-website-redirect-location: /anotherPage.html</code>
|
|
1441
2729
|
* </p>
|
|
1442
|
-
* <p>In the following example, the request header sets the object redirect to another
|
|
1443
|
-
* website:</p>
|
|
2730
|
+
* <p>In the following example, the request header sets the object redirect to another website:</p>
|
|
1444
2731
|
* <p>
|
|
1445
2732
|
* <code>x-amz-website-redirect-location: http://www.example.com/</code>
|
|
1446
2733
|
* </p>
|
|
1447
|
-
* <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
|
|
1448
|
-
*
|
|
1449
|
-
* Configure Website Page Redirects</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
2734
|
+
* <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
|
|
2735
|
+
* Redirects</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
1450
2736
|
* <note>
|
|
1451
2737
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1452
2738
|
* </note>
|
|
@@ -1454,8 +2740,7 @@ export interface PutObjectRequest {
|
|
|
1454
2740
|
*/
|
|
1455
2741
|
WebsiteRedirectLocation?: string | undefined;
|
|
1456
2742
|
/**
|
|
1457
|
-
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
1458
|
-
* <code>AES256</code>).</p>
|
|
2743
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example, <code>AES256</code>).</p>
|
|
1459
2744
|
* <note>
|
|
1460
2745
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1461
2746
|
* </note>
|
|
@@ -1463,10 +2748,10 @@ export interface PutObjectRequest {
|
|
|
1463
2748
|
*/
|
|
1464
2749
|
SSECustomerAlgorithm?: string | undefined;
|
|
1465
2750
|
/**
|
|
1466
|
-
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
1467
|
-
*
|
|
1468
|
-
*
|
|
1469
|
-
*
|
|
2751
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is
|
|
2752
|
+
* used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must
|
|
2753
|
+
* be appropriate for use with the algorithm specified in the
|
|
2754
|
+
* <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>
|
|
1470
2755
|
* <note>
|
|
1471
2756
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1472
2757
|
* </note>
|
|
@@ -1474,9 +2759,8 @@ export interface PutObjectRequest {
|
|
|
1474
2759
|
*/
|
|
1475
2760
|
SSECustomerKey?: string | undefined;
|
|
1476
2761
|
/**
|
|
1477
|
-
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
1478
|
-
*
|
|
1479
|
-
* without error.</p>
|
|
2762
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header
|
|
2763
|
+
* for a message integrity check to ensure that the encryption key was transmitted without error.</p>
|
|
1480
2764
|
* <note>
|
|
1481
2765
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1482
2766
|
* </note>
|
|
@@ -1532,12 +2816,11 @@ export interface PutObjectRequest {
|
|
|
1532
2816
|
*/
|
|
1533
2817
|
BucketKeyEnabled?: boolean | undefined;
|
|
1534
2818
|
/**
|
|
1535
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1536
|
-
*
|
|
1537
|
-
*
|
|
1538
|
-
*
|
|
1539
|
-
*
|
|
1540
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2819
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
2820
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
2821
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
2822
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
2823
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1541
2824
|
* <note>
|
|
1542
2825
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1543
2826
|
* </note>
|
|
@@ -1545,8 +2828,8 @@ export interface PutObjectRequest {
|
|
|
1545
2828
|
*/
|
|
1546
2829
|
RequestPayer?: RequestPayer | undefined;
|
|
1547
2830
|
/**
|
|
1548
|
-
* <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For
|
|
1549
|
-
*
|
|
2831
|
+
* <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example,
|
|
2832
|
+
* "Key1=Value1")</p>
|
|
1550
2833
|
* <note>
|
|
1551
2834
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1552
2835
|
* </note>
|
|
@@ -1562,8 +2845,8 @@ export interface PutObjectRequest {
|
|
|
1562
2845
|
*/
|
|
1563
2846
|
ObjectLockMode?: ObjectLockMode | undefined;
|
|
1564
2847
|
/**
|
|
1565
|
-
* <p>The date and time when you want this object's Object Lock to expire. Must be formatted
|
|
1566
|
-
*
|
|
2848
|
+
* <p>The date and time when you want this object's Object Lock to expire. Must be formatted as a
|
|
2849
|
+
* timestamp parameter.</p>
|
|
1567
2850
|
* <note>
|
|
1568
2851
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1569
2852
|
* </note>
|
|
@@ -1571,9 +2854,9 @@ export interface PutObjectRequest {
|
|
|
1571
2854
|
*/
|
|
1572
2855
|
ObjectLockRetainUntilDate?: Date | undefined;
|
|
1573
2856
|
/**
|
|
1574
|
-
* <p>Specifies whether a legal hold will be applied to this object. For more information
|
|
1575
|
-
*
|
|
1576
|
-
*
|
|
2857
|
+
* <p>Specifies whether a legal hold will be applied to this object. For more information about S3 Object
|
|
2858
|
+
* Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in
|
|
2859
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1577
2860
|
* <note>
|
|
1578
2861
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1579
2862
|
* </note>
|
|
@@ -1587,11 +2870,9 @@ export interface PutObjectRequest {
|
|
|
1587
2870
|
ExpectedBucketOwner?: string | undefined;
|
|
1588
2871
|
}
|
|
1589
2872
|
/**
|
|
1590
|
-
* <p>
|
|
1591
|
-
*
|
|
1592
|
-
*
|
|
1593
|
-
* to copy this object to another and then add more data to the newly copied object.
|
|
1594
|
-
* </p>
|
|
2873
|
+
* <p> You have attempted to add more parts than the maximum of 10000 that are allowed for this object.
|
|
2874
|
+
* You can use the CopyObject operation to copy this object to another and then add more data to the newly
|
|
2875
|
+
* copied object. </p>
|
|
1595
2876
|
* @public
|
|
1596
2877
|
*/
|
|
1597
2878
|
export declare class TooManyParts extends __BaseException {
|
|
@@ -1607,8 +2888,9 @@ export declare class TooManyParts extends __BaseException {
|
|
|
1607
2888
|
*/
|
|
1608
2889
|
export interface PutObjectAclOutput {
|
|
1609
2890
|
/**
|
|
1610
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
1611
|
-
*
|
|
2891
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
2892
|
+
* 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
|
|
2893
|
+
* Storage Service user guide</i>.</p>
|
|
1612
2894
|
* <note>
|
|
1613
2895
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1614
2896
|
* </note>
|
|
@@ -1621,8 +2903,7 @@ export interface PutObjectAclOutput {
|
|
|
1621
2903
|
*/
|
|
1622
2904
|
export interface PutObjectAclRequest {
|
|
1623
2905
|
/**
|
|
1624
|
-
* <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
|
|
1625
|
-
* ACL</a>.</p>
|
|
2906
|
+
* <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>
|
|
1626
2907
|
* @public
|
|
1627
2908
|
*/
|
|
1628
2909
|
ACL?: ObjectCannedACL | undefined;
|
|
@@ -1645,10 +2926,9 @@ export interface PutObjectAclRequest {
|
|
|
1645
2926
|
*/
|
|
1646
2927
|
Bucket: string | undefined;
|
|
1647
2928
|
/**
|
|
1648
|
-
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a
|
|
1649
|
-
*
|
|
1650
|
-
*
|
|
1651
|
-
* 1864.></a>
|
|
2929
|
+
* <p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a
|
|
2930
|
+
* message integrity check to verify that the request body was not corrupted in transit. For more
|
|
2931
|
+
* information, go to <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864.></a>
|
|
1652
2932
|
* </p>
|
|
1653
2933
|
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
1654
2934
|
* @public
|
|
@@ -1660,14 +2940,13 @@ export interface PutObjectAclRequest {
|
|
|
1660
2940
|
* <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
|
|
1661
2941
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1662
2942
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1663
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1664
|
-
*
|
|
2943
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
2944
|
+
* parameter.</p>
|
|
1665
2945
|
* @public
|
|
1666
2946
|
*/
|
|
1667
2947
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
1668
2948
|
/**
|
|
1669
|
-
* <p>Allows grantee the read, write, read ACP, and write ACP permissions on the
|
|
1670
|
-
* bucket.</p>
|
|
2949
|
+
* <p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>
|
|
1671
2950
|
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1672
2951
|
* @public
|
|
1673
2952
|
*/
|
|
@@ -1686,8 +2965,8 @@ export interface PutObjectAclRequest {
|
|
|
1686
2965
|
GrantReadACP?: string | undefined;
|
|
1687
2966
|
/**
|
|
1688
2967
|
* <p>Allows grantee to create new objects in the bucket.</p>
|
|
1689
|
-
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
1690
|
-
*
|
|
2968
|
+
* <p>For the bucket and object owners of existing objects, also allows deletions and overwrites of those
|
|
2969
|
+
* objects.</p>
|
|
1691
2970
|
* @public
|
|
1692
2971
|
*/
|
|
1693
2972
|
GrantWrite?: string | undefined;
|
|
@@ -1703,12 +2982,11 @@ export interface PutObjectAclRequest {
|
|
|
1703
2982
|
*/
|
|
1704
2983
|
Key: string | undefined;
|
|
1705
2984
|
/**
|
|
1706
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1707
|
-
*
|
|
1708
|
-
*
|
|
1709
|
-
*
|
|
1710
|
-
*
|
|
1711
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2985
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
2986
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
2987
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
2988
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
2989
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1712
2990
|
* <note>
|
|
1713
2991
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1714
2992
|
* </note>
|
|
@@ -1734,8 +3012,9 @@ export interface PutObjectAclRequest {
|
|
|
1734
3012
|
*/
|
|
1735
3013
|
export interface PutObjectLegalHoldOutput {
|
|
1736
3014
|
/**
|
|
1737
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
1738
|
-
*
|
|
3015
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
3016
|
+
* 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
|
|
3017
|
+
* Storage Service user guide</i>.</p>
|
|
1739
3018
|
* <note>
|
|
1740
3019
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1741
3020
|
* </note>
|
|
@@ -1762,18 +3041,16 @@ export interface PutObjectLegalHoldRequest {
|
|
|
1762
3041
|
*/
|
|
1763
3042
|
Key: string | undefined;
|
|
1764
3043
|
/**
|
|
1765
|
-
* <p>Container element for the legal hold configuration you want to apply to the specified
|
|
1766
|
-
* object.</p>
|
|
3044
|
+
* <p>Container element for the legal hold configuration you want to apply to the specified object.</p>
|
|
1767
3045
|
* @public
|
|
1768
3046
|
*/
|
|
1769
3047
|
LegalHold?: ObjectLockLegalHold | undefined;
|
|
1770
3048
|
/**
|
|
1771
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1772
|
-
*
|
|
1773
|
-
*
|
|
1774
|
-
*
|
|
1775
|
-
*
|
|
1776
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3049
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
3050
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
3051
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
3052
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
3053
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1777
3054
|
* <note>
|
|
1778
3055
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1779
3056
|
* </note>
|
|
@@ -1797,8 +3074,8 @@ export interface PutObjectLegalHoldRequest {
|
|
|
1797
3074
|
* <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
|
|
1798
3075
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1799
3076
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1800
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1801
|
-
*
|
|
3077
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
3078
|
+
* parameter.</p>
|
|
1802
3079
|
* @public
|
|
1803
3080
|
*/
|
|
1804
3081
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -1813,8 +3090,9 @@ export interface PutObjectLegalHoldRequest {
|
|
|
1813
3090
|
*/
|
|
1814
3091
|
export interface PutObjectLockConfigurationOutput {
|
|
1815
3092
|
/**
|
|
1816
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
1817
|
-
*
|
|
3093
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
3094
|
+
* 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
|
|
3095
|
+
* Storage Service user guide</i>.</p>
|
|
1818
3096
|
* <note>
|
|
1819
3097
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1820
3098
|
* </note>
|
|
@@ -1839,12 +3117,11 @@ export interface PutObjectLockConfigurationRequest {
|
|
|
1839
3117
|
*/
|
|
1840
3118
|
ObjectLockConfiguration?: ObjectLockConfiguration | undefined;
|
|
1841
3119
|
/**
|
|
1842
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1843
|
-
*
|
|
1844
|
-
*
|
|
1845
|
-
*
|
|
1846
|
-
*
|
|
1847
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3120
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
3121
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
3122
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
3123
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
3124
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1848
3125
|
* <note>
|
|
1849
3126
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1850
3127
|
* </note>
|
|
@@ -1868,8 +3145,8 @@ export interface PutObjectLockConfigurationRequest {
|
|
|
1868
3145
|
* <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
|
|
1869
3146
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1870
3147
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1871
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1872
|
-
*
|
|
3148
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
3149
|
+
* parameter.</p>
|
|
1873
3150
|
* @public
|
|
1874
3151
|
*/
|
|
1875
3152
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -1884,8 +3161,9 @@ export interface PutObjectLockConfigurationRequest {
|
|
|
1884
3161
|
*/
|
|
1885
3162
|
export interface PutObjectRetentionOutput {
|
|
1886
3163
|
/**
|
|
1887
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
1888
|
-
*
|
|
3164
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
3165
|
+
* 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
|
|
3166
|
+
* Storage Service user guide</i>.</p>
|
|
1889
3167
|
* <note>
|
|
1890
3168
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1891
3169
|
* </note>
|
|
@@ -1898,8 +3176,7 @@ export interface PutObjectRetentionOutput {
|
|
|
1898
3176
|
*/
|
|
1899
3177
|
export interface PutObjectRetentionRequest {
|
|
1900
3178
|
/**
|
|
1901
|
-
* <p>The bucket name that contains the object you want to apply this Object Retention
|
|
1902
|
-
* configuration to. </p>
|
|
3179
|
+
* <p>The bucket name that contains the object you want to apply this Object Retention configuration to. </p>
|
|
1903
3180
|
* <p>
|
|
1904
3181
|
* <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>
|
|
1905
3182
|
* <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.
|
|
@@ -1908,8 +3185,7 @@ export interface PutObjectRetentionRequest {
|
|
|
1908
3185
|
*/
|
|
1909
3186
|
Bucket: string | undefined;
|
|
1910
3187
|
/**
|
|
1911
|
-
* <p>The key name for the object that you want to apply this Object Retention configuration
|
|
1912
|
-
* to.</p>
|
|
3188
|
+
* <p>The key name for the object that you want to apply this Object Retention configuration to.</p>
|
|
1913
3189
|
* @public
|
|
1914
3190
|
*/
|
|
1915
3191
|
Key: string | undefined;
|
|
@@ -1919,12 +3195,11 @@ export interface PutObjectRetentionRequest {
|
|
|
1919
3195
|
*/
|
|
1920
3196
|
Retention?: ObjectLockRetention | undefined;
|
|
1921
3197
|
/**
|
|
1922
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1923
|
-
*
|
|
1924
|
-
*
|
|
1925
|
-
*
|
|
1926
|
-
*
|
|
1927
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3198
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
3199
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
3200
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
3201
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
3202
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1928
3203
|
* <note>
|
|
1929
3204
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1930
3205
|
* </note>
|
|
@@ -1932,8 +3207,7 @@ export interface PutObjectRetentionRequest {
|
|
|
1932
3207
|
*/
|
|
1933
3208
|
RequestPayer?: RequestPayer | undefined;
|
|
1934
3209
|
/**
|
|
1935
|
-
* <p>The version ID for the object that you want to apply this Object Retention configuration
|
|
1936
|
-
* to.</p>
|
|
3210
|
+
* <p>The version ID for the object that you want to apply this Object Retention configuration to.</p>
|
|
1937
3211
|
* @public
|
|
1938
3212
|
*/
|
|
1939
3213
|
VersionId?: string | undefined;
|
|
@@ -1954,8 +3228,8 @@ export interface PutObjectRetentionRequest {
|
|
|
1954
3228
|
* <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
|
|
1955
3229
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1956
3230
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1957
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1958
|
-
*
|
|
3231
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
3232
|
+
* parameter.</p>
|
|
1959
3233
|
* @public
|
|
1960
3234
|
*/
|
|
1961
3235
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -2014,8 +3288,8 @@ export interface PutObjectTaggingRequest {
|
|
|
2014
3288
|
* <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
|
|
2015
3289
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
2016
3290
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
2017
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
2018
|
-
*
|
|
3291
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
3292
|
+
* parameter.</p>
|
|
2019
3293
|
* @public
|
|
2020
3294
|
*/
|
|
2021
3295
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -2030,12 +3304,11 @@ export interface PutObjectTaggingRequest {
|
|
|
2030
3304
|
*/
|
|
2031
3305
|
ExpectedBucketOwner?: string | undefined;
|
|
2032
3306
|
/**
|
|
2033
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
2034
|
-
*
|
|
2035
|
-
*
|
|
2036
|
-
*
|
|
2037
|
-
*
|
|
2038
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3307
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
3308
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
3309
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
3310
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
3311
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2039
3312
|
* <note>
|
|
2040
3313
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2041
3314
|
* </note>
|
|
@@ -2048,8 +3321,8 @@ export interface PutObjectTaggingRequest {
|
|
|
2048
3321
|
*/
|
|
2049
3322
|
export interface PutPublicAccessBlockRequest {
|
|
2050
3323
|
/**
|
|
2051
|
-
* <p>The name of the Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration you want
|
|
2052
|
-
*
|
|
3324
|
+
* <p>The name of the Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration you want to
|
|
3325
|
+
* set.</p>
|
|
2053
3326
|
* <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.
|
|
2054
3327
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
2055
3328
|
* @public
|
|
@@ -2067,15 +3340,15 @@ export interface PutPublicAccessBlockRequest {
|
|
|
2067
3340
|
* <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
|
|
2068
3341
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
2069
3342
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
2070
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
2071
|
-
*
|
|
3343
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
3344
|
+
* parameter.</p>
|
|
2072
3345
|
* @public
|
|
2073
3346
|
*/
|
|
2074
3347
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
2075
3348
|
/**
|
|
2076
|
-
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
2077
|
-
*
|
|
2078
|
-
*
|
|
3349
|
+
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3 bucket. You can
|
|
3350
|
+
* enable the configuration options in any combination. For more information about when Amazon S3 considers a
|
|
3351
|
+
* 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>
|
|
2079
3352
|
* @public
|
|
2080
3353
|
*/
|
|
2081
3354
|
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined;
|
|
@@ -2086,12 +3359,12 @@ export interface PutPublicAccessBlockRequest {
|
|
|
2086
3359
|
ExpectedBucketOwner?: string | undefined;
|
|
2087
3360
|
}
|
|
2088
3361
|
/**
|
|
2089
|
-
* <p>Parameters on this idempotent request are inconsistent with parameters used in previous request(s).
|
|
2090
|
-
* </p>
|
|
2091
|
-
* <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
|
|
2092
|
-
* codes</a>.</p>
|
|
3362
|
+
* <p>Parameters on this idempotent request are inconsistent with parameters used in previous request(s). </p>
|
|
3363
|
+
* <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>
|
|
2093
3364
|
* <note>
|
|
2094
|
-
* <p>Idempotency ensures that an API request completes no more than one time. With an idempotent
|
|
3365
|
+
* <p>Idempotency ensures that an API request completes no more than one time. With an idempotent
|
|
3366
|
+
* request, if the original request completes successfully, any subsequent retries complete successfully
|
|
3367
|
+
* without performing any further actions.</p>
|
|
2095
3368
|
* </note>
|
|
2096
3369
|
* @public
|
|
2097
3370
|
*/
|
|
@@ -2115,12 +3388,11 @@ export interface RenameObjectRequest {
|
|
|
2115
3388
|
/**
|
|
2116
3389
|
* <p>The bucket name of the directory bucket containing the object.</p>
|
|
2117
3390
|
* <p> You must use virtual-hosted-style requests in the format
|
|
2118
|
-
*
|
|
2119
|
-
*
|
|
2120
|
-
*
|
|
2121
|
-
*
|
|
2122
|
-
*
|
|
2123
|
-
* naming rules</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3391
|
+
* <code>Bucket-name.s3express-zone-id.region-code.amazonaws.com</code>. Path-style requests are not
|
|
3392
|
+
* supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
|
|
3393
|
+
* follow the format <code>bucket-base-name--zone-id--x-s3 </code> (for example,
|
|
3394
|
+
* <code>amzn-s3-demo-bucket--usw2-az1--x-s3</code>). For information about bucket naming restrictions, see
|
|
3395
|
+
* <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>
|
|
2124
3396
|
* <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.
|
|
2125
3397
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
2126
3398
|
* @public
|
|
@@ -2137,28 +3409,27 @@ export interface RenameObjectRequest {
|
|
|
2137
3409
|
*/
|
|
2138
3410
|
RenameSource: string | undefined;
|
|
2139
3411
|
/**
|
|
2140
|
-
* <p>Renames the object only if the ETag (entity tag) value provided during the operation
|
|
2141
|
-
*
|
|
2142
|
-
*
|
|
2143
|
-
*
|
|
3412
|
+
* <p>Renames the object only if the ETag (entity tag) value provided during the operation matches the
|
|
3413
|
+
* ETag of the object in S3. The <code>If-Match</code> header field makes the request method conditional on
|
|
3414
|
+
* ETags. If the ETag values do not match, the operation returns a <code>412 Precondition Failed</code>
|
|
3415
|
+
* error.</p>
|
|
2144
3416
|
* <p>Expects the ETag value as a string.</p>
|
|
2145
3417
|
* @public
|
|
2146
3418
|
*/
|
|
2147
3419
|
DestinationIfMatch?: string | undefined;
|
|
2148
3420
|
/**
|
|
2149
|
-
* <p> Renames the object only if the destination does not already exist in the specified
|
|
2150
|
-
*
|
|
2151
|
-
*
|
|
2152
|
-
*
|
|
2153
|
-
*
|
|
2154
|
-
* key name already in your directory bucket.</p>
|
|
3421
|
+
* <p> Renames the object only if the destination does not already exist in the specified directory
|
|
3422
|
+
* bucket. If the object does exist when you send a request with <code>If-None-Match:*</code>, the S3 API
|
|
3423
|
+
* will return a <code>412 Precondition Failed</code> error, preventing an overwrite. The
|
|
3424
|
+
* <code>If-None-Match</code> header prevents overwrites of existing data by validating that there's not
|
|
3425
|
+
* an object with the same key name already in your directory bucket.</p>
|
|
2155
3426
|
* <p> Expects the <code>*</code> character (asterisk).</p>
|
|
2156
3427
|
* @public
|
|
2157
3428
|
*/
|
|
2158
3429
|
DestinationIfNoneMatch?: string | undefined;
|
|
2159
3430
|
/**
|
|
2160
|
-
* <p>Renames the object if the destination exists and if it has been modified since the
|
|
2161
|
-
*
|
|
3431
|
+
* <p>Renames the object if the destination exists and if it has been modified since the specified
|
|
3432
|
+
* time.</p>
|
|
2162
3433
|
* @public
|
|
2163
3434
|
*/
|
|
2164
3435
|
DestinationIfModifiedSince?: Date | undefined;
|
|
@@ -2168,15 +3439,15 @@ export interface RenameObjectRequest {
|
|
|
2168
3439
|
*/
|
|
2169
3440
|
DestinationIfUnmodifiedSince?: Date | undefined;
|
|
2170
3441
|
/**
|
|
2171
|
-
* <p>Renames the object if the source exists and if its entity tag (ETag) matches the
|
|
2172
|
-
*
|
|
3442
|
+
* <p>Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
|
|
3443
|
+
* </p>
|
|
2173
3444
|
* @public
|
|
2174
3445
|
*/
|
|
2175
3446
|
SourceIfMatch?: string | undefined;
|
|
2176
3447
|
/**
|
|
2177
|
-
* <p>Renames the object if the source exists and if its entity tag (ETag) is different than
|
|
2178
|
-
*
|
|
2179
|
-
*
|
|
3448
|
+
* <p>Renames the object if the source exists and if its entity tag (ETag) is different than the specified
|
|
3449
|
+
* ETag. If an asterisk (<code>*</code>) character is provided, the operation will fail and return a
|
|
3450
|
+
* <code>412 Precondition Failed</code> error. </p>
|
|
2180
3451
|
* @public
|
|
2181
3452
|
*/
|
|
2182
3453
|
SourceIfNoneMatch?: string | undefined;
|
|
@@ -2194,13 +3465,12 @@ export interface RenameObjectRequest {
|
|
|
2194
3465
|
* <p> A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.</p>
|
|
2195
3466
|
* <note>
|
|
2196
3467
|
* <p>
|
|
2197
|
-
* <code>RenameObject</code> supports idempotency using a client token. To make an
|
|
2198
|
-
*
|
|
2199
|
-
*
|
|
2200
|
-
*
|
|
2201
|
-
*
|
|
2202
|
-
*
|
|
2203
|
-
* retry fails and an <code>IdempotentParameterMismatch</code> error is returned. </p>
|
|
3468
|
+
* <code>RenameObject</code> supports idempotency using a client token. To make an idempotent API request
|
|
3469
|
+
* using <code>RenameObject</code>, specify a client token in the request. You should not reuse the same
|
|
3470
|
+
* client token for other API requests. If you retry a request that completed successfully using the same
|
|
3471
|
+
* client token and the same parameters, the retry succeeds without performing any further actions. If
|
|
3472
|
+
* you retry a successful request using the same client token, but one or more of the parameters are
|
|
3473
|
+
* different, the retry fails and an <code>IdempotentParameterMismatch</code> error is returned. </p>
|
|
2204
3474
|
* </note>
|
|
2205
3475
|
* @public
|
|
2206
3476
|
*/
|
|
@@ -2223,8 +3493,9 @@ export declare class ObjectAlreadyInActiveTierError extends __BaseException {
|
|
|
2223
3493
|
*/
|
|
2224
3494
|
export interface RestoreObjectOutput {
|
|
2225
3495
|
/**
|
|
2226
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
2227
|
-
*
|
|
3496
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
3497
|
+
* 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
|
|
3498
|
+
* Storage Service user guide</i>.</p>
|
|
2228
3499
|
* <note>
|
|
2229
3500
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2230
3501
|
* </note>
|
|
@@ -2232,8 +3503,8 @@ export interface RestoreObjectOutput {
|
|
|
2232
3503
|
*/
|
|
2233
3504
|
RequestCharged?: RequestCharged | undefined;
|
|
2234
3505
|
/**
|
|
2235
|
-
* <p>Indicates the path in the provided S3 output location where Select results will be
|
|
2236
|
-
*
|
|
3506
|
+
* <p>Indicates the path in the provided S3 output location where Select results will be restored
|
|
3507
|
+
* to.</p>
|
|
2237
3508
|
* @public
|
|
2238
3509
|
*/
|
|
2239
3510
|
RestoreOutputPath?: string | undefined;
|
|
@@ -2268,22 +3539,22 @@ export interface GlacierJobParameters {
|
|
|
2268
3539
|
*/
|
|
2269
3540
|
export interface Encryption {
|
|
2270
3541
|
/**
|
|
2271
|
-
* <p>The server-side encryption algorithm used when storing job results in Amazon S3 (for example,
|
|
2272
|
-
*
|
|
3542
|
+
* <p>The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256,
|
|
3543
|
+
* <code>aws:kms</code>).</p>
|
|
2273
3544
|
* @public
|
|
2274
3545
|
*/
|
|
2275
3546
|
EncryptionType: ServerSideEncryption | undefined;
|
|
2276
3547
|
/**
|
|
2277
|
-
* <p>If the encryption type is <code>aws:kms</code>, this optional value specifies the ID of
|
|
2278
|
-
*
|
|
2279
|
-
*
|
|
2280
|
-
*
|
|
3548
|
+
* <p>If the encryption type is <code>aws:kms</code>, this optional value specifies the ID of the
|
|
3549
|
+
* symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric
|
|
3550
|
+
* 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
|
|
3551
|
+
* <i>Amazon Web Services Key Management Service Developer Guide</i>.</p>
|
|
2281
3552
|
* @public
|
|
2282
3553
|
*/
|
|
2283
3554
|
KMSKeyId?: string | undefined;
|
|
2284
3555
|
/**
|
|
2285
|
-
* <p>If the encryption type is <code>aws:kms</code>, this optional value can be used to
|
|
2286
|
-
*
|
|
3556
|
+
* <p>If the encryption type is <code>aws:kms</code>, this optional value can be used to specify the
|
|
3557
|
+
* encryption context for the restore results.</p>
|
|
2287
3558
|
* @public
|
|
2288
3559
|
*/
|
|
2289
3560
|
KMSContext?: string | undefined;
|
|
@@ -2400,7 +3671,7 @@ export declare const FileHeaderInfo: {
|
|
|
2400
3671
|
export type FileHeaderInfo = (typeof FileHeaderInfo)[keyof typeof FileHeaderInfo];
|
|
2401
3672
|
/**
|
|
2402
3673
|
* <p>Describes how an uncompressed comma-separated values (CSV)-formatted input object is
|
|
2403
|
-
*
|
|
3674
|
+
* formatted.</p>
|
|
2404
3675
|
* @public
|
|
2405
3676
|
*/
|
|
2406
3677
|
export interface CSVInput {
|
|
@@ -2413,51 +3684,50 @@ export interface CSVInput {
|
|
|
2413
3684
|
* </li>
|
|
2414
3685
|
* <li>
|
|
2415
3686
|
* <p>
|
|
2416
|
-
* <code>IGNORE</code>: First line is a header, but you can't use the header values
|
|
2417
|
-
*
|
|
2418
|
-
*
|
|
3687
|
+
* <code>IGNORE</code>: First line is a header, but you can't use the header values to indicate the
|
|
3688
|
+
* column in an expression. You can use column position (such as _1, _2, …) to indicate the column
|
|
3689
|
+
* (<code>SELECT s._1 FROM OBJECT s</code>).</p>
|
|
2419
3690
|
* </li>
|
|
2420
3691
|
* <li>
|
|
2421
3692
|
* <p>
|
|
2422
|
-
* <code>Use</code>: First line is a header, and you can use the header value to
|
|
2423
|
-
*
|
|
3693
|
+
* <code>Use</code>: First line is a header, and you can use the header value to identify a column
|
|
3694
|
+
* in an expression (<code>SELECT "name" FROM OBJECT</code>). </p>
|
|
2424
3695
|
* </li>
|
|
2425
3696
|
* </ul>
|
|
2426
3697
|
* @public
|
|
2427
3698
|
*/
|
|
2428
3699
|
FileHeaderInfo?: FileHeaderInfo | undefined;
|
|
2429
3700
|
/**
|
|
2430
|
-
* <p>A single character used to indicate that a row should be ignored when the character is
|
|
2431
|
-
*
|
|
2432
|
-
*
|
|
3701
|
+
* <p>A single character used to indicate that a row should be ignored when the character is present at
|
|
3702
|
+
* the start of that row. You can specify any character to indicate a comment line. The default character
|
|
3703
|
+
* is <code>#</code>.</p>
|
|
2433
3704
|
* <p>Default: <code>#</code>
|
|
2434
3705
|
* </p>
|
|
2435
3706
|
* @public
|
|
2436
3707
|
*/
|
|
2437
3708
|
Comments?: string | undefined;
|
|
2438
3709
|
/**
|
|
2439
|
-
* <p>A single character used for escaping the quotation mark character inside an already
|
|
2440
|
-
*
|
|
2441
|
-
* "</code>.</p>
|
|
3710
|
+
* <p>A single character used for escaping the quotation mark character inside an already escaped value.
|
|
3711
|
+
* For example, the value <code>""" a , b """</code> is parsed as <code>" a , b "</code>.</p>
|
|
2442
3712
|
* @public
|
|
2443
3713
|
*/
|
|
2444
3714
|
QuoteEscapeCharacter?: string | undefined;
|
|
2445
3715
|
/**
|
|
2446
|
-
* <p>A single character used to separate individual records in the input. Instead of the
|
|
2447
|
-
*
|
|
3716
|
+
* <p>A single character used to separate individual records in the input. Instead of the default value,
|
|
3717
|
+
* you can specify an arbitrary delimiter.</p>
|
|
2448
3718
|
* @public
|
|
2449
3719
|
*/
|
|
2450
3720
|
RecordDelimiter?: string | undefined;
|
|
2451
3721
|
/**
|
|
2452
|
-
* <p>A single character used to separate individual fields in a record. You can specify an
|
|
2453
|
-
*
|
|
3722
|
+
* <p>A single character used to separate individual fields in a record. You can specify an arbitrary
|
|
3723
|
+
* delimiter.</p>
|
|
2454
3724
|
* @public
|
|
2455
3725
|
*/
|
|
2456
3726
|
FieldDelimiter?: string | undefined;
|
|
2457
3727
|
/**
|
|
2458
|
-
* <p>A single character used for escaping when the field delimiter is part of the value. For
|
|
2459
|
-
*
|
|
2460
|
-
*
|
|
3728
|
+
* <p>A single character used for escaping when the field delimiter is part of the value. For example, if
|
|
3729
|
+
* the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, as follows: <code>" a ,
|
|
3730
|
+
* b "</code>.</p>
|
|
2461
3731
|
* <p>Type: String</p>
|
|
2462
3732
|
* <p>Default: <code>"</code>
|
|
2463
3733
|
* </p>
|
|
@@ -2467,9 +3737,8 @@ export interface CSVInput {
|
|
|
2467
3737
|
*/
|
|
2468
3738
|
QuoteCharacter?: string | undefined;
|
|
2469
3739
|
/**
|
|
2470
|
-
* <p>Specifies that CSV field values may contain quoted record delimiters and such records
|
|
2471
|
-
*
|
|
2472
|
-
* performance.</p>
|
|
3740
|
+
* <p>Specifies that CSV field values may contain quoted record delimiters and such records should be
|
|
3741
|
+
* allowed. Default value is FALSE. Setting this value to TRUE may lower performance.</p>
|
|
2473
3742
|
* @public
|
|
2474
3743
|
*/
|
|
2475
3744
|
AllowQuotedRecordDelimiter?: boolean | undefined;
|
|
@@ -2514,8 +3783,7 @@ export interface InputSerialization {
|
|
|
2514
3783
|
*/
|
|
2515
3784
|
CSV?: CSVInput | undefined;
|
|
2516
3785
|
/**
|
|
2517
|
-
* <p>Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value:
|
|
2518
|
-
* NONE.</p>
|
|
3786
|
+
* <p>Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.</p>
|
|
2519
3787
|
* @public
|
|
2520
3788
|
*/
|
|
2521
3789
|
CompressionType?: CompressionType | undefined;
|
|
@@ -2543,8 +3811,7 @@ export declare const QuoteFields: {
|
|
|
2543
3811
|
*/
|
|
2544
3812
|
export type QuoteFields = (typeof QuoteFields)[keyof typeof QuoteFields];
|
|
2545
3813
|
/**
|
|
2546
|
-
* <p>Describes how uncompressed comma-separated values (CSV)-formatted results are
|
|
2547
|
-
* formatted.</p>
|
|
3814
|
+
* <p>Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.</p>
|
|
2548
3815
|
* @public
|
|
2549
3816
|
*/
|
|
2550
3817
|
export interface CSVOutput {
|
|
@@ -2564,27 +3831,26 @@ export interface CSVOutput {
|
|
|
2564
3831
|
*/
|
|
2565
3832
|
QuoteFields?: QuoteFields | undefined;
|
|
2566
3833
|
/**
|
|
2567
|
-
* <p>The single character used for escaping the quote character inside an already escaped
|
|
2568
|
-
* value.</p>
|
|
3834
|
+
* <p>The single character used for escaping the quote character inside an already escaped value.</p>
|
|
2569
3835
|
* @public
|
|
2570
3836
|
*/
|
|
2571
3837
|
QuoteEscapeCharacter?: string | undefined;
|
|
2572
3838
|
/**
|
|
2573
|
-
* <p>A single character used to separate individual records in the output. Instead of the
|
|
2574
|
-
*
|
|
3839
|
+
* <p>A single character used to separate individual records in the output. Instead of the default value,
|
|
3840
|
+
* you can specify an arbitrary delimiter.</p>
|
|
2575
3841
|
* @public
|
|
2576
3842
|
*/
|
|
2577
3843
|
RecordDelimiter?: string | undefined;
|
|
2578
3844
|
/**
|
|
2579
3845
|
* <p>The value used to separate individual fields in a record. You can specify an arbitrary
|
|
2580
|
-
*
|
|
3846
|
+
* delimiter.</p>
|
|
2581
3847
|
* @public
|
|
2582
3848
|
*/
|
|
2583
3849
|
FieldDelimiter?: string | undefined;
|
|
2584
3850
|
/**
|
|
2585
|
-
* <p>A single character used for escaping when the field delimiter is part of the value. For
|
|
2586
|
-
*
|
|
2587
|
-
*
|
|
3851
|
+
* <p>A single character used for escaping when the field delimiter is part of the value. For example, if
|
|
3852
|
+
* the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, as follows: <code>" a ,
|
|
3853
|
+
* b "</code>.</p>
|
|
2588
3854
|
* @public
|
|
2589
3855
|
*/
|
|
2590
3856
|
QuoteCharacter?: string | undefined;
|
|
@@ -2595,8 +3861,8 @@ export interface CSVOutput {
|
|
|
2595
3861
|
*/
|
|
2596
3862
|
export interface JSONOutput {
|
|
2597
3863
|
/**
|
|
2598
|
-
* <p>The value used to separate individual records in the output. If no value is specified,
|
|
2599
|
-
*
|
|
3864
|
+
* <p>The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a
|
|
3865
|
+
* newline character ('\n').</p>
|
|
2600
3866
|
* @public
|
|
2601
3867
|
*/
|
|
2602
3868
|
RecordDelimiter?: string | undefined;
|
|
@@ -2619,12 +3885,14 @@ export interface OutputSerialization {
|
|
|
2619
3885
|
}
|
|
2620
3886
|
/**
|
|
2621
3887
|
* <important>
|
|
2622
|
-
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
|
|
3888
|
+
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
|
|
3889
|
+
* continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2623
3890
|
* </p>
|
|
2624
3891
|
* </important>
|
|
2625
3892
|
* <p>Describes the parameters for Select job types.</p>
|
|
2626
|
-
* <p>Learn <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">How to
|
|
2627
|
-
*
|
|
3893
|
+
* <p>Learn <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">How to
|
|
3894
|
+
* optimize querying your data in Amazon S3</a> using <a href="https://docs.aws.amazon.com/athena/latest/ug/what-is.html">Amazon Athena</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">S3 Object Lambda</a>, or client-side
|
|
3895
|
+
* filtering.</p>
|
|
2628
3896
|
* @public
|
|
2629
3897
|
*/
|
|
2630
3898
|
export interface SelectParameters {
|
|
@@ -2640,7 +3908,8 @@ export interface SelectParameters {
|
|
|
2640
3908
|
ExpressionType: ExpressionType | undefined;
|
|
2641
3909
|
/**
|
|
2642
3910
|
* <important>
|
|
2643
|
-
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
|
|
3911
|
+
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
|
|
3912
|
+
* continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2644
3913
|
* </p>
|
|
2645
3914
|
* </important>
|
|
2646
3915
|
* <p>The expression that is used to query the object.</p>
|
|
@@ -2671,21 +3940,22 @@ export type RestoreRequestType = (typeof RestoreRequestType)[keyof typeof Restor
|
|
|
2671
3940
|
export interface RestoreRequest {
|
|
2672
3941
|
/**
|
|
2673
3942
|
* <p>Lifetime of the active copy in days. Do not use with restores that specify
|
|
2674
|
-
*
|
|
3943
|
+
* <code>OutputLocation</code>.</p>
|
|
2675
3944
|
* <p>The Days element is required for regular restores, and must not be provided for select
|
|
2676
|
-
*
|
|
3945
|
+
* requests.</p>
|
|
2677
3946
|
* @public
|
|
2678
3947
|
*/
|
|
2679
3948
|
Days?: number | undefined;
|
|
2680
3949
|
/**
|
|
2681
|
-
* <p>S3 Glacier related parameters pertaining to this job. Do not use with restores that
|
|
2682
|
-
*
|
|
3950
|
+
* <p>S3 Glacier related parameters pertaining to this job. Do not use with restores that specify
|
|
3951
|
+
* <code>OutputLocation</code>.</p>
|
|
2683
3952
|
* @public
|
|
2684
3953
|
*/
|
|
2685
3954
|
GlacierJobParameters?: GlacierJobParameters | undefined;
|
|
2686
3955
|
/**
|
|
2687
3956
|
* <important>
|
|
2688
|
-
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
|
|
3957
|
+
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
|
|
3958
|
+
* continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2689
3959
|
* </p>
|
|
2690
3960
|
* </important>
|
|
2691
3961
|
* <p>Type of restore request.</p>
|
|
@@ -2704,7 +3974,8 @@ export interface RestoreRequest {
|
|
|
2704
3974
|
Description?: string | undefined;
|
|
2705
3975
|
/**
|
|
2706
3976
|
* <important>
|
|
2707
|
-
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
|
|
3977
|
+
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can
|
|
3978
|
+
* continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2708
3979
|
* </p>
|
|
2709
3980
|
* </important>
|
|
2710
3981
|
* <p>Describes the parameters for Select job types.</p>
|
|
@@ -2750,12 +4021,11 @@ export interface RestoreObjectRequest {
|
|
|
2750
4021
|
*/
|
|
2751
4022
|
RestoreRequest?: RestoreRequest | undefined;
|
|
2752
4023
|
/**
|
|
2753
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
2754
|
-
*
|
|
2755
|
-
*
|
|
2756
|
-
*
|
|
2757
|
-
*
|
|
2758
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4024
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
4025
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
4026
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
4027
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
4028
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2759
4029
|
* <note>
|
|
2760
4030
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2761
4031
|
* </note>
|
|
@@ -2768,8 +4038,8 @@ export interface RestoreObjectRequest {
|
|
|
2768
4038
|
* <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
|
|
2769
4039
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
2770
4040
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
2771
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
2772
|
-
*
|
|
4041
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
4042
|
+
* parameter.</p>
|
|
2773
4043
|
* @public
|
|
2774
4044
|
*/
|
|
2775
4045
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -2786,9 +4056,8 @@ export interface RestoreObjectRequest {
|
|
|
2786
4056
|
export interface ContinuationEvent {
|
|
2787
4057
|
}
|
|
2788
4058
|
/**
|
|
2789
|
-
* <p>A message that indicates the request is complete and no more messages will be sent. You
|
|
2790
|
-
*
|
|
2791
|
-
* <code>EndEvent</code>.</p>
|
|
4059
|
+
* <p>A message that indicates the request is complete and no more messages will be sent. You should not
|
|
4060
|
+
* assume that the request is complete until the client receives an <code>EndEvent</code>.</p>
|
|
2792
4061
|
* @public
|
|
2793
4062
|
*/
|
|
2794
4063
|
export interface EndEvent {
|
|
@@ -2831,12 +4100,13 @@ export interface ProgressEvent {
|
|
|
2831
4100
|
*/
|
|
2832
4101
|
export interface RecordsEvent {
|
|
2833
4102
|
/**
|
|
2834
|
-
* <p>The byte array of partial, one or more result records. S3 Select doesn't guarantee that
|
|
2835
|
-
*
|
|
2836
|
-
*
|
|
2837
|
-
*
|
|
2838
|
-
*
|
|
2839
|
-
*
|
|
4103
|
+
* <p>The byte array of partial, one or more result records. S3 Select doesn't guarantee that a record
|
|
4104
|
+
* will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might
|
|
4105
|
+
* split the same record across multiple record frames instead of aggregating the results in memory. Some
|
|
4106
|
+
* S3 clients (for example, the SDKforJava) handle this behavior by creating a
|
|
4107
|
+
* <code>ByteStream</code> out of the response by default. Other clients might not handle this behavior
|
|
4108
|
+
* by default. In those cases, you must aggregate the results on the client side and parse the
|
|
4109
|
+
* response.</p>
|
|
2840
4110
|
* @public
|
|
2841
4111
|
*/
|
|
2842
4112
|
Payload?: Uint8Array | undefined;
|
|
@@ -2974,57 +4244,54 @@ export interface SelectObjectContentOutput {
|
|
|
2974
4244
|
Payload?: AsyncIterable<SelectObjectContentEventStream> | undefined;
|
|
2975
4245
|
}
|
|
2976
4246
|
/**
|
|
2977
|
-
* <p>Container for specifying if periodic <code>QueryProgress</code> messages should be
|
|
2978
|
-
* sent.</p>
|
|
4247
|
+
* <p>Container for specifying if periodic <code>QueryProgress</code> messages should be sent.</p>
|
|
2979
4248
|
* @public
|
|
2980
4249
|
*/
|
|
2981
4250
|
export interface RequestProgress {
|
|
2982
4251
|
/**
|
|
2983
|
-
* <p>Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,
|
|
2984
|
-
*
|
|
4252
|
+
* <p>Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default
|
|
4253
|
+
* value: FALSE.</p>
|
|
2985
4254
|
* @public
|
|
2986
4255
|
*/
|
|
2987
4256
|
Enabled?: boolean | undefined;
|
|
2988
4257
|
}
|
|
2989
4258
|
/**
|
|
2990
|
-
* <p>Specifies the byte range of the object to get the records from. A record is processed
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
2993
|
-
* start and end of the range.</p>
|
|
4259
|
+
* <p>Specifies the byte range of the object to get the records from. A record is processed when its first
|
|
4260
|
+
* byte is contained by the range. This parameter is optional, but when specified, it must not be empty.
|
|
4261
|
+
* See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.</p>
|
|
2994
4262
|
* @public
|
|
2995
4263
|
*/
|
|
2996
4264
|
export interface ScanRange {
|
|
2997
4265
|
/**
|
|
2998
|
-
* <p>Specifies the start of the byte range. This parameter is optional. Valid values:
|
|
2999
|
-
*
|
|
3000
|
-
*
|
|
3001
|
-
*
|
|
3002
|
-
*
|
|
4266
|
+
* <p>Specifies the start of the byte range. This parameter is optional. Valid values: non-negative
|
|
4267
|
+
* integers. The default value is 0. If only <code>start</code> is supplied, it means scan from that point
|
|
4268
|
+
* to the end of the file. For example,
|
|
4269
|
+
* <code><scanrange><start>50</start></scanrange></code> means scan from byte 50
|
|
4270
|
+
* until the end of the file.</p>
|
|
3003
4271
|
* @public
|
|
3004
4272
|
*/
|
|
3005
4273
|
Start?: number | undefined;
|
|
3006
4274
|
/**
|
|
3007
|
-
* <p>Specifies the end of the byte range. This parameter is optional. Valid values:
|
|
3008
|
-
*
|
|
3009
|
-
*
|
|
3010
|
-
*
|
|
3011
|
-
*
|
|
3012
|
-
* last 50 bytes.</p>
|
|
4275
|
+
* <p>Specifies the end of the byte range. This parameter is optional. Valid values: non-negative
|
|
4276
|
+
* integers. The default value is one less than the size of the object being queried. If only the End
|
|
4277
|
+
* parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example,
|
|
4278
|
+
* <code><scanrange><end>50</end></scanrange></code> means scan the last 50
|
|
4279
|
+
* bytes.</p>
|
|
3013
4280
|
* @public
|
|
3014
4281
|
*/
|
|
3015
4282
|
End?: number | undefined;
|
|
3016
4283
|
}
|
|
3017
4284
|
/**
|
|
3018
4285
|
* <note>
|
|
3019
|
-
* <p>Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3
|
|
4286
|
+
* <p>Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3
|
|
4287
|
+
* Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
3020
4288
|
* </p>
|
|
3021
4289
|
* </note>
|
|
3022
|
-
* <p>Request to filter the contents of an Amazon S3 object based on a simple Structured Query
|
|
3023
|
-
*
|
|
3024
|
-
*
|
|
3025
|
-
*
|
|
3026
|
-
*
|
|
3027
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html">S3Select API Documentation</a>.</p>
|
|
4290
|
+
* <p>Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL)
|
|
4291
|
+
* statement. In the request, along with the SQL expression, you must specify a data serialization format
|
|
4292
|
+
* (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records
|
|
4293
|
+
* that match the specified SQL expression. You must also specify the data serialization format for the
|
|
4294
|
+
* response. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html">S3Select API Documentation</a>.</p>
|
|
3028
4295
|
* @public
|
|
3029
4296
|
*/
|
|
3030
4297
|
export interface SelectObjectContentRequest {
|
|
@@ -3090,28 +4357,27 @@ export interface SelectObjectContentRequest {
|
|
|
3090
4357
|
*/
|
|
3091
4358
|
OutputSerialization: OutputSerialization | undefined;
|
|
3092
4359
|
/**
|
|
3093
|
-
* <p>Specifies the byte range of the object to get the records from. A record is processed
|
|
3094
|
-
*
|
|
3095
|
-
*
|
|
3096
|
-
* start and end of the range.</p>
|
|
4360
|
+
* <p>Specifies the byte range of the object to get the records from. A record is processed when its first
|
|
4361
|
+
* byte is contained by the range. This parameter is optional, but when specified, it must not be empty.
|
|
4362
|
+
* See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.</p>
|
|
3097
4363
|
* <p>
|
|
3098
4364
|
* <code>ScanRange</code>may be used in the following ways:</p>
|
|
3099
4365
|
* <ul>
|
|
3100
4366
|
* <li>
|
|
3101
4367
|
* <p>
|
|
3102
4368
|
* <code><scanrange><start>50</start><end>100</end></scanrange></code>
|
|
3103
|
-
*
|
|
3104
|
-
*
|
|
4369
|
+
* - process only the records starting between the bytes 50 and 100 (inclusive, counting from
|
|
4370
|
+
* zero)</p>
|
|
3105
4371
|
* </li>
|
|
3106
4372
|
* <li>
|
|
3107
4373
|
* <p>
|
|
3108
|
-
* <code><scanrange><start>50</start></scanrange></code> -
|
|
3109
|
-
*
|
|
4374
|
+
* <code><scanrange><start>50</start></scanrange></code> - process only the
|
|
4375
|
+
* records starting after the byte 50</p>
|
|
3110
4376
|
* </li>
|
|
3111
4377
|
* <li>
|
|
3112
4378
|
* <p>
|
|
3113
|
-
* <code><scanrange><end>50</end></scanrange></code> -
|
|
3114
|
-
*
|
|
4379
|
+
* <code><scanrange><end>50</end></scanrange></code> - process only the
|
|
4380
|
+
* records within the last 50 bytes of the file.</p>
|
|
3115
4381
|
* </li>
|
|
3116
4382
|
* </ul>
|
|
3117
4383
|
* @public
|
|
@@ -3123,6 +4389,132 @@ export interface SelectObjectContentRequest {
|
|
|
3123
4389
|
*/
|
|
3124
4390
|
ExpectedBucketOwner?: string | undefined;
|
|
3125
4391
|
}
|
|
4392
|
+
/**
|
|
4393
|
+
* <p>
|
|
4394
|
+
* The specified updates to the S3 Metadata inventory table configuration.
|
|
4395
|
+
* </p>
|
|
4396
|
+
* @public
|
|
4397
|
+
*/
|
|
4398
|
+
export interface InventoryTableConfigurationUpdates {
|
|
4399
|
+
/**
|
|
4400
|
+
* <p>
|
|
4401
|
+
* The configuration state of the inventory table, indicating whether the inventory table is enabled
|
|
4402
|
+
* or disabled.
|
|
4403
|
+
* </p>
|
|
4404
|
+
* @public
|
|
4405
|
+
*/
|
|
4406
|
+
ConfigurationState: InventoryConfigurationState | undefined;
|
|
4407
|
+
/**
|
|
4408
|
+
* <p>
|
|
4409
|
+
* The encryption configuration for the inventory table.
|
|
4410
|
+
* </p>
|
|
4411
|
+
* @public
|
|
4412
|
+
*/
|
|
4413
|
+
EncryptionConfiguration?: MetadataTableEncryptionConfiguration | undefined;
|
|
4414
|
+
}
|
|
4415
|
+
/**
|
|
4416
|
+
* @public
|
|
4417
|
+
*/
|
|
4418
|
+
export interface UpdateBucketMetadataInventoryTableConfigurationRequest {
|
|
4419
|
+
/**
|
|
4420
|
+
* <p>
|
|
4421
|
+
* The general purpose bucket that corresponds to the metadata configuration that you want to
|
|
4422
|
+
* enable or disable an inventory table for.
|
|
4423
|
+
* </p>
|
|
4424
|
+
* <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.
|
|
4425
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
4426
|
+
* @public
|
|
4427
|
+
*/
|
|
4428
|
+
Bucket: string | undefined;
|
|
4429
|
+
/**
|
|
4430
|
+
* <p>
|
|
4431
|
+
* The <code>Content-MD5</code> header for the inventory table configuration.
|
|
4432
|
+
* </p>
|
|
4433
|
+
* @public
|
|
4434
|
+
*/
|
|
4435
|
+
ContentMD5?: string | undefined;
|
|
4436
|
+
/**
|
|
4437
|
+
* <p>
|
|
4438
|
+
* The checksum algorithm to use with your inventory table configuration.
|
|
4439
|
+
* </p>
|
|
4440
|
+
* @public
|
|
4441
|
+
*/
|
|
4442
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
4443
|
+
/**
|
|
4444
|
+
* <p>
|
|
4445
|
+
* The contents of your inventory table configuration.
|
|
4446
|
+
* </p>
|
|
4447
|
+
* @public
|
|
4448
|
+
*/
|
|
4449
|
+
InventoryTableConfiguration: InventoryTableConfigurationUpdates | undefined;
|
|
4450
|
+
/**
|
|
4451
|
+
* <p>
|
|
4452
|
+
* The expected owner of the general purpose bucket that corresponds to the metadata table
|
|
4453
|
+
* configuration that you want to enable or disable an inventory table for.
|
|
4454
|
+
* </p>
|
|
4455
|
+
* @public
|
|
4456
|
+
*/
|
|
4457
|
+
ExpectedBucketOwner?: string | undefined;
|
|
4458
|
+
}
|
|
4459
|
+
/**
|
|
4460
|
+
* <p>
|
|
4461
|
+
* The specified updates to the S3 Metadata journal table configuration.
|
|
4462
|
+
* </p>
|
|
4463
|
+
* @public
|
|
4464
|
+
*/
|
|
4465
|
+
export interface JournalTableConfigurationUpdates {
|
|
4466
|
+
/**
|
|
4467
|
+
* <p>
|
|
4468
|
+
* The journal table record expiration settings for the journal table.
|
|
4469
|
+
* </p>
|
|
4470
|
+
* @public
|
|
4471
|
+
*/
|
|
4472
|
+
RecordExpiration: RecordExpiration | undefined;
|
|
4473
|
+
}
|
|
4474
|
+
/**
|
|
4475
|
+
* @public
|
|
4476
|
+
*/
|
|
4477
|
+
export interface UpdateBucketMetadataJournalTableConfigurationRequest {
|
|
4478
|
+
/**
|
|
4479
|
+
* <p>
|
|
4480
|
+
* The general purpose bucket that corresponds to the metadata configuration that you want to
|
|
4481
|
+
* enable or disable journal table record expiration for.
|
|
4482
|
+
* </p>
|
|
4483
|
+
* <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.
|
|
4484
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
4485
|
+
* @public
|
|
4486
|
+
*/
|
|
4487
|
+
Bucket: string | undefined;
|
|
4488
|
+
/**
|
|
4489
|
+
* <p>
|
|
4490
|
+
* The <code>Content-MD5</code> header for the journal table configuration.
|
|
4491
|
+
* </p>
|
|
4492
|
+
* @public
|
|
4493
|
+
*/
|
|
4494
|
+
ContentMD5?: string | undefined;
|
|
4495
|
+
/**
|
|
4496
|
+
* <p>
|
|
4497
|
+
* The checksum algorithm to use with your journal table configuration.
|
|
4498
|
+
* </p>
|
|
4499
|
+
* @public
|
|
4500
|
+
*/
|
|
4501
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
4502
|
+
/**
|
|
4503
|
+
* <p>
|
|
4504
|
+
* The contents of your journal table configuration.
|
|
4505
|
+
* </p>
|
|
4506
|
+
* @public
|
|
4507
|
+
*/
|
|
4508
|
+
JournalTableConfiguration: JournalTableConfigurationUpdates | undefined;
|
|
4509
|
+
/**
|
|
4510
|
+
* <p>
|
|
4511
|
+
* The expected owner of the general purpose bucket that corresponds to the metadata table
|
|
4512
|
+
* configuration that you want to enable or disable journal table record expiration for.
|
|
4513
|
+
* </p>
|
|
4514
|
+
* @public
|
|
4515
|
+
*/
|
|
4516
|
+
ExpectedBucketOwner?: string | undefined;
|
|
4517
|
+
}
|
|
3126
4518
|
/**
|
|
3127
4519
|
* @public
|
|
3128
4520
|
*/
|
|
@@ -3130,7 +4522,8 @@ export interface UploadPartOutput {
|
|
|
3130
4522
|
/**
|
|
3131
4523
|
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p>
|
|
3132
4524
|
* <note>
|
|
3133
|
-
* <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
|
|
4525
|
+
* <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
|
|
4526
|
+
* encryption option is <code>aws:fsx</code>.</p>
|
|
3134
4527
|
* </note>
|
|
3135
4528
|
* @public
|
|
3136
4529
|
*/
|
|
@@ -3157,9 +4550,10 @@ export interface UploadPartOutput {
|
|
|
3157
4550
|
*/
|
|
3158
4551
|
ChecksumCRC32C?: string | undefined;
|
|
3159
4552
|
/**
|
|
3160
|
-
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3161
|
-
*
|
|
3162
|
-
*
|
|
4553
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
4554
|
+
* that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code>
|
|
4555
|
+
* checksum of the part. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
4556
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3163
4557
|
* @public
|
|
3164
4558
|
*/
|
|
3165
4559
|
ChecksumCRC64NVME?: string | undefined;
|
|
@@ -3180,8 +4574,8 @@ export interface UploadPartOutput {
|
|
|
3180
4574
|
*/
|
|
3181
4575
|
ChecksumSHA256?: string | undefined;
|
|
3182
4576
|
/**
|
|
3183
|
-
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
3184
|
-
*
|
|
4577
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the response will
|
|
4578
|
+
* include this header to confirm the encryption algorithm that's used.</p>
|
|
3185
4579
|
* <note>
|
|
3186
4580
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3187
4581
|
* </note>
|
|
@@ -3189,9 +4583,9 @@ export interface UploadPartOutput {
|
|
|
3189
4583
|
*/
|
|
3190
4584
|
SSECustomerAlgorithm?: string | undefined;
|
|
3191
4585
|
/**
|
|
3192
|
-
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
3193
|
-
*
|
|
3194
|
-
*
|
|
4586
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the response will
|
|
4587
|
+
* include this header to provide the round-trip message integrity verification of the customer-provided
|
|
4588
|
+
* encryption key.</p>
|
|
3195
4589
|
* <note>
|
|
3196
4590
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3197
4591
|
* </note>
|
|
@@ -3204,14 +4598,15 @@ export interface UploadPartOutput {
|
|
|
3204
4598
|
*/
|
|
3205
4599
|
SSEKMSKeyId?: string | undefined;
|
|
3206
4600
|
/**
|
|
3207
|
-
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
3208
|
-
*
|
|
4601
|
+
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with
|
|
4602
|
+
* Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
3209
4603
|
* @public
|
|
3210
4604
|
*/
|
|
3211
4605
|
BucketKeyEnabled?: boolean | undefined;
|
|
3212
4606
|
/**
|
|
3213
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
3214
|
-
*
|
|
4607
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
4608
|
+
* 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
|
|
4609
|
+
* Storage Service user guide</i>.</p>
|
|
3215
4610
|
* <note>
|
|
3216
4611
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3217
4612
|
* </note>
|
|
@@ -3231,8 +4626,7 @@ export interface UploadPartRequest {
|
|
|
3231
4626
|
/**
|
|
3232
4627
|
* <p>The name of the bucket to which the multipart upload was initiated.</p>
|
|
3233
4628
|
* <p>
|
|
3234
|
-
* <b>Directory buckets</b> -
|
|
3235
|
-
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
4629
|
+
* <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
3236
4630
|
* <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>
|
|
3237
4631
|
* <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
|
|
3238
4632
|
* <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -3253,15 +4647,14 @@ export interface UploadPartRequest {
|
|
|
3253
4647
|
*/
|
|
3254
4648
|
Bucket: string | undefined;
|
|
3255
4649
|
/**
|
|
3256
|
-
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be
|
|
3257
|
-
*
|
|
4650
|
+
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
|
|
4651
|
+
* automatically.</p>
|
|
3258
4652
|
* @public
|
|
3259
4653
|
*/
|
|
3260
4654
|
ContentLength?: number | undefined;
|
|
3261
4655
|
/**
|
|
3262
|
-
* <p>The Base64 encoded 128-bit MD5 digest of the part data. This parameter is auto-populated
|
|
3263
|
-
*
|
|
3264
|
-
* are specified.</p>
|
|
4656
|
+
* <p>The Base64 encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using
|
|
4657
|
+
* the command from the CLI. This parameter is required if object lock parameters are specified.</p>
|
|
3265
4658
|
* <note>
|
|
3266
4659
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3267
4660
|
* </note>
|
|
@@ -3274,10 +4667,10 @@ export interface UploadPartRequest {
|
|
|
3274
4667
|
* <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
|
|
3275
4668
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
3276
4669
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3277
|
-
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
3278
|
-
*
|
|
3279
|
-
* <p>This checksum algorithm must be the same for all parts and it match the checksum value
|
|
3280
|
-
*
|
|
4670
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code>
|
|
4671
|
+
* parameter.</p>
|
|
4672
|
+
* <p>This checksum algorithm must be the same for all parts and it match the checksum value supplied in
|
|
4673
|
+
* the <code>CreateMultipartUpload</code> request.</p>
|
|
3281
4674
|
* @public
|
|
3282
4675
|
*/
|
|
3283
4676
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
@@ -3298,9 +4691,10 @@ export interface UploadPartRequest {
|
|
|
3298
4691
|
*/
|
|
3299
4692
|
ChecksumCRC32C?: string | undefined;
|
|
3300
4693
|
/**
|
|
3301
|
-
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3302
|
-
*
|
|
3303
|
-
*
|
|
4694
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
4695
|
+
* that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code>
|
|
4696
|
+
* checksum of the part. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
4697
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3304
4698
|
* @public
|
|
3305
4699
|
*/
|
|
3306
4700
|
ChecksumCRC64NVME?: string | undefined;
|
|
@@ -3326,8 +4720,7 @@ export interface UploadPartRequest {
|
|
|
3326
4720
|
*/
|
|
3327
4721
|
Key: string | undefined;
|
|
3328
4722
|
/**
|
|
3329
|
-
* <p>Part number of part being uploaded. This is a positive integer between 1 and
|
|
3330
|
-
* 10,000.</p>
|
|
4723
|
+
* <p>Part number of part being uploaded. This is a positive integer between 1 and 10,000.</p>
|
|
3331
4724
|
* @public
|
|
3332
4725
|
*/
|
|
3333
4726
|
PartNumber: number | undefined;
|
|
@@ -3345,11 +4738,11 @@ export interface UploadPartRequest {
|
|
|
3345
4738
|
*/
|
|
3346
4739
|
SSECustomerAlgorithm?: string | undefined;
|
|
3347
4740
|
/**
|
|
3348
|
-
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
3349
|
-
*
|
|
3350
|
-
*
|
|
3351
|
-
*
|
|
3352
|
-
*
|
|
4741
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is
|
|
4742
|
+
* used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must
|
|
4743
|
+
* be appropriate for use with the algorithm specified in the
|
|
4744
|
+
* <code>x-amz-server-side-encryption-customer-algorithm header</code>. This must be the same encryption
|
|
4745
|
+
* key specified in the initiate multipart upload request.</p>
|
|
3353
4746
|
* <note>
|
|
3354
4747
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3355
4748
|
* </note>
|
|
@@ -3357,9 +4750,8 @@ export interface UploadPartRequest {
|
|
|
3357
4750
|
*/
|
|
3358
4751
|
SSECustomerKey?: string | undefined;
|
|
3359
4752
|
/**
|
|
3360
|
-
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
3361
|
-
*
|
|
3362
|
-
* without error.</p>
|
|
4753
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header
|
|
4754
|
+
* for a message integrity check to ensure that the encryption key was transmitted without error.</p>
|
|
3363
4755
|
* <note>
|
|
3364
4756
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3365
4757
|
* </note>
|
|
@@ -3367,12 +4759,11 @@ export interface UploadPartRequest {
|
|
|
3367
4759
|
*/
|
|
3368
4760
|
SSECustomerKeyMD5?: string | undefined;
|
|
3369
4761
|
/**
|
|
3370
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
3371
|
-
*
|
|
3372
|
-
*
|
|
3373
|
-
*
|
|
3374
|
-
*
|
|
3375
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4762
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
4763
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
4764
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
4765
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
4766
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3376
4767
|
* <note>
|
|
3377
4768
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3378
4769
|
* </note>
|
|
@@ -3401,40 +4792,42 @@ export interface CopyPartResult {
|
|
|
3401
4792
|
*/
|
|
3402
4793
|
LastModified?: Date | undefined;
|
|
3403
4794
|
/**
|
|
3404
|
-
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
3405
|
-
*
|
|
3406
|
-
*
|
|
3407
|
-
*
|
|
4795
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
4796
|
+
* that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum
|
|
4797
|
+
* of the part. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
4798
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3408
4799
|
* @public
|
|
3409
4800
|
*/
|
|
3410
4801
|
ChecksumCRC32?: string | undefined;
|
|
3411
4802
|
/**
|
|
3412
|
-
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
3413
|
-
*
|
|
3414
|
-
*
|
|
3415
|
-
*
|
|
4803
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
4804
|
+
* that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum
|
|
4805
|
+
* of the part. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
4806
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3416
4807
|
* @public
|
|
3417
4808
|
*/
|
|
3418
4809
|
ChecksumCRC32C?: string | undefined;
|
|
3419
4810
|
/**
|
|
3420
|
-
* <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. This checksum is present
|
|
3421
|
-
*
|
|
4811
|
+
* <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. This checksum is present if
|
|
4812
|
+
* the multipart upload request was created with the <code>CRC64NVME</code> checksum algorithm to the
|
|
4813
|
+
* 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
|
|
4814
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3422
4815
|
* @public
|
|
3423
4816
|
*/
|
|
3424
4817
|
ChecksumCRC64NVME?: string | undefined;
|
|
3425
4818
|
/**
|
|
3426
|
-
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
3427
|
-
*
|
|
3428
|
-
*
|
|
3429
|
-
*
|
|
4819
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
4820
|
+
* that was originally sent. This header specifies the Base64 encoded, 160-bit <code>SHA1</code> checksum
|
|
4821
|
+
* of the part. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
4822
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3430
4823
|
* @public
|
|
3431
4824
|
*/
|
|
3432
4825
|
ChecksumSHA1?: string | undefined;
|
|
3433
4826
|
/**
|
|
3434
|
-
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
3435
|
-
*
|
|
3436
|
-
*
|
|
3437
|
-
*
|
|
4827
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
4828
|
+
* that was originally sent. This header specifies the Base64 encoded, 256-bit <code>SHA256</code> checksum
|
|
4829
|
+
* of the part. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
4830
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3438
4831
|
* @public
|
|
3439
4832
|
*/
|
|
3440
4833
|
ChecksumSHA256?: string | undefined;
|
|
@@ -3444,8 +4837,8 @@ export interface CopyPartResult {
|
|
|
3444
4837
|
*/
|
|
3445
4838
|
export interface UploadPartCopyOutput {
|
|
3446
4839
|
/**
|
|
3447
|
-
* <p>The version of the source object that was copied, if you have enabled versioning on the
|
|
3448
|
-
*
|
|
4840
|
+
* <p>The version of the source object that was copied, if you have enabled versioning on the source
|
|
4841
|
+
* bucket.</p>
|
|
3449
4842
|
* <note>
|
|
3450
4843
|
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3451
4844
|
* </note>
|
|
@@ -3460,14 +4853,15 @@ export interface UploadPartCopyOutput {
|
|
|
3460
4853
|
/**
|
|
3461
4854
|
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p>
|
|
3462
4855
|
* <note>
|
|
3463
|
-
* <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
|
|
4856
|
+
* <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
|
|
4857
|
+
* encryption option is <code>aws:fsx</code>.</p>
|
|
3464
4858
|
* </note>
|
|
3465
4859
|
* @public
|
|
3466
4860
|
*/
|
|
3467
4861
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
3468
4862
|
/**
|
|
3469
|
-
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
3470
|
-
*
|
|
4863
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the response will
|
|
4864
|
+
* include this header to confirm the encryption algorithm that's used.</p>
|
|
3471
4865
|
* <note>
|
|
3472
4866
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3473
4867
|
* </note>
|
|
@@ -3475,9 +4869,9 @@ export interface UploadPartCopyOutput {
|
|
|
3475
4869
|
*/
|
|
3476
4870
|
SSECustomerAlgorithm?: string | undefined;
|
|
3477
4871
|
/**
|
|
3478
|
-
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
3479
|
-
*
|
|
3480
|
-
*
|
|
4872
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the response will
|
|
4873
|
+
* include this header to provide the round-trip message integrity verification of the customer-provided
|
|
4874
|
+
* encryption key.</p>
|
|
3481
4875
|
* <note>
|
|
3482
4876
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3483
4877
|
* </note>
|
|
@@ -3490,14 +4884,15 @@ export interface UploadPartCopyOutput {
|
|
|
3490
4884
|
*/
|
|
3491
4885
|
SSEKMSKeyId?: string | undefined;
|
|
3492
4886
|
/**
|
|
3493
|
-
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
3494
|
-
*
|
|
4887
|
+
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with
|
|
4888
|
+
* Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
3495
4889
|
* @public
|
|
3496
4890
|
*/
|
|
3497
4891
|
BucketKeyEnabled?: boolean | undefined;
|
|
3498
4892
|
/**
|
|
3499
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
3500
|
-
*
|
|
4893
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
4894
|
+
* 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
|
|
4895
|
+
* Storage Service user guide</i>.</p>
|
|
3501
4896
|
* <note>
|
|
3502
4897
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3503
4898
|
* </note>
|
|
@@ -3519,8 +4914,10 @@ export interface UploadPartCopyRequest {
|
|
|
3519
4914
|
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
|
|
3520
4915
|
* rules</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3521
4916
|
* <note>
|
|
3522
|
-
* <p>Copying objects across different Amazon Web Services Regions isn't supported when the source or destination
|
|
3523
|
-
*
|
|
4917
|
+
* <p>Copying objects across different Amazon Web Services Regions isn't supported when the source or destination
|
|
4918
|
+
* bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region.
|
|
4919
|
+
* Otherwise, you get an HTTP <code>400 Bad Request</code> error with the error code
|
|
4920
|
+
* <code>InvalidRequest</code>.</p>
|
|
3524
4921
|
* </note>
|
|
3525
4922
|
* <p>
|
|
3526
4923
|
* <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>
|
|
@@ -3537,15 +4934,14 @@ export interface UploadPartCopyRequest {
|
|
|
3537
4934
|
*/
|
|
3538
4935
|
Bucket: string | undefined;
|
|
3539
4936
|
/**
|
|
3540
|
-
* <p>Specifies the source object for the copy operation. You specify the value in one of two
|
|
3541
|
-
*
|
|
4937
|
+
* <p>Specifies the source object for the copy operation. You specify the value in one of two formats,
|
|
4938
|
+
* depending on whether you want to access the source object through an <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">access point</a>:</p>
|
|
3542
4939
|
* <ul>
|
|
3543
4940
|
* <li>
|
|
3544
|
-
* <p>For objects not accessed through an access point, specify the name of the source bucket
|
|
3545
|
-
*
|
|
3546
|
-
*
|
|
3547
|
-
*
|
|
3548
|
-
* The value must be URL-encoded.</p>
|
|
4941
|
+
* <p>For objects not accessed through an access point, specify the name of the source bucket and key of the
|
|
4942
|
+
* source object, separated by a slash (/). For example, to copy the object
|
|
4943
|
+
* <code>reports/january.pdf</code> from the bucket <code>awsexamplebucket</code>, use
|
|
4944
|
+
* <code>awsexamplebucket/reports/january.pdf</code>. The value must be URL-encoded.</p>
|
|
3549
4945
|
* </li>
|
|
3550
4946
|
* <li>
|
|
3551
4947
|
* <p>For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded.</p>
|
|
@@ -3562,22 +4958,19 @@ export interface UploadPartCopyRequest {
|
|
|
3562
4958
|
* <p>Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL-encoded. </p>
|
|
3563
4959
|
* </li>
|
|
3564
4960
|
* </ul>
|
|
3565
|
-
* <p>If your bucket has versioning enabled, you could have multiple versions of the same
|
|
3566
|
-
*
|
|
3567
|
-
*
|
|
3568
|
-
*
|
|
3569
|
-
*
|
|
3570
|
-
* /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). </p>
|
|
4961
|
+
* <p>If your bucket has versioning enabled, you could have multiple versions of the same object. By
|
|
4962
|
+
* default, <code>x-amz-copy-source</code> identifies the current version of the source object to copy. To
|
|
4963
|
+
* copy a specific version of the source object to copy, append <code>?versionId=<version-id></code> to
|
|
4964
|
+
* the <code>x-amz-copy-source</code> request header (for example, <code>x-amz-copy-source:
|
|
4965
|
+
* /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). </p>
|
|
3571
4966
|
* <p>If the current version is a delete marker and you don't specify a versionId in the
|
|
3572
|
-
*
|
|
3573
|
-
*
|
|
3574
|
-
*
|
|
3575
|
-
*
|
|
3576
|
-
* marker as a version for the <code>x-amz-copy-source</code>. </p>
|
|
4967
|
+
* <code>x-amz-copy-source</code> request header, Amazon S3 returns a <code>404 Not Found</code> error,
|
|
4968
|
+
* because the object does not exist. If you specify versionId in the <code>x-amz-copy-source</code> and
|
|
4969
|
+
* the versionId is a delete marker, Amazon S3 returns an HTTP <code>400 Bad Request</code> error, because you
|
|
4970
|
+
* are not allowed to specify a delete marker as a version for the <code>x-amz-copy-source</code>. </p>
|
|
3577
4971
|
* <note>
|
|
3578
4972
|
* <p>
|
|
3579
|
-
* <b>Directory buckets</b> -
|
|
3580
|
-
* S3 Versioning isn't enabled and supported for directory buckets.</p>
|
|
4973
|
+
* <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets.</p>
|
|
3581
4974
|
* </note>
|
|
3582
4975
|
* @public
|
|
3583
4976
|
*/
|
|
@@ -3585,72 +4978,62 @@ export interface UploadPartCopyRequest {
|
|
|
3585
4978
|
/**
|
|
3586
4979
|
* <p>Copies the object if its entity tag (ETag) matches the specified tag.</p>
|
|
3587
4980
|
* <p>If both of the <code>x-amz-copy-source-if-match</code> and
|
|
3588
|
-
*
|
|
3589
|
-
*
|
|
4981
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as
|
|
4982
|
+
* follows:</p>
|
|
3590
4983
|
* <p>
|
|
3591
|
-
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
|
|
3592
|
-
* and;</p>
|
|
4984
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, and;</p>
|
|
3593
4985
|
* <p>
|
|
3594
|
-
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
|
|
3595
|
-
* <code>false</code>;</p>
|
|
4986
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to <code>false</code>;</p>
|
|
3596
4987
|
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
3597
|
-
*
|
|
4988
|
+
* </p>
|
|
3598
4989
|
* @public
|
|
3599
4990
|
*/
|
|
3600
4991
|
CopySourceIfMatch?: string | undefined;
|
|
3601
4992
|
/**
|
|
3602
4993
|
* <p>Copies the object if it has been modified since the specified time.</p>
|
|
3603
4994
|
* <p>If both of the <code>x-amz-copy-source-if-none-match</code> and
|
|
3604
|
-
*
|
|
3605
|
-
* follows:</p>
|
|
4995
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as follows:</p>
|
|
3606
4996
|
* <p>
|
|
3607
|
-
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>,
|
|
3608
|
-
* and;</p>
|
|
4997
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>, and;</p>
|
|
3609
4998
|
* <p>
|
|
3610
|
-
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
|
|
3611
|
-
* <code>true</code>;</p>
|
|
4999
|
+
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to <code>true</code>;</p>
|
|
3612
5000
|
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
|
|
3613
|
-
*
|
|
5001
|
+
* </p>
|
|
3614
5002
|
* @public
|
|
3615
5003
|
*/
|
|
3616
5004
|
CopySourceIfModifiedSince?: Date | undefined;
|
|
3617
5005
|
/**
|
|
3618
5006
|
* <p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>
|
|
3619
5007
|
* <p>If both of the <code>x-amz-copy-source-if-none-match</code> and
|
|
3620
|
-
*
|
|
3621
|
-
* follows:</p>
|
|
5008
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as follows:</p>
|
|
3622
5009
|
* <p>
|
|
3623
|
-
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>,
|
|
3624
|
-
* and;</p>
|
|
5010
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>, and;</p>
|
|
3625
5011
|
* <p>
|
|
3626
|
-
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
|
|
3627
|
-
* <code>true</code>;</p>
|
|
5012
|
+
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to <code>true</code>;</p>
|
|
3628
5013
|
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
|
|
3629
|
-
*
|
|
5014
|
+
* </p>
|
|
3630
5015
|
* @public
|
|
3631
5016
|
*/
|
|
3632
5017
|
CopySourceIfNoneMatch?: string | undefined;
|
|
3633
5018
|
/**
|
|
3634
5019
|
* <p>Copies the object if it hasn't been modified since the specified time.</p>
|
|
3635
5020
|
* <p>If both of the <code>x-amz-copy-source-if-match</code> and
|
|
3636
|
-
*
|
|
3637
|
-
*
|
|
5021
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as
|
|
5022
|
+
* follows:</p>
|
|
3638
5023
|
* <p>
|
|
3639
|
-
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
|
|
3640
|
-
* and;</p>
|
|
5024
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, and;</p>
|
|
3641
5025
|
* <p>
|
|
3642
|
-
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
|
|
3643
|
-
* <code>false</code>;</p>
|
|
5026
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to <code>false</code>;</p>
|
|
3644
5027
|
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
3645
|
-
*
|
|
5028
|
+
* </p>
|
|
3646
5029
|
* @public
|
|
3647
5030
|
*/
|
|
3648
5031
|
CopySourceIfUnmodifiedSince?: Date | undefined;
|
|
3649
5032
|
/**
|
|
3650
5033
|
* <p>The range of bytes to copy from the source object. The range value must use the form
|
|
3651
|
-
*
|
|
3652
|
-
*
|
|
3653
|
-
*
|
|
5034
|
+
* bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example,
|
|
5035
|
+
* bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if
|
|
5036
|
+
* the source object is greater than 5 MB.</p>
|
|
3654
5037
|
* @public
|
|
3655
5038
|
*/
|
|
3656
5039
|
CopySourceRange?: string | undefined;
|
|
@@ -3660,8 +5043,7 @@ export interface UploadPartCopyRequest {
|
|
|
3660
5043
|
*/
|
|
3661
5044
|
Key: string | undefined;
|
|
3662
5045
|
/**
|
|
3663
|
-
* <p>Part number of part being copied. This is a positive integer between 1 and
|
|
3664
|
-
* 10,000.</p>
|
|
5046
|
+
* <p>Part number of part being copied. This is a positive integer between 1 and 10,000.</p>
|
|
3665
5047
|
* @public
|
|
3666
5048
|
*/
|
|
3667
5049
|
PartNumber: number | undefined;
|
|
@@ -3679,11 +5061,11 @@ export interface UploadPartCopyRequest {
|
|
|
3679
5061
|
*/
|
|
3680
5062
|
SSECustomerAlgorithm?: string | undefined;
|
|
3681
5063
|
/**
|
|
3682
|
-
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
3683
|
-
*
|
|
3684
|
-
*
|
|
3685
|
-
*
|
|
3686
|
-
*
|
|
5064
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is
|
|
5065
|
+
* used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must
|
|
5066
|
+
* be appropriate for use with the algorithm specified in the
|
|
5067
|
+
* <code>x-amz-server-side-encryption-customer-algorithm</code> header. This must be the same encryption
|
|
5068
|
+
* key specified in the initiate multipart upload request.</p>
|
|
3687
5069
|
* <note>
|
|
3688
5070
|
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
3689
5071
|
* </note>
|
|
@@ -3691,9 +5073,8 @@ export interface UploadPartCopyRequest {
|
|
|
3691
5073
|
*/
|
|
3692
5074
|
SSECustomerKey?: string | undefined;
|
|
3693
5075
|
/**
|
|
3694
|
-
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
3695
|
-
*
|
|
3696
|
-
* without error.</p>
|
|
5076
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header
|
|
5077
|
+
* for a message integrity check to ensure that the encryption key was transmitted without error.</p>
|
|
3697
5078
|
* <note>
|
|
3698
5079
|
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
3699
5080
|
* </note>
|
|
@@ -3702,7 +5083,7 @@ export interface UploadPartCopyRequest {
|
|
|
3702
5083
|
SSECustomerKeyMD5?: string | undefined;
|
|
3703
5084
|
/**
|
|
3704
5085
|
* <p>Specifies the algorithm to use when decrypting the source object (for example,
|
|
3705
|
-
*
|
|
5086
|
+
* <code>AES256</code>).</p>
|
|
3706
5087
|
* <note>
|
|
3707
5088
|
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3708
5089
|
* </note>
|
|
@@ -3710,9 +5091,9 @@ export interface UploadPartCopyRequest {
|
|
|
3710
5091
|
*/
|
|
3711
5092
|
CopySourceSSECustomerAlgorithm?: string | undefined;
|
|
3712
5093
|
/**
|
|
3713
|
-
* <p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source
|
|
3714
|
-
*
|
|
3715
|
-
*
|
|
5094
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The
|
|
5095
|
+
* encryption key provided in this header must be one that was used when the source object was
|
|
5096
|
+
* created.</p>
|
|
3716
5097
|
* <note>
|
|
3717
5098
|
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3718
5099
|
* </note>
|
|
@@ -3720,9 +5101,8 @@ export interface UploadPartCopyRequest {
|
|
|
3720
5101
|
*/
|
|
3721
5102
|
CopySourceSSECustomerKey?: string | undefined;
|
|
3722
5103
|
/**
|
|
3723
|
-
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
3724
|
-
*
|
|
3725
|
-
* without error.</p>
|
|
5104
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header
|
|
5105
|
+
* for a message integrity check to ensure that the encryption key was transmitted without error.</p>
|
|
3726
5106
|
* <note>
|
|
3727
5107
|
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3728
5108
|
* </note>
|
|
@@ -3730,12 +5110,11 @@ export interface UploadPartCopyRequest {
|
|
|
3730
5110
|
*/
|
|
3731
5111
|
CopySourceSSECustomerKeyMD5?: string | undefined;
|
|
3732
5112
|
/**
|
|
3733
|
-
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
3734
|
-
*
|
|
3735
|
-
*
|
|
3736
|
-
*
|
|
3737
|
-
*
|
|
3738
|
-
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5113
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not
|
|
5114
|
+
* specify this parameter in their requests. If either the source or destination S3 bucket has Requester
|
|
5115
|
+
* Pays enabled, the requester will pay for corresponding charges to copy the object. For information about
|
|
5116
|
+
* downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays
|
|
5117
|
+
* Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3739
5118
|
* <note>
|
|
3740
5119
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3741
5120
|
* </note>
|
|
@@ -3763,8 +5142,8 @@ export interface WriteGetObjectResponseRequest {
|
|
|
3763
5142
|
*/
|
|
3764
5143
|
RequestRoute: string | undefined;
|
|
3765
5144
|
/**
|
|
3766
|
-
* <p>A single use encrypted token that maps <code>WriteGetObjectResponse</code> to the end
|
|
3767
|
-
*
|
|
5145
|
+
* <p>A single use encrypted token that maps <code>WriteGetObjectResponse</code> to the end user
|
|
5146
|
+
* <code>GetObject</code> request.</p>
|
|
3768
5147
|
* @public
|
|
3769
5148
|
*/
|
|
3770
5149
|
RequestToken: string | undefined;
|
|
@@ -3774,8 +5153,8 @@ export interface WriteGetObjectResponseRequest {
|
|
|
3774
5153
|
*/
|
|
3775
5154
|
Body?: StreamingBlobTypes | undefined;
|
|
3776
5155
|
/**
|
|
3777
|
-
* <p>The integer status code for an HTTP response of a corresponding <code>GetObject</code>
|
|
3778
|
-
*
|
|
5156
|
+
* <p>The integer status code for an HTTP response of a corresponding <code>GetObject</code> request. The
|
|
5157
|
+
* following is a list of status codes.</p>
|
|
3779
5158
|
* <ul>
|
|
3780
5159
|
* <li>
|
|
3781
5160
|
* <p>
|
|
@@ -3852,19 +5231,18 @@ export interface WriteGetObjectResponseRequest {
|
|
|
3852
5231
|
*/
|
|
3853
5232
|
StatusCode?: number | undefined;
|
|
3854
5233
|
/**
|
|
3855
|
-
* <p>A string that uniquely identifies an error condition. Returned in the <Code> tag
|
|
3856
|
-
*
|
|
3857
|
-
*
|
|
3858
|
-
*
|
|
3859
|
-
*
|
|
5234
|
+
* <p>A string that uniquely identifies an error condition. Returned in the <Code> tag of the error
|
|
5235
|
+
* XML response for a corresponding <code>GetObject</code> call. Cannot be used with a successful
|
|
5236
|
+
* <code>StatusCode</code> header or when the transformed object is provided in the body. All error codes
|
|
5237
|
+
* from S3 are sentence-cased. The regular expression (regex) value is
|
|
5238
|
+
* <code>"^[A-Z][a-zA-Z]+$"</code>.</p>
|
|
3860
5239
|
* @public
|
|
3861
5240
|
*/
|
|
3862
5241
|
ErrorCode?: string | undefined;
|
|
3863
5242
|
/**
|
|
3864
|
-
* <p>Contains a generic description of the error condition. Returned in the <Message>
|
|
3865
|
-
*
|
|
3866
|
-
*
|
|
3867
|
-
* provided in body.</p>
|
|
5243
|
+
* <p>Contains a generic description of the error condition. Returned in the <Message> tag of the
|
|
5244
|
+
* error XML response for a corresponding <code>GetObject</code> call. Cannot be used with a successful
|
|
5245
|
+
* <code>StatusCode</code> header or when the transformed object is provided in body.</p>
|
|
3868
5246
|
* @public
|
|
3869
5247
|
*/
|
|
3870
5248
|
ErrorMessage?: string | undefined;
|
|
@@ -3884,9 +5262,8 @@ export interface WriteGetObjectResponseRequest {
|
|
|
3884
5262
|
*/
|
|
3885
5263
|
ContentDisposition?: string | undefined;
|
|
3886
5264
|
/**
|
|
3887
|
-
* <p>Specifies what content encodings have been applied to the object and thus what decoding
|
|
3888
|
-
*
|
|
3889
|
-
* field.</p>
|
|
5265
|
+
* <p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms
|
|
5266
|
+
* must be applied to obtain the media-type referenced by the Content-Type header field.</p>
|
|
3890
5267
|
* @public
|
|
3891
5268
|
*/
|
|
3892
5269
|
ContentEncoding?: string | undefined;
|
|
@@ -3911,74 +5288,71 @@ export interface WriteGetObjectResponseRequest {
|
|
|
3911
5288
|
*/
|
|
3912
5289
|
ContentType?: string | undefined;
|
|
3913
5290
|
/**
|
|
3914
|
-
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3915
|
-
*
|
|
3916
|
-
*
|
|
3917
|
-
*
|
|
3918
|
-
*
|
|
3919
|
-
*
|
|
3920
|
-
*
|
|
3921
|
-
*
|
|
3922
|
-
* headers, this request will fail.</p>
|
|
5291
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
5292
|
+
* that was originally sent. This specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the
|
|
5293
|
+
* object returned by the Object Lambda function. This may not match the checksum for the object stored in
|
|
5294
|
+
* Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code>
|
|
5295
|
+
* request required checksum validation. For more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
5296
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5297
|
+
* <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this
|
|
5298
|
+
* request will fail.</p>
|
|
3923
5299
|
* <p></p>
|
|
3924
5300
|
* @public
|
|
3925
5301
|
*/
|
|
3926
5302
|
ChecksumCRC32?: string | undefined;
|
|
3927
5303
|
/**
|
|
3928
|
-
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3929
|
-
*
|
|
3930
|
-
*
|
|
3931
|
-
*
|
|
3932
|
-
*
|
|
3933
|
-
*
|
|
3934
|
-
*
|
|
3935
|
-
*
|
|
3936
|
-
* headers, this request will fail.</p>
|
|
5304
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
5305
|
+
* that was originally sent. This specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the
|
|
5306
|
+
* object returned by the Object Lambda function. This may not match the checksum for the object stored in
|
|
5307
|
+
* Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code>
|
|
5308
|
+
* request required checksum validation. For more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
5309
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5310
|
+
* <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this
|
|
5311
|
+
* request will fail.</p>
|
|
3937
5312
|
* @public
|
|
3938
5313
|
*/
|
|
3939
5314
|
ChecksumCRC32C?: string | undefined;
|
|
3940
5315
|
/**
|
|
3941
|
-
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3942
|
-
*
|
|
3943
|
-
*
|
|
5316
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
5317
|
+
* that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code>
|
|
5318
|
+
* checksum of the part. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
5319
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3944
5320
|
* @public
|
|
3945
5321
|
*/
|
|
3946
5322
|
ChecksumCRC64NVME?: string | undefined;
|
|
3947
5323
|
/**
|
|
3948
|
-
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3949
|
-
*
|
|
3950
|
-
*
|
|
3951
|
-
*
|
|
3952
|
-
*
|
|
3953
|
-
*
|
|
3954
|
-
*
|
|
3955
|
-
*
|
|
3956
|
-
* headers, this request will fail.</p>
|
|
5324
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
5325
|
+
* that was originally sent. This specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the
|
|
5326
|
+
* object returned by the Object Lambda function. This may not match the checksum for the object stored in
|
|
5327
|
+
* Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code>
|
|
5328
|
+
* request required checksum validation. For more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
5329
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5330
|
+
* <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this
|
|
5331
|
+
* request will fail.</p>
|
|
3957
5332
|
* @public
|
|
3958
5333
|
*/
|
|
3959
5334
|
ChecksumSHA1?: string | undefined;
|
|
3960
5335
|
/**
|
|
3961
|
-
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3962
|
-
*
|
|
3963
|
-
*
|
|
3964
|
-
*
|
|
3965
|
-
*
|
|
3966
|
-
*
|
|
3967
|
-
*
|
|
3968
|
-
*
|
|
3969
|
-
* headers, this request will fail.</p>
|
|
5336
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data
|
|
5337
|
+
* that was originally sent. This specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the
|
|
5338
|
+
* object returned by the Object Lambda function. This may not match the checksum for the object stored in
|
|
5339
|
+
* Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code>
|
|
5340
|
+
* request required checksum validation. For more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
5341
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5342
|
+
* <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this
|
|
5343
|
+
* request will fail.</p>
|
|
3970
5344
|
* @public
|
|
3971
5345
|
*/
|
|
3972
5346
|
ChecksumSHA256?: string | undefined;
|
|
3973
5347
|
/**
|
|
3974
|
-
* <p>Specifies whether an object stored in Amazon S3 is (<code>true</code>) or is not
|
|
3975
|
-
*
|
|
5348
|
+
* <p>Specifies whether an object stored in Amazon S3 is (<code>true</code>) or is not (<code>false</code>) a
|
|
5349
|
+
* delete marker. To learn more about delete markers, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html">Working with delete markers</a>.</p>
|
|
3976
5350
|
* @public
|
|
3977
5351
|
*/
|
|
3978
5352
|
DeleteMarker?: boolean | undefined;
|
|
3979
5353
|
/**
|
|
3980
|
-
* <p>An opaque identifier assigned by a web server to a specific version of a resource found
|
|
3981
|
-
*
|
|
5354
|
+
* <p>An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
|
|
5355
|
+
* </p>
|
|
3982
5356
|
* @public
|
|
3983
5357
|
*/
|
|
3984
5358
|
ETag?: string | undefined;
|
|
@@ -3988,10 +5362,9 @@ export interface WriteGetObjectResponseRequest {
|
|
|
3988
5362
|
*/
|
|
3989
5363
|
Expires?: Date | undefined;
|
|
3990
5364
|
/**
|
|
3991
|
-
* <p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes
|
|
3992
|
-
*
|
|
3993
|
-
*
|
|
3994
|
-
* is URL-encoded. </p>
|
|
5365
|
+
* <p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this
|
|
5366
|
+
* header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs that provide
|
|
5367
|
+
* the object expiration information. The value of the <code>rule-id</code> is URL-encoded. </p>
|
|
3995
5368
|
* @public
|
|
3996
5369
|
*/
|
|
3997
5370
|
Expiration?: string | undefined;
|
|
@@ -4001,10 +5374,9 @@ export interface WriteGetObjectResponseRequest {
|
|
|
4001
5374
|
*/
|
|
4002
5375
|
LastModified?: Date | undefined;
|
|
4003
5376
|
/**
|
|
4004
|
-
* <p>Set to the number of metadata entries not returned in <code>x-amz-meta</code> headers.
|
|
4005
|
-
*
|
|
4006
|
-
*
|
|
4007
|
-
* are not legal HTTP headers.</p>
|
|
5377
|
+
* <p>Set to the number of metadata entries not returned in <code>x-amz-meta</code> headers. This can
|
|
5378
|
+
* happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST
|
|
5379
|
+
* API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.</p>
|
|
4008
5380
|
* @public
|
|
4009
5381
|
*/
|
|
4010
5382
|
MissingMeta?: number | undefined;
|
|
@@ -4014,8 +5386,9 @@ export interface WriteGetObjectResponseRequest {
|
|
|
4014
5386
|
*/
|
|
4015
5387
|
Metadata?: Record<string, string> | undefined;
|
|
4016
5388
|
/**
|
|
4017
|
-
* <p>Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information
|
|
4018
|
-
*
|
|
5389
|
+
* <p>Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3
|
|
5390
|
+
* Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html">Object
|
|
5391
|
+
* Lock</a>.</p>
|
|
4019
5392
|
* @public
|
|
4020
5393
|
*/
|
|
4021
5394
|
ObjectLockMode?: ObjectLockMode | undefined;
|
|
@@ -4035,14 +5408,15 @@ export interface WriteGetObjectResponseRequest {
|
|
|
4035
5408
|
*/
|
|
4036
5409
|
PartsCount?: number | undefined;
|
|
4037
5410
|
/**
|
|
4038
|
-
* <p>Indicates if request involves bucket that is either a source or destination in a
|
|
4039
|
-
*
|
|
5411
|
+
* <p>Indicates if request involves bucket that is either a source or destination in a Replication rule.
|
|
5412
|
+
* For more information about S3 Replication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html">Replication</a>.</p>
|
|
4040
5413
|
* @public
|
|
4041
5414
|
*/
|
|
4042
5415
|
ReplicationStatus?: ReplicationStatus | undefined;
|
|
4043
5416
|
/**
|
|
4044
|
-
* <p>If present, indicates that the requester was successfully charged for the
|
|
4045
|
-
*
|
|
5417
|
+
* <p>If present, indicates that the requester was successfully charged for the request. For more
|
|
5418
|
+
* 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
|
|
5419
|
+
* Storage Service user guide</i>.</p>
|
|
4046
5420
|
* <note>
|
|
4047
5421
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
4048
5422
|
* </note>
|
|
@@ -4050,43 +5424,42 @@ export interface WriteGetObjectResponseRequest {
|
|
|
4050
5424
|
*/
|
|
4051
5425
|
RequestCharged?: RequestCharged | undefined;
|
|
4052
5426
|
/**
|
|
4053
|
-
* <p>Provides information about object restoration operation and expiration time of the
|
|
4054
|
-
*
|
|
5427
|
+
* <p>Provides information about object restoration operation and expiration time of the restored object
|
|
5428
|
+
* copy.</p>
|
|
4055
5429
|
* @public
|
|
4056
5430
|
*/
|
|
4057
5431
|
Restore?: string | undefined;
|
|
4058
5432
|
/**
|
|
4059
5433
|
* <p> The server-side encryption algorithm used when storing requested object in Amazon S3 or Amazon FSx.</p>
|
|
4060
5434
|
* <note>
|
|
4061
|
-
* <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
|
|
5435
|
+
* <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
|
|
5436
|
+
* encryption option is <code>aws:fsx</code>.</p>
|
|
4062
5437
|
* </note>
|
|
4063
5438
|
* @public
|
|
4064
5439
|
*/
|
|
4065
5440
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
4066
5441
|
/**
|
|
4067
|
-
* <p>Encryption algorithm used if server-side encryption with a customer-provided encryption
|
|
4068
|
-
*
|
|
5442
|
+
* <p>Encryption algorithm used if server-side encryption with a customer-provided encryption key was
|
|
5443
|
+
* specified for object stored in Amazon S3.</p>
|
|
4069
5444
|
* @public
|
|
4070
5445
|
*/
|
|
4071
5446
|
SSECustomerAlgorithm?: string | undefined;
|
|
4072
5447
|
/**
|
|
4073
|
-
* <p> If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key
|
|
4074
|
-
*
|
|
4075
|
-
* Amazon S3 object. </p>
|
|
5448
|
+
* <p> If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service
|
|
5449
|
+
* (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object. </p>
|
|
4076
5450
|
* @public
|
|
4077
5451
|
*/
|
|
4078
5452
|
SSEKMSKeyId?: string | undefined;
|
|
4079
5453
|
/**
|
|
4080
|
-
* <p> 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data
|
|
4081
|
-
*
|
|
4082
|
-
*
|
|
4083
|
-
* (SSE-C)</a>.</p>
|
|
5454
|
+
* <p> 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3.
|
|
5455
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html">Protecting data using
|
|
5456
|
+
* server-side encryption with customer-provided encryption keys (SSE-C)</a>.</p>
|
|
4084
5457
|
* @public
|
|
4085
5458
|
*/
|
|
4086
5459
|
SSECustomerKeyMD5?: string | undefined;
|
|
4087
5460
|
/**
|
|
4088
|
-
* <p>Provides storage class information of the object. Amazon S3 returns this header for all
|
|
4089
|
-
*
|
|
5461
|
+
* <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except
|
|
5462
|
+
* for S3 Standard storage class objects.</p>
|
|
4090
5463
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p>
|
|
4091
5464
|
* @public
|
|
4092
5465
|
*/
|
|
@@ -4102,12 +5475,16 @@ export interface WriteGetObjectResponseRequest {
|
|
|
4102
5475
|
*/
|
|
4103
5476
|
VersionId?: string | undefined;
|
|
4104
5477
|
/**
|
|
4105
|
-
* <p> Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side
|
|
4106
|
-
*
|
|
5478
|
+
* <p> Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with
|
|
5479
|
+
* Amazon Web Services KMS (SSE-KMS).</p>
|
|
4107
5480
|
* @public
|
|
4108
5481
|
*/
|
|
4109
5482
|
BucketKeyEnabled?: boolean | undefined;
|
|
4110
5483
|
}
|
|
5484
|
+
/**
|
|
5485
|
+
* @internal
|
|
5486
|
+
*/
|
|
5487
|
+
export declare const ListPartsRequestFilterSensitiveLog: (obj: ListPartsRequest) => any;
|
|
4111
5488
|
/**
|
|
4112
5489
|
* @internal
|
|
4113
5490
|
*/
|