@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
|
@@ -28,20 +28,22 @@ declare const ListPartsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists the parts that have been uploaded for a specific multipart upload.</p>
|
|
31
|
-
* <p>To use this operation, you must provide the <code>upload ID</code> in the request. You
|
|
32
|
-
* request through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.</p>
|
|
33
|
-
* <p>The <code>ListParts</code> request returns a maximum of 1,000 uploaded parts. The limit
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
31
|
+
* <p>To use this operation, you must provide the <code>upload ID</code> in the request. You
|
|
32
|
+
* obtain this uploadID by sending the initiate multipart upload request through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.</p>
|
|
33
|
+
* <p>The <code>ListParts</code> request returns a maximum of 1,000 uploaded parts. The limit
|
|
34
|
+
* of 1,000 parts is also the default value. You can restrict the number of parts in a
|
|
35
|
+
* response by specifying the <code>max-parts</code> request parameter. If your multipart
|
|
36
|
+
* upload consists of more than 1,000 parts, the response returns an <code>IsTruncated</code>
|
|
37
|
+
* field with the value of <code>true</code>, and a <code>NextPartNumberMarker</code> element.
|
|
38
|
+
* To list remaining uploaded parts, in subsequent <code>ListParts</code> requests, include
|
|
39
|
+
* the <code>part-number-marker</code> query string parameter and set its value to the
|
|
40
|
+
* <code>NextPartNumberMarker</code> field value from the previous response.</p>
|
|
39
41
|
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
40
|
-
*
|
|
41
|
-
* User Guide</i>.</p>
|
|
42
|
+
* Upload</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
42
43
|
* <note>
|
|
43
44
|
* <p>
|
|
44
|
-
* <b>Directory buckets</b> -
|
|
45
|
+
* <b>Directory buckets</b> -
|
|
46
|
+
* 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>
|
|
45
47
|
* </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
|
|
46
48
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
47
49
|
* </note>
|
|
@@ -51,12 +53,15 @@ declare const ListPartsCommand_base: {
|
|
|
51
53
|
* <ul>
|
|
52
54
|
* <li>
|
|
53
55
|
* <p>
|
|
54
|
-
* <b>General purpose bucket permissions</b> - For
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
56
|
+
* <b>General purpose bucket permissions</b> - For
|
|
57
|
+
* information about permissions required to use the multipart upload API, see
|
|
58
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
59
|
+
* Permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
60
|
+
* <p>If the upload was created using server-side encryption with Key Management Service
|
|
61
|
+
* (KMS) keys (SSE-KMS) or dual-layer server-side encryption with
|
|
62
|
+
* Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the
|
|
63
|
+
* <code>kms:Decrypt</code> action for the <code>ListParts</code> request to
|
|
64
|
+
* succeed.</p>
|
|
60
65
|
* </li>
|
|
61
66
|
* <li>
|
|
62
67
|
* <p>
|
|
@@ -28,7 +28,7 @@ declare const PutBucketAccelerateConfigurationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a
|
|
34
34
|
* bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p>
|
|
@@ -28,7 +28,7 @@ declare const PutBucketAclCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sets the permissions on an existing bucket using access control lists (ACL). For more
|
|
34
34
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set the ACL of a
|
|
@@ -28,7 +28,7 @@ declare const PutBucketAnalyticsConfigurationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sets an analytics configuration for the bucket (specified by the analytics configuration
|
|
34
34
|
* ID). You can have up to 1,000 analytics configurations per bucket.</p>
|
|
@@ -28,7 +28,7 @@ declare const PutBucketCorsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sets the <code>cors</code> configuration for your bucket. If the configuration exists,
|
|
34
34
|
* Amazon S3 replaces it.</p>
|
|
@@ -27,8 +27,8 @@ declare const PutBucketEncryptionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>This operation configures default encryption
|
|
31
|
-
*
|
|
30
|
+
* <p>This operation configures default encryption and Amazon S3 Bucket Keys for an existing
|
|
31
|
+
* bucket.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>
|
|
34
34
|
* <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
|
|
@@ -46,30 +46,35 @@ declare const PutBucketEncryptionCommand_base: {
|
|
|
46
46
|
* </p>
|
|
47
47
|
* <ul>
|
|
48
48
|
* <li>
|
|
49
|
-
* <p>You can optionally configure default encryption
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
* in the <i>Amazon S3 User Guide</i>.
|
|
57
|
-
* </p>
|
|
49
|
+
* <p>You can optionally configure default encryption for a bucket by using
|
|
50
|
+
* server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer
|
|
51
|
+
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify
|
|
52
|
+
* default encryption by using SSE-KMS, you can also configure <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3
|
|
53
|
+
* Bucket Keys</a>. For information about the bucket default encryption
|
|
54
|
+
* feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default
|
|
55
|
+
* Encryption</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
58
56
|
* </li>
|
|
59
57
|
* <li>
|
|
60
|
-
* <p>If you use PutBucketEncryption to set your <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">default bucket
|
|
58
|
+
* <p>If you use PutBucketEncryption to set your <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">default bucket
|
|
59
|
+
* encryption</a> to SSE-KMS, you should verify that your KMS key ID
|
|
60
|
+
* is correct. Amazon S3 doesn't validate the KMS key ID provided in
|
|
61
|
+
* PutBucketEncryption requests.</p>
|
|
61
62
|
* </li>
|
|
62
63
|
* </ul>
|
|
63
64
|
* </li>
|
|
64
65
|
* <li>
|
|
65
66
|
* <p>
|
|
66
|
-
* <b>Directory buckets </b> - You can
|
|
67
|
-
*
|
|
67
|
+
* <b>Directory buckets </b> - You can
|
|
68
|
+
* optionally configure default encryption for a bucket by using server-side
|
|
69
|
+
* encryption with Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
68
70
|
* <ul>
|
|
69
71
|
* <li>
|
|
70
|
-
* <p>We recommend that the bucket's default encryption uses the desired
|
|
71
|
-
*
|
|
72
|
-
*
|
|
72
|
+
* <p>We recommend that the bucket's default encryption uses the desired
|
|
73
|
+
* encryption configuration and you don't override the bucket default
|
|
74
|
+
* encryption in your <code>CreateSession</code> requests or <code>PUT</code>
|
|
75
|
+
* object requests. Then, new objects are automatically encrypted with the
|
|
76
|
+
* desired encryption settings.
|
|
77
|
+
* 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>
|
|
73
78
|
* </li>
|
|
74
79
|
* <li>
|
|
75
80
|
* <p>Your SSE-KMS configuration can only support 1 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> per directory bucket for the lifetime of the bucket.
|
|
@@ -85,19 +90,21 @@ declare const PutBucketEncryptionCommand_base: {
|
|
|
85
90
|
* <p>When you specify an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">KMS customer managed key</a> for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.</p>
|
|
86
91
|
* </li>
|
|
87
92
|
* <li>
|
|
88
|
-
* <p>For directory buckets, if you use PutBucketEncryption to set your <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">default bucket encryption</a> to SSE-KMS, Amazon S3 validates the
|
|
93
|
+
* <p>For directory buckets, if you use PutBucketEncryption to set your <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">default bucket encryption</a> to SSE-KMS, Amazon S3 validates the
|
|
94
|
+
* KMS key ID provided in PutBucketEncryption requests.</p>
|
|
89
95
|
* </li>
|
|
90
96
|
* </ul>
|
|
91
97
|
* </li>
|
|
92
98
|
* </ul>
|
|
93
99
|
* </note>
|
|
94
100
|
* <important>
|
|
95
|
-
* <p>If you're specifying a customer managed KMS key, we recommend using a fully
|
|
96
|
-
* KMS key ARN. If you use a KMS key alias instead, then KMS resolves the
|
|
97
|
-
* requester’s account. This behavior can result in data that's encrypted
|
|
98
|
-
* that belongs to the requester, and not the bucket owner.</p>
|
|
99
|
-
* <p>Also, this action requires Amazon Web Services Signature Version 4. For more information, see
|
|
100
|
-
*
|
|
101
|
+
* <p>If you're specifying a customer managed KMS key, we recommend using a fully
|
|
102
|
+
* qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the
|
|
103
|
+
* key within the requester’s account. This behavior can result in data that's encrypted
|
|
104
|
+
* with a KMS key that belongs to the requester, and not the bucket owner.</p>
|
|
105
|
+
* <p>Also, this action requires Amazon Web Services Signature Version 4. For more information, see
|
|
106
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html"> Authenticating
|
|
107
|
+
* Requests (Amazon Web Services Signature Version 4)</a>. </p>
|
|
101
108
|
* </important>
|
|
102
109
|
* <dl>
|
|
103
110
|
* <dt>Permissions</dt>
|
|
@@ -105,17 +112,25 @@ declare const PutBucketEncryptionCommand_base: {
|
|
|
105
112
|
* <ul>
|
|
106
113
|
* <li>
|
|
107
114
|
* <p>
|
|
108
|
-
* <b>General purpose bucket permissions</b> - The
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
115
|
+
* <b>General purpose bucket permissions</b> - The
|
|
116
|
+
* <code>s3:PutEncryptionConfiguration</code> permission is required in a
|
|
117
|
+
* policy. The bucket owner has this permission by default. The bucket owner
|
|
118
|
+
* can grant this permission to others. For more information about permissions,
|
|
119
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
|
|
120
|
+
* Permissions to Your Amazon S3 Resources</a> in the
|
|
121
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
114
122
|
* </li>
|
|
115
123
|
* <li>
|
|
116
124
|
* <p>
|
|
117
|
-
* <b>Directory bucket permissions</b> -
|
|
118
|
-
*
|
|
125
|
+
* <b>Directory bucket permissions</b> -
|
|
126
|
+
* To grant access to this API operation, you must have the
|
|
127
|
+
* <code>s3express:PutEncryptionConfiguration</code> permission in
|
|
128
|
+
* 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.
|
|
129
|
+
* 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>
|
|
130
|
+
* <p>To set a directory bucket default encryption with SSE-KMS, you must also
|
|
131
|
+
* have the <code>kms:GenerateDataKey</code> and the <code>kms:Decrypt</code>
|
|
132
|
+
* permissions in IAM identity-based policies and KMS key policies for the
|
|
133
|
+
* target KMS key.</p>
|
|
119
134
|
* </li>
|
|
120
135
|
* </ul>
|
|
121
136
|
* </dd>
|
|
@@ -28,7 +28,7 @@ declare const PutBucketIntelligentTieringConfigurationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to
|
|
34
34
|
* 1,000 S3 Intelligent-Tiering configurations per bucket.</p>
|
|
@@ -28,7 +28,7 @@ declare const PutBucketInventoryConfigurationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>This implementation of the <code>PUT</code> action adds an inventory configuration
|
|
34
34
|
* (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory
|
|
@@ -27,26 +27,37 @@ declare const PutBucketLifecycleConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
31
|
-
* <p>This operation is not supported by directory buckets.</p>
|
|
32
|
-
* </note>
|
|
33
|
-
* <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
|
|
30
|
+
* <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
|
|
34
31
|
* configuration. Keep in mind that this will overwrite an existing lifecycle configuration,
|
|
35
32
|
* so if you want to retain any configuration details, they must be included in the new
|
|
36
33
|
* lifecycle configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing
|
|
37
34
|
* your storage lifecycle</a>.</p>
|
|
38
35
|
* <dl>
|
|
39
36
|
* <dt>Rules</dt>
|
|
37
|
+
* <dt>Permissions</dt>
|
|
38
|
+
* <dt>HTTP Host header syntax</dt>
|
|
40
39
|
* <dd>
|
|
41
40
|
* <p>You specify the lifecycle configuration in your request body. The lifecycle
|
|
42
41
|
* configuration is specified as XML consisting of one or more rules. An Amazon S3
|
|
43
|
-
* Lifecycle configuration can have up to 1,000 rules. This limit is not
|
|
44
|
-
*
|
|
45
|
-
*
|
|
42
|
+
* Lifecycle configuration can have up to 1,000 rules. This limit is not
|
|
43
|
+
* adjustable.</p>
|
|
44
|
+
* <p>Bucket lifecycle configuration supports specifying a lifecycle rule using an
|
|
45
|
+
* object key name prefix, one or more object tags, object size, or any combination
|
|
46
|
+
* of these. Accordingly, this section describes the latest API. The previous version
|
|
47
|
+
* of the API supported filtering based only on an object key name prefix, which is
|
|
48
|
+
* supported for backward compatibility for general purpose buckets. For the related
|
|
49
|
+
* API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>. </p>
|
|
50
|
+
* <note>
|
|
51
|
+
* <p>Lifecyle configurations for directory buckets only support expiring objects and
|
|
52
|
+
* cancelling multipart uploads. Expiring of versioned objects,transitions and tag
|
|
53
|
+
* filters are not supported.</p>
|
|
54
|
+
* </note>
|
|
46
55
|
* <p>A lifecycle rule consists of the following:</p>
|
|
47
56
|
* <ul>
|
|
48
57
|
* <li>
|
|
49
|
-
* <p>A filter identifying a subset of objects to which the rule applies. The
|
|
58
|
+
* <p>A filter identifying a subset of objects to which the rule applies. The
|
|
59
|
+
* filter can be based on a key name prefix, object tags, object size, or any
|
|
60
|
+
* combination of these.</p>
|
|
50
61
|
* </li>
|
|
51
62
|
* <li>
|
|
52
63
|
* <p>A status indicating whether the rule is in effect.</p>
|
|
@@ -64,59 +75,87 @@ declare const PutBucketLifecycleConfigurationCommand_base: {
|
|
|
64
75
|
* Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration
|
|
65
76
|
* Elements</a>.</p>
|
|
66
77
|
* </dd>
|
|
67
|
-
* <dt>Permissions</dt>
|
|
68
78
|
* <dd>
|
|
69
|
-
* <p>By default, all Amazon S3 resources are private, including buckets, objects, and
|
|
70
|
-
* related subresources (for example, lifecycle configuration and website
|
|
71
|
-
* configuration). Only the resource owner (that is, the Amazon Web Services account that created
|
|
72
|
-
* it) can access the resource. The resource owner can optionally grant access
|
|
73
|
-
* permissions to others by writing an access policy. For this operation, a user must
|
|
74
|
-
* get the <code>s3:PutLifecycleConfiguration</code> permission.</p>
|
|
75
|
-
* <p>You can also explicitly deny permissions. An explicit deny also supersedes any
|
|
76
|
-
* other permissions. If you want to block users or accounts from removing or
|
|
77
|
-
* deleting objects from your bucket, you must deny them permissions for the
|
|
78
|
-
* following actions:</p>
|
|
79
79
|
* <ul>
|
|
80
80
|
* <li>
|
|
81
81
|
* <p>
|
|
82
|
-
* <
|
|
83
|
-
*
|
|
82
|
+
* <b>General purpose bucket permissions</b> - By
|
|
83
|
+
* default, all Amazon S3 resources are private, including buckets, objects, and
|
|
84
|
+
* related subresources (for example, lifecycle configuration and website
|
|
85
|
+
* configuration). Only the resource owner (that is, the Amazon Web Services account that
|
|
86
|
+
* created it) can access the resource. The resource owner can optionally grant
|
|
87
|
+
* access permissions to others by writing an access policy. For this
|
|
88
|
+
* operation, a user must have the <code>s3:PutLifecycleConfiguration</code>
|
|
89
|
+
* permission.</p>
|
|
90
|
+
* <p>You can also explicitly deny permissions. An explicit deny also
|
|
91
|
+
* supersedes any other permissions. If you want to block users or accounts
|
|
92
|
+
* from removing or deleting objects from your bucket, you must deny them
|
|
93
|
+
* permissions for the following actions:</p>
|
|
94
|
+
* <ul>
|
|
95
|
+
* <li>
|
|
96
|
+
* <p>
|
|
97
|
+
* <code>s3:DeleteObject</code>
|
|
98
|
+
* </p>
|
|
99
|
+
* </li>
|
|
100
|
+
* <li>
|
|
101
|
+
* <p>
|
|
102
|
+
* <code>s3:DeleteObjectVersion</code>
|
|
103
|
+
* </p>
|
|
104
|
+
* </li>
|
|
105
|
+
* <li>
|
|
106
|
+
* <p>
|
|
107
|
+
* <code>s3:PutLifecycleConfiguration</code>
|
|
108
|
+
* </p>
|
|
109
|
+
* <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
110
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
111
|
+
* </li>
|
|
112
|
+
* </ul>
|
|
113
|
+
* </li>
|
|
114
|
+
* </ul>
|
|
115
|
+
* <ul>
|
|
116
|
+
* <li>
|
|
117
|
+
* <p>
|
|
118
|
+
* <b>Directory bucket permissions</b> -
|
|
119
|
+
* You must have the <code>s3express:PutLifecycleConfiguration</code>
|
|
120
|
+
* permission in an IAM identity-based policy to use this operation.
|
|
121
|
+
* Cross-account access to this API operation isn't supported. The resource
|
|
122
|
+
* owner can optionally grant access permissions to others by creating a role
|
|
123
|
+
* or user for them as long as they are within the same account as the owner
|
|
124
|
+
* and resource.</p>
|
|
125
|
+
* <p>For more information about directory bucket policies and permissions, see
|
|
126
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Authorizing Regional endpoint APIs with IAM</a> in the
|
|
127
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
128
|
+
* <note>
|
|
129
|
+
* <p>
|
|
130
|
+
* <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
|
|
131
|
+
* </code>. Virtual-hosted-style requests aren't supported.
|
|
132
|
+
* 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
|
|
133
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
134
|
+
* </note>
|
|
84
135
|
* </li>
|
|
136
|
+
* </ul>
|
|
137
|
+
* </dd>
|
|
138
|
+
* <dd>
|
|
139
|
+
* <p>
|
|
140
|
+
* <b>Directory buckets </b> - The HTTP Host
|
|
141
|
+
* header syntax is
|
|
142
|
+
* <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
|
|
143
|
+
* <p>The following operations are related to
|
|
144
|
+
* <code>PutBucketLifecycleConfiguration</code>:</p>
|
|
145
|
+
* <ul>
|
|
85
146
|
* <li>
|
|
86
147
|
* <p>
|
|
87
|
-
* <
|
|
148
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
|
|
88
149
|
* </p>
|
|
89
150
|
* </li>
|
|
90
151
|
* <li>
|
|
91
152
|
* <p>
|
|
92
|
-
* <
|
|
153
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a>
|
|
93
154
|
* </p>
|
|
94
155
|
* </li>
|
|
95
156
|
* </ul>
|
|
96
|
-
* <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
|
|
97
|
-
* Permissions to Your Amazon S3 Resources</a>.</p>
|
|
98
157
|
* </dd>
|
|
99
158
|
* </dl>
|
|
100
|
-
* <p>The following operations are related to
|
|
101
|
-
* <code>PutBucketLifecycleConfiguration</code>:</p>
|
|
102
|
-
* <ul>
|
|
103
|
-
* <li>
|
|
104
|
-
* <p>
|
|
105
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html">Examples of
|
|
106
|
-
* Lifecycle Configuration</a>
|
|
107
|
-
* </p>
|
|
108
|
-
* </li>
|
|
109
|
-
* <li>
|
|
110
|
-
* <p>
|
|
111
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
|
|
112
|
-
* </p>
|
|
113
|
-
* </li>
|
|
114
|
-
* <li>
|
|
115
|
-
* <p>
|
|
116
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a>
|
|
117
|
-
* </p>
|
|
118
|
-
* </li>
|
|
119
|
-
* </ul>
|
|
120
159
|
* @example
|
|
121
160
|
* Use a bare-bones client and the command you need to make an API call.
|
|
122
161
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ declare const PutBucketLoggingCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Set the logging parameters for a bucket and to specify permissions for who can view and
|
|
34
34
|
* modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as
|
|
@@ -28,7 +28,7 @@ declare const PutBucketMetricsConfigurationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
|
|
34
34
|
* You can have up to 1,000 metrics configurations per bucket. If you're updating an existing
|
|
@@ -28,7 +28,7 @@ declare const PutBucketNotificationConfigurationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Enables notifications of specified events for a bucket. For more information about event
|
|
34
34
|
* notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event
|
|
@@ -28,7 +28,7 @@ declare const PutBucketOwnershipControlsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this
|
|
34
34
|
* operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For
|
|
@@ -38,42 +38,51 @@ declare const PutBucketPolicyCommand_base: {
|
|
|
38
38
|
* <dl>
|
|
39
39
|
* <dt>Permissions</dt>
|
|
40
40
|
* <dd>
|
|
41
|
-
* <p>If you are using an identity other than the
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* bucket owner's account in order to use this operation.</p>
|
|
45
|
-
* <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a
|
|
46
|
-
*
|
|
47
|
-
* identity that belongs to the bucket owner's account, Amazon S3
|
|
48
|
-
*
|
|
41
|
+
* <p>If you are using an identity other than the root user of the Amazon Web Services account that
|
|
42
|
+
* owns the bucket, the calling identity must both have the
|
|
43
|
+
* <code>PutBucketPolicy</code> permissions on the specified bucket and belong to
|
|
44
|
+
* the bucket owner's account in order to use this operation.</p>
|
|
45
|
+
* <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a
|
|
46
|
+
* <code>403 Access Denied</code> error. If you have the correct permissions, but
|
|
47
|
+
* you're not using an identity that belongs to the bucket owner's account, Amazon S3
|
|
48
|
+
* returns a <code>405 Method Not Allowed</code> error.</p>
|
|
49
49
|
* <important>
|
|
50
|
-
* <p>To ensure that bucket owners don't inadvertently lock themselves out of
|
|
51
|
-
* buckets, the root principal in a bucket owner's Amazon Web Services account can
|
|
52
|
-
* <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
|
|
53
|
-
*
|
|
54
|
-
* denies the root principal's access. Bucket owner root principals can
|
|
55
|
-
* from performing these API actions by VPC endpoint policies and
|
|
56
|
-
* policies.</p>
|
|
50
|
+
* <p>To ensure that bucket owners don't inadvertently lock themselves out of
|
|
51
|
+
* their own buckets, the root principal in a bucket owner's Amazon Web Services account can
|
|
52
|
+
* perform the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
|
|
53
|
+
* <code>DeleteBucketPolicy</code> API actions, even if their bucket policy
|
|
54
|
+
* explicitly denies the root principal's access. Bucket owner root principals can
|
|
55
|
+
* only be blocked from performing these API actions by VPC endpoint policies and
|
|
56
|
+
* Amazon Web Services Organizations policies.</p>
|
|
57
57
|
* </important>
|
|
58
58
|
* <ul>
|
|
59
59
|
* <li>
|
|
60
60
|
* <p>
|
|
61
|
-
* <b>General purpose bucket permissions</b> - The
|
|
62
|
-
*
|
|
63
|
-
*
|
|
61
|
+
* <b>General purpose bucket permissions</b> - The
|
|
62
|
+
* <code>s3:PutBucketPolicy</code> permission is required in a policy. For
|
|
63
|
+
* more information about general purpose buckets bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a> in the
|
|
64
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
64
65
|
* </li>
|
|
65
66
|
* <li>
|
|
66
67
|
* <p>
|
|
67
|
-
* <b>Directory bucket permissions</b> -
|
|
68
|
+
* <b>Directory bucket permissions</b> -
|
|
69
|
+
* To grant access to this API operation, you must have the
|
|
70
|
+
* <code>s3express:PutBucketPolicy</code> permission in
|
|
71
|
+
* 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.
|
|
72
|
+
* 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>
|
|
68
73
|
* </li>
|
|
69
74
|
* </ul>
|
|
70
75
|
* </dd>
|
|
71
76
|
* <dt>Example bucket policies</dt>
|
|
72
77
|
* <dd>
|
|
73
78
|
* <p>
|
|
74
|
-
* <b>General purpose buckets example bucket policies</b>
|
|
79
|
+
* <b>General purpose buckets example bucket policies</b>
|
|
80
|
+
* - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
|
|
81
|
+
* examples</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
75
82
|
* <p>
|
|
76
|
-
* <b>Directory bucket example bucket policies</b>
|
|
83
|
+
* <b>Directory bucket example bucket policies</b>
|
|
84
|
+
* - 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> in the
|
|
85
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
77
86
|
* </dd>
|
|
78
87
|
* <dt>HTTP Host header syntax</dt>
|
|
79
88
|
* <dd>
|
|
@@ -28,16 +28,15 @@ declare const PutBucketReplicationCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p> Creates a replication configuration or replaces an existing one. For more information,
|
|
34
34
|
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
35
35
|
* <p>Specify the replication configuration in the request body. In the replication
|
|
36
36
|
* configuration, you provide the name of the destination bucket or buckets where you want
|
|
37
37
|
* Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your
|
|
38
|
-
* behalf, and other relevant information. You can invoke this request for a specific
|
|
39
|
-
*
|
|
40
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion">
|
|
38
|
+
* behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services
|
|
39
|
+
* Region by using the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion">
|
|
41
40
|
* <code>aws:RequestedRegion</code>
|
|
42
41
|
* </a> condition key.</p>
|
|
43
42
|
* <p>A replication configuration must include at least one rule, and can contain a maximum of
|
|
@@ -28,7 +28,7 @@ declare const PutBucketRequestPaymentCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sets the request payment configuration for a bucket. By default, the bucket owner pays
|
|
34
34
|
* for downloads from the bucket. This configuration parameter enables the bucket owner (only)
|
|
@@ -28,7 +28,7 @@ declare const PutBucketTaggingCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>This operation is not supported
|
|
31
|
+
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sets the tags for a bucket.</p>
|
|
34
34
|
* <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
|