@aws-sdk/client-s3 3.697.0 → 3.698.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +152 -5
- package/dist-es/models/models_1.js +48 -0
- package/dist-es/protocols/Aws_restXml.js +75 -4
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +16 -13
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +47 -42
- package/dist-types/commands/CopyObjectCommand.d.ts +77 -57
- package/dist-types/commands/CreateBucketCommand.d.ts +60 -45
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +92 -66
- package/dist-types/commands/CreateSessionCommand.d.ts +30 -16
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketCommand.d.ts +10 -3
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +18 -10
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +52 -9
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +25 -21
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/DeleteObjectCommand.d.ts +3 -0
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteObjectsCommand.d.ts +41 -27
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAclCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +18 -10
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +61 -17
- package/dist-types/commands/GetBucketLocationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +30 -21
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectAclCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +62 -44
- package/dist-types/commands/GetObjectCommand.d.ts +79 -60
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +1 -1
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/HeadBucketCommand.d.ts +32 -16
- package/dist-types/commands/HeadObjectCommand.d.ts +60 -38
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketsCommand.d.ts +6 -6
- package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +10 -4
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +50 -33
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListObjectsCommand.d.ts +1 -1
- package/dist-types/commands/ListObjectsV2Command.d.ts +23 -14
- package/dist-types/commands/ListPartsCommand.d.ts +22 -17
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketAclCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +47 -32
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +84 -45
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +30 -21
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +3 -4
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +3 -6
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectAclCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectCommand.d.ts +83 -35
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +2 -2
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +1 -1
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/RestoreObjectCommand.d.ts +1 -1
- package/dist-types/commands/SelectObjectContentCommand.d.ts +1 -1
- package/dist-types/commands/UploadPartCommand.d.ts +52 -41
- package/dist-types/commands/UploadPartCopyCommand.d.ts +53 -39
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +938 -632
- package/dist-types/models/models_1.d.ts +230 -135
- package/dist-types/ts3.4/models/models_0.d.ts +7 -0
- package/dist-types/ts3.4/models/models_1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -29,41 +29,44 @@ declare const CompleteMultipartUploadCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Completes a multipart upload by assembling previously uploaded parts.</p>
|
|
31
31
|
* <p>You first initiate the multipart upload and then upload all parts using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
|
|
32
|
-
* operation or the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* in ascending order by part number to create a
|
|
36
|
-
* request, you must provide the parts list and
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
32
|
+
* operation or the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> operation.
|
|
33
|
+
* After successfully uploading all relevant parts of an upload, you call this
|
|
34
|
+
* <code>CompleteMultipartUpload</code> operation to complete the upload. Upon receiving
|
|
35
|
+
* this request, Amazon S3 concatenates all the parts in ascending order by part number to create a
|
|
36
|
+
* new object. In the CompleteMultipartUpload request, you must provide the parts list and
|
|
37
|
+
* ensure that the parts list is complete. The CompleteMultipartUpload API operation
|
|
38
|
+
* concatenates the parts that you provide in the list. For each part in the list, you must
|
|
39
|
+
* provide the <code>PartNumber</code> value and the <code>ETag</code> value that are returned
|
|
40
|
+
* after that part was uploaded.</p>
|
|
40
41
|
* <p>The processing of a CompleteMultipartUpload request could take several minutes to
|
|
41
42
|
* finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that
|
|
42
|
-
* specifies a <code>200 OK</code> response. While processing is in progress, Amazon S3
|
|
43
|
-
* space characters to keep the connection from timing out. A request
|
|
44
|
-
* initial <code>200 OK</code> response has been sent. This means that a
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
* your application to parse the contents of the
|
|
48
|
-
* use Amazon Web Services SDKs, SDKs handle this condition.
|
|
49
|
-
* error handling per your configuration settings
|
|
50
|
-
* request as appropriate). If the condition persists,
|
|
51
|
-
* the SDKs that don't use exceptions, they return an
|
|
43
|
+
* specifies a <code>200 OK</code> response. While processing is in progress, Amazon S3
|
|
44
|
+
* periodically sends white space characters to keep the connection from timing out. A request
|
|
45
|
+
* could fail after the initial <code>200 OK</code> response has been sent. This means that a
|
|
46
|
+
* <code>200 OK</code> response can contain either a success or an error. The error
|
|
47
|
+
* response might be embedded in the <code>200 OK</code> response. If you call this API
|
|
48
|
+
* operation directly, make sure to design your application to parse the contents of the
|
|
49
|
+
* response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition.
|
|
50
|
+
* The SDKs detect the embedded error and apply error handling per your configuration settings
|
|
51
|
+
* (including automatically retrying the request as appropriate). If the condition persists,
|
|
52
|
+
* the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an
|
|
53
|
+
* error). </p>
|
|
52
54
|
* <p>Note that if <code>CompleteMultipartUpload</code> fails, applications should be prepared
|
|
53
|
-
* to retry any failed requests (including 500 error responses). For more information, see
|
|
54
|
-
*
|
|
55
|
+
* to retry any failed requests (including 500 error responses). For more information, see
|
|
56
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html">Amazon S3 Error
|
|
57
|
+
* Best Practices</a>.</p>
|
|
55
58
|
* <important>
|
|
56
59
|
* <p>You can't use <code>Content-Type: application/x-www-form-urlencoded</code> for the
|
|
57
|
-
* CompleteMultipartUpload requests. Also, if you don't provide a
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
+
* CompleteMultipartUpload requests. Also, if you don't provide a <code>Content-Type</code>
|
|
61
|
+
* header, <code>CompleteMultipartUpload</code> can still return a <code>200 OK</code>
|
|
62
|
+
* response.</p>
|
|
60
63
|
* </important>
|
|
61
64
|
* <p>For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
62
|
-
*
|
|
63
|
-
* User Guide</i>.</p>
|
|
65
|
+
* Upload</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
64
66
|
* <note>
|
|
65
67
|
* <p>
|
|
66
|
-
* <b>Directory buckets</b> -
|
|
68
|
+
* <b>Directory buckets</b> -
|
|
69
|
+
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
|
|
67
70
|
* </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
|
|
68
71
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
69
72
|
* </note>
|
|
@@ -78,10 +81,10 @@ declare const CompleteMultipartUploadCommand_base: {
|
|
|
78
81
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
79
82
|
* Permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
80
83
|
* <p>If you provide an <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html">additional checksum
|
|
81
|
-
*
|
|
84
|
+
* value</a> in your <code>MultipartUpload</code> requests and the
|
|
82
85
|
* object is encrypted with Key Management Service, you must have permission to use the
|
|
83
|
-
*
|
|
84
|
-
*
|
|
86
|
+
* <code>kms:Decrypt</code> action for the
|
|
87
|
+
* <code>CompleteMultipartUpload</code> request to succeed.</p>
|
|
85
88
|
* </li>
|
|
86
89
|
* <li>
|
|
87
90
|
* <p>
|
|
@@ -91,9 +94,10 @@ declare const CompleteMultipartUploadCommand_base: {
|
|
|
91
94
|
* Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
|
|
92
95
|
* <code>CreateSession</code>
|
|
93
96
|
* </a>.</p>
|
|
94
|
-
* <p>If the object is encrypted with
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
+
* <p>If the object is encrypted with SSE-KMS, you must also have the
|
|
98
|
+
* <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions
|
|
99
|
+
* in IAM identity-based policies and KMS key policies for the KMS
|
|
100
|
+
* key.</p>
|
|
97
101
|
* </li>
|
|
98
102
|
* </ul>
|
|
99
103
|
* </dd>
|
|
@@ -105,8 +109,9 @@ declare const CompleteMultipartUploadCommand_base: {
|
|
|
105
109
|
* </p>
|
|
106
110
|
* <ul>
|
|
107
111
|
* <li>
|
|
108
|
-
* <p>Description: Your proposed upload is smaller than the minimum
|
|
109
|
-
*
|
|
112
|
+
* <p>Description: Your proposed upload is smaller than the minimum
|
|
113
|
+
* allowed object size. Each part must be at least 5 MB in size, except
|
|
114
|
+
* the last part.</p>
|
|
110
115
|
* </li>
|
|
111
116
|
* <li>
|
|
112
117
|
* <p>HTTP Status Code: 400 Bad Request</p>
|
|
@@ -118,9 +123,9 @@ declare const CompleteMultipartUploadCommand_base: {
|
|
|
118
123
|
* </p>
|
|
119
124
|
* <ul>
|
|
120
125
|
* <li>
|
|
121
|
-
* <p>Description: One or more of the specified parts could not be found.
|
|
122
|
-
*
|
|
123
|
-
*
|
|
126
|
+
* <p>Description: One or more of the specified parts could not be found.
|
|
127
|
+
* The part might not have been uploaded, or the specified ETag might not
|
|
128
|
+
* have matched the uploaded part's ETag.</p>
|
|
124
129
|
* </li>
|
|
125
130
|
* <li>
|
|
126
131
|
* <p>HTTP Status Code: 400 Bad Request</p>
|
|
@@ -132,8 +137,8 @@ declare const CompleteMultipartUploadCommand_base: {
|
|
|
132
137
|
* </p>
|
|
133
138
|
* <ul>
|
|
134
139
|
* <li>
|
|
135
|
-
* <p>Description: The list of parts was not in ascending order. The
|
|
136
|
-
*
|
|
140
|
+
* <p>Description: The list of parts was not in ascending order. The
|
|
141
|
+
* parts list must be specified in order by part number.</p>
|
|
137
142
|
* </li>
|
|
138
143
|
* <li>
|
|
139
144
|
* <p>HTTP Status Code: 400 Bad Request</p>
|
|
@@ -145,9 +150,9 @@ declare const CompleteMultipartUploadCommand_base: {
|
|
|
145
150
|
* </p>
|
|
146
151
|
* <ul>
|
|
147
152
|
* <li>
|
|
148
|
-
* <p>Description: The specified multipart upload does not exist. The
|
|
149
|
-
*
|
|
150
|
-
*
|
|
153
|
+
* <p>Description: The specified multipart upload does not exist. The
|
|
154
|
+
* upload ID might be invalid, or the multipart upload might have been
|
|
155
|
+
* aborted or completed.</p>
|
|
151
156
|
* </li>
|
|
152
157
|
* <li>
|
|
153
158
|
* <p>HTTP Status Code: 404 Not Found</p>
|
|
@@ -35,55 +35,63 @@ declare const CopyObjectCommand_base: {
|
|
|
35
35
|
* (UploadPartCopy) API. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html">Copy Object Using the
|
|
36
36
|
* REST Multipart Upload API</a>.</p>
|
|
37
37
|
* </note>
|
|
38
|
-
* <p>You can copy individual objects between general purpose buckets, between directory buckets,
|
|
39
|
-
* between general purpose buckets and directory buckets.</p>
|
|
38
|
+
* <p>You can copy individual objects between general purpose buckets, between directory buckets,
|
|
39
|
+
* and between general purpose buckets and directory buckets.</p>
|
|
40
40
|
* <note>
|
|
41
41
|
* <ul>
|
|
42
42
|
* <li>
|
|
43
|
-
* <p>Amazon S3 supports copy operations using Multi-Region Access Points only as a
|
|
43
|
+
* <p>Amazon S3 supports copy operations using Multi-Region Access Points only as a
|
|
44
|
+
* destination when using the Multi-Region Access Point ARN. </p>
|
|
44
45
|
* </li>
|
|
45
46
|
* <li>
|
|
46
47
|
* <p>
|
|
47
|
-
* <b>Directory buckets </b> -
|
|
48
|
+
* <b>Directory buckets </b> -
|
|
49
|
+
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
|
|
48
50
|
* </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
|
|
49
51
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
50
52
|
* </li>
|
|
51
53
|
* <li>
|
|
52
|
-
* <p>VPC endpoints don't support cross-Region requests (including copies). If you're
|
|
54
|
+
* <p>VPC endpoints don't support cross-Region requests (including copies). If you're
|
|
55
|
+
* using VPC endpoints, your source and destination buckets should be in the same
|
|
56
|
+
* Amazon Web Services Region as your VPC endpoint.</p>
|
|
53
57
|
* </li>
|
|
54
58
|
* </ul>
|
|
55
59
|
* </note>
|
|
56
|
-
* <p>Both the
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* <i>Amazon Web Services Account Management Guide</i>.</p>
|
|
60
|
+
* <p>Both the Region that you want to copy the object from and the Region that you want to
|
|
61
|
+
* copy the object to must be enabled for your account. For more information about how to
|
|
62
|
+
* enable a Region for your account, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone">Enable or disable a Region for standalone accounts</a> in the <i>Amazon Web Services
|
|
63
|
+
* Account Management Guide</i>.</p>
|
|
61
64
|
* <important>
|
|
62
65
|
* <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a
|
|
63
66
|
* cross-Region copy using a transfer acceleration endpoint, you get a <code>400 Bad
|
|
64
67
|
* Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer
|
|
65
|
-
*
|
|
68
|
+
* Acceleration</a>.</p>
|
|
66
69
|
* </important>
|
|
67
70
|
* <dl>
|
|
68
71
|
* <dt>Authentication and authorization</dt>
|
|
69
72
|
* <dd>
|
|
70
|
-
* <p>All <code>CopyObject</code> requests must be authenticated and signed by using
|
|
71
|
-
*
|
|
73
|
+
* <p>All <code>CopyObject</code> requests must be authenticated and signed by using
|
|
74
|
+
* IAM credentials (access key ID and secret access key for the IAM identities).
|
|
75
|
+
* All headers with the <code>x-amz-</code> prefix, including
|
|
76
|
+
* <code>x-amz-copy-source</code>, must be signed. For more information, see
|
|
77
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
|
|
72
78
|
* <p>
|
|
73
|
-
* <b>Directory buckets</b> - You must use the
|
|
74
|
-
*
|
|
75
|
-
*
|
|
79
|
+
* <b>Directory buckets</b> - You must use the
|
|
80
|
+
* IAM credentials to authenticate and authorize your access to the
|
|
81
|
+
* <code>CopyObject</code> API operation, instead of using the temporary security
|
|
82
|
+
* credentials through the <code>CreateSession</code> API operation.</p>
|
|
83
|
+
* <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your
|
|
84
|
+
* behalf.</p>
|
|
76
85
|
* </dd>
|
|
77
86
|
* <dt>Permissions</dt>
|
|
78
87
|
* <dd>
|
|
79
|
-
* <p>You must have
|
|
80
|
-
*
|
|
81
|
-
* access to the destination bucket.</p>
|
|
88
|
+
* <p>You must have <i>read</i> access to the source object and
|
|
89
|
+
* <i>write</i> access to the destination bucket.</p>
|
|
82
90
|
* <ul>
|
|
83
91
|
* <li>
|
|
84
92
|
* <p>
|
|
85
|
-
* <b>General purpose bucket permissions</b> -
|
|
86
|
-
*
|
|
93
|
+
* <b>General purpose bucket permissions</b> - You
|
|
94
|
+
* must have permissions in an IAM policy based on the source and destination
|
|
87
95
|
* bucket types in a <code>CopyObject</code> operation.</p>
|
|
88
96
|
* <ul>
|
|
89
97
|
* <li>
|
|
@@ -105,30 +113,38 @@ declare const CopyObjectCommand_base: {
|
|
|
105
113
|
* <li>
|
|
106
114
|
* <p>
|
|
107
115
|
* <b>Directory bucket permissions</b> -
|
|
108
|
-
* You must have permissions in a bucket policy or an IAM identity-based policy based on the
|
|
109
|
-
* bucket types in a <code>CopyObject</code>
|
|
116
|
+
* You must have permissions in a bucket policy or an IAM identity-based policy based on the
|
|
117
|
+
* source and destination bucket types in a <code>CopyObject</code>
|
|
118
|
+
* operation.</p>
|
|
110
119
|
* <ul>
|
|
111
120
|
* <li>
|
|
112
121
|
* <p>If the source object that you want to copy is in a
|
|
113
122
|
* directory bucket, you must have the <b>
|
|
114
123
|
* <code>s3express:CreateSession</code>
|
|
115
124
|
* </b> permission in
|
|
116
|
-
* the <code>Action</code> element of a policy to read the object. By
|
|
125
|
+
* the <code>Action</code> element of a policy to read the object. By
|
|
126
|
+
* default, the session is in the <code>ReadWrite</code> mode. If you
|
|
127
|
+
* want to restrict the access, you can explicitly set the
|
|
128
|
+
* <code>s3express:SessionMode</code> condition key to
|
|
129
|
+
* <code>ReadOnly</code> on the copy source bucket.</p>
|
|
117
130
|
* </li>
|
|
118
131
|
* <li>
|
|
119
|
-
* <p>If the copy destination is a directory bucket, you must have the
|
|
132
|
+
* <p>If the copy destination is a directory bucket, you must have the
|
|
133
|
+
* <b>
|
|
120
134
|
* <code>s3express:CreateSession</code>
|
|
121
135
|
* </b> permission in the
|
|
122
|
-
* <code>Action</code> element of a policy to write the object
|
|
123
|
-
*
|
|
124
|
-
*
|
|
136
|
+
* <code>Action</code> element of a policy to write the object to the
|
|
137
|
+
* destination. The <code>s3express:SessionMode</code> condition key
|
|
138
|
+
* can't be set to <code>ReadOnly</code> on the copy destination bucket.
|
|
139
|
+
* </p>
|
|
125
140
|
* </li>
|
|
126
141
|
* </ul>
|
|
127
|
-
* <p>If the object is encrypted with
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
142
|
+
* <p>If the object is encrypted with SSE-KMS, you must also have the
|
|
143
|
+
* <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions
|
|
144
|
+
* in IAM identity-based policies and KMS key policies for the KMS
|
|
145
|
+
* key.</p>
|
|
146
|
+
* <p>For example policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services Identity and Access Management (IAM) identity-based policies for
|
|
147
|
+
* S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
132
148
|
* </li>
|
|
133
149
|
* </ul>
|
|
134
150
|
* </dd>
|
|
@@ -140,33 +156,36 @@ declare const CopyObjectCommand_base: {
|
|
|
140
156
|
* to check if the copy succeeds. </p>
|
|
141
157
|
* <ul>
|
|
142
158
|
* <li>
|
|
143
|
-
* <p>If the copy is successful, you receive a response with information about
|
|
144
|
-
*
|
|
159
|
+
* <p>If the copy is successful, you receive a response with information about
|
|
160
|
+
* the copied object.</p>
|
|
145
161
|
* </li>
|
|
146
162
|
* <li>
|
|
147
|
-
* <p>A copy request might return an error when Amazon S3 receives the copy request
|
|
148
|
-
* is copying the files. A <code>200 OK</code> response can
|
|
163
|
+
* <p>A copy request might return an error when Amazon S3 receives the copy request
|
|
164
|
+
* or while Amazon S3 is copying the files. A <code>200 OK</code> response can
|
|
165
|
+
* contain either a success or an error.</p>
|
|
149
166
|
* <ul>
|
|
150
167
|
* <li>
|
|
151
168
|
* <p>If the error occurs before the copy action starts, you receive a
|
|
152
|
-
*
|
|
169
|
+
* standard Amazon S3 error.</p>
|
|
153
170
|
* </li>
|
|
154
171
|
* <li>
|
|
155
|
-
* <p>If the error occurs during the copy operation, the error response
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
172
|
+
* <p>If the error occurs during the copy operation, the error response
|
|
173
|
+
* is embedded in the <code>200 OK</code> response. For example, in a
|
|
174
|
+
* cross-region copy, you may encounter throttling and receive a
|
|
175
|
+
* <code>200 OK</code> response. For more information, see <a href="https://repost.aws/knowledge-center/s3-resolve-200-internalerror">Resolve the Error 200 response when copying objects to
|
|
176
|
+
* Amazon S3</a>. The <code>200 OK</code> status code means the copy
|
|
177
|
+
* was accepted, but it doesn't mean the copy is complete. Another
|
|
178
|
+
* example is when you disconnect from Amazon S3 before the copy is complete,
|
|
179
|
+
* Amazon S3 might cancel the copy and you may receive a <code>200 OK</code>
|
|
180
|
+
* response. You must stay connected to Amazon S3 until the entire response is
|
|
181
|
+
* successfully received and processed.</p>
|
|
182
|
+
* <p>If you call this API operation directly, make sure to design your
|
|
183
|
+
* application to parse the content of the response and handle it
|
|
184
|
+
* appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The
|
|
185
|
+
* SDKs detect the embedded error and apply error handling per your
|
|
186
|
+
* configuration settings (including automatically retrying the request
|
|
187
|
+
* as appropriate). If the condition persists, the SDKs throw an
|
|
188
|
+
* exception (or, for the SDKs that don't use exceptions, they return an
|
|
170
189
|
* error).</p>
|
|
171
190
|
* </li>
|
|
172
191
|
* </ul>
|
|
@@ -175,10 +194,11 @@ declare const CopyObjectCommand_base: {
|
|
|
175
194
|
* </dd>
|
|
176
195
|
* <dt>Charge</dt>
|
|
177
196
|
* <dd>
|
|
178
|
-
* <p>The copy request charge is based on the storage class and Region that you
|
|
179
|
-
* the destination object. The request can also result in a data
|
|
180
|
-
* source if the source storage class bills for data
|
|
181
|
-
*
|
|
197
|
+
* <p>The copy request charge is based on the storage class and Region that you
|
|
198
|
+
* specify for the destination object. The request can also result in a data
|
|
199
|
+
* retrieval charge for the source if the source storage class bills for data
|
|
200
|
+
* retrieval. If the copy source is in a different region, the data transfer is
|
|
201
|
+
* billed to the copy source account. For pricing information, see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>.</p>
|
|
182
202
|
* </dd>
|
|
183
203
|
* <dt>HTTP Host header syntax</dt>
|
|
184
204
|
* <dd>
|
|
@@ -32,9 +32,9 @@ declare const CreateBucketCommand_base: {
|
|
|
32
32
|
* <code>CreateBucket</code>
|
|
33
33
|
* </a>.</p>
|
|
34
34
|
* </note>
|
|
35
|
-
* <p>Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a
|
|
36
|
-
*
|
|
37
|
-
*
|
|
35
|
+
* <p>Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services
|
|
36
|
+
* Access Key ID to authenticate requests. Anonymous requests are never allowed to create
|
|
37
|
+
* buckets. By creating the bucket, you become the bucket owner.</p>
|
|
38
38
|
* <p>There are two types of buckets: general purpose buckets and directory buckets. For more
|
|
39
39
|
* information about these bucket types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and
|
|
40
40
|
* working with Amazon S3 buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -42,12 +42,14 @@ declare const CreateBucketCommand_base: {
|
|
|
42
42
|
* <ul>
|
|
43
43
|
* <li>
|
|
44
44
|
* <p>
|
|
45
|
-
* <b>General purpose buckets</b> - If you send your
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
45
|
+
* <b>General purpose buckets</b> - If you send your
|
|
46
|
+
* <code>CreateBucket</code> request to the <code>s3.amazonaws.com</code> global
|
|
47
|
+
* endpoint, the request goes to the <code>us-east-1</code> Region. So the signature
|
|
48
|
+
* calculations in Signature Version 4 must use <code>us-east-1</code> as the Region,
|
|
49
|
+
* even if the location constraint in the request specifies another Region where the
|
|
50
|
+
* bucket is to be created. If you create a bucket in a Region other than US East (N.
|
|
51
|
+
* Virginia), your application must be able to handle 307 redirect. For more
|
|
52
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
|
|
51
53
|
* buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
52
54
|
* </li>
|
|
53
55
|
* <li>
|
|
@@ -65,33 +67,40 @@ declare const CreateBucketCommand_base: {
|
|
|
65
67
|
* <ul>
|
|
66
68
|
* <li>
|
|
67
69
|
* <p>
|
|
68
|
-
* <b>General purpose bucket permissions</b> - In
|
|
69
|
-
*
|
|
70
|
-
*
|
|
70
|
+
* <b>General purpose bucket permissions</b> - In
|
|
71
|
+
* addition to the <code>s3:CreateBucket</code> permission, the following
|
|
72
|
+
* permissions are required in a policy when your <code>CreateBucket</code>
|
|
73
|
+
* request includes specific headers: </p>
|
|
71
74
|
* <ul>
|
|
72
75
|
* <li>
|
|
73
76
|
* <p>
|
|
74
|
-
* <b>Access control lists (ACLs)</b>
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
77
|
+
* <b>Access control lists (ACLs)</b>
|
|
78
|
+
* - In your <code>CreateBucket</code> request, if you specify an
|
|
79
|
+
* access control list (ACL) and set it to <code>public-read</code>,
|
|
80
|
+
* <code>public-read-write</code>, <code>authenticated-read</code>, or
|
|
81
|
+
* if you explicitly specify any other custom ACLs, both
|
|
82
|
+
* <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code>
|
|
83
|
+
* permissions are required. In your <code>CreateBucket</code> request,
|
|
84
|
+
* if you set the ACL to <code>private</code>, or if you don't specify
|
|
85
|
+
* any ACLs, only the <code>s3:CreateBucket</code> permission is
|
|
86
|
+
* required. </p>
|
|
80
87
|
* </li>
|
|
81
88
|
* <li>
|
|
82
89
|
* <p>
|
|
83
90
|
* <b>Object Lock</b> - In your
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
91
|
+
* <code>CreateBucket</code> request, if you set
|
|
92
|
+
* <code>x-amz-bucket-object-lock-enabled</code> to true, the
|
|
93
|
+
* <code>s3:PutBucketObjectLockConfiguration</code> and
|
|
94
|
+
* <code>s3:PutBucketVersioning</code> permissions are
|
|
95
|
+
* required.</p>
|
|
88
96
|
* </li>
|
|
89
97
|
* <li>
|
|
90
98
|
* <p>
|
|
91
|
-
* <b>S3 Object Ownership</b> - If
|
|
92
|
-
* <code>CreateBucket</code> request includes the
|
|
93
|
-
*
|
|
94
|
-
*
|
|
99
|
+
* <b>S3 Object Ownership</b> - If
|
|
100
|
+
* your <code>CreateBucket</code> request includes the
|
|
101
|
+
* <code>x-amz-object-ownership</code> header, then the
|
|
102
|
+
* <code>s3:PutBucketOwnershipControls</code> permission is
|
|
103
|
+
* required.</p>
|
|
95
104
|
* <important>
|
|
96
105
|
* <p> To set an ACL on a bucket as part of a
|
|
97
106
|
* <code>CreateBucket</code> request, you must explicitly set S3
|
|
@@ -102,10 +111,10 @@ declare const CreateBucketCommand_base: {
|
|
|
102
111
|
* Public Access on the bucket before using <code>PutBucketAcl</code>
|
|
103
112
|
* to set the ACL. If you try to create a bucket with a public ACL,
|
|
104
113
|
* the request will fail. </p>
|
|
105
|
-
* <p> For the majority of modern use cases in S3, we recommend
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
114
|
+
* <p> For the majority of modern use cases in S3, we recommend that
|
|
115
|
+
* you keep all Block Public Access settings enabled and keep ACLs
|
|
116
|
+
* disabled. If you would like to share data with users outside of
|
|
117
|
+
* your account, you can use bucket policies as needed. For more
|
|
109
118
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of objects and disabling ACLs for your
|
|
110
119
|
* bucket </a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html">Blocking public access to your Amazon S3 storage </a> in
|
|
111
120
|
* the <i>Amazon S3 User Guide</i>. </p>
|
|
@@ -113,30 +122,36 @@ declare const CreateBucketCommand_base: {
|
|
|
113
122
|
* </li>
|
|
114
123
|
* <li>
|
|
115
124
|
* <p>
|
|
116
|
-
* <b>S3 Block Public Access</b> - If
|
|
117
|
-
* specific use case requires granting public access to your S3
|
|
118
|
-
* can disable Block Public Access. Specifically, you can
|
|
119
|
-
* Public Access enabled, then separately
|
|
125
|
+
* <b>S3 Block Public Access</b> - If
|
|
126
|
+
* your specific use case requires granting public access to your S3
|
|
127
|
+
* resources, you can disable Block Public Access. Specifically, you can
|
|
128
|
+
* create a new bucket with Block Public Access enabled, then separately
|
|
129
|
+
* call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">
|
|
120
130
|
* <code>DeletePublicAccessBlock</code>
|
|
121
131
|
* </a> API. To use this operation, you must have the
|
|
122
|
-
*
|
|
123
|
-
* Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html">Blocking
|
|
124
|
-
*
|
|
125
|
-
* <i>Amazon S3 User Guide</i>. </p>
|
|
132
|
+
* <code>s3:PutBucketPublicAccessBlock</code> permission. For more
|
|
133
|
+
* information about S3 Block Public Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html">Blocking public access to your Amazon S3 storage </a> in the
|
|
134
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
126
135
|
* </li>
|
|
127
136
|
* </ul>
|
|
128
137
|
* </li>
|
|
129
138
|
* <li>
|
|
130
139
|
* <p>
|
|
131
|
-
* <b>Directory bucket permissions</b> -
|
|
140
|
+
* <b>Directory bucket permissions</b> -
|
|
141
|
+
* You must have the <code>s3express:CreateBucket</code> permission in
|
|
142
|
+
* an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
|
|
143
|
+
* For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
132
144
|
* <important>
|
|
133
|
-
* <p>The permissions for ACLs, Object Lock, S3 Object Ownership, and S3
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
145
|
+
* <p>The permissions for ACLs, Object Lock, S3 Object Ownership, and S3
|
|
146
|
+
* Block Public Access are not supported for directory buckets. For
|
|
147
|
+
* directory buckets, all Block Public Access settings are enabled at the
|
|
148
|
+
* bucket level and S3 Object Ownership is set to Bucket owner enforced
|
|
149
|
+
* (ACLs disabled). These settings can't be modified. </p>
|
|
137
150
|
* <p>For more information about permissions for creating and working with
|
|
138
|
-
* directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the
|
|
139
|
-
*
|
|
151
|
+
* directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the
|
|
152
|
+
* <i>Amazon S3 User Guide</i>. For more information about
|
|
153
|
+
* supported S3 features for directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features">Features of S3 Express One Zone</a> in the
|
|
154
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
140
155
|
* </important>
|
|
141
156
|
* </li>
|
|
142
157
|
* </ul>
|